batman-rails 0.0.9 → 0.15.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTg5OGJkMTdiNzEyMjI1ZmMzNGQ2ZDk4NTQ4MjgzYTZiOGM2M2U0Zg==
+  data.tar.gz: !binary |-
+    Zjk1NTc0MWEwN2RmZWNhZDAzNGJjMjBkZjQxNjMxZDZjNWYwYjgwYg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    Y2IzNDQxMDI5NzBjODZkY2E2YTAzNmQyMmUwYWQ2MmQzODEyMzUwNTA1ZGUw
+    YzU4YzE0N2UyMTI3MDIxYjE0NTA0OWJiMzlmNjVlZDRiNzM2YWMzMDE5NmRm
+    NDM3MTNiODFiZjNjNDkzMWNiYTFiNDdmNGUzYjYwOTBkOGY2OGY=
+  data.tar.gz: !binary |-
+    YWQyMWM1YjcxY2U5YWJlYjYyMTliZTg5Y2UyNzUyMGNhNGEyZjMzYTU0ODIz
+    N2EyMWIxMGI3YjQzZmQ0YTc2MjYwMzRmMzdlYzM5YWUyN2EwMTRjNmIwNzk0
+    MjNlYzZlNmQ2MzZiY2UxMWJjYWZmM2I4MWJkMDY2NjlkMmRiNzc=

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in batman-rails.gemspec
 gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Matt Helm
+
+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

@@ -1,58 +1,55 @@
-# Batman-Rails
+# Batman::Rails
 
-Easily setup and use batman.js (0.12.0) with rails 3.1
+Easily setup and use batman.js (0.15) with Rails 4
 
-## Rails 3.1 setup
-This gem requires the use of rails 3.1, coffeescript and the new rails asset pipeline provided by sprockets.
+## Installation
 
-This gem vendors the latest version of batman.js for Rails 3.1 and greater. The files will be added to the asset pipeline and available for you to use. 
-    
-### Installation
+Add this line to your application's Gemfile:
 
-In your Gemfile, add this line:
+    gem 'batman-rails'
 
-    gem "batman-rails"
-  
-Then run the following commands:
+And then execute:
 
-    bundle install
-    rails g batman:install
+    $ bundle
+    $ rails generate batman:app
 
 ### Layout and namespacing
 
-Running `rails g batman:install` will create the following directory structure under `app/assets/javascripts/`:
-  
-    controllers/
+Running `rails generate batman:app` will create the following directory structure under `app/assets/app_name/`:
+
     models/
-    helpers/
-    
-It will also create a toplevel app_name.coffee file to setup namespacing and setup initial requires.
-    
+    views/
+    controllers/
+    html/
+    lib/
+
+It will also create a toplevel `app_name.coffee` file to setup namespacing and setup initial requires.
+
 ## Generators
-batman-rails provides 3 simple generators to help get you started using batman.js with rails 3.1. 
-The generators will only create client side code (javascript).
+Batman-Rails provides 3 simple generators to help get you started using Batman.js with Rails.
+The generators will only create client side code (CoffeeScript).
 
 ### Model Generator
 
-    rails g batman:model
-    
-This generator creates a batman model and collection inside `app/assets/javascript/models` to be used to talk to the rails backend.
+    rails generate batman:model
+
+This generator creates a batman model inside `app/assets/app_name/models` to be used to talk to the Rails backend.
 
 ### Controllers
-    
-    rails g batman:controller
-    
+
+    rails generate batman:controller
+
 This generator creates a batman controller for the given actions provided.
 
 ### Scaffolding
 
-    rails g batman:scaffold
-    
-This generator creates a controller, helper and mode to create a simple crud single page app
+    rails generate batman:scaffold
+
+This generator creates a controller, helper and model to create a simple crud single page app
 
-## Example Usage
+## Usage
 
-Created a new rails 3.1 application called `blog`.
+Created a new Rails application called `blog`.
 
     rails new blog
 
@@ -63,10 +60,17 @@ Edit your Gemfile and add
 Install the gem and generate scaffolding.
 
     bundle install
-    rails g batman:install
-    rails g scaffold Post title:string content:string
+    rails generate batman:app
+    rails generate scaffold Post title:string content:string
     rake db:migrate
-    rails g batman:scaffold Post title:string content:string
-    
-You now have installed the batman-rails gem, setup a default directory structure for your frontend batman code. 
-Then you generated the usual rails server side crud scaffolding and finally generated batman.js code to provide a simple single page crud app.
+    rails generate batman:scaffold Post title:string content:string
+
+You now have installed the `batman-rails` gem, setup a default directory structure for your frontend batman code. Then you generated the usual Rails server side scaffolding and finally generated Batman.js code to provide a simple single page app.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -1,12 +1,5 @@
-#!/usr/bin/env rake
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-require 'bundler/gem_tasks'
-require 'rake/testtask'
+require "bundler/gem_tasks"
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'

