bookshelf-scopes - npm Package Compare versions

Comparing version 1.0.0 to 1.0.2

package.json

 {
   "name": "bookshelf-scopes",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Giving you Rails like scopes in Bookshelf.js.",
@@ -5,0 +5,0 @@ "main": "src/scopes.js",

README.md

@@ -1,2 +0,126 @@
-# bookshelf-scopes
+# Bookshelf-Scopes
 Giving you Rails like scopes in Bookshelf.js.
+
+If you add in the plugin like so:
+```javascript
+var bookshelf = require('bookshelf')(knex);
+
+bookshelf.plugin(scopes);
+```
+
+You will then be able to add a scopes property on your models that will give you
+a Knex query builder as the first argument and then followed by any additional
+arguments. See examples below.
+
+Also just like rails we can set a default. See examples below.
+
+## Examples
+
+### Simple
+
+You can define a model with scopes and an active function like this:
+```javascript
+var TestModel = bookshelf.Model.extend({
+  tableName: 'testmodel',
+  scopes: {
+    active: function(qb) {
+      qb.where({status: 'Active'});
+    },
+    nameContains: function(gb, text) {
+      qb.where(knex.raw('name LIKE ?', '%' + name + '%'));
+    }
+  }
+});
+```
+You can now run code like this to get all Active:
+```javascript
+TestModel.active().fetchAll().then(function(allActiveTests) {
+  ...
+});
+```
+You can also get all active where name contains test as well:
+```javascript
+TestModel.active().nameContains('test').fetchAll().then(function(allActiveTests) {
+  ...
+});
+```
+
+### Default
+
+You can define a model with scopes and default like this:
+```javascript
+var TestModel = bookshelf.Model.extend({
+  tableName: 'testmodel',
+  scopes: {
+    default: function(qb) {
+      qb.where({archived: 0});
+    }
+  }
+});
+```
+Now if you call fetchAll or fetch on any of your queries you will only get items that have archive set to 0:
+```javascript
+TestModel.fetchAll().then(function(allUnArchived) {
+  ...
+});
+```
+
+If you need to query without the default scope you can call unscoped like so:
+```javascript
+TestModel.unscoped().fetchAll().then(function(allModels) {
+  ...
+});
+```
+
+### Combine Methods In Scope
+
+You can define a bunch of scope functions you can also combine them in another scope function.
+```javascript
+var TestModel = bookshelf.Model.extend({
+  tableName: 'testmodel',
+  scopes: {
+    running: function(qb) {
+      qb.where({running: 0});
+    },
+    byDate: function(qb, date) {
+      qb.where('created_date', '>=', date);
+    },
+    runningByDate: function(qb, date) {
+      this.running(qb);
+      this.byDate(qb, date);
+    }
+  }
+});
+```
+Now you can use the combined scope method as well to make things more readable.
+```javascript
+TestModel.runningByDate('2015-01-01').fetchAll().then(function(allUnArchived) {
+  ...
+});
+```
+
+### Override Initialize
+
+If in your model you set an initialize you will need to call addScope() to add default scope if you want it
+
+```javascript
+var TestModel = bookshelf.Model.extend({
+  tableName: 'testmodel',
+  scopes: {
+    default: function(qb) {
+      qb.where({status: 'Active'});
+    }
+  },
+  initialize: function() {
+    this.addScope(); //Now default scope is set, all other scopes work regardless.
+    this.newValue = 1;
+  }
+});
+```
+
+Then calls to fetchAll will include it.
+```javascript
+TestModel.fetchAll().then(function(allActive) {
+  ...
+});
+```

src/scopes.js

@@ -8,8 +8,7 @@ 'use strict';
 
-  bookshelf.Model.extend = function(protoProps, staticProps) {
-    var oldScopes = this.prototype.scopes || {};
-    var self = baseExtend.apply(this, arguments);
-    self.scopes = _.extend({}, oldScopes, protoProps.scopes || {});
+  bookshelf.Model.extend = function(protoProps) {
+    var self = this;
+    self.scopes = _.extend({}, self.scopes || {}, protoProps.scopes || {});
 
-    Object.keys(self.prototype.scopes).forEach(function(property) {
+    Object.keys(self.scopes).forEach(function(property) {
       self.prototype[property] = function() {
@@ -19,3 +18,4 @@ var passedInArguments = _.toArray(arguments);
         return this.query(function(qb) {
-          self.scopes[property].apply(qb, passedInArguments);
+          passedInArguments.unshift(qb);
+          self.scopes[property].apply(self.scopes, passedInArguments);
         });
@@ -27,6 +27,36 @@ };
       }
-    })
+    });
 
-    return self;
+    return baseExtend.apply(self, arguments);
   }
+
+  var Model = bookshelf.Model.extend({
+
+    scopes: null,
+
+    initialize: function() {
+      this.addScope();
+    },
+
+    addScope: function() {
+      var self = this;
+      if (self.scopes && self.scopes.default) {
+        self.query(function(qb) {
+          var args = new Array();
+          args.push(qb);
+          self.scopes.default.apply(self.scopes, args);
+        });
+      }
+    },
+
+    unscoped: function() {
+      return this.resetQuery();
+    }
+  }, {
+    unscoped: function() {
+      return this.forge().unscoped();
+    }
+  });
+
+  bookshelf.Model = Model;
 }

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

Improved metrics

Total package byte prevSize

27510

increased by150.05%

Number of package files

9

increased by28.57%

Lines of code

475

increased by295.83%

Number of lines in readme file

127

increased by4133.33%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes