rails-backbone-generator 0.0.2 → 0.0.3

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Chip Miller
+
+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,213 @@
+# RailsBackboneGenerator [![Gem Version](https://badge.fury.io/rb/rails-backbone-generator.png)](http://badge.fury.io/rb/rails-backbone-generator)  
+Inspired by ``rails generate`` - Generates [Backbone.js](/documentcloud/backbone) models and collections with [BackboneFactory](/SupportBee/Backbone-Factory) and [Jasmine](/pivotal/jasmine) tests.  
+The gem adds Backbone: [Setup](#backbonesetup) | [Namespace](#backbonenamespace) | [Model](#backbonemodel) | [Collection](#backbonecollection)
+
+
+```  
+    $ rails generate backbone:collection Dashboard::Widget 
+    
+    app/assets/javascripts/dashboard
+    ├── collections
+    │   └── widgets.coffee
+    └── models
+        └── widget.coffee
+    
+    spec/javascripts/dashboard
+    ├── collections
+    │   └── widgets_spec.coffee
+    ├── factories
+    │   └── widget_factory.coffee
+    └── models
+        └── widget_spec.coffee
+```
+## Installation
+Add this line to your application's Gemfile:
+
+    gem 'rails_backbone_generator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_backbone_generator
+
+
+
+
+## Usage
+The gem has three main generators (and one for setup):  
+[backbone:setup](#backbonesetup) | [backbone:namespace](#backbonenamespace) | [backbone:model](#backbonemodel) | [backbone:collection](#backbonecollection)
+```
+$ rails g # for generate
+
+  Backbone:
+    backbone:collection
+    backbone:model
+    backbone:namespace
+    backbone:setup
+```
+
+
+##  backbone:namespace
+Creates a namespaced directory structure
+```
+$ rails g backbone:namespace dashboard
+  
+  app/assets/javascripts/dashboard
+  │   ├── collections
+  │   ├── models
+  │   ├── routes
+  │   ├── templates
+  │   └── views
+  └── dashboard.coffee
+
+  spec/javascripts/dashboard/
+  ├── collections
+  ├── factories
+  ├── models
+  └── views
+```
+
+
+##  backbone:collection
+Creates a model and plural-collection 
+```
+$ rails g backbone:collection Dashboard::Widgets
+
+  app/assets/javascripts/dashboard
+  ├── collections
+  │   └── widgets.coffee
+  └── models
+      └── widget.coffee
+  
+  spec/javascripts/dashboard/
+  ├── collections
+  │   └── widgets_spec.coffee
+  ├── factories
+  │   └── widget_factory.coffee
+  └── models
+      └── widget_spec.coffee
+```
+
+
+##  backbone:model
+Creates a model w/out a collection
+```
+$ rails g backbone:model Dashboard::Widget
+  
+  app/assets/javascript/dashboard
+  └── models
+      └── widget.coffee
+  
+  spec/javascripts/dashboard
+  ├── factories
+  │   └── widget_factory.coffee
+  └── models
+      └── widget_spec.coffee
+```
+
+
+##  backbone:setup
+__[ Optional ]__: Prepares the app for Backbone/Jasmine development.
+ * Vendors and requires core frameworks
+ * Adds common plugins and Jasmine helpers 
+ * Configures Jasmine and adds a Guard file.   Run ``bundle exec guard`` to run tests.
+ 
+__Runtime Dependency__  
+  ``brew install qt --build-from-source`` [\[ Details \]](https://github.com/thoughtbot/capybara-webkit/wiki/Installing-Qt-and-compiling-capybara-webkit)
+  * required to run Jasmine specs with guard-jasmine-headless-webkit
+  * other generators do not require this option
+
+```
+$ rails g backbone:setup
+      
+      app/assets/javascripts
+      ├── application.js
+      └── shared
+          ├── core_extentions
+          │   └── collections_extentions.coffee
+          ├── helpers
+          └── utils
+      
+      spec/javascripts/
+      ├── fixtures
+      ├── helpers
+      │   ├── association_helpers.coffee
+      │   ├── common_helpers.coffee
+      │   ├── fake_host.coffee
+      │   └── headless_webkit_helper.coffee
+      └── support
+          └── jasmine.yml
+
+      vendor/javascripts/
+      ├── backbone
+      │   ├── backbone-0.9.2.js
+      │   ├── backbone-bind-to-1.0.0.coffee
+      │   ├── backbone-handlebars-1.0.0.coffee
+      │   ├── backbone-query-0.1.2.js
+      │   ├── backbone-relational-0.6.0.js
+      │   ├── handlebars-1.0.rc.1.js
+      │   └── underscore-1.3.3.js
+      ├── browser_compatibility
+      │   ├── json2.js
+      │   └── localstorage-polyfill.js
+      ├── jquery
+      │   ├── jquery-1.8.0.js
+      │   ├── jquery-ui.min.js
+      │   ├── jquery.easing-1.3.js
+      │   └── jquery_ujs.js
+      └── testing
+          ├── backbone-factory.js
+          ├── jasmine-jquery-1.3.1.js
+          ├── jasmine-sinon.js
+          ├── mock-ajax.js
+          └── sinon-1.4.2.js
+      
+```
+## Factories
+Similar to ruby's FactoryGirl, [BackboneFactory](/SupportBee/Backbone-Factory) adds factories to Jasmine.js.  
+The generator adds ``Factory.model_name({optional:override})`` and ``Factory.collection_name({optional:override})``  
+```
+  # spec/javascripts/dashboard/factories/widget_factory.coffee
+  
+  BackboneFactory.define 'widget', Dashboard.Models.Widget, ->
+    reminder:  'Remember to update with attributes'
+        hint:  'attributes can be other factories'
+```
+
+## External Docs
+**[Backbone.js](http://backbonejs.org/)** and it's foundation **[Underscore.js](http://underscorejs.org/)**
+* [Backbone Relational](https://github.com/PaulUithol/Backbone-relational/#backbone-relational): Associations for Backbone Models <tt>Bundle.get('books')</tt>
+* [Backbone Query](https://github.com/davidgtonge/backbone_query#usage): A query DSL inspired by MongoDB. Includes matchers, logical operators, sorting, and paging.
+* [Backbone BindTo](https://github.com/RStankov/backbone-bind-to#backbonebindto): Cleans-up the pattern of adding and *removing* event listeners to <tt>Backbone.Views</tt>
+* [Backbone Handlebars](https://github.com/RStankov/backbone-handlebars/blob/master/README.md#backbonehandlebars): Extension for better integration with [Handlebars.js](http://handlebarsjs.com/) including nested views  
+
+**[Handlebars JS Templates](http://handlebarsjs.com/)**
+* [Handlebars TextMate Bundle](https://github.com/drnic/Handlebars.tmbundle)
+
+**[Jasmine.js](http://pivotal.github.com/jasmine/)** | [Cheat Sheat](https://github.com/mattfysh/cheat-sinon-jasmine)
+* [Backbone Factory](https://github.com/SupportBee/Backbone-Factory#backbone-factory)
+* [Jasmine Jquery](https://github.com/velesin/jasmine-jquery/)
+* [Sinon](http://sinonjs.org/): Spies, stubs, mock ajax, and time/animation
+* [Sinon-Jasmine](https://github.com/froots/jasmine-sinon#sinonjs-matchers): Test expectations for mocks and stubs
+
+**Best Practices**: [Backbone Patterns](http://ricostacruz.com/backbone-patterns/)  
+**Testing Backbone**: [Part 1: Introduction](http://tinnedfruit.com/2011/03/03/testing-backbone-apps-with-jasmine-sinon.html) | [Part 2: Models & Collections](http://tinnedfruit.com/2011/03/25/testing-backbone-apps-with-jasmine-sinon-2.html) | [Part 3: Routers & Views](http://tinnedfruit.com/2011/04/26/testing-backbone-apps-with-jasmine-sinon-3.html)
+**Hackers Guide to Backbone**: [Part 1: Models & Events](http://dailyjs.com/2012/07/19/mvstar-2/) | [Part 2: Collections](http://dailyjs.com/2012/07/26/mvstar-3/) | [Part 3: Router and History](http://dailyjs.com/2012/08/02/mvstar-4/) | [Part 4: Sync](http://dailyjs.com/2012/08/09/mvstar-5/)
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+<hr/>
+[![BookRenter.com Logo](http://www.rafter.com/common/images/header_logo.png "BookRenter.com")](http://http://www.rafter.com/)
+RailsBackboneGenerator is maintained by [Chip Miller](/chip-miller) and and funded by [Rafter](http://http://www.rafter.com/)
+

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/generators/backbone/collection_generator.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+require 'rails/generators'
+
+module Backbone
+  class CollectionGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    desc "Creates a BackboneModel, BackboneCollection, & Jasmine tests/factory\nrails g backbone:collection Navigation::Buttons"
+    argument :raw_collection_name, required: true, type: 'string'
+
+    def create_collection
+      destination_dir = File.join( ['app/assets/javascripts', namespace, 'collections', "#{collection_name}.coffee"].compact )
+      template 'app/assets/javascripts/%namespace%/collections/%collection_name%.coffee.tt', destination_dir
+    end
+    
+    def create_model
+      destination_dir = File.join( ['app/assets/javascripts', namespace, 'models', "#{model_name}.coffee"].compact )
+      template 'app/assets/javascripts/%namespace%/models/%model_name%.coffee.tt', destination_dir
+    end
+    
+    def create_specs
+      destination_dir = File.join( ['spec/javascripts', namespace].compact )
+      spec_paths = ['collections/%collection_name%_spec.coffee', 'factories/%model_name%_factory.coffee', 'models/%model_name%_spec.coffee']
+      spec_paths.each do |path|
+        template "spec/javascripts/%namespace%/#{path}.tt", "spec/javascripts/%namespace%/#{path}"
+      end
+    end
+    
+    def print_tree
+      tree =  <<-TREE
+        
+        app/assets/javascripts/dashboard
+        ├── collections
+        │   └── widgets.coffee
+        └── models
+            └── widget.coffee
+
+        spec/javascripts/dashboard
+        ├── collections
+        │   └── widgets_spec.coffee
+        ├── factories
+        │   └── widget_factory.coffee
+        └── models
+            └── widget_spec.coffee
+      TREE
+      say tree.gsub(/dashboard/, namespace.to_s).gsub(/widget/, model_name)
+    end
+    
+    # Helpers
+    def collection_name(classify=false)
+      style = classify ?  :camelize : :underscore
+      _collection_name, _namespace = raw_collection_name.split('::').reverse
+      _collection_name.pluralize.send(style)
+    end
+    
+    # Use the extended class if availiable ( recommended )
+    def collection_base_class
+      File.exists?(Rails.root.join('app/assets/javascripts/shared/core_extentions/collections_extentions.coffee')) ? 'Backbone.ExtendedCollection' : 'Backbone.Collection'
+    end
+    
+    def namespace(classify=false)
+      style = classify ?  :camelize : :underscore
+      _collection_name, _namespace = raw_collection_name.split('::').reverse
+      _namespace && _namespace.singularize.send(style)
+    end
+
+    def model_name(classify=false)
+      collection_name(classify).singularize
+    end
+  end
+end

data/lib/generators/backbone/model_generator.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+require 'rails/generators'
+
+module Backbone
+  class ModelGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    desc "Creates a BackboneModel, Jasmine tests/factory"
+    argument :raw_model_name, required: true, type: 'string'
+      
+    def create_model
+      destination_dir = File.join( ['app/assets/javascripts', namespace, "models/#{model_name}.coffee"].compact )
+      template 'app/assets/javascripts/%namespace%/models/%model_name%.coffee.tt', destination_dir
+    end
+    
+    def create_specs
+      destination_dir = File.join( ['spec/javascripts', namespace].compact )
+      spec_paths = ['factories/%model_name%_factory.coffee', 'models/%model_name%_spec.coffee']
+      spec_paths.each do |path|
+        template "spec/javascripts/%namespace%/#{path}.tt", "spec/javascripts/%namespace%/#{path}"
+      end
+    end
+    
+    def print_tree
+      tree =  <<-TREE
+        
+        app/assets/javascript/dashboard
+        └── models
+            └── widget.coffee
+
+        spec/javascripts/dashboard
+        ├── factories
+        │   └── widget_factory.coffee
+        └── models
+            └── widget_spec.coffee
+      TREE
+      say tree.gsub(/\/dashboard/, namespace.to_s).gsub(/widget/, model_name)
+    end
+    
+    # Helpers
+    def namespace(classify=false)
+      @model_name, @namespace = raw_model_name.split('::').reverse
+      style = classify ?  :camelize : :underscore
+      @namespace && @namespace.singularize.send(style)
+    end
+
+    def model_name(classify=false)
+      @model_name, @namespace = raw_model_name.split('::').reverse
+      style = classify ?  :camelize : :underscore
+      @model_name.singularize.send(style)
+    end
+    
+    def collection_name(classify=false)      
+    end
+        
+  end
+end

data/lib/generators/backbone/namespace_generator.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+require 'rails/generators'
+require 'find'
+
+module Backbone
+  class NamespaceGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    desc "Setup a Backbone namespace"
+    argument :raw_namespace, :type => :string, :required => true
+    
+    def setup_dir_structure
+      Dir.glob(File.join(source_paths, "**/.gitkeep")) do |keep_path|  
+        template keep_path, keep_path.gsub(/^.*backbone\/templates\//, "")
+      end
+      
+      # build and require a namespace initializer
+      template "app/assets/javascripts/%namespace%.coffee.tt", "app/assets/javascripts/%namespace%.coffee"
+      path = File.join(destination_root, 'app/assets/javascripts/application.js')
+      content =(
+        if behavior == :revoke  # destroy
+          File.read(path).sub(/\/\/= require \.\/#{namespace}\n/, '')
+        else
+          File.read(path).sub(/(^\/\/[\S| ]*\n)([^\/])/) do |match|
+            "#{match.strip}\n//= require ./#{namespace}\n\n"
+          end
+        end  )
+      File.open(path, 'wb') { |file| file.write(content) }
+      say_status :gsub, 'app/assets/javascripts/application.js'
+    end
+    
+    
+        
+    def print_tree
+      tree = <<-TREE
+      
+      app/assets/javascripts/dashboard
+      │   ├── collections
+      │   ├── models
+      │   ├── routes
+      │   ├── templates
+      │   └── views
+      └── dashboard.coffee
+
+
+      spec/javascripts/dashboard/
+      ├── collections
+      ├── factories
+      ├── models
+      └── views
+      TREE
+      say tree.gsub(/dashboard/, namespace).gsub(/widget/, model_name)
+    end
+    
+    def namespace(classify=false)
+      style = classify ?  :camelize : :underscore
+      raw_namespace.send(style)
+    end
+    
+    def model_name(classify=false); '__delte__' ;end
+    def collection_name(classify=false); '__delte__' ;end
+  end
+end

data/lib/generators/backbone/setup_generator/templates/Guardfile

@@ -0,0 +1,44 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+# Run JS and CoffeeScript files in a typical Rails 3.1 fashion, placing Underscore templates in app/views/*.jst
+# Your spec files end with _spec.{js,coffee}.
+
+spec_location = "spec/javascripts/%s_spec"
+
+
+guard 'jasmine-headless-webkit' do
+  watch(%r{^app/views/.*\.jst$})
+  
+  # Run All
+  watch(%r{^spec/javascripts/factories\..*}) { spec_location }
+  watch(%r{^spec/javascripts/helpers(.*)\.(js|coffee)$}) { spec_location }
+  watch(%r{^app/assets/javascripts/([^/]*)\.(js|coffee)$}) { spec_location }
+  watch(%r{^app/assets/javascripts/fixtures(.*)\.(js|coffee)$}) { spec_location }
+
+  # Single Spec
+  watch(%r{^public/javascripts/(.*)\.js$}) { |m| newest_js_file(spec_location % m[1]) }
+  watch(%r{^app/assets/javascripts/(.*)\.(js|coffee)$}) { |m| newest_js_file(spec_location % m[1]) }
+  watch(%r{^spec/javascripts/(.*)_spec\..*}) { |m| newest_js_file(spec_location % m[1]) }
+end
+
+
+
+# guard 'rspec', :version => 2 do
+#   watch(%r{^spec/.+_spec\.rb$})
+#   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+#   watch('spec/spec_helper.rb')  { "spec" }
+#   watch(%r{spec/factories/.*_factory.rb'})  { "spec" }
+# 
+#   # Rails example
+#   watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+#   watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+#   watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+#   watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+#   watch('config/routes.rb')                           { "spec/routing" }
+#   watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+# 
+#   # Capybara request specs
+#   watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+# 
+# end

data/lib/generators/backbone/setup_generator/templates/app/assets/javascripts/application.js

@@ -0,0 +1,14 @@
+// This is a manifest file that'll be compiled into application.js
+//
+//= require_tree ../../../vendor/assets/javascripts/browser_compatibility
+//= require ../../../vendor/assets/javascripts/jquery/jquery-1.8.0
+//= require ../../../vendor/assets/javascripts/jquery/jquery-ui.min
+//= require ../../../vendor/assets/javascripts/jquery/jquery.easing-1.3
+//= require ../../../vendor/assets/javascripts/backbone/handlebars-1.0.rc.1
+//= require ../../../vendor/assets/javascripts/backbone/underscore-1.3.3
+//= require ../../../vendor/assets/javascripts/backbone/backbone-0.9.2
+//= require ../../../vendor/assets/javascripts/backbone/backbone-relational-0.6.0
+//= require ../../../vendor/assets/javascripts/backbone/backbone-query-0.2.3
+//= require ../../../vendor/assets/javascripts/backbone/backbone-bind-to-1.0.0
+//= require ../../../vendor/assets/javascripts/backbone/backbone-handlebars-1.0.0
+//= require_tree ./shared

data/lib/generators/backbone/setup_generator/templates/app/assets/javascripts/shared/core_extentions/collections_extentions.coffee

@@ -0,0 +1,30 @@
+class Backbone.ExtendedCollection extends Backbone.Collection
+  
+  # Backwards compatable interface update
+  # Allows the Backbone.Collection#constructor to accept a single hash of attributes.
+  # The 'models' attribute is used as the collection's enumerable
+  #
+  #   new Sample({
+  #     models:[ model1, model2],
+  #     title: 'great for factories'
+  #   })
+  #
+  constructor: (models=[], other_options={})->
+    unless models instanceof Array
+      _(other_options).extend( _(models).tap (obj)-> 
+        models = models.models
+        delete obj.options 
+      )
+    
+    # store attributes
+    @attributes = _.clone @defaults || {}
+    _.chain(@attributes).keys().each (attr)=>
+      @attributes[attr]= other_options[attr] if other_options[attr]?
+    
+    # continue building obj
+    super( models, other_options )
+    
+  
+  toJSON: => { collection: @models }
+  
+  first: => @at(0)

data/lib/generators/backbone/setup_generator/templates/spec/javascripts/helpers/association_helpers.coffee

@@ -0,0 +1,3 @@
+beforeEach ->
+  @addMatchers toHaveAssociated: (expectedAssociation) ->
+    @actual.get(expectedAssociation)?

data/lib/generators/backbone/setup_generator/templates/spec/javascripts/helpers/common_helpers.coffee

@@ -0,0 +1,13 @@
+beforeEach ->
+  @addMatchers toBeEmpty: ->
+    _(@actual).isEmpty()
+  
+  @addMatchers toBeA: (expeced) ->
+    @actual instanceof expeced
+  
+  @addMatchers toBeValid: () ->
+    @actual.isValid()
+
+  # Non-recursive version of toContain()
+  @addMatchers toInclude: (expeced) ->
+    _(@actual).include(expeced)

data/lib/generators/backbone/setup_generator/templates/spec/javascripts/helpers/fake_host.coffee

@@ -0,0 +1,14 @@
+#= require_tree ../fixtures
+#= require ../../../vendor/assets/javascripts/testing/sinon-1.4.2
+
+# FakeHost.respond() to complete request
+beforeEach ->
+  
+  localStorage.clear()
+  window.FakeHost = sinon.fakeServer.create();
+  # window.FakeHost.respondWith("GET", Dashboard.Routes.widget_search_path(),   [200, { "Content-Type": "application/json" }, JSON.stringify( Fixtures.search_results )] )
+  # window.FakeHost.respondWith("GET", new RegExp(Dashboard.Routes.widget_search_path("[\\d]+$")), [200, { "Content-Type": "application/json" }, JSON.stringify( Fixtures.search_results )] )
+
+  
+afterEach ->
+  window.FakeHost.restore()

data/lib/generators/backbone/setup_generator/templates/spec/javascripts/helpers/headless_webkit_helper.coffee

@@ -0,0 +1,9 @@
+is_headless = ->
+  /jasmine-headless-webkit/.test(navigator.userAgent)
+
+
+if is_headless()
+  # Things that need to change here
+
+else
+  jasmine.getFixtures().fixturesPath = 'assets/javascripts/fixtures'