sprockets-sass 1.3.1 → 2.0.0.beta2

data/lib/sprockets/sass/registration.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+module Sprockets
+  module Sass
+    # class useful for registering engines, tranformers, preprocessors and conpressors for sprockets
+    # depending on the version of sprockets
+    class Registration
+      attr_reader :klass, :sprockets_version, :registration_instance
+
+      def initialize(klass)
+        @klass = klass
+        @sprockets_version = Sprockets::Sass::Utils.version_of_sprockets
+        @registration_instance = self
+      end
+
+      def run
+        require_libraries
+        case @sprockets_version
+          when 2...3
+            register_sprockets_legacy
+          when 3...4
+            register_sprockets_v3
+          when 4...5
+            register_sprockets_v4
+          else
+            raise "Version #{Sprockets::Sass::Utils.full_version_of_sprockets} is not supported"
+        end
+      end
+
+      def require_libraries
+        require_standard_libraries
+        require 'sprockets/sass/functions'
+      end
+
+    private
+
+      def require_standard_libraries(version = @sprockets_version)
+        %w(cache_store compressor functions importer sass_template scss_template).each do |filename|
+          begin
+            require "sprockets/sass/v#{version}/#{filename}"
+          rescue LoadError; end
+        end
+      end
+
+      def register_sprockets_v3_common
+        %w(sass scss).each do |mime|
+          _register_mime_types(mime_type:  "application/#{mime}+ruby", extensions: [".#{mime}.erb", ".css.#{mime}.erb"])
+        end
+        _register_compressors(mime_type: 'text/css', name: :sprockets_sass, klass: Sprockets::Sass::Utils.get_class_by_version('Compressor'))
+      end
+
+      def register_sprockets_v4
+        register_sprockets_v3_common
+        %w(sass scss).each do |mime|
+          _register_mime_types(mime_type:  "text/#{mime}", extensions: [".#{mime}", ".css.#{mime}"])
+        end
+        %w(sass scss).each do |mime|
+          _register_transformers(from: "application/#{mime}+ruby", to: "text/#{mime}", klass: Sprockets::ERBProcessor)
+        end
+        _register_v4_preprocessors(
+          Sprockets::Sass::V4::SassTemplate => ['text/sass'],
+          Sprockets::Sass::V4::ScssTemplate => ['text/scss']
+        )
+        _register_transformers(
+          { from: 'text/sass', to: 'text/css', klass: Sprockets::Sass::V4::SassTemplate },
+          from: 'text/scss', to: 'text/css', klass: Sprockets::Sass::V4::ScssTemplate
+        )
+      end
+
+      def register_sprockets_v3
+        register_sprockets_v3_common
+        _register_transformers(
+          { from: 'application/scss+ruby', to: 'text/css', klass: Sprockets::ERBProcessor },
+          from: 'application/sass+ruby', to: 'text/css', klass: Sprockets::ERBProcessor
+        )
+        _register_engines('.sass' => Sprockets::Sass::V3::SassTemplate, '.scss' => Sprockets::Sass::V3::ScssTemplate)
+      end
+
+      def register_sprockets_legacy
+        _register_engines('.sass' => Sprockets::Sass::V2::SassTemplate, '.scss' => Sprockets::Sass::V2::ScssTemplate)
+      end
+
+      def _register_engines(hash)
+        hash.each do |key, value|
+          args = [key, value]
+          args << { mime_type: 'text/css', silence_deprecation: true } if sprockets_version >= 3
+          register_engine(*args)
+        end
+      end
+
+      def _register_mime_types(*mime_types)
+        mime_types.each do |mime_data|
+          register_mime_type(mime_data[:mime_type], extensions: mime_data[:extensions])
+        end
+      end
+
+      def _register_compressors(*compressors)
+        compressors.each do |compressor|
+          register_compressor(compressor[:mime_type], compressor[:name], compressor[:klass])
+        end
+      end
+
+      def _register_transformers(*tranformers)
+        tranformers.each do |tranformer|
+          register_transformer(tranformer[:from], tranformer[:to], tranformer[:klass])
+        end
+      end
+
+      def _register_v4_preprocessors(hash)
+        hash.each do |key, value|
+          value.each do |mime|
+            register_preprocessor(mime, key)
+          end
+        end
+      end
+
+      def method_missing(sym, *args, &block)
+        @klass.public_send(sym, *args, &block) || super
+      end
+
+      def respond_to_missing?(method_name, include_private = nil)
+        include_private = include_private.blank? ? true : include_private
+        @klass.public_methods.include?(method_name) || super(method_name, include_private)
+      end
+    end
+  end
+end

data/lib/sprockets/sass/utils.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+module Sprockets
+  module Sass
+    # utility functions that can be used statically from anywhere
+    class Utils
+      class << self
+        def full_version_of_sprockets
+          Sprockets::VERSION
+        end
+
+        def version_of_sprockets
+          full_version_of_sprockets.split('.')[0].to_i
+        end
+
+        def read_file_binary(file, options = {})
+          default_encoding = options.delete :default_encoding
+
+          # load template data and prepare (uses binread to avoid encoding issues)
+          data = read_template_file(file)
+
+          if data.respond_to?(:force_encoding)
+            if default_encoding
+              data = data.dup if data.frozen?
+              data.force_encoding(default_encoding)
+            end
+
+            unless data.valid_encoding?
+              raise Encoding::InvalidByteSequenceError, "#{filename} is not valid #{data.encoding}"
+            end
+          end
+          data
+        end
+
+        def digest(options)
+          options.delete_if { |_key, value| value.is_a?(Pathname) } if options.is_a?(Hash)
+          options = options.to_s unless options.is_a?(Hash)
+          if defined?(Sprockets::DigestUtils)
+            Sprockets::DigestUtils.digest(options)
+          else
+            options = options.is_a?(Hash) ? options : { value: options }
+            Digest::SHA256.hexdigest(JSON.generate(options))
+          end
+        end
+
+        def read_template_file(file)
+          data = File.open(file, 'rb', &:read)
+          if data.respond_to?(:force_encoding)
+            # Set it to the default external (without verifying)
+            data.force_encoding(Encoding.default_external) if Encoding.default_external
+          end
+          data
+        end
+
+        def get_class_by_version(class_name, version = version_of_sprockets)
+          constantize("Sprockets::Sass::V#{version}::#{class_name}")
+        rescue
+          nil
+        end
+
+        def constantize(camel_cased_word)
+          names = camel_cased_word.split('::')
+
+          # Trigger a built-in NameError exception including the ill-formed constant in the message.
+          Object.const_get(camel_cased_word) if names.empty?
+
+          # Remove the first blank element in case of '::ClassName' notation.
+          names.shift if names.size > 1 && names.first.empty?
+
+          names.reduce(Object) do |constant, name|
+            if constant == Object
+              constant.const_get(name)
+            else
+              candidate = constant.const_get(name)
+              next candidate if constant.const_defined?(name, false)
+              next candidate unless Object.const_defined?(name)
+
+              # Go down the ancestors to check if it is owned directly. The check
+              # stops when we reach Object or the end of ancestors tree.
+              constant = constant.ancestors.each_with_object do |ancestor, const|
+                break const    if ancestor == Object
+                break ancestor if ancestor.const_defined?(name, false)
+                const
+              end
+
+              # owner is in Object, so raise
+              constant.const_get(name, false)
+            end
+          end
+        end
+
+        def module_include(base, mod)
+          old_methods = {}
+
+          mod.instance_methods.each do |sym|
+            old_methods[sym] = base.instance_method(sym) if base.method_defined?(sym)
+          end
+
+          mod.instance_methods.each do |sym|
+            method = mod.instance_method(sym)
+            base.send(:define_method, sym, method)
+          end
+
+          yield
+        ensure
+          mod.instance_methods.each do |sym|
+            base.send(:undef_method, sym) if base.method_defined?(sym)
+          end
+          old_methods.each do |sym, method|
+            base.send(:define_method, sym, method)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sprockets/sass/v2/cache_store.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module Sprockets
+  module Sass
+    module V2
+      # Internal: Cache wrapper for Sprockets cache adapter. (Sprockets 2.x)
+      class CacheStore < ::Sass::CacheStores::Base
+        attr_reader :environment
+
+        def initialize(environment)
+          @environment = environment
+        end
+
+        def _store(key, version, sha, contents)
+          environment.send :cache_set, "sass/#{key}", version: version, sha: sha, contents: contents
+        end
+
+        def _retrieve(key, version, sha)
+          obj = environment.send(:cache_get, "sass/#{key}")
+          return unless obj.is_a?(Hash)
+          return if obj[:version] != version || obj[:sha] != sha
+          obj[:obj]
+        end
+      end
+    end
+  end
+end

