darkroom 0.0.2 → 0.0.5

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

data/lib/darkroom/errors/unrecognized_extension_error.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative('asset_error')
+
+class Darkroom
+  ##
+  # Error class used when a reference is made to a file with an unrecognized extension.
+  #
+  class UnrecognizedExtensionError < AssetError
+    ##
+    # Creates a new instance.
+    #
+    # * +file+ - File with the unrecognized extension.
+    # * +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(file, source_path = nil, source_line_num = nil)
+      super('File extension not recognized', file, source_path, source_line_num)
+    end
+  end
+end

data/lib/darkroom/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Darkroom
-  VERSION = '0.0.2'
+  VERSION = '0.0.5'
 end

data/lib/darkroom.rb

@@ -4,36 +4,29 @@ require('darkroom/asset')
 require('darkroom/darkroom')
 require('darkroom/version')
 
+require('darkroom/delegates/css')
+require('darkroom/delegates/html')
+require('darkroom/delegates/htx')
+require('darkroom/delegates/javascript')
+
+require('darkroom/errors/asset_error')
 require('darkroom/errors/asset_not_found_error')
+require('darkroom/errors/circular_reference_error')
 require('darkroom/errors/duplicate_asset_error')
+require('darkroom/errors/invalid_path_error')
 require('darkroom/errors/missing_library_error')
 require('darkroom/errors/processing_error')
-require('darkroom/errors/spec_not_defined_error')
-
-Darkroom::Asset.add_spec('.css', 'text/css',
-  dependency_regex: /^ *@import +(?<quote>['"]) *(?<path>.*) *\g<quote> *; *$/,
-  minify: -> (content) { CSSminify.compress(content) },
-  minify_lib: 'cssminify',
-)
-
-Darkroom::Asset.add_spec('.js', 'application/javascript',
-  dependency_regex: /^ *import +(?<quote>['"])(?<path>.*)\g<quote> *;? *$/,
-  minify: -> (content) { Uglifier.compile(content, harmony: true) },
-  minify_lib: 'uglifier',
-)
-
-Darkroom::Asset.add_spec('.htx', 'application/javascript',
-  compile: -> (path, content) { HTX.compile(path, content) },
-  compile_lib: 'htx',
-  minify: Darkroom::Asset.spec('.js').minify,
-  minify_lib: Darkroom::Asset.spec('.js').minify_lib,
-)
+require('darkroom/errors/unrecognized_extension_error')
 
-Darkroom::Asset.add_spec('.html', '.html', 'text/html')
-Darkroom::Asset.add_spec('.ico', 'image/x-icon')
-Darkroom::Asset.add_spec('.jpg', '.jpeg', 'image/jpeg')
-Darkroom::Asset.add_spec('.png', 'image/png')
-Darkroom::Asset.add_spec('.svg', 'image/svg+xml')
-Darkroom::Asset.add_spec('.txt', 'text/plain')
-Darkroom::Asset.add_spec('.woff', 'font/woff')
-Darkroom::Asset.add_spec('.woff2', 'font/woff2')
+Darkroom.register('.css', Darkroom::Asset::CSSDelegate)
+Darkroom.register('.htm', '.html', Darkroom::Asset::HTMLDelegate)
+Darkroom.register('.htx', Darkroom::Asset::HTXDelegate)
+Darkroom.register('.ico', 'image/x-icon')
+Darkroom.register('.jpg', '.jpeg', 'image/jpeg')
+Darkroom.register('.js', Darkroom::Asset::JavaScriptDelegate)
+Darkroom.register('.json', 'application/json')
+Darkroom.register('.png', 'image/png')
+Darkroom.register('.svg', 'image/svg+xml')
+Darkroom.register('.txt', 'text/plain')
+Darkroom.register('.woff', 'font/woff')
+Darkroom.register('.woff2', 'font/woff2')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: darkroom
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.5
 platform: ruby
 authors:
 - Nate Pickens
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-25 00:00:00.000000000 Z
+date: 2022-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,8 +44,10 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 6.0.0
-description: Darkroom provides simple web asset management complete with dependency
-  bundling based on import statements, compilation, and minification.
+description: Darkroom provides web asset compilation, bundling, and minification without
+  any external tools, manifest files, or special comment syntax. CSS and JavaScript
+  bundles are automatically generated based on import statements native to each language.
+  Darkroom is also extensible, allowing support to be added for arbitrary file types.
 email:
 executables: []
 extensions: []
@@ -57,11 +59,18 @@ files:
 - lib/darkroom.rb
 - lib/darkroom/asset.rb
 - lib/darkroom/darkroom.rb
+- lib/darkroom/delegates/css.rb
+- lib/darkroom/delegates/html.rb
+- lib/darkroom/delegates/htx.rb
+- lib/darkroom/delegates/javascript.rb
+- lib/darkroom/errors/asset_error.rb
 - lib/darkroom/errors/asset_not_found_error.rb
+- lib/darkroom/errors/circular_reference_error.rb
 - lib/darkroom/errors/duplicate_asset_error.rb
+- lib/darkroom/errors/invalid_path_error.rb
 - lib/darkroom/errors/missing_library_error.rb
 - lib/darkroom/errors/processing_error.rb
-- lib/darkroom/errors/spec_not_defined_error.rb
+- lib/darkroom/errors/unrecognized_extension_error.rb
 - lib/darkroom/version.rb
 homepage: https://github.com/npickens/darkroom
 licenses:
@@ -85,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: A fast, lightweight, and straightforward web asset management library.

data/lib/darkroom/errors/spec_not_defined_error.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-class Darkroom
-  ##
-  # Error class used when a spec is not defined for a particular file extension.
-  #
-  class SpecNotDefinedError < StandardError
-    attr_reader(:extension, :file)
-
-    ##
-    # Creates a new instance.
-    #
-    # * +extension+ - Extension for which there is no spec defined.
-    # * +file+ - File path of the asset whose loading was attempted.
-    #
-    def initialize(extension, file = nil)
-      @extension = extension
-      @file = file
-    end
-
-    ##
-    # Returns a string representation of the error.
-    #
-    def to_s
-      "Spec not defined for #{@extension} files#{" (#{@file})" if @file}"
-    end
-  end
-end