requirejs-rails 0.0.2 → 0.5.0

data/lib/requirejs/error.rb

@@ -0,0 +1,4 @@
+module Requirejs
+  # Raised if requirejs_include_tag appears multiple times on a page.
+  class MultipleIncludeError < RuntimeError; end
+end

data/lib/requirejs/rails/builder.rb

@@ -0,0 +1,29 @@
+require 'requirejs/rails'
+
+require 'pathname'
+require 'ostruct'
+
+module Requirejs::Rails
+  class Builder
+    # config should be an instance of Requirejs::Rails::Config
+    
+    def initialize(config)
+      @config = config
+    end
+    
+    def build      
+      @config.tmp_dir
+    end
+
+    def digest_for(path)
+      Rails.application.assets.file_digest(path).hexdigest
+    end
+
+    def generate_rjs_driver
+      templ = Erubis::Eruby.new(@config.driver_template_path.read)
+      @config.driver_path.open('w') do |f|
+        f.write(templ.result(@config.get_binding))
+      end
+    end
+  end
+end

data/lib/requirejs/rails/config.rb

@@ -0,0 +1,52 @@
+require 'requirejs/rails'
+
+require 'active_support/ordered_options'
+require 'erubis'
+require 'pathname'
+
+module Requirejs::Rails
+  class Config < ::ActiveSupport::OrderedOptions
+
+    def initialize(app=Rails.application)
+      super
+      self.manifest = nil
+
+      self.tmp_dir = Rails.root + 'tmp'
+      self.bin_dir = Pathname.new(__FILE__+'/../../../../bin').cleanpath
+
+      self.source_dir = self.tmp_dir + 'assets'
+      self.target_dir = Rails.root + 'public/assets'
+      self.rjs_path   = self.bin_dir+'r.js'
+
+      self.driver_template_path = Pathname.new(__FILE__+'/../rjs_driver.js.erb').cleanpath
+      self.driver_path = self.tmp_dir + 'rjs_driver.js'
+
+      # The user-supplied config parameters, to be merged with the default params.
+      # This file must contain a single JavaScript object.
+      self.user_config_file = Pathname.new(app.paths["config"].first)+'requirejs.yml'
+      if self.user_config_file.exist?
+        self.user_config = YAML.load(self.user_config_file.read)
+      else
+        self.user_config = {}
+      end
+
+      self.run_config = {
+        "baseUrl" => "/assets",
+        "modules" => [ { name: 'application' } ]
+      }
+      self.run_config.merge!(self.user_config)
+      self.run_config_json = self.run_config.to_json
+
+      self.build_config = self.run_config.merge "baseUrl" => source_dir.to_s
+      self.build_config.merge!(self.user_config)
+    end
+
+    def module_path_for(name)
+      self.target_dir+(name+'.js')
+    end
+    
+    def get_binding
+      return binding()
+    end    
+  end
+end

data/lib/requirejs/rails/engine.rb

@@ -1,6 +1,44 @@
+require 'requirejs/rails/config'
+
+require 'pathname'
+
 module Requirejs
   module Rails
     class Engine < ::Rails::Engine
-    end
+
+      initializer "requirejs.tag_included_state" do |app|
+        ActiveSupport.on_load(:action_controller) do
+          ::ActionController::Base.class_eval do
+            attr_accessor :requirejs_included
+          end
+        end
+      end
+
+      initializer "requirejs.config" do |app|
+        config = app.config
+        config.requirejs = Requirejs::Rails::Config.new(app)
+        if config.requirejs.manifest
+          path = File.join(config.assets.manifest, "rjs_manifest.yml")
+        else
+          path = File.join(::Rails.public_path, config.assets.prefix, "rjs_manifest.yml")
+        end
+        config.requirejs.manifest_path = Pathname.new(path)
+        
+        config.requirejs.precompile = [/require\.js$/]
+
+        if ::Rails.env == "production"
+          config.assets.precompile += config.requirejs.precompile
+        end
+      end
+      
+      initializer "requirejs.manifest", :after => "sprockets.environment" do |app|
+        config = app.config
+        if config.requirejs.manifest_path.exist? && config.assets.digests
+          rjs_digests = YAML.load_file(config.requirejs.manifest_path)
+          config.assets.digests.merge!(rjs_digests)
+        end
+      end
+      
+    end # class Engine
   end
 end

