sprockets-sass 0.3.0 → 0.4.0

data/README.md

@@ -16,6 +16,7 @@ _Note: This works in Rails 3.1, thanks to the [sass-rails gem](http://github.com
   Directives from within imported files also work as expected.
 * Automatic integration with Compass.
 * Supports glob imports, like sass-rails.
+* Asset path Sass functions. **New in 0.4!**
 
 
 Installation
@@ -126,6 +127,44 @@ button {
 }
 ```
 
+
+Asset Path Sass Functions
+-------------------------
+
+As of version 0.4.0, asset path helpers have been added. Here's a quick guide to using them in your application (look at [sprockets-helpers](https://github.com/petebrowne/sprockets-helpers) for more information):
+
+``` ruby
+map "/assets" do
+  environment = Sprockets::Environment.new
+  environment.append_path "assets/stylesheets"
+  
+  Sprockets::Helpers.configure do |config|
+    config.environment = environment
+    config.prefix      = "/assets"
+    config.digest      = false
+  end
+  
+  run environment
+end
+
+# etc...
+```
+
+The Sass functions are based on the ones in sass-rails. So there is a `-path` and `-url` version of each helper:
+
+``` scss
+background: url(asset-path("logo.jpg")); // background: url("/assets/logo.jpg");
+background: asset-url("logo.jpg");       // background: url("/assets/logo.jpg");
+```
+
+The API of the functions mimics the helpers provided by sprockets-helpers, using Sass keyword arguments as options:
+
+``` scss
+background: asset-url("logo.jpg", $digest: true);               // background: url("background: url("/assets/logo-27a8f1f96afd8d4c67a59eb9447f45bd.jpg");
+background: asset-url("logo", $prefix: "/themes", $ext: "jpg"); // background: url("background: url("/themes/logo.jpg");
+```
+
+
 Copyright
 ---------
 

data/lib/sprockets/sass.rb

@@ -12,7 +12,18 @@ module Sprockets
       @options ||= {}
     end
   end
-    
+  
+  # Register the new templates
   register_engine ".sass", Sass::SassTemplate
   register_engine ".scss", Sass::ScssTemplate
+  
+  # Attempt to add the Sass Functions
+  begin
+    require "sass"
+    require "sprockets/sass/functions"
+  rescue LoadError
+    # fail silently...
+  end
 end
+
+

data/lib/sprockets/sass/functions.rb

@@ -0,0 +1,80 @@
+require "sass"
+require "sprockets-helpers"
+
+module Sass
+  module Script
+    module Functions
+      # Using Sprockets::Helpers#asset_path, return the full path
+      # for the given +source+ as a Sass String. This supports keyword
+      # arguments that mirror the +options+.
+      #
+      # === Examples
+      #
+      #   background: url(asset-path("image.jpg"));                // background: url("/assets/image.jpg");
+      #   background: url(asset-path("image.jpg", $digest: true)); // background: url("/assets/image-27a8f1f96afd8d4c67a59eb9447f45bd.jpg");
+      #
+      def asset_path(source, options = {})
+        Script::String.new context.asset_path(source.value, map_options(options)), :string
+      end
+      declare :asset_path, [:source], :var_kwargs => true
+      
+      # Using Sprockets::Helpers#asset_path, return the url CSS
+      # for the given +source+ as a Sass String. This supports keyword
+      # arguments that mirror the +options+.
+      #
+      # === Examples
+      #
+      #   background: asset-url("image.jpg");                // background: url("/assets/image.jpg");
+      #   background: asset-url("image.jpg", $digest: true); // background: url("/assets/image-27a8f1f96afd8d4c67a59eb9447f45bd.jpg");
+      #
+      def asset_url(source, options = {})
+        Script::String.new "url(#{asset_path(source, options)})"
+      end
+      declare :asset_url, [:source], :var_kwargs => true
+      
+      # Using Sprockets::Helpers#image_path, return the full path
+      # for the given +source+ as a Sass String. This supports keyword
+      # arguments that mirror the +options+.
+      #
+      # === Examples
+      #
+      #   background: url(image-path("image.jpg"));                // background: url("/assets/image.jpg");
+      #   background: url(image-path("image.jpg", $digest: true)); // background: url("/assets/image-27a8f1f96afd8d4c67a59eb9447f45bd.jpg");
+      #
+      def image_path(source, options = {})
+        Script::String.new context.image_path(source.value, map_options(options)), :string
+      end
+      declare :image_path, [:source], :var_kwargs => true
+      
+      # Using Sprockets::Helpers#image_path, return the url CSS
+      # for the given +source+ as a Sass String. This supports keyword
+      # arguments that mirror the +options+.
+      #
+      # === Examples
+      #
+      #   background: asset-url("image.jpg");                // background: url("/assets/image.jpg");
+      #   background: asset-url("image.jpg", $digest: true); // background: url("/assets/image-27a8f1f96afd8d4c67a59eb9447f45bd.jpg");
+      #
+      def image_url(source, options = {})
+        Script::String.new "url(#{image_path(source, options)})"
+      end
+      declare :image_url, [:source], :var_kwargs => true
+      
+      protected
+      
+      # Returns a reference to the Sprocket's context through
+      # the importer.
+      def context # :nodoc:
+        options[:importer].context
+      end
+      
+      # Returns an options hash where the keys are symbolized
+      # and the values are unwrapped Sass literals.
+      def map_options(options = {}) # :nodoc:
+        Sass::Util.map_hash(options) do |key, value|
+          [key.to_sym, value.respond_to?(:value) ? value.value : value]
+        end
+      end
+    end
+  end
+end

data/lib/sprockets/sass/importer.rb

@@ -81,10 +81,18 @@ module Sprockets
       # we make Sprockets behave like Sass, and import partial
       # style paths.
       def resolve(path)
-        path    = Pathname.new(path) unless path.is_a?(Pathname)
-        partial = path.dirname.join("_#{path.basename}")
+        path = Pathname.new(path) unless path.is_a?(Pathname)
         
-        resolve_path(path) || resolve_path(partial)
+        # First look for the normal path
+        context.resolve(path) { |found| return found }
+        
+        # Then look for the partial-style version
+        unless path.basename.to_s =~ /^_/
+          partial = path.dirname.join "_#{path.basename}"
+          context.resolve(partial) { |found| return found }
+        end
+        
+        nil
       end
       
       # Finds all of the assets using the given glob.
@@ -97,13 +105,6 @@ module Sprockets
         end
       end
       
-      # Finds the asset using the context from Sprockets.
-      def resolve_path(path)
-        context.resolve path, :content_type => :self
-      rescue ::Sprockets::FileNotFound, ::Sprockets::ContentTypeMismatch
-        nil
-      end
-      
       # Returns the Sass syntax of the given path.
       def syntax(path)
         path.to_s.include?(".sass") ? :sass : :scss

data/lib/sprockets/sass/sass_template.rb

@@ -8,6 +8,12 @@ module Sprockets
       # A reference to the current Sprockets context
       attr_reader :context
       
+      # Add the Sass functions if they haven't already been added.
+      def initialize_engine
+        super
+        require_template_library "sprockets/sass/functions"
+      end
+      
       # Define the expected syntax for the template
       def syntax
         :sass

data/lib/sprockets/sass/version.rb

@@ -1,5 +1,5 @@
 module Sprockets
   module Sass
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/spec/sprockets-sass_spec.rb

@@ -115,10 +115,10 @@ describe Sprockets::Sass do
   end
   
   it "works with the Compass framework" do
-    @assets.file "main.css.scss", %(@import "compass/typography/text/nowrap";\np { @include nowrap; })
+    @assets.file "main.css.scss", %(@import "compass/css3";\nbutton { @include border-radius(5px); })
     
     asset = @env["main.css"]
-    asset.to_s.should == "p {\n  white-space: nowrap; }\n"
+    asset.to_s.should include("border-radius: 5px;")
   end
   
   it "imports globbed files" do
@@ -172,4 +172,30 @@ describe Sprockets::Sass do
     
     asset.should be_stale
   end
+  
+  it "adds the #asset_path helper" do
+    @assets.file "asset_path.css.scss", %(body { background: url(asset-path("image.jpg")); })
+    @assets.file "asset_url.css.scss", %(body { background: asset-url("image.jpg"); })
+    @assets.file "asset_path_options.css.scss", %(body { background: url(asset-path("image.jpg", $digest: true, $prefix: "/themes")); })
+    @assets.file "asset_url_options.css.scss", %(body { background: asset-url("image.jpg", $digest: true, $prefix: "/themes"); })
+    @assets.file "image.jpg"
+    
+    @env["asset_path.css"].to_s.should == %(body {\n  background: url("/assets/image.jpg"); }\n)
+    @env["asset_url.css"].to_s.should == %(body {\n  background: url("/assets/image.jpg"); }\n)
+    @env["asset_path_options.css"].to_s.should =~ %r(body \{\n  background: url\("/themes/image-[0-9a-f]+.jpg"\); \}\n)
+    @env["asset_url_options.css"].to_s.should =~ %r(body \{\n  background: url\("/themes/image-[0-9a-f]+.jpg"\); \}\n)
+  end
+  
+  it "adds the #image_path helper" do
+    @assets.file "image_path.css.scss", %(body { background: url(image-path("image.jpg")); })
+    @assets.file "image_url.css.scss", %(body { background: image-url("image.jpg"); })
+    @assets.file "image_path_options.css.scss", %(body { background: url(image-path("image.jpg", $digest: true, $prefix: "/themes")); })
+    @assets.file "image_url_options.css.scss", %(body { background: image-url("image.jpg", $digest: true, $prefix: "/themes"); })
+    @assets.file "image.jpg"
+    
+    @env["image_path.css"].to_s.should == %(body {\n  background: url("/assets/image.jpg"); }\n)
+    @env["image_url.css"].to_s.should == %(body {\n  background: url("/assets/image.jpg"); }\n)
+    @env["image_path_options.css"].to_s.should =~ %r(body \{\n  background: url\("/themes/image-[0-9a-f]+.jpg"\); \}\n)
+    @env["image_url_options.css"].to_s.should =~ %r(body \{\n  background: url\("/themes/image-[0-9a-f]+.jpg"\); \}\n)
+  end
 end

data/sprockets-sass.gemspec

@@ -18,10 +18,12 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   
-  s.add_dependency "sprockets", "~> 2.0"
-  s.add_development_dependency "rake"
-  s.add_development_dependency "rspec", "~> 2.6"
+  s.add_dependency "sprockets",                  "~> 2.0"
+  s.add_dependency "sprockets-helpers",          "~> 0.1"
+  s.add_dependency "tilt",                       "~> 1.1"
+  s.add_development_dependency "rspec",          "~> 2.6"
   s.add_development_dependency "test-construct", "~> 1.2"
-  s.add_development_dependency "sass", "~> 3.1"
-  s.add_development_dependency "compass", "0.11"
+  s.add_development_dependency "sass",           "~> 3.1"
+  s.add_development_dependency "compass",        "~> 0.11"
+  s.add_development_dependency "rake"
 end

metadata

@@ -2,7 +2,7 @@
 name: sprockets-sass
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Pete Browne
@@ -10,11 +10,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-01 00:00:00 Z
+date: 2011-11-02 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: sprockets
-  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -22,62 +21,85 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "2.0"
   type: :runtime
+  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rake
-  prerelease: false
+  name: sprockets-helpers
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: "0"
-  type: :development
+        version: "0.1"
+  type: :runtime
+  prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rspec
-  prerelease: false
+  name: tilt
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.1"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         version: "2.6"
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: test-construct
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         version: "1.2"
   type: :development
-  version_requirements: *id004
+  prerelease: false
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: sass
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         version: "3.1"
   type: :development
-  version_requirements: *id005
+  prerelease: false
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: compass
-  prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
         version: "0.11"
   type: :development
-  version_requirements: *id006
+  prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id008
 description: When using Sprockets 2.0 with Sass you will eventually run into a pretty big issue. `//= require` directives will not allow Sass mixins, variables, etc. to be shared between files. So you'll try to use `@import`, and that'll also blow up in your face. `sprockets-sass` fixes all of this by creating a Sass::Importer that is Sprockets aware.
 email: 
 - me@petebrowne.com
@@ -95,6 +117,7 @@ files:
 - Rakefile
 - lib/sprockets-sass.rb
 - lib/sprockets/sass.rb
+- lib/sprockets/sass/functions.rb
 - lib/sprockets/sass/importer.rb
 - lib/sprockets/sass/sass_template.rb
 - lib/sprockets/sass/scss_template.rb
@@ -115,12 +138,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 2155872013882302780
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 2155872013882302780
+      segments: 
+      - 0
       version: "0"
 requirements: []