gqsimplenedb 0.0.1

package/README.md

@@ -0,0 +1,53 @@
+# gqnedb
+
+```
+                                  .______.    
+   ____    ______ ____   ____   __| _/\_ |__  
+  / ___\  / ____//    \_/ __ \ / __ |  | __ \ 
+ / /_/  >< <_|  |   |  \  ___// /_/ |  | \_\ \
+ \___  /  \__   |___|  /\___  >____ |  |___  /
+/_____/      |__|    \/     \/     \/      \/ 
+```
+
+## Description
+
+* A wrapper module for nedb for crud operations.
+
+## Getting Started
+
+### Dependencies
+```
+  "node_version": "18.20.2",
+  "dependencies": {
+    "nedb":"1.8.0"
+  },
+  "devDependencies": {
+    "gqtest": ">=0.0.17",
+    "coffeescript": "2.7.0",
+    "nodemon": "3.1.10"
+  }
+```
+### Installing
+
+* npm install --save gqnedb
+* npm test
+
+## Help
+
+```
+check out test.coffee for how to use the module
+```
+
+## Authors
+
+glidev5
+
+## Version History
+
+* 0.1
+    * Initial Release
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE.md file for details
+

package/app.coffee

@@ -0,0 +1,96 @@
+Datastore = require 'nedb'
+log=console.log
+db=null
+
+@createDB=(path)->
+  db = new Datastore { filename: (path||'./db/nedb.json'), autoload: true }
+  db.persistence.setAutocompactionInterval 120000
+  log("nedb loaded...")
+  return db
+
+@getDB=()->
+  return db
+
+cleanStr=(str)->
+  return str.trim().toLowerCase()
+
+@handler=(db,opt)->
+  return (req,res,next)->
+    method=cleanStr req.method
+    if method=="get"
+      db.find req.body.query,(err,docs)->
+        if err
+          log err
+          res.send 404,"Server error."
+        else
+          res.send 200,docs
+    
+    else if method=="head"
+      db.count req.body.query,(err,count)->
+        if err
+          log err
+          res.send 404,"Server error."
+        else
+          res.send 200,count
+    
+    else if method=="post"
+      db.insert req.body.data,(err,result)->
+        if err
+          log err
+          res.send 404,"Server error."
+        else
+          res.send 200,result
+    
+    else if method=="upsert"
+      db.update req.body.query,req.body.data,{upsert:true},(err,num,upsert)->
+        if err
+          log err
+          res.send 404,"Server error."
+        else
+          res.send 200,{num:num,upsert:upsert}
+        
+    else if method=="all"||method=="put"||method=="update"||method=="patch"  #use put to do entire doc, use patch to update
+      db.update req.body.query,req.body.data,{multi:true},(err,result)->
+        if err
+          log err
+          res.send 404,"Server error."
+        else
+          res.send 200,result
+          
+    else if method=="delete"||method=="remove"||method=="del"
+      db.remove req.body.query,{multi:(!!req.body.multi)},(err,num)->
+        if err
+          log err
+          res.send 404,"Server error."
+        else
+          db.persistence.compactDatafile();
+          res.send 200,num
+    
+    else if method=="index"
+      db.ensureIndex {fieldName:req.body.field},(err)->
+        if err
+          log err
+          res.send 404,"Server error."
+        else
+          res.send 200,"OK"
+    
+    else if method=="uniqueindex"
+      db.ensureIndex {fieldName:req.body.field,unique:true,sparse:true},(err)->
+        if err
+          log err
+          res.send 404,"Server error."
+        else
+          res.send 200,"OK"
+    
+    else if method=="opt" # other operations
+      if !!opt
+        opt req,res,next,db
+      else
+        next req,res
+    else
+      next req,res
+
+
+
+
+

package/app.js

