backbone-support 0.0.1 → 0.2.0

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+*.swp

data/CHANGELOG

@@ -0,0 +1,12 @@
+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
+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).
+
+0.0.1
+
+Initial Version

data/README.md

@@ -1,11 +1,16 @@
-Helper and utility classes that fill out Backbone for serious development.
+There's no built-in garbage collection for Backbone’s event bindings, and 
+forgetting to unbind can cause bugs and memory leaks.
+
+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:
 http://workshops.thoughtbot.com/backbone-js-on-rails
 
 The book contains complete instructions and in-depth coverage of the internals
-of CompositeView and Swappingrouter, and an example application that shows
-their usage 
+of CompositeView and SwappingRouter, and an example application that shows
+their usage.
 
 ### SwappingRouter
 
@@ -14,7 +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.
+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).
 
 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
@@ -24,10 +30,9 @@ view by rendering that view into its own `el`:
       if (this.currentView && this.currentView.leave) {
         this.currentView.leave();
       }
-  
+
       this.currentView = newView;
-      this.currentView.render();
-      $(this.el).empty().append(this.currentView.el);
+      $(this.el).empty().append(this.currentView.render().el);
     }
 
 An example SwappingRouter would look as follows:
@@ -74,7 +79,7 @@ maintain a back-reference at `this.parent`. This is used to reach up and call
 
 You'll need these, but chances are you already have them in your app:
 
-* jQuery
+* jQuery or Zepto
 * Underscore
 * Backbone
 
@@ -131,7 +136,7 @@ First off:
 In your `config/application.rb`:
 
 ``` ruby
-config.middleware.use Rack::Static, 
+config.middleware.use Rack::Static,
                       :urls => ['/vendor/plugins/backbone-support/lib/assets/javascripts']
 ```
 
@@ -157,7 +162,6 @@ end
 Your individual specs will then need the full root path in `require`. For
 example:
 
-
 ``` js
 requirePublic = function(path) {
   require("/public/javascripts/" + path);

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

@@ -9,8 +9,7 @@ _.extend(Support.SwappingRouter.prototype, Backbone.Router.prototype, {
     }
 
     this.currentView = newView;
-    this.currentView.render();
-    $(this.el).empty().append(this.currentView.el);
+    $(this.el).empty().append(this.currentView.render().el);
   }
 });
 

data/lib/backbone-support/version.rb

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

data/spec/javascripts/support/jasmine.yml

@@ -14,6 +14,8 @@ src_files:
     - vendor/jquery.js
     - vendor/underscore.js
     - vendor/backbone.js
+    - lib/assets/javascripts/backbone-support.js
+    - lib/assets/javascripts/backbone-support/support.js
     - lib/**/*.js
 
 # spec_files

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: backbone-support
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 23
   prerelease: 
   segments: 
   - 0
+  - 2
   - 0
-  - 1
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Chad Pytel
@@ -18,7 +18,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-29 00:00:00 Z
+date: 2012-01-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: jasmine
@@ -44,6 +44,8 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gitignore
+- CHANGELOG
 - Gemfile
 - Gemfile.lock
 - LICENSE