sass-rails 4.0.3 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 54dce7aa277951f8a75d414c3d306bcb31e8f197
-  data.tar.gz: 24ac93add7c710d1bc971ca6fd128a4d1c983559
+SHA256:
+  metadata.gz: 81b377677315439a968f5d8c1fe884680e40681853aa6ce0059fec8f81a7561e
+  data.tar.gz: fce2dc70c42fd35b13dd1310c6e7f48825143497bb98fde3d4ded15efa5b72fe
 SHA512:
-  metadata.gz: 10f18b7e6991934d836c7bf6beeda155b943a700440b9cd9fe95c31f204744aa5e984a9bd4ee74ede0d6938fff753c83ee29d95ba2ff1e8010e9cc30dd3e25f9
-  data.tar.gz: e203aa3c350946f547b14eb6d2c2e035d880e7cd656675e3e54ea08e0f374a4d99bd821f1a9835748266c83d870362dbdd81b09618da9e2a1608a1f9f11d552f
+  metadata.gz: 561d100c511ed762dec416a081117bb949833e2ffde2ea8fa984cfae44f4f432e3cb52f3f213c8b4c37fe365c50a77b8fbe04e26f48a4a12b7cc5f8fd074ffce
+  data.tar.gz: 20b336c399d4907f64c95112a95ab912ce04575f8e3f153476e1b10d5d70dba4038d220baadbf4d408f509fe2c58cdde26c5250383ad52b011394c46afe90f65

data/README.md

@@ -16,20 +16,23 @@ properties that will be passed to Sass.
 
 ### Options
 
-The [list of supported options](http://sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html#options)
+- `preferred_syntax` - This option determines the default Sass syntax and file extensions that will be used by Rails generators. Can be `:scss` (default CSS-compatible SCSS syntax) or `:sass` (indented Sass syntax).
+
+The [list of supported Sass options](http://sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html#options)
 can be found on the Sass Website with the following caveats:
 
-1. `:style` - This option is not supported. This is determined by the Rails environment. It's `:expanded` only on development, otherwise it's `:compressed`.
-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.
+- `:style` - This option is not supported. This is determined by the Rails environment. It's `:expanded` only on development, otherwise it's `:compressed`.
+- `:never_update` - This option is not supported. Instead set `config.assets.enabled = false`
+- `: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.
+- `:always_check` - This option is not supported. Sprockets always checks in development.
+- `:syntax` - This is determined by the file's extensions.
+- `:filename` - This is determined by the file's name.
+- `:line` - This is provided by the template handler.
 
 ### Example
 
     MyProject::Application.configure do
+      config.sass.preferred_syntax = :sass
       config.sass.line_comments = false
       config.sass.cache = false
     end
@@ -65,24 +68,24 @@ in Sass):
 #### `asset-path($relative-asset-path)`
 Returns a string to the asset.
 
-* `asset-path("rails.png")` becomes `"/assets/rails.png"`
+* `asset-path("rails.png")` returns `"/assets/rails.png"`
 
 #### `asset-url($relative-asset-path)`
 Returns a url reference to the asset.
 
-* `asset-url("rails.png")` becomes `url(/assets/rails.png)`
+* `asset-url("rails.png")` returns `url(/assets/rails.png)`
 
 As a convenience, for each of the following asset classes there are
 corresponding `-path` and `-url` helpers:
 image, font, video, audio, javascript, stylesheet.
 
-* `image-path("rails.png")` becomes `"/assets/rails.png"`
-* `image-url("rails.png")` becomes `url(/assets/rails.png)`
+* `image-path("rails.png")` returns `"/assets/rails.png"`
+* `image-url("rails.png")` returns `url(/assets/rails.png)`
 
 #### `asset-data-url($relative-asset-path)`
 Returns a url reference to the Base64-encoded asset at the specified path.
 
-* `asset-data-url("rails.png")` becomes `url(data:image/png;base64,iVBORw0K...)`
+* `asset-data-url("rails.png")` returns `url(data:image/png;base64,iVBORw0K...)`
 
 ## Running Tests
 
@@ -93,6 +96,6 @@ If you need to test against local gems, use Bundler's gem :path option in the Ge
 
 ## Code Status
 
-* [![Travis CI](https://api.travis-ci.org/rails/sass-rails.png)](http://travis-ci.org/rails/sass-rails)
-* [![Gem Version](https://badge.fury.io/rb/sass-rails.png)](http://badge.fury.io/rb/sass-rails)
-* [![Dependencies](https://gemnasium.com/rails/sass-rails.png)](https://gemnasium.com/rails/sass-rails)
+* [![Travis CI](https://api.travis-ci.org/rails/sass-rails.svg)](http://travis-ci.org/rails/sass-rails)
+* [![Gem Version](https://badge.fury.io/rb/sass-rails.svg)](http://badge.fury.io/rb/sass-rails)
+* [![Dependencies](https://gemnasium.com/rails/sass-rails.svg)](https://gemnasium.com/rails/sass-rails)

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
-        template "stylesheet.css.sass", File.join('app/assets/stylesheets', class_path, "#{file_name}.css.sass")
+        template "stylesheet.sass", File.join('app/assets/stylesheets', class_path, "#{file_name}.sass")
       end
     end
   end

data/lib/rails/generators/sass_scaffold.rb

@@ -8,9 +8,8 @@ module Sass
         dir = ::Rails::Generators::ScaffoldGenerator.source_root
         file = File.join(dir, "scaffold.css")
         converted_contents = ::Sass::CSS.new(File.read(file)).render(syntax)
-        create_file "app/assets/stylesheets/scaffolds.css.#{syntax}", converted_contents
+        create_file "app/assets/stylesheets/scaffolds.#{syntax}", converted_contents
       end
     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
-        template "stylesheet.css.scss", File.join('app/assets/stylesheets', class_path, "#{file_name}.css.scss")
+        template "stylesheet.scss", File.join('app/assets/stylesheets', class_path, "#{file_name}.scss")
       end
     end
   end

data/lib/sass/rails/cache_store.rb

@@ -0,0 +1,31 @@
+require 'sass'
+
+module Sass
+  module Rails
+    class CacheStore < ::Sass::CacheStores::Base
+      attr_reader :environment
+
+      def initialize(environment)
+        @environment = environment
+      end
+
+      def _store(key, version, sha, contents)
+        environment.cache_set("sass/#{key}", {:version => version, :sha => sha, :contents => contents})
+      end
+
+      def _retrieve(key, version, sha)
+        if obj = environment.cache_get("sass/#{key}")
+          return unless obj[:version] == version
+          return unless obj[:sha] == sha
+          obj[:contents]
+        else
+          nil
+        end
+      end
+
+      def path_to(key)
+        key
+      end
+    end
+  end
+end

data/lib/sass/rails/helpers.rb

@@ -1,30 +1,13 @@
+require 'sass'
 require 'sprockets/sass_functions'
-require 'active_support/deprecation'
 
 module Sprockets
   module SassFunctions
-    if instance_methods.map(&:to_sym).include?(:asset_path)
-      undef_method :asset_path
-    end
-
-    def asset_path(path, kind = nil)
-      ActiveSupport::Deprecation.warn "asset_path with two arguments is deprecated. Use asset_path(#{path}) instead." if kind
-
-      Sass::Script::String.new(sprockets_context.asset_path(path.value), :string)
-    end
-
-    if instance_methods.map(&:to_sym).include?(:asset_url)
-      undef_method :asset_url
-    end
-
-    def asset_url(path, kind = nil)
-      ActiveSupport::Deprecation.warn "asset_url with two arguments is deprecated. Use asset_url(#{path}) instead." if kind
-
-      Sass::Script::String.new("url(" + sprockets_context.asset_path(path.value) + ")")
-    end
-
+    remove_method :asset_data_url if method_defined?(:asset_data_url)
     def asset_data_url(path)
       Sass::Script::String.new("url(" + sprockets_context.asset_data_uri(path.value) + ")")
     end
   end
 end
+
+::Sass::Script::Functions.send :include, Sprockets::SassFunctions

data/lib/sass/rails/importer.rb

@@ -1,104 +1,147 @@
+require 'active_support/deprecation/reporting'
+require 'sass'
 require 'sprockets/sass_importer'
+require 'tilt'
+
+module Sass
+  module Rails
+    class SassImporter < Sass::Importers::Filesystem
+      module Globbing
+        GLOB = /(\A|\/)(\*|\*\*\/\*)\z/
+
+        def find_relative(name, base, options)
+          if options[:sprockets] && m = name.match(GLOB)
+            path = name.sub(m[0], "")
+            base = File.expand_path(path, File.dirname(base))
+            glob_imports(base, m[2], options)
+          else
+            super
+          end
+        end
 
-module Sprockets
-  class SassImporter < Sass::Importers::Filesystem
-    GLOB = /\*|\[.+\]/
-
-    attr_reader :context
-    private :context
-
-    def extensions
-      {
-        'css'          => :scss,
-        'css.scss'     => :scss,
-        'css.sass'     => :sass,
-        'css.erb'      => :scss,
-        'scss.erb'     => :scss,
-        'sass.erb'     => :sass,
-        'css.scss.erb' => :scss,
-        'css.sass.erb' => :sass
-      }.merge!(super)
-    end
+        def find(name, options)
+          # globs must be relative
+          return if name =~ GLOB
+          super
+        end
 
-    def find_relative(name, base, options)
-      if name =~ GLOB
-        glob_imports(name, Pathname.new(base), options)
-      else
-        engine_from_path(name, File.dirname(base), options)
+        private
+          def glob_imports(base, glob, options)
+            contents = ""
+            context = options[:sprockets][:context]
+            each_globbed_file(base, glob, context) do |filename|
+              next if filename == options[:filename]
+              contents << "@import #{filename.inspect};\n"
+            end
+            return nil if contents == ""
+            Sass::Engine.new(contents, options.merge(
+              :filename => base,
+              :importer => self,
+              :syntax => :scss
+            ))
+          end
+
+          def each_globbed_file(base, glob, context)
+            raise ArgumentError unless glob == "*" || glob == "**/*"
+
+            exts = extensions.keys.map { |ext| Regexp.escape(".#{ext}") }.join("|")
+            sass_re = Regexp.compile("(#{exts})$")
+
+            context.depend_on(base)
+
+            Dir["#{base}/#{glob}"].sort.each do |path|
+              if File.directory?(path)
+                context.depend_on(path)
+              elsif sass_re =~ path
+                yield path
+              end
+            end
+          end
       end
-    end
 
-    def find(name, options)
-      if name =~ GLOB
-        nil # globs must be relative
-      else
-        engine_from_path(name, root, options)
-      end
-    end
+      module ERB
+        def extensions
+          {
+            'css.erb'  => :scss_erb,
+            'scss.erb' => :scss_erb,
+            'sass.erb' => :sass_erb
+          }.merge(super)
+        end
 
-    def each_globbed_file(glob, base_pathname, options)
-      Dir["#{base_pathname}/#{glob}"].sort.each do |filename|
-        next if filename == options[:filename]
-        yield filename if File.directory?(filename) || context.asset_requirable?(filename)
-      end
-    end
+        def erb_extensions
+          {
+            :scss_erb => :scss,
+            :sass_erb => :sass
+          }
+        end
 
-    def glob_imports(glob, base_pathname, options)
-      contents = ""
-      each_globbed_file(glob, base_pathname.dirname, options) do |filename|
-        if File.directory?(filename)
-          depend_on(filename)
-        elsif context.asset_requirable?(filename)
-          depend_on(filename)
-          contents << "@import #{Pathname.new(filename).relative_path_from(base_pathname.dirname).to_s.inspect};\n"
+        def find_relative(*args)
+          process_erb_engine(super)
         end
-      end
-      return nil if contents.empty?
-      Sass::Engine.new(contents, options.merge(
-        :filename => base_pathname.to_s,
-        :importer => self,
-        :syntax => :scss
-      ))
-    end
 
-    private
+        def find(*args)
+          process_erb_engine(super)
+        end
 
-      def depend_on(filename)
-        context.depend_on(filename)
-        context.depend_on(globbed_file_parent(filename))
+        private
+          def process_erb_engine(engine)
+            if engine && engine.options[:sprockets] && syntax = erb_extensions[engine.options[:syntax]]
+              template = Tilt::ERBTemplate.new(engine.options[:filename])
+              contents = template.render(engine.options[:sprockets][:context], {})
+
+              Sass::Engine.new(contents, engine.options.merge(:syntax => syntax))
+            else
+              engine
+            end
+          end
       end
 
-      def globbed_file_parent(filename)
-        if File.directory?(filename)
-          File.expand_path('..', filename)
-        else
-          File.dirname(filename)
+      module Deprecated
+        def extensions
+          {
+            'css.scss'     => :scss,
+            'css.sass'     => :sass,
+            'css.scss.erb' => :scss_erb,
+            'css.sass.erb' => :sass_erb
+          }.merge(super)
         end
-      end
-
-      def engine_from_path(name, dir, options)
-        full_filename, syntax = Sass::Util.destructure(find_real_file(dir, name, options))
-        return unless full_filename && File.readable?(full_filename)
 
-        engine = Sass::Engine.new(evaluate(full_filename), options.merge(
-          syntax: syntax,
-          filename: full_filename,
-          importer: self
-        ))
+        def find_relative(*args)
+          deprecate_extra_css_extension(super)
+        end
 
-        if engine && (filename = engine.options[:filename])
-          @context.depend_on(filename)
+        def find(*args)
+          deprecate_extra_css_extension(super)
         end
 
-        engine
+        private
+          def deprecate_extra_css_extension(engine)
+            if engine && filename = engine.options[:filename]
+              if filename.end_with?('.css.scss')
+                msg = "Extra .css in SCSS file is unnecessary. Rename #{filename} to #{filename.sub('.css.scss', '.scss')}."
+              elsif filename.end_with?('.css.sass')
+                msg = "Extra .css in SASS file is unnecessary. Rename #{filename} to #{filename.sub('.css.sass', '.sass')}."
+              elsif filename.end_with?('.css.scss.erb')
+                msg = "Extra .css in SCSS/ERB file is unnecessary. Rename #{filename} to #{filename.sub('.css.scss.erb', '.scss.erb')}."
+              elsif filename.end_with?('.css.sass.erb')
+                msg = "Extra .css in SASS/ERB file is unnecessary. Rename #{filename} to #{filename.sub('.css.sass.erb', '.sass.erb')}."
+              end
+
+              ActiveSupport::Deprecation.warn(msg) if msg
+            end
+
+            engine
+          end
       end
 
-      def evaluate(filename)
-        attributes = context.environment.attributes_for(filename)
-        processors = context.environment.preprocessors(attributes.content_type) +
-          attributes.engines.reverse - [Sprockets::ScssTemplate, Sprockets::SassTemplate]
+      include Deprecated
+      include ERB
+      include Globbing
 
-        context.evaluate(filename, processors: processors)
+      # Allow .css files to be @import'd
+      def extensions
+        { 'css' => :scss }.merge(super)
       end
+    end
   end
 end

data/lib/sass/rails/logger.rb

@@ -1,3 +1,4 @@
+require 'sass'
 require 'sass/logger'
 
 module Sass

data/lib/sass/rails/railtie.rb

@@ -1,11 +1,9 @@
+require 'sass'
+require 'active_support/core_ext/class/attribute'
 require 'sprockets/railtie'
 
 module Sass::Rails
   class Railtie < ::Rails::Railtie
-    module SassContext
-      attr_accessor :sass_config
-    end
-
     config.sass = ActiveSupport::OrderedOptions.new
 
     # Establish static configuration defaults
@@ -23,11 +21,15 @@ module Sass::Rails
     config.sass.logger           = Sass::Rails::Logger.new
 
     # Set the default stylesheet engine
-    # It can be overridedden by passing:
+    # It can be overridden by passing:
     #     --stylesheet_engine=sass
     # to the rails generate command
     config.app_generators.stylesheet_engine config.sass.preferred_syntax
 
+    if config.respond_to?(:annotations)
+      config.annotations.register_extensions("scss", "sass") { |annotation| /\/\/\s*(#{annotation}):?\s*(.*)$/ }
+    end
+
     # Remove the sass middleware if it gets inadvertently enabled by applications.
     config.after_initialize do |app|
       app.config.middleware.delete(Sass::Plugin::Rack) if defined?(Sass::Plugin::Rack)
@@ -51,20 +53,41 @@ module Sass::Rails
         config.sass.full_exception = app.config.consider_all_requests_local
       end
 
-      if app.assets
-        app.assets.context_class.extend(SassContext)
-        app.assets.context_class.sass_config = app.config.sass
+      config.assets.configure do |env|
+        if env.respond_to?(:register_engine)
+          args = ['.sass', Sass::Rails::SassTemplate]
+          args << { silence_deprecation: true } if env.method(:register_engine).arity.abs > 2
+          env.register_engine(*args)
+
+          args = ['.scss', Sass::Rails::ScssTemplate]
+          args << { silence_deprecation: true } if env.method(:register_engine).arity.abs > 2
+          env.register_engine(*args)
+        end
+
+        if env.respond_to?(:register_transformer)
+          env.register_transformer 'text/sass', 'text/css',
+            Sprockets::SassProcessor.new(importer: SassImporter, sass_config: app.config.sass)
+          env.register_transformer 'text/scss', 'text/css',
+            Sprockets::ScssProcessor.new(importer: SassImporter, sass_config: app.config.sass)
+        end
+
+        env.context_class.class_eval do
+          class_attribute :sass_config
+          self.sass_config = app.config.sass
+        end
       end
 
       Sass.logger = app.config.sass.logger
     end
 
     initializer :setup_compression, group: :all do |app|
-      unless Rails.env.development?
-        app.config.assets.css_compressor ||= :sass
-      else
+      if Rails.env.development?
         # Use expanded output instead of the sass default of :nested unless specified
         app.config.sass.style ||= :expanded
+      else
+        # config.assets.css_compressor may be set to nil in non-dev environments.
+        # otherwise, the default is sass compression.
+        app.config.assets.css_compressor = :sass unless app.config.assets.has_key?(:css_compressor)
       end
     end
   end