hanami-assets 1.3.5 → 2.1.0.beta2

data/lib/hanami/assets/cache.rb

@@ -1,102 +0,0 @@
-# frozen_string_literal: true
-
-require "pathname"
-
-module Hanami
-  module Assets
-    # Store assets references when compile mode is on.
-    #
-    # This is especially useful in development mode, where we want to compile
-    # only the assets that were changed from last browser refresh.
-    #
-    # @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] = File.new(k, mtime: 0) }
-        @mutex = Mutex.new
-      end
-
-      # Check if the given file was modified
-      #
-      # @param file [String,Pathname] the file path
-      #
-      # @return [TrueClass,FalseClass] the result of the check
-      #
-      # @since 0.3.0
-      # @api private
-      def modified?(file)
-        @mutex.synchronize do
-          @data[file.to_s].modified?(file)
-        end
-      end
-
-      # Store the given file reference
-      #
-      # @param file [String,Pathname] the file path
-      #
-      # @return [TrueClass,FalseClass] the result of the check
-      #
-      # @since 0.1.0
-      # @api private
-      def store(file, dependencies = nil)
-        @mutex.synchronize do
-          @data[file.to_s] = File.new(file, dependencies: dependencies)
-        end
-      end
-    end
-  end
-end

data/lib/hanami/assets/compiler.rb

