backbone-filtered-collection 1.0.0 → 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 652f34d8646e018db86ec95f4722b8b115a0078f
+  data.tar.gz: bf1d2c926f9e1e0135984b78613d3ddc36a055e8
+SHA512:
+  metadata.gz: 69c6b95b7d3d05da2521ced7e1cb26fe970efb633869d9459cc52907f8a02105d982f5f500e07c9bd33f48b6ec9cc3ddb6982b3a574c67f16c8c6b353a1de4fc
+  data.tar.gz: f1c0fde67a77d7e28c15e4e7808d4d6c4ee4feb22a4d67cf520c5b119472845e89e08f05dafeb9700b7b23139e0d4109a0751f7d70e9bf3d5f08c8d787efdb88

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.idea
 Gemfile.lock
 InstalledFiles
 _yardoc

data/.rvmrc

@@ -1,49 +1 @@
-#!/usr/bin/env bash
-
-# This is an RVM Project .rvmrc file, used to automatically load the ruby
-# development environment upon cd'ing into the directory
-
-# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
-environment_id="1.9.3-head@filtered-collection"
-
-#
-# First we attempt to load the desired environment directly from the environment
-# file. This is very fast and efficicent compared to running through the entire
-# CLI and selector. If you want feedback on which environment was used then
-# insert the word 'use' after --create as this triggers verbose mode.
-#
-if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
-  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]] ; then
-  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
-
-  [[ -s ".rvm/hooks/after_use" ]] && . ".rvm/hooks/after_use"
-else
-  # If the environment file has not yet been created, use the RVM CLI to select.
-  rvm --create  "$environment_id"
-fi
-
-#
-# If you use an RVM gemset file to install a list of gems (*.gems), you can have
-# it be automatically loaded. Uncomment the following and adjust the filename if
-# necessary.
-#
-# filename=".gems"
-# if [[ -s "$filename" ]] ; then
-#   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
-# fi
-
-#
-# If you use bundler and would like to run bundle each time you enter the
-# directory, you can uncomment the following code.
-#
-#   # Ensure that Bundler is installed. Install it if it is not.
-#   if ! command -v bundle >/dev/null; then
-#      printf "The rubygem 'bundler' is not installed. Installing it now.\n"
-#      gem install bundler
-#   fi
-#
-#   # Bundle while reducing excess noise.
-#   printf "Bundling your gems. This may take a few minutes on a fresh clone.\n"
-#   bundle | grep -v '^Using ' | grep -v ' is complete' | sed '/^$/d'
-#
-
+rvm use ruby-2.0.0-p247@filtered-collection --create

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install:
+  - "export DISPLAY=:99.0"
+  - "sh -e /etc/init.d/xvfb start"
+install: bundle
+script: rake jasmine:ci

data/LICENSE.txt

@@ -1,22 +1,22 @@
+The MIT License (MIT)
+
 Copyright (c) 2013 Dmitriy Likhten
 
-MIT License
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,5 +1,7 @@
 # Filtered Collection
 
