backbone-support 0.2.0 → 0.3.0

data/CHANGELOG

@@ -1,8 +1,14 @@
+0.3.0
+
+CompositeView provides this.bindTo(source, event, callback) to provide easy
+unbinding with unbindFromAll().  It also invokes unbindFromAll from within
+leave().
+
 0.2.0
 
-The version changes the order of the when a view has render called on it when
-it is being swapped by a SwappingRouter. This fixes some browsers which would
-display a flash of unstyled content when performing certain actions in their
+The version changes the order of when a view has render called on it when
+being swapped by a SwappingRouter. This fixes an issue in some browsers which 
+would display a flash of unstyled content when performing certain actions in their
 render, like changing the body class. It introduces the requirement that all
 views return an instance of themselves when rendered (a fairly standard
 backbone convention).

data/README.md

@@ -19,8 +19,8 @@ A Router subclass the provides a standard way to swap one view for another.
 This introduces a convention that all views have a `leave()` function,
 responsible for unbinding and cleaning up the view. And the convention that
 all actions underneath the same `Router` share the same root element, and
-define it as `el` on the router. It also requires that all view's render
-method returns the view itself (a fairly standard backbone convention).
+define it as `el` on the router. Additionally, the render method for every
+view must return that view (a fairly standard backbone convention).
 
 Now, a `SwappingRouter` can take advantage of the `leave()` function, and
 clean up any existing views before swapping to a new one.  It swaps into a new
@@ -45,7 +45,7 @@ An example SwappingRouter would look as follows:
         "stories": "index",
         "stories/new": "newStory"
       }
