sprockets-umodule 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a34c71c2402af977c4d275588332de7dbe530dd
-  data.tar.gz: a3f7a0701325d4b5d8d4342de84bd4560647e674
+  metadata.gz: 3fac1b724d5ddcf8fd7af63a13b517783d3a8ae5
+  data.tar.gz: c145b7522e79a28e83037761143dd6f01833f674
 SHA512:
-  metadata.gz: da56b89e33c79812e5c255318d7fe2347ad2f0802ded82c9e4c620fb213e6f084fe40f71e7ce7008ea5afe8caf0835cc467a05439a8d750a0ac10f68aebbbb33
-  data.tar.gz: f881d1af7ac14dd7160bbde4060098b13e24142a00d3303e4897113fc06adb43b3ac6fff966f966067d9c6cb454320ea98b1d680afa720a90ad39e2643f1aadc
+  metadata.gz: 127119840a092b45c59cfb3d6a94809ca4646d3177c169a6bdb0f02da1410ad1725b218a8e5f045761ac3063deef3dbd48224096cb4c39017f7dd78fce43a873
+  data.tar.gz: 43bd520fe7cffc318f652a60df78f3a175568e482a72eb959a3430cad3a8eee4384781e386cccf6d71dbf14c6b93388e49f8813fe9087cbd7eee350dca6ee9fc

data/README.mdown

@@ -4,8 +4,30 @@
 
 ## Goal
 
-Save you from the boilerplate of writing module wrapping.
+`sprockets-umodule` saves you from the chore of writing CommonJS umodule
+wrapping boilerplate. The module name will automatically be set from its
+logical path (relative path to its asset root).
 
 ## Usage
 
-Add sprockets-umodule to your Gemfile. Name your module files with .umodule.
+Add `gem 'sprockets-umodule'` to your Gemfile. Name your module files with
+`.js.umodule` or `.js.umodule.coffee`, matching your poison of choice.
+
+If you're using Sprockets, load umodule.js by any way you see fit. For convenience,
+its source is included and can be obtained with `Umodule::Source.contents`, so
+it's merely a `umodule.js.erb` away:
+
+    <%= Umodule::Source.contents %>
+
+Alternatively, you can add `File.dirname(Umodule::Source.bundled_path)` to the
+asset load path.
+
+If you're using Rails, add `gem 'sprockets-umodule, require: umodule-rails`
+instead, which will make it an engine and set up all of this for you, so you
+just have to add `//= require
+umodule` to `application.js`.
+
+Important note: due to some technical complications, you must also
+`//= require` your umodule assets in `application.js`, and possibly manage
+dependency ordering manually. In any case, they should be loaded after
+`umodule.js`.

data/lib/assets/javascripts/umodule.js.erb

@@ -0,0 +1 @@
+<%= Umodule::Source.contents %>

data/lib/sprockets/umodule/version.rb

@@ -1,5 +1,5 @@
 module Sprockets
   module Umodule
-    VERSION = '1.0.0'
+    VERSION = '1.1.0'
   end
 end

data/lib/umodule/rails.rb

@@ -0,0 +1,8 @@
+require 'rails/engine'
+
+module Umodule
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/umodule-rails.rb

@@ -0,0 +1,2 @@
+require 'sprockets-umodule'
+require 'umodule/rails'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sprockets-umodule
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Loic Nageleisen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-30 00:00:00.000000000 Z
+date: 2013-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: umodule-source
@@ -105,11 +105,14 @@ files:
 - Gemfile
 - LICENSE
 - README.mdown
+- lib/assets/javascripts/umodule.js.erb
 - lib/sprockets-umodule.rb
 - lib/sprockets/umodule.rb
 - lib/sprockets/umodule/umodule.js.erb
 - lib/sprockets/umodule/version.rb
 - lib/sprockets/umodule/wrapper.rb
+- lib/umodule-rails.rb
+- lib/umodule/rails.rb
 - spec/spec_helper.rb
 - spec/sprockets-umodule_spec.rb
 - sprockets-umodule.gemspec