@@ -0,0 +1,133 @@
+// Generated by CoffeeScript 2.7.0
+(function() {
+  var Datastore, cleanStr, db, log;
+
+  Datastore = require('nedb');
+
+  log = console.log;
+
+  db = null;
+
+  this.createDB = function(path) {
+    db = new Datastore({
+      filename: path || './db/nedb.json',
+      autoload: true
+    });
+    db.persistence.setAutocompactionInterval(120000);
+    log("nedb loaded...");
+    return db;
+  };
+
+  this.getDB = function() {
+    return db;
+  };
+
+  cleanStr = function(str) {
+    return str.trim().toLowerCase();
+  };
+
+  this.handler = function(db, opt) {
+    return function(req, res, next) {
+      var method;
+      method = cleanStr(req.method);
+      if (method === "get") {
+        return db.find(req.body.query, function(err, docs) {
+          if (err) {
+            log(err);
+            return res.send(404, "Server error.");
+          } else {
+            return res.send(200, docs);
+          }
+        });
+      } else if (method === "head") {
+        return db.count(req.body.query, function(err, count) {
+          if (err) {
+            log(err);
+            return res.send(404, "Server error.");
+          } else {
+            return res.send(200, count);
+          }
+        });
+      } else if (method === "post") {
+        return db.insert(req.body.data, function(err, result) {
+          if (err) {
+            log(err);
+            return res.send(404, "Server error.");
+          } else {
+            return res.send(200, result);
+          }
+        });
+      } else if (method === "upsert") {
+        return db.update(req.body.query, req.body.data, {
+          upsert: true
+        }, function(err, num, upsert) {
+          if (err) {
+            log(err);
+            return res.send(404, "Server error.");
+          } else {
+            return res.send(200, {
+              num: num,
+              upsert: upsert
+            });
+          }
+        });
+      } else if (method === "all" || method === "put" || method === "update" || method === "patch") { //use put to do entire doc, use patch to update
+        return db.update(req.body.query, req.body.data, {
+          multi: true
+        }, function(err, result) {
+          if (err) {
+            log(err);
+            return res.send(404, "Server error.");
+          } else {
+            return res.send(200, result);
+          }
+        });
+      } else if (method === "delete" || method === "remove" || method === "del") {
+        return db.remove(req.body.query, {
+          multi: !!req.body.multi
+        }, function(err, num) {
+          if (err) {
+            log(err);
+            return res.send(404, "Server error.");
+          } else {
+            db.persistence.compactDatafile();
+            return res.send(200, num);
+          }
+        });
+      } else if (method === "index") {
+        return db.ensureIndex({
+          fieldName: req.body.field
+        }, function(err) {
+          if (err) {
+            log(err);
+            return res.send(404, "Server error.");
+          } else {
+            return res.send(200, "OK");
+          }
+        });
+      } else if (method === "uniqueindex") {
+        return db.ensureIndex({
+          fieldName: req.body.field,
+          unique: true,
+          sparse: true
+        }, function(err) {
+          if (err) {
+            log(err);
+            return res.send(404, "Server error.");
+          } else {
+            return res.send(200, "OK");
+          }
+        });
+      } else if (method === "opt") { // other operations
+        if (!!opt) {
+          return opt(req, res, next, db);
+        } else {
+          return next(req, res);
+        }
+      } else {
+        return next(req, res);
+      }
+    };
+  };
+
+}).call(this);

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "gqsimplenedb",
+  "version": "0.0.1",
+  "description": "A wrapper module for nedb for crud operations.",
+  "repository": "git@github.com:goldfiction/gqnedb.git",
+  "private": false,
+  "main": "app.js",
+  "node_version": "18.20.2",
+  "dependencies": {
+    "nedb":"1.8.0"
+  },
+  "devDependencies": {
+    "gqtest": ">=0.0.17",
+    "coffeescript": "2.7.0",
+    "nodemon": "3.1.10"
+  },
+  "scripts": {
+    "start": "export NODE_OPTIONS=--openssl-legacy-provider; node --require coffeescript/register db.coffee",
+    "test": "node --require coffeescript/register test.coffee",
+    "test:watch": "nodemon --delay 2 -q -x \"npm test\"",
+    "test:slow": "mocha --openssl-legacy-provider --require coffeescript/register --no-color --reporter min -t 20000 test/test.slow.coffee",
+    "install:nobin": "npm install --no-bin-links --no-optional --omit=optional --ignore-scripts",
+    "install:prod": "npm install --production",
+    "install:prod2": "npm install --omit=dev --no-bin-links",
+    "git": "git add .; git commit -m \"update\"; echo gitted...",
+    "git:push": "git push scm; echo pushed...",
+    "git:setup": "git config --global user.name \"username\";git config --global user.email \"username@gmail.com\";git branch --set-upstream-to=origin/master master;",
+    "commit":"git push origin master && git push bitbucket master && git push nodegit master"
+  },
+  "author": "glidev5@gmail.com",
+  "license": "MIT"
+}