data/lib/requirejs/rails/rjs_driver.js.erb

@@ -0,0 +1,40 @@
+//Load the requirejs optimizer
+var requirejs = require('<%= rjs_path %>'),
+    //Set up basic config, include config that is
+    //common to all the optimize() calls.
+    basConfig = <%= JSON.pretty_generate(build_config) %>;
+
+// Function used to mix in baseConfig to a new config target
+function mix(target) {
+    for (var prop in basConfig) {
+        if (basConfig.hasOwnProperty(prop)) {
+            target[prop] = basConfig[prop];
+        }
+    }
+    return target;
+}
+
+var module_specs = [
+<% build_config['modules'].each do |m| %>
+  {
+    name: "<%= m['name'] %>",
+		<% if m['includes'] %>
+    include: [<%= m['includes'].map {|i| "'#{i}'" }.join(", ") %>],
+		<% end %>
+    out: '<%= module_path_for m['name'] %>'
+  },
+<% end %>
+];
+
+// Do a series of builds of individual files, using the args suggested by:
+// http://requirejs.org/docs/optimization.html#onejs
+//
+// r.js will eventually need a nested call idiom to handle async 
+// builds.  Anticipating that need.
+var async_runner = module_specs.reduceRight(function(prev, curr) {
+  return function (buildReportText) { 
+    requirejs.optimize(mix(curr), prev);
+  };
+}, function(buildReportText) {} );
+
+async_runner();

data/lib/requirejs/rails/version.rb

@@ -1,5 +1,5 @@
 module Requirejs
   module Rails
-    VERSION = "0.0.2"
+    VERSION = "0.5.0"
   end
 end

data/lib/tasks/requirejs-rails_tasks.rake

@@ -1,4 +1,193 @@
-# desc "Explaining what the task does"
-# task :requirejs-rails do
-#   # Task goes here
-# end
+require 'requirejs/rails/builder'
+require 'requirejs/rails/config'
+
+require 'fileutils'
+require 'pathname'
+require 'sprockets/digest'
+require 'tempfile'
+
+require 'active_support/ordered_options'
+
+# Prevent Sprockets::Bootstrap from making the environment immutable,
+# as we need to manipulate the environment paths before the asset build.
+#
+# Without this, task requirejs:assets:purge_js throws an exception from 
+# Sprockets::Index#expire_index!, which is in response to any mutating
+# method call.
+#
+if Rails.env == "production"
+  require 'sprockets/bootstrap'
+  module ::Sprockets
+    class Bootstrap
+      alias_method :orig_run, :run
+      def run(*args)
+        config = @app.config
+        saved_config_assets_digest = config.assets.digest
+        begin
+          config.assets.digest = false
+          orig_run(*args)
+        ensure
+          config.assets.digest = saved_config_assets_digest
+        end
+      end
+    end
+  end
+end
+
+namespace :requirejs do
+  
+  # From Rails 3 assets.rake; we have the same problem:
+  #
+  # We are currently running with no explicit bundler group
+  # and/or no explicit environment - we have to reinvoke rake to
+  # execute this task.
+  def invoke_or_reboot_rake_task(task)
+    if ENV['RAILS_GROUPS'].to_s.empty? || ENV['RAILS_ENV'].to_s.empty?
+      ruby_rake_task task
+    else
+      Rake::Task[task].invoke
+    end
+  end
+  
+  class String
+    def unindent
+      gsub /^#{self[/\A\s*/]}/, ''
+    end
+  end
+  
+  requirejs = ActiveSupport::OrderedOptions.new
+  
+  task :clean => ["requirejs:setup"] do
+    FileUtils.remove_entry_secure(requirejs.config.source_dir, true)
+    FileUtils.remove_entry_secure(requirejs.driver_path, true)
+  end
+
+  task :setup => ["environment"] do
+    unless Rails.application.config.assets.enabled
+      warn "Cannot precompile assets if sprockets is disabled. Please set config.assets.enabled to true"
+      exit
+    end
+    
+    # Ensure that action view is loaded and the appropriate
+    # sprockets hooks get executed
+    _ = ActionView::Base
+
+    requirejs.env = Rails.application.assets
+    # Preserve the original asset paths, as we'll be manipulating them later
+    requirejs.env_paths = requirejs.env.paths.dup
+    requirejs.config = Rails.application.config.requirejs
+    requirejs.builder = Requirejs::Rails::Builder.new(requirejs.config)
+    requirejs.manifest = {}
+  end
+  
+  task :test_node do
+    begin
+      `node -v`
+    rescue Errno::ENOENT
+      STDERR.puts <<-EOM
+Unable to find 'node' on the current path, required for precompilation
+using the requirejs-ruby gem. To install node.js, see http://nodejs.org/
+OS X Homebrew users can use 'brew install node'.
+EOM
+      exit 1
+    end
+  end
+  
+  namespace :precompile do
+    # stage1 must NOT be run in the production environment
+    #
+    # Depend on test_node first here so we'll fail early and hard if 
+    # node isn't available.
+    task :stage1 => ["requirejs:test_node",
+                     "requirejs:precompile:prepare_source",
+                     "requirejs:precompile:generate_rjs_driver",
+                     "requirejs:precompile:run_rjs"]
+    task :stage2 => ["requirejs:precompile:digestify_and_compress"]
+    
+    # Copy all assets to tmp/assets
+    task :prepare_source => ["requirejs:setup", 
+                             "requirejs:clean", 
+                             "requirejs:assets:keep_js"] do
+      requirejs.config.source_dir.mkpath
+      requirejs.env.each_logical_path do |logical_path|
+        if asset = requirejs.env.find_asset(logical_path)
+          filename = requirejs.config.source_dir + asset.logical_path
+          filename.dirname.mkpath
+          
+          asset.write_to(filename)
+        end
+      end
+    end
+    
+    task :generate_rjs_driver => ["requirejs:setup"] do
+      requirejs.builder.generate_rjs_driver
+    end
+
+    task :run_rjs => ["requirejs:setup", 
+                      "requirejs:test_node"] do
+      requirejs.config.target_dir.mkpath
+
+      `node #{requirejs.config.driver_path}`
+      unless $?.success?
+        raise RuntimeError, "Asset compilation with node failed."
+      end
+    end
+    
+    # Copy each built asset, identified by a named module in the 
+    # build config, to its Sprockets digestified name.
+    task :digestify_and_compress => ["requirejs:setup"] do
+      requirejs.config.build_config['modules'].each do |m|
+        asset_name = "#{m['name']}.js"
+        built_asset_path = requirejs.config.target_dir + asset_name
+        digest_name = asset_name.sub(/\.(\w+)$/) { |ext| "-#{requirejs.builder.digest_for(built_asset_path)}#{ext}" }
+        digest_asset_path = requirejs.config.target_dir + digest_name
+        requirejs.manifest[asset_name] = digest_name
+        FileUtils.cp built_asset_path, digest_asset_path
+
+        # Create the compressed versions
+        File.open("#{built_asset_path}.gz",'wb') do |f|
+          zgw = Zlib::GzipWriter.new(f, Zlib::BEST_COMPRESSION)
+          zgw.write built_asset_path.read
+          zgw.close
+        end
+        FileUtils.cp "#{built_asset_path}.gz", "#{digest_asset_path}.gz"
+
+        requirejs.config.manifest_path.open('wb') do |f|
+          YAML.dump(requirejs.manifest,f)
+        end
+      end    
+    end
+  end
+
+  desc "Precompile RequireJS-managed assets"
+  task :precompile do
+    invoke_or_reboot_rake_task "requirejs:precompile:all"
+  end
+
+  # We remove all .js assets from the Rails Asset Pipeline when 
+  # precompiling, as those are handled by r.js. Conversely, r.js 
+  # only sees .js assets. For now, this is by path convention; any
+  # asset path ending in "javascript". If you've got javascripts in 
+  # your stylesheets directory, then heaven help you. You've got bigger
+  # problems.
+  namespace :assets do
+    # Purge all ".../javascripts" directories from the asset paths
+    task :purge_js => ["requirejs:setup"] do
+      new_paths = requirejs.env_paths.dup.delete_if { |p| p =~ /javascripts$/ && p !~ /requirejs-rails/ }
+      requirejs.env.clear_paths
+      new_paths.each { |p| requirejs.env.append_path(p) }
+    end
+    
+    # Preserve only ".../javascripts" directories
+    task :keep_js => ["requirejs:setup"] do
+      new_paths = requirejs.env_paths.dup.keep_if { |p| p =~ /javascripts$/ }
+      requirejs.env.clear_paths
+      new_paths.each { |p| requirejs.env.append_path(p) }
+    end
+  end
+end
+
+task "assets:precompile:primary" => ["requirejs:precompile:stage2", 
+                                     "requirejs:assets:purge_js"]
+task "assets:precompile:nondigest" => ["requirejs:assets:purge_js"]
+task "assets:precompile" => ["requirejs:precompile:stage1"]

