sprockets 3.0.3 → 4.2.0

data/lib/sprockets/preprocessors/default_source_map.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+module Sprockets
+  module Preprocessors
+    # Private: Adds a default map to assets when one is not present
+    #
+    # If the input file already has a source map, it effectively returns the original
+    # result. Otherwise it maps 1 for 1 lines original to generated. This is needed
+    # Because other generators run after might depend on having a valid source map
+    # available.
+    class DefaultSourceMap
+      def call(input)
+        result        = { data: input[:data] }
+        map           = input[:metadata][:map]
+        filename      = input[:filename]
+        load_path     = input[:load_path]
+        lines         = input[:data].lines.length
+        basename      = File.basename(filename)
+        mime_exts     = input[:environment].config[:mime_exts]
+        pipeline_exts = input[:environment].config[:pipeline_exts]
+        if map.nil? || map.empty?
+          result[:map] = {
+            "version"   => 3,
+            "file"      => PathUtils.split_subpath(load_path, filename),
+            "mappings"  => default_mappings(lines),
+            "sources"   => [PathUtils.set_pipeline(basename, mime_exts, pipeline_exts, :source)],
+            "names"     => []
+          }
+        else
+          result[:map] = map
+        end
+
+        result[:map]["x_sprockets_linecount"] = lines
+        return result
+      end
+
+      private
+
+      def default_mappings(lines)
+        if (lines == 0)
+          ""
+        elsif (lines == 1)
+          "AAAA"
+        else
+          "AAAA;" + "AACA;"*(lines - 2) + "AACA"
+        end
+      end
+    end
+  end
+end

data/lib/sprockets/processing.rb

@@ -1,7 +1,5 @@
-require 'sprockets/engines'
+# frozen_string_literal: true
 require 'sprockets/file_reader'
-require 'sprockets/legacy_proc_processor'
-require 'sprockets/legacy_tilt_processor'
 require 'sprockets/mime'
 require 'sprockets/processor_utils'
 require 'sprockets/uri_utils'
@@ -17,9 +15,14 @@ module Sprockets
       config[:pipelines]
     end
 
+    # Registers a pipeline that will be called by `call_processor` method.
     def register_pipeline(name, proc = nil, &block)
       proc ||= block
 
+      self.config = hash_reassoc(config, :pipeline_exts) do |pipeline_exts|
+        pipeline_exts.merge(".#{name}".freeze => name.to_sym)
+      end
+
       self.config = hash_reassoc(config, :pipelines) do |pipelines|
         pipelines.merge(name.to_sym => proc)
       end
@@ -43,12 +46,13 @@ module Sprockets
     #
     # A block can be passed for to create a shorthand processor.
     #
-    #     register_preprocessor 'text/css', :my_processor do |context, data|
-    #       data.gsub(...)
+    #     register_preprocessor 'text/css' do |input|
+    #       input[:data].gsub(...)
     #     end
     #
     def register_preprocessor(*args, &block)
       register_config_processor(:preprocessors, *args, &block)
+      compute_transformers!(self.config[:registered_transformers])
     end
     alias_method :register_processor, :register_preprocessor
 
@@ -58,12 +62,13 @@ module Sprockets
     #
     # A block can be passed for to create a shorthand processor.
     #
-    #     register_postprocessor 'application/javascript', :my_processor do |context, data|
-    #       data.gsub(...)
+    #     register_postprocessor 'application/javascript' do |input|
+    #       input[:data].gsub(...)
     #     end
     #
     def register_postprocessor(*args, &block)
       register_config_processor(:postprocessors, *args, &block)
+      compute_transformers!(self.config[:registered_transformers])
     end
 
     # Remove Preprocessor `klass` for `mime_type`.
@@ -72,6 +77,7 @@ module Sprockets
     #
     def unregister_preprocessor(*args)
       unregister_config_processor(:preprocessors, *args)
+      compute_transformers!(self.config[:registered_transformers])
     end
     alias_method :unregister_processor, :unregister_preprocessor
 
@@ -81,6 +87,7 @@ module Sprockets
     #
     def unregister_postprocessor(*args)
       unregister_config_processor(:postprocessors, *args)
+      compute_transformers!(self.config[:registered_transformers])
     end
 
     # Bundle Processors are ran on concatenated assets rather than