package/test.coffee

@@ -0,0 +1,158 @@
+app=require './app.coffee'
+assert=require 'assert'
+tests=require 'gqtest'
+
+it=tests.it
+xit=tests.xit
+run=tests.doRun
+th=this
+db=null
+opt=null
+hand=null
+next=null
+log=console.log
+
+getRandomInt=(min,max)->
+  return Math.floor(Math.random() * (max - min + 1)) + min
+
+rndid=getRandomInt(1,10000)
+
+# dummy test for code integrity
+it "should be able to run",(done)->
+  done()
+
+# create db
+
+it "should be able to create db",(done)->
+  db=app.createDB()
+  opt=(req,res,next,db)->
+    res.send 200,"OK"
+  hand=app.handler db,opt
+  next=(req,res)->
+    res.send 200,"OK"
+  done()
+
+it "should be able to clean db",(done)->
+  req={method:"delete",body:{query:{"index":rndid},multi:true}}
+  res={send:(status,result)->
+    log status
+    log result
+    assert.equal status,200
+    done()
+  }
+  hand req,res,next
+
+it "should be able to make field unique",(done)->
+  req={method:"uniqueindex",body:{field:"index"}}
+  res={send:(status,result)->
+    log status
+    log result
+    assert.equal status,200
+    done()
+  }
+  hand req,res,next
+
+# post
+it "should be able to post new entry",(done)->
+  req={method:"post",body:{data:{index:rndid,value:"abc"}}}
+  res={send:(status,result)->
+    log status
+    log result
+    assert.equal status,200
+    assert.equal result.value,"abc"
+    done()
+  }
+  hand req,res,next
+
+# get
+it "should be able to get entry",(done)->
+  req={method:"get",body:{query:{index:rndid}}}
+  res={send:(status,result)->
+    log status
+    log result
+    assert.equal status,200
+    assert.equal result[0].value,"abc"
+    done()
+  }
+  hand req,res,next
+
+# head
+it "should be able to head entry",(done)->
+  req={method:"head",body:{query:{index:rndid}}}
+  res={send:(status,result)->
+    log status
+    log result
+    assert.equal status,200
+    assert.equal result,1
+    done()
+  }
+  hand req,res,next
+
+# update
+it "should be able to update entry",(done)->
+  req={method:"update",body:{query:{index:rndid},data:{$set:{value:"def"}}}}
+  res={send:(status,result)->
+    log status
+    log result
+    assert.equal status,200
+    assert.equal result,1
+    done()
+  }
+  hand req,res,next
+
+# upsert
+it "should be able to upsert entry",(done)->
+  req={method:"upsert",body:{query:{index:rndid},data:{index:rndid,value:"ghi"}}}
+  res={send:(status,result)->
+    log status
+    log result
+    assert.equal status,200
+    assert.equal result.num,1
+    done()
+  }
+  hand req,res,next
+
+# delete
+it "should be able to delete entry",(done)->
+  req={method:"delete",body:{query:{index:rndid},multi:true}}
+  res={send:(status,result)->
+    log status
+    log result
+    assert.equal status,200
+    assert.equal result,1
+    done()
+  }
+  hand req,res,next
+
+# opt
+it "should be able to do opt operation",(done)->
+  req={method:"opt",body:{data:{index:rndid}}}
+  res={send:(status,result)->
+    log status
+    log result
+    assert.equal status,200
+    assert.equal result,"OK"
+    done()
+  }
+  next=done
+  hand req,res,next
+
+# no method
+it "should be able to handle no method",(done)->
+  req={method:"none",body:{data:{index:rndid}}}
+  res={send:(status,result)->
+    log status
+    log result
+    assert.equal status,200
+    assert.equal result,"OK"
+    done()
+  }
+  next=(req,res)->
+    res.send 200,"OK"
+  hand req,res,next
+
+xit "should be able to get abc",(done)->
+  assert.equal app.abc,"abc"
+  done()
+
+run()