@@ -1,287 +0,0 @@
-# frozen_string_literal: true
-
-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})")
-      end
-    end
-
-    # Unknown Asset Engine error
-    class UnknownAssetEngine < Error
-      def initialize(source)
-        super("No asset engine registered for `#{::File.basename(source)}'")
-      end
-    end
-
-    # Assets compiler
-    #
-    # It compiles assets that needs to be preprocessed (eg. Sass or ES6) into
-    # the destination directory.
-    #
-    # Vanilla javascripts or stylesheets are just copied over.
-    #
-    # @since 0.1.0
-    # @api private
-    class Compiler
-      # @since 0.1.0
-      # @api private
-      DEFAULT_PERMISSIONS = 0o644
-
-      # @since 0.1.0
-      # @api private
-      COMPILE_PATTERN = "*.*.*" # Example hello.js.es6
-
-      # @since 0.1.0
-      # @api private
-      EXTENSIONS = {".js" => true, ".css" => true, ".map" => true}.freeze
-
-      include Utils::ClassAttribute
-
-      # @since 0.3.0
-      # @api private
-      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
-      #
-      # @param configuration [Hanami::Assets::Configuration] the application
-      #   configuration associated with the given asset
-      #
-      # @param name [String] the asset path
-      #
-      # @since 0.1.0
-      # @api private
-      def self.compile(configuration, name)
-        return unless configuration.compile
-
-        require "tilt"
-        require "hanami/assets/cache"
-        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
-      #
-      # @since 0.1.0
-      # @api private
-      #
-      # @see Hanami::Assets::Cache
-      def self.cache
-        @@cache ||= Assets::Cache.new # rubocop:disable Style/ClassVars
-      end
-
-      # Return a new instance
-      #
-      # @param configuration [Hanami::Assets::Configuration] the application
-      #   configuration associated with the given asset
-      #
-      # @param name [String] the asset path
-      #
-      # @return [Hanami::Assets::Compiler] a new instance
-      #
-      # @since 0.1.0
-      # @api private
-      def initialize(configuration, name)
-        @configuration = configuration
-        @name          = Pathname.new(name)
-      end
-
-      # Compile the asset
-      #
-      # @raise [Hanami::Assets::MissingAsset] if the asset can't be found in
-      #   sources
-      #
-      # @since 0.1.0
-      # @api private
-      def compile
-        raise MissingAsset.new(@name, @configuration.sources) unless exist?
-        return unless modified?
-
-        if compile?
-          compile!
-        else
-          copy!
-        end
-
-        cache!
-      end
-
-      private
-
-      # @since 0.1.0
-      # @api private
-      def source
-        @source ||= @configuration.source(@name)
-      end
-
-      # @since 0.1.0
-      # @api private
-      def destination
-        @destination ||= @configuration.destination_directory.join(destination_name)
-      end
-
-      # @since 1.3.0
-      # @api private
-      def relative_destination_name(name: @name, add_prefix: true)
-        result = name.to_s
-        base_dir = @configuration.base_directories.detect { |dir| result.start_with?(dir) }
-        if base_dir
-          prefix = @configuration.prefix
-          base_dir = prefix.join(base_dir) if add_prefix
-          result = name.relative_path_from(Pathname.new(base_dir))
-        end
-        result
-      end
-
-      # @since 1.3.0
-      # @api private
-      def absolute_destination_name
-        result = ::File.basename(@name)
-        @configuration.sources.each do |source|
-          if @name.to_s.start_with?(source.to_s)
-            result = @name.relative_path_from(source)
-            break
-          end
-        end
-        relative_destination_name(name: Pathname.new(result), add_prefix: false)
-      end
-
-      # @since 1.3.0
-      # @api private
-      def destination_name
-        result = destination_path
-
-        if compile?
-          result.scan(/\A[[[:alnum:]][\-\_]]*\.[[\w]]*/).first || result
-        else
-          result
-        end
-      end
-
-      # @since 1.3.1
-      # @api private
-      def destination_path
-        if @configuration.nested
-          @name.relative? ? relative_destination_name : absolute_destination_name
-        else
-          ::File.basename(@name)
-        end.to_s
-      end
-
-      # @since 0.1.0
-      # @api private
-      def exist?
-        !source.nil? &&
-          source.exist?
-      end
-
-      # @since 0.3.0
-      # @api private
-      def modified?
-        !destination.exist? ||
-          cache.modified?(source)
-      end
-
-      # @since 0.1.0
-      # @api private
-      def compile?
-        @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!
-        write { renderer.render }
-      rescue RuntimeError
-        raise UnknownAssetEngine.new(source)
-      end
-
-      # @since 0.1.0
-      # @api private
-      def copy!
-        write { source.binread }
-      end
-
-      # @since 0.1.0
-      # @api private
-      def cache!
-        cache.store(source, dependencies)
-      end
-
-      # @since 0.1.0
-      # @api private
-      def write
-        destination.dirname.mkpath
-        destination.open(File::WRONLY | File::TRUNC | File::CREAT | File::BINARY, DEFAULT_PERMISSIONS) do |file|
-          file.write(yield)
-        end
-      end
-
-      # @since 0.1.0
-      # @api private
-      def cache
-        self.class.cache
-      end
-
-      # @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 load_paths
-        result = []
-
-        @configuration.sources.each do |source|
-          Find.find(source) do |path|
-            result << path if File.directory?(path)
-          end
-        end
-
-        result
-      end
-    end
-  end
-end

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

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-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/.freeze
-
-        # @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

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-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/.freeze
-
-        # @since 0.3.0
-        # @api private
-        def self.eligible?(name)
-          name.to_s =~ EXTENSIONS
-        end
-
-        # @since 1.3.3
-        # @api private
-        def initialize(*)
-          super
-          require "sassc"
-        end
-
-        private
-
-        # @since 0.3.0
-        # @api private
-        def renderer
-          @renderer ||=
-            ::SassC::Engine.new(
-              source.read,
-              syntax: target_syntax,
-              load_paths: load_paths
-            )
-        end
-
-        # @since 0.3.0
-        # @api private
-        def dependencies
-          renderer.dependencies.map(&:filename)
-        rescue source::NotRenderedError
-          []
-        end
-
-        # @since 1.3.2
-        # @api private
-        def target_syntax
-          if source.extname =~ /sass\z/.freeze
-            :sass
-          else
-            :scss
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,119 +0,0 @@
-require 'hanami/utils/string'
-require 'hanami/utils/class'
-
-module Hanami
-  module Assets
-    module Compressors
-      # Unknown compressor error
-      #
-      # It's raised when trying to load an unknown compressor.
-      #
-      # @since 0.1.0
-      # @api private
-      #
-      # @see Hanami::Assets::Configuration#javascript_compressor
-      # @see Hanami::Assets::Configuration#stylesheet_compressor
-      # @see Hanami::Assets::Compressors::Abstract#for
-      class UnknownCompressorError < Error
-        # @since 0.1.0
-        # @api private
-        def initialize(type, engine_name)
-          super("Unknown #{ type } compressor: :#{ engine_name }")
-        end
-      end
-
-      # Abstract base class for compressors.
-      #
-      # Don't use this class directly, but please use subclasses instead.
-      #
-      # @since 0.1.0
-      # @api private
-      class Abstract
-        # Compress the given asset
-        #
-        # @param filename [String, Pathname] the absolute path to the asset
-        #
-        # @return [String] the compressed asset
-        #
-        # @since 0.1.0
-        # @api private
-        def compress(filename)
-          compressor.compress(
-            read(filename)
-          )
-        end
-
-        protected
-        # @since 0.1.0
-        # @api private
-        attr_reader :compressor
-
-        # Read the contents of given filename
-        #
-        # @param filename [String, Pathname] the absolute path to the asset
-        #
-        # @return [String] the contents of asset
-        #
-        # @since 0.1.0
-        # @api private
-        def read(filename)
-          ::File.read(filename)
-        end
-
-        private
-
-        # Factory for compressors.
-        #
-        # It loads a compressor for the given name.
-        #
-        # @abstract Please use this method from the subclasses
-        #
-        # @param engine_name [Symbol,String,NilClass,#compress] the name of the
-        #   engine to load or an instance of an engine
-        #
-        # @return [Hanami::Assets::Compressors::Abstract] returns a concrete
-        #   implementation of a compressor
-        #
-        # @raise [Hanami::Assets::Compressors::UnknownCompressorError] when the
-        #   given name refers to an unknown compressor engine
-        #
-        # @since 0.1.0
-        # @api private
-        def self.for(engine_name)
-          case engine_name
-          when Symbol, String
-            load_engine(name, engine_name)
-          when nil
-            require 'hanami/assets/compressors/null_compressor'
-            NullCompressor.new
-          else
-            engine_name
-          end
-        end
-
-        # Load the compressor for the given type and engine name.
-        #
-        # @param type [String] asset type (eg. "Javascript" or "Stylesheet")
-        # @param engine_name [Symbol,String] the name of the engine to load (eg. `:yui`)
-        #
-        # @return [Hanami::Assets::Compress::Abstract] returns a concrete
-        #   implementation of a compressor
-        #
-        # @since 0.1.0
-        # @api private
-        def self.load_engine(type, engine_name)
-          type = Utils::String.demodulize(type)
-
-          require "hanami/assets/compressors/#{ engine_name }_#{ Utils::String.underscore(type) }"
-          Utils::Class.load!("#{ Utils::String.classify(engine_name) }#{ type }", Hanami::Assets::Compressors).new
-        rescue LoadError
-          raise UnknownCompressorError.new(type, engine_name)
-        end
-
-        class << self
-          private :for, :load_engine
-        end
-      end
-    end
-  end
-end

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

@@ -1,36 +0,0 @@
-require 'hanami/assets/compressors/javascript'
-require_relative './jsmin'
-
-module Hanami
-  module Assets
-    module Compressors
-      # Builtin compressor for stylesheet
-      #
-      # This is a port of jsmin
-      # Copyright (c) 2002 Douglas Crockford  (www.crockford.com)
-      #
-      # This Ruby port was implemented by Ryan Grove (@rgrove) as work for
-      # <tt>jsmin</tt> gem.
-      #
-      # Copyright (c) 2008-2012 Ryan Grove
-      #
-      # @since 0.1.0
-      # @api private
-      #
-      # @see https://github.com/sbecker/asset_packager
-      class BuiltinJavascript < Javascript
-        def initialize
-          @compressor = JSMin
-        end
-
-        # @since 0.1.0
-        # @api private
-        def compress(filename)
-          compressor.minify(
-            read(filename)
-          )
-        end
-      end
-    end
-  end
-end

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

@@ -1,57 +0,0 @@
-require 'hanami/assets/compressors/stylesheet'
-
-module Hanami
-  module Assets
-    module Compressors
-      # Builtin compressor for stylesheet
-      #
-      # This is a basic algorithm based on Scott Becker (@sbecker) work on
-      # <tt>asset_packager</tt> gem.
-      #
-      # Copyright (c) 2006-2008 Scott Becker
-      #
-      # @since 0.1.0
-      # @api private
-      #
-      # @see https://github.com/sbecker/asset_packager
-      class BuiltinStylesheet < Stylesheet
-        # @since 0.1.0
-        # @api private
-        SPACE_REPLACEMENT                = " ".freeze
-
-        # @since 0.1.0
-        # @api private
-        COMMENTS_REPLACEMENT             = "".freeze
-
-        # @since 0.1.0
-        # @api private
-        LINE_BREAKS_REPLACEMENT          = "}\n".freeze
-
-        # @since 0.1.0
-        # @api private
-        LAST_BREAK_REPLACEMENT           = "".freeze
-
-        # @since 0.1.0
-        # @api private
-        INSIDE_LEFT_BRACKET_REPLACEMENT  = " {".freeze
-
-        # @since 0.1.0
-        # @api private
-        INSIDE_RIGHT_BRACKET_REPLACEMENT = "}".freeze
-
-        # @since 0.1.0
-        # @api private
-        def compress(filename)
-          result = read(filename)
-          result.gsub!(/\s+/,            SPACE_REPLACEMENT)                # collapse space
-          result.gsub!(/\/\*(.*?)\*\/ /, COMMENTS_REPLACEMENT)             # remove comments - caution, might want to remove this if using css hacks
-          result.gsub!(/\} /,            LINE_BREAKS_REPLACEMENT)          # add line breaks
-          result.gsub!(/\n$/,            LAST_BREAK_REPLACEMENT)           # remove last break
-          result.gsub!(/ \{ /,           INSIDE_LEFT_BRACKET_REPLACEMENT)  # trim inside brackets
-          result.gsub!(/; \}/,           INSIDE_RIGHT_BRACKET_REPLACEMENT) # trim inside brackets
-          result
-        end
-      end
-    end
-  end
-end