sprockets-require_module 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4dd0e9142cec7e3f633ae65d35b656919e477a40
+  data.tar.gz: 46a3c3c364483e3e6b73f0fac28a4d0bac0f30e1
+SHA512:
+  metadata.gz: a322efb479999d3c04a5a77ea7444c338a1c6b72f5faf32e9f2e3047f596a7feb0d8de124cffe12c91690daa73d93a4350a2680aaa97adb1eae59f49331acf0c
+  data.tar.gz: 9e7b044775d05c102973ad7cd858b0eab26f3d138dc4c7d258250efda85ff52f2c1fae7ee947736829977ed16457a81590eaad1416099452eae2d3457c3cbf2a

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Rolf van de Krol
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# Sprockets Require Module
+Sprockets Require Module provides a sprocket directive `require_module` that allows wrapping a number of assets in a module and requiring them at once.
+
+## Installation
+
+In order to install `sprockets-require_module` into your project, add 
+
+```ruby
+gem "sprockets-require_module"
+```
+
+to your `Gemfile`.
+
+## Usage
+
+Provide a module that has an `assets` method. For example:
+
+```ruby
+module MyProject
+  module Assets
+    extend self
+    
+    def assets
+      ['myproject/core', 'myproject/something_else']
+    end
+  end
+end
+```
+
+Make sure the module is either loaded or auto loadable.
+
+In a sprockets manifest, add a reference to this module, like this:
+
+```js
+//= require_module my_project/assets
+```
+
+The module does not have to be an actual module. As long as it is a constant that has an `assets` method, it's fine. So it can be class too. 
+
+The `assets` method should return an `Enumerable`.
+
+### Asset caching
+
+Sprockets caches all asset files, also on development, to prevent unnecessary asset compilation. This behavior conflicts a bit with this gem. Luckily Sprockets allows us to register files that are dependencies of the assets. When these dependencies change, the assets that depend on them, are recompiled.
+
+By default Sprockets Require Module registers the file that defines the `assets` method as a dependency. That means that in the example `MyProject::Assets` module, you can change the list of returned asset paths and it will all update perfectly well, because Sprockets will detect that the file where the module is defined has been altered and will invalidate the relevant cache parts.
+
+If you create a more complicated implementation, you might need to spend a little more effort to make sure Sprockets cache does not prevent asset recompilation. If you for example create a class that receives it's paths from another part of the application, you will need to mark those other parts as dependencies.
+
+If the constant that you mention in your `require_module` directive has an `asset_dependencies` method, the return value of this method is used as the list of dependencies, instead of the default behavior. 

data/lib/sprockets-require_module.rb

@@ -0,0 +1 @@
+require 'sprockets/require_module'

data/lib/sprockets/require_module.rb

@@ -0,0 +1,24 @@
+require 'active_support'
+require 'active_support/core_ext/string/inflections'
+
+require 'sprockets'
+
+Sprockets::DirectiveProcessor.class_eval do
+  protected
+    def process_require_module_directive name
+      mod = name.camelize.constantize
+      mod.assets.each do |path|
+        context.require_asset(path)
+      end
+
+      if mod.respond_to? :asset_dependencies
+        dependencies = mod.asset_dependencies
+      else
+        dependencies = [mod.method(:assets).source_location.first]
+      end
+
+      dependencies.each do |path|
+        context.depend_on(path)
+      end
+    end
+end

data/lib/sprockets/require_module/version.rb

@@ -0,0 +1,5 @@
+module Sprockets
+  module RequireModule
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: sprockets-require_module
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rolf van de Krol
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Sprockets directive require_module to keep a list of assets outside a
+  sprocket manifest in a module
+email:
+- info@rolfvandekrol.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/sprockets-require_module.rb
+- lib/sprockets/require_module.rb
+- lib/sprockets/require_module/version.rb
+homepage: https://github.com/rolfvandekrol/sprockets-require_module
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Sprockets Require Module
+test_files: []