Merge branch 'master' of https://github.com/NaturalNode/natural into …

…issue-641

.env

@@ -0,0 +1,24 @@
+NODE_PATH=.
+# Storage backend you want to use
+NATURAL_STORAGE=PG
+# Settings for Postgres
+POSTGRES_USER=user
+POSTGRES_PASSWORD=password
+POSTGRES_DB=naturaldb
+POSTGRES_HOST=localhost
+POSTGRES_PORT=5432
+POSTGRES_TABLE=naturaltable
+# Settings for Redis
+REDIS_HOST=localhost
+REDIS_PORT=6379
+# Settings for Memcached
+MEM_HOST=localhost
+MEM_PORT=11211
+MEM_EXPIRES = 3600
+# Settings for MongoDB
+MONGO_HOST=localhost
+MONGO_PORT=27017
+MONGO_DATABASE=naturaldb
+MONGO_OBJECTMODEL=NaturalObjectModel
+# Path to the folder writing files 
+FS_PATH=./io_spec/tmp

.eslintrc.json

@@ -0,0 +1,13 @@
+{
+    "env": {
+        "browser": true,
+        "commonjs": true,
+        "es2021": true
+    },
+    "extends": "standard-with-typescript",
+    "parserOptions": {
+        "ecmaVersion": "latest"
+    },
+    "rules": {
+    }
+}

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,28 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: Bug
+assignees: Hugo-ter-Doest
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior, or clear and concise code excerpts that trigger the unexpected behaviour.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here, especially if you are running natural in the browser as part a framework.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: Feature Request
+assignees: Hugo-ter-Doest
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/pull_request_template.md

@@ -0,0 +1,11 @@
+Fixes #
+
+## Proposed Changes
+
+  -
+  -
+  -
+
+## Checklist before merging
+- [ ] Added Jasmine tests
+- [ ] Updates TypeScipt `index.d.ts` files

.github/workflows/node.js.yml

@@ -1,35 +1,73 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
+# This workflow will do a clean install of node dependencies, 
+# build the source code and run tests across different versions of node
+# For more information see: 
+# https://help.github.com/actions/language-and-framework-guides/
+# using-nodejs-with-github-actions
+---
 name: Node.js CI
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request:
-    branches: [ master ]
+    branches: [master]
 
 jobs:
   build:
 
     runs-on: ubuntu-latest
 
+    services:
+      redis:
+        image: redis:latest
+        ports:
+          - 6379:6379
+      postgres:
+        image: postgres:latest
+        env:
+          POSTGRES_USER: user
+          POSTGRES_PASSWORD: password
+          POSTGRES_DB: naturaldb
+          POSTGRES_HOST: localhost
+          POSTGRES_PORT: 5432
+          POSTGRES_TABLE: naturaltable
+        ports:
+          - 5432:5432  
+      memcached:
+        image: memcached:latest
+        ports:
+          - 11211:11211
+      mongodb:
+        image: mongo:latest
+        ports:
+          - 27017:27017
+
     strategy:
       matrix:
-        node-version: [14.x, 16.x, 18.x]
-        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+        node-version: [16.x, 18.x, 20.x]
+        # See supported Node.js release schedule at 
+        #https://nodejs.org/en/about/releases/
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
-      with:
-        node-version: ${{ matrix.node-version }}
-    - run: npm ci
-    - run: npm run build --if-present
-    - run: npm run coverage
-    # Save coverage report in Coveralls
-    - name: Coveralls
-      uses: coverallsapp/github-action@master
-      with:
-        github-token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Clean install
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Run Istanbul coverage
+        run: npm run coverage
+
+      # Save coverage report in Coveralls
+      - name: Coveralls
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/npm-publish.yml

@@ -11,21 +11,23 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: 12
+          node-version: 20
       - run: npm ci
+      - name: Build
+        run: npm run build
       - run: npm test
 
   publish-npm:
     needs: build
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: 14
+          node-version: 20
           registry-url: https://registry.npmjs.org/
       - run: npm ci
       - run: git config user.name "$GITHUB_ACTOR"

.nycrc

@@ -0,0 +1,9 @@
+{
+  "include": [
+    "io_spec/**/*_spec.js",
+    "dist/**/*_spec.js",
+    "lib/natural/**/*.js",
+    "lib/natural/**/*.ts"
+  ],
+  "reporter": "lcov"
+}

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leader responsible for enforcement: at the moment of writing 
+Hugo ter Doest.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

spec/MaxEntAppliedToPOSTagging_spec.js → examples/classification/MaxEntAppliedToPOSTagging_spec.js

@@ -24,7 +24,7 @@ THE SOFTWARE.
 // const fs = require('fs')
 
 // const base_folder_test_data = 'spec/test_data/'
-const brownCorpus = require('spec/test_data/browntag_nolines_excerpt_maxent.json')
+const brownCorpus = require('./test_data/browntag_nolines_excerpt_maxent.json')
 // const classifierFile = base_folder_test_data + 'classifier.json'
 
 const natural = require('../lib/natural')

examples/classification/try_events.js

@@ -0,0 +1,13 @@
+const natural = require('../../lib/natural')
+const PorterStemmerEs = require('../../lib/natural/stemmers/porter_stemmer_es')
+const classifier = new natural.LogisticRegressionClassifier(PorterStemmerEs)
+
+classifier.addDocument('ranchero golpe', 'Huevos')
+classifier.addDocument('bbq', 'Huevos')
+classifier.addDocument('salchichas ranchero', 'Tortas')
+
+classifier.on('trainedWithDocument', (v) => console.log(v))
+classifier.on('doneTraining', (v) => console.log(v))
+classifier.train()
+
+classifier.save('classifier.json', (err) => console.log(err))

examples/stemming/stem_corpus.js

@@ -22,7 +22,7 @@ THE SOFTWARE.
 
 'use strict'
 
-const natural = require('lib/natural')
+const natural = require('natural')
 const stemmer = natural.PorterStemmer
 
 console.log(stemmer.tokenizeAndStem('i stemmed words.'))