backbone-support 0.3.1 → 0.3.2

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+before_install:
+  - 'export DISPLAY=:99.0'
+  - 'sh -e /etc/init.d/xvfb start'
+rvm:
+  - '1.9.2'
+  - '1.9.3'

data/CHANGELOG

@@ -1,3 +1,12 @@
+0.3.2 (April 27, 2013)
+
+- Backbone support now includes a vendored version of Backbone and Underscore
+  for use with the asset pipeline.
+- SwappingRouter now calls 'swapped' method on new view as it is added to the
+  DOM. CompositeView emits an associated 'swapped' event.
+- CompositeView#prependChildTo is now properly scoped to the view thanks to nhocki
+- Backbone Support is now on Travis for continuous integration
+
 0.3.1 (March 05, 2013)
 
 Views fire 'leave' event when calling leave()

data/Gemfile

@@ -1,5 +1,3 @@
-source :rubygems
+source 'https://rubygems.org'
 
-gem 'jasmine'
-gem 'headless'
-gem 'rake'
+gemspec

data/Gemfile.lock

@@ -1,38 +1,46 @@
+PATH
+  remote: .
+  specs:
+    backbone-support (0.3.2)
+
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    childprocess (0.2.0)
-      ffi (~> 1.0.6)
-    diff-lcs (1.1.2)
-    ffi (1.0.9)
-    headless (0.1.0)
-    jasmine (1.0.2.1)
-      json_pure (>= 1.4.3)
-      rack (>= 1.1)
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    diff-lcs (1.2.1)
+    ffi (1.4.0)
+    headless (1.0.1)
+    jasmine (1.3.0)
+      jasmine-core (>= 1.3.0)
+      rack (~> 1.0)
       rspec (>= 1.3.1)
       selenium-webdriver (>= 0.1.3)
-    json_pure (1.5.3)
-    rack (1.3.2)
-    rake (0.9.2)
-    rspec (2.6.0)
-      rspec-core (~> 2.6.0)
-      rspec-expectations (~> 2.6.0)
-      rspec-mocks (~> 2.6.0)
-    rspec-core (2.6.4)
-    rspec-expectations (2.6.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.6.0)
-    rubyzip (0.9.4)
-    selenium-webdriver (2.3.2)
-      childprocess (>= 0.1.9)
-      ffi (>= 1.0.7)
-      json_pure
+    jasmine-core (1.3.1)
+    multi_json (1.6.1)
+    rack (1.5.2)
+    rake (10.0.3)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.0)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.31.0)
+      childprocess (>= 0.2.5)
+      multi_json (~> 1.0)
       rubyzip
+      websocket (~> 1.0.4)
+    websocket (1.0.7)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  backbone-support!
   headless
-  jasmine
+  jasmine (= 1.3.0)
   rake

data/README.md

@@ -1,12 +1,18 @@
-There's no built-in garbage collection for Backbone’s event bindings, and 
-forgetting to unbind can cause bugs and memory leaks.
+# Backbone Support
 
