hanami-assets 0.2.1 → 0.3.0

data/lib/hanami/assets/cache.rb

@@ -1,4 +1,5 @@
 require 'thread'
+require 'pathname'
 
 module Hanami
   module Assets
@@ -10,25 +11,75 @@ module Hanami
     # @since 0.1.0
     # @api private
     class Cache
+      # File cache entry
+      #
+      # @since 0.3.0
+      # @api private
+      class File
+        # @since 0.3.0
+        # @api private
+        def initialize(file, mtime: nil, dependencies: nil)
+          @file  = file.is_a?(String) ? Pathname.new(file) : file
+          @mtime = mtime || @file.mtime.utc.to_i
+
+          @dependencies = (dependencies || []).map { |d| self.class.new(d) }
+        end
+
+        # @since 0.3.0
+        # @api private
+        def modified?(other)
+          file = other.is_a?(self.class) ? other : self.class.new(other)
+
+          if dependencies?
+            modified_dependencies?(file) ||
+              mtime <= file.mtime
+          else
+            mtime < file.mtime
+          end
+        end
+
+        protected
+
+        # @since 0.3.0
+        # @api private
+        attr_reader :mtime
+
+        # @since 0.3.0
+        # @api private
+        attr_reader :dependencies
+
+        # @since 0.3.0
+        # @api private
+        def modified_dependencies?(other)
+          dependencies.all? { |dep| dep.mtime > other.mtime }
+        end
+
+        # @since 0.3.0
+        # @api private
+        def dependencies?
+          dependencies.any?
+        end
+      end
+
       # Return a new instance
       #
       # @return [Hanami::Assets::Cache] a new instance
       def initialize
-        @data  = Hash.new{|h,k| h[k] = 0 }
+        @data  = Hash.new { |h, k| h[k] = File.new(k, mtime: 0) }
         @mutex = Mutex.new
       end
 
-      # Check if the given file is fresh or changed from last check.
+      # Check if the given file was modified
       #
       # @param file [String,Pathname] the file path
       #
       # @return [TrueClass,FalseClass] the result of the check
       #
-      # @since 0.1.0
+      # @since 0.3.0
       # @api private
-      def fresh?(file)
+      def modified?(file)
         @mutex.synchronize do
-          @data[file.to_s] < mtime(file)
+          @data[file.to_s].modified?(file)
         end
       end
 
@@ -40,19 +91,11 @@ module Hanami
       #
       # @since 0.1.0
       # @api private
-      def store(file)
+      def store(file, dependencies = nil)
         @mutex.synchronize do
-          @data[file.to_s] = mtime(file)
+          @data[file.to_s] = File.new(file, dependencies: dependencies)
         end
       end
-
-      private
-
-      # @since 0.1.0
-      # @api private
-      def mtime(file)
-        file.mtime.utc.to_i
-      end
     end
   end
 end

data/lib/hanami/assets/compiler.rb

@@ -1,17 +1,21 @@
+require 'set'
 require 'find'
+require 'hanami/utils/class_attribute'
 
 module Hanami
   module Assets
+    # Missing Asset error
     class MissingAsset < Error
       def initialize(name, sources)
         sources = sources.map(&:to_s).join(', ')
-        super("Missing asset: `#{ name }' (sources: #{ sources })")
+        super("Missing asset: `#{name}' (sources: #{sources})")
       end
     end
 
+    # Unknown Asset Engine error
     class UnknownAssetEngine < Error
       def initialize(source)
-        super("No asset engine registered for `#{ ::File.basename(source) }'")
+        super("No asset engine registered for `#{::File.basename(source)}'")
       end
     end
 
@@ -24,10 +28,10 @@ module Hanami
     #
     # @since 0.1.0
     # @api private
-    class Compiler
+    class Compiler # rubocop:disable Metrics/ClassLength
       # @since 0.1.0
       # @api private
-      DEFAULT_PERMISSIONS = 0644
+      DEFAULT_PERMISSIONS = 0o644
 
       # @since 0.1.0
       # @api private
