backgridjs-rails 0.2.6 → 0.3.5

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZjE2OTQ4Y2JjNTM2YzM2MWFkYmEzM2U0MjBhNGViMTQxN2JkZjBiZA==
-  data.tar.gz: !binary |-
-    ZTNiOGU0MGViYmI1ZTUzMTExNmUzMWYyYjNiNzVmNzU4ZWQ1OTliZA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    MWY3MDhiNDhjNDkyOTQ1ZTBiNDM5MTQ0YWUwYWUwMDhmOWNkNjQ4YmFhNTdm
-    NTljZGUyYzMxNzM4NDg0MGIyNDJjY2RkZmM4OGEzOThjNjc2OTcwYThlNTNj
-    Y2FlYjc5ZDRhYzM2MDg3ODQ3ODg1MDc0ODA4ODFiYjAzMzMzMTU=
-  data.tar.gz: !binary |-
-    YzNlNjQ4MTg5YTg1N2Q5ZDE4YTkyYmJkOGE1N2ZmODEwMjg1NDJjMDc2MDc2
-    MDk5MzY3ZTRjYTU1OWU0M2FhYzc2YjZiMmJhMmEzMWE5NWY5MGIxODQ2NzQy
-    N2Y4ZDIwY2E3YWY1YWQ0Y2MyNTMxMjMzOWQ4MWQ0NTg2YjkwMDk=
+SHA1:
+  metadata.gz: 1ab7aafbde55ffeca00bdf228fce029974a92330
+  data.tar.gz: b800be2fe7b2eba3a228ee2cd1b3a17991dc89c5
+SHA512:
+  metadata.gz: c78c96f141e13784f227aac7c34d99e8a14a382c20304de71986a45f04b2f14cd52481fec128e8b2ccfa44e490dc9bd099a412ab1825e7076f9d6c48180c140a
+  data.tar.gz: 4f0f4a01bf087193b623468ca02634e6ca426bb09aecb37a9660c3f1a1f82028098a9031a8383fd7804a47e0045d10f0c80e4a199527ebf0b0061c90f7740642

data/lib/backgridjs-rails/version.rb

@@ -1,3 +1,3 @@
 module BackgridjsRails
-  VERSION = "0.2.6"
+  VERSION = "0.3.5"
 end

data/vendor/assets/javascripts/backgrid-extensions/backgrid-filter.js

@@ -5,8 +5,25 @@
   Copyright (c) 2013 Jimmy Yuen Ho Wong and contributors
   Licensed under the MIT @license.
 */