data/requirejs-rails.gemspec

@@ -22,5 +22,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rails", "~> 3.1.1"
   s.add_development_dependency "sqlite3"
 
+  s.requirements << "node.js is required for 'rake assets:precompile', used to run the r.js build"
   s.requirements << "If needed, jQuery should be v1.7 or greater (jquery-rails >= 1.0.17)."
 end

data/test/requirejs-rails_test.rb

@@ -16,3 +16,32 @@ class RequirejsRailsTest < ActiveSupport::TestCase
     assert_equal "1.0.2", context.eval("require.version")
   end
 end
+
+class RequirejsHelperTest < ActionView::TestCase
+  
+  def setup
+    controller.requirejs_included = false
+  end
+  
+  def wrap(tag)
+    "<html><head>#{tag}</head></html>"
+  end
+  
+  test "requirejs_include_tag" do
+    render :text => wrap(requirejs_include_tag)
+    assert_select "script:first-of-type", :text => /var require =/
+    assert_select "script:last-of-type[src^=/javascripts/require.js]", :count => 1
+  end
+  
+  test "requirejs_include_tag_with_param" do
+    render :text => wrap(requirejs_include_tag("application"))
+    assert_select "script:nth-of-type(2)[src^=/javascripts/require.js]", :count => 1
+    assert_select "script:last-of-type[src^=/javascripts/application.js]", :count => 1
+  end
+  
+  test "requirejs_include_tag can appear only once" do
+    assert_raises Requirejs::MultipleIncludeError do
+      render :text => "#{requirejs_include_tag}\n#{requirejs_include_tag}"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: requirejs-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-22 00:00:00.000000000 Z
+date: 2011-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
-  requirement: &70199933410040 !ruby/object:Gem::Requirement
+  requirement: &70099873431600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 3.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *70199933410040
+  version_requirements: *70099873431600
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70199933409200 !ruby/object:Gem::Requirement
+  requirement: &70099873416040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 3.1.1
   type: :development
   prerelease: false
-  version_requirements: *70199933409200
+  version_requirements: *70099873416040
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70199933408160 !ruby/object:Gem::Requirement
+  requirement: &70099873414400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70199933408160
+  version_requirements: *70099873414400
 description: This gem provides RequireJS support for your Rails 3 application.
 email:
 - whitley@bangpath.org
@@ -59,9 +59,15 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/helpers/requirejs_helper.rb
+- bin/r.js
 - lib/requirejs-rails.rb
+- lib/requirejs/error.rb
 - lib/requirejs/rails.rb
+- lib/requirejs/rails/builder.rb
+- lib/requirejs/rails/config.rb
 - lib/requirejs/rails/engine.rb
+- lib/requirejs/rails/rjs_driver.js.erb
 - lib/requirejs/rails/version.rb
 - lib/tasks/requirejs-rails_tasks.rake
 - requirejs-rails.gemspec
@@ -92,6 +98,7 @@ files:
 - test/dummy/config/initializers/wrap_parameters.rb
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
+- test/dummy/db/.gitkeep
 - test/dummy/lib/assets/.gitkeep
 - test/dummy/log/.gitkeep
 - test/dummy/public/404.html
@@ -115,7 +122,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2678184901028172103
+      hash: 3746544673108118455
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -124,8 +131,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2678184901028172103
+      hash: 3746544673108118455
 requirements:
+- node.js is required for 'rake assets:precompile', used to run the r.js build
 - If needed, jQuery should be v1.7 or greater (jquery-rails >= 1.0.17).
 rubyforge_project: 
 rubygems_version: 1.8.10
@@ -158,6 +166,7 @@ test_files:
 - test/dummy/config/initializers/wrap_parameters.rb
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
+- test/dummy/db/.gitkeep
 - test/dummy/lib/assets/.gitkeep
 - test/dummy/log/.gitkeep
 - test/dummy/public/404.html