@@ -35,12 +39,21 @@ module Hanami
 
       # @since 0.1.0
       # @api private
-      EXTENSIONS = {'.js' => true, '.css' => true, '.map' => true}.freeze
+      EXTENSIONS = { '.js' => true, '.css' => true, '.map' => true }.freeze
 
-      # @since 0.1.0
+      include Utils::ClassAttribute
+
+      # @since 0.3.0
       # @api private
-      SASS_CACHE_LOCATION = Pathname(Hanami.respond_to?(:root) ?
-                                     Hanami.root : Dir.pwd).join('tmp', 'sass-cache')
+      class_attribute :subclasses
+      self.subclasses = Set.new
+
+      # @since 0.3.0
+      # @api private
+      def self.inherited(subclass)
+        super
+        subclasses.add(subclass)
+      end
 
       # Compile the given asset
       #
@@ -56,7 +69,26 @@ module Hanami
 
         require 'tilt'
         require 'hanami/assets/cache'
-        new(configuration, name).compile
+        require 'hanami/assets/compilers/sass'
+        require 'hanami/assets/compilers/less'
+        fabricate(configuration, name).compile
+      end
+
+      # @since 0.3.0
+      # @api private
+      def self.fabricate(configuration, name)
+        source = configuration.source(name)
+        engine = (subclasses + [self]).find do |klass|
+          klass.eligible?(source)
+        end
+
+        engine.new(configuration, name)
+      end
+
+      # @since 0.3.0
+      # @api private
+      def self.eligible?(_name)
+        true
       end
 
       # Assets cache
@@ -66,7 +98,7 @@ module Hanami
       #
       # @see Hanami::Assets::Cache
       def self.cache
-        @@cache ||= Assets::Cache.new
+        @@cache ||= Assets::Cache.new # rubocop:disable Style/ClassVars
       end
 
       # Return a new instance
@@ -94,7 +126,7 @@ module Hanami
       # @api private
       def compile
         raise MissingAsset.new(@name, @configuration.sources) unless exist?
-        return unless fresh?
+        return unless modified?
 
         if compile?
           compile!
@@ -110,10 +142,7 @@ module Hanami
       # @since 0.1.0
       # @api private
       def source
-        @source ||= begin
-          @name.absolute? ? @name :
-            @configuration.find(@name)
-        end
+        @source ||= @configuration.source(@name)
       end
 
       # @since 0.1.0
@@ -141,38 +170,24 @@ module Hanami
           source.exist?
       end
 
-      # @since 0.1.0
+      # @since 0.3.0
       # @api private
-      def fresh?
+      def modified?
         !destination.exist? ||
-          cache.fresh?(source)
+          cache.modified?(source)
       end
 
       # @since 0.1.0
       # @api private
       def compile?
-        @compile ||= ::File.fnmatch(COMPILE_PATTERN, source.to_s) &&
-          !EXTENSIONS[::File.extname(source.to_s)]
+        @compile ||= ::File.fnmatch(COMPILE_PATTERN, ::File.basename(source.to_s)) &&
+                     !EXTENSIONS[::File.extname(source.to_s)]
       end
 
       # @since 0.1.0
       # @api private
       def compile!
-        # NOTE `:load_paths' is useful only for Sass engine, to make `@include' directive to work.
-        # For now we don't want to maintan a specialized Compiler version for Sass.
-        #
-        # If in the future other precompilers will need special treatment,
-        # we can consider to maintain several specialized versions in order to
-        # don't add a perf tax to all the other preprocessors who "just work".
-        #
-        # Example: if Less "just works", we can keep it in the general `Compiler',
-        # but have a `SassCompiler` if it requires more than `:load_paths'.
-        #
-        # NOTE: We need another option to pass for Sass: `:cache_location'.
-        #
-        # This is needed to don't create a `.sass-cache' directory at the root of the project,
-        # but to have it under `tmp/sass-cache'.
-        write { Tilt.new(source, nil, load_paths: sass_load_paths, cache_location: sass_cache_location).render }
+        write { renderer.render }
       rescue RuntimeError
         raise UnknownAssetEngine.new(source)
       end
@@ -186,14 +201,14 @@ module Hanami
       # @since 0.1.0
       # @api private
       def cache!
-        cache.store(source)
+        cache.store(source, dependencies)
       end
 
       # @since 0.1.0
       # @api private
       def write
         destination.dirname.mkpath
-        destination.open(File::WRONLY|File::TRUNC|File::CREAT, DEFAULT_PERMISSIONS) do |file|
+        destination.open(File::WRONLY | File::TRUNC | File::CREAT, DEFAULT_PERMISSIONS) do |file|
           file.write(yield)
         end
       end
@@ -204,9 +219,21 @@ module Hanami
         self.class.cache
       end
 
-      # @since x.x.x
+      # @since 0.3.0
+      # @api private
+      def renderer
+        Tilt.new(source)
+      end
+
+      # @since 0.3.0
+      # @api private
+      def dependencies
+        nil
+      end
+
+      # @since 0.3.0
       # @api private
-      def sass_load_paths
+      def load_paths
         result = []
 
         @configuration.sources.each do |source|
@@ -217,12 +244,6 @@ module Hanami
 
         result
       end
-
-      # @since 0.1.0
-      # @api private
-      def sass_cache_location
-        SASS_CACHE_LOCATION
-      end
     end
   end
 end

data/lib/hanami/assets/compilers/less.rb

@@ -0,0 +1,29 @@
+module Hanami
+  module Assets
+    module Compilers
+      # LESS compiler
+      #
+      # @since 0.3.0
+      # @api private
+      class Less < Compiler
+        # @since 0.3.0
+        # @api private
+        EXTENSIONS = /\.(less)\z/
+
+        # @since 0.3.0
+        # @api private
+        def self.eligible?(name)
+          name.to_s =~ EXTENSIONS
+        end
+
+        private
+
+        # @since 0.3.0
+        # @api private
+        def renderer
+          Tilt.new(source, nil, paths: load_paths)
+        end
+      end
+    end
+  end
+end

data/lib/hanami/assets/compilers/sass.rb

@@ -0,0 +1,46 @@
+module Hanami
+  module Assets
+    module Compilers
+      # Sass/SCSS Compiler
+      #
+      # @since 0.3.0
+      # @api private
+      class Sass < Compiler
+        # @since 0.3.0
+        # @api private
+        EXTENSIONS = /\.(sass|scss)\z/
+
+        # @since 0.1.0
+        # @api private
+        CACHE_LOCATION = Pathname(Hanami.respond_to?(:root) ? # rubocop:disable Style/MultilineTernaryOperator
+                                  Hanami.root : Dir.pwd).join('tmp', 'sass-cache')
+
+        # @since 0.3.0
+        # @api private
+        def self.eligible?(name)
+          name.to_s =~ EXTENSIONS
+        end
+
+        private
+
+        # @since 0.3.0
+        # @api private
+        def renderer
+          Tilt.new(source, nil, load_paths: load_paths, cache_location: CACHE_LOCATION)
+        end
+
+        # @since 0.3.0
+        # @api private
+        def dependencies
+          engine.dependencies.map { |d| d.options[:filename] }
+        end
+
+        # @since 0.3.0
+        # @api private
+        def engine
+          ::Sass::Engine.for_file(source.to_s, load_paths: load_paths, cache_location: CACHE_LOCATION)
+        end
+      end
+    end
+  end
+end

data/lib/hanami/assets/compressors/sass_stylesheet.rb

@@ -18,7 +18,7 @@ module Hanami
         # @api private
         #
         # FIXME This is the same logic that we have for Hanami::Assets::Compiler