+[![Build Status](https://travis-ci.org/dlikhten/filtered-collection.png?branch=master)](https://travis-ci.org/dlikhten/filtered-collection)
+
 This is a simple filtered collection implemented using
 Backbone.Collection. The goal here is to create a collection which,
 given a filter function, will just contain elements of the original
@@ -19,21 +21,28 @@ these guys.
 
 With bundler
 
-    gem 'backbone-filtered-collection', git: "git://github.com/dlikhten/filtered-collection.git"
+    gem 'backbone-filtered-collection'
 
 Inside your sprockets file:
 
     //= require backbone-filtered-collection
 
+# Installation anywhere else
+
+Download the [source][1], minify as you see fit by your minification strategy.
+
 # Usage
 
     var YourCollection = Backbone.Collection.extend({model: YourModel});
     var YourFilteredCollection = Backbone.FilteredCollection.extend({model: YourModel});
+
     var allItems = new YourCollection(...);
+
     // note the null, backbone collections want the pre-populated model here
     // we can't do that since this collection does not accept mutations, it
     // only mutates as a proxy for the underlying collection
     var filteredItems = new YourFilteredCollection(null, {collection: allItems});
+
     var filteredItems.setFilter(function(item) { return item.get('included') == true;});
 
 And now filteredItems contains only those items that pass the filter.
@@ -50,6 +59,28 @@ Same goes for remove and reset.
 
 To clear the filtering completely, pass the value false to setFilter.
 
+## Filters
+
+- `setFilter(function() {})`: Set the given function as the filter. Same api as `_.each`.
+- `setFilter(false)`: Turn filtering off. This collection will have all elements of the original collection.
+- `setFilter()`: Re-filter. Don't change the filter function but execute it on all elements. Useful after the original collection was modified via `silent: true`
+
+## Events
+
+The collection will create events much like a regular collection. There are a few to note:
+
+ - `add`: An object was added to the collection (via filter OR via orig collection)
+ - `remove`: An object was removed from the collection (via filter OR via orig collection)
+ - `reset`: The original collection was reset, filtering happened
+ - `sort`: The collection was sorted. No changes in models represented.
+ - `change`: An object in the collection was changed. The object was already accepted by the filter, and is still.
+ - `filter-complete`: Filtering was completed. If you are not listening to add/remove then just listen to filter-complete and reset your views.
+
+## Change Collection
+
+You can change the underlying collection if you really need to by invoking `#resetWith(newCollection)`, only one `reset`
+event will be triggered with the new data.
+
 # Testing
 
     bundle install
@@ -59,8 +90,10 @@ I also included a .rvmrc file incase you have rvm installed.
 
 # Contributing
 
-Please, do not contribute without a spec. Being tested is critically important 
-to this project, as it's a framework level component, and so its failure 
+Please, do not contribute without a spec. Being tested is critically important
+to this project, as it's a framework level component, and so its failure
 will be damn hard to detect.
 
 Also, no tab characters, 2 spaces only. Minifiers can handle this stuff for you.
+
+[1]: https://raw.github.com/dlikhten/filtered-collection/master/vendor/assets/javascripts/backbone-filtered-collection.js

data/lib/backbone/filtered_collection/version.rb

@@ -1,5 +1,5 @@
 module Backbone
   module FilteredCollection
-    VERSION = "1.0.0"
+    VERSION = "1.2.0"
   end
 end

data/spec/javascripts/backbone-filtered-collection-spec.js

@@ -7,10 +7,6 @@ describe("Backbone.FilteredCollection", function() {
     model: TehModel
   });
 
-  var ModelCollection = Backbone.FilteredCollection.extend({
-    model: TehModel
-  });
-
   var allModels;
   var collection;
 
@@ -20,12 +16,9 @@ describe("Backbone.FilteredCollection", function() {
     }
   };
 
-  var oddFilter = function(model) {
-    return model.get("value") % 2 == 1;
-  }
   var evenFilter = function(model) {
     return model.get("value") % 2 == 0;
-  }
+  };
 
   beforeEach(function() {
     allModels = new RegularModelCollection();
@@ -33,20 +26,23 @@ describe("Backbone.FilteredCollection", function() {
       allModels.add(new TehModel({id: i, value: i}));
     }
 
-    collection = new ModelCollection(null, {collection: allModels});
+    collection = new Backbone.FilteredCollection(null, {collection: allModels});
+  });
+
+  afterEach(function() {
+    if (collection) collection.off(null, null, null);
   });
 
   describe("#setFilter", function() {
-    it("should filter the given model", function() {
+    it("filters the given model", function() {
       collection.setFilter(createLessthanFilter(5));
 
       expect(collection.length).toEqual(5);
       expect(collection.at(0).get('value')).toEqual(0);
     });
 
-    it("should change filters", function() {
+    it("uses the given filter", function() {
       collection.setFilter(createLessthanFilter(5));
-
       collection.setFilter(function(model) {
         return model.get('value') > 7;
       });
@@ -55,7 +51,7 @@ describe("Backbone.FilteredCollection", function() {
       expect(collection.at(0).get('value')).toEqual(8);
     });
 
-    it("should take a false filter as a return to no filter", function() {
+    it("accepts false to remove all filters", function() {
       collection.setFilter(createLessthanFilter(5));
       expect(collection.length).toEqual(5);
       collection.setFilter(undefined); // no change
@@ -66,46 +62,43 @@ describe("Backbone.FilteredCollection", function() {
       expect(collection.length).toEqual(10);
     });
 
-    it("should work correctly after filtering is changed constantly", function() {
+    it("works correctly after filtering is changed constantly", function() {
       collection.setFilter(createLessthanFilter(0));
       expect(collection.models.length).toEqual(0);
 
       collection.setFilter(createLessthanFilter(3));
       expect(collection.models.length).toEqual(3);
-      expect(collection.models[0].get("value")).toEqual(0)
-      expect(collection.models[1].get("value")).toEqual(1)
-      expect(collection.models[2].get("value")).toEqual(2)
+      expect(collection.at(0).get("value")).toEqual(0);
+      expect(collection.at(1).get("value")).toEqual(1);
+      expect(collection.at(2).get("value")).toEqual(2);
 
       collection.setFilter(evenFilter);
       expect(collection.models.length).toEqual(5);
-      expect(collection.models[0].get("value")).toEqual(0)
-      expect(collection.models[1].get("value")).toEqual(2)
-      expect(collection.models[2].get("value")).toEqual(4)
-      expect(collection.models[3].get("value")).toEqual(6)
-      expect(collection.models[4].get("value")).toEqual(8)
+      expect(collection.at(0).get("value")).toEqual(0);
+      expect(collection.at(1).get("value")).toEqual(2);
+      expect(collection.at(2).get("value")).toEqual(4);
+      expect(collection.at(3).get("value")).toEqual(6);
+      expect(collection.at(4).get("value")).toEqual(8);
     });
 
-    it("should not trigger a filter-complete event if options.silent is true", function() {
-      count = 0;
-      collection.on("filter-complete", function() {
-        count += 1;
-      });
+    it("does not trigger a filter-complete event if options.silent is true", function() {
+      var eventSpy = jasmine.createSpy('filter-complete listener');
+      collection.on("filter-complete", eventSpy);
 
       collection.setFilter(createLessthanFilter(0), {silent: true});
-
-      expect(count).toEqual(0);
+      expect(eventSpy).not.toHaveBeenCalled();
     });
   });
 
   describe("event:add", function() {
-    it("should not add the new object, since it is already filtered out", function() {
+    it("does not add an already filtered out new object", function() {
       collection.setFilter(createLessthanFilter(5));
       expect(collection.length).toEqual(5);
       allModels.add(new TehModel({value: 6}));
       expect(collection.length).toEqual(5);
     });
 
-    it("should add the new object, since it passes the filter", function() {
+    it("adds the new object, since it passes the filter", function() {
       collection.setFilter(createLessthanFilter(5));
       expect(collection.length).toEqual(5);
       allModels.add(new TehModel({value: 1}));
@@ -113,7 +106,7 @@ describe("Backbone.FilteredCollection", function() {
       expect(collection.at(5).get('value')).toEqual(1);
     });
 
-    it("should add the new object to the correct location", function() {
+    it("adds the new object to the correct location", function() {
       collection.setFilter(createLessthanFilter(5));
       expect(collection.length).toEqual(5);
       allModels.add(new TehModel({value: 4}), {at: 0});
@@ -121,23 +114,18 @@ describe("Backbone.FilteredCollection", function() {
       expect(collection.at(0).get('value')).toEqual(4);
     });
 
-    it("should trigger an add event if the object was added", function() {
+    it("triggers an add event if the object was added", function() {
       collection.setFilter(createLessthanFilter(5));
-      expect(collection.length).toEqual(5);
-
       var newModel = new TehModel({value: 3});
-      count = 0;
-      collection.on("add", function(model, collection, options) {
-        expect(model).toEqual(newModel);
-        expect(options.index).toEqual(0);
-        count += 1;
-      });
+      var eventSpy = jasmine.createSpy('reset event listener');
+
+      collection.on("add", eventSpy);
       allModels.add(newModel, {at: 0});
 
-      expect(count).toEqual(1);
+      expect(eventSpy).toHaveBeenCalledWith(newModel, collection, {index: 0})
     });
 
-    it("should re-number elements propperly in the mapping according to what the actualy indices are in the original collection", function() {
+    it("re-numbers elements properly in the mapping according to what the atual indices are in the original collection", function() {
       collection.setFilter(createLessthanFilter(10));
       expect(collection.length).toEqual(10);
 
@@ -148,14 +136,14 @@ describe("Backbone.FilteredCollection", function() {
   });
 
   describe("event:remove", function() {
-    it("should be a noop since the object is filtered", function() {
+    it("is a no-op if the item removed is already not filtered", function() {
       collection.setFilter(createLessthanFilter(5));
       expect(collection.length).toEqual(5);
       allModels.remove(allModels.at(6));
       expect(collection.length).toEqual(5);
     });
 
-    it("should be a remove the removed object", function() {
+    it("removes the model that was removed from the underlying collection", function() {
       collection.setFilter(createLessthanFilter(5));
       expect(collection.length).toEqual(5);
       allModels.remove(allModels.at(4));
@@ -163,7 +151,7 @@ describe("Backbone.FilteredCollection", function() {
       expect(collection.at(collection.length - 1).get('value')).toEqual(3);
     });
 
-    it("should re-number elements propperly in the mapping according to what the actualy indices are in the original collection", function() {
+    it("should re-number elements properly in the mapping according to what the actual indices are in the original collection", function() {
       collection.setFilter(createLessthanFilter(10));
       expect(collection.length).toEqual(10);
 
@@ -174,7 +162,7 @@ describe("Backbone.FilteredCollection", function() {
   });
 
   describe("event:reset", function() {
-    it("should be a noop since the object is filtered", function() {
+    it("resets all models to those in the underlying collection", function() {
       collection.setFilter(createLessthanFilter(15));
       var newAll = [];
       for (var i = 10; i < 20; i++) {
@@ -184,10 +172,20 @@ describe("Backbone.FilteredCollection", function() {
       expect(collection.length).toEqual(5);
       expect(collection.at(4).get('value')).toEqual(14);
     });
+
+    it("triggers exactly one reset event", function() {
+      var eventSpy = jasmine.createSpy('reset event listener');
+      collection.on('reset', eventSpy);
+
+      allModels.reset([{id: 11, value: 11}]);
+
+      expect(eventSpy).toHaveBeenCalledWith(collection);
+      expect(eventSpy.callCount).toEqual(1);
+    });
   });
 
   describe("event:sort", function() {
-    it("should continue filtering the collection, except with a new order", function() {
+    it("continues to filter the collection, except with a new order", function() {
       collection.setFilter(createLessthanFilter(5));
       allModels.comparator = function(v1, v2) {
         return v2.get("value") - v1.get("value");
@@ -204,25 +202,26 @@ describe("Backbone.FilteredCollection", function() {
   });
 
   describe("event:filter-complete", function() {
-    it("should fire when the underlying collection fires it (thus we're done filtering too)", function() {
-      var filterFired = 0;
-      collection.on("filter-complete", function() {
-        filterFired += 1;
-      });
+    it("triggers when the underlying collection triggers it (thus we're done filtering too)", function() {
+      var eventSpy = jasmine.createSpy('filter-complete event listener');
+      collection.on("filter-complete", eventSpy);
+
       allModels.trigger("filter-complete");
-      expect(filterFired).toEqual(1);
+
+      expect(eventSpy).toHaveBeenCalled();
     });
 
-    it("should fire once only at the end of a filter", function() {
-      var filterFired = 0;
-      collection.on("filter-complete", function() {
-        filterFired += 1;
-      });
+    it("triggers once only at the end of a filter", function() {
+      var eventSpy = jasmine.createSpy('filter-complete event listener');
+      collection.on("filter-complete", eventSpy);
+
       collection.setFilter(createLessthanFilter(3));
-      expect(filterFired).toEqual(1);
+
+      expect(eventSpy).toHaveBeenCalled();
+      expect(eventSpy.callCount).toEqual(1);
     });
 
-    it("should fire once when a change is propagated from an underlying model", function() {
+    it("triggers once when a change is propagated from an underlying model", function() {
       var filterFired = 0;
       collection.on("filter-complete", function() {
         filterFired += 1;
@@ -230,51 +229,51 @@ describe("Backbone.FilteredCollection", function() {
       collection.setFilter(createLessthanFilter(3));
       filterFired = 0;
 
-      collection.models[0].trigger("change", collection.models[0], allModels)
+      collection.at(0).trigger("change", collection.at(0), allModels)
       expect(filterFired).toEqual(1);
     });
   });
 
   describe("model - event:destroy", function() {
-    it("should just remove the model from the base collection like normal, and raise no problems with the filter", function() {
+    it("just removes the model from the base collection like normal, and raise no problems with the filter", function() {
       collection.setFilter(createLessthanFilter(5));
-      origModelZero = collection.models[0];
+      origModelZero = collection.at(0);
       // simulate an ajax destroy
-      origModelZero.trigger("destroy", origModelZero, origModelZero.collection)
+      origModelZero.trigger("destroy", origModelZero, origModelZero.collection);
 
-      expect(collection.models[0].get("value")).toEqual(1)
+      expect(collection.at(0).get("value")).toEqual(1);
     });
 
-    it("should remove elements from the model as events occur", function() {
+    it("removes elements from the model as events occur", function() {
       collection.setFilter(createLessthanFilter(10));
 
       // start removing in weird orders, make sure vents are done properly
-      model = collection.models[0];
-      model.trigger("destroy", model, model.collection)
-      expect(collection.models[0].get("value")).toEqual(1)
+      model = collection.at(0);
+      model.trigger("destroy", model, model.collection);
+      expect(collection.at(0).get("value")).toEqual(1);
 
-      model = collection.models[3];
-      model.trigger("destroy", model, model.collection)
-      expect(collection.models[3].get("value")).toEqual(5)
+      model = collection.at(3);
+      model.trigger("destroy", model, model.collection);
+      expect(collection.at(3).get("value")).toEqual(5);
 
-      model = collection.models[3];
-      model.trigger("destroy", model, model.collection)
-      expect(collection.models[3].get("value")).toEqual(6)
+      model = collection.at(3);
+      model.trigger("destroy", model, model.collection);
+      expect(collection.at(3).get("value")).toEqual(6);
 
-      model = collection.models[3];
-      model.trigger("destroy", model, model.collection)
-      expect(collection.models[3].get("value")).toEqual(7)
+      model = collection.at(3);
+      model.trigger("destroy", model, model.collection);
+      expect(collection.at(3).get("value")).toEqual(7);
 
-      model = collection.models[2];
-      model.trigger("destroy", model, model.collection)
-      expect(collection.models[2].get("value")).toEqual(7)
+      model = collection.at(2);
+      model.trigger("destroy", model, model.collection);
+      expect(collection.at(2).get("value")).toEqual(7);
 
-      model = collection.models[1];
-      model.trigger("destroy", model, model.collection)
-      expect(collection.models[1].get("value")).toEqual(7)
+      model = collection.at(1);
+      model.trigger("destroy", model, model.collection);
+      expect(collection.at(1).get("value")).toEqual(7);
     });
 
-    it("should create remove events for every deleted model", function() {
+    it("triggers remove events for every deleted model", function() {
       collection.setFilter(createLessthanFilter(10));
       var lastModelRemoved = null;
       var count = 0;
@@ -285,37 +284,37 @@ describe("Backbone.FilteredCollection", function() {
 
       // start removing in weird orders, make sure vents are done properly
       count = 0;
-      model = collection.models[0];
+      model = collection.at(0);
       model.trigger("destroy", model, model.collection)
       expect(lastModelRemoved).toEqual(model);
       expect(count).toEqual(1);
 
       count = 0;
-      model = collection.models[3];
+      model = collection.at(3);
       model.trigger("destroy", model, model.collection)
       expect(lastModelRemoved).toEqual(model);
       expect(count).toEqual(1);
 
       count = 0;
-      model = collection.models[3];
+      model = collection.at(3);
       model.trigger("destroy", model, model.collection)
       expect(lastModelRemoved).toEqual(model);
       expect(count).toEqual(1);
 
       count = 0;
-      model = collection.models[3];
+      model = collection.at(3);
       model.trigger("destroy", model, model.collection)
       expect(lastModelRemoved).toEqual(model);
       expect(count).toEqual(1);
 
       count = 0;
-      model = collection.models[2];
+      model = collection.at(2);
       model.trigger("destroy", model, model.collection)
       expect(lastModelRemoved).toEqual(model);
       expect(count).toEqual(1);
 
       count = 0;
-      model = collection.models[1];
+      model = collection.at(1);
       model.trigger("destroy", model, model.collection)
       expect(lastModelRemoved).toEqual(model);
       expect(count).toEqual(1);
@@ -323,31 +322,145 @@ describe("Backbone.FilteredCollection", function() {
   });
 
   describe("model - event:change", function() {
-    it("should remove the model because it failed the filter post change", function() {
+    var changeSpy, addSpy, removeSpy;
+
+    beforeEach(function() {
+      changeSpy = jasmine.createSpy("change listener");
+      addSpy = jasmine.createSpy("add listener");
+      removeSpy = jasmine.createSpy("remove listener");
+    });
+
+    it("removes the model because it failed the filter post change, triggers remove event", function() {
       collection.setFilter(createLessthanFilter(5));
-      origModelZero = collection.models[0];
+      collection.on("change", changeSpy);
+      collection.on("add", addSpy);
+      collection.on("remove", removeSpy);
+
+      origModelZero = collection.at(0);
       origModelZero.set("value", 10)
 
       expect(collection.models.length).toEqual(4)
-      expect(collection.models[0].get("value")).toEqual(1)
+      expect(collection.at(0).get("value")).toEqual(1)
+      expect(changeSpy).not.toHaveBeenCalled();
+      expect(addSpy).not.toHaveBeenCalled();
+      expect(removeSpy).toHaveBeenCalledWith(origModelZero, collection, jasmine.any(Object));
     });
 
-    it("should do nothing if the model is still passing the filter", function() {
+    it("does not alter the collection if the model is still passing, triggers change event", function() {
       collection.setFilter(createLessthanFilter(5));
-      origModelZero = collection.models[0];
+      collection.on("change", changeSpy);
+      collection.on("add", addSpy);
+      collection.on("remove", removeSpy);
+
+      origModelZero = collection.at(0);
       origModelZero.set("value", 3)
 
       expect(collection.models.length).toEqual(5)
-      expect(collection.models[0].get("value")).toEqual(3)
+      expect(collection.at(0).get("value")).toEqual(3)
+      expect(changeSpy).toHaveBeenCalledWith(origModelZero, collection);
+      expect(addSpy).not.toHaveBeenCalled();
+      expect(removeSpy).not.toHaveBeenCalled();
     });
 
-    it("should add the model that is now passing the filter", function() {
+    it("adds the model that is now passing the filter, triggers add event", function() {
       collection.setFilter(createLessthanFilter(5));
-      origModelZero = allModels.models[9];
+      collection.on("change", changeSpy);
+      collection.on("add", addSpy);
+      collection.on("remove", removeSpy);
+
+      origModelZero = allModels.at(9);
       origModelZero.set("value", 2)
 
       expect(collection.models.length).toEqual(6)
-      expect(collection.models[5].get("value")).toEqual(2)
+      expect(collection.at(5).get("value")).toEqual(2)
+      expect(changeSpy).not.toHaveBeenCalled();
+      expect(addSpy).toHaveBeenCalledWith(origModelZero, collection, jasmine.any(Object));
+      expect(removeSpy).not.toHaveBeenCalled();
+    });
+  });
+
+  describe("#resetWith", function() {
+    var moreModels;
+
+    beforeEach(function(){
+      moreModels = new RegularModelCollection();
+      for(var i = 10; i < 16; i++) {
+        moreModels.add(new TehModel({id: i, value: i}));
+      }
+      collection.setFilter(evenFilter);
+    });
+
+    it("updates the collection's length to match that of the new collection", function() {
+      var lengthBefore = collection.length;
+      collection.resetWith(moreModels);
+      var lengthAfter = collection.length;
+
+      expect(lengthBefore).toEqual(5); // even models
+      expect(lengthAfter).toEqual(3); // even models
+    });
+
+    it("handles add events on the new collection", function() {
+      collection.resetWith(moreModels);
+
+      var lengthBefore = collection.length;
+      newModel = new TehModel({id: 16, value: 16});
+      moreModels.add(newModel);
+      var lengthAfter = collection.length;
+
+      expect(lengthAfter).toEqual(lengthBefore + 1);
+      expect(collection.indexOf(newModel)).toBeGreaterThan(-1);
+    });
+
+    it("handles remove events on the new collection", function() {
+      collection.resetWith(moreModels);
+
+      var lengthBefore = collection.length;
+      var toRemove = moreModels.get(12);
+      moreModels.remove(toRemove);
+      var lengthAfter = collection.length;
+
+      expect(lengthAfter).toEqual(lengthBefore - 1);
+      expect(collection.indexOf(toRemove)).toEqual(-1)
+    });
+
+    it("handles change events on the new collection", function() {
+      collection.resetWith(moreModels);
+
+      var lengthBefore = collection.length;
+      var changeModel = moreModels.get(10);
+      changeModel.set('value', 11);
+      var lengthAfter = collection.length;
+
+      expect(lengthAfter).toEqual(lengthBefore - 1);
+      expect(collection.indexOf(changeModel)).toEqual(-1);
+    });
+
+    it("ignores the old collection events", function() {
+      var eventSpy = jasmine.createSpy('all event listener');
+
+      collection.resetWith(moreModels);
+
+      collection.on('all', eventSpy);
+
+      allModels.add(new TehModel({id: 16, value: 16}));
+      allModels.remove(allModels.at(0));
+      allModels.get(2).set("value", "3");
+      allModels.comparator = function(a, b) { return 0 };
+      allModels.sort();
+      allModels.reset([{value: 5}]);
+
+      expect(eventSpy).not.toHaveBeenCalled();
+    });
+
+    it("fire a reset with the new filtered data, exactly once", function() {
+      var eventSpy = jasmine.createSpy('reset event listener');
+
+      collection.on('reset', eventSpy);
+
+      collection.resetWith(moreModels);
+
+      expect(eventSpy).toHaveBeenCalledWith(collection);
+      expect(eventSpy.callCount).toEqual(1);
     });
   });
 });

data/vendor/assets/javascripts/backbone-filtered-collection.js

@@ -1,25 +1,27 @@
 /*
-Copyright (C) 2012 Dmitriy Likhten
+The MIT License (MIT)
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
-of the Software, and to permit persons to whom the Software is furnished to do
-so, subject to the following conditions:
+Copyright (c) 2013 Dmitriy Likhten
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
 */
-/* version 1.0.0 */
+/* version 1.2.0 */
 (function(_, Backbone) {
   var defaultFilter = function() {return true;};
   /**
@@ -44,17 +46,44 @@ SOFTWARE.
     collectionFilter: null
     ,defaultFilter: defaultFilter
 
+    /**
+    Default initializer.
+
+    @param {Boolean} [models=false] - By default we must to use a falsy value here.
+    @param {Object}  data           - Options.
+        @param {Backbone.Collection} data.collection       - Collection to be filtered
+        @param {Function}            data.collectionFilter - Filter to be applied to the collection.
+
+    @constructor
+    **/
     ,initialize: function(models, data) {
       if (models) throw "models cannot be set directly, unfortunately first argument is the models.";
+
       this.collection = data.collection;
       this.setFilter(data.collectionFilter);
+      this._bindEvents();
+    }
+
+    /**
+     * Replace the current underlying collection with a new one.
+     * note: only a reset event will be fired.
+     */
+    ,resetWith: function(newCollection) {
+      this.stopListening(this.collection);
+      this.collection = newCollection;
+      this.resetCollection();
+      this._bindEvents();
+
+      return this;
+    }
 
-      this.collection.on("add",     this.addModel, this);
-      this.collection.on("remove",  this.removeModel, this);
-      this.collection.on("reset",   this.resetCollection, this);
-      this.collection.on("sort",    this.resortCollection, this);
-      this.collection.on("change",  this._modelChanged, this);
-      this.collection.on("filter-complete", this._filterComplete, this);
+    ,_bindEvents: function () {
+      this.listenTo(this.collection, "add", this.addModel);
+      this.listenTo(this.collection, "remove", this.removeModel);
+      this.listenTo(this.collection, "reset", this.resetCollection);
+      this.listenTo(this.collection, "sort", this.resortCollection);
+      this.listenTo(this.collection, "change", this._modelChanged);
+      this.listenTo(this.collection, "filter-complete", this._filterComplete);
     }
 
     ,_reset: function(options) {
@@ -85,6 +114,11 @@ SOFTWARE.
           var index = this.collection.indexOf(model);
           this._forceAddModel(model, {index: index});
         }
+        // the model passes the filter and is already in the collection
+        // therefore we want to indicate that the model has changed
+        else {
+          this.trigger("change", model, this);
+        }
       } else {
         // Model did not pass filter
         if (ownIndexOfModel > -1){
@@ -97,11 +131,22 @@ SOFTWARE.
     }
 
     ,resortCollection: function() {
-      this._mapping = [];
-      this._reset();
-      this.setFilter(undefined, {silent: true});
+      // note: we don't need to do any filter work since sort
+      // implies nothing changed, only order
+      var newModels = [];
+      var newMapping = [];
+      var models = this.models;
+      _.each(this.collection.models, function(model, index) {
+        if (models.indexOf(model) >= 0) {
+          newModels.push(model);
+          newMapping.push(index);
+        }
+      });
+      this.models = newModels;
+      this._mapping = newMapping;
       this.trigger("sort", this);
     }
+
     ,resetCollection: function() {
       this._mapping = [];
       this._reset();

metadata

@@ -1,22 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: backbone-filtered-collection
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 1.2.0
 platform: ruby
 authors:
 - Dmitriy Likhten
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-10 00:00:00.000000000 Z
+date: 2013-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.0'
     - - <
@@ -25,9 +23,8 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.0'
     - - <
@@ -36,33 +33,29 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: jasmine
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A filtered collection for backbone.js
@@ -74,6 +67,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rvmrc
+- .travis.yml
 - Gemfile
 - LICENSE
 - LICENSE.txt
@@ -93,27 +87,26 @@ files:
 homepage: http://github.com/dlikhten/filtered-collection
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Allowing implementation of a chain-of-responsibility pattern in backbone's
   collection filtering
 test_files: