darkroom 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15822eea03a5814dc169523ec7285c97b12efa7e3818a5de03099b670823564d
-  data.tar.gz: 6ab19e03a8282508ea571d1d30b458750aaad273af0151d2582eeff889d69a4e
+  metadata.gz: 518b5ff3d82631d41125029a7292c2bfdd8942990a7e92e2be08f99217fe8d02
+  data.tar.gz: 388cf8db580df8de6d85a9d196786ef7400a97a096dfbbb316de4b0dbca8e295
 SHA512:
-  metadata.gz: a421ab802832dd3268d8fdb17cf1c3843f5bf554ec43eace104b3e324a53bf4790f5268a65b4c1acb5b545782ab69fda5ea5aeebca62b77f3cc1ebe4889aa5d7
-  data.tar.gz: b040b997cbc321ce11af041f387bb1a89543071b9b657a38575602e8663e87573ff6442af8c016061ce29fdb67284f5301cbcbaa22b14cd8c8d1ce6a61b255db
+  metadata.gz: 439b783c5d7afcb20c6a5bde715f686e42236bd70251af909938784f3c4e855f3e22b8fa779b1de19478e64e17462dc4fe37d28f043c0a62f95d13cc8e40829a
+  data.tar.gz: 3bb350472717b4a656e71ef3c7c1b8c200b88c7414c3f7feecfee46b19327e7d7bb5bb061878474d584c65afa84777cdf784fe76fd0cada86cecfbb20485fd13

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/darkroom/asset.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require('base64')
 require('digest')
 
 class Darkroom
@@ -12,7 +13,7 @@ class Darkroom
 
     @@specs = {}
 
-    attr_reader(:content, :error, :errors, :path, :path_versioned)
+    attr_reader(:content, :error, :errors, :path, :path_unversioned, :path_versioned)
 
     ##
     # Holds information about how to handle a particular asset type.
@@ -72,18 +73,21 @@ class Darkroom
     #
     # * +file+ - The path to the file on disk.
     # * +path+ - The path this asset will be referenced by (e.g. /js/app.js).
-    # * +manifest+ - Manifest hash from the Darkroom instance that the asset is a member of.
+    # * +darkroom+ - Darkroom instance that the asset is a member of.
+    # * +prefix+ - Prefix to apply to unversioned and versioned paths.
     # * +minify+ - Boolean specifying whether or not the asset should be minified when processed.
     # * +internal+ - Boolean indicating whether or not the asset is only accessible internally (i.e. as a
     #   dependency).
     #
-    def initialize(path, file, manifest, minify: false, internal: false)
+    def initialize(path, file, darkroom, prefix: nil, minify: false, internal: false)
       @path = path
       @file = file
-      @manifest = manifest
+      @darkroom = darkroom
+      @prefix = prefix
       @minify = minify
       @internal = internal
 
+      @path_unversioned = "#{@prefix}#{@path}"
       @extension = File.extname(@path).downcase
       @spec = self.class.spec(@extension) or raise(SpecNotDefinedError.new(@extension, @file))
 
@@ -92,35 +96,26 @@ class Darkroom
     end
 
     ##
-    # Processes the asset if necessary (file's mtime is compared to the last time it was processed). File is
-    # read from disk, any dependencies are merged into its content (if spec for the asset type allows for
-    # it), the content is compiled (if the asset type requires compilation), and minified (if specified for
-    # this Asset). Returns true if asset was modified since it was last processed and false otherwise.
+    # Processes the asset if modified (see #modified? for how modification is determined). File is read from
+    # disk, any dependencies are merged into its content (if spec for the asset type allows for it), the
+    # content is compiled (if the asset type requires compilation), and minified (if specified for this
+    # Asset). Returns true if asset was modified since it was last processed and false otherwise.
     #
-    # * +key+ - Unique value associated with the current round of processing.
-    #
-    def process(key)
-      key == @process_key ? (return @modified) : (@process_key = key)
-
-      begin
-        @modified = @mtime != (@mtime = File.mtime(@file))
-        @modified ||= @dependencies.any? { |d| d.process(key) }
-
-        return false unless @modified
-      rescue Errno::ENOENT
-        clear
-        return @modified = true
-      end
+    def process
+      @process_key == @darkroom.process_key ? (return @processed) : (@process_key = @darkroom.process_key)
+      modified? ? (@processed = true) : (return @processed = false)
 
       clear