data/lib/sprockets/sass/v2/compressor.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+module Sprockets
+  module Sass
+    module V2
+      # Class used to compress CSS files
+      class Compressor
+        def self.instance
+          @instance ||= new
+        end
+
+        def self.compress(input)
+          instance.compress(input)
+        end
+
+        # Compresses the given CSS using Sass::Engine's
+        # :compressed output style.
+        def compress(css)
+          if css.count("\n") >= 2
+            ::Sass::Engine.new(css,
+                               syntax: :scss,
+                               cache: false,
+                               read_cache: false,
+                               style: :compressed).render
+          else
+            css
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sprockets/sass/v2/functions.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+module Sprockets
+  module Sass
+    module V2
+      # Module used to inject helpers into SASS engine
+      module Functions
+        # Using Sprockets::Context#asset_data_uri return a Base64-encoded `data:`
+        # URI with the contents of the asset at the specified path.
+        #
+        # === Examples
+        #
+        #   background: asset-data-uri("image.jpg"); // background: url(data:image/jpeg;base64,...);
+        #
+        def asset_data_uri(source)
+          ::Sass::Script::String.new "url(#{sprockets_context.asset_data_uri(source.value)})"
+        end
+
+        # 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 = {})
+          # Work with the Sass::Rails #asset_path API
+          if options.respond_to? :value
+            kind = options.value
+            options = {}
+          end
+
+          if kind && sprockets_context.respond_to?("#{kind}_path")
+            ::Sass::Script::String.new sprockets_context.send("#{kind}_path", source.value), :string
+          else
+            ::Sass::Script::String.new sprockets_context.asset_path(source.value, map_options(options)).to_s, :string
+          end
+        end
+
+        # 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 = {})
+          ::Sass::Script::String.new "url(#{asset_path(source, options)})"
+        end
+
+        # 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 = {})
+          ::Sass::Script::String.new sprockets_context.image_path(source.value, map_options(options)).to_s, :string
+        end
+
+        # 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: image-url("image.jpg");                // background: url("/assets/image.jpg");
+        #   background: image-url("image.jpg", $digest: true); // background: url("/assets/image-27a8f1f96afd8d4c67a59eb9447f45bd.jpg");
+        #
+        def image_url(source, options = {}, _cache_buster = nil)
+          # Work with the Compass #image_url API
+          if options.respond_to? :value
+            case options.value
+              when true
+                return image_path source
+              else
+                options = {}
+            end
+          end
+          ::Sass::Script::String.new "url(#{image_path(source, options)})"
+        end
+
+        # Using Sprockets::Helpers#font_path, return the full path
+        # for the given +source+ as a Sass String. This supports keyword
+        # arguments that mirror the +options+.
+        #
+        # === Examples
+        #
+        #   src: url(font-path("font.ttf"));                // src: url("/assets/font.ttf");
+        #   src: url(font-path("font.ttf", $digest: true)); // src: url("/assets/font-27a8f1f96afd8d4c67a59eb9447f45bd.ttf");
+        #
+        def font_path(source, options = {})
+          ::Sass::Script::String.new sprockets_context.font_path(source.value, map_options(options)).to_s, :string
+        end
+
+        # Using Sprockets::Helpers#font_path, return the url CSS
+        # for the given +source+ as a Sass String. This supports keyword
+        # arguments that mirror the +options+.
+        #
+        # === Examples
+        #
+        #   src: font-url("font.ttf");                  // src: url("/assets/font.ttf");
+        #   src: font-url("image.jpg", $digest: true);  // src: url("/assets/font-27a8f1f96afd8d4c67a59eb9447f45bd.ttf");
+        #
+        def font_url(source, options = {})
+          # Work with the Compass #font_url API
+          if options.respond_to? :value
+            case options.value
+              when true
+                return font_path source
+              else
+                options = {}
+            end
+          end
+          ::Sass::Script::String.new "url(#{font_path(source, options)})"
+        end
+
+      protected
+
+        # Returns a reference to the Sprocket's context through
+        # the importer.
+        def sprockets_context # :nodoc:
+          options[:custom][:sprockets_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
+end

data/lib/sprockets/sass/v2/importer.rb

@@ -0,0 +1,209 @@
+# frozen_string_literal: true
+
+module Sprockets
+  module Sass
+    module V2
+      # class used for importing files from SCCS and SASS files
+      class Importer < ::Sass::Importers::Base
+        GLOB = /\*|\[.+\]/
+
+        # @see Sass::Importers::Base#find_relative
+        def find_relative(path, base_path, options)
+          if path.to_s =~ GLOB
+            engine_from_glob(path, base_path, options)
+          else
+            engine_from_path(path, base_path, options)
+          end
+        end
+
+        # @see Sass::Importers::Base#find
+        def find(path, options)
+          engine_from_path(path, nil, 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
+          inspect
+        end
+
+      protected
+
+        # Create a Sass::Engine from the given path.
+        def engine_from_path(path, base_path, options)
+          context = options[:custom][:sprockets_context]
+          (pathname = resolve(context, path, base_path)) || (return nil)
+          context.depend_on pathname
+          ::Sass::Engine.new evaluate(context, pathname), options.merge(
+            filename: pathname.to_s,
+            syntax: syntax(pathname),
+            importer: self,
+            custom: { sprockets_context: context }
+          )
+        end
+
+        # Create a Sass::Engine that will handle importing
+        # a glob of files.
+        def engine_from_glob(glob, base_path, options)
+          context = options[:custom][:sprockets_context]
+          engine_imports = resolve_glob(context, glob, base_path).reduce(''.dup) do |imports, path|
+            context.depend_on path
+            relative_path = path.relative_path_from Pathname.new(base_path).dirname
+            imports << %(@import "#{relative_path}";\n)
+          end
+          return nil if engine_imports.empty?
+          ::Sass::Engine.new engine_imports, options.merge(
+            filename: base_path.to_s,
+            syntax: syntax(base_path.to_s),
+            importer: self,
+            custom: { sprockets_context: context }
+          )
+        end
+
+        # Finds an asset from the given path. This is where
+        # we make Sprockets behave like Sass, and import partial
+        # style paths.
+        def resolve(context, path, base_path)
+          paths, _root_path = possible_files(context, path, base_path)
+          paths.each do |file|
+            context.resolve(file.to_s) do |found|
+              return found if context.asset_requirable?(found)
+            end
+          end
+          nil
+        end
+
+        # Finds all of the assets using the given glob.
+        def resolve_glob(context, glob, base_path)
+          base_path      = Pathname.new(base_path)
+          path_with_glob = base_path.dirname.join(glob).to_s
+
+          Pathname.glob(path_with_glob).sort.select do |path|
+            asset_requirable = context.asset_requirable?(path)
+            path != context.pathname && asset_requirable
+          end
+        end
+
+        def context_root_path(context)
+          Pathname.new(context.root_path)
+        end
+
+        def context_load_pathnames(context)
+          context.environment.paths.map { |p| Pathname.new(p) }
+        end
+
+        # Returns all of the possible paths (including partial variations)
+        # to attempt to resolve with the given path.
+        def possible_files(context, path, base_path)
+          path      = Pathname.new(path)
+          base_path = Pathname.new(base_path).dirname
+          partial_path = partialize_path(path)
+          additional_paths = [Pathname.new("#{path}.css"), Pathname.new("#{partial_path}.css"), Pathname.new("#{path}.css.#{syntax(path)}"), Pathname.new("#{partial_path}.css.#{syntax(path)}")]
+          paths = additional_paths.concat([path, partial_path])
+
+          # Find base_path's root
+          paths, root_path = add_root_to_possible_files(context, base_path, path, paths)
+          [paths.compact, root_path]
+        end
+
+        def add_root_to_possible_files(context, base_path, path, paths)
+          env_root_paths = context_load_pathnames(context)
+          root_path = env_root_paths.find do |env_root_path|
+            base_path.to_s.start_with?(env_root_path.to_s)
+          end
+          root_path ||= context_root_path(context)
+          # Add the relative path from the root, if necessary
+          if path.relative? && base_path != root_path
+            relative_path = base_path.relative_path_from(root_path).join path
+            paths.unshift(relative_path, partialize_path(relative_path))
+          end
+          [paths, root_path]
+        end
+
+        # Returns the partialized version of the given path.
+        # Returns nil if the path is already to a partial.
+        def partialize_path(path)
+          return unless path.basename.to_s !~ /\A_/
+          Pathname.new path.to_s.sub(/([^\/]+)\Z/, '_\1')
+        end
+
+        # Returns the Sass syntax of the given path.
+        def syntax(path)
+          path.to_s.include?('.sass') ? :sass : :scss
+        end
+
+        def syntax_mime_type(_path)
+          'text/css'
+        end
+
+        def filtered_processor_classes
+          classes = [Sprockets::Sass::Utils.get_class_by_version('SassTemplate'), Sprockets::Sass::Utils.get_class_by_version('ScssTemplate')]
+          classes << Sprockets::SassProcessor if defined?(Sprockets::SassProcessor)
+          classes << Sprockets::SasscProcessor if defined?(Sprockets::SasscProcessor)
+          classes
+        end
+
+        def content_type_of_path(context, path)
+          attributes = context.environment.attributes_for(path)
+          content_type = attributes.content_type
+          [content_type, attributes]
+        end
+
+        def get_context_preprocessors(context, content_type)
+          context.environment.preprocessors(content_type)
+        end
+
+        def get_context_transformers(_context, _content_type, _path)
+          []
+        end
+
+        def get_engines_from_attributes(context, attributes)
+          attributes.engines
+        end
+
+        def get_all_processors_for_evaluate(context, content_type, attributes, path)
+          engines = get_engines_from_attributes(context, attributes)
+          preprocessors = get_context_preprocessors(context, content_type)
+          additional_transformers = get_context_transformers(context, content_type, path)
+          additional_transformers.reverse + preprocessors + engines.reverse
+        end
+
+        def filter_all_processors(processors)
+          processors.delete_if do |processor|
+            filtered_processor_classes.include?(processor) || filtered_processor_classes.any? do |filtered_processor|
+              !processor.is_a?(Proc) && processor < filtered_processor
+            end
+          end
+        end
+
+        def evaluate_path_from_context(context, path, processors)
+          context.evaluate(path, processors: processors)
+        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(context, path)
+          content_type, attributes = content_type_of_path(context, path)
+          processors = get_all_processors_for_evaluate(context, content_type, attributes, path)
+          filter_all_processors(processors)
+          evaluate_path_from_context(context, path, processors)
+        end
+      end
+    end
+  end
+end