rails-backbone-generator 0.0.1

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,135 @@
+# RailsBackboneGenerator
+Inspired by ``rails generate`` - Generates [Backbone.js](/documentcloud/backbone) models and collections with [BackboneFactory](/SupportBee/Backbone-Factory) and [Jasmine](/pivotal/jasmine) tests.
+```  
+    $ 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 generators:
+```
+$ rails g # for generate
+
+  Backbone:
+    backbone:collection
+    backbone:model
+    backbone:namespace
+```
+##  backbone:namespace
+Creates a namespaced directory structure
+```
+$ rails g backbone:namespace dashboard
+  
+  app/assets/javascripts/dashboard
+  │   ├── collections
+  │   ├── models
+  │   ├── routes
+  │   ├── templates
+  │   └── views
+  ├── dashboard.coffee
+  ├── application.js
+  └── shared
+      ├── core_extentions
+      │   └── collections_extentions.coffee
+      ├── helpers
+      └── utils
+
+  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
+  create  app/assets/javascripts/dashboard/widget.coffee
+  create  spec/javascripts/dashboard/factories/widget_factory.coffee
+  create  spec/javascripts/dashboard/models/widget_spec.coffee
+  
+  app/assets/javascript/dashboard
+  └── models
+      └── widget.coffee
+  
+  spec/javascripts/dashboard
+  ├── factories
+  │   └── widget_factory.coffee
+  └── models
+      └── widget_spec.coffee
+  
+  
+```
+## Factories
+Similar to ruby's FactoryGirl, BackboneFactory adds factories to Jasmine.js.  ``Factory.widget({ options:obj })  #=> Backbone.Model``
+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'
+```
+
+
+
+## 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,65 @@
+# 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
+    
+    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, "#{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,68 @@
+# 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 ensure_namespaced_app_dir # :nodoc:
+      directory 'app/assets/javascripts'
+      
+      # add to application.js
+      append_to_file 'app/assets/javascripts/application.js', "\n\n"
+      gsub_file 'app/assets/javascripts/application.js', /\/\/.*\n\s/ do |match|
+        match.sub /\n\s/, "\n//= require ./#{namespace}\n\n"
+      end
+    end
+    
+    def ensure_namespaced_spec_dir # :nodoc:
+      directory 'spec/javascripts'
+    end
+    
+    # removes %un-namespaced% files
+    def cleanup
+      ['app/assets/javascripts', 'spec/javascripts'].each do |base|
+        Dir.glob("#{base}/**/__delte__*").each do |file|
+          remove_file( file )
+        end
+      end
+    end
+    
+    def print_tree
+      tree = <<-TREE
+      
+      app/assets/javascripts/dashboard
+      │   ├── collections
+      │   ├── models
+      │   ├── routes
+      │   ├── templates
+      │   └── views
+      ├── dashboard.coffee
+      ├── application.js
+      └── shared
+          ├── core_extentions
+          │   └── collections_extentions.coffee
+          ├── helpers
+          └── utils
+
+      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/templates/app/assets/javascripts/%namespace%/collections/%collection_name%.coffee.tt

@@ -0,0 +1,4 @@
+#= require ../models/<%= model_name %>
+
+class <%= [namespace('classify'), "Collections", collection_name('classify')].compact.join('.') %> extends Backbone.ExtendedCollection
+  model: <%= [namespace('classify'), "Models", model_name('classify')].compact.join('.') %>

data/lib/generators/backbone/templates/app/assets/javascripts/%namespace%/models/%model_name%.coffee.tt

@@ -0,0 +1,15 @@
+class <%= [namespace('classify'), "Models", model_name('classify')].compact.join('.') %> extends Backbone.RelationalModel
+
+  # relations:[
+  #   {
+  #     type:            'HasMany'
+  #     key:             'examples'
+  #     relatedModel:    '<%= [namespace('classify'), "Models", "Example"].compact.join('.') %>'
+  #     collectionType:  '<%= [namespace('classify'), "Collections", "Examples"].compact.join('.') %>'
+  #     reverseRelation: 
+  #       key: 'example_id'
+  #       type: 'HasOne'
+  #   }
+  # ]
+  # 
+  # defaults: {}

data/lib/generators/backbone/templates/app/assets/javascripts/%namespace%.coffee.tt

@@ -0,0 +1,16 @@
+#= require_tree ./shared
+#= require_self
+#= require_tree ./<%= namespace %>
+window.<%= namespace( :classify ) %> ||= {}
+_(<%= namespace( :classify ) %>).extend
+  Collections: {}
+  Models: {}
+  Routers: {}
+  Views: {}
+  Templates: {}
+  Environment: {}
+
+
+
+$(document).ready ->
+  

data/lib/generators/backbone/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/templates/spec/javascripts/%namespace%/collections/%collection_name%_spec.coffee.tt

