sprockets-helpers 0.1.0 → 0.2.0

data/README.md

@@ -43,18 +43,22 @@ class App < Sinatra::Base
     sprockets.append_path File.join(root, "assets", "images")
     
     # Configure Sprockets::Helpers (if necessary)
-    Sprockets::Helpers.prefix      = assets_prefix
-    Sprockets::Helpers.digest      = digest_assets
-    Sprockets::Helpers.public_path = public_folder
+    Sprockets::Helpers.configure do |config|
+      config.environment = sprockets
+      config.prefix      = assets_prefix
+      config.digest      = digest_assets
+      config.public_path = public_folder
+    end
   end
   
   helpers do
     include Sprockets::Helpers
     
-    # required for Sprockets::Helpers to work!
-    def environment
-      settings.sprockets
-    end
+    # Alternative method for telling Sprockets::Helpers which
+    # Sprockets environment to use.
+    # def assets_environment
+    #   settings.sprockets
+    # end
   end
   
   get "/" do
@@ -83,7 +87,7 @@ var Paths = { railsImage: "/assets/rails.png" };
 Usage in the App
 ----------------
 
-The helpers can also be used in the app itself. You just include the `Sprockets::Helpers` module and add an `#environment` method which returns a reference to the Sprockets environment (see the Sinatra app setup above).
+The helpers can also be used in the app itself. You just include the `Sprockets::Helpers` module and set Sprockets::Helpers.environment to the Sprockets environment to search for the assets. Alternatively you can define an #assets_environment method in the context of #asset_path, which returns a reference to the Sprockets environment (see above).
 
 Now the following index file:
 

data/lib/sprockets/helpers.rb

@@ -13,6 +13,10 @@ module Sprockets
       # When true, the asset paths will return digest paths.
       attr_accessor :digest
       
+      # Set the Sprockets environment to search for assets.
+      # This defaults to the context's #environment method.
+      attr_accessor :environment
+      
       # The base URL the Sprocket environment is mapped to.
       # This defaults to "/assets".
       def prefix
@@ -27,6 +31,11 @@ module Sprockets
         @public_path ||= "./public"
       end
       attr_writer :public_path
+      
+      # Convience method for configuring Sprockets::Helpers.
+      def configure
+        yield self
+      end
     end
     
     # Returns the path to an asset either in the Sprockets environment
@@ -38,7 +47,7 @@ module Sprockets
     # * <tt>:dir</tt> - The directory to prepend if the file is in the public directory.
     # * <tt>:digest</tt> - Wether or not use the digest paths for assets. Set Sprockets::Helpers.digest for global configuration.
     # * <tt>:prefix</tt> - Use a custom prefix for the Sprockets environment. Set Sprockets::Helpers.prefix for global configuration.
-    #
+    # * <tt>:body</tt> - Adds a ?body=1 flag that tells Sprockets to return only the body of the asset.
     #
     # ==== Examples
     #
@@ -68,8 +77,8 @@ module Sprockets
         
       # If the source points to an asset in the Sprockets
       # environment use AssetPath to generate the full path.
-      environment.resolve(source) do |path|
-        return AssetPath.new(environment.find_asset(path), options).to_s
+      assets_environment.resolve(source) do |path|
+        return AssetPath.new(assets_environment[path], options).to_s
       end
       
       # Use FilePath for normal files on the file system
@@ -146,6 +155,16 @@ module Sprockets
     def image_path(source, options = {})
       asset_path source, { :dir => "images" }.merge(options)
     end
+    
+    protected
+    
+    # Returns the Sprockets environment #asset_path uses to search for
+    # assets. This can be overridden for more control, if necessary.
+    # Defaults to Sprockets::Helpers.environment or the envrionment
+    # returned by #environment.
+    def assets_environment
+      Helpers.environment || environment
+    end
   end
   
   class Context

data/lib/sprockets/helpers/version.rb

@@ -1,5 +1,5 @@
 module Sprockets
   module Helpers
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/spec/sprockets-helpers_spec.rb

@@ -1,6 +1,76 @@
 require "spec_helper"
 
 describe Sprockets::Helpers do
+  describe ".configure" do
+    it "sets global configuration" do
+      within_construct do |c|
+        c.file "assets/main.css"
+        
+        context.asset_path("main.css").should == "/assets/main.css"
+        Sprockets::Helpers.configure do |config|
+          config.digest = true
+          config.prefix = "/themes"
+        end
+        context.asset_path("main.css").should =~ %r(/themes/main-[0-9a-f]+.css)
+        Sprockets::Helpers.digest = nil
+        Sprockets::Helpers.prefix = nil
+      end
+    end
+  end
+  
+  describe ".digest" do
+    it "globally configures digest paths" do
+      within_construct do |c|
+        c.file "assets/main.js"
+        
+        context.asset_path("main", :ext => "js").should == "/assets/main.js"
+        Sprockets::Helpers.digest = true
+        context.asset_path("main", :ext => "js").should =~ %r(/assets/main-[0-9a-f]+.js)
+        Sprockets::Helpers.digest = nil
+      end
+    end
+  end
+  
+  describe ".environment" do
+    it "sets a custom assets environment" do
+      within_construct do |c|
+        c.file "themes/main.css"
+        
+        custom_env = Sprockets::Environment.new
+        custom_env.append_path "themes"
+        Sprockets::Helpers.environment = custom_env
+        context.asset_path("main.css").should == "/assets/main.css"
+        Sprockets::Helpers.environment = nil
+      end
+    end
+  end
+  
+  describe ".prefix" do
+    it "sets a custom assets prefix" do
+      within_construct do |c|
+        c.file "assets/logo.jpg"
+        
+        context.asset_path("logo.jpg").should == "/assets/logo.jpg"
+        Sprockets::Helpers.prefix = "/images"
+        context.asset_path("logo.jpg").should == "/images/logo.jpg"
+        Sprockets::Helpers.prefix = nil
+      end
+    end
+  end
+  
+  describe ".public_path" do
+    it "sets a custom location for the public path" do
+      within_construct do |c|
+        c.file "output/main.js"
+        
+        context.asset_path("main.js").should == "/main.js"
+        Sprockets::Helpers.public_path = "./output"
+        context.asset_path("main.js").should =~ %r(/main.js\?\d+)
+        Sprockets::Helpers.public_path = nil
+      end
+    end
+  end
+  
   describe "#asset_path" do
     context "with URIs" do
       it "returns URIs untouched" do
@@ -32,8 +102,8 @@ describe Sprockets::Helpers do
       
       it "appends a timestamp if the file exists in the output path" do
         within_construct do |c|
-          file1 = c.file "public/main.js"
-          file2 = c.file "public/favicon.ico"
+          c.file "public/main.js"
+          c.file "public/favicon.ico"
           
           context.asset_path("main", :ext => "js").should =~ %r(/main.js\?\d+)
           context.asset_path("/favicon.ico").should =~ %r(/favicon.ico\?\d+)
@@ -60,9 +130,6 @@ describe Sprockets::Helpers do
           
           context.asset_path("logo.jpg").should == "/assets/logo.jpg"
           context.asset_path("logo.jpg", :prefix => "/images").should == "/images/logo.jpg"
-          Sprockets::Helpers.prefix = "/images"
-          context.asset_path("logo.jpg").should == "/images/logo.jpg"
-          Sprockets::Helpers.prefix = "/assets"
         end
       end
       
@@ -72,9 +139,6 @@ describe Sprockets::Helpers do
           
           context.asset_path("main", :ext => "js").should == "/assets/main.js"
           context.asset_path("main", :ext => "js", :digest => true).should =~ %r(/assets/main-[0-9a-f]+.js)
-          Sprockets::Helpers.digest = true
-          context.asset_path("main", :ext => "js").should =~ %r(/assets/main-[0-9a-f]+.js)
-          Sprockets::Helpers.digest = false
         end
       end
       

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sprockets-helpers
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Pete Browne
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-31 00:00:00 Z
+date: 2011-11-01 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement