requirejs-rails 0.5.6 → 0.6.1

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+# v0.6.1
+
+- Fix regression in production env when `paths` specified in requirejs.yml.
+
+# v0.6.0
+
+**NOTE:** Upgrade to 0.6.1! This was yanked due to a regression.
+
+- We now generate a paths config to hit digested assets when needed (in
+  `production` or when `config.assets.digest` is true). Fixes #20.
+- Support for generating additional data attributes on the require.js script
+  tag via `requirejs_include_tag`. See [README](README.md) for details. Closes 
+  pull request #32; thanks to @hollow for the submission!
+
 # v0.5.6
 
 - Upgrade to RequireJS and r.js 1.0.7

data/Gemfile.lock

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

data/README.md

@@ -65,14 +65,22 @@ Integrates [RequireJS](http://requirejs.org/) into the Rails 3 Asset Pipeline.
 
 ## Configuration
 
-Configuration lives in `config/requirejs.yml`.  These values are inspected and used by `requirejs-rails` and passed along as configuration for require.js and `r.js`.  This replaces the use of `require.config()` in v0.0.2.  The default configuration declares `application.js` as the sole top-level module.  This can be overridden by creating a `config/requirejs.yml`, such as:
+### The Basics
+
+Configuration lives in `config/requirejs.yml`.  These values are inspected and
+used by `requirejs-rails` and passed along as configuration for require.js and
+`r.js`.  The default configuration declares `application.js` as the sole
+top-level module.  This can be overridden by creating
+a `config/requirejs.yml`, such as:
 
 ```yaml
 modules:
   - name: 'mytoplevel'
 ```
 
-You may pass in [require.js config options](http://requirejs.org/docs/api.html#config) as needed.  For example, to add path parameters:
+You may pass in [require.js config
+options](http://requirejs.org/docs/api.html#config) as needed.  For example,
+to add path parameters:
 
 ```yaml
 paths:
@@ -80,7 +88,12 @@ paths:
   "d3.time": "d3/d3.time"
 ```
 
-Only modules specified in the configuration will be created as build artifacts by `r.js`.  [Layered r.js builds](http://requirejs.org/docs/faq-optimization.html#priority) be configured like so:
+### Layered builds
+
+Only modules specified in the configuration will be created as build artifacts
+by `r.js`.  [Layered r.js
+builds](http://requirejs.org/docs/faq-optimization.html#priority) be
+configured like so:
 
 ```yaml
 modules:
@@ -89,9 +102,43 @@ modules:
     exclude: ['appcommon']
   - name: 'page2'
     exclude: ['appcommon']
+priority: ['appcommon']
+```
+
+In this example, only modules `page1` and `page2` are intended for direct
+loading via `requirejs_include_tag`. The `appcommon` module contains
+dependencies shared by the per-page modules.  As a guideline, each module in
+the configuration should be referenced by one of:
+
+- A `requirejs_include_tag` in a template
+- Pulled in via a dynamic `require()` call.  Modules which are solely
+  referenced by a dynamic `require()` call (i.e. a call not optimized by r.js)
+  **must** be specified in the modules section in order to produce a correct
+  build.
+- Be a common library module like `appcommon`, listed in the `priority` config
+  option.
+
+## Advanced features
+
+### Additional data attributes
+
+`requirejs_include_tag` accepts an optional block which should return a hash.
+This hash will be used to populate additional `data-...` attributes like so:
+
+```erb
+<%= requirejs_include_tag "page1" do |controller|
+      { 'foo' => controller.foo,
+        'bar' => controller.bar
+      }
+    end
+%>
 ```
 
-As a guideline, each module in the configuration should either be referenced by a `requirejs_include_tag` in a template or pulled in via a dynamic `require()` call.  Modules which are solely referenced by a dynamic `require()` call (i.e. a call not optimized by r.js) **must** be specified in the modules section in order to produce a correct build.
+This will generate a script tag like so:
+
+```
+<script data-main="/assets/page1.js" data-foo="..." data-bar="..." src="/assets/require.js"></script>
+```
 
 ## Using AMD libraries
 
@@ -111,29 +158,31 @@ define ['jquery'], ($) ->
 
 ### Backbone.js
 
-**DO NOT USE vanilla Backbone 0.5.3 with require.js!**
-
-Backbone with AMD support hasn't been released yet.  In the meantime, you can download [Backbone 0.5.3 with AMD support](https://github.com/jrburke/backbone/raw/optamd3/backbone.js) from [jrburke's optamd3 branch](https://github.com/jrburke/backbone/tree/optamd3).  See pull request [documentcloud/backbone#710](https://github.com/documentcloud/backbone/pull/710) for details.  Backbone's module name is `backbone`.
+Backbone 0.9.x doesn't support AMD natively.  I recommend the [amdjs
+fork of Backbone](https://github.com/amdjs/backbone/) which adds AMD
+support and actively tracks mainline.
 
 ### Underscore.js
 
-Underscore version 1.2.x, 1.2.2 or later has integrated AMD support.  Get it from [Underscore.js' homepage](http://documentcloud.github.com/underscore/). Underscore's module name is `underscore`.
-
-**IMPORTANT:** Underscore has **removed** AMD support again in the 1.3.x series.  Please consult the [requirejs mailing list](http://groups.google.com/group/requirejs/) for the current recommended solution.
+Underscore 1.3.x likewise doesn't have AMD support.  Again, see
+the [amdjs fork of Underscore](https://github.com/amdjs/underscore).
 
 ## Changes
 
-Usage changes that impact folks upgrading along the 0.x series are documented here.
+Usage changes that impact folks upgrading along the 0.x series are
+documented here. See [the Changelog](CHANGELOG.md) for other details.
 
 ### v0.5.1
 
 - `requirejs_include_tag` now generates a data-main attribute if given an argument, ala:
 
     ```erb
-	<%= requirejs_include_tag "application" %>
-	```
+    <%= requirejs_include_tag "application" %>
+    ```
 
-    This usage is preferred to using a separate `javascript_include_tag`, which will produce errors from require.js or r.js if the included script uses define anonymously, or not at all.
+    This usage is preferred to using a separate
+    `javascript_include_tag`, which will produce errors from require.js or
+    r.js if the included script uses define anonymously, or not at all.
 
 ### v0.5.0
 
@@ -141,12 +190,12 @@ Usage changes that impact folks upgrading along the 0.x series are documented he
 - It is no longer necessary or desirable to specify `baseUrl` explicitly in the configuration.
 - Users should migrate application configuration previously in `application.js` (ala `require.config(...)`) to `config/requirejs.yml`
 
-See [the Changelog](CHANGELOG.md) for other details
+
 
 ## TODOs
 
-- Sample app, including jQuery usage
-- Generator and/or template support.. ?
+Please check out [our GitHub issues page](https://github.com/jwhitley/requirejs-rails/issues)
+to see what's upcoming and to file feature requests and bug reports.
 
 ----
 

data/app/helpers/requirejs_helper.rb

@@ -1,6 +1,19 @@
 require 'requirejs/error'
 
 module RequirejsHelper
+  def _requirejs_data(name, &block)
+    {}.tap do |data|
+      if name
+        name += ".js" unless name =~ /\.js$/
+        data['main'] = javascript_path(name)
+      end
+
+      data.merge!(yield controller) if block_given?
+    end.map do |k, v|
+      %Q{data-#{k}="#{v}"}
+    end.join(" ")
+  end
+
   def _data_main(name)
     if name
       name += ".js" unless name =~ /\.js$/
@@ -10,18 +23,36 @@ module RequirejsHelper
     end
   end
 
-  def requirejs_include_tag(name=nil)
+  def requirejs_include_tag(name=nil, &block)
     html = ""
-    
+    requirejs = Rails.application.config.requirejs
+
     if controller.requirejs_included
       raise Requirejs::MultipleIncludeError, "Only one requirejs_include_tag allowed per page."
     end
-    html = <<-HTML
-    <script>
-      var require = #{Rails.application.config.requirejs.run_config_json};
-    </script>
-    <script #{_data_main name} src="#{javascript_path 'require.js'}"></script>
+
+    unless requirejs.run_config.empty?
+      run_config = requirejs.run_config
+      if Rails.application.config.assets.digest
+        modules = requirejs.build_config['modules'].map { |m| m['name'] }
+
+        # Generate digestified paths from the modules spec
+        paths = {}
+        modules.each { |m| paths[m] = javascript_path(m).sub /\.js$/,'' }
+
+        # Override uesr 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 #{_requirejs_data(name, &block)} src="#{javascript_path 'require.js'}"></script>
     HTML
+
     controller.requirejs_included = true
     html.html_safe
   end

data/lib/requirejs/rails/config.rb

@@ -30,15 +30,72 @@ module Requirejs::Rails
         self.user_config = {}
       end
 
-      self.run_config = {
+      self.run_config_whitelist = %w{
+        baseUrl
+        callback
+        catchError
+        context
+        deps
+        jQuery
+        locale
+        packages
+        paths
+        priority
+        scriptType
+        urlArgs
+        waitSeconds
+        xhtml
+      }
+
+      self.build_config_whitelist = %w{
+        appDir
+        baseUrl
+        closure
+        cssImportIgnore
+        cssIn
+        dir
+        fileExclusionRegExp
+        findNestedDependencies
+        has
+        hasOnSave
+        include
+        inlineText
+        locale
+        mainConfigFile
+        modules
+        name
+        namespace
+        onBuildRead
+        onBuildWrite
+        optimize
+        optimizeAllPluginResources
+        optimizeCss
+        out
+        packagePaths
+        packages
+        paths
+        pragmas
+        pragmasOnSave
+        preserveLicenseComments
+        skipModuleInsertion
+        skipPragmas
+        uglify
+        useStrict
+        wrap
+      }
+    end
+
+    def build_config
+      build_config = self.run_config.merge "baseUrl" => source_dir.to_s
+      build_config.merge!(self.user_config).slice(*self.build_config_whitelist)
+    end
+
+    def run_config
+      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)
+      run_config.merge!(self.user_config).slice(*self.run_config_whitelist)
     end
 
     def module_path_for(name)

data/lib/requirejs/rails/version.rb

@@ -1,5 +1,5 @@
 module Requirejs
   module Rails
-    VERSION = "0.5.6"
+    VERSION = "0.6.1"
   end
 end

data/test/requirejs-rails_test.rb

@@ -38,6 +38,16 @@ class RequirejsHelperTest < ActionView::TestCase
     assert_select "script:last-of-type[src^=/javascripts/require.js][data-main^=/javascripts/application.js]", :count => 1
   end
   
+  test "requirejs_include_tag_with_block" do
+    test_block = Proc.new do |controller| 
+      { 'class' => controller.class.to_s.demodulize }
+    end
+
+    render :text => wrap(requirejs_include_tag("application", &test_block))
+    assert_select "script:last-of-type[src^=/javascripts/require.js][data-main^=/javascripts/application.js]", :count => 1
+    assert_select "script:last-of-type[src^=/javascripts/require.js][data-class^=TestController]", :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}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: requirejs-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.6.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-23 00:00:00.000000000 Z
+date: 2012-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
-  requirement: &70316642847980 !ruby/object:Gem::Requirement
+  requirement: &70307822048760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +24,10 @@ dependencies:
         version: '3.3'
   type: :runtime
   prerelease: false
-  version_requirements: *70316642847980
+  version_requirements: *70307822048760
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70316642846680 !ruby/object:Gem::Requirement
+  requirement: &70307822046940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -38,10 +38,10 @@ dependencies:
         version: '3.3'
   type: :development
   prerelease: false
-  version_requirements: *70316642846680
+  version_requirements: *70307822046940
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70316642844860 !ruby/object:Gem::Requirement
+  requirement: &70307822042460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -49,7 +49,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70316642844860
+  version_requirements: *70307822042460
 description: This gem provides RequireJS support for your Rails 3 application.
 email:
 - whitley@bangpath.org
@@ -128,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4183822375632730942
+      hash: 4356678976778407183
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -137,12 +137,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4183822375632730942
+      hash: 4356678976778407183
 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.16
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Use RequireJS with the Rails 3 Asset Pipeline