orm-model - npm Package Compare versions

Comparing version 0.0.0 to 0.0.1

package.json

 {
   "name": "orm-model",
-  "version": "0.0.0",
-  "description": "orm-model =========",
+  "version": "0.0.1",
+  "description": "Unified MVC-style structure for ORM models.",
   "main": "index.js",
@@ -18,3 +18,12 @@ "scripts": {
   },
-  "homepage": "https://github.com/xpepermint/orm-model"
+  "homepage": "https://github.com/xpepermint/orm-model",
+  "dependencies": {
+    "lodash": "^2.4.1",
+    "mongoose": "^3.9.1",
+    "mysql": "^2.4.2",
+    "natural": "^0.1.28",
+    "pg": "^3.4.1",
+    "sequelize": "^2.0.0-dev12",
+    "sqlite3": "^2.2.7"
+  }
 }

README.md

@@ -1,2 +0,127 @@
-orm-model
-=========
+# orm-model
+
+![Build Status](https://travis-ci.org/xpepermint/orm-model.svg?branch=master) [![NPM version](https://badge.fury.io/js/orm-model.svg)](http://badge.fury.io/js/orm-model) [![Dependency Status](https://gemnasium.com/xpepermint/orm-model.svg)](https://gemnasium.com/xpepermint/orm-model)
+
+ORM libraries are great but they usually left you with a gigant and unstructured block of code. You have to manually figure the right way on how to split the code into multiple files and it gets event worse when you have multiple databases or even multiple ORMs.
+
+This module brings unified MVC-style structure for models into your NodeJS project. Currently the [mongoose](http://mongoosejs.com/) and [sequelize](http://sequelizejs.com) ORMs are supported.
+
+## Installation
+
+Install the [npm](https://www.npmjs.org/package/orm-model) package.
+
+```
+npm install orm-model --save
+```
+
+## Setup
+
+Let's first configure project's **database connectors**. By default the module will try to read the `config/connectors.js` configuration file so let's create it. The file content should look like the example bellow.
+
+```js
+// config/connectors.js
+module.exports = {
+
+  default: {
+
+    // mongoose database connector
+    'mongo-db': {
+      orm: 'mongoose',
+      uris: ['mongodb://user:secret@hostname:port/database'],
+      options: {}
+    },
+
+    // sequelize database connector
+    'seq-db': {
+      orm: 'sequelize',
+      database: 'database',
+      username: 'root',
+      password: 'secret',
+      options: { dialect: 'mysql' }
+    }
+  },
+
+  production: {}
+};
+```
+
+The next step is to **define models**. The module will load files found at `app/models`. Let's create two models for `mongo-db` connector and two models for `seq-db` connector (defined earlier).
+
+```js
+// app/models/animal.js (mongoose model)
+module.exports = {
+  connector: 'mongo-db',
+  attributes: {
+    name: 'string'
+  },
+  classMethods: {},
+  instanceMethods: {},
+  plugins: [{ fn: require('mongoose-timestamp'), options: { index:true } }],
+  middleware: {
+    pre: [{ event: 'save', fn: function(next) { next() }}],
+    post: [{ event: 'save', fn: function(model) { }}]
+  },
+  options: { strict: true }
+};
+```
+```js
+// app/models/bird.js (mongoose discriminator of animal)
+module.exports = {
+  connector: 'mongo-db',
+  extends: 'animal'
+};
+```
+```js
+// app/models/user.js (sequelize model)
+module.exports = {
+  connector: 'seq-db',
+  attributes: {
+    name: 'STRING'
+  },
+  options: {
+    classMethods: {},
+    instanceMethods: {}
+  }
+};
+```
+```js
+// app/models/friend.js (sequelize model extends from user)
+module.exports = {
+  connector: 'seq-db',
+  extends: 'user'
+};
+```
+
+Now we only have to **load and connect** connectors and models together to make it work. We do this inside project's main file (e.g. `index.js`).
+
+```js
+var orm = require('../orm-model');
+orm.connect({
+  connectorsPath: 'new/file/path.js', // optional
+  modelsPath: 'new/directory/path' // optional
+});
+```
+
+## API
+
+After the project has been setup we can access any model like this:
+
+```js
+var orm = require('orm-model');
+var Bird = orm.model('bird');
+
+Bird.create({ name: "Fluppy" }, function(err, data) {
+  console.log('Mongoose Fluppy bird created.');
+});
+```
+
+You can also access an instance of a connector (database connection).
+
+```js
+var orm = require('orm-model');
+var sequelize = orm.connection('seq-db');
+
+sequelize.query("SELECT * FROM users").success(function(data) {
+  console.log('Sequelize results:', data);
+});
+```

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

16421

increased by680.84%

Number of package files

13

increased by225%

Lines of code

426

increased byInfinity%

Number of lines in readme file

128

increased by4166.67%

Worsened metrics

Dependency count

7

increased byInfinity%

Number of low supply chain risk alerts

12

increased byInfinity%

Dependency changes

• + Addedlodash@^2.4.1

• + Addedmongoose@^3.9.1

• + Addedmysql@^2.4.2

• + Addednatural@^0.1.28

• + Addedpg@^3.4.1

• + Addedsequelize@^2.0.0-dev12

• + Addedsqlite3@^2.2.7

• + Addedabort-controller@3.0.0(transitive)

• + Addedapparatus@0.0.10(transitive)

• + Addedasync@0.9.0(transitive)

• + Addedbase64-js@1.5.1(transitive)

• + Addedbignumber.js@9.0.0(transitive)

• + Addedbindings@1.2.1(transitive)

• + Addedbluebird@2.9.34(transitive)

• + Addedbson@0.2.22(transitive)

• + Addedbuffer@6.0.3(transitive)

• + Addedbuffer-writer@1.0.0(transitive)

• + Addedcore-util-is@1.0.3(transitive)

• + Addeddebug@0.7.4(transitive)

• + Addeddottie@0.3.1(transitive)

• + Addedevent-target-shim@5.0.1(transitive)

• + Addedevents@3.3.0(transitive)

• + Addedgeneric-pool@2.1.12.2.0(transitive)

• + Addedhooks@0.3.2(transitive)

• + Addedieee754@1.2.1(transitive)

• + Addedinflection@1.13.4(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedisarray@1.0.0(transitive)

• + Addedjs-string-escape@1.0.1(transitive)

• + Addedkareem@0.0.4(transitive)

• + Addedkerberos@0.0.4(transitive)

• + Addedlodash@2.4.23.10.1(transitive)

• + Addedmoment@2.30.1(transitive)

• + Addedmongodb@1.4.12(transitive)

• + Addedmongoose@3.9.7(transitive)

• + Addedmpath@0.1.1(transitive)

• + Addedmpromise@0.5.4(transitive)

• + Addedmquery@1.0.0(transitive)

• + Addedms@0.1.0(transitive)

• + Addedmuri@0.3.1(transitive)

• + Addedmysql@2.18.1(transitive)

• + Addednan@1.1.21.3.01.8.4(transitive)

• + Addednatural@0.1.29(transitive)

• + Addednode-uuid@1.4.8(transitive)

• + Addedpacket-reader@0.2.0(transitive)

• + Addedpg@3.6.4(transitive)

• + Addedpg-connection-string@0.1.3(transitive)

• + Addedpg-types@1.6.0(transitive)

• + Addedpgpass@0.0.3(transitive)

• + Addedprocess@0.11.10(transitive)

• + Addedprocess-nextick-args@2.0.1(transitive)

• + Addedreadable-stream@2.3.74.5.2(transitive)

• + Addedregexp-clone@0.0.1(transitive)

• + Addedsafe-buffer@5.1.25.2.1(transitive)

• + Addedsequelize@2.1.3(transitive)

• + Addedset-immediate@0.1.1(transitive)

• + Addedsliced@0.0.5(transitive)

• + Addedsplit@0.3.3(transitive)

• + Addedsqlite3@2.2.7(transitive)

• + Addedsqlstring@2.3.1(transitive)

• + Addedstring_decoder@1.1.11.3.0(transitive)

• + Addedsylvester@0.0.21(transitive)

• + Addedthrough@2.3.8(transitive)

• + Addedtoposort-class@0.3.1(transitive)

• + Addedunderscore@1.13.6(transitive)

• + Addedutil-deprecate@1.0.2(transitive)

• + Addedvalidator@3.43.0(transitive)