requirejs-rails 0.7.3 → 0.8.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# v0.8.0
+
+- Build will now substitute `empty:` for the right-hand side of
+  `config/requirejs.yml` paths entries that are URLs.
+- Documented how to configure assets hosted on a CDN.
+
 # v0.7.3
 
 - Upgrade RequireJS and r.js to v1.0.8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    requirejs-rails (0.7.3)
+    requirejs-rails (0.8.0)
       railties (>= 3.1.1, < 3.3)
 
 GEM

data/README.md

@@ -186,9 +186,51 @@ This will generate a script tag like so:
 <script data-main="/assets/page1.js" data-foo="..." data-bar="..." src="/assets/require.js"></script>
 ```
 
+### External domain (CDN) support
+
+There are two ways in which requirejs-rails supports the use of different
+domains for serving built JavaScript modules, as is the case when using
+a [CDN](http://en.wikipedia.org/wiki/Content_delivery_network).
+
+1.  URLs in paths config in `requirejs.yml`:
+
+    If requirejs-rails encounters an URL as the right-hand side of a paths
+    configuration, it will correctly emit that as `"empty:"` during the build
+    process so that [r.js will do the right thing](http://requirejs.org/docs/optimization.html#empty).
+
+    Example:
+
+    ```yaml
+    paths:
+      jquery: "https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js"
+    ```
+
+2.  Deploying all requirejs-rails assets to a CDN:
+
+    In `config/environments/production.rb` (or another environment)
+    set the run_config as follows:
+
+    ```ruby
+    config.requirejs.run_config['baseUrl'] = 'http://mycdn.example.com/12345abc/assets'
+    ```
+
+    The [`asset_sync` gem](https://github.com/rumblelabs/asset_sync) is one
+    tool that can be used to deploy your built assets to a CDN (S3, in this
+    case).
+
+## Troubleshooting
+
+### Avoid `config.assets.precompile`
+
+Don't set `config.assets.precompile` to reference any of your AMD module code.
+Avoid it altogether, except to reference non-AMD code that you're loading via
+javascript_include_tag, and which is **never** referenced by the AMD codebase.
+
 ## Using AMD libraries
 
-I currently recommend placing your AMD libraries into `vendor/assets/javascripts`.  The needs of a few specific libraries are discussed below.
+I currently recommend placing your AMD libraries into
+`vendor/assets/javascripts`.  The needs of a few specific libraries are
+discussed below.
 
 ### jQuery
 

data/app/helpers/requirejs_helper.rb

@@ -1,11 +1,17 @@
 require 'requirejs/error'
 
 module RequirejsHelper
+  # EXPERIMENTAL: Additional priority settings appended to
+  # any user-specified priority setting by requirejs_include_tag.
+  # Used for JS test suite integration.
+  mattr_accessor :_priority
+  @@_priority = []
+
   def _requirejs_data(name, &block)
     {}.tap do |data|
       if name
         name += ".js" unless name =~ /\.js$/
-        data['main'] = javascript_path(name)
+        data['main'] = _javascript_path(name)
       end
 
       data.merge!(yield controller) if block_given?
@@ -17,7 +23,7 @@ module RequirejsHelper
   def _data_main(name)
     if name
       name += ".js" unless name =~ /\.js$/
-      %Q{data-main="#{javascript_path(name)}"}
+      %Q{data-main="#{_javascript_path(name)}"}
     else
       ""
     end
@@ -33,37 +39,61 @@ module RequirejsHelper
 
     html = ""
 
-    if controller.requirejs_included
-      raise Requirejs::MultipleIncludeError, "Only one requirejs_include_tag allowed per page."
-    end
+    _once_guard do
+      unless requirejs.run_config.empty?
+        run_config = requirejs.run_config.dup
+        unless _priority.empty?
+          run_config = run_config.dup
+          run_config[:priority] ||= []
+          run_config[:priority].concat _priority
+        end
+        if Rails.application.config.assets.digest
+          modules = requirejs.build_config['modules'].map { |m| requirejs.module_name_for m }
 
-    unless requirejs.run_config.empty?
-      run_config = requirejs.run_config
-      if Rails.application.config.assets.digest
-        modules = requirejs.build_config['modules'].map { |m| requirejs.module_name_for m }
+          # Generate digestified paths from the modules spec
+          paths = {}
+          modules.each { |m| paths[m] = _javascript_path(m).sub /\.js$/,'' }
 
-        # Generate digestified paths from the modules spec
-        paths = {}
-        modules.each { |m| paths[m] = javascript_path(m).sub /\.js$/,'' }
+          # Add paths for assets specified by full URL (on a CDN)
+          run_config['paths'].each { |k,v| paths[k] = v if v =~ /^https?:/ }
 
-        # Override uesr paths, whose mappings are only relevant in dev mode
-        # and in the build_config.
-        run_config['paths'] = paths
+          # Override user paths, whose mappings are only relevant in dev mode
+          # and in the build_config.
+          run_config['paths'] = paths
+        end
+        html.concat <<-HTML
+        <script>var require = #{run_config.to_json};</script>
+        HTML
       end
+
       html.concat <<-HTML
-      <script>var require = #{run_config.to_json};</script>
+      <script #{_requirejs_data(name, &block)} src="#{_javascript_path 'require.js'}"></script>
       HTML
+
+      html.html_safe
     end
+  end
 
-    html.concat <<-HTML
-    <script #{_requirejs_data(name, &block)} src="#{javascript_path 'require.js'}"></script>
-    HTML
+  def _once_guard
+    if defined?(controller) && controller.requirejs_included
+      raise Requirejs::MultipleIncludeError, "Only one requirejs_include_tag allowed per page."
+    end
+
+    retval = yield
 
-    controller.requirejs_included = true
-    html.html_safe
+    controller.requirejs_included = true if defined?(controller)
+    retval
   end
 
   def _almond_include_tag(name, &block)
-    "<script src='#{javascript_path name}'></script>\n".html_safe
+    "<script src='#{_javascript_path name}'></script>\n".html_safe
+  end
+
+  def _javascript_path(name)
+    if defined?(javascript_path)
+      javascript_path(name)
+    else
+      "/assets/#{name}"
+    end
   end
 end

data/lib/requirejs/rails/config.rb

@@ -26,6 +26,8 @@ module Requirejs::Rails
       self.driver_template_path = Pathname.new(__FILE__+'/../rjs_driver.js.erb').cleanpath
       self.driver_path = self.tmp_dir + 'rjs_driver.js'
 
+      self.user_config = {}
+
       self.run_config_whitelist = %w{
         baseUrl
         callback
@@ -106,13 +108,24 @@ module Requirejs::Rails
           mod['name'] = 'almond'
           mod['include'] = name
         end
+        self.rewrite_urls_in_paths self[:build_config]
       end
       self[:build_config]
     end
 
     def run_config
-      run_config = { "baseUrl" => "/assets" }
-      run_config.merge!(self.user_config).slice(*self.run_config_whitelist)
+      unless self.has_key?(:run_config)
+        self[:run_config] = { "baseUrl" => "/assets" }
+        self[:run_config].merge!(self.user_config).slice!(*self.run_config_whitelist)
+      end
+      self[:run_config]
+    end
+
+    def user_config=(cfg)
+      if url = cfg.delete('baseUrl')
+        raise Requirejs::ConfigError, "baseUrl is not needed or permitted in the configuration"
+      end
+      self[:user_config] = cfg
     end
 
     def module_name_for(mod)
@@ -137,5 +150,13 @@ module Requirejs::Rails
         accum || (matcher =~ asset)
       end ? true : false
     end
+
+    def rewrite_urls_in_paths(cfg)
+      if cfg.has_key? 'paths'
+        cfg['paths'] = cfg['paths'].each_with_object({}) do |(k, v), h|
+          h[k] = (v =~ /^https?:/) ? 'empty:' : v
+        end
+      end
+    end
   end
 end

data/lib/requirejs/rails/version.rb

@@ -1,6 +1,6 @@
 module Requirejs
   module Rails
-    Version = "0.7.3"
-    LibVersion = "1.0.7"
+    Version = "0.8.0"
+    LibVersion = "1.0.8"
   end
 end

data/test/requirejs-rails_test.rb

@@ -44,12 +44,92 @@ class RequirejsRailsConfigTest < ActiveSupport::TestCase
     @cfg.logical_asset_filter += [/\.frobnitz$/]
     assert_equal true, @cfg.asset_allowed?('bar.frobnitz')
   end
+
+  test "should have a default empty user_config" do
+    assert_kind_of Hash, @cfg.user_config
+  end
+
+  test "user_config should reject baseUrl" do
+    exc = assert_raises Requirejs::ConfigError do
+      @cfg.user_config = { 'baseUrl' => '/frobnitz' }
+    end
+    assert_match /baseUrl is not needed/, exc.message
+  end
+
+  test "run_config should inherit user_config settings" do
+    @cfg.user_config = { 'paths' => { 'jquery' => 'lib/jquery-1.7.2.min' } }
+    refute_nil @cfg.run_config['paths']
+    assert_kind_of Hash, @cfg.run_config['paths']
+    assert_equal 'lib/jquery-1.7.2.min', @cfg.run_config['paths']['jquery']
+  end
+
+  test "run_config should allow settings to be overridden" do
+    @cfg.run_config['baseUrl'] = 'http://cdn.example.com/assets'
+    assert_equal 'http://cdn.example.com/assets', @cfg.run_config['baseUrl']
+  end
+
+  test "build_config should inherit user_config settings" do
+    @cfg.user_config = { 'paths' => { 'jquery' => 'lib/jquery-1.7.2.min' } }
+    refute_nil @cfg.build_config['paths']
+    assert_kind_of Hash, @cfg.build_config['paths']
+    assert_equal 'lib/jquery-1.7.2.min', @cfg.build_config['paths']['jquery']
+  end
+
+  test "run_config should reject irrelevant settings" do
+    @cfg.user_config = { 'optimize' => 'none' }
+    assert_nil @cfg.run_config['optimize'] 
+  end
+
+  test "build_config should reject irrelevant settings" do
+    @cfg.user_config = { 'priority' => %w{ foo bar baz } }
+    assert_nil @cfg.build_config['priority'] 
+  end
+
+  test "build config should replace urls in paths with 'empty:'" do
+    @cfg.user_config = { 'paths' => 
+      { 
+        'jquery' => 'http://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js',
+        'jqueryssl' => 'https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js'
+      }
+    }
+    assert_equal 'empty:', @cfg.build_config['paths']['jquery']
+    assert_equal 'empty:', @cfg.build_config['paths']['jqueryssl']
+  end
+
+  test "build_config should not modify non-urls in paths" do
+    @cfg.user_config = { 'paths' => 
+      { 
+        'foo' => 'components/foo'
+      }
+    }
+    assert_equal 'components/foo', @cfg.build_config['paths']['foo']
+  end
+
+  ## Almond-specific tests
+  test "build_config with almond should accept one module" do
+    @cfg.loader = :almond
+    @cfg.user_config = { 'modules' => [ { 'name' => 'foo' } ] }
+    assert_match 'almond', @cfg.build_config['modules'][0]['name']
+  end
+
+  test "build_config with almond must reject more than one module" do
+    @cfg.loader = :almond
+    @cfg.user_config = { 'modules' => [ { 'name' => 'foo' }, { 'name' => 'bar' } ] }
+    exc = assert_raises Requirejs::ConfigError do
+      @cfg.build_config
+    end
+    assert_match /requires exactly one module/, exc.message
+  end
 end
 
 class RequirejsHelperTest < ActionView::TestCase
   
   def setup
     controller.requirejs_included = false
+    Rails.application.config.requirejs.user_config = { 'paths' => 
+      { 'jquery' => 'http://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js' }
+    }
+
   end
   
   def wrap(tag)
@@ -82,4 +162,20 @@ class RequirejsHelperTest < ActionView::TestCase
       render :text => "#{requirejs_include_tag}\n#{requirejs_include_tag}"
     end
   end
+
+  test "requirejs_include_tag with CDN asset in paths" do
+    render :text => wrap(requirejs_include_tag)
+    assert_select "script:first-of-type", :text => %r{var require =.*paths.*http://ajax}
+  end
+
+  test "requirejs_include_tag with CDN asset and digested asset paths" do
+    begin
+      saved_digest = Rails.application.config.assets.digest
+      Rails.application.config.assets.digest = true
+      render :text => wrap(requirejs_include_tag)
+      assert_select "script:first-of-type", :text => %r{var require =.*paths.*http://ajax}
+    ensure
+      Rails.application.config.assets.digest = saved_digest
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: requirejs-rails
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-20 00:00:00.000000000 Z
+date: 2012-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
-  requirement: &70218915266960 !ruby/object:Gem::Requirement
+  requirement: &70259994422520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +24,10 @@ dependencies:
         version: '3.3'
   type: :runtime
   prerelease: false
-  version_requirements: *70218915266960
+  version_requirements: *70259994422520
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70218915433300 !ruby/object:Gem::Requirement
+  requirement: &70259994419640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -38,10 +38,10 @@ dependencies:
         version: '3.3'
   type: :development
   prerelease: false
-  version_requirements: *70218915433300
+  version_requirements: *70259994419640
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70218915431540 !ruby/object:Gem::Requirement
+  requirement: &70259994416180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -49,7 +49,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70218915431540
+  version_requirements: *70259994416180
 description: This gem provides RequireJS support for your Rails 3 application.
 email:
 - whitley@bangpath.org
@@ -129,7 +129,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2649433147791205198
+      hash: -70510863405532610
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -138,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2649433147791205198
+      hash: -70510863405532610
 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).