-      read(key)
+      read
       compile
       minify
 
       @fingerprint = Digest::MD5.hexdigest(@content)
-      @path_versioned = @path.sub(EXTENSION_REGEX, "-#{@fingerprint}")
+      @path_versioned = "#{@prefix}#{@path.sub(EXTENSION_REGEX, "-#{@fingerprint}")}"
 
-      @modified
+      @processed
+    rescue Errno::ENOENT
+      # File was deleted. Do nothing.
     ensure
       @error = @errors.empty? ? nil : ProcessingError.new(@errors)
     end
@@ -145,6 +140,23 @@ class Darkroom
       }.compact!
     end
 
+    ##
+    # Returns subresource integrity string.
+    #
+    # * +algorithm+ - The hash algorithm to use to generate the integrity string (one of sha256, sha384, or
+    #   sha512).
+    #
+    def integrity(algorithm = :sha384)
+      @integrity[algorithm] ||= "#{algorithm}-#{Base64.strict_encode64(
+        case algorithm
+        when :sha256 then Digest::SHA256.digest(@content)
+        when :sha384 then Digest::SHA384.digest(@content)
+        when :sha512 then Digest::SHA512.digest(@content)
+        else raise("Unrecognized integrity algorithm: #{algorithm}")
+        end
+      )}".freeze
+    end
+
     ##
     # Returns boolean indicating whether or not the asset is marked as internal.
     #
@@ -173,24 +185,57 @@ class Darkroom
         "@minify=#{@minify.inspect}, "\
         "@mtime=#{@mtime.inspect}, "\
         "@path=#{@path.inspect}, "\
-        "@path_versioned=#{@path_versioned.inspect}"\
+        "@path_unversioned=#{@path_unversioned.inspect}, "\
+        "@path_versioned=#{@path_versioned.inspect}, "\
+        "@prefix=#{@prefix.inspect}"\
       '>'
     end
 
     protected
 
     ##
-    # Returns the processed content of the asset without dependencies concatenated.
+    # Returns true if the asset or any of its dependencies were modified since last processed, or if an
+    # error was recorded during the last processing run.
     #
-    def own_content
-      @own_content
+    def modified?
+      @modified_key == @darkroom.process_key ? (return @modified) : (@modified_key = @darkroom.process_key)
+
+      begin
+        @modified = !!@error
+        @modified ||= @mtime != (@mtime = File.mtime(@file))
+        @modified ||= dependencies.any? { |d| d.modified? }
+      rescue Errno::ENOENT
+        @modified = true
+      end
     end
 
     ##
-    # Returns an array of all the asset's dependencies.
+    # Returns all dependencies (including dependencies of dependencies).
+    #
+    # * +ancestors+ - Ancestor chain followed to get to this asset as a dependency.
     #
-    def dependencies
-      @dependencies
+    def dependencies(ancestors = Set.new)
+      @dependencies ||= @own_dependencies.inject([]) do |dependencies, own_dependency|
+        next dependencies if ancestors.include?(self)
+
+        ancestors << self
+        own_dependency.process
+
+        dependencies |= own_dependency.dependencies(ancestors)
+        dependencies |= [own_dependency]
+
+        dependencies.delete(self)
+        ancestors.delete(self)
+
+        dependencies
+      end
+    end
+
+    ##
+    # Returns the processed content of the asset without dependencies concatenated.
+    #
+    def own_content
+      @own_content
     end
 
     private
@@ -199,48 +244,40 @@ class Darkroom
     # Clears content, dependencies, and errors so asset is ready for (re)processing.
     #
     def clear
+      @dependencies = nil
+      @error = nil
+      @fingerprint = nil
+      @path_versioned = nil
+
       (@errors ||= []).clear
-      (@dependencies ||= []).clear
+      (@own_dependencies ||= []).clear
       (@content ||= +'').clear
       (@own_content ||= +'').clear
+      (@integrity ||= {}).clear
     end
 
     ##
     # Reads the asset file, building dependency array if dependencies are supported for the asset's type.
     #
