batman-rails 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+tmp/**/*

data/Gemfile

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

data/README.md

@@ -0,0 +1,73 @@
+# Batman-Rails
+
+Easily setup and use batman.js (0.6.0) with rails 3.1
+
+## Rails 3.1 setup
+This gem requires the use of rails 3.1, coffeescript and the new rails asset pipeline provided by sprockets.
+
+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
+
+In your Gemfile, add this line:
+
+    gem "batman-rails"
+  
+Then run the following commands:
+
+    bundle install
+    rails g batman:install
+
+### Layout and namespacing
+
+Running `rails g batman:install` will create the following directory structure under `app/assets/javascripts/`:
+  
+    controllers/
+    models/
+    helpers/
+    
+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).
+
+### 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.
+
+### Controllers
+    
+    rails g 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
+
+## Example Usage
+
+Created a new rails 3.1 application called `blog`.
+
+    rails new blog
+
+Edit your Gemfile and add
+
+    gem 'batman-rails'
+
+Install the gem and generate scaffolding.
+
+    bundle install
+    rails g batman:install
+    rails g 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.
+You have one last step:

data/Rakefile

@@ -0,0 +1,18 @@
+#!/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'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/batman-rails.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+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.}
+
+  s.rubyforge_project = "batman-rails"
+
+  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"
+
+  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"]
+end

data/lib/batman-rails.rb

@@ -0,0 +1 @@
+require "batman/rails"

data/lib/batman/rails.rb

@@ -0,0 +1,6 @@
+require "batman/rails/version"
+require "batman/rails/engine"
+module Batman
+  module Rails
+  end
+end

data/lib/batman/rails/engine.rb

@@ -0,0 +1,6 @@
+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.0.1"
+    BATMAN_VERSION = "0.7.0"
+  end
+end

data/lib/generators/batman/common.rb

@@ -0,0 +1,45 @@
+module Batman
+  module Generators
+    module Common
+      def self.included(base)
+        base.send(:extend, ClassMethods)
+        base.source_root File.expand_path("../templates", __FILE__)
+      end
+
+      protected
+      def with_app_name
+        raise "Batman application name must be given" unless app_name
+        yield
+      end
+
+      def js_app_name
+        app_name.camelize
+      end
+
+      def app_name
+        @app_name ||= options[:app_name] || application_name
+      end
+
+      def application_name
+        if defined?(::Rails) && ::Rails.application
+          ::Rails.application.class.name.split('::').first.underscore
+        end
+      end
+
+      def js_path
+        "app/assets/javascripts"
+      end
+
+      def singular_model_name
+        singular_name.camelize
+      end
+
+      module ClassMethods
+        def requires_app_name
+          class_option :app_name, :type => :string, :optional => true,
+                       :desc => "Name of the Batman app (defaults to the Rails app name"
+        end
+      end
+    end
+  end
+end

data/lib/generators/batman/controller_generator.rb

@@ -0,0 +1,33 @@
+require 'generators/batman/common'
+module Batman
+  module Generators
+    class ControllerGenerator < ::Rails::Generators::NamedBase
+      include Common
+      requires_app_name
+
+      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"
+        end
+      end
+    end
+  end
+end

data/lib/generators/batman/helper_generator.rb

@@ -0,0 +1,14 @@
+require 'generators/batman/common'
+module Batman
+  module Generators
+    class HelperGenerator < ::Rails::Generators::NamedBase
+      include Common
+
+      desc "This generator creates a Batman helper"
+
+      def create_batman_helper
+        template "helper.coffee", "#{js_path}/helpers/#{plural_name.downcase}_helper.js.coffee"
+      end
+    end
+  end
+end

data/lib/generators/batman/install_generator.rb

@@ -0,0 +1,58 @@
+require 'generators/batman/common'
+module Batman
+  module Generators
+    class InstallGenerator < ::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"
+
+      def create_batman_app
+        with_app_name do
+          template "batman_app.coffee", "#{js_path}/#{app_name}.js.coffee"
+        end
+      end
+
+      def create_directories
+        %w(models controllers helpers).each do |dir|
+          empty_directory "#{js_path}/#{dir}"
+          create_file "#{js_path}/#{dir}/.gitkeep" unless options[:skip_git]
+        end
+      end
+
+      def inject_batman
+        with_app_name do
+          require_tree_pattern = /\/\/=(?!.*\/\/=).*?$/m
+
+          inject_into_file "#{js_path}/application.js", :before=>require_tree_pattern do
+<<-CODE
+\n// Batman.js and its adapters
+//= require batman/batman
+//= require batman/batman.jquery
+//= require batman/batman.rails
+
+//= require #{app_name}
+
+//= require_tree ./models
+//= require_tree ./controllers
+//= require_tree ./helpers
+\n
+CODE
+          end
+
+          inject_into_file "#{js_path}/application.js", :after=>require_tree_pattern do
+<<-CODE
+\n// Run the Batman app
+$(document).ready(function(){
+  #{js_app_name}.run();
+});
+CODE
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/batman/model_generator.rb