@@ -95,8 +102,8 @@ module Sprockets
     #
     # A block can be passed for to create a shorthand processor.
     #
-    #     register_bundle_processor 'application/javascript', :my_processor do |context, data|
-    #       data.gsub(...)
+    #     register_bundle_processor 'application/javascript' do |input|
+    #       input[:data].gsub(...)
     #     end
     #
     def register_bundle_processor(*args, &block)
@@ -123,7 +130,7 @@ module Sprockets
     #
     # mime_type - String MIME Type. Use '*/*' applies to all types.
     # key       - Symbol metadata key
-    # initial   - Initial memo to pass to the reduce funciton (default: nil)
+    # initial   - Initial memo to pass to the reduce function (default: nil)
     # block     - Proc accepting the memo accumulator and current value
     #
     # Returns nothing.
@@ -154,46 +161,44 @@ module Sprockets
     protected
       def resolve_processors_cache_key_uri(uri)
         params = parse_uri_query_params(uri[11..-1])
-        params[:engine_extnames] = params[:engines] ? params[:engines].split(',') : []
-        processors = processors_for(params[:type], params[:file_type], params[:engine_extnames], params[:pipeline])
+        processors = processors_for(params[:type], params[:file_type], params[:pipeline])
         processors_cache_keys(processors)
       end
 
-      def build_processors_uri(type, file_type, engine_extnames, pipeline)
-        engines = engine_extnames.join(',') if engine_extnames.any?
+      def build_processors_uri(type, file_type, pipeline)
         query = encode_uri_query_params(
           type: type,
           file_type: file_type,
-          engines: engines,
           pipeline: pipeline
         )
         "processors:#{query}"
       end
 
-      def processors_for(type, file_type, engine_extnames, pipeline)
+      def processors_for(type, file_type, pipeline)
         pipeline ||= :default
-        config[:pipelines][pipeline.to_sym].call(self, type, file_type, engine_extnames)
+        if fn = config[:pipelines][pipeline.to_sym]
+          fn.call(self, type, file_type)
+        else
+          raise Error, "no pipeline: #{pipeline}"
+        end
       end
 
-      def default_processors_for(type, file_type, engine_extnames)
+      def default_processors_for(type, file_type)
         bundled_processors = config[:bundle_processors][type]
         if bundled_processors.any?
           bundled_processors
         else
-          self_processors_for(type, file_type, engine_extnames)
+          self_processors_for(type, file_type)
         end
       end
 
-      def self_processors_for(type, file_type, engine_extnames)
+      def self_processors_for(type, file_type)
         processors = []
 
         processors.concat config[:postprocessors][type]
-
         if type != file_type && processor = config[:transformers][file_type][type]
           processors << processor
         end
-
-        processors.concat engine_extnames.map { |ext| engines[ext] }
         processors.concat config[:preprocessors][file_type]
 
         if processors.any? || mime_type_charset_detecter(type)
@@ -204,45 +209,20 @@ module Sprockets
       end
 
     private
-      def register_config_processor(type, mime_type, klass, proc = nil, &block)
-        proc ||= block
-        processor = wrap_processor(klass, proc)
+      def register_config_processor(type, mime_type, processor = nil, &block)
+        processor ||= block
 
         self.config = hash_reassoc(config, type, mime_type) do |processors|
           processors.unshift(processor)
           processors
         end
-
-        compute_transformers!
       end
 
-      def unregister_config_processor(type, mime_type, klass)
-        if klass.is_a?(String) || klass.is_a?(Symbol)
-          klass = config[type][mime_type].detect do |cls|
-            cls.respond_to?(:name) && cls.name == "Sprockets::LegacyProcProcessor (#{klass})"
-          end
-        end
-
+      def unregister_config_processor(type, mime_type, processor)
         self.config = hash_reassoc(config, type, mime_type) do |processors|
-          processors.delete(klass)
+          processors.delete_if { |p| p == processor || p.class == processor }
           processors
         end
-
-        compute_transformers!
-      end
-
-      def wrap_processor(klass, proc)
-        if !proc
-          if klass.respond_to?(:call)
-            klass
-          else
-            LegacyTiltProcessor.new(klass)
-          end
-        elsif proc.respond_to?(:arity) && proc.arity == 2
-          LegacyProcProcessor.new(klass.to_s, proc)
-        else
-          proc
-        end
       end
   end
 end

data/lib/sprockets/processor_utils.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
 require 'set'
 
 module Sprockets
   # Functional utilities for dealing with Processor functions.
   #
-  # A Processor is a general function that my modify or transform an asset as
+  # A Processor is a general function that may modify or transform an asset as
   # part of the pipeline. CoffeeScript to JavaScript conversion, Minification
-  # or Concatenation are all implemented as seperate Processor steps.
+  # or Concatenation are all implemented as separate Processor steps.
   #
   # Processors maybe any object that responds to call. So procs or a class that
   # defines a self.call method.
@@ -16,26 +17,34 @@ module Sprockets
   module ProcessorUtils
     extend self
 
+    class CompositeProcessor < Struct.new(:processor_strategy, :param, :processors) # :nodoc:
+      SINGULAR = lambda { |param, input| ProcessorUtils.call_processor param, input }
+      PLURAL   = lambda { |param, input| ProcessorUtils.call_processors param, input }
+
+      def self.create(processors)
+        if processors.length == 1
+          new SINGULAR, processors.first, processors
+        else
+          new PLURAL, processors, processors
+        end
+      end
+
+      def call(input)
+        processor_strategy.call param, input
+      end
+
+      def cache_key
+        ProcessorUtils.processors_cache_keys(processors)
+      end
+    end
+
     # Public: Compose processors in right to left order.
     #
     # processors - Array of processors callables
     #
     # Returns a composed Proc.
     def compose_processors(*processors)
-      context = self
-
-      if processors.length == 1
-        obj = method(:call_processor).to_proc.curry[processors.first]
-      else
-        obj = method(:call_processors).to_proc.curry[processors]
-      end
-
-      metaclass = (class << obj; self; end)
-      metaclass.send(:define_method, :cache_key) do
-        context.processors_cache_keys(processors)
-      end
-
-      obj
+      CompositeProcessor.create processors
     end
 
     # Public: Invoke list of processors in right to left order.
@@ -107,11 +116,10 @@ module Sprockets
     VALID_METADATA_VALUE_TYPES = Set.new([
       String,
       Symbol,
-      Fixnum,
-      Bignum,
       TrueClass,
       FalseClass,
-      NilClass
+      NilClass,
+      Integer
     ]).freeze
 
     # Internal: Set of all nested compound metadata types that can nest values.
@@ -121,6 +129,17 @@ module Sprockets
       Set
     ]).freeze
 
+    # Internal: Hash of all "simple" value types allowed to be returned in
+    # processor metadata.
+    VALID_METADATA_VALUE_TYPES_HASH = VALID_METADATA_VALUE_TYPES.each_with_object({}) do |type, hash|
+      hash[type] = true
+    end.freeze
+
+    # Internal: Hash of all nested compound metadata types that can nest values.
+    VALID_METADATA_COMPOUND_TYPES_HASH = VALID_METADATA_COMPOUND_TYPES.each_with_object({}) do |type, hash|
+      hash[type] = true
+    end.freeze
+
     # Internal: Set of all allowed metadata types.
     VALID_METADATA_TYPES = (VALID_METADATA_VALUE_TYPES + VALID_METADATA_COMPOUND_TYPES).freeze
 
@@ -143,29 +162,9 @@ module Sprockets
         if !key.instance_of?(Symbol)
           raise TypeError, "processor metadata[#{key.inspect}] expected to be a Symbol"
         end
-
-        if !valid_processor_metadata_value?(value)
-          raise TypeError, "processor metadata[:#{key}] returned a complex type: #{value.inspect}\n" +
-            "Only #{VALID_METADATA_TYPES.to_a.join(", ")} maybe used."
-        end
       end
 
       result
     end
-
-    # Internal: Validate object is in validate metadata whitelist.
-    #
-    # value - Any Object
-    #
-    # Returns true if class is in whitelist otherwise false.
-    def valid_processor_metadata_value?(value)
-      if VALID_METADATA_VALUE_TYPES.include?(value.class)
-        true
-      elsif VALID_METADATA_COMPOUND_TYPES.include?(value.class)
-        value.all? { |v| valid_processor_metadata_value?(v) }
-      else
-        false
-      end
-    end
   end
 end