-
-(function ($, _, Backbone, Backgrid, lunr) {
+(function (root, factory) {
+
+  // CommonJS
+  if (typeof exports == "object") {
+    (function () {
+      var lunr;
+      try { lunr = require("lunr"); } catch (e) {}
+      module.exports = factory(require("underscore"),
+                               require("backbone"),
+                               require("backgrid"),
+                               lunr);
+    }());
+  }
+  // Browser
+  else {
+    factory(root._, root.Backbone, root.Backgrid, root.lunr);
+  }
+
+}(this, function (_, Backbone, Backgrid, lunr) {
 
   "use strict";
 
@@ -25,62 +42,140 @@
     className: "backgrid-filter form-search",
 
     /** @property {function(Object, ?Object=): string} template */
-    template: _.template('<div class="input-prepend input-append"><span class="add-on"><i class="icon-search"></i></span><input type="text" <% if (placeholder) { %> placeholder="<%- placeholder %>" <% } %> name="<%- name %>" /><span class="add-on"><a class="close" href="#">&times;</a></span></div>'),
+    template: _.template('<span class="search">&nbsp;</span><input type="search" <% if (placeholder) { %> placeholder="<%- placeholder %>" <% } %> name="<%- name %>" <% if (value) { %> value="<%- value %>" <% } %>/><a class="clear" data-backgrid-action="clear" href="#">&times;</a>', null, {variable: null}),
 
     /** @property */
     events: {
-      "click .close": "clear",
+      "keyup input[type=search]": "showClearButtonMaybe",
+      "click a[data-backgrid-action=clear]": "clear",
       "submit": "search"
     },
 
     /** @property {string} [name='q'] Query key */
     name: "q",
 
-    /** @property The HTML5 placeholder to appear beneath the search box. */
+    /** @property {string} [value] The search box value.  */
+    value: null,
+
+    /**
+       @property {string} [placeholder] The HTML5 placeholder to appear beneath
+       the search box.
+    */
     placeholder: null,
 
     /**
        @param {Object} options
        @param {Backbone.Collection} options.collection
-       @param {String} [options.name]
-       @param {String} [options.placeholder]
+       @param {string} [options.name]
+       @param {string} [options.value]
+       @param {string} [options.placeholder]
+       @param {function(Object): string} [options.template]
     */
     initialize: function (options) {
-      Backgrid.requireOptions(options, ["collection"]);
-      Backbone.View.prototype.initialize.apply(this, arguments);
+      ServerSideFilter.__super__.initialize.apply(this, arguments);
       this.name = options.name || this.name;
+      this.value = options.value || this.value;
       this.placeholder = options.placeholder || this.placeholder;
+      this.template = options.template || this.template;
 
+      // Persist the query on pagination
       var collection = this.collection, self = this;
       if (Backbone.PageableCollection &&
           collection instanceof Backbone.PageableCollection &&
           collection.mode == "server") {
         collection.queryParams[this.name] = function () {
-          return self.$el.find("input[type=text]").val();
+          return self.searchBox().val() || null;
         };
       }
     },
 
+    /**
+       Event handler. Clear the search box and reset the internal search value.
+     */
+    clearSearchBox: function() {
+      this.value = null;
+      this.searchBox().val(null);
+      this.showClearButtonMaybe();
+    },
+
+    /**
+       Event handler. Show the clear button when the search box has text, hide
+       it otherwise.
+     */
+    showClearButtonMaybe: function () {
+      var $clearButton = this.clearButton();
+      var searchTerms = this.searchBox().val();
+      if (searchTerms) $clearButton.show();
+      else $clearButton.hide();
+    },
+
+    /**
+       Returns the search input box.
+     */
+    searchBox: function () {
+      return this.$el.find("input[type=search]");
+    },
+
+    /**
+       Returns the clear button.
+     */
+    clearButton: function () {
+      return this.$el.find("a[data-backgrid-action=clear]");
+    },
+
+
+    /**
+       Returns the current search query.
+     */
+    query: function() {
+      this.value = this.searchBox().val();
+      return this.value;
+    },
+
     /**
        Upon search form submission, this event handler constructs a query
        parameter object and pass it to Collection#fetch for server-side
        filtering.
+
+       If the collection is a PageableCollection, searching will go back to the
+       first page.
     */
     search: function (e) {
       if (e) e.preventDefault();
+
       var data = {};
-      data[this.name] = this.$el.find("input[type=text]").val();
-      this.collection.fetch({data: data});
+      var query = this.query();
+      if (query) data[this.name] = query;
+
+      var collection = this.collection;
+
+      // go back to the first page on search
+      if (Backbone.PageableCollection &&
+          collection instanceof Backbone.PageableCollection) {
+        collection.getFirstPage({data: data, reset: true, fetch: true});
+      }
+      else collection.fetch({data: data, reset: true});
     },
 
     /**
-       Event handler for the close button. Clears the search box and refetch the
+       Event handler for the clear button. Clears the search box and refetch the
        collection.
+
+       If the collection is a PageableCollection, clearing will go back to the
+       first page.
     */
     clear: function (e) {
       if (e) e.preventDefault();
-      this.$("input[type=text]").val(null);
-      this.collection.fetch();
+      this.clearSearchBox();
+
+      var collection = this.collection;
+
+      // go back to the first page on clear
+      if (Backbone.PageableCollection &&
+          collection instanceof Backbone.PageableCollection) {
+        collection.getFirstPage({reset: true, fetch: true});
+      }
+      else collection.fetch({reset: true});
     },
 
     /**
@@ -93,6 +188,7 @@
         placeholder: this.placeholder,
         value: this.value
       }));
+      this.showClearButtonMaybe();
       this.delegateEvents();
       return this;
     }
@@ -110,27 +206,26 @@
   var ClientSideFilter = Backgrid.Extension.ClientSideFilter = ServerSideFilter.extend({
 
     /** @property */
-    events: {
-      "click .close": function (e) {
+    events: _.extend({}, ServerSideFilter.prototype.events, {
+      "click a[data-backgrid-action=clear]": function (e) {
         e.preventDefault();
         this.clear();
       },
-      "change input[type=text]": "search",
-      "keyup input[type=text]": "search",
+      "keydown input[type=search]": "search",
       "submit": function (e) {
         e.preventDefault();
         this.search();
       }
-    },
+    }),
 
     /**
-       @property {?Array.<string>} A list of model field names to search
-       for matches. If null, all of the fields will be searched.
+       @property {?Array.<string>} [fields] A list of model field names to
+       search for matches. If null, all of the fields will be searched.
     */
     fields: null,
 
     /**
-       @property wait The time in milliseconds to wait since for since the last
+       @property [wait=149] The time in milliseconds to wait since the last
        change to the search box's value before searching. This value can be
        adjusted depending on how often the search box is used and how large the
        search index is.
@@ -143,23 +238,20 @@
 
        @param {Object} options
        @param {Backbone.Collection} options.collection
-       @param {String} [options.placeholder]
-       @param {String} [options.fields]
-       @param {String} [options.wait=149]
+       @param {string} [options.placeholder]
+       @param {string} [options.fields]
+       @param {string} [options.wait=149]
     */
     initialize: function (options) {
-      ServerSideFilter.prototype.initialize.apply(this, arguments);
+      ClientSideFilter.__super__.initialize.apply(this, arguments);
 
       this.fields = options.fields || this.fields;
       this.wait = options.wait || this.wait;
 
       this._debounceMethods(["search", "clear"]);
 
-      var collection = this.collection;
+      var collection = this.collection = this.collection.fullCollection || this.collection;
       var shadowCollection = this.shadowCollection = collection.clone();
-      shadowCollection.url = collection.url;
-      shadowCollection.sync = collection.sync;
-      shadowCollection.parse = collection.parse;
 
       this.listenTo(collection, "add", function (model, collection, options) {
         shadowCollection.add(model, options);
@@ -167,9 +259,14 @@
       this.listenTo(collection, "remove", function (model, collection, options) {
         shadowCollection.remove(model, options);
       });
-      this.listenTo(collection, "sort reset", function (collection, options) {
+      this.listenTo(collection, "sort", function (col) {
+        if (!this.searchBox().val()) shadowCollection.reset(col.models);
+      });
+      this.listenTo(collection, "reset", function (col, options) {
         options = _.extend({reindex: true}, options || {});
-        if (options.reindex) shadowCollection.reset(collection.models);
+        if (options.reindex && options.from == null && options.to == null) {
+          shadowCollection.reset(col.models);
+        }
       });
     },
 
@@ -187,22 +284,47 @@
       this.delegateEvents();
     },
 
+    /**
+       Constructs a Javascript regular expression object for #makeMatcher.
+
+       This default implementation takes a query string and returns a Javascript
+       RegExp object that matches any of the words contained in the query string
+       case-insensitively. Override this method to return a different regular
+       expression matcher if this behavior is not desired.
+
+       @param {string} query The search query in the search box.
+       @return {RegExp} A RegExp object to match against model #fields.
+     */
+    makeRegExp: function (query) {
+      return new RegExp(query.trim().split(/\s+/).join("|"), "i");
+    },
+
     /**
        This default implementation takes a query string and returns a matcher
        function that looks for matches in the model's #fields or all of its
        fields if #fields is null, for any of the words in the query
-       case-insensitively.
+       case-insensitively using the regular expression object returned from
+       #makeRegExp.
+
+       Most of time, you'd want to override the regular expression used for
+       matching. If so, please refer to the #makeRegExp documentation,
+       otherwise, you can override this method to return a custom matching
+       function.
 
        Subclasses overriding this method must take care to conform to the
-       signature of the matcher function. In addition, when the matcher function
-       is called, its context will be bound to this ClientSideFilter object so
-       it has access to the filter's attributes and methods.
+       signature of the matcher function. The matcher function is a function
+       that takes a model as paramter and returns true if the model matches a
+       search, or false otherwise.
+
+       In addition, when the matcher function is called, its context will be
+       bound to this ClientSideFilter object so it has access to the filter's
+       attributes and methods.
 
        @param {string} query The search query in the search box.
        @return {function(Backbone.Model):boolean} A matching function.
     */
     makeMatcher: function (query) {
-      var regexp = new RegExp(query.trim().split(/\W/).join("|"), "i");
+      var regexp = this.makeRegExp(query);
       return function (model) {
         var keys = this.fields || model.keys();
         for (var i = 0, l = keys.length; i < l; i++) {
@@ -216,18 +338,28 @@
        Takes the query from the search box, constructs a matcher with it and
        loops through collection looking for matches. Reset the given collection
        when all the matches have been found.
+
+       If the collection is a PageableCollection, searching will go back to the
+       first page.
     */
     search: function () {
-      var matcher = _.bind(this.makeMatcher(this.$("input[type=text]").val()), this);
-      this.collection.reset(this.shadowCollection.filter(matcher), {reindex: false});
+      var matcher = _.bind(this.makeMatcher(this.query()), this);
+      var col = this.collection;
+      if (col.pageableCollection) col.pageableCollection.getFirstPage({silent: true});
+      col.reset(this.shadowCollection.filter(matcher), {reindex: false});
     },
 
     /**
        Clears the search box and reset the collection to its original.
+
+       If the collection is a PageableCollection, clearing will go back to the
+       first page.
     */
     clear: function () {
-      this.$("input[type=text]").val(null);
-      this.collection.reset(this.shadowCollection.models, {reindex: false});
+      this.clearSearchBox();
+      var col = this.collection;
+      if (col.pageableCollection) col.pageableCollection.getFirstPage({silent: true});
+      col.reset(this.shadowCollection.models, {reindex: false});
     }
 
   });
@@ -240,7 +372,7 @@
      @class Backgrid.Extension.LunrFilter
      @extends Backgrid.Extension.ClientSideFilter
   */
-  Backgrid.Extension.LunrFilter = ClientSideFilter.extend({
+  var LunrFilter = Backgrid.Extension.LunrFilter = ClientSideFilter.extend({
 
     /**
        @property {string} [ref="id"]｀lunrjs` document reference attribute name.
@@ -262,18 +394,18 @@
 
        @param {Object} options
        @param {Backbone.Collection} options.collection
-       @param {String} [options.placeholder]
+       @param {string} [options.placeholder]
        @param {string} [options.ref] ｀lunrjs` document reference attribute name.
        @param {Object} [options.fields] A hash of `lunrjs` index field names and
        boost value.
        @param {number} [options.wait]
     */
     initialize: function (options) {
-      ClientSideFilter.prototype.initialize.apply(this, arguments);
+      LunrFilter.__super__.initialize.apply(this, arguments);
 
       this.ref = options.ref || this.ref;
 
-      var collection = this.collection;
+      var collection = this.collection = this.collection.fullCollection || this.collection;
       this.listenTo(collection, "add", this.addToIndex);
       this.listenTo(collection, "remove", this.removeFromIndex);
       this.listenTo(collection, "reset", this.resetIndex);
@@ -349,17 +481,28 @@
        the client-side. The search result is returned by resetting the
        underlying collection to the models after interrogating the index for the
        query answer.
+
+       If the collection is a PageableCollection, searching will go back to the
+       first page.
     */
     search: function () {
-      var searchResults = this.index.search(this.$("input[type=text]").val());
+      var col = this.collection;
+      if (!this.query()) {
+        col.reset(this.shadowCollection.models, {reindex: false});
+        return;
+      }
+
+      var searchResults = this.index.search(this.query());
       var models = [];
       for (var i = 0; i < searchResults.length; i++) {
         var result = searchResults[i];
         models.push(this.shadowCollection.get(result.ref));
       }
-      this.collection.reset(models, {reindex: false});
+
+      if (col.pageableCollection) col.pageableCollection.getFirstPage({silent: true});
+      col.reset(models, {reindex: false});
     }
 
   });
 
-}(jQuery, _, Backbone, Backgrid, lunr));
+}));

data/vendor/assets/javascripts/backgrid-extensions/backgrid-moment-cell.js

@@ -5,7 +5,17 @@
   Copyright (c) 2013 Jimmy Yuen Ho Wong and contributors
   Licensed under the MIT @license.
 */
-(function ($, _, Backbone, Backgrid, moment) {
+(function (root, factory) {
+
+  // CommonJS
+  if (typeof exports == "object") {
+    module.exports = factory(require("underscore"), require("backgrid"),
+                             require("moment"));
+  }
+  // Browser
+  else factory(root._, root.Backgrid, root.moment);
+
+}(this, function (_, Backgrid, moment) {
 
   /**
      MomentFormatter converts bi-directionally any datetime values in any format
@@ -152,14 +162,14 @@
      */
     initialize: function (options) {
 
-      Backgrid.Cell.prototype.initialize.apply(this, arguments);
+      MomentCell.__super__.initialize.apply(this, arguments);
 
       var formatterDefaults = MomentFormatter.prototype.defaults;
       var formatterDefaultKeys = _.keys(formatterDefaults);
-      var classAttrs = _.pick(this, formatterDefaultKeys);
+      var instanceAttrs = _.pick(this, formatterDefaultKeys);
       var formatterOptions = _.pick(options, formatterDefaultKeys);
 
-      this.formatter = new this.formatter(_.extend({}, formatterDefaults, classAttrs, formatterOptions));
+      _.extend(this.formatter, formatterDefaults, instanceAttrs, formatterOptions);
 
       this.editor = this.editor.extend({
         attributes: _.extend({}, this.editor.prototype.attributes || this.editor.attributes || {}, {
@@ -172,4 +182,4 @@
 
   _.extend(MomentCell.prototype, MomentFormatter.prototype.defaults);
 
-}(jQuery, _, Backbone, Backgrid, moment));
+}));