@@ -0,0 +1,29 @@
+require 'generators/batman/common'
+module Batman
+  module Generators
+    class ModelGenerator < ::Rails::Generators::NamedBase
+      include Common
+      requires_app_name
+
+      desc "This generator creates a Batman model"
+      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+
+      def create_batman_model
+        with_app_name do
+          template "model.coffee", "#{js_path}/models/#{file_name.downcase}.js.coffee"
+        end
+      end
+
+      protected
+      def render_attribute(attribute)
+        type = case attribute.type.to_s
+        when 'date', 'datetime'
+          "Batman.Encoders.railsDate"
+        when 'string', 'integer', 'float', 'decimal', 'boolean', 'text'
+        end
+
+        ["'#{attribute.name}'", type].compact.join(', ')
+      end
+    end
+  end
+end

data/lib/generators/batman/scaffold_generator.rb

@@ -0,0 +1,19 @@
+require 'generators/batman/common'
+module Batman
+  module Generators
+    class ScaffoldGenerator < ::Rails::Generators::NamedBase
+      include Common
+      requires_app_name
+
+      desc "This generator creates the client side CRUD scaffolding"
+
+      def create_batman_model
+        with_app_name do
+          generate "batman:model #{singular_model_name} --app_name #{app_name}"
+          generate "batman:controller #{singular_model_name} index show create update destroy --app_name #{app_name}"
+          generate "batman:helper #{singular_model_name}"
+        end
+      end
+    end
+  end
+end

data/lib/generators/batman/templates/batman_app.coffee

@@ -0,0 +1,25 @@
+window.<%= js_app_name %> = class <%= js_app_name %> extends Batman.App
+
+  # @root 'controller#all'
+  # @route '/controller/:id', 'controller#show', resource: 'model', action: 'show'
+
+  @run ->
+    console.log "Running..."
+    true
+
+  @ready ->
+    console.log "<%= js_app_name %> ready for use."
+
+  @flash: Batman()
+  @flash.accessor
+    get: (key) -> @[key]
+    set: (key, value) ->
+      @[key] = value
+      if value isnt ''
+        setTimeout =>
+          @set(key, '')
+        , 2000
+      value
+
+  @flashSuccess: (message) -> @set 'flash.success', message
+  @flashError: (message) ->  @set 'flash.error', message

data/lib/generators/batman/templates/controller.coffee

@@ -0,0 +1,5 @@
+class <%= js_app_name %>.<%= plural_name.camelize %>Controller extends Batman.Controller
+<% actions.each do |action| -%>
+  <%= action %>: (params) ->
+    
+<% end -%>

data/lib/generators/batman/templates/helper.coffee

@@ -0,0 +1,5 @@
+# <%= plural_name.camelize %> helper file
+
+# Batman.mixin Batman.Filters,
+#   helper: (input) ->
+#     return input

data/lib/generators/batman/templates/model.coffee

@@ -0,0 +1,7 @@
+class <%= js_app_name %>.<%= singular_model_name %> extends Batman.Model
+  @storageKey: '<%= plural_name %>'
+  @persist Batman.RailsStorage
+
+<% attributes.each do |attribute| -%>
+  @encode <%= render_attribute(attribute) %>
+<% end -%>

data/test/controller_generator_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+require 'generators/batman/controller_generator'
+
+class ControllerGeneratorTest < Rails::Generators::TestCase
+  tests Batman::Generators::ControllerGenerator
+  
+  test "simple controller" do
+    run_generator %w(Task index show)
+    
+    assert_file "#{javascripts_path}/controllers/tasks_controller.js.coffee" do |controller|
+      controller_class = Regexp.escape("class Sample.TasksController extends Batman.Controller")
+      
+      assert_match /#{controller_class}/, controller
+      assert_match %r{  index: \(params\) ->}, controller
+      assert_match %r{  show: \(params\) ->}, controller
+    end
+  end
+  
+  test "two word controller is camelcased" do
+    run_generator %w(RegularUser index)
+    
+    assert_file "#{javascripts_path}/controllers/regular_users_controller.js.coffee" do |controller|
+      controller_class = Regexp.escape("class Sample.RegularUsersController extends Batman.Controller")
+      
+      assert_match /#{controller_class}/, controller
+      assert_match %r{  index: \(params\) ->}, controller
+    end
+  end
+  
+  test "simple controller with app_name" do
+    run_generator %w(Task index --app_name MyApp)
+    
+    assert_file "#{javascripts_path}/controllers/tasks_controller.js.coffee" do |controller|
+      controller_class = Regexp.escape("class MyApp.TasksController extends Batman.Controller")
+      
+      assert_match /#{controller_class}/, controller
+      assert_match %r{  index: \(params\) ->}, controller
+    end
+  end
+end