-      index: function(story_id) {
+      index: function() {
         var view = new Trajectory.Views.StoriesIndex();
         this.swap(view);
       },
@@ -67,9 +67,9 @@ responsible for unbinding and cleaning up the view.
 parent view.
 
 `CompositeView` maintains an array of its immediate children as
-`this.children`.  With this reference in place, a parent view's `leave()`
-method can invoke `leave()` on its children, ensuring that an entire tree of
-composed views is cleaned up properly.
+`this.children`. Using this reference, a parent view's `leave()`
+method will invoke `leave()` on all its children, ensuring that an entire 
+tree of composed views is cleaned up properly.
 
 For child views that can dismiss themselves, such as dialog boxes, children
 maintain a back-reference at `this.parent`. This is used to reach up and call
@@ -93,7 +93,7 @@ While TDD'ing:
 
     bundle exec rake jasmine
 
-To not open tests a browser window:
+To not open tests in a browser window:
 
     bundle exec rake jasmine:ci
 
@@ -177,4 +177,4 @@ require("/vendor/plugins/backbone-support/lib/assets/javascripts/backbone-suppor
 
 ## License
 
-Copyright 2011 thoughtbot. Please check LICENSE for more details.
+Copyright 2012 thoughtbot. Please check LICENSE for more details.

data/lib/assets/javascripts/backbone-support/composite_view.js

@@ -1,30 +1,59 @@
 Support.CompositeView = function(options) {
   this.children = _([]);
+  this.bindings = _([]);
   Backbone.View.apply(this, [options]);
 };
 
 _.extend(Support.CompositeView.prototype, Backbone.View.prototype, {
   leave: function() {
     this.unbind();
+    this.unbindFromAll();
     this.remove();
     this._leaveChildren();
     this._removeFromParent();
   },
 
+  bindTo: function(source, event, callback) {
+    source.bind(event, callback, this);
+    this.bindings.push({ source: source, event: event, callback: callback });
+  },
+
+  unbindFromAll: function() {
+    this.bindings.each(function(binding) {
+      binding.source.unbind(binding.event, binding.callback);
+    });
+    this.bindings = _([]);
+  },
+
   renderChild: function(view) {
     view.render();
     this.children.push(view);
     view.parent = this;
   },
+  
+  renderChildInto: function(view, container) {
+    this.renderChild(view);
+    $(container).empty().append(view.el);
+  },
 
   appendChild: function(view) {
     this.renderChild(view);
     $(this.el).append(view.el);
   },
-
-  renderChildInto: function(view, container) {
+  
+  appendChildTo: function (view, container) {
     this.renderChild(view);
-    $(container).empty().append(view.el);
+    $(container).append(view.el);
+  },
+  
+  prependChild: function(view) {
+    this.renderChild(view);
+    $(this.el).prepend(view.el);
+  },
+  
+  prependChildTo: function (view, container) {
+    this.renderChild(view);
+    $(container).prepend(view.el);
   },
 
   _leaveChildren: function() {

data/lib/backbone-support/version.rb

@@ -1,3 +1,3 @@
 module BackboneSupport
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/spec/javascripts/composite_view_spec.js

@@ -38,6 +38,18 @@ describe("Support.CompositeView", function() {
       expect($("#test2").text()).toEqual("Orange!");
     });
   });
+  
+  describe("#renderChildInto", function() {
+    it("renders child into the given element and replaces content there", function() {
+      $("#test1").text("Replace this!");
+
+      var view = new blankView({el: "#test"});
+      view.renderChildInto(new orangeView(), "#test1");
+
+      expect($("#test").text()).toEqual("");
+      expect($("#test1").text()).toEqual("Orange!");
+    });
+  });
 
   describe("#appendChild", function() {
     it("renders and appends children views", function() {
@@ -49,15 +61,37 @@ describe("Support.CompositeView", function() {
     });
   });
 
-  describe("#renderChildInto", function() {
-    it("renders child into the given element and replaces content there", function() {
-      $("#test1").text("Replace this!");
-
+  describe("#appendChildTo", function() {
+    it("appends child into the given element", function() {
+      $("#test1").text("Append to this!");
+  
       var view = new blankView({el: "#test"});
-      view.renderChildInto(new orangeView(), "#test1");
-
+      view.appendChildTo(new orangeView(), "#test1");
+  
       expect($("#test").text()).toEqual("");
-      expect($("#test1").text()).toEqual("Orange!");
+      expect($("#test1").text()).toEqual("Append to this!Orange!");
+    });
+  });
+  
+  describe("#prependChild", function() {
+    it("renders and prepends children views", function() {
+      var view = new blankView({el: "#test"});
+      view.prependChild(new orangeView());
+      view.prependChild(new normalView());
+  
+      expect($("#test").text()).toEqual("Normal!Orange!");
+    });
+  });
+  
+  describe("#prependChildTo", function() {
+    it("prepends child into the given element", function() {
+      $("#test1").text("Prepend to this!");
+  
+      var view = new blankView({el: "#test"});
+      view.prependChildTo(new orangeView(), "#test1");
+  
+      expect($("#test").text()).toEqual("");
+      expect($("#test1").text()).toEqual("Orange!Prepend to this!");
     });
   });
 
@@ -129,5 +163,26 @@ describe("Support.CompositeView", function() {
       expect($("#test2").size()).toEqual(1);
       expect(view.children.size()).toEqual(1);
     });
+
+    it("removes any bindings that were bound via bindTo", function() {
+      var model1 = new Backbone.Model({}),
+          model2 = new Backbone.Model({}),
+          eventListener = sinon.spy(),
+          bindToView = new (Support.CompositeView.extend({
+            initialize: function(options) {
+              this.bindTo(options.model1, 'change', eventListener);
+              this.bindTo(options.model2, 'change', eventListener);
+            }
+          }))({
+            model1: model1,
+            model2: model2
+          });
+
+      bindToView.leave();
+      model1.trigger('change');
+      model2.trigger('change');
+
+      expect(eventListener.called).toBeFalsy();
+    });
   });
 });

data/spec/javascripts/swapping_router_spec.js

@@ -4,12 +4,14 @@ describe("Support.SwappingRouter", function() {
   var redView = Backbone.View.extend({
     render: function() {
       $(this.el).text("Red!");
+      return this;
     }
   });
 
   var blueView = Backbone.View.extend({
     render: function() {
       $(this.el).text("Blue!");
+      return this;
     }
   });
 

metadata

@@ -1,15 +1,10 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: backbone-support
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 0.3.0
   prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 0
-  version: 0.2.0
 platform: ruby
-authors: 
+authors:
 - Chad Pytel
 - Joe Ferris
 - Jason Morrison
@@ -17,33 +12,31 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-01-23 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: jasmine
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: SwappingController and CompositeView for Backbone.js
-email: 
+email:
 - support@thoughtbot.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - CHANGELOG
 - Gemfile
@@ -71,38 +64,29 @@ files:
 - vendor/underscore.js
 homepage: http://github.com/thoughtbot/backbone-support
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: SwappingController and CompositeView for Backbone.js
-test_files: 
+test_files:
 - spec/javascripts/composite_view_spec.js
 - spec/javascripts/helpers/helpers.js
 - spec/javascripts/helpers/sinon-1.1.1.js
@@ -110,3 +94,4 @@ test_files:
 - spec/javascripts/support/jasmine_config.rb
 - spec/javascripts/support/jasmine_runner.rb
 - spec/javascripts/swapping_router_spec.js
+has_rdoc: