sprockets-sass 1.3.1 → 2.0.0.beta1

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(attributes)
+          attributes.engines
+        end
+
+        def get_all_processors_for_evaluate(context, content_type, attributes, path)
+          engines = get_engines_from_attributes(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

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

@@ -0,0 +1,221 @@
+# frozen_string_literal: true
+module Sprockets
+  module Sass
+    module V2
+      # Preprocessor for SASS files
+      class SassTemplate
+        VERSION = '1'
+
+        def self.default_mime_type
+          'text/css'
+        end
+
+        # Internal: Defines default sass syntax to use. Exposed so the ScssProcessor
+        # may override it.
+        def self.syntax
+          :sass
+        end
+
+        # Public: Return singleton instance with default options.
+        #
+        # Returns SassProcessor object.
+        def self.instance
+          @instance ||= new
+        end
+
+        def self.call(input)
+          instance.call(input)
+        end
+
+        def self.cache_key
+          instance.cache_key
+        end
+
+        attr_reader :cache_key, :filename, :source, :context, :options
+
+        def initialize(options = {}, &block)
+          @default_options = { default_encoding: Encoding.default_external || 'utf-8' }
+          initialize_engine
+          if options.is_a?(Hash)
+            instantiate_with_options(options, &block)
+          else
+            instantiate_with_filename_and_source(options, &block)
+          end
+        end
+
+        def instantiate_with_filename_and_source(options)
+          @filename = options
+          @source = block_given? ? yield : nil
+          @options = @default_options
+          @cache_version = VERSION
+          @cache_key = "#{self.class.name}:#{::Sass::VERSION}:#{VERSION}:#{Sprockets::Sass::Utils.digest(options)}"
+          @functions = Module.new do
+            include Sprockets::Helpers if defined?(Sprockets::Helpers)
+            include Sprockets::Sass::Utils.get_class_by_version('Functions')
+          end
+        end
+
+        def instantiate_with_options(options, &block)
+          @cache_version = options[:cache_version] || VERSION
+          @cache_key = "#{self.class.name}:#{::Sass::VERSION}:#{@cache_version}:#{Sprockets::Sass::Utils.digest(options)}"
+          @filename = options[:filename]
+          @source = options[:data]
+          @options = options.merge(@default_options)
+          @importer_class = options[:importer]
+          @sass_config = options[:sass_config] || {}
+          @input = options
+          @functions = Module.new do
+            include Sprockets::Helpers if defined?(Sprockets::Helpers)
+            include Sprockets::Sass::Utils.get_class_by_version('Functions')
+            include options[:functions] if options[:functions]
+            class_eval(&block) if block_given?
+          end
+        end
+
+        @sass_functions_initialized = false
+        class << self
+          attr_accessor :sass_functions_initialized
+          alias sass_functions_initialized? sass_functions_initialized
+          # Templates are initialized once the functions are added.
+          def engine_initialized?
+            sass_functions_initialized?
+          end
+        end
+
+        # Add the Sass functions if they haven't already been added.
+        def initialize_engine
+          return if self.class.engine_initialized?
+
+          if Sass.add_sass_functions != false
+            begin
+              require 'sprockets/helpers'
+              require 'sprockets/sass/functions'
+              self.class.sass_functions_initialized = true
+            rescue LoadError; end
+          end
+        end
+
+        def call(input)
+          @input = input
+          @filename = input[:filename]
+          @source   = input[:data]
+          @context  = input[:environment].context_class.new(input)
+          run
+        end
+
+        def render(context, _empty_hash_wtf)
+          @context = context
+          run
+        end
+
+        def run
+          data = Sprockets::Sass::Utils.read_file_binary(filename, options)
+
+          engine = ::Sass::Engine.new(data, sass_options)
+          css = Sprockets::Sass::Utils.module_include(::Sass::Script::Functions, @functions) do
+            css = engine.render
+          end
+
+          sass_dependencies = Set.new([filename])
+          if context.respond_to?(:metadata)
+            engine.dependencies.map do |dependency|
+              sass_dependencies << dependency.options[:filename]
+              context.metadata[:dependencies] << Sprockets::URIUtils.build_file_digest_uri(dependency.options[:filename])
+            end
+            context.metadata.merge(data: css, sass_dependencies: sass_dependencies)
+          else
+            css
+          end
+
+          #  Tilt::SassTemplate.new(filename, sass_options(filename, context)).render(self)
+        rescue => e
+          # Annotates exception message with parse line number
+          # context.__LINE__ = e.sass_backtrace.first[:line]
+          raise [e, e.backtrace].join("\n")
+        end
+
+        def merge_sass_options(options, other_options)
+          if (load_paths = options[:load_paths]) && (other_paths = other_options[:load_paths])
+            other_options[:load_paths] = other_paths + load_paths
+          end
+          options = options.merge(other_options)
+          options[:load_paths] = options[:load_paths].is_a?(Array) ? options[:load_paths] : []
+          options[:load_paths] = options[:load_paths].concat(context.environment.paths)
+          options
+        end
+
+        def default_sass_config
+          if defined?(Compass)
+            merge_sass_options Compass.sass_engine_options.dup, Sprockets::Sass.options
+          else
+            Sprockets::Sass.options.dup
+          end
+        end
+
+        def default_sass_options
+          sass = default_sass_config
+          sass = merge_sass_options(sass.dup, @sass_config) if defined?(@sass_config) && @sass_config.is_a?(Hash)
+          sass
+        end
+
+        def build_cache_store(context)
+          return nil if context.environment.cache.nil?
+          if defined?(Sprockets::SassProcessor::CacheStore)
+            Sprockets::SassProcessor::CacheStore.new(context.environment)
+          else
+            custom_cache_store(context.environment)
+          end
+        end
+
+        def custom_cache_store(*args)
+          Sprockets::Sass::V2::CacheStore.new(*args)
+        end
+
+        # Allow the use of custom SASS importers, making sure the
+        # custom importer is a `Sprockets::Sass::Importer`
+        def fetch_importer_class
+          if defined?(@importer_class) && !@importer_class.nil?
+            @importer_class
+          elsif default_sass_options.key?(:importer) && default_sass_options[:importer].is_a?(Importer)
+            default_sass_options[:importer]
+          else
+            custom_importer_class
+          end
+        end
+
+        def custom_importer_class(*_args)
+          Sprockets::Sass::V2::Importer.new
+        end
+
+        def fetch_sprockets_options
+          sprockets_options = {
+            context: context,
+            environment: context.environment,
+            dependencies: context.respond_to?(:metadata) ? context.metadata[:dependencies] : []
+          }
+          if context.respond_to?(:metadata)
+            sprockets_options.merge(load_paths: context.environment.paths + default_sass_options[:load_paths])
+          end
+          sprockets_options
+        end
+
+        def sass_options
+          importer = fetch_importer_class
+          sprockets_options = fetch_sprockets_options
+
+          sass = merge_sass_options(default_sass_options, options).merge(
+            filename: filename,
+            line: 1,
+            syntax: self.class.syntax,
+            cache: true,
+            cache_store: build_cache_store(context),
+            importer: importer,
+            custom: { sprockets_context: context },
+            sprockets: sprockets_options
+          )
+          sass
+        end
+      end
+    end
+  end
+end