hanami-assets 0.0.0 → 0.2.0

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

@@ -0,0 +1,25 @@
+require 'hanami/assets/compressors/javascript'
+require 'uglifier'
+
+module Hanami
+  module Assets
+    module Compressors
+      # Uglifier compressor for JavaScript
+      #
+      # It depends on <tt>uglifier</tt> gem
+      #
+      # @since 0.1.0
+      # @api private
+      #
+      # @see http://lisperator.net/uglifyjs
+      # @see https://rubygems.org/gems/uglifier
+      class UglifierJavascript < Javascript
+        # @since 0.1.0
+        # @api private
+        def initialize
+          @compressor = Uglifier.new
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require 'hanami/assets/compressors/javascript'
+require 'yui/compressor'
+
+module Hanami
+  module Assets
+    module Compressors
+      # YUI Compressor for JavaScript
+      #
+      # It depends on <tt>yui-compressor</tt> gem
+      #
+      # @since 0.1.0
+      # @api private
+      #
+      # @see http://yui.github.io/yuicompressor
+      # @see https://rubygems.org/gems/yui-compressor
+      class YuiJavascript < Javascript
+        # @since 0.1.0
+        # @api private
+        def initialize
+          @compressor = YUI::JavaScriptCompressor.new(munge: true)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require 'hanami/assets/compressors/stylesheet'
+require 'yui/compressor'
+
+module Hanami
+  module Assets
+    module Compressors
+      # YUI Compressor for stylesheet
+      #
+      # It depends on <tt>yui-compressor</tt> gem
+      #
+      # @since 0.1.0
+      # @api private
+      #
+      # @see http://yui.github.io/yuicompressor
+      # @see https://rubygems.org/gems/yui-compressor
+      class YuiStylesheet < Stylesheet
+        # @since 0.1.0
+        # @api private
+        def initialize
+          @compressor = YUI::CssCompressor.new
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+require 'hanami/utils/load_paths'
+
+module Hanami
+  module Assets
+    # Configuration settings
+    #
+    # @since 0.1.0
+    # @api private
+    module Config
+      # Global asset sources across all the duplicated <tt>Hanami::Assets</tt>
+      # instances.
+      #
+      # @since 0.1.0
+      # @api private
+      #
+      # @see Hanami::Assets.duplicate
+      # @see http://www.rubydoc.info/gems/hanami-utils/Hanami/Utils/LoadPaths
+      class GlobalSources < Utils::LoadPaths
+        # @since 0.1.0
+        # @api private
+        def push(*paths)
+          super
+
+          sync_configuration
+          sync_duplicated_frameworks
+        end
+
+        # @since 0.1.0
+        # @api private
+        alias_method :<<, :push
+
+        private
+
+        # @since 0.1.0
+        # @api private
+        def sync_configuration
+          Hanami::Assets.configuration.sources << @paths
+        end
+
+        # @since 0.1.0
+        # @api private
+        def sync_duplicated_frameworks
+          Hanami::Assets.duplicates.each do |duplicate|
+            duplicate.configuration.sources << @paths
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,112 @@
+module Hanami
+  module Assets
+    # This error is raised when the application starts but can't be load the
+    # digest manifest.
+    #
+    # @since 0.1.0
+    # @api private
+    class MissingDigestManifestError < Error
+      def initialize(path)
+        super("Can't read manifest: #{ path }")
+      end
+    end
+
+    # This error is raised when an asset is referenced from the DOM, but it's
+    # not present in the digest manifest
+    #
+    # @since 0.1.0
+    # @api private
+    class MissingDigestAssetError < Error
+      def initialize(asset, manifest_path)
+        super("Can't find asset `#{ asset }' in manifest (#{ manifest_path })")
+      end
+    end
+
+    # Configuration settings
+    #
+    # @since 0.1.0
+    # @api private
+    module Config
+      # Default value for configuration's digest manifest.
+      #
+      # It indicates that the digest manifest wasn't loaded yet.
+      #
+      # At the load time, this should be replaced by an instance of
+      # <tt>Hanami::Assets::Config::Manifest</tt>.
+      #
+      # If for some reason that won't happen, the instance of this class is
+      # still referenced by the configuration and all the method invocations
+      # will raise a <tt>Hanami::Assets::MissingDigestManifestError</tt>.
+      #
+      # @since 0.1.0
+      # @api private
+      #
+      # @see Hanami::Assets::Configuration#manifest
+      # @see Hanami::Assets::Configuration#manifest_path
+      # @see Hanami::Assets::Configuration#digest
+      class NullDigestManifest < Utils::BasicObject
+        # Return a new instance
+        #
+        # @param configuration [Hanami::Assets::Configuration]
+        #
+        # @return [Hanami::Assets::Config::NullDigestManifest] a new instance
+        #
+        # @since 0.1.0
+        # @api private
+        def initialize(configuration)
+          @configuration = configuration
+        end
+
+        # @raise [Hanami::Assets::MissingDigestManifestError]
+        #
+        # @since 0.1.0
+        # @api private
+        def method_missing(*)
+          ::Kernel.raise(
+            ::Hanami::Assets::MissingDigestManifestError.new(@configuration.manifest_path)
+          )
+        end
+      end
+
+      # Digest manifest
+      #
+      # @since 0.1.0
+      # @api private
+      class DigestManifest
+        # Return a new instance
+        #
+        # @param assets [Hash] the content of the digest manifest
+        # @param manifest_path [Pathname] the path to the digest manifest
+        #
+        # @return [Hanami::Assets::Config::Manifest] a new instance
+        #
+        # @since 0.1.0
+        # @api private
+        #
+        # @see Hanami::Assets::Configuration#manifest
+        # @see Hanami::Assets::Configuration#manifest_path
+        def initialize(assets, manifest_path)
+          @assets        = assets
+          @manifest_path = manifest_path
+        end
+
+        # Resolve the given asset into a digest path
+        #
+        # 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
+        #
+        # @return [String] the digest path
+        #
+        # @raise [Hanami::Assets::MissingDigestAssetError] when the asset can't be
+        #   found in manifest
+        def resolve(asset)
+          @assets.fetch(asset.to_s) do
+            raise Hanami::Assets::MissingDigestAssetError.new(asset, @manifest_path)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+require 'hanami/utils/load_paths'
+
+module Hanami
+  module Assets
+    # Configuration settings
+    #
+    # @since 0.1.0
+    # @api private
+    module Config
+      # Source directories for a specific application
+      #
+      # @since 0.1.0
+      # @api private
+      #
+      # @see Hanami::Assets.duplicate
+      # @see http://www.rubydoc.info/gems/hanami-utils/Hanami/Utils/LoadPaths
+      #
+      # TODO The perf of this class is poor, consider to improve it.
+      class Sources < Utils::LoadPaths
+        # @since 0.1.0
+        # @api private
+        attr_writer :root
+
+        # @since 0.1.0
+        # @api private
+        def initialize(root)
+          super()
+          @root = root
+        end
+
+        # @since 0.1.0
+        # @api private
+        def map
+          Array.new.tap do |result|
+            each do |source|
+              result << yield(source)
+            end
+          end
+        end
+
+        # @since 0.1.0
+        # @api private
+        def find(filename)
+          result = files(filename).first
+          result = Pathname.new(result) unless result.nil?
+          result
+        end
+
+        # @since 0.1.0
+        # @api private
+        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\_/)
+            result << file
+          end
+
+          result
+        end
+
+        # @since 0.1.0
+        # @api private
+        def to_a
+          map {|s| s }
+        end
+
+        private
+        # @since 0.1.0
+        # @api private
+        def realpath(path)
+          @root.join(path).realpath
+        end
+      end
+    end
+  end
+end

