natural 6.11.1 → 6.12.0

package/.env

@@ -1,12 +1,12 @@
 # Storage backend you want to use
 NATURAL_STORAGE=PG
 # Settings for Postgres
-PG_USER=user
-PG_PASSWORD=password
-PG_DATABASE=naturaldb
-PG_HOST=localhost
-PG_PORT=5432
-PG_TABLE=naturaltable
+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
@@ -18,5 +18,6 @@ MEM_EXPIRES = 3600
 MONGO_HOST=localhost
 MONGO_PORT=27017
 MONGO_DATABASE=naturaldb
+MONGO_OBJECTMODEL=NaturalObjectModel
 # Path to the folder writing files 
 FS_PATH=.

package/.github/workflows/node.js.yml

@@ -1,35 +1,76 @@
-# 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: [16.x, 18.x, 20.x]
-        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+        # 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: Run tests
+        run: npm run test
+
+      - name: Run IO tests
+        run: npm run test_io
+
+      - 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 }}

package/lib/natural/classifiers/bayes_classifier.js

@@ -52,6 +52,11 @@ class BayesClassifier extends Classifier {
       }
     })
   }
+
+  static async loadFrom (key, stemmer, storageBackend) {
+    const classifier = await Classifier.loadFrom(key, storageBackend)
+    return BayesClassifier.restore(classifier, stemmer)
+  }
 }
 
 module.exports = BayesClassifier

package/lib/natural/classifiers/classifier.js

@@ -164,6 +164,16 @@ class Classifier extends EventEmitter {
     })
   }
 
+  async saveTo (storageBackend) {
+    return await storageBackend.store(this)
+  }
+
+  static async loadFrom (key, storageBackend) {
+    const obj = await storageBackend.retrieve(key)
+    Object.setPrototypeOf(obj, Classifier.prototype)
+    return obj
+  }
+
   setOptions (options) {
     this.keepStops = !!(options.keepStops)
   }

package/lib/natural/classifiers/logistic_regression_classifier.js

@@ -42,15 +42,20 @@ class LogisticRegressionClassifier extends Classifier {
   }
 
   static load (filename, stemmer, callback) {
-    Classifier.load(filename, function (err, classifier) {
+    Classifier.load(filename, (err, classifier) => {
       if (err) {
         callback(err)
       } else {
-        callback(err, this.restore(classifier, stemmer))
+        callback(err, LogisticRegressionClassifier.restore(classifier, stemmer))
       }
     })
   }
 
+  static async loadFrom (key, stemmer, storageBackend) {
+    const classifier = await Classifier.loadFrom(key, storageBackend)
+    return LogisticRegressionClassifier.restore(classifier, stemmer)
+  }
+
   train () {
     // we need to reset the training state because logistic regression
     // needs its matricies to have their widths synced, etc.

package/lib/natural/util/storage/File.js

@@ -1,3 +1,25 @@
+/*
+Copyright (c) 2024, Hugo W.L. ter Doest
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+*/
+
 require('dotenv').config()
 const { v4: uuidv4 } = require('uuid')
 const fs = require('fs').promises

package/lib/natural/util/storage/Memcached.js

@@ -1,3 +1,25 @@
+/*
+Copyright (c) 2024, Hugo W.L. ter Doest
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+*/
+
 const { v4: uuidv4 } = require('uuid')
 require('dotenv').config()
 const memjs = require('memjs')

package/lib/natural/util/storage/MongoDB.js

@@ -1,14 +1,42 @@
+/*
+Copyright (c) 2024, Hugo W.L. ter Doest
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+*/
+
 require('dotenv').config()
 const mongoose = require('mongoose')
 const mongoDBConnectionString = 'mongodb://' + process.env.MONGO_HOST + ':' +
   process.env.MONGO_PORT + '/' + process.env.MONGO_DATABASE
+const objectModelName = process.env.MONGO_OBJECTMODEL
 
 class MongoDBPlugin {
   constructor () {
     mongoose.connect(mongoDBConnectionString, {})
-    // We do not enforce a schema with MongoDB
-    this.ObjectModel = mongoose.model('ObjectModel', new mongoose.Schema({},
-      { strict: false, versionKey: false }))
+
+    if (!mongoose.models[objectModelName]) {
+      // We do not enforce a schema with MongoDB
+      this.ObjectModel = mongoose.model(objectModelName, new mongoose.Schema({},
+        { strict: false, versionKey: false }))
+    } else {
+      this.ObjectModel = mongoose.models[objectModelName]
+    }
   }
 
   async store (object, options) {

package/lib/natural/util/storage/Postgres.js

@@ -1,54 +1,71 @@
+/*
+Copyright (c) 2024, Hugo W.L. ter Doest
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+*/
+
 const postgres = require('pg')
 require('dotenv').config()
 
 class PostgresPlugin {
   constructor () {
-    this.configPostgres()
+    this.postgresClient = null
   }
 
   async configPostgres () {
     // Initialize connection to Postgres
     const client = new postgres.Client({
-      user: process.env.PG_USER,
-      host: process.env.PG_HOST,
-      database: process.env.PG_DATABASE,
-      password: process.env.PG_PASSWORD,
-      port: process.env.PG_PORT
+      user: process.env.POSTGRES_USER,
+      host: process.env.POSTGRES_HOST,
+      database: process.env.POSTGRES_DB,
+      password: process.env.POSTGRES_PASSWORD,
+      port: process.env.POSTGRES_PORT
     })
     this.postgresClient = client
-    this.postgresTableName = process.env.PG_TABLE
+    this.postgresTableName = process.env.POSTGRES_TABLE
+
     // Connect to the database
-    return new Promise((resolve, reject) => {
-      client.connect()
-        .then(() => {
-          // Call the function to create the table
-          createTable(this.postgresTableName)
-          resolve()
-        })
-        .catch(err => {
-          console.error('Error connecting to the database:', err)
-          reject(err)
-        })
-    })
+    await client.connect()
+
+    // Call the function to create the table
+    await this.createTableIfNotExists(client, this.postgresTableName)
+
+    // Don't forget to close the connection when done
+    // await client.end()
+  }
+
+  // Function to create the table
+  async createTableIfNotExists (client, tableName) {
+    // Check if the table exists
+    const query = `SELECT to_regclass('${tableName}')`
+    const result = await client.query(query)
 
-    // Function to create the table
-    function createTable (tableName) {
-      // We use JSONB (binary JSON format of Postgres) to store objects
+    if (result.rows[0].to_regclass === null) {
+      // Table does not exist, create it
       const createTableQuery = `
-        CREATE TABLE IF NOT EXISTS ${tableName} (
+        CREATE TABLE ${tableName} (
           id SERIAL PRIMARY KEY,
           data JSONB
         );
       `
-      return new Promise((resolve, reject) => {
-        client.query(createTableQuery)
-          .then(() => {
-            resolve()
-          })
-          .catch(error => {
-            reject(error)
-          })
-      })
+      await client.query(createTableQuery)
+      console.log('table created')
     }
   }
 

package/lib/natural/util/storage/Redis.js

@@ -1,3 +1,25 @@
+/*
+Copyright (c) 2024, Hugo W.L. ter Doest
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+*/
+
 const { v4: uuidv4 } = require('uuid')
 require('dotenv').config()
 const redis = require('redis')

package/lib/natural/util/storage/StorageBackend.js

@@ -1,3 +1,25 @@
+/*
+Copyright (c) 2024, Hugo W.L. ter Doest
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+*/
+
 const PostgresPlugin = require('./Postgres')
 const MongoDBPlugin = require('./MongoDB')
 const RedisPlugin = require('./Redis')
@@ -38,6 +60,7 @@ class StorageBackend {
     switch (storageType) {
       case STORAGE_TYPES.POSTGRES:
         this.client = new PostgresPlugin()
+        await this.client.configPostgres()
         break
       case STORAGE_TYPES.REDIS:
         this.client = new RedisPlugin()

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "natural",
   "description": "General natural language (tokenizing, stemming (English, Russian, Spanish), part-of-speech tagging, sentiment analysis, classification, inflection, phonetics, tfidf, WordNet, jaro-winkler, Levenshtein distance, Dice's Coefficient) facilities for node.",
-  "version": "6.11.1",
+  "version": "6.12.0",
   "homepage": "https://github.com/NaturalNode/natural",
   "repository": {
     "type": "git",
@@ -64,8 +64,8 @@
   "scripts": {
     "benchmark": "node benchmarks",
     "clean": "rimraf *~ #* *classifier.json",
-    "test": "NODE_PATH=. node ./node_modules/jasmine/bin/jasmine.js io_spec/*_spec.js spec/*_spec.js",
-    "coverage": "nyc --reporter=lcov npm test",
+    "test": "NODE_PATH=. node ./node_modules/jasmine/bin/jasmine.js --random=false spec/*_spec.js",
+    "coverage": "nyc --reporter=lcov npm run test && nyc npm run test_io",
     "test_io": "NODE_PATH=. node ./node_modules/jasmine/bin/jasmine.js --random=false io_spec/*_spec.js",
     "test_browser": "NODE_PATH=. node ./node_modules/gulp/bin/gulp.js",
     "lint": "eslint . --ext .ts",

package/tsconfig.json

@@ -17,7 +17,7 @@
   "include": [
     "lib/natural/**/*",
     "spec/*"
-  ],
+, "io_spec/StorageBackend_spec.js"  ],
   "exclude": [
     "./node_modules"
   ]

package/f2f5d4bc-daa0-4392-8981-9614cd0c802e.json

@@ -1 +0,0 @@
-{"attr1":"val1","attr2":"val2"}