backbone-fetch-event 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in backbone-fetch-event.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Tim Branyen, Todd Eichel
+
+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:
+
+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.

data/README.md

@@ -0,0 +1,42 @@
+# backbone-fetch-event
+
+Patches Backbone's Model and Collection to fire a `fetch` event when starting a fetch operation.
+Useful for showing a loading indicator while data is being retrieved.
+
+Original blog post and code: [http://tbranyen.com/post/how-to-indicate-backbone-fetch-progress](http://tbranyen.com/post/how-to-indicate-backbone-fetch-progress)
+
+This gem makes it easy to include in Rails 3.1 projects using the asset pipeline. It just bundles
+the JavaScript file and makes it available to your application.
+
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+    gem 'backbone-fetch-event'
+
+Then require it somewhere, e.g. `app/assets/javascripts/application.js`:
+
+    //= require backbone-fetch-event
+
+
+## Usage
+
+Just bind to the `fetch` event on a model or collection. A view that shows a spinner whenever its
+collection is being fetched might look like this:
+
+    Repos.Views.List = Backbone.View.extend({
+      initialize: function () {
+        // Display a loading indication whenever the Collection is fetching.
+        this.collection.on("fetch", function () {
+          this.html("<img src='/assets/img/spinner.gif'>");
+        }, this);
+      }
+    });
+
+
+## Contributors
+
+  - [Tim Branyen](http://tbranyen.com): original idea and code
+  - [Todd Eichel](http://toddeichel.com): packaging for the Rails asset pipeline
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/backbone-fetch-event.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'backbone-fetch-event/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "backbone-fetch-event"
+  gem.version       = BackboneFetchEvent::VERSION
+  gem.authors       = ["Tim Branyen", "Todd Eichel"]
+  gem.email         = ["tim@tabdeveloper.com", "todd@toddeichel.com"]
+  gem.description   = %q{Code by Tim Branyen (http://tbranyen.com/post/how-to-indicate-backbone-fetch-progress). Packaged by Todd Eichel.}
+  gem.summary       = %q{Triggers an event when a Model or Collection starts a fetch.}
+  gem.homepage      = "https://github.com/tfe/backbone-fetch-event"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/backbone-fetch-event.rb

@@ -0,0 +1,8 @@
+require "backbone-fetch-event/version"
+
+module BackboneFetchEvent
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/backbone-fetch-event/version.rb

@@ -0,0 +1,3 @@
+module BackboneFetchEvent
+  VERSION = "0.0.1"
+end

data/vendor/assets/javascripts/backbone-fetch-event.js

@@ -0,0 +1,17 @@
+// Patch Model and Collection so they emit a 'fetch' event when starting to fetch data
+// http://tbranyen.com/post/how-to-indicate-backbone-fetch-progress
+_.each(["Model", "Collection"], function(name) {
+  // Cache Backbone constructor.
+  var ctor = Backbone[name];
+  // Cache original fetch.
+  var fetch = ctor.prototype.fetch;
+
+  // Override the fetch method to emit a fetch event.
+  ctor.prototype.fetch = function() {
+    // Trigger the fetch event on the instance.
+    this.trigger("fetch", this);
+
+    // Pass through to original fetch.
+    return fetch.apply(this, arguments);
+  };
+});

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: backbone-fetch-event
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tim Branyen
+- Todd Eichel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-29 00:00:00.000000000 Z
+dependencies: []
+description: Code by Tim Branyen (http://tbranyen.com/post/how-to-indicate-backbone-fetch-progress).
+  Packaged by Todd Eichel.
+email:
+- tim@tabdeveloper.com
+- todd@toddeichel.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- backbone-fetch-event.gemspec
+- lib/backbone-fetch-event.rb
+- lib/backbone-fetch-event/version.rb
+- vendor/assets/javascripts/backbone-fetch-event.js
+homepage: https://github.com/tfe/backbone-fetch-event
+licenses: []
+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
+signing_key: 
+specification_version: 3
+summary: Triggers an event when a Model or Collection starts a fetch.
+test_files: []