-    # * +key+ - Unique value associated with the current round of processing.
-    #
-    def read(key)
-      if @spec.dependency_regex
-        dependencies = []
-
-        File.new(@file).each.with_index do |line, line_num|
-          if (path = line[@spec.dependency_regex, :path])
-            if (dependency = @manifest[path])
-              dependencies << dependency
-            else
-              @errors << AssetNotFoundError.new(path, @path, line_num + 1)
-            end
+    def read
+      unless @spec.dependency_regex
+        @own_content = File.read(@file)
+        return
+      end
+
+      File.new(@file).each.with_index do |line, line_num|
+        if (path = line[@spec.dependency_regex, :path])
+          if (dependency = @darkroom.manifest(path))
+            @own_dependencies << dependency
           else
-            @own_content << line
+            @errors << AssetNotFoundError.new(path, @path, line_num + 1)
           end
+        else
+          @own_content << line
         end
-
-        dependencies.each do |dependency|
-          dependency.process(key)
-
-          @dependencies += dependency.dependencies
-          @dependencies << dependency
-        end
-
-        @dependencies.uniq!
-        @dependencies.delete_if { |d| d.path == @path }
-
-        @content << @dependencies.map { |d| d.own_content }.join(DEPENDENCY_JOINER)
-        @own_content
-      else
-        @own_content = File.read(@file)
       end
+
+      @content << dependencies.map { |d| d.own_content }.join(DEPENDENCY_JOINER)
     end
 
     ##
@@ -287,14 +324,17 @@ class Darkroom
       begin
         require(@spec.compile_lib) if @spec.compile_lib
       rescue LoadError
-        raise(MissingLibraryError.new(@spec.compile_lib, 'compile', @extension))
+        compile_load_error = true
       end
 
       begin
         require(@spec.minify_lib) if @spec.minify_lib && @minify
       rescue LoadError
-        raise(MissingLibraryError.new(@spec.minify_lib, 'minify', @extension))
+        minify_load_error = true
       end
+
+      raise(MissingLibraryError.new(@spec.compile_lib, 'compile', @extension)) if compile_load_error
+      raise(MissingLibraryError.new(@spec.minify_lib, 'minify', @extension)) if minify_load_error
     end
   end
 end

data/lib/darkroom/darkroom.rb

@@ -13,7 +13,7 @@ class Darkroom
 
   TRAILING_SLASHES = /\/+$/.freeze
 
-  attr_reader(:error, :errors)
+  attr_reader(:error, :errors, :process_key)
 
   ##
   # Creates a new instance.
@@ -51,8 +51,12 @@ class Darkroom
 
     @min_process_interval = min_process_interval
     @last_processed_at = 0
+    @process_key = 0
     @mutex = Mutex.new
+
     @manifest = {}
+    @manifest_unversioned = {}
+    @manifest_versioned = {}
 
     Thread.current[:darkroom_host_index] = -1 unless @hosts.empty?
   end
@@ -70,6 +74,7 @@ class Darkroom
     end
 
     @mutex.synchronize do
+      @process_key += 1
       @errors = []
       found = {}
 
@@ -82,21 +87,28 @@ class Darkroom
           else
             found[path] = load_path
 