-Backbone Support currently provides two utility classes, SwappingRouter and CompositeView,
-that introduce a `leave()` function, which unbinds and cleans up the view.
-They should be used where views are instantiated (in Router instances and in composite views).
+[![Build Status](https://travis-ci.org/thoughtbot/backbone-support.png?branch=master)](https://travis-ci.org/thoughtbot/backbone-support)
 
-Inspired by our projects and the Backbone.js on Rails book:
-http://workshops.thoughtbot.com/backbone-js-on-rails
+Backbone Support provides a collection of utility classes for use with
+[Backbone.js][]. There's no built-in garbage collection for Backbone’s event
+bindings, and forgetting to unbind can cause bugs and memory leaks. Backbone
+Support has your covered.
+
+Backbone Support currently provides two utility classes, SwappingRouter and
+CompositeView, that introduce a `leave()` function, which unbinds and cleans up
+the view.  They should be used where views are instantiated (in Router
+instances and in composite views).
+
+Inspired by our projects and the [Backbone.js on Rails book][].
 
 The book contains complete instructions and in-depth coverage of the internals
 of CompositeView and SwappingRouter, and an example application that shows
@@ -68,7 +74,7 @@ parent view.
 
 `CompositeView` maintains an array of its immediate children as
 `this.children`. Using this reference, a parent view's `leave()`
-method will invoke `leave()` on all its children, ensuring that an entire 
+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
@@ -77,31 +83,33 @@ maintain a back-reference at `this.parent`. This is used to reach up and call
 
 ## Dependencies
 
-You'll need these, but chances are you already have them in your app:
+Backbone Support has the following dependencies:
 
 * jQuery or Zepto
 * Underscore
 * Backbone
 
-## Development
-
-First:
-
-    bundle
-
-While TDD'ing:
+### Included Versions
 
-    bundle exec rake jasmine
+For convenience, Backbone Support comes with a vendored copy of Backbone and
+Underscore to get you up and running as quickly as possible. If you want to
+use these included files, simply follow the instructions below in the
+[Installation][] section.
 
-To not open tests in a browser window:
+### Alternate Versions
 
-    bundle exec rake jasmine:ci
+If you require a different version of Backbone or Underscore than those
+provided by this gem, simply put the script files in
+`vendor/assets/javascripts` and they will take higher precedence than the
+versions provided by the gem thanks to the ordering of the [search paths in the
+asset pipeline][].
 
 ## Installation
 
-The recommended usage is with Rails 3.1.
+The recommended usage is with Rails 3.1 or higher to take advantage of the
+asset pipeline.
 
-### With Rails 3.1
+### With Rails 3.1 or higher
 
 Add the gem to your Gemfile
 
@@ -109,8 +117,19 @@ Add the gem to your Gemfile
 
 And then `bundle install`
 
-In your application.js, or in whatever file your backbone.js assets are
-required in, add the following:
+Before including any part of Backbone Support, you must include its
+dependencies. In your application.js or any other manifest file, add the
+following to load in the needed dependencies:
+
+    // jQuery is provided by the 'jquery-rails' gem, included with Rails
+    //= require jquery
+    //
+    // Backbone Support includes Backbone and Underscore, or you can provides
+    // alternate versions by placing them in vendor/assets/javascripts/
+    //= require backbone
+    //= require underscore
+
+To require all of Backbone Support, add the following:
 
     //= require backbone-support
 
@@ -118,13 +137,16 @@ This should be _above_ any usage of SwappingController or SwappingRouter, but
 below the inclusion of Backbone.js, Underscore, and jQuery.
 
 If you do not wish to include all of backbone-support, you can include
-individual pieces.  First, require the main support file:
+individual pieces.  Require the support file and the individual assets you
+wish to use:
 
     //= require backbone-support/support
+    //= require backbone-support/swapping_router
 
-Then require the individual assets you wish to use:
+or:
 
-    //= require backbone-support/swapping_router
+    //= require backbone-support/support
+    //= require backbone-support/observer
     //= require backbone-support/composite_view
 
 ### With Jammit
@@ -175,6 +197,26 @@ require("/vendor/plugins/backbone-support/lib/assets/javascripts/backbone-suppor
 require("/vendor/plugins/backbone-support/lib/assets/javascripts/backbone-support/swapping_router.js");
 ```
 
+## Development
+
+First:
+
+    bundle
+
+While TDD'ing:
+
+    bundle exec rake jasmine
+
+To not open tests in a browser window:
+
+    bundle exec rake jasmine:ci
+
 ## License
 
-Copyright 2012 thoughtbot. Please check LICENSE for more details.
+Copyright 2012 thoughtbot. Please check [LICENSE][] for more details.
+
+[Installation]: https://github.com/thoughtbot/backbone-support#installation
+[search paths in the asset pipeline]: http://edgeguides.rubyonrails.org/asset_pipeline.html#search-paths
+[Backbone.js on Rails book]: https://learn.thoughtbot.com/products/1-backbone-js-on-rails
+[Backbone.js]: http://backbonejs.org/
+[LICENSE]: https://github.com/thoughtbot/backbone-support/blob/master/LICENSE

data/backbone-support.gemspec

@@ -16,5 +16,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency('jasmine')
+  s.add_development_dependency('jasmine', '1.3.0')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('headless')
 end

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

@@ -41,7 +41,11 @@ _.extend(Support.CompositeView.prototype, Backbone.View.prototype, Support.Obser
   
   prependChildTo: function (view, container) {
     this.renderChild(view);
-    $(container).prepend(view.el);
+    this.$(container).prepend(view.el);
+  },
+
+  swapped: function () {
+    this.trigger('swapped')
   },
 
   _leaveChildren: function() {

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

@@ -1,2 +1,2 @@
-Support = {};
-Support.VERSION = "0.0.1";
+window.Support = {};
+Support.VERSION = "0.3.2";

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

@@ -10,6 +10,10 @@ _.extend(Support.SwappingRouter.prototype, Backbone.Router.prototype, {
 
     this.currentView = newView;
     $(this.el).empty().append(this.currentView.render().el);
+
+    if (this.currentView && this.currentView.swapped) {
+      this.currentView.swapped();
+    }
   }
 });
 

data/lib/backbone-support/version.rb

@@ -1,3 +1,3 @@
 module BackboneSupport
-  VERSION = '0.3.1'.freeze
+  VERSION = '0.3.2'.freeze
 end

data/spec/javascripts/composite_view_spec.js

@@ -91,6 +91,15 @@ describe("Support.CompositeView", function() {
 
       expect($(view.el).find('.inside').text()).toEqual("Append to this!Orange!"); 
     });
+
+    it("appends the element only to elements inside the view", function(){
+      var view = new blankView({el: $('<div><div class="main">Append to this!</div></div>')});
+      var div = $("<div class='main' id='outside'></div>");
+      view.appendChildTo(new orangeView(), ".main");
+
+      expect($(view.el).find('.main').text()).toEqual("Append to this!Orange!");
+      expect($("#outside").text()).toEqual("");
+    });
   });
   
   describe("#prependChild", function() {
@@ -108,11 +117,29 @@ describe("Support.CompositeView", function() {
       $("#test1").text("Prepend to this!");
   
       var view = new blankView({el: "#test"});
+      expect($("#test").text()).toEqual("");
+
+      $("#test").append($("#test1"));
       view.prependChildTo(new orangeView(), "#test1");
   
-      expect($("#test").text()).toEqual("");
       expect($("#test1").text()).toEqual("Orange!Prepend to this!");
     });
+
+    it("prepends child into a sub-element even if it is not added to the document", function() {
+      var view = new blankView({el: $('<div><div class="inside">Prepend to this!</div></div>')});
+      view.prependChildTo(new orangeView(), ".inside");
+
+      expect($(view.el).find('.inside').text()).toEqual("Orange!Prepend to this!");
+    });
+    
+    it("prepends the element only to elements inside the view", function(){
+      var view = new blankView({el: $('<div><div class="main">Prepend to this!</div></div>')});
+      var div = $("<div class='main' id='outside'></div>");
+      view.prependChildTo(new orangeView(), ".main");
+
+      expect($(view.el).find('.main').text()).toEqual("Orange!Prepend to this!");
+      expect($("#outside").text()).toEqual("");
+    });
   });
 
   describe("#leave", function() {
@@ -219,6 +246,18 @@ describe("Support.CompositeView", function() {
     });
   });
 
+  describe("#swapped", function() {
+    it("fires 'swapped' event", function() {
+      var eventListener = sinon.spy()
+      var view = new Support.CompositeView
+      view.bind('swapped', eventListener)
+
+      view.swapped();
+
+      expect(eventListener.called).toBeTruthy();
+    });
+  });
+
   describe("#bindTo", function() {
     var view = new orangeView();
     var callback = sinon.spy();
@@ -260,5 +299,4 @@ describe("Support.CompositeView", function() {
       });
     });
   });
-
 });

data/spec/javascripts/support/jasmine.yml

@@ -11,9 +11,9 @@
 #   - dist/**/*.js
 #
 src_files:
-    - vendor/jquery.js
-    - vendor/underscore.js
-    - vendor/backbone.js
+    - spec/javascripts/support/jquery.js
+    - vendor/assets/javascripts/underscore.js
+    - vendor/assets/javascripts/backbone.js
     - lib/assets/javascripts/backbone-support.js
     - lib/assets/javascripts/backbone-support/support.js
     - lib/assets/javascripts/backbone-support/observer.js

data/spec/javascripts/swapping_router_spec.js

@@ -16,8 +16,8 @@ describe("Support.SwappingRouter", function() {
   });
 
   var leaveView = Backbone.View.extend({
-    leave: function() {
-    }
+    leave: function() {},
+    swapped: function() {},
   });
   var leaveViewInstance = new leaveView();
 
@@ -119,4 +119,18 @@ describe("Support.SwappingRouter", function() {
       expect(spy.called).toBeTruthy();
     });
   });
+
+  it("calls .swapped on the view after swapping", function() {
+    var spy = sinon.spy(leaveViewInstance, "swapped");
+
+    runs(function() {
+      window.location.hash = "#leave"
+    });
+
+    Helpers.sleep()
+
+    runs(function() {
+      expect(spy.called).toBeTruthy()
+    });
+  });
 });

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: backbone-support
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -12,10 +12,42 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-05 00:00:00.000000000 Z
+date: 2013-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jasmine
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !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: headless
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -38,6 +70,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - CHANGELOG
 - Gemfile
 - Gemfile.lock
@@ -60,10 +93,10 @@ files:
 - spec/javascripts/support/jasmine.yml
 - spec/javascripts/support/jasmine_config.rb
 - spec/javascripts/support/jasmine_runner.rb
+- spec/javascripts/support/jquery.js
 - spec/javascripts/swapping_router_spec.js
-- vendor/backbone.js
-- vendor/jquery.js
-- vendor/underscore.js
+- vendor/assets/javascripts/backbone.js
+- vendor/assets/javascripts/underscore.js
 homepage: http://github.com/thoughtbot/backbone-support
 licenses: []
 post_install_message: 
@@ -84,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: SwappingController and CompositeView for Backbone.js
@@ -96,5 +129,5 @@ test_files:
 - spec/javascripts/support/jasmine.yml
 - spec/javascripts/support/jasmine_config.rb
 - spec/javascripts/support/jasmine_runner.rb
+- spec/javascripts/support/jquery.js
 - spec/javascripts/swapping_router_spec.js
-has_rdoc: