npm - sorla-db - Versions diffs - 1.0.0 - Mend

sorla-db 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (26) hide show

package/Brainstorming.md +22 -0
package/LICENSE +21 -0
package/README.md +31 -0
package/debug-not.js +24 -0
package/dist/sorla.min.js +1 -0
package/example/simple_data_example.html +196 -0
package/index.js +62 -0
package/package.json +42 -0
package/src/collections/collection.js +47 -0
package/src/dbs/database.js +72 -0
package/src/documents/cursor.js +144 -0
package/src/documents/document.js +88 -0
package/src/helper.js +41 -0
package/src/query_language/index.js +0 -0
package/src/query_language/manipulation.js +161 -0
package/src/query_language/operators.js +289 -0
package/src/query_language/query.js +104 -0
package/src/sorla.js +123 -0
package/src/utils.js +41 -0
package/test/feature_collection.test.js +73 -0
package/test/feature_collection_queries.test.js +269 -0
package/test/unit_database.test.js +36 -0
package/test/unit_document_test.js +39 -0
package/test/unit_sorla.test.js +42 -0
package/test/unit_test.test.js +25 -0
package/webpack.config.js +11 -0

package/example/simple_data_example.html ADDED Viewed

@@ -0,0 +1,196 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <meta charset="UTF-8">
+        <title>Simple Data Example</title>
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    </head>
+    <body>
+        <p><b>Total Items:</b> <span id="total-items"></span></p><hr>
+        <h3>Add you data:</h3>
+        <div>
+            <label>Name</label>
+            <input type="text" id="name" placeholder="Name">
+        </div>
+        <div>
+            <label>Inscription</label>
+            <input type="number" step="1" min="1" id="inscription" placeholder="Inscription">
+        </div>
+        <div>
+            <label>Age</label>
+            <input type="number" step="1" min="1" id="age" placeholder="Age">
+        </div>
+        <div>
+            <label>Father</label>
+            <input type="text" id="father" placeholder="Father">
+        </div>
+        <div>
+            <label>Mother</label>
+            <input type="text" id="mother" placeholder="Mother">
+        </div>
+        <button type="button" id="add-data">Add data</button>
+        <hr>
+        <h3>Seach data</h3>
+        <div>
+            <label>Search by</label>
+            <input type="text" id="search-name" placeholder="Search by">
+            <select id="search-name-type">
+                <option value="name">Name</option>
+                <option value="inscription">Inscription</option>
+                <option value="age">Age</option>
+                <option value="parents.father">Father</option>
+                <option value="parents.mother">Mother</option>
+            </select>
+            <button type="button" id="search-by-btn">Search</button>
+        </div>
+        <div>
+            <textarea id="search-result" cols="30" rows="10"></textarea>
+        </div>
+        <script src="../dist/sorla.min.js"></script>
+        <script>
+            function generateUUID() {
+                return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function(c) {
+                    var r = Math.random() * 16 | 0,
+                        v = c == 'x' ? r : (r & 0x3 | 0x8);
+                    return v.toString(16);
+                });
+            }
+            addItem = () => {
+                const name = document.getElementById('name').value;
+                const inscription = document.getElementById('inscription').value;
+                const age = document.getElementById('age').value;
+                const father = document.getElementById('father').value;
+                const mother = document.getElementById('mother').value;
+                s.db.simple.insertOne({
+                    'name': name,
+                    'inscription': inscription,
+                    'age': age,
+                    'parents': {
+                        'father': father,
+                        'mother': mother
+                    }
+                });
+                document.getElementById('total-items').innerText = s.db.simple.count();
+            }
+            searchData = () => {
+                const searchName = document.getElementById('search-name').value;
+                const searchNameType = document.getElementById('search-name-type').value;
+                const result = s.db.simple.findOne({
+                    [searchNameType]: searchName
+                });
+                console.log(result);
+                document.getElementById('search-result').value = JSON.stringify(result, null, 4);
+            }
+            document.addEventListener('DOMContentLoaded', () => {
+                window.s = new sorla();
+                s.useDb('simple_database');
+                s.db.createCollection('simple');
+                const uuid_fix = generateUUID();
+                //creating data
+                s.db.simple.insertMany([
+                    {
+                        'name': 'John Doe',
+                        'inscription': 123,
+                        'age': 25,
+                        'parents': {
+                            'father': 'John Doe Sr.',
+                            'mother': 'Jane Doe'
+                        },
+                        'uuid': generateUUID()
+                    },
+                    {
+                        "name": "Elizabeth Davis",
+                        "inscription": 618,
+                        "age": 36,
+                        "parents": {
+                            "father": "Elizabeth Brown",
+                            "mother": "Elizabeth Brown"
+                        },
+                        'uuid': generateUUID()
+                    },
+                    {
+                        "name": "John Davis",
+                        "inscription": 817,
+                        "age": 54,
+                        "parents": {
+                            "father": "John Garcia",
+                            "mother": "Patricia Garcia"
+                        },
+                        'uuid': uuid_fix
+                    },
+                    {
+                        "name": "Jennifer Miller",
+                        "inscription": 699,
+                        "age": 45,
+                        "parents": {
+                            "father": "Linda Brown",
+                            "mother": "Elizabeth Brown"
+                        },
+                        'uuid': generateUUID()
+                    },
+                    {
+                        "name": "Patricia Johnson",
+                        "inscription": 906,
+                        "age": 49,
+                        "parents": {
+                            "father": "Robert Johnson",
+                            "mother": "Elizabeth Johnson"
+                        },
+                        'uuid': generateUUID()
+                    },
+                    {
+                        "name": "Michael Johnson",
+                        "inscription": 810,
+                        "age": 20,
+                        "parents": {
+                            "father": "Jennifer Brown",
+                            "mother": "Jennifer Brown"
+                        },
+                        'uuid': generateUUID()
+                    }
+                ]);
+                document.getElementById('total-items').innerText = s.db.simple.count();
+                document.getElementById('add-data').addEventListener('click', addItem);
+                document.getElementById('search-by-btn').addEventListener('click', searchData);
+                //operators test
+                //testing search and
+                /*const result = s.db.simple.find({'$and': [{'name': 'John Doe'}, {'age': 25}]}, {_id: 0}); //should return 1
+                console.log('and', result);
+                //testing search or
+                const result2 = s.db.simple.find({'$or': [{'name': 'John Doe'}, {'parents.mother': 'Elizabeth Johnson'}]}); //should return 2
+                console.log('or', result2);
+                //testing search uuid
+                const result3 = s.db.simple.findOne({'uuid': uuid_fix});
+                console.log('uuid', uuid_fix, result3);*/
+                //search uuid with not
+                const result4 = s.db.simple.find({'uuid': {'$not': uuid_fix}});
+                console.log('uuid not', uuid_fix, result4);
+            });
+        </script>
+    </body>
+</html>

package/index.js ADDED Viewed

@@ -0,0 +1,62 @@
+const fs = require('fs-extra');
+const browserify = require('browserify');
+const path = require('path');
+const terser = require('terser');
+const srcDir = './src';
+const distDir = './dist';
+const outputFile = `${distDir}/sorla.min.js`;
+function findJsFiles(dir, fileList = [])
+{
+    const files = fs.readdirSync(dir);
+    files.forEach(file => {
+        const filePath = path.join(dir, file);
+        const stat = fs.statSync(filePath);
+        if (stat.isDirectory())
+        {
+            findJsFiles(filePath, fileList);
+        }
+        else if (path.extname(filePath) === '.js')
+        {
+            fileList.push(filePath);
+        }
+    });
+    return fileList;
+}
+function buildForBrowser(entryFile, outputFile) {
+    const b = browserify();
+    b.add(entryFile);
+    b.bundle(async (err, buf) => {
+        if (err) {
+            console.error(err);
+            return;
+        }
+        const code = buf.toString();
+        try {
+            const minified = await terser.minify(code, {
+                compress: true,
+                mangle: {
+                    keep_classnames: true,
+                    keep_fnames: true
+                }
+            });
+            if (minified.error) {
+                console.error(minified.error);
+                return;
+            }
+            fs.outputFileSync(outputFile, code);
+            fs.outputFileSync(outputFile, minified.code);
+        } catch (minifyErr) {
+            console.error(minifyErr);
+        }
+    });
+}
+const allJsFiles = findJsFiles(srcDir);
+buildForBrowser(allJsFiles, outputFile);

package/package.json ADDED Viewed

@@ -0,0 +1,42 @@
+{
+  "name": "sorla-db",
+  "version": "1.0.0",
+  "description": "A simple and temporary database focused to use in browser environment that will bring capabilities for other tools that will be launched as soon as possible.",
+  "main": "dist/sorla.min.js",
+  "scripts": {
+    "mini": "node index.js",
+    "build": "webpack",
+    "test": "jest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sysborg/sorla-db.git"
+  },
+  "keywords": [
+    "nosql",
+    "browser",
+    "database",
+    "sorla",
+    "sysborg",
+    "anderson",
+    "arruda",
+    "andmarruda"
+  ],
+  "author": "Anderson Arruda < andmarruda@gmail.com >",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/sysborg/sorla-db/issues"
+  },
+  "homepage": "https://github.com/sysborg/sorla-db#readme",
+  "devDependencies": {
+    "browserify": "^17.0.0",
+    "chai": "^4.3.8",
+    "faker": "^5.5.3",
+    "fs-extra": "^11.2.0",
+    "jest": "^29.6.4",
+    "jsdom": "^22.1.0",
+    "jsdom-global": "^3.0.2",
+    "mocha": "^10.2.0",
+    "terser": "^5.27.0"
+  }
+}

package/src/collections/collection.js ADDED Viewed

@@ -0,0 +1,47 @@
+const query = require('../query_language/query.js');
+class collection extends query
+{
+    /**
+     * Constructs class Collection to manage documents
+     * @author Anderson Arruda < anderson@sysborg.com.br >
+     * @version 1.0.0
+     * @param object validationSchema - in construction
+     * @return void
+    **/
+    constructor(validationSchema)
+    {
+        super(validationSchema);
+        this._documents = [];
+        this._indexes = [];
+    }
+    /**
+     * Returns the first document of the collection
+     * @return object
+     */
+    get first()
+    {
+        return structuredClone(this._documents[0]._data);
+    }
+    /**
+     * Returns the last document of the collection
+     * @return object
+     */
+    get last()
+    {
+        return structuredClone(this._documents[this._documents.length - 1]._data);
+    }
+    /**
+     * Return all the documents of the collection
+     * @return array
+     */
+    get all()
+    {
+        return this._documents;
+    }
+}
+module.exports =  collection;

package/src/dbs/database.js ADDED Viewed

@@ -0,0 +1,72 @@
+const collection = require('../collections/collection.js');
+class database
+{
+    /**
+     * Constructs class Database to manage collections
+     * @author Anderson Arruda < anderson@sysborg.com.br >
+     * @version 1.0.0
+     * @param  string name
+     * @return void
+    **/
+    constructor(name)
+    {
+        this._collections = {};
+        this._name = name;
+        this._collectionCount = 0;
+        return new Proxy(this, {
+            get: (target, prop, receiver) => {
+                if(prop in target._collections)
+                {
+                    return target._collections[prop];
+                }
+                return target[prop];
+            }
+        });
+    }
+    /**
+     * Returns the database name
+     * @author Anderson Arruda < anderson@sysborg.com.br >
+     * @version 1.0.0
+     * @param
+     * @return string
+    **/
+    get name()
+    {
+        return this._name;
+    }
+    /**
+     * Sets a new collection in the database
+     * @param string name
+     * @param object validationSchema - in construction
+     * @return void
+     */
+    createCollection(name, validationSchema)
+    {
+        if(this._collections.hasOwnProperty(name) || typeof this[name] !== 'undefined')
+        {
+            throw new Error('Collection already exists');
+        }
+        this._collections[name] = new collection(validationSchema);
+        this._collectionCount++;
+        //creates _id as a index unique
+    }
+    /**
+     * Returns the number of collections in the database
+     * @param
+     * @return int
+     */
+    countCollections()
+    {
+        return this._collectionCount;
+    }
+}
+module.exports = database;

package/src/documents/cursor.js ADDED Viewed

@@ -0,0 +1,144 @@
+/**
+ * @class Cursor
+ * @description Cursor class is used to represent the cursor in the document, adding some extra capabilities to object.
+ */
+const documents = require('../documents/document.js');
+class cursor {
+    /**
+     * @constructor
+     * @param array data
+     * @description Create a new cursor instance
+     */
+    constructor(data, projection) {
+        this._data = typeof data === 'undefined' ? [] : data;
+        this.currIndex = 0;
+        if(typeof projection === 'object')
+            this.projection(projection);
+    }
+    /**
+     * @method hasNext
+     * @description Check if the cursor has more elements
+     * @return boolean
+     */
+    hasNext() {
+        return this.currIndex < this._data.length;
+    }
+    /**
+     * @method next
+     * @description Get the next element in the cursor
+     * @return mixed
+     */
+    next() {
+        if(!this.hasNext())
+            throw new Error('No more item to the cursor');
+        return this._data[this.currIndex++];
+    }
+    /**
+     * @method toArray
+     * @description Convert the cursor to an array
+     * @return array
+     */
+    toArray() {
+        return structuredClone(this._data);
+    }
+    /**
+     * @methor reset
+     * @description Reset the cursor to the first element
+     * @return void
+     */
+    reset() {
+        this.currIndex = 0;
+    }
+    /**
+     * @method first
+     * @description Get the first element in the cursor
+     * @return mixed
+     */
+    first() {
+        return this._data[0]._data;
+    }
+    /**
+     * @method last
+     * @description Get the last element in the cursor
+     * @return mixed
+     */
+    last() {
+        return this._data[this._data.length - 1];
+    }
+    /**
+     * @method sort
+     * @description Sort the cursor using collection
+     * @param json sortQuery
+     * @return void
+     */
+    sort(sortQuery) {
+        const queryDoc = new documents(sortQuery);
+        this._data.sort((a, b) => {
+            for(const key of Object.keys(sortQuery))
+            {
+                const ascending = queryDoc[key] === 1;
+                if(a[key] > b[key])
+                    return ascending ? 1 : -1;
+                if(a[key] < b[key])
+                    return ascending ? -1 : 1;
+            }
+            return 0;
+        });
+    }
+    /**
+     * @get length
+     * @description Get the number of elements in the cursor
+     * @return number
+     */
+    get length() {
+        return this._data.length;
+    }
+    /**
+     * Projection of the cursor
+     * @param json projection
+     * @return cursor
+     */
+    projection(projection) {
+        if(projection === null || typeof projection !== 'object')
+            return;
+        const self = this;
+        this._data.forEach(doc => {
+            for(const attribute of Object.keys(projection))
+            {
+                if(projection[attribute] === 0) {
+                    doc.deleteProp(attribute, self);
+                }
+            }
+        });
+    }
+    /**
+     * @method push
+     * @description Push an element to the cursor
+     * @param object element
+     * @return void
+     */
+    push(element) {
+        if(typeof element !== 'object')
+            throw new Error('The element must be an object');
+        this._data.push(element);
+    }
+}
+module.exports = cursor;

package/src/documents/document.js ADDED Viewed

@@ -0,0 +1,88 @@
+const utils = require('../utils');
+const cursor = require('./cursor');
+const manipulation = require('../query_language/manipulation');
+class documents
+{
+    constructor(object)
+    {
+        this._data = object;
+        this._utils = new utils();
+        this._cloned = false;
+        this._deleteReceiver = null;
+        return new Proxy(this, {
+            deleteProperty: (target, prop, receiver) => {
+                if(target._cloned && target._deleteReceiver instanceof cursor)
+                {
+                    if(prop in target._data)
+                    {
+                        console.log('2', prop);
+                        delete target._data[prop];
+                        return true;
+                    }
+                    return false;
+                }
+            },
+            get: (target, prop) => {
+                if(prop.indexOf('.') > -1)
+                    return target._utils.getDotData(target._data, prop);
+                if(prop in target._data)
+                    return target._data[prop];
+                return target[prop];
+            },
+            set: (target, prop, value, receiver) => {
+                if(!(prop in target._data) && !target.hasOwnProperty(prop))
+                    return false;
+                if(target.hasOwnProperty(prop) && ['_data', '_utils'].indexOf(prop) === -1){
+                    target[prop] = value;
+                    return true;
+                }
+                if(receiver instanceof manipulation || target._cloned && receiver instanceof cursor) {
+                    target._data[prop] = value;
+                    return true;
+                }
+                return false;
+            }
+        });
+    }
+    /**
+     * @method clone
+     * @description Clone the document
+     * @return Document
+     */
+    clone()
+    {
+        const cloned = new documents(structuredClone(this._data));
+        cloned._cloned = true;
+        return cloned;
+    }
+    /**
+     * @method delete prop
+     * @description Delete a property from the document
+     * @param string prop
+     * @param cursor receiver
+     * @return boolean
+     */
+    deleteProp(prop, receiver)
+    {
+        this._deleteReceiver = receiver;
+        if(this._cloned)
+            return Reflect.deleteProperty(this, prop);
+        return false;
+    }
+}
+module.exports = documents;

package/src/helper.js ADDED Viewed

@@ -0,0 +1,41 @@
+//this file works only in dev mode, and is used to help with the development of the app
+//and to debug bad behaviors and mistakes
+const faker = require('faker');
+const sorla = require('./sorla.js');
+const createFakeCollection = (srla, collectionName, number_objects) => {
+    if(!(srla instanceof sorla))
+        throw new Error('srla must be an instance of sorla');
+    const objects = [];
+    for(let i=0; i<number_objects; i++)
+    {
+        const obj = {
+            name: faker.random.word(),
+            email: faker.internet.email(),
+            age: faker.datatype.number(),
+            uuid: faker.datatype.uuid()
+        };
+        srla.db[collectionName].insertOne(structuredClone(obj));
+        objects.push(obj);
+    }
+    return objects;
+}
+const getRandomComparisonData = (objects) => {
+    const itemIndex1 = Math.floor(Math.random() * objects.length);
+    let itemIndex2 = null;
+    do {
+        itemIndex2 = Math.floor(Math.random() * objects.length);
+    } while(itemIndex1 === itemIndex2);
+    return [objects[itemIndex1], objects[itemIndex2]];
+}
+module.exports = {
+    createFakeCollection,
+    getRandomComparisonData
+}

package/src/query_language/index.js ADDED Viewed

File without changes