-            @manifest[path] ||= Asset.new(path, file, @manifest,
-              internal: internal = @internal_pattern && path =~ @internal_pattern,
-              minify: @minify && !internal && path !~ @minified_pattern,
+            @manifest[path] ||= Asset.new(path, file, self,
+              prefix: (@prefix unless @pristine.include?(path)),
+              internal: @internal_pattern && path =~ @internal_pattern,
+              minify: @minify && path !~ @minified_pattern,
             )
           end
         end
       end
 
       @manifest.select! { |path, _| found.key?(path) }
+      @manifest_unversioned.clear
+      @manifest_versioned.clear
+
+      @manifest.each do |path, asset|
+        asset.process
 
-      found.each do |path, _|
-        @manifest[path].process(@last_processed_at)
-        @manifest[@manifest[path].path_versioned] = @manifest[path]
+        unless asset.internal?
+          @manifest_unversioned[asset.path_unversioned] = asset
+          @manifest_versioned[asset.path_versioned] = asset
+        end
 
-        @errors += @manifest[path].errors
+        @errors += asset.errors
       end
     ensure
       @last_processed_at = Time.now.to_f
@@ -132,14 +144,7 @@ class Darkroom
   # * +path+ - The external path of the asset.
   #
   def asset(path)
-    asset = @manifest[@prefix ? path.sub(@prefix, '') : path]
-
-    return nil if asset.nil?
-    return nil if asset.internal?
-    return nil if @prefix && !path.start_with?(@prefix) && !@pristine.include?(asset.path)
-    return nil if @prefix && path.start_with?(@prefix) && @pristine.include?(asset.path)
-
-    asset
+    @manifest_versioned[path] || @manifest_unversioned[path]
   end
 
   ##
@@ -151,28 +156,40 @@ class Darkroom
   #   darkroom.asset_path('/js/app.js')                   # => /assets/js/app.<hash>.js
   #   darkroom.asset_path('/js/app.js', versioned: false) # => /assets/js/app.js
   #
+  # Raises an AssetNotFoundError if the asset doesn't exist.
+  #
   # * +path+ - The 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))
-    asset = @manifest[path] or return nil
-
+    asset = @manifest[path] or raise(AssetNotFoundError.new(path))
     host = @hosts.empty? ? '' : @hosts[
       Thread.current[:darkroom_host_index] = (Thread.current[:darkroom_host_index] + 1) % @hosts.size
     ]
-    prefix = @prefix unless @pristine.include?(path)
 
-    "#{host}#{prefix}#{versioned ? asset.path_versioned : path}"
+    "#{host}#{versioned ? asset.path_versioned : asset.path_unversioned}"
   end
 
   ##
-  # Calls #asset_path and raises a AssetNotFoundError if the asset doesn't exist (instead of just returning
-  # nil).
+  # Returns an asset's subresource integrity string. Raises an AssetNotFoundError if the asset doesn't
+  # exist.
   #
-  # * +versioned+ - Boolean indicating whether the versioned or unversioned path should be returned.
+  # * +path+ - The internal path of the asset.
+  # * +algorithm+ - The hash algorithm to use to generate the integrity string (see Asset#integrity).
   #
-  def asset_path!(path, versioned: true)
-    asset_path(path, versioned: versioned) or raise(AssetNotFoundError.new(path))
+  def asset_integrity(path, algorithm = nil)
+    asset = @manifest[path] or raise(AssetNotFoundError.new(path))
+
+    algorithm ? asset.integrity(algorithm) : asset.integrity
+  end
+
+  ##
+  # Returns the asset from the manifest hash associated with the given path.
+  #
+  # * +path+ - The internal path of the asset.
+  #
+  def manifest(path)
+    @manifest[path]
   end
 
   ##
@@ -188,23 +205,20 @@ class Darkroom
   #
   def dump(dir, clear: false, include_pristine: true)
     dir = File.expand_path(dir)
-    written = Set.new
 
     FileUtils.mkdir_p(dir)
     Dir.each_child(dir) { |child| FileUtils.rm_rf(File.join(dir, child)) } if clear
 
-    @manifest.each do |_, asset|
+    @manifest_versioned.each do |path, asset|
       next if asset.internal?
-      next if written.include?(asset.path)
       next if @pristine.include?(asset.path) && !include_pristine
 
-      external_path = asset_path(asset.path)
-      file_path = File.join(dir, external_path)
+      file_path = File.join(dir,
+        @pristine.include?(asset.path) ? asset.path_unversioned : path
+      )
 
       FileUtils.mkdir_p(File.dirname(file_path))
       File.write(file_path, asset.content)
-
-      written << asset.path
     end
   end
 
@@ -222,7 +236,8 @@ class Darkroom
       "@minified_pattern=#{@minified_pattern.inspect}, "\
       "@minify=#{@minify.inspect}, "\
       "@prefix=#{@prefix.inspect}, "\
-      "@pristine=#{@pristine.inspect}"\
+      "@pristine=#{@pristine.inspect}, "\
+      "@process_key=#{@process_key.inspect}"\
     '>'
   end
 end

data/lib/darkroom/errors/missing_library_error.rb

@@ -24,7 +24,8 @@ class Darkroom
     # Returns a string representation of the error.
     #
     def to_s
-      "Cannot #{@need} #{@extension} file(s): #{@library} library not available"
+      "Cannot #{@need} #{@extension} file(s): #{@library} library not available [hint: try adding "\
+      "gem('#{@library}') to your Gemfile]"
     end
   end
 end

data/lib/darkroom/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: darkroom
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nate Pickens
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-25 00:00:00.000000000 Z
+date: 2021-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler