darkroom 0.0.3 → 0.0.4

data/lib/darkroom/darkroom.rb

@@ -11,10 +11,47 @@ class Darkroom
   PRISTINE = Set.new(%w[/favicon.ico /mask-icon.svg /humans.txt /robots.txt]).freeze
   MIN_PROCESS_INTERVAL = 0.5
 
+  DISALLOWED_PATH_CHARS = '\'"`=<>? '
+  INVALID_PATH = /[#{DISALLOWED_PATH_CHARS}]/.freeze
   TRAILING_SLASHES = /\/+$/.freeze
 
+  @@delegates = {}
+  @@glob = ''
+
   attr_reader(:error, :errors, :process_key)
 
+  ##
+  # Registers an asset delegate.
+  #
+  # * +delegate+ - An HTTP MIME type string, a Hash of Delegate parameters, or a Delegate instance.
+  # * +extensions+ - File extension(s) to associate with this delegate.
+  #
+  def self.register(*extensions, delegate)
+    case delegate
+    when String
+      delegate = Asset::Delegate.new(content_type: delegate.freeze)
+    when Hash
+      delegate = Asset::Delegate.new(**delegate)
+    end
+
+    extensions.each do |extension|
+      @@delegates[extension] = delegate
+    end
+
+    @@glob = "**/*{#{@@delegates.keys.sort.join(',')}}"
+
+    delegate
+  end
+
+  ##
+  # Returns the delegate associated with a file extension.
+  #
+  # * +extension+ - File extension of the desired delegate.
+  #
+  def self.delegate(extension)
+    @@delegates[extension]
+  end
+
   ##
   # Creates a new instance.
   #
@@ -35,9 +72,7 @@ class Darkroom
   def initialize(*load_paths, host: nil, hosts: nil, prefix: nil, pristine: nil, minify: false,
       minified_pattern: DEFAULT_MINIFIED_PATTERN, internal_pattern: DEFAULT_INTERNAL_PATTERN,
       min_process_interval: MIN_PROCESS_INTERVAL)
-    @globs = load_paths.each_with_object({}) do |path, globs|
-      globs[path.chomp('/')] = File.join(path, '**', "*{#{Asset.extensions.join(',')}}")
-    end
+    @load_paths = load_paths.map { |load_path| load_path.chomp('/') }
 
     @hosts = (Array(host) + Array(hosts)).map! { |host| host.sub(TRAILING_SLASHES, '') }
     @minify = minify
@@ -58,6 +93,8 @@ class Darkroom
     @manifest_unversioned = {}
     @manifest_versioned = {}
 
+    @errors = []
+
     Thread.current[:darkroom_host_index] = -1 unless @hosts.empty?
   end
 
@@ -75,14 +112,16 @@ class Darkroom
 
     @mutex.synchronize do
       @process_key += 1
-      @errors = []
+      @errors.clear
       found = {}
 
-      @globs.each do |load_path, glob|
-        Dir.glob(glob).sort.each do |file|
+      @load_paths.each do |load_path|
+        Dir.glob(File.join(load_path, @@glob)).sort.each do |file|
           path = file.sub(load_path, '')
 
-          if found.key?(path)
+          if index = (path =~ INVALID_PATH)
+            @errors << InvalidPathError.new(path, index)
+          elsif found.key?(path)
             @errors << DuplicateAssetError.new(path, found[path], load_path)
           else
             found[path] = load_path
@@ -141,7 +180,7 @@ class Darkroom
   #   darkroom.asset('/assets/js/app.<hash>.js')
   #   darkroom.asset('/assets/js/app.js')
   #
-  # * +path+ - The external path of the asset.
+  # * +path+ - External path of the asset.
   #
   def asset(path)
     @manifest_versioned[path] || @manifest_unversioned[path]
@@ -158,7 +197,7 @@ class Darkroom
   #
   # Raises an AssetNotFoundError if the asset doesn't exist.
   #
-  # * +path+ - The internal path of the asset.
+  # * +path+ - Internal path of the asset.
   # * +versioned+ - Boolean indicating whether the versioned or unversioned path should be returned.
   #
   def asset_path(path, versioned: !@pristine.include?(path))
@@ -174,8 +213,8 @@ class Darkroom
   # Returns an asset's subresource integrity string. Raises an AssetNotFoundError if the asset doesn't
   # exist.
   #
-  # * +path+ - The internal path of the asset.
-  # * +algorithm+ - The hash algorithm to use to generate the integrity string (see Asset#integrity).
+  # * +path+ - Internal path of the asset.
+  # * +algorithm+ - Hash algorithm to use to generate the integrity string (see Asset#integrity).
   #
   def asset_integrity(path, algorithm = nil)
     asset = @manifest[path] or raise(AssetNotFoundError.new(path))
@@ -186,7 +225,7 @@ class Darkroom
   ##
   # Returns the asset from the manifest hash associated with the given path.
   #
-  # * +path+ - The internal path of the asset.
+  # * +path+ - Internal path of the asset.
   #
   def manifest(path)
     @manifest[path]
@@ -204,6 +243,8 @@ class Darkroom
   #   included).
   #
   def dump(dir, clear: false, include_pristine: true)
+    require('fileutils')
+
     dir = File.expand_path(dir)
 
     FileUtils.mkdir_p(dir)
@@ -228,10 +269,10 @@ class Darkroom
   def inspect
     "#<#{self.class}: "\
       "@errors=#{@errors.inspect}, "\
-      "@globs=#{@globs.inspect}, "\
       "@hosts=#{@hosts.inspect}, "\
       "@internal_pattern=#{@internal_pattern.inspect}, "\
       "@last_processed_at=#{@last_processed_at.inspect}, "\
+      "@load_paths=#{@load_paths.inspect}, "\
       "@min_process_interval=#{@min_process_interval.inspect}, "\
       "@minified_pattern=#{@minified_pattern.inspect}, "\
       "@minify=#{@minify.inspect}, "\

data/lib/darkroom/delegates/css.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative('../asset')
+
+class Darkroom
+  class Asset
+    ##
+    # Delegate for CSS assets.
+    #
+    CSSDelegate = Delegate.new(
+      content_type: 'text/css',
+      import_regex: /^ *@import +#{QUOTED_PATH.source} *; *(\n|$)/.freeze,
+      reference_regex: /url\(\s*#{REFERENCE_PATH.source}\s*\)/x.freeze,
+
+      validate_reference: ->(asset, match, format) do
+        if format == 'displace'
+          'Cannot displace in CSS files'
+        elsif !asset.image? && !asset.font?
+          'Referenced asset must be an image or font type'
+        end
+      end,
+
+      reference_content: ->(asset, match, format) do
+        if format == 'utf8'
+          content = asset.content.gsub('#', '%23')
+          content.gsub!(/(['"])/, '\\\\\1')
+          content.gsub!("\n", "\\\n")
+
+          content
+        end
+      end,
+
+      minify_lib: 'sassc',
+      minify: ->(content) do
+        SassC::Engine.new(content, style: :compressed).render
+      end,
+    )
+  end
+end

data/lib/darkroom/delegates/html.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative('../asset')
+
+class Darkroom
+  class Asset
+    HTMLDelegate = Delegate.new(
+      content_type: 'text/html',
+      reference_regex: %r{
+        <(?<tag>a|area|audio|base|embed|iframe|img|input|link|script|source|track|video)\s+[^>]*
+        (?<attr>href|src)=#{REFERENCE_PATH.source}[^>]*>
+      }x.freeze,
+
+      validate_reference: ->(asset, match, format) do
+        return unless format == 'displace'
+
+        if match[:tag] == 'link'
+          'Asset type must be text/css' unless asset.content_type == 'text/css'
+        elsif match[:tag] == 'script'
+          'Asset type must be text/javascript' unless asset.content_type == 'text/javascript'
+        elsif match[:tag] == 'img'
+          'Asset type must be image/svg+xml' unless asset.content_type == 'image/svg+xml'
+        else
+          "Cannot displace <#{match[:tag]}> tags"
+        end
+      end,
+
+      reference_content: ->(asset, match, format) do
+        case format
+        when 'displace'
+          if match[:tag] == 'link' && asset.content_type == 'text/css'
+            "<style>#{asset.content}</style>"
+          elsif match[:tag] == 'script' && asset.content_type == 'text/javascript'
+            offset = match.begin(0)
+
+            "#{match[0][0..(match.begin(:attr) - 2 - offset)]}"\
+            "#{match[0][(match.end(:quoted) + match[:quote].size - offset)..(match.end(0) - offset)]}"\
+            "#{asset.content}"
+          elsif match[:tag] == 'img' && asset.content_type == 'image/svg+xml'
+            asset.content
+          end
+        when 'utf8'
+          quote = match[:quote] == '' ? Asset::DEFAULT_QUOTE : match[:quote]
+
+          content = asset.content.gsub('#', '%23')
+          content.gsub!(quote, quote == "'" ? '"' : "'")
+
+          content
+        end
+      end,
+    )
+  end
+end

data/lib/darkroom/delegates/htx.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative('../asset')
+require_relative('html')
+require_relative('javascript')
+
+class Darkroom
+  class Asset
+    HTXDelegate = Delegate.new(
+      content_type: JavaScriptDelegate.content_type,
+      import_regex: HTMLDelegate.import_regex,
+      reference_regex: HTMLDelegate.reference_regex,
+      validate_reference: HTMLDelegate.validate_reference,
+      reference_content: HTMLDelegate.reference_content,
+      compile_lib: 'htx',
+      compile: ->(path, content) { HTX.compile(path, content) },
+      minify_lib: JavaScriptDelegate.minify_lib,
+      minify: JavaScriptDelegate.minify,
+    )
+  end
+end

data/lib/darkroom/delegates/javascript.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative('../asset')
+
+class Darkroom
+  class Asset
+    JavaScriptDelegate = Delegate.new(
+      content_type: 'text/javascript',
+      import_regex: /^ *import +#{QUOTED_PATH.source} *;? *(\n|$)/.freeze,
+      minify_lib: 'uglifier',
+      minify: ->(content) do
+        Uglifier.compile(content, harmony: true)
+      end,
+    )
+  end
+end

data/lib/darkroom/errors/asset_error.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+class Darkroom
+  ##
+  # General error class used for errors encountered while processing an asset.
+  #
+  class AssetError < StandardError
+    attr_reader(:detail, :source_path, :source_line_num)
+
+    ##
+    # Creates a new instance.
+    #
+    # * +message+ - Description of the error.
+    # * +detail+ - Additional detail about the error.
+    # * +source_path+ - Path of the asset that contains the error (optional).
+    # * +source_line_num+ - Line number in the asset where the error is located (optional).
+    #
+    def initialize(message, detail, source_path = nil, source_line_num = nil)
+      super(message)
+
+      @detail = detail
+      @source_path = source_path
+      @source_line_num = source_line_num
+    end
+
+    ##
+    # Returns a string representation of the error.
+    #
+    def to_s
+      "#{"#{@source_path}:#{@source_line_num || '?'}: " if @source_path}#{super}: #{@detail}"
+    end
+  end
+end

data/lib/darkroom/errors/asset_not_found_error.rb

@@ -1,33 +1,22 @@
 # frozen_string_literal: true
 
+require_relative('asset_error')
+
 class Darkroom
   ##
-  # Error class used when an asset requested explicitly or specified as a dependency of another cannot be
-  # found.
+  # Error class used when an asset requested explicitly or specified as a dependency of another doesn't
+  # exist.
   #
-  class AssetNotFoundError < StandardError
-    attr_reader(:path, :referenced_from, :referenced_from_line)
-
+  class AssetNotFoundError < AssetError
     ##
     # Creates a new instance.
     #
-    # * +path+ - The path of the asset that cannot be found.
-    # * +referenced_from+ - The path of the asset the not-found asset was referenced from.
-    # * +referenced_from_line+ - The line number where the not-found asset was referenced.
-    #
-    def initialize(path, referenced_from = nil, referenced_from_line = nil)
-      @path = path
-      @referenced_from = referenced_from
-      @referenced_from_line = referenced_from_line
-    end
-
-    ##
-    # Returns a string representation of the error.
+    # * +path+ - Path of asset that doesn't exist.
+    # * +source_path+ - Path of the asset that contains the error (optional).
+    # * +source_line_num+ - Line number in the asset where the error is located (optional).
     #
-    def to_s
-      "Asset not found#{
-        " (referenced from #{@referenced_from}:#{@referenced_from_line || '?'})" if @referenced_from
-      }: #{@path}"
+    def initialize(path, source_path = nil, source_line_num = nil)
+      super('Asset not found', path, source_path, source_line_num)
     end
   end
 end

data/lib/darkroom/errors/circular_reference_error.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative('asset_error')
+
+class Darkroom
+  ##
+  # Error class used when an asset reference results in a circular reference chain.
+  #
+  class CircularReferenceError < AssetError
+    ##
+    # Creates a new instance.
+    #
+    # * +snippet+ - Snippet showing the reference.
+    # * +source_path+ - Path of the asset that contains the error.
+    # * +source_line_num+ - Line number in the asset where the error is located.
+    #
+    def initialize(snippet, source_path, source_line_num)
+      super('Reference would result in a circular reference chain', snippet, source_path, source_line_num)
+    end
+  end
+end

data/lib/darkroom/errors/duplicate_asset_error.rb

@@ -2,7 +2,7 @@
 
 class Darkroom
   ##
-  # Error class used when an asset exists in multiple load paths.
+  # Error class used when an asset exists under multiple load paths.
   #
   class DuplicateAssetError < StandardError
     attr_reader(:path, :first_load_path, :second_load_path)
@@ -10,9 +10,9 @@ class Darkroom
     ##
     # Creates a new instance.
     #
-    # * +path+ - The path of the asset that has the same path as another asset.
-    # * +first_load_path+ - The load path where the first asset with the path was found.
-    # * +second_load_path+ - The load path where the second asset with the path was found.
+    # * +path+ - Path of the asset that exists under multiple load paths.
+    # * +first_load_path+ - Load path where the asset was first found.
+    # * +second_load_path+ - Load path where the asset was subsequently found.
     #
     def initialize(path, first_load_path, second_load_path)
       @path = path

data/lib/darkroom/errors/invalid_path_error.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class Darkroom
+  ##
+  # Error class used when an asset's path contains one or more invalid characters.
+  #
+  class InvalidPathError < StandardError
+    attr_reader(:path, :index)
+
+    ##
+    # Creates a new instance.
+    #
+    # * +path+ - Path of the asset with the invalid character(s).
+    # * +index+ - Position of the first bad character in the path.
+    #
+    def initialize(path, index)
+      @path = path
+      @index = index
+    end
+
+    ##
+    # Returns a string representation of the error.
+    #
+    def to_s
+      "Asset path contains one or more invalid characters (#{DISALLOWED_PATH_CHARS}): #{@path}"
+    end
+  end
+end

data/lib/darkroom/errors/missing_library_error.rb

@@ -10,9 +10,9 @@ class Darkroom
     ##
     # Creates a new instance.
     #
-    # * +library+ - The name of the library that's missing.
-    # * +need+ - The reason the library is needed ('compile' or 'minify').
-    # * +extension+ - The extenion of the type of asset that needs the library.
+    # * +library+ - Name of the library that's missing.
+    # * +need+ - Reason the library is needed ('compile' or 'minify').
+    # * +extension+ - Extension of the type of asset that needs the library.
     #
     def initialize(library, need, extension)
       @library = library