ember-rails 0.2.4 → 0.3.1

data/README.md

@@ -1,10 +1,10 @@
-# ember-rails  [![Build Status](https://secure.travis-ci.org/keithpitt/ember-rails.png)](http://travis-ci.org/keithpitt/ember-rails)
+# ember-rails  [![Build Status](https://secure.travis-ci.org/keithpitt/ember-rails.png)](http://travis-ci.org/keithpitt/ember-rails) [![Dependency Status](https://gemnasium.com/emberjs/ember-rails.png)](https://gemnasium.com/emberjs/ember-rails)
 
-ember-rails allows you to include [Ember.JS](http://emberjs.com/) into your Rails 3.x application.
+ember-rails allows you to include [Ember.JS](http://emberjs.com/) into your Rails 3.1+ application.
 
 The gem will also pre-compile your handlebars templates when building your asset pipeline. It includes development and production copies of Ember.
 
-You can see an example of how to use the gem [here](https://github.com/keithpitt/ember-rails-example)
+You can see an example of how to use the gem [here](https://github.com/keithpitt/ember-rails-example). There is also a great tutorial by [Dan Gebhardt](https://twitter.com/#!/dgeb) called "[Beginning Ember.js on Rails](http://www.cerebris.com/blog/2012/01/24/beginning-ember-js-on-rails-part-1/)" which is a great read if your just starting out with Rails and Ember.js
 
 ## Getting started
 
@@ -12,23 +12,81 @@ Add the gem to your application Gemfile:
 
     gem "ember-rails"
 
-Run `bundle install` and add the following line to 
-`app/assets/javascripts/application.js`:
+Run `bundle install` and add the following line to `app/assets/javascripts/application.js`:
 
     //= require ember
 
 Ember-rails also provides a way to run Ember in development mode, you
-can switch out your require statements to use the dev copies like so:
+can switch out your require statement `//= require ember` to use the
+dev copies like so:
 
     //= require ember-dev
 
+## Architecture
+
+Ember does not require an organized file structure. However, ember-rails allows you 
+to use `rails g ember:bootstrap` to create the following directory structure under `app/assets/javascripts/ember`:
+
+    controllers/
+    helpers/
+    models/
+    templates/
+    views/
+
+Additionally, it will add the following lines to `app/assets/javascripts/application.js`.
+By default, it uses the Rails Application's name and creates an `rails_app_name.js.coffee` 
+file to setup application namespace and initial requires:
+
+    //= require ember
+    //= require ember/app
+
+*Example:*
+
+    rails g ember:bootstrap
+      insert  app/assets/javascripts/application.js
+      create  app/assets/javascripts/ember/models
+      create  app/assets/javascripts/ember/models/.gitkeep
+      create  app/assets/javascripts/ember/controllers
+      create  app/assets/javascripts/ember/controllers/.gitkeep
+      create  app/assets/javascripts/ember/views
+      create  app/assets/javascripts/ember/views/.gitkeep
+      create  app/assets/javascripts/ember/helpers
+      create  app/assets/javascripts/ember/helpers/.gitkeep
+      create  app/assets/javascripts/ember/templates
+      create  app/assets/javascripts/ember/templates/.gitkeep
+      create  app/assets/javascripts/ember/app.js.coffee
+
+If you want to avoid `.gitkeep` files, use the `skip git` option like
+this: `rails g ember:bootstrap -g`.
+
 Ask Rails to serve HandlebarsJS and pre-compile templates to Ember
-by putting each template in a dedicated ".js.hjs" or ".handlebars" file
+by putting each template in a dedicated ".js.hjs", ".hbs" or ".handlebars" file
 (e.g. `app/assets/javascripts/templates/admin_panel.handlebars`)
 and including the assets in your layout:
 
     <%= javascript_include_tag "templates/admin_panel" %>
 
+If you want to strip template root from template names, add `templates_root` option to your application configuration block :
+
+    config.handlebars.templates_root = 'templates'
+
+The result will be like this :
+
+    Ember.TEMPLATES['admin_panel'] = "...";
+
+If you want a different path separator in template names add `templates_path_separator` option to your application configuration block :
+
+    config.handlebars.templates_path_separator = '-'
+
+The result will be like this :
+
+    Ember.TEMPLATES['templates-admin_panel'] = "...";
+
+Default behavior for ember-rails is to precompile handlebars templates only in production environment.
+If you don't want this behavior you can turn it off in your application configuration block :
+
+    config.handlebars.precompile = false
+
 Bundle all templates together thanks to Sprockets,
 e.g create `app/assets/javascripts/templates/all.js` with:
 
@@ -38,6 +96,17 @@ Now a single line in the layout loads everything:
 
     <%= javascript_include_tag "templates/all" %>
 
+If you use Slim or Haml templates, you can use handlebars filter :
+
+    handlebars:
+        {{view Ember.Button}}OK{{/view}}
+
+It will be translated as :
+
+    <script type="text/x-handlebars">
+        {{view Ember.Button}}OK{{/view}}
+    </script>
+
 ## Note on Patches/Pull Requests
 
 1. Fork the project.

data/lib/ember-rails.rb

@@ -1,14 +1 @@
-require 'sprockets'
-require 'sprockets/engines'
-require 'ember-rails/hjs_template'
-
-module EmberRails
-  class Engine < Rails::Engine
-  end
-
-  # Registers the HandlebarsJS template engine so that
-  # an asset file having the extension ".hjs" is processed
-  # by the asset pipeline and converted to javascript code.
-  Sprockets.register_engine '.hjs', HjsTemplate
-  Sprockets.register_engine '.handlebars', HjsTemplate
-end
+require 'ember_rails'

data/lib/ember/filters/haml.rb

@@ -0,0 +1,11 @@
+module Haml
+  module Filters
+    module Handlebars
+      include Base
+      def render_with_options(text, options)
+        type = "type=#{options[:attr_wrapper]}text/x-handlebars#{options[:attr_wrapper]}"
+        "<script #{type}>\n#{text.rstrip}\n</script>"
+      end
+    end
+  end
+end

data/lib/ember/filters/slim.rb

@@ -0,0 +1,5 @@
+module Slim
+  class EmbeddedEngine
+    register :handlebars, TagEngine, :tag => :script, :attributes => { :type => 'text/x-handlebars' }
+  end
+end

data/{vendor/assets/javascripts → lib/ember/handlebars/assets}/ember-precompiler.js

@@ -15,7 +15,7 @@ console.log = console.info = console.warn = console.error = function(){};
 var jQuery = window.jQuery = function() { return jQuery };
 jQuery.ready = function() { return jQuery };
 jQuery.inArray = function() { return jQuery };
-jQuery.jquery = "1.7.1";
+jQuery.jquery = "1.7.2";
 var $ = jQuery;
 
 // Precompiler

data/lib/ember/handlebars/source.rb

@@ -0,0 +1,48 @@
+require 'execjs'
+
+module Ember
+  module Handlebars
+    class Source
+      class << self
+        def precompiler_path
+          File.expand_path(File.join(__FILE__, '../assets/ember-precompiler.js'))
+        end
+
+        def vendor_path
+          path = ::Rails.root.nil? ? '' : ::Rails.root.join('vendor/assets/javascripts/ember.js')
+
+          if !File.exists?(path)
+            path = File.expand_path(File.join(__FILE__, '../../../../vendor/assets/javascripts/ember.js'))
+          end
+        end
+
+        def path
+          @path ||= ENV['EMBER_SOURCE_PATH'] || vendor_path
+        end
+
+        def contents
+          @contents ||= [File.read(precompiler_path), File.read(path)].join("\n")
+        end
+
+        def handlebars_version
+          @handlebars_version ||= contents[/^Handlebars.VERSION = "([^"]*)"/, 1]
+        end
+
+        def ember_version
+          @ember_version ||= contents[/^Ember.VERSION = '([^']*)'/, 1]
+        end
+
+        def context
+          @context ||= ExecJS.compile(contents)
+        end
+      end
+    end
+
+    class << self
+      def compile(template)
+        template = template.read if template.respond_to?(:read)
+        Source.context.call('EmberRails.precompile', template)
+      end
+    end
+  end
+end

data/lib/ember/handlebars/template.rb

@@ -0,0 +1,54 @@
+require 'ember/handlebars/source'
+
+module Ember
+  module Handlebars
+    class Template < Tilt::Template
+      def self.default_mime_type
+        'application/javascript'
+      end
+
+      def prepare; end
+
+      def evaluate(scope, locals, &block)
+        template = mustache_to_handlebars(scope, data)
+
+        if configuration.precompile
+          func = Ember::Handlebars.compile(template)
+          "Ember.TEMPLATES[#{template_path(scope.logical_path).inspect}] = Ember.Handlebars.template(#{func});\n"
+        else
+          "Ember.TEMPLATES[#{template_path(scope.logical_path).inspect}] = Ember.Handlebars.compile(#{indent(template).inspect});\n"
+        end
+      end
+
+      private
+
+      def mustache_to_handlebars(scope, template)
+        if scope.pathname.to_s =~ /\.mustache\.(handlebars|hjs)/
+          template.gsub(/\{\{(\w[^\}\}]+)\}\}/){ |x| "{{unbound #{$1}}}" }
+        else
+          template
+        end
+      end
+
+      def template_path(path)
+        root = configuration.templates_root
+
+        unless root.blank?
+          path.gsub!(/^#{Regexp.quote(root)}\/?/, '')
+        end
+
+        path = path.split('/')
+
+        path.join(configuration.templates_path_separator)
+      end
+
+      def configuration
+        ::Rails.configuration.handlebars
+      end
+
+      def indent(string)
+        string.gsub(/$(.)/m, "\\1  ").strip
+      end
+    end
+  end
+end

data/lib/ember/handlebars/version.rb

@@ -0,0 +1,7 @@
+require 'ember/handlebars/source'
+
+module Ember
+  module Handlebars
+    VERSION = Ember::Handlebars::Source.handlebars_version
+  end
+end

data/lib/ember/rails/engine.rb

@@ -0,0 +1,18 @@
+require 'ember/handlebars/template'
+
+module Ember
+  module Rails
+    class Engine < ::Rails::Engine
+      config.handlebars = ActiveSupport::OrderedOptions.new
+      config.handlebars.precompile = ::Rails.env.production?
+      config.handlebars.templates_root = nil
+      config.handlebars.templates_path_separator = '/'
+
+      initializer :setup_ember_rails, :group => :all do |app|
+        app.assets.register_engine '.handlebars', Ember::Handlebars::Template
+        app.assets.register_engine '.hbs', Ember::Handlebars::Template
+        app.assets.register_engine '.hjs', Ember::Handlebars::Template
+      end
+    end
+  end
+end

data/lib/ember/rails/version.rb

@@ -0,0 +1,5 @@
+module Ember
+  module Rails
+    VERSION = '0.3.1'
+  end
+end

data/lib/ember/version.rb

@@ -0,0 +1,5 @@
+require 'ember/handlebars/source'
+
+module Ember
+  VERSION = Ember::Handlebars::Source.ember_version
+end

data/lib/ember_rails.rb

@@ -0,0 +1,10 @@
+require 'sprockets'
+require 'sprockets/engines'
+
+require 'ember/rails/engine'
+
+require 'ember/version'
+require 'ember/handlebars/version'
+
+require 'ember/filters/slim' if defined? Slim
+require 'ember/filters/haml' if defined? Haml

data/lib/generators/ember/bootstrap_generator.rb

@@ -0,0 +1,39 @@
+require 'generators/ember/generator_helpers'
+
+module Ember
+  module Generators
+    class BootstrapGenerator < ::Rails::Generators::Base
+      include Ember::Generators::GeneratorHelpers
+
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates a default Ember.js folder layout in app/assets/javascripts/ember"
+
+      class_option :skip_git, :type => :boolean, :aliases => "-g", :default => false, :desc => "Skip Git keeps"
+
+      def inject_ember
+        application_file = "app/assets/javascripts/application.js"
+        if File.exists? application_file
+          inject_into_file(application_file, :before => "//= require_tree") do
+            dependencies = [
+              "//= require ember",
+              "//= require ember/#{application_name.underscore}"
+            ]
+            dependencies.join("\n").concat("\n")
+          end
+        end
+      end
+
+      def create_dir_layout
+        %W{models controllers views helpers templates}.each do |dir|
+          empty_directory "#{ember_path}/#{dir}"
+          create_file "#{ember_path}/#{dir}/.gitkeep" unless options[:skip_git]
+        end
+      end
+
+      def create_app_file
+        template "app.js", "#{ember_path}/#{application_name.underscore}.js"
+      end
+    end
+  end
+end

data/lib/generators/ember/controller_generator.rb

@@ -0,0 +1,21 @@
+require 'ember/version'
+
+module Ember
+  module Generators
+    class ControllerGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("../../templates", __FILE__)
+    
+      desc "Creates a new Ember.js controller"
+      class_option :array, :type => :boolean, :default => false, :desc => "Create an Ember.ArrayController to represent multiple objects"
+      
+      def create_controller_files
+        file_path = File.join('app/assets/javascripts/ember/controllers', class_path, "#{file_name}_controller.js")
+        if options.array?
+          template 'array_controller.js', file_path
+        else
+          template 'controller.js', file_path
+        end
+      end
+    end
+  end
+end

data/lib/generators/ember/generator_helpers.rb

@@ -0,0 +1,19 @@
+module Ember
+  module Generators
+    module GeneratorHelpers
+
+      def ember_path
+        "app/assets/javascripts/ember"
+      end
+
+      def application_name
+        if defined?(::Rails) && ::Rails.application
+          ::Rails.application.class.name.split('::').first
+        else
+          "app"
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/ember/install_generator.rb

@@ -0,0 +1,92 @@
+require 'ember/version'
+
+module Ember
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+
+      EMBER_FILES = [ "ember.js", "ember-dev.js" ]
+      RUNTIME_FILES = [ "ember-runtime.js", "ember-runtime-dev.js" ]
+      ALL_FILES = [ *EMBER_FILES, *RUNTIME_FILES ]
+
+      desc "Install Ember.js into your vendor folder"
+      class_option :head, :type => :boolean, :default => false, :desc => "Download latest Ember.js from GitHub and copy it into your project"
+      class_option :runtime, :type => :boolean, :default => false, :desc => "Include the Ember.js runtime only"
+
+      def remove_ember
+        ALL_FILES.each do |name|
+          file = "vendor/assets/javascripts/#{name}"
+          remove_file file if File.exist?(file)
+        end
+      end
+
+      def copy_ember
+        if options.head?
+
+          git_root = File.expand_path "~/.ember"
+          gem_file = File.join git_root, "Gemfile"
+
+          # If it doesn't exist yet
+          unless File.exist?(git_root)
+            command = %{git clone git://github.com/emberjs/ember.js.git "#{git_root}"}
+            say_status("downloading", command, :green)
+
+            cmd command
+          else
+            Dir.chdir git_root do
+              command = "git fetch --force --quiet --tags && git reset HEAD --hard"
+              say_status("updating", command, :green)
+
+              cmd command
+            end
+          end
+
+          Dir.chdir git_root do
+            say_status("building", "bundle && bundle exec rake", :green)
+            Bundler.with_clean_env do
+              cmd "bundle --gemfile #{gem_file}"
+              cmd %{BUNDLE_GEMFILE="#{gem_file}" bundle exec rake}
+            end
+          end
+
+          self.class.source_root File.join(git_root, "dist")
+
+          ember_files.each do |name|
+            source_file = if name.match /-dev/
+              name.gsub /-dev/, '.debug'
+            else
+              name.gsub /.js/, '.prod.js'
+            end
+
+            copy_file source_file, "vendor/assets/javascripts/#{name}"
+          end
+
+        else
+
+          self.class.source_root File.expand_path('../../../../../vendor/assets/javascripts', __FILE__)
+          say_status("copying", "Ember.js (#{Ember::VERSION})", :green)
+
+          ember_files.each do |name|
+            copy_file name, "vendor/assets/javascripts/#{name}"
+          end
+
+        end
+      end
+
+      private
+
+      def ember_files
+        options.runtime? ? RUNTIME_FILES : EMBER_FILES
+      end
+
+      def cmd(command)
+        out = `#{command}`
+
+        if $?.exitstatus != 0
+          raise "Command error: command `#{command}` in directory #{Dir.pwd} has failed."
+        end
+        out
+      end
+
+    end
+  end
+end