data/lib/hanami/assets/configuration.rb

@@ -0,0 +1,539 @@
+require 'pathname'
+require 'json'
+require 'hanami/utils/string'
+require 'hanami/utils/class'
+require 'hanami/utils/path_prefix'
+require 'hanami/utils/basic_object'
+require 'hanami/assets/config/manifest'
+require 'hanami/assets/config/sources'
+
+module Hanami
+  module Assets
+    # Framework configuration
+    #
+    # @since 0.1.0
+    class Configuration
+      # @since 0.1.0
+      # @api private
+      DEFAULT_SCHEME           = 'http'.freeze
+
+      # @since 0.1.0
+      # @api private
+      DEFAULT_HOST             = 'localhost'.freeze
+
+      # @since 0.1.0
+      # @api private
+      DEFAULT_PORT             = '2300'.freeze
+
+      # @since 0.1.0
+      # @api private
+      DEFAULT_PUBLIC_DIRECTORY = 'public'.freeze
+
+      # @since 0.1.0
+      # @api private
+      DEFAULT_MANIFEST         = 'assets.json'.freeze
+
+      # @since 0.1.0
+      # @api private
+      DEFAULT_PREFIX           = '/assets'.freeze
+
+      # @since 0.1.0
+      # @api private
+      URL_SEPARATOR            = '/'.freeze
+
+      # @since 0.1.0
+      # @api private
+      HTTP_SCHEME              = 'http'.freeze
+
+      # @since 0.1.0
+      # @api private
+      HTTP_PORT                = '80'.freeze
+
+      # @since 0.1.0
+      # @api private
+      HTTPS_SCHEME             = 'https'.freeze
+
+      # @since 0.1.0
+      # @api private
+      HTTPS_PORT               = '443'.freeze
+
+      # Return a copy of the configuration of the framework instance associated
+      # with the given class.
+      #
+      # When multiple instances of Hanami::Assets are used in the same
+      # application, we want to make sure that a controller or an action will
+      # receive the expected configuration.
+      #
+      # @param base [Class, Module] a controller or an action
+      #
+      # @return [Hanami::Assets::Configuration] the configuration associated
+      #   to the given class.
+      #
+      # @since 0.1.0
+      # @api private
+      def self.for(base)
+        # TODO this implementation is similar to Hanami::Controller::Configuration consider to extract it into Hanami::Utils
+        namespace = Utils::String.new(base).namespace
+        framework = Utils::Class.load_from_pattern!("(#{namespace}|Hanami)::Assets")
+        framework.configuration
+      end
+
+      # @since 0.1.0
+      # @api private
+      attr_reader :digest_manifest
+
+      # Return a new instance
+      #
+      # @return [Hanami::Assets::Configuration] a new instance
+      #
+      # @since 0.1.0
+      # @api private
+      def initialize
+        reset!
+      end
+
+      # Compile mode
+      #
+      # Determine if compile assets from sources to destination.
+      # Usually this is turned off in production mode.
+      #
+      # @since 0.1.0
+      def compile(value = nil)
+        if value.nil?
+          @compile
+        else
+          @compile = value
+        end
+      end
+
+      # Digest mode
+      #
+      # Determine if the helpers should generate the digest path for an asset.
+      # Usually this is turned on in production mode.
+      #
+      # @since 0.1.0
+      def digest(value = nil)
+        if value.nil?
+          @digest
+        else
+          @digest = value
+        end
+      end
+
+      # CDN mode
+      #
+      # Determine if the helpers should always generate absolute URL.
+      # This is useful in production mode.
+      #
+      # @since 0.1.0
+      def cdn(value = nil)
+        if value.nil?
+          @cdn
+        else
+          @cdn = !!value
+        end
+      end
+
+      # JavaScript compressor
+      #
+      # Determine which compressor to use for JavaScript files during deploy.
+      #
+      # By default it's <tt>nil</tt>, that means it doesn't compress JavaScripts at deploy time.
+      #
+      # It accepts a <tt>Symbol</tt> or an object that respond to <tt>#compress(file)</tt>.
+      #
+      # The following symbols are accepted:
+      #
+      #   * <tt>:builtin</tt> - Ruby based implementation of jsmin. It doesn't require any external gem.
+      #   * <tt>:yui</tt> - YUI Compressor, it depends on <tt>yui-compressor</tt> gem and it requires Java 1.4+
+      #   * <tt>:uglifier</tt> - UglifyJS, it depends on <tt>uglifier</tt> gem and it requires Node.js
+      #   * <tt>:closure</tt> - Google Closure Compiler, it depends on <tt>closure-compiler</tt> gem and it requires Java
+      #
+      # @param value [Symbol,#compress] the compressor
+      #
+      # @since 0.1.0
+      #
+      # @see http://yui.github.io/yuicompressor
+      # @see https://rubygems.org/gems/yui-compressor
+      #
+      # @see http://lisperator.net/uglifyjs
+      # @see https://rubygems.org/gems/uglifier
+      #
+      # @see https://developers.google.com/closure/compiler
+      # @see https://rubygems.org/gems/closure-compiler
+      #
+      # @example YUI Compressor
+      #   require 'hanami/assets'
+      #
+      #   Hanami::Assets.configure do
+      #     # ...
+      #     javascript_compressor :yui
+      #   end.load!
+      #
+      # @example Custom Compressor
+      #   require 'hanami/assets'
+      #
+      #   Hanami::Assets.configure do
+      #     # ...
+      #     javascript_compressor MyCustomJavascriptCompressor.new
+      #   end.load!
+      def javascript_compressor(value = nil)
+        if value.nil?
+          @javascript_compressor
+        else
+          @javascript_compressor = value
+        end
+      end
+
+      # Stylesheet compressor
+      #
+      # Determine which compressor to use for Stylesheet files during deploy.
+      #
+      # By default it's <tt>nil</tt>, that means it doesn't compress Stylesheets at deploy time.
+      #
+      # It accepts a <tt>Symbol</tt> or an object that respond to <tt>#compress(file)</tt>.
+      #
+      # The following symbols are accepted:
+      #
+      #   * <tt>:builtin</tt> - Ruby based compressor. It doesn't require any external gem. It's fast, but not an efficient compressor.
+      #   * <tt>:yui</tt> - YUI-Compressor, it depends on <tt>yui-compressor</tt> gem and requires Java 1.4+
+      #   * <tt>:sass</tt> - Sass, it depends on <tt>sass</tt> gem
+      #
+      # @param value [Symbol,#compress] the compressor
+      #
+      # @since 0.1.0
+      #
+      # @see http://yui.github.io/yuicompressor
+      # @see https://rubygems.org/gems/yui-compressor
+      #
+      # @see http://sass-lang.com
+      # @see https://rubygems.org/gems/sass
+      #
+      # @example YUI Compressor
+      #   require 'hanami/assets'
+      #
+      #   Hanami::Assets.configure do
+      #     # ...
+      #     stylesheet_compressor :yui
+      #   end.load!
+      #
+      # @example Custom Compressor
+      #   require 'hanami/assets'
+      #
+      #   Hanami::Assets.configure do
+      #     # ...
+      #     stylesheet_compressor MyCustomStylesheetCompressor.new
+      #   end.load!
+      def stylesheet_compressor(value = nil)
+        if value.nil?
+          @stylesheet_compressor
+        else
+          @stylesheet_compressor = value
+        end
+      end
+
+      # URL scheme for the application
+      #
+      # This is used to generate absolute URL from helpers.
+      #
+      # @since 0.1.0
+      def scheme(value = nil)
+        if value.nil?
+          @scheme
+        else
+          @scheme = value
+        end
+      end
+
+      # URL host for the application
+      #
+      # This is used to generate absolute URL from helpers.
+      #
+      # @since 0.1.0
+      def host(value = nil)
+        if value.nil?
+          @host
+        else
+          @host = value
+        end
+      end
+
+      # URL port for the application
+      #
+      # This is used to generate absolute URL from helpers.
+      #
+      # @since 0.1.0
+      def port(value = nil)
+        if value.nil?
+          @port
+        else
+          @port = value.to_s
+        end
+      end
+
+      # URL port for the application
+      #
+      # This is used to generate absolute or relative URL from helpers.
+      #
+      # @since 0.1.0
+      def prefix(value = nil)
+        if value.nil?
+          @prefix
+        else
+          @prefix = Utils::PathPrefix.new(value)
+        end
+      end
+
+      # Sources root
+      #
+      # @since 0.1.0
+      def root(value = nil)
+        if value.nil?
+          @root
+        else
+          @root = Pathname.new(value).realpath
+          sources.root = @root
+        end
+      end
+
+      # Application public directory
+      #
+      # @since 0.1.0
+      def public_directory(value = nil)
+        if value.nil?
+          @public_directory
+        else
+          @public_directory = Pathname.new(::File.expand_path(value))
+        end
+      end
+
+      # Destination directory
+      #
+      # It's the combination of <tt>public_directory</tt> and <tt>prefix</tt>.
+      #
+      # @since 0.1.0
+      # @api private
+      def destination_directory
+        @destination_directory ||= public_directory.join(*prefix.split(URL_SEPARATOR))
+      end
+
+      # Manifest path from public directory
+      #
+      # @since 0.1.0
+      def manifest(value = nil)
+        if value.nil?
+          @manifest
+        else
+          @manifest = value.to_s
+        end
+      end
+
+      # Absolute manifest path
+      #
+      # @since 0.1.0
+      # @api private
+      def manifest_path
+        public_directory.join(manifest)
+      end
+
+      # Application's assets sources
+      #
+      # @since 0.1.0
+      # @api private
+      def sources
+        @sources ||= Hanami::Assets::Config::Sources.new(root)
+      end
+
+      # Application's assets
+      #
+      # @since 0.1.0
+      # @api private
+      def files
+        sources.files
+      end
+
+      # Find a file from sources
+      #
+      # @since 0.1.0
+      # @api private
+      def find(file)
+        @sources.find(file)
+      end
+
+      # Relative URL
+      #
+      # @since 0.1.0
+      # @api private
+      def asset_path(source)
+        cdn ?
+          asset_url(source) :
+          compile_path(source)
+      end
+
+      # Absolute URL
+      #
+      # @since 0.1.0
+      # @api private
+      def asset_url(source)
+        "#{ @base_url }#{ compile_path(source) }"
+      end
+
+      # Load Javascript compressor
+      #
+      # @return [Hanami::Assets::Compressors::Javascript] a compressor
+      #
+      # @raise [Hanami::Assets::Compressors::UnknownCompressorError] when the
+      #   given name refers to an unknown compressor engine
+      #
+      # @since 0.1.0
+      # @api private
+      #
+      # @see Hanami::Assets::Configuration#javascript_compressor
+      # @see Hanami::Assets::Compressors::Javascript#for
+      def js_compressor
+        require 'hanami/assets/compressors/javascript'
+        Hanami::Assets::Compressors::Javascript.for(javascript_compressor)
+      end
+
+      # Load Stylesheet compressor
+      #
+      # @return [Hanami::Assets::Compressors::Stylesheet] a compressor
+      #
+      # @raise [Hanami::Assets::Compressors::UnknownCompressorError] when the
+      #   given name refers to an unknown compressor engine
+      #
+      # @since 0.1.0
+      # @api private
+      #
+      # @see Hanami::Assets::Configuration#stylesheet_compressor
+      # @see Hanami::Assets::Compressors::Stylesheet#for
+      def css_compressor
+        require 'hanami/assets/compressors/stylesheet'
+        Hanami::Assets::Compressors::Stylesheet.for(stylesheet_compressor)
+      end
+
+      # @since 0.1.0
+      # @api private
+      def duplicate
+        Configuration.new.tap do |c|
+          c.root                  = root
+          c.scheme                = scheme
+          c.host                  = host
+          c.port                  = port
+          c.prefix                = prefix
+          c.cdn                   = cdn
+          c.compile               = compile
+          c.public_directory      = public_directory
+          c.manifest              = manifest
+          c.sources               = sources.dup
+          c.javascript_compressor = javascript_compressor
+          c.stylesheet_compressor = stylesheet_compressor
+        end
+      end
+
+      # @since 0.1.0
+      # @api private
+      def reset!
+        @scheme                = DEFAULT_SCHEME
+        @host                  = DEFAULT_HOST
+        @port                  = DEFAULT_PORT
+
+        @prefix                = Utils::PathPrefix.new(DEFAULT_PREFIX)
+        @cdn                   = false
+        @compile               = false
+        @destination_directory = nil
+        @digest_manifest       = Config::NullDigestManifest.new(self)
+
+        @javascript_compressor = nil
+        @stylesheet_compressor = nil
+
+        root             Dir.pwd
+        public_directory root.join(DEFAULT_PUBLIC_DIRECTORY)
+        manifest         DEFAULT_MANIFEST
+      end
+
+      # Load the configuration
+      #
+      # This MUST be executed before to accept the first HTTP request
+      #
+      # @since 0.1.0
+      def load!
+        if digest && manifest_path.exist?
+          @digest_manifest = Config::DigestManifest.new(
+            JSON.load(manifest_path.read),
+            manifest_path
+          )
+        end
+
+        @base_url = URI::Generic.build(scheme: scheme, host: host, port: url_port).to_s
+      end
+
+      protected
+
+      # @since 0.1.0
+      # @api private
+      attr_writer :cdn
+
+      # @since 0.1.0
+      # @api private
+      attr_writer :compile
+
+      # @since 0.1.0
+      # @api private
+      attr_writer :scheme
+
+      # @since 0.1.0
+      # @api private
+      attr_writer :host
+
+      # @since 0.1.0
+      # @api private
+      attr_writer :port
+
+      # @since 0.1.0
+      # @api private
+      attr_writer :prefix
+
+      # @since 0.1.0
+      # @api private
+      attr_writer :root
+
+      # @since 0.1.0
+      # @api private
+      attr_writer :public_directory
+
+      # @since 0.1.0
+      # @api private
+      attr_writer :manifest
+
+      # @since 0.1.0
+      # @api private
+      attr_writer :sources
+
+      # @since 0.1.0
+      # @api private
+      attr_writer :javascript_compressor
+
+      # @since 0.1.0
+      # @api private
+      attr_writer :stylesheet_compressor
+
+      private
+
+      # @since 0.1.0
+      # @api private
+      def compile_path(source)
+        result = prefix.join(source)
+        result = digest_manifest.resolve(result) if digest
+        result.to_s
+      end
+
+      # @since 0.1.0
+      # @api private
+      def url_port
+        ( (scheme == HTTP_SCHEME  && port == HTTP_PORT  ) ||
+          (scheme == HTTPS_SCHEME && port == HTTPS_PORT ) ) ? nil : port.to_i
+      end
+    end
+  end
+end