sprockets-plugin 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Appraisals

@@ -0,0 +1,11 @@
+appraise "sprockets-2.0" do
+  gem "sprockets", "~> 2.0.0"
+end
+
+appraise "sprockets-2.1" do
+  gem "sprockets", "~> 2.1.0"
+end
+
+appraise "sprockets-2.2" do
+  gem "sprockets", ">= 2.2.0.beta"
+end

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in sprockets-plugin.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Peter Browne
+
+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,73 @@
+sprockets-plugin
+================
+
+Package assets into gems for non-Rails applications.
+
+
+Installation
+------------
+
+``` bash
+$ gem install sprockets-plugin
+```
+
+
+Usage
+-----
+
+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:
+
+``` ruby
+Gem::Specification.new do |s|
+  # ...
+  s.add_runtime_dependency "sprockets-plugin"
+end
+```
+
+And then extend Sprockets::Plugin and add the necessary asset paths:
+
+``` ruby
+require "sprockets-plugin"
+
+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 
+```
+
+Now any assets in the "lib/assets" directory will be available to applications that require this gem:
+
+``` 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
+end
+```
+
+Advanced Usage
+--------------
+
+You can package assets for Rails and non-Rails applications in the following way:
+
+``` ruby
+if defined? Rails
+  require "my_assets/engine"
+elsif defined? Sprockets::Plugin
+  require "my_assets/plugin"
+end
+```
+
+Copyright
+---------
+
+Copyright (c) 2011 [Peter Browne](http://petebrowne.com). See LICENSE for details.

data/Rakefile

@@ -0,0 +1,6 @@
+require "appraisal"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+task :default => :spec

data/gemfiles/sprockets-2.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "sprockets", "~> 2.0.0"
+
+gemspec :path=>"../"

data/gemfiles/sprockets-2.0.gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: /Users/Pete/Code/sprockets-plugin
+  specs:
+    sprockets-plugin (0.0.1)
+      sprockets (~> 2.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    appraisal (0.4.0)
+      bundler
+      rake
+    diff-lcs (1.1.3)
+    hike (1.2.1)
+    rack (1.4.0)
+    rake (0.9.2.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    sprockets (2.0.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (!= 1.3.0, ~> 1.1)
+    test-construct (1.2.0)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 0.4.0)
+  rspec (~> 2.6.0)
+  sprockets (~> 2.0.0)
+  sprockets-plugin!
+  test-construct (~> 1.2.0)

data/gemfiles/sprockets-2.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "sprockets", "~> 2.1.0"
+
+gemspec :path=>"../"

data/gemfiles/sprockets-2.1.gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: /Users/Pete/Code/sprockets-plugin
+  specs:
+    sprockets-plugin (0.0.1)
+      sprockets (~> 2.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    appraisal (0.4.0)
+      bundler
+      rake
+    diff-lcs (1.1.3)
+    hike (1.2.1)
+    rack (1.4.0)
+    rake (0.9.2.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    sprockets (2.1.2)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (!= 1.3.0, ~> 1.1)
+    test-construct (1.2.0)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 0.4.0)
+  rspec (~> 2.6.0)
+  sprockets (~> 2.1.0)
+  sprockets-plugin!
+  test-construct (~> 1.2.0)

data/gemfiles/sprockets-2.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "sprockets", ">= 2.2.0.beta"
+
+gemspec :path=>"../"

data/gemfiles/sprockets-2.2.gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: /Users/Pete/Code/sprockets-plugin
+  specs:
+    sprockets-plugin (0.0.1)
+      sprockets (~> 2.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    appraisal (0.4.0)
+      bundler
+      rake
+    diff-lcs (1.1.3)
+    hike (1.2.1)
+    multi_json (1.0.4)
+    rack (1.4.0)
+    rake (0.9.2.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    sprockets (2.2.0.beta)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    test-construct (1.2.0)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 0.4.0)
+  rspec (~> 2.6.0)
+  sprockets (>= 2.2.0.beta)
+  sprockets-plugin!
+  test-construct (~> 1.2.0)

data/lib/sprockets-plugin.rb

@@ -0,0 +1 @@
+require "sprockets/plugin"

data/lib/sprockets/plugin.rb

@@ -0,0 +1,61 @@
+require "pathname"
+
+module Sprockets
+  class Plugin
+    require "sprockets/plugin/version"
+    require "sprockets/plugin/aware"
+    
+    class << self
+      def inherited(plugin)
+        plugins << plugin
+      end
+      
+      # Returns all of the plugins inheriting from
+      # Sprockets::Plugin.
+      def plugins
+        @@plugins ||= []
+      end
+      
+      # Sets the root path or returns the current one.
+      # A root path is required for appending relative
+      # paths.
+      def root(path = nil)
+        if path
+          @root = Pathname.new(path).expand_path
+        else
+          @root
+        end
+      end
+      
+      # Appends a path to the Plugin. The path will
+      # later be appended to the Sprockets::Environment.
+      def append_paths(*paths)
+        self.paths.push *normalize_paths(paths)
+      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)
+      end
+      alias_method :prepend_path, :prepend_paths
+    
+      # All of the paths registered by the plugin.
+      def paths
+        @paths ||= []
+      end
+      
+      protected
+      
+      def normalize_paths(paths)
+        paths.inject([]) do |normalized_paths, path|
+          path = Pathname.new(path)
+          path = root.join(path) if root && path.relative?
+          path = path.expand_path
+          normalized_paths.push(path.to_s) if path.exist?
+        end
+      end
+    end
+  end
+end

data/lib/sprockets/plugin/aware.rb

@@ -0,0 +1,35 @@
+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(root = ".")
+          super(root) do |env|
+            env.append_plugin_paths
+          end
+        end
+      end
+      
+      # Appends the paths from each Sprockets::Plugin
+      # to the Sprockets::Environment.
+      def append_plugin_paths
+        Plugin.plugins.each do |plugin|
+          plugin.paths.each do |path|
+            self.append_path(path) unless self.paths.include?(path)
+          end
+        end
+      end
+    end
+  end
+end
+
+Sprockets::Environment.send :include, Sprockets::Plugin::Aware

data/lib/sprockets/plugin/version.rb

@@ -0,0 +1,5 @@
+module Sprockets
+  class Plugin
+    VERSION = "0.1.0"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require "sprockets"
+require "sprockets-plugin"
+require "construct"
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  include Construct::Helpers
+  
+  config.before :each do
+    @sandbox = create_construct
+  end
+  
+  config.after :each do
+    @sandbox.destroy!
+  end
+end

data/spec/sprockets-plugin_spec.rb

@@ -0,0 +1,165 @@
+require "spec_helper"
+
+describe Sprockets::Plugin do
+  after :each do
+    Sprockets::Plugin.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
+  
+  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)
+  end
+  
+  describe ".append_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"
+      
+      plugin = Class.new Sprockets::Plugin
+      plugin.append_path dir_1
+      plugin.append_path dir_2
+      plugin.append_path dir_3
+      plugin.paths.should == [dir_1, dir_2, dir_3].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.append_path "assets/images"
+      plugin.append_path "assets/javascripts"
+      plugin.append_path "assets/stylesheets"
+      plugin.paths.should == [dir_1, dir_2, dir_3].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.append_path dir_1
+      plugin.append_path dir_2
+      plugin.append_path dir_3
+      plugin.paths.should == [dir_1, dir_2].map(&:to_s)
+    end
+  end
+  
+  describe ".appends_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, dir_2 ,dir_3
+      plugin.paths.should == [dir_1, dir_2, dir_3].map(&:to_s)
+    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"
+      
+      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)
+    end
+  end
+  
+  describe ".root" do
+    it "converts the given path to a Pathname object" do
+      plugin_path = @sandbox.join "plugin"
+      plugin = Class.new Sprockets::Plugin
+      plugin.root plugin_path.to_s
+      plugin.root.should be_an_instance_of(Pathname)
+      plugin.root.should == plugin_path
+    end
+  end
+  
+  describe ".plugins" do
+    it "returns all of the plugins" do
+      plugin_1 = Class.new Sprockets::Plugin
+      plugin_2 = Class.new Sprockets::Plugin
+      plugin_3 = Class.new Sprockets::Plugin
+      Sprockets::Plugin.plugins.should == [ plugin_1, plugin_2, plugin_3 ]
+    end
+  end
+end

data/sprockets-plugin.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "sprockets/plugin/version"
+
+Gem::Specification.new do |s|
+  s.name        = "sprockets-plugin"
+  s.version     = Sprockets::Plugin::VERSION
+  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.rubyforge_project = "sprockets-plugin"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_runtime_dependency     "sprockets",      "~> 2.0"
+  s.add_development_dependency "appraisal",      "~> 0.4.0"
+  s.add_development_dependency "rspec",          "~> 2.6.0"
+  s.add_development_dependency "test-construct", "~> 1.2.0"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification 
+name: sprockets-plugin
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Pete Browne
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-02 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sprockets
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: appraisal
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: test-construct
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: Package assets into gems for non-Rails applications.
+email: 
+- me@petebrowne.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Appraisals
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- gemfiles/sprockets-2.0.gemfile
+- gemfiles/sprockets-2.0.gemfile.lock
+- gemfiles/sprockets-2.1.gemfile
+- gemfiles/sprockets-2.1.gemfile.lock
+- gemfiles/sprockets-2.2.gemfile
+- gemfiles/sprockets-2.2.gemfile.lock
+- lib/sprockets-plugin.rb
+- lib/sprockets/plugin.rb
+- lib/sprockets/plugin/aware.rb
+- lib/sprockets/plugin/version.rb
+- spec/spec_helper.rb
+- spec/sprockets-plugin_spec.rb
+- sprockets-plugin.gemspec
+homepage: https://github.com/petebrowne/sprockets-plugin
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3383115453657503844
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3383115453657503844
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: sprockets-plugin
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: Package assets into gems for non-Rails applications.
+test_files: 
+- spec/spec_helper.rb
+- spec/sprockets-plugin_spec.rb