sass-rails 3.1.0.rc.1 → 3.1.0.rc.2

data/Gemfile

@@ -3,11 +3,10 @@ source "http://rubygems.org"
 # Specify your gem's dependencies in sass-rails.gemspec
 gemspec
 
-gem "rails", :path => "~/Code/cool_stuff/rails"
-gem "capybara", ">= 0.4.0"
-gem "sqlite3"
+gem "rails", :git => "git://github.com/rails/rails.git", :branch => "3-1-stable"
+gem "sprockets"
 
 # To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
 # gem 'ruby-debug'
-gem 'ruby-debug19'
+# gem 'ruby-debug19'
 

data/README.markdown

@@ -0,0 +1,52 @@
+# Official Ruby-on-Rails Integration with Sass
+
+This gem provides official integration for ruby on rails projects with the Sass stylesheet language.
+
+## Installing
+
+Since rails 3.1, new rails projects will be already configured to use Sass. If you are upgrading to rails 3.1 you will need to add the following to your Gemfile:
+
+    gem 'sass-rails'
+
+## Configuration
+
+To configure Sass via rails set use `config.sass` in your
+application and/or environment files to set configuration
+properties that will be passed to Sass.
+
+### Example
+
+    MyProject::Application.configure do
+      config.sass.line_comments = false
+      config.sass.syntax = :nested
+    end
+
+### Options
+
+The [list of supported options](http://sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html#options) can be found on the Sass Website with the following  caveats:
+
+1. Output compression is now controlled via the `config.assets.compress` boolean option instead of through the `:style` option.
+2. `:never_update` - This option is not supported. Instead set `config.assets.enabled = false`
+3. `:always_update` - This option is not supported. Sprockets uses a controller to access stylesheets in development mode instead of a full scan for changed files.
+4. `:always_check` - This option is not supported. Sprockets always checks in development.
+5. `:syntax` - This is determined by the file's extensions.
+6. `:filename` - This is determined by the file's name.
+7. `:line` - This is provided by the template handler.
+
+## Features
+
+* **Glob Imports**. When in rails, there is a special import syntax that allows you to
+  glob imports relative to the folder of the stylesheet that is doing the importing.
+  E.g. `@import "mixins/*"` will import all the files in the mixins folder and
+  `@import "mixins/**/*"` will import all the files in the mixins tree.
+  Any valid ruby glob may be used. The imports are sorted alphabetically.
+  **NOTE:** It is recommended that you only use this when importing pure library
+  files (containing mixins and variables) because it is difficult to control the
+  cascade ordering for imports that contain styles using this approach.
+
+## Running Tests
+
+    $ bundle install
+    $ bundle exec rake test
+
+If you need to test against local gems, use Bundler's gem :path option in the Gemfile and also edit `test/support/test_helper.rb` and tell the tests where the gem is checked out.

data/lib/rails/generators/sass/assets/assets_generator.rb

@@ -6,7 +6,7 @@ module Sass
       source_root File.expand_path("../templates", __FILE__)
 
       def copy_sass
-        copy_file "stylesheet.css.sass", File.join('app/assets/stylesheets', class_path, "#{file_name}.css.sass")
+        template "stylesheet.css.sass", File.join('app/assets/stylesheets', class_path, "#{file_name}.css.sass")
       end
     end
   end

data/lib/rails/generators/sass/assets/templates/stylesheet.css.sass

@@ -1,3 +1,6 @@
-// Place all the styles related to the matching controller here.
+// Place all the styles related to the <%= name %> controller here.
 // They will automatically be included in application.css.
 // You can use Sass here: http://sass-lang.com/
+
+body.<%= name.dasherize %>
+  // Place scoped styles here

data/lib/rails/generators/sass_scaffold.rb

@@ -7,7 +7,8 @@ module Sass
       def copy_stylesheet
         dir = ::Rails::Generators::ScaffoldGenerator.source_root
         file = File.join(dir, "scaffold.css")
-        create_file "app/assets/stylesheets/scaffold.css.#{syntax}", ::Sass::CSS.new(File.read(file)).render(syntax)
+        converted_contents = ::Sass::CSS.new(File.read(file)).render(syntax)
+        create_file "app/assets/stylesheets/scaffolds.css.#{syntax}", converted_contents
       end
     end
   end

data/lib/rails/generators/scss/assets/assets_generator.rb

@@ -6,7 +6,7 @@ module Scss
       source_root File.expand_path("../templates", __FILE__)
 
       def copy_scss
-        copy_file "stylesheet.css.scss", File.join('app/assets/stylesheets', class_path, "#{file_name}.css.scss")
+        template "stylesheet.css.scss", File.join('app/assets/stylesheets', class_path, "#{file_name}.css.scss")
       end
     end
   end

data/lib/rails/generators/scss/assets/templates/stylesheet.css.scss

@@ -1,3 +1,7 @@
-// Place all the styles related to the matching controller here.
+// Place all the styles related to the <%= name %> controller here.
 // They will automatically be included in application.css.
 // You can use Sass (SCSS) here: http://sass-lang.com/
+
+body.<%= name.dasherize %> {
+  // Place scoped styles here
+}

data/lib/sass-rails.rb

@@ -1,31 +1 @@
-module Sass
-  class CssCompressor
-    def compress(css)
-      Sass::Engine.new(css,
-                       :syntax => :scss,
-                       :cache => false,
-                       :read_cache => false,
-                       :style => :compressed).render
-    end
-  end
-
-  class Railtie < ::Rails::Railtie
-    config.sass = ActiveSupport::OrderedOptions.new
-    config.sass.syntax = :scss
-
-    initializer :setup_sass do |app|
-      syntax     = app.config.sass.syntax
-      alt_syntax = syntax.to_s == "sass" ? "scss" : "sass"
-
-      app.config.generators.hide_namespace alt_syntax
-      config.app_generators.stylesheet_engine app.config.sass.syntax
-    end
-
-    initializer :setup_compression do |app|
-      if app.config.assets.compress
-        app.config.assets.css_compressor = CssCompressor.new
-      end
-    end
-  end
-end
-
+require 'sass/rails'

data/lib/sass/rails.rb

@@ -0,0 +1,11 @@
+module Sass
+  module Rails
+  end
+end
+
+require 'sass/rails/compressor'
+require 'sass/rails/railtie'
+require 'sass/rails/monkey_patches'
+require 'sass/rails/importer'
+require 'sass/rails/template_handlers'
+require 'sass/rails/version'

data/lib/sass/rails/compressor.rb

@@ -0,0 +1,15 @@
+require 'sass'
+
+module Sass
+  module Rails
+    class CssCompressor
+      def compress(css)
+        Sass::Engine.new(css,
+                         :syntax => :scss,
+                         :cache => false,
+                         :read_cache => false,
+                         :style => :compressed).render
+      end
+    end
+  end
+end

data/lib/sass/rails/importer.rb

@@ -0,0 +1,128 @@
+require 'sprockets'
+
+module Sass::Rails
+  class Importer
+    GLOB = /\*|\[.+\]/
+    PARTIAL = /^_/
+    HAS_EXTENSION = /\.css(.s[ac]ss)?$/
+
+    SASS_EXTENSIONS = {
+      ".css.sass" => :sass,
+      ".css.scss" => :scss
+    }
+    attr_reader :context
+
+    def initialize(context)
+      @context = context
+    end
+
+    def sass_file?(filename)
+      filename = filename.to_s
+      SASS_EXTENSIONS.keys.any?{|ext| filename[ext]}
+    end
+
+    def syntax(filename)
+      filename = filename.to_s
+      SASS_EXTENSIONS.each {|ext, syntax| return syntax if filename[(ext.size+2)..-1][ext]}
+      nil
+    end
+
+    def resolve(name, base_pathname = nil)
+      name = Pathname.new(name)
+      if base_pathname && base_pathname.to_s.size > 0
+        name = base_pathname.dirname.relative_path_from(context.pathname.dirname).join(name)
+      end
+      partial_name = name.dirname.join("_#{name.basename}")
+      sprockets_resolve(name) || sprockets_resolve(partial_name)
+    end
+
+    def find_relative(name, base, options)
+      base_pathname = Pathname.new(base)
+      if name =~ GLOB
+        glob_imports(name, base_pathname, options)
+      elsif pathname = resolve(name, base_pathname)
+        context.depend_on(pathname)
+        if sass_file?(pathname)
+          Sass::Engine.new(pathname.read, options.merge(:filename => pathname.to_s, :importer => self, :syntax => syntax(pathname)))
+        else
+          Sass::Engine.new(sprockets_process(pathname), options.merge(:filename => pathname.to_s, :importer => self, :syntax => :scss))
+        end
+      else
+        nil
+      end
+    end
+
+    def find(name, options)
+      if name =~ GLOB
+        nil # globs must be relative
+      elsif pathname = resolve(name)
+        context.depend_on(pathname)
+        if sass_file?(pathname)
+          Sass::Engine.new(pathname.read, options.merge(:filename => pathname.to_s, :importer => self, :syntax => syntax(pathname)))
+        else
+          Sass::Engine.new(sprockets_process(pathname), options.merge(:filename => pathname.to_s, :importer => self, :syntax => :scss))
+        end
+      else
+        nil
+      end
+    end
+
+    def each_globbed_file(glob, base_pathname, options)
+      Dir["#{base_pathname.dirname}/#{glob}"].sort.each do |filename|
+        next if filename == options[:filename]
+        yield filename if File.directory?(filename) || context.asset_requirable?(filename)
+      end
+    end
+
+    def glob_imports(glob, base_pathname, options)
+      contents = ""
+      each_globbed_file(glob, base_pathname, options) do |filename|
+        if File.directory?(filename)
+          context.depend_on(filename)
+        elsif context.asset_requirable?(filename)
+          context.depend_on(filename)
+          contents << "@import #{Pathname.new(filename).relative_path_from(base_pathname.dirname).to_s.inspect};\n"
+        end
+      end
+      return nil if contents.empty?
+      Sass::Engine.new(contents, options.merge(
+        :filename => base_pathname.to_s,
+        :importer => self,
+        :syntax => :scss
+      ))
+    end
+
+    def mtime(name, options)
+      if name =~ GLOB && options[:filename]
+        mtime = nil
+        each_globbed_file(name, Pathname.new(options[:filename]), options) do |p|
+          mtime ||= File.mtime(p)
+          mtime = [mtime, File.mtime(p)].max
+        end
+        mtime
+      elsif pathname = resolve(name)
+        pathname.mtime
+      end
+    end
+
+    def key(name, options)
+      ["Sprockets:" + File.dirname(File.expand_path(name)), File.basename(name)]
+    end
+
+    def to_s
+      "Sass::Rails::Importer(#{context.pathname})"
+    end
+
+    private
+      def sprockets_resolve(path)
+        context.resolve(path, :content_type => :self)
+      rescue Sprockets::FileNotFound, Sprockets::ContentTypeMismatch
+        nil
+      end
+
+      def sprockets_process(path)
+        context.environment[path].to_s
+      end
+  end
+
+end

data/lib/sass/rails/monkey_patches.rb

@@ -0,0 +1,20 @@
+require 'sprockets/railtie'
+
+module Sprockets
+  class Railtie < ::Rails::Railtie
+
+    module SassContext
+      attr_accessor :sass_config
+    end
+
+    protected
+
+    def asset_environment_with_sass_config(app, *args)
+      env = asset_environment_without_sass_config(app, *args)
+      env.context_class.extend(SassContext)
+      env.context_class.sass_config = app.config.sass
+      env
+    end
+    alias_method_chain :asset_environment, :sass_config
+  end
+end

data/lib/sass/rails/railtie.rb

@@ -0,0 +1,43 @@
+module Sass::Rails
+  class Railtie < ::Rails::Railtie
+    config.sass = ActiveSupport::OrderedOptions.new
+    # Establish static configuration defaults
+    # Emit scss files during stylesheet generation of scaffold
+    config.sass.preferred_syntax = :scss
+    # Use expanded output instead of the sass default of :nested
+    config.sass.style            = :expanded
+    # Write sass cache files to tmp/sass-cache for performance
+    config.sass.cache            = true
+    # Read sass cache files from tmp/sass-cache for performance
+    config.sass.read_cache       = true
+    # Display line comments above each selector as a debugging aid
+    config.sass.line_comments    = true
+
+    initializer :setup_sass do |app|
+      # Only emit one kind of syntax because though we have registered two kinds of generators
+      syntax     = app.config.sass.preferred_syntax.to_sym
+      alt_syntax = syntax == :sass ? "scss" : "sass"
+      app.config.generators.hide_namespace alt_syntax
+
+      # Set the stylesheet engine to the preferred syntax
+      config.app_generators.stylesheet_engine syntax
+
+      # Set the sass cache location to tmp/sass-cache
+      config.sass.cache_location   = File.join(Rails.root, "tmp/sass-cache")
+
+      # Establish configuration defaults that are evironmental in nature
+      if config.sass.full_exception.nil?
+        # Display a stack trace in the css output when in development-like environments.
+        config.sass.full_exception = app.config.consider_all_requests_local
+      end
+
+    end
+
+    initializer :setup_compression do |app|
+      if app.config.assets.compress
+        # Use sass's css_compressor
+        app.config.assets.css_compressor = CssCompressor.new
+      end
+    end
+  end
+end

data/lib/sass/rails/template_handlers.rb

@@ -0,0 +1,61 @@
+require 'tilt'
+require 'sprockets'
+
+module Sass::Rails
+  class SassTemplate < Tilt::SassTemplate
+    self.default_mime_type = 'text/css'
+
+    def self.engine_initialized?
+      defined?(::Sass::Engine)
+    end
+
+    def initialize_engine
+      require_template_library 'sass'
+    end
+
+    def syntax
+      :sass
+    end
+
+    def sass_options_from_rails(scope)
+      scope.environment.context_class.sass_config
+    end
+
+    def sass_options(scope)
+      importer = self.importer(scope)
+      options = sass_options_from_rails(scope)
+      load_paths = (options[:load_paths] || []).dup
+      load_paths.unshift(importer)
+      options.merge(
+        :filename => eval_file,
+        :line => line,
+        :syntax => syntax,
+        :importer => importer,
+        :load_paths => load_paths
+      )
+    end
+
+    def importer(scope)
+      Sass::Rails::Importer.new(scope)
+    end
+
+    def prepare
+    end
+
+    def evaluate(scope, locals, &block)
+      Sass::Engine.new(data, sass_options(scope)).render
+    end
+  end
+
+  class ScssTemplate < SassTemplate
+    self.default_mime_type = 'text/css'
+
+    def syntax
+      :scss
+    end
+  end
+end
+
+Sprockets::Engines #invoke autoloading
+Sprockets.register_engine '.sass', Sass::Rails::SassTemplate
+Sprockets.register_engine '.scss', Sass::Rails::ScssTemplate

data/lib/{sass-rails → sass/rails}/version.rb

@@ -1,5 +1,5 @@
 module Sass
   module Rails
-    VERSION = "3.1.0.rc.1"
+    VERSION = "3.1.0.rc.2"
   end
 end

data/sass-rails.gemspec

@@ -1,22 +1,23 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "sass-rails/version"
+require "sass/rails/version"
 
 Gem::Specification.new do |s|
   s.name        = "sass-rails"
   s.version     = Sass::Rails::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["wycats"]
-  s.email       = ["wycats@gmail.com"]
-  s.homepage    = "http://www.rubyonrails.org"
-  s.summary     = %q{Ruby on Rails stylesheet engine for Sass}
-  s.description = %q{Provides Ruby on Rails generators and asset support for Sass and SCSS}
+  s.authors     = ["wycats", "chriseppstein"]
+  s.email       = ["wycats@gmail.com", "chris@eppsteins.net"]
+  s.homepage    = ""
+  s.summary     = %q{Sass adapter for the Rails asset pipeline.}
+  s.description = %q{Sass adapter for the Rails asset pipeline.}
 
   s.rubyforge_project = "sass-rails"
 
-  s.add_runtime_dependency 'sass',       '~> 3.1.1'
+  s.add_runtime_dependency 'sass',       '>= 3.1.2'
   s.add_runtime_dependency 'railties',   '~> 3.1.0.rc1'
   s.add_runtime_dependency 'actionpack', '~> 3.1.0.rc1'
+  s.add_runtime_dependency 'sprockets', '>= 2.0.0.beta.9'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")