@@ -0,0 +1,8 @@
+describe "<%= [namespace('classify'), 'Collections'].compact.join('.') %>", ->
+  
+  describe "<%= collection_name('classify') %>", ->
+    @<%= collection_name %> = Factory.<%= collection_name %>()
+
+    it "should build from factory", =>
+      expect(@<%= collection_name %>).toBeA(<%= [namespace('classify'), "Collections", collection_name('classify')].compact.join('.') %>)
+      expect(@<%= collection_name %>.at(0)).toBeA(<%= [namespace('classify'), "Models", model_name('classify')].compact.join('.') %>)

data/lib/generators/backbone/templates/spec/javascripts/%namespace%/factories/%model_name%_factory.coffee.tt

@@ -0,0 +1,43 @@
+# ====================================================
+# =                      Model                       =
+# ====================================================
+BackboneFactory.define '<%= model_name %>', <%= "#{namespace('classify')}.Models.#{model_name('classify')}" %>, ->
+  # title:       'Your Title Here'
+  # description: 'string, function, or another Factory'
+  # size:         _(['Tall', 'Grande', 'Venti', 'Trenta']).shuffle()[0]
+  # section:      Factory.section()
+
+
+
+
+# =======================================================
+# =  FactoryGirl Interface:                             =
+# =  Factory.modleName( {overrides:here} )              =
+# =======================================================
+window.Factory = (->
+  factories = [{}].concat _(BackboneFactory.factories).keys()
+  _(factories).inject (memo, factory)->
+    memo[factory]= (overrides)-> BackboneFactory.create factory, -> overrides
+    memo
+)()
+
+
+<%- if collection_name -%>
+# ====================================================
+# =                   Collection                     =
+# ====================================================
+_(window.Factory).extend({        
+  <%= collection_name %>:   (overrides)->   new <%= "#{namespace('classify')}.Collections.#{collection_name('classify')}" %>  _({
+    models: _([1,2,3]).map -> BackboneFactory.create('<%= model_name %>', ->)
+    }).extend( overrides )
+
+})
+<%- end -%>
+
+
+# ====================================================
+# =               Complex Factories                 =
+# ====================================================
+
+# section_w_section_materials: (overrides)-> Factory.section( _( section_materials: Factory.section_materials().models ).extend(overrides) )
+# distributor_w_offers:        (overrides)-> Factory.distributor( _(offers: Factory.offers().models ).extend(overrides))

data/lib/generators/backbone/templates/spec/javascripts/%namespace%/models/%model_name%_spec.coffee.tt

@@ -0,0 +1,12 @@
+describe "<%= [namespace('classify'), 'Models'].compact.join('.') %>", ->
+  
+  describe "<%= model_name('classify') %>", ->
+    @<%= model_name %> = Factory.<%= model_name %>()
+  
+    it "should build from factory", =>
+      expect(@<%= model_name %>).toBeA( <%= [namespace('classify'), "Models", model_name('classify')].compact.join('.') %> )
+      # expect(@<%= model_name %>).toHaveAssociated('examples')
+      
+    it "should have better tests", =>
+      # TODO
+    

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

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

data/lib/generators/backbone/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/templates/spec/javascripts/helpers/fake_host.coffee

@@ -0,0 +1,18 @@
+#= 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", ShopCompare.routes.course_search_path(),   [200, { "Content-Type": "application/json" }, JSON.stringify( Fixtures.courses )] )
+  window.FakeHost.respondWith("GET", new RegExp(ShopCompare.routes.section_books_path("[\\d]+$")), [200, { "Content-Type": "application/json" }, JSON.stringify( Fixtures.section )] )
+  window.FakeHost.respondWith("GET", new RegExp(ShopCompare.routes.book_info_path({isbn : "[\\d]+$"})), [200, { "Content-Type": "application/json" }, JSON.stringify( Fixtures.book )] )
+  window.FakeHost.respondWith("GET", ShopCompare.escapeRegExp(ShopCompare.offer_route("REG"), "REG", "[\\d]+"), [200, { "Content-Type": "application/json" }, JSON.stringify( Fixtures.offers )] )
+  # window.FakeHost.respondWith("GET", /\/applications.json/,   [200, { "Content-Type": "application/json" }, JSON.stringify( Fixtures.rafter_apps )] )
+  # window.FakeHost.respondWith("GET", new RegExp(ShopCompare.routes.sections_path() + "\\?keywords=[^&]*$"), [200, { "Content-Type": "application/json" }, JSON.stringify( Fixtures.courses )])
+  # window.FakeHost.respondWith("GET", new RegExp(ShopCompare.routes.sections_path()), [200, { "Content-Type": "application/json" }, JSON.stringify( Fixtures.sections )])
+  
+afterEach ->
+  window.FakeHost.restore()

data/lib/generators/backbone/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'

data/lib/generators/backbone/templates/spec/javascripts/helpers/state_helpers.coffee

@@ -0,0 +1,4 @@
+beforeEach ->
+  @addMatchers toHaveState: (expectedState) ->
+    state = @actual.get('currentState')
+    state is expectedState