-        SASS_CACHE_LOCATION = Pathname(Hanami.respond_to?(:root) ?
+        SASS_CACHE_LOCATION = Pathname(Hanami.respond_to?(:root) ? # rubocop:disable Style/MultilineTernaryOperator
                                        Hanami.root : Dir.pwd).join('tmp', 'sass-cache')
         # @since 0.1.0
         # @api private
@@ -30,7 +30,7 @@ module Hanami
         # @api private
         def compress(filename)
           compressor.new(read(filename), filename: filename, syntax: :scss,
-            style: :compressed, cache_location: SASS_CACHE_LOCATION).render
+                                         style: :compressed, cache_location: SASS_CACHE_LOCATION).render
         end
       end
     end

data/lib/hanami/assets/config/global_sources.rb

@@ -27,7 +27,7 @@ module Hanami
 
         # @since 0.1.0
         # @api private
-        alias_method :<<, :push
+        alias << push
 
         private
 

data/lib/hanami/assets/config/manifest.rb

@@ -7,7 +7,7 @@ module Hanami
     # @api private
     class MissingDigestManifestError < Error
       def initialize(path)
-        super("Can't read manifest: #{ path }")
+        super("Can't read manifest: #{path}")
       end
     end
 
@@ -18,7 +18,7 @@ module Hanami
     # @api private
     class MissingDigestAssetError < Error
       def initialize(asset, manifest_path)
-        super("Can't find asset `#{ asset }' in manifest (#{ manifest_path })")
+        super("Can't find asset `#{asset}' in manifest (#{manifest_path})")
       end
     end
 
@@ -73,6 +73,14 @@ module Hanami
       # @since 0.1.0
       # @api private
       class DigestManifest
+        # @since 0.3.0
+        # @api private
+        TARGET                = 'target'.freeze
+
+        # @since 0.3.0
+        # @api private
+        SUBRESOURCE_INTEGRITY = 'sri'.freeze
+
         # Return a new instance
         #
         # @param assets [Hash] the content of the digest manifest
@@ -95,7 +103,7 @@ module Hanami
         # For a given path <tt>/assets/application.js</tt> it will return
         # <tt>/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.js</tt>
         #
-        # @param asset [#to_s] the relateive asset path
+        # @param asset [#to_s] the relative asset path
         #
         # @return [String] the digest path
         #
@@ -106,6 +114,18 @@ module Hanami
             raise Hanami::Assets::MissingDigestAssetError.new(asset, @manifest_path)
           end
         end
+
+        # @since 0.3.0
+        # @api private
+        def target(path)
+          resolve(path).fetch(TARGET)
+        end
+
+        # @since 0.3.0
+        # @api private
+        def subresource_integrity_values(path)
+          resolve(path).fetch(SUBRESOURCE_INTEGRITY)
+        end
       end
     end
   end

data/lib/hanami/assets/config/sources.rb

@@ -17,6 +17,10 @@ module Hanami
       #
       # TODO The perf of this class is poor, consider to improve it.
       class Sources < Utils::LoadPaths
+        # @since 0.3.0
+        # @api private
+        SKIPPED_FILE_PREFIX = '_'.freeze
+
         # @since 0.1.0
         # @api private
         attr_writer :root
@@ -31,7 +35,7 @@ module Hanami
         # @since 0.1.0
         # @api private
         def map
-          Array.new.tap do |result|
+          [].tap do |result|
             each do |source|
               result << yield(source)
             end
@@ -51,8 +55,8 @@ module Hanami
         def files(name = nil)
           result = []
 
-          Dir.glob(map {|source| "#{ source }#{ ::File::SEPARATOR }**#{ ::File::SEPARATOR }#{ name }*"}).each do |file|
-            next if ::File.directory?(file) || ::File.basename(file).match(/\A\_/)
+          Dir.glob(map { |source| "#{source}#{::File::SEPARATOR}**#{::File::SEPARATOR}#{name}*" }).each do |file|
+            next if ::File.directory?(file) || ::File.basename(file).start_with?(SKIPPED_FILE_PREFIX)
             result << file
           end
 
@@ -60,6 +64,7 @@ module Hanami
         end
 
         private
+
         # @since 0.1.0
         # @api private
         def realpath(path)