sprockets-sass 0.1.0

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+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,102 @@
+sprockets-sass
+==============
+
+**Better Sass integration with [Sprockets 2.0](http://github.com/sstephenson/sprockets)**
+
+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.
+
+_Note: This works in Rails 3.1, thanks to the [sass-rails gem](http://github.com/rails/sass-rails). But if you want to use Sprockets and Sass anywhere else, like Sinatra, use `sprockets-sass`._
+
+### Features
+
+* Imports Sass _partials_ (filenames prepended with "_").
+* Import paths work exactly like `require` directives*.
+* Imports either Sass syntax, or just regular CSS files.
+* Imported files are preprocessed by Sprockets, so `.css.scss.erb` files can be imported.
+  Directives from within imported files also work as expected.
+* Standard Sass load paths are not touched, so Compass extensions will work as expected.
+
+_* Glob support coming in 0.2.0_
+
+### TODO
+
+* Glob support (as mentioned above)
+* Asset path helpers
+
+
+Installation
+------------
+
+``` bash
+$ gem install sprockets-sass
+```
+
+
+Usage
+-----
+
+In your Rack application, setup Sprockets as you normally would, and require "sprockets-sass":
+
+``` ruby
+require "sprockets"
+require "sprockets-sass"
+require "sass"
+
+map "/assets" do
+  environment = Sprockets::Environment.new
+  environment.append_path "assets/stylesheets"
+  run environment
+end
+
+map "/" do
+  run YourRackApp
+end
+```
+
+Now `@import` works essentially just like a `require` directive, but with one essential bonus:
+Sass mixins, variables, etc. work as expected.
+
+Given the following Sass _partials_:
+
+``` scss
+// assets/stylesheets/_mixins.scss
+@mixin border-radius($radius) {
+  -webkit-border-radius: $radius;
+  -moz-border-radius: $radius;
+  border-radius: $radius;
+}
+```
+
+``` scss
+// assets/stylesheets/_settings.scss
+$color: red;
+```
+
+In another file - you can now do this - from within a Sprockets asset:
+
+``` scss
+// assets/stylesheets/application.css.scss
+@import "mixins";
+@import "settings";
+
+button {
+  @include border-radius(5px);
+  color: $color;
+}
+```
+
+And `GET /assets/application.css` would return something like:
+
+``` css
+button {
+  -webkit-border-radius: 5px;
+  -moz-border-radius: 5px;
+  border-radius: 5px;
+  color: red; }
+```
+
+
+Copyright
+---------
+
+Copyright (c) 2011 [Peter Browne](http://petebrowne.com). See LICENSE for details.

data/Rakefile

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

data/lib/sprockets-sass.rb

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

data/lib/sprockets/sass.rb

@@ -0,0 +1,13 @@
+require "sprockets/sass/version"
+require "sprockets/sass/sass_template"
+require "sprockets/sass/scss_template"
+require "sprockets/engines"
+
+module Sprockets
+  module Sass
+    autoload :Importer, "sprockets/sass/importer"
+    
+    ::Sprockets.register_engine ".sass", SassTemplate
+    ::Sprockets.register_engine ".scss", ScssTemplate
+  end
+end

data/lib/sprockets/sass/importer.rb

@@ -0,0 +1,91 @@
+require "sass/importers/base"
+require "pathname"
+
+module Sprockets
+  module Sass
+    class Importer < ::Sass::Importers::Base
+      # Reference to the Sprockets context
+      attr_reader :context
+      
+      # 
+      def initialize(context)
+        @context = context
+      end
+      
+      # @see Sass::Importers::Base#find_relative
+      def find_relative(path, base, options)
+        engine_from_path(path, options)
+      end
+      
+      # @see Sass::Importers::Base#find
+      def find(path, options)
+        engine_from_path(path, options)
+      end
+
+      # @see Sass::Importers::Base#mtime
+      def mtime(path, options)
+        if pathname = resolve(path)
+          pathname.mtime
+        end
+      rescue Errno::ENOENT
+        nil
+      end
+
+      # @see Sass::Importers::Base#key
+      def key(path, options)
+        path = Pathname.new(path)
+        ["#{self.class.name}:#{path.dirname.expand_path}", path.basename]
+      end
+
+      # @see Sass::Importers::Base#to_s
+      def to_s
+        "#{self.class.name}:#{context.pathname}"
+      end
+      
+      protected
+      
+      # Create a Sass::Engine from the given path.
+      # This is where all the magic happens!
+      def engine_from_path(path, options)
+        pathname = resolve(path) or return nil
+        context.depend_on pathname
+        ::Sass::Engine.new evaluate(pathname), options.merge(
+          :filename => pathname.to_s,
+          :syntax   => syntax(pathname),
+          :importer => self
+        )
+      end
+      
+      # Finds an asset from the given path. This is where
+      # 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}")
+        
+        resolve_asset(path) || resolve_asset(partial)
+      end
+      
+      # Finds the asset using the context from Sprockets.
+      def resolve_asset(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
+      end
+      
+      # Returns the string to be passed to the Sass engine. We use
+      # Sprockets to process the file, but we remove any Sass processors
+      # because we need to let the Sass::Engine handle that.
+      def evaluate(path)
+        processors = context.environment.attributes_for(path).processors.dup
+        processors.delete_if { |processor| processor < Tilt::SassTemplate }
+        context.evaluate path, :processors => processors
+      end
+    end
+  end
+end

data/lib/sprockets/sass/sass_template.rb

@@ -0,0 +1,43 @@
+require "tilt"
+
+module Sprockets
+  module Sass
+    class SassTemplate < Tilt::SassTemplate
+      
+      # A reference to the current Sprockets context
+      attr_reader :context
+      
+      # Define the expected syntax for the template
+      def syntax
+        :sass
+      end
+      
+      def prepare
+        @context = nil
+        @output  = nil
+      end
+      
+      def evaluate(context, locals, &block)
+        @output ||= begin
+          @context = context
+          ::Sass::Engine.new(data, sass_options).render
+        end
+      end
+
+      private
+      
+      def sass_options
+        options.merge(
+          :filename => eval_file,
+          :line     => line,
+          :syntax   => syntax,
+          :importer => importer
+        )
+      end
+      
+      def importer
+        Importer.new context
+      end
+    end
+  end
+end

data/lib/sprockets/sass/scss_template.rb

@@ -0,0 +1,10 @@
+module Sprockets
+  module Sass
+    class ScssTemplate < SassTemplate
+      # Define the expected syntax for the template
+      def syntax
+        :scss
+      end
+    end
+  end
+end

data/lib/sprockets/sass/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require "sprockets"
+require "sprockets-sass"
+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|
+  config.include Construct::Helpers
+end

data/spec/sprockets-sass_spec.rb

@@ -0,0 +1,112 @@
+require "spec_helper"
+
+describe Sprockets::Sass do
+  before :each do
+    @root   = create_construct
+    @assets = @root.directory "assets"
+    @env    = Sprockets::Environment.new @root.to_s
+    @env.append_path @assets.to_s
+  end
+  
+  after :each do
+    @root.destroy!
+  end
+  
+  it "processes scss files normally" do
+    @assets.file "main.css.scss", "//= require dep"
+    @assets.file "dep.css.scss", "body { color: blue; }"
+    asset = @env["main.css.scss"]
+    asset.to_s.should == "body {\n  color: blue; }\n"
+  end
+  
+  it "processes sass files normally" do
+    @assets.file "main.css.sass", "//= require dep"
+    @assets.file "dep.css.sass", "body\n  color: blue"
+    asset = @env["main.css.sass"]
+    asset.to_s.should == "body {\n  color: blue; }\n"
+  end
+  
+  it "imports standard files" do
+    @assets.file "main.css.scss", %(@import "dep";\nbody { color: $color; })
+    @assets.file "dep.css.scss", "$color: blue;"
+    asset = @env["main.css.scss"]
+    asset.to_s.should == "body {\n  color: blue; }\n"
+  end
+  
+  it "imports partial style files" do
+    @assets.file "main.css.scss", %(@import "dep";\nbody { color: $color; })
+    @assets.file "_dep.css.scss", "$color: blue;"
+    asset = @env["main.css.scss"]
+    asset.to_s.should == "body {\n  color: blue; }\n"
+  end
+  
+  it "imports other syntax" do
+    @assets.file "main.css.scss", %(@import "dep";\nbody { color: $color; })
+    @assets.file "dep.css.sass", "$color: blue\nhtml\n  height: 100%"
+    asset = @env["main.css.scss"]
+    asset.to_s.should == "html {\n  height: 100%; }\n\nbody {\n  color: blue; }\n"
+  end
+  
+  it "imports files with directives" do
+    @assets.file "main.css.scss", %(@import "dep";)
+    @assets.file "dep.css", "/*\n *= require subdep\n */"
+    @assets.file "subdep.css.scss", "$color: blue;\nbody { color: $color; }"
+    asset = @env["main.css.scss"]
+    asset.to_s.should include("body {\n  color: blue; }\n")
+  end
+  
+  it "imports files with additional processors" do
+    @assets.file "main.css.scss", %(@import "dep";\nbody { color: $color; })
+    @assets.file "dep.css.scss.erb", "$color: <%= 'blue' %>;"
+    asset = @env["main.css.scss"]
+    asset.to_s.should == "body {\n  color: blue; }\n"
+  end
+  
+  it "imports relative files" do
+    @assets.file "folder/main.css.scss", %(@import "./dep";\nbody { color: $color; })
+    @assets.file "folder/dep.css.scss", "$color: blue;"
+    asset = @env["folder/main.css.scss"]
+    asset.to_s.should == "body {\n  color: blue; }\n"
+  end
+  
+  it "imports files relative to root" do
+    @assets.file "folder/main.css.scss", %(@import "dep";\nbody { color: $color; })
+    @assets.file "dep.css.scss", "$color: blue;"
+    asset = @env["folder/main.css.scss"]
+    asset.to_s.should == "body {\n  color: blue; }\n"
+  end
+  
+  it "imports files from the assets load path" do
+    vendor = @root.directory "vendor"
+    @env.append_path vendor.to_s
+    
+    @assets.file "main.css.scss", %(@import "dep";\nbody { color: $color; })
+    vendor.file "dep.css.scss", "$color: blue;"
+    asset = @env["main.css.scss"]
+    asset.to_s.should == "body {\n  color: blue; }\n"
+  end
+  
+  it "imports files from the Sass load path" do
+    vendor = @root.directory "vendor"
+    Sass::Engine::DEFAULT_OPTIONS[:load_paths] << vendor.to_s
+    
+    @assets.file "main.css.scss", %(@import "dep";\nbody { color: $color; })
+    vendor.file "dep.scss", "$color: blue;"
+    asset = @env["main.css.scss"]
+    asset.to_s.should == "body {\n  color: blue; }\n"
+  end
+
+  it "adds dependency when imported" do
+    @assets.file "main.css.scss", %(@import "dep";\nbody { color: $color; })
+    dep = @assets.file "dep.css.scss", "$color: blue;"
+    
+    asset = @env["main.css.scss"]
+    asset.should be_fresh
+    
+    mtime = Time.now + 1
+    dep.open("w") { |f| f.write "$color: red;" }
+    dep.utime mtime, mtime
+    
+    asset.should be_stale
+  end
+end

data/sprockets-sass.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "sprockets/sass/version"
+
+Gem::Specification.new do |s|
+  s.name        = "sprockets-sass"
+  s.version     = Sprockets::Sass::VERSION
+  s.authors     = ["Pete Browne"]
+  s.email       = ["me@petebrowne.com"]
+  s.homepage    = "http://github.com/petebrowne/sprockets-sass"
+  s.summary     = %q{Better Sass integration with Sprockets 2.0}
+  s.description = %q{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.}
+
+  s.rubyforge_project = "sprockets-sass"
+
+  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_dependency "sprockets", "~> 2.0"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec", "~> 2.6"
+  s.add_development_dependency "test-construct", "~> 1.2"
+  s.add_development_dependency "sass", "~> 3.1"
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification 
+name: sprockets-sass
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Pete Browne
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-21 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  requirement: *id001
+  name: sprockets
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+  name: rake
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
+  requirement: *id003
+  name: rspec
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 2
+        version: "1.2"
+  requirement: *id004
+  name: test-construct
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        - 1
+        version: "3.1"
+  requirement: *id005
+  name: sass
+  prerelease: false
+  type: :development
+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
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sprockets-sass.rb
+- lib/sprockets/sass.rb
+- lib/sprockets/sass/importer.rb
+- lib/sprockets/sass/sass_template.rb
+- lib/sprockets/sass/scss_template.rb
+- lib/sprockets/sass/version.rb
+- spec/spec_helper.rb
+- spec/sprockets-sass_spec.rb
+- sprockets-sass.gemspec
+homepage: http://github.com/petebrowne/sprockets-sass
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: sprockets-sass
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Better Sass integration with Sprockets 2.0
+test_files: 
+- spec/spec_helper.rb
+- spec/sprockets-sass_spec.rb