sprockets-plugin 0.1.2 → 0.2.0

data/README.md

@@ -1,7 +1,7 @@
 sprockets-plugin
 ================
 
-Package assets into gems for non-Rails applications.
+Package assets into gems for non-Rails Sprockets 2.x applications.
 
 
 Installation
@@ -12,61 +12,68 @@ $ gem install sprockets-plugin
 ```
 
 
-Usage
------
+Usage in Applications
+---------------------
 
-Sprockets::Plugin is meant to be used within gems, to package assets for reuse. So the first step is to add it as a dependency in your gemspec:
+To use Sprockets plugins, you only need to do 3 things:
 
+1. Require "sprockets-plugin" to hook everything up.
+   _This may be required by the plugins themselves, but it's best practice to also require this in your application._
+2. Require any plugins you want to use.
+3. Call Sprockets::Environment#append_plugin_paths after setting up your application paths.
+   _Sprockets::Plugin **does not** automatically append paths to the environment. This is because the plugin paths would take precedence over your application's paths._
+   
+Here's an example:
+   
 ``` ruby
-Gem::Specification.new do |s|
-  # ...
-  s.add_runtime_dependency "sprockets-plugin"
+require "sprockets"
+require "sprockets-plugin" # 1.
+require "my_plugin"        # 2.
+
+map "/assets" do
+  env = Sprockets::Environment.new
+  env.append_path "assets/images"
+  env.append_path "assets/javascripts"
+  env.append_path "assets/stylesheets"
+  env.append_plugin_paths # 3.
+  run env
 end
 ```
 
-And then extend Sprockets::Plugin and add the necessary asset paths:
+Usage in Gems
+-------------
 
-``` ruby
-require "sprockets-plugin"
+Sprockets::Plugin is meant to be used within gems, to package assets for reuse. Again, there's only 3 things to do to set this up.
 
-class MyPlugin < Sprockets::Plugin
-  # Set the root path to use relative paths in `.append_path`
-  root File.expand_path("../..", __FILE__)
-  append_path "lib/assets/images"
-  append_path "lib/assets/javascripts"
-  append_path "lib/assets/stylesheets"
-end 
-```
+1. Add it as a dependency in your gemspec.
+2. Extend Sprockets::Plugin.
+3. Add the necessary paths.
 
-Now any assets in the "lib/assets" directory will be available to applications that require this gem:
+`my_plugin.gemspec`:
 
 ``` ruby
-require "sprockets"
-require "my_plugin"
-
-map "/assets" do
-  environment = Sprockets::Environment.new
-  # The assets from MyPlugin will be automatically appended.
-  environment.append_path "assets/images"
-  environment.append_path "assets/javascripts"
-  environment.append_path "assets/stylesheets"
-  run environment
+Gem::Specification.new do |s|
+  # ...
+  s.add_runtime_dependency "sprockets-plugin" # 1.
 end
 ```
 
-Advanced Usage
---------------
-
-You can package assets for Rails and non-Rails applications in the following way:
+`my_plugin.rb`:
 
 ``` ruby
-if defined? Rails
-  require "my_assets/engine"
-elsif defined? Sprockets::Plugin
-  require "my_assets/plugin"
-end
+require "sprockets-plugin"
+
+class MyPlugin < Sprockets::Plugin # 2.
+  # Set the root path to use relative paths in `.append_path`
+  root File.expand_path("../..", __FILE__)
+  
+  append_path "lib/assets/images"      # 3.
+  append_path "lib/assets/javascripts" # 3.
+  append_path "lib/assets/stylesheets" # 3.
+end 
 ```
 
+
 Copyright
 ---------
 

data/lib/sprockets/plugin.rb

@@ -31,15 +31,16 @@ module Sprockets
       # later be appended to the Sprockets::Environment.
       def append_paths(*paths)
         self.paths.push *normalize_paths(paths)
+        self
       end
       alias_method :append_path, :append_paths
       
-      # Prepends a path to the Plugin. The path will
-      # later be appended to the Sprockets::Environment.
-      def prepend_paths(*paths)
-        self.paths.unshift *normalize_paths(paths)
+      # Append each path in the given directory.
+      def append_paths_in(path)
+        path = normalize_path(path)
+        append_paths(*path.children.select(&:directory?)) if path.directory?
+        self
       end
-      alias_method :prepend_path, :prepend_paths
     
       # All of the paths registered by the plugin.
       def paths
@@ -48,12 +49,14 @@ module Sprockets
       
       protected
       
+      def normalize_path(path)
+        Pathname.new(path).expand_path(root)
+      end
+      
       def normalize_paths(paths)
         normalized_paths = []
         paths.each do |path|
-          path = Pathname.new(path)
-          path = root.join(path) if root && path.relative?
-          path = path.expand_path
+          path = normalize_path(path)
           normalized_paths.push(path.to_s) if path.exist?
         end
         normalized_paths

data/lib/sprockets/plugin/aware.rb

@@ -3,22 +3,6 @@ require "sprockets/environment"
 module Sprockets
   class Plugin
     module Aware
-      def self.included(base)
-        base.extend ClassMethods
-      end
-      
-      module ClassMethods
-        # Overrides .new to append Plugin paths after
-        # initialization.
-        #
-        # Is there a better way to do this?
-        def new(*args)
-          super(*args) do |env|
-            env.append_plugin_paths
-          end
-        end
-      end
-      
       # Appends the paths from each Sprockets::Plugin
       # to the Sprockets::Environment.
       def append_plugin_paths

data/lib/sprockets/plugin/version.rb

@@ -1,5 +1,5 @@
 module Sprockets
   class Plugin
-    VERSION = "0.1.2"
+    VERSION = "0.2.0"
   end
 end

data/spec/sprockets-plugin_spec.rb

@@ -5,40 +5,44 @@ describe Sprockets::Plugin do
     Sprockets::Plugin.send :class_variable_set, :@@plugins, nil
   end
   
-  it "adds paths from plugins to newly created environments" do
-    dir_1 = @sandbox.directory "plugin_1/assets"
-    dir_2 = @sandbox.directory "plugin_2/assets"
-    dir_3 = @sandbox.directory "plugin_3/assets"
-    
-    plugin_1 = Class.new Sprockets::Plugin
-    plugin_1.append_path dir_1
-    plugin_2 = Class.new Sprockets::Plugin
-    plugin_2.append_path dir_2
-    plugin_3 = Class.new Sprockets::Plugin
-    plugin_3.append_path dir_3
-    
-    env = Sprockets::Environment.new
-    env.paths.should == [dir_1, dir_2, dir_3].map(&:to_s)
-  end
+  describe "#append_plugin_paths" do
+    it "adds paths from plugins to environments" do
+      dir_1 = @sandbox.directory "plugin_1/assets"
+      dir_2 = @sandbox.directory "plugin_2/assets"
+      dir_3 = @sandbox.directory "plugin_3/assets"
+      
+      plugin_1 = Class.new Sprockets::Plugin
+      plugin_1.append_path dir_1
+      plugin_2 = Class.new Sprockets::Plugin
+      plugin_2.append_path dir_2
+      plugin_3 = Class.new Sprockets::Plugin
+      plugin_3.append_path dir_3
+      
+      env = Sprockets::Environment.new
+      env.append_plugin_paths
+      env.paths.should == [dir_1, dir_2, dir_3].map(&:to_s)
+    end
   
-  it "adds a #append_plugin_paths method for adding paths from plugins" do
-    dir_1 = @sandbox.directory "plugin_1/assets"
-    dir_2 = @sandbox.directory "plugin_2/assets"
-    dir_3 = @sandbox.directory "plugin_3/assets"
-    
-    plugin_1 = Class.new Sprockets::Plugin
-    plugin_1.append_path dir_1
-    
-    env = Sprockets::Environment.new
-    env.paths.should == [dir_1].map(&:to_s)
-    
-    plugin_2 = Class.new Sprockets::Plugin
-    plugin_2.append_path dir_2
-    plugin_3 = Class.new Sprockets::Plugin
-    plugin_3.append_path dir_3
-    
-    env.append_plugin_paths
-    env.paths.should == [dir_1, dir_2, dir_3].map(&:to_s)
+    it "does not add duplicate paths" do
+      dir_1 = @sandbox.directory "plugin_1/assets"
+      dir_2 = @sandbox.directory "plugin_2/assets"
+      dir_3 = @sandbox.directory "plugin_3/assets"
+      
+      plugin_1 = Class.new Sprockets::Plugin
+      plugin_1.append_path dir_1
+      
+      env = Sprockets::Environment.new
+      env.append_plugin_paths
+      env.paths.should == [dir_1].map(&:to_s)
+      
+      plugin_2 = Class.new Sprockets::Plugin
+      plugin_2.append_path dir_2
+      plugin_3 = Class.new Sprockets::Plugin
+      plugin_3.append_path dir_3
+      
+      env.append_plugin_paths
+      env.paths.should == [dir_1, dir_2, dir_3].map(&:to_s)
+    end
   end
   
   describe ".append_path" do
@@ -92,55 +96,16 @@ describe Sprockets::Plugin do
     end
   end
   
-  describe ".prepend_path" do
-    it "adds paths" do
-      dir_1 = @sandbox.directory "plugin/assets/images"
-      dir_2 = @sandbox.directory "plugin/assets/javascripts"
-      dir_3 = @sandbox.directory "plugin/assets/stylesheets"
+  describe ".append_paths_in" do
+    it "adds paths within the given path" do
+      assets_dir = @sandbox.directory "plugin/assets"
+      dir_1      = assets_dir.directory "images"
+      dir_2      = assets_dir.directory "javascripts"
+      dir_3      = assets_dir.directory "stylesheets"
       
       plugin = Class.new Sprockets::Plugin
-      plugin.prepend_path dir_1
-      plugin.prepend_path dir_2
-      plugin.prepend_path dir_3
-      plugin.paths.should == [dir_3, dir_2, dir_1].map(&:to_s)
-    end
-    
-    it "adds the paths relative to the plugin root" do
-      dir_1 = @sandbox.directory "plugin/assets/images"
-      dir_2 = @sandbox.directory "plugin/assets/javascripts"
-      dir_3 = @sandbox.directory "plugin/assets/stylesheets"
-      
-      plugin = Class.new Sprockets::Plugin
-      plugin.root @sandbox.join "plugin"
-      plugin.prepend_path "assets/images"
-      plugin.prepend_path "assets/javascripts"
-      plugin.prepend_path "assets/stylesheets"
-      plugin.paths.should == [dir_3, dir_2, dir_1].map(&:to_s)
-    end
-    
-    it "only adds existing paths" do
-      dir_1 = @sandbox.directory "plugin/assets/images"
-      dir_2 = @sandbox.directory "plugin/assets/javascripts"
-      dir_3 = @sandbox.join "plugin/assets/stylesheets"
-      
-      plugin = Class.new Sprockets::Plugin
-      plugin.prepend_path dir_1
-      plugin.prepend_path dir_2
-      plugin.prepend_path dir_3
-      plugin.paths.should == [dir_2, dir_1].map(&:to_s)
-    end
-  end
-  
-  describe ".prepends_paths" do
-    it "adds multiple paths at once" do
-      dir_1 = @sandbox.directory "plugin/assets/images"
-      dir_2 = @sandbox.directory "plugin/assets/javascripts"
-      dir_3 = @sandbox.directory "plugin/assets/stylesheets"
-      
-      plugin = Class.new Sprockets::Plugin
-      plugin.append_path dir_1
-      plugin.prepend_paths dir_2 ,dir_3
-      plugin.paths.should == [dir_2, dir_3, dir_1].map(&:to_s)
+      plugin.append_paths_in assets_dir
+      plugin.paths.should == [dir_1, dir_2, dir_3].map(&:to_s)
     end
   end
   

data/sprockets-plugin.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Pete Browne"]
   s.email       = ["me@petebrowne.com"]
   s.homepage    = "https://github.com/petebrowne/sprockets-plugin"
-  s.summary     = %q{Package assets into gems for non-Rails applications.}
-  s.description = %q{Package assets into gems for non-Rails applications.}
+  s.summary     = %q{Package assets into gems for non-Rails Sprockets 2.x applications.}
+  s.description = %q{Package assets into gems for non-Rails Sprockets 2.x applications.}
 
   s.rubyforge_project = "sprockets-plugin"
 

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sprockets-plugin
 version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: 
-  version: 0.1.2
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Pete Browne
@@ -10,53 +15,72 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-04 00:00:00 Z
+date: 2012-01-05 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: sprockets
+  type: :runtime
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
         version: "2.0"
-  type: :runtime
   prerelease: false
+  name: sprockets
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: appraisal
+  type: :development
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 4
+        - 0
         version: 0.4.0
-  type: :development
   prerelease: false
+  name: appraisal
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  type: :development
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
         version: 2.6.0
-  type: :development
   prerelease: false
+  name: rspec
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: test-construct
+  type: :development
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 2
+        - 0
         version: 1.2.0
-  type: :development
   prerelease: false
+  name: test-construct
   version_requirements: *id004
-description: Package assets into gems for non-Rails applications.
+description: Package assets into gems for non-Rails Sprockets 2.x applications.
 email: 
 - me@petebrowne.com
 executables: []
@@ -95,7 +119,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 783171325049649071
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -104,17 +128,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 783171325049649071
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: sprockets-plugin
-rubygems_version: 1.8.8
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: Package assets into gems for non-Rails applications.
+summary: Package assets into gems for non-Rails Sprockets 2.x applications.
 test_files: 
 - spec/spec_helper.rb
 - spec/sprockets-plugin_spec.rb