data/batman-rails.gemspec

@@ -1,27 +1,26 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "batman/rails/version"
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'batman-rails/version'
 
-Gem::Specification.new do |s|
-  s.name        = "batman-rails"
-  s.version     = Batman::Rails::VERSION
-  s.authors     = ["John Duff"]
-  s.email       = ["john.duff@jadedpixel.com"]
-  s.homepage    = "https://github.com/Shopify/batman-rails"
-  s.summary     = %q{Use Batman.js with Rails 3.1}
-  s.description = %q{Quickly get started with Batman.js in a Rails 3.1 app. Provides generators to get started and bundles in the latest version of Batman.js.}
+Gem::Specification.new do |gem|
+  gem.name          = "batman-rails"
+  gem.version       = Batman::Rails::VERSION
+  gem.authors       = ["Nick Small", "Matt Helm", "John Duff"]
+  gem.email         = ["batmanjs@shopify.com"]
+  gem.description   = %q{Quickly get started with batman.js in a Rails app. Provides generators to get started and bundles in the latest version of batman.js.}
+  gem.summary       = %q{Use batman.js with Rails}
+  gem.homepage      = "https://github.com/Shopify/batman-rails"
 
-  s.rubyforge_project = "batman-rails"
+  gem.add_dependency "railties", [">= 3.2"]
 
-  s.add_dependency "railties", ">= 3.1.0"
-  s.add_dependency "thor",     ">= 0.14"
-  s.add_development_dependency "bundler", ">= 1.0.0"
-  s.add_development_dependency "rails",   ">= 3.1.0"
-  s.add_development_dependency "mocha"
-  s.add_development_dependency "sqlite3"
+  gem.add_development_dependency "bundler"
+  gem.add_development_dependency "rails"
+  gem.add_development_dependency "mocha"
+  gem.add_development_dependency "sqlite3"
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  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/batman-rails.rb

@@ -1 +1,8 @@
-require "batman/rails"
+require "batman-rails/version"
+
+module Batman
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/batman-rails/version.rb

@@ -0,0 +1,6 @@
+module Batman
+  module Rails
+    VERSION = "0.15.0"
+    BATMAN_VERSION = "0.15.0"
+  end
+end

data/lib/generators/batman/app_generator.rb

@@ -0,0 +1,117 @@
+require 'generators/common'
+
+module Batman
+  module Generators
+    class AppGenerator < ::Rails::Generators::Base
+      include Common
+      requires_app_name
+
+      desc "This generator installs Batman.js with a default folder layout"
+
+      class_option :skip_git, :type => :boolean, :aliases => "-G", :default => false,
+                              :desc => "Skip Git ignores and keeps"
+
+      class_option :skip_jquery, :type => :boolean, :aliases => "-J", :default => false,
+                              :desc => "Skip including jQuery"
+
+      class_option :skip_es5, :type => :boolean, :default => false,
+                              :desc => "Skip including the ES5 shim"
+
+      def setup_rails
+        with_app_name do
+          template "rails/controller.rb", "app/controllers/#{app_name}_controller.rb"
+          template "rails/layout.html", "app/views/layouts/#{app_name}.html.erb"
+
+          unless ENV["RAILS_ENV"] == "test"
+            inject_into_file "config/routes.rb", :after => "#{js_application_name}::Application.routes.draw do\n"  do
+              route_catchall
+            end
+          end
+
+        end
+      end
+
+      def create_app
+        with_app_name do
+          template "batman/batman_app.coffee", "#{app_path}/#{application_name}.js.coffee"
+        end
+      end
+
+      def create_directories
+        %w(models views controllers html lib).each do |dir|
+          empty_directory "#{app_path}/#{dir}"
+          create_file "#{app_path}/#{dir}/.gitkeep" unless options[:skip_git]
+        end
+      end
+
+      def create_default_controllers
+        with_app_name do
+          empty_directory "#{app_path}/html/main"
+
+          template "batman/application_controller.coffee", "#{app_path}/controllers/application_controller.js.coffee"
+          template "batman/main_controller.coffee", "#{app_path}/controllers/main_controller.js.coffee"
+          template "batman/html/main_index.html", "#{app_path}/html/main/index.html"
+        end
+      end
+
+      def inject_batman
+        with_app_name do
+          application_file = File.join(app_path, "#{application_name}.js.coffee")
+
+          prepend_file application_file, app_requires
+          prepend_file application_file, jquery_requires unless options[:skip_jquery]
+          prepend_file application_file, batman_requires
+          prepend_file application_file, es5_requires unless options[:skip_es5]
+        end
+      end
+
+      def route_catchall
+<<-CODE
+\n  get "(*redirect_path)", to: "#{app_name}\#index", constraints: lambda { |request| request.format == "text/html" }\n
+CODE
+      end
+
+      def es5_requires
+<<-CODE
+#= require batman/es5-shim\n
+CODE
+      end
+
+      def batman_requires
+<<-CODE
+#= require batman/batman
+#= require batman/batman.rails\n
+CODE
+      end
+
+      def jquery_requires
+<<-CODE
+#= require jquery
+#= require batman/batman.jquery\n
+CODE
+      end
+
+      def app_requires
+<<-CODE
+#= require_self
+
+#= require_tree ./lib
+#= require_tree ./controllers
+#= require_tree ./models
+#= require_tree ./views\n
+CODE
+      end
+
+      private
+
+      def file_exists?(file)
+        relative_root = relative_to_original_destination_root(destination_root, false)
+        source_paths.any? do |source|
+          source_file = File.expand_path(file, File.join(source, relative_root))
+          File.exists?(source_file)
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/batman/controller_generator.rb

@@ -1,4 +1,4 @@
-require 'generators/batman/common'
+require 'generators/common'
 module Batman
   module Generators
     class ControllerGenerator < ::Rails::Generators::NamedBase
@@ -8,26 +8,17 @@ module Batman
       desc "This generator creates a Batman controller"
       argument :actions, :type => :array, :default => [], :banner => "action action"
 
-
-      RESERVED_JS_WORDS = %w{
-        break case catch continue debugger default delete do else finally for 
-        function if in instanceof new return switch this throw try typeof var void while with 
-      }
-
-      def validate_no_reserved_words
-        actions.each do |action|
-          if RESERVED_JS_WORDS.include? action
-             raise Thor::Error, "The name '#{action}' is reserved by javascript " <<
-                                "Please choose an alternative action name and run this generator again."
-          end
-        end
-      end
-
       def create_batman_controller
         with_app_name do
-          template "controller.coffee", "#{js_path}/controllers/#{plural_name.downcase}_controller.js.coffee"
+          template "batman/controller.coffee", "#{app_path}/controllers/#{file_name.downcase}_controller.js.coffee"
+          generate "batman:html #{plural_name} #{action_names} #{app_name_flag}"
+          generate "batman:view  #{plural_name} #{app_name_flag}"
         end
       end
+
+      def action_names
+        options[:actions].join(' ') if options[:actions]
+      end
     end
   end
 end

data/lib/generators/batman/html_generator.rb

@@ -0,0 +1,42 @@
+require 'generators/common'
+module Batman
+  module Generators
+    class HtmlGenerator < ::Rails::Generators::NamedBase
+      include Common
+      requires_app_name
+
+      desc "This generator creates a the HTML files needed for a Batman.Controller"
+      argument :actions, :type => :array, :default => [], :banner => "action action"
+
+
+      RESERVED_JS_WORDS = %w{
+        break case catch continue debugger default delete do else finally for
+        function if in instanceof new return switch this throw try typeof var void while with
+      }
+
+      def validate_no_reserved_words
+        actions.each do |action|
+          if RESERVED_JS_WORDS.include? action
+             raise Thor::Error, "The name '#{action}' is reserved by javascript " <<
+                                "Please choose an alternative action name and run this generator again."
+          end
+        end
+      end
+
+      def create_directory
+        with_app_name do
+          empty_directory "#{app_path}/html/#{plural_name.downcase}"
+        end
+      end
+
+      def create_files
+        with_app_name do
+          (options[:arguments] || %w(index show edit)).each do |file|
+            template "batman/html/#{file}.html", "#{app_path}/html/#{plural_name.downcase}/#{file}.html"
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/batman/model_generator.rb

@@ -1,4 +1,4 @@
-require 'generators/batman/common'
+require 'generators/common'
 module Batman
   module Generators
     class ModelGenerator < ::Rails::Generators::NamedBase
@@ -10,7 +10,7 @@ module Batman
 
       def create_batman_model
         with_app_name do
-          template "model.coffee", "#{js_path}/models/#{file_name.downcase}.js.coffee"
+          template "batman/model.coffee", "#{app_path}/models/#{singular_table_name.downcase}.js.coffee"
         end
       end