lotus-assets 0.0.0 → 0.1.0

data/lib/lotus/assets/compressors/null_compressor.rb

@@ -0,0 +1,19 @@
+require 'lotus/assets/compressors/abstract'
+
+module Lotus
+  module Assets
+    module Compressors
+      # No-op, it returns the asset contents without to compress them.
+      #
+      # @since 0.1.0
+      # @api private
+      class NullCompressor < Abstract
+        # @since 0.1.0
+        # @api private
+        def compress(filename)
+          read(filename)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+require 'lotus/assets/compressors/stylesheet'
+require 'sass'
+
+module Lotus
+  module Assets
+    module Compressors
+      # Sass compressor for stylesheet
+      #
+      # It depends on <tt>sass</tt> gem.
+      #
+      # @since 0.1.0
+      # @api private
+      #
+      # @see http://sass-lang.com
+      # @see https://rubygems.org/gems/sass
+      class SassStylesheet < Stylesheet
+        # @since 0.1.0
+        # @api private
+        #
+        # FIXME This is the same logic that we have for Lotus::Assets::Compiler
+        SASS_CACHE_LOCATION = Pathname(Lotus.respond_to?(:root) ?
+                                       Lotus.root : Dir.pwd).join('tmp', 'sass-cache')
+        # @since 0.1.0
+        # @api private
+        def initialize
+          @compressor = Sass::Engine
+        end
+
+        # @since 0.1.0
+        # @api private
+        def compress(filename)
+          compressor.new(read(filename), filename: filename, syntax: :scss,
+            style: :compressed, cache_location: SASS_CACHE_LOCATION).render
+        end
+      end
+    end
+  end
+end

data/lib/lotus/assets/compressors/stylesheet.rb

@@ -0,0 +1,77 @@
+require 'lotus/assets/compressors/abstract'
+
+module Lotus
+  module Assets
+    module Compressors
+      # Base class for stylesheet compressors
+      #
+      # @since 0.1.0
+      # @api private
+      class Stylesheet < Abstract
+        # Factory for Stylesheet compressors.
+        #
+        # It loads a compressor for the given name.
+        #
+        # @param engine_name [Symbol,String,NilClass,#compress] the name of the
+        #   engine to load or an instance of an engine
+        #
+        # @return [Lotus::Assets::Compressors::Abstract] returns a concrete
+        #   implementation of a compressor
+        #
+        # @raise [Lotus::Assets::Compressors::UnknownCompressorError] when the
+        #   given name refers to an unknown compressor engine
+        #
+        # @since 0.1.0
+        # @api private
+        #
+        # @see Lotus::Assets::Compressors::Abstract#for
+        # @see Lotus::Assets::Configuration#stylesheet_compressor
+        #
+        # @example Basic Usage
+        #   require 'lotus/assets'
+        #   require 'lotus/assets/compressors/stylesheet'
+        #
+        #   Lotus::Assets::Compressors::Stylesheet.for(:sass)
+        #     # => #<Lotus::Assets::Compressors::SassStylesheet:0x007f8674cc4a50 ...>
+        #
+        # @example Null Compressor
+        #   require 'lotus/assets'
+        #   require 'lotus/assets/compressors/stylesheet'
+        #
+        #   Lotus::Assets::Compressors::Stylesheet.for(nil)
+        #     # => #<Lotus::Assets::Compressors::NullCompressor:0x007fa32a314258>
+        #
+        # @example Custom Compressor
+        #   require 'lotus/assets'
+        #   require 'lotus/assets/compressors/stylesheet'
+        #
+        #   class CustomStylesheetCompressor
+        #     def compress(filename)
+        #       # ...
+        #     end
+        #   end
+        #
+        #   Lotus::Assets::Compressors::Stylesheet.for(CustomStylesheetCompressor.new)
+        #     # => #<CustomStylesheetCompressor:0x007fa32a2cdf10>
+        #
+        # @example Third Party Compressor
+        #   require 'lotus/assets'
+        #   require 'lotus/assets/compressors/stylesheet'
+        #   require 'lotus/foo/compressor' # third party gem
+        #
+        #   Lotus::Assets::Compressors::Stylesheet.for(:foo)
+        #     # => #<Lotus::Assets::Compressors::FooStylesheet:0x007fa3dd9ed968>
+        #
+        # @example Unknown Engine
+        #   require 'lotus/assets'
+        #   require 'lotus/assets/compressors/stylesheet'
+        #
+        #   Lotus::Assets::Compressors::Stylesheet.for(:wat)
+        #     # => Lotus::Assets::Compressors::UnknownCompressorError: Unknown Stylesheet compressor: :wat
+        def self.for(engine_name)
+          super
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require 'lotus/assets/compressors/javascript'
+require 'uglifier'
+
+module Lotus
+  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/lotus/assets/compressors/yui_javascript.rb

@@ -0,0 +1,25 @@
+require 'lotus/assets/compressors/javascript'
+require 'yui/compressor'
+
+module Lotus
+  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/lotus/assets/compressors/yui_stylesheet.rb

@@ -0,0 +1,25 @@
+require 'lotus/assets/compressors/stylesheet'
+require 'yui/compressor'
+
+module Lotus
+  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/lotus/assets/config/global_sources.rb

@@ -0,0 +1,50 @@
+require 'lotus/utils/load_paths'
+
+module Lotus
+  module Assets
+    # Configuration settings
+    #
+    # @since 0.1.0
+    # @api private
+    module Config
+      # Global asset sources across all the duplicated <tt>Lotus::Assets</tt>
+      # instances.
+      #
+      # @since 0.1.0
+      # @api private
+      #
+      # @see Lotus::Assets.duplicate
+      # @see http://www.rubydoc.info/gems/lotus-utils/Lotus/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
+          Lotus::Assets.configuration.sources << @paths
+        end
+
+        # @since 0.1.0
+        # @api private
+        def sync_duplicated_frameworks
+          Lotus::Assets.duplicates.each do |duplicate|
+            duplicate.configuration.sources << @paths
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,112 @@
+module Lotus
+  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>Lotus::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>Lotus::Assets::MissingDigestManifestError</tt>.
+      #
+      # @since 0.1.0
+      # @api private
+      #
+      # @see Lotus::Assets::Configuration#manifest
+      # @see Lotus::Assets::Configuration#manifest_path
+      # @see Lotus::Assets::Configuration#digest
+      class NullDigestManifest < Utils::BasicObject
+        # Return a new instance
+        #
+        # @param configuration [Lotus::Assets::Configuration]
+        #
+        # @return [Lotus::Assets::Config::NullDigestManifest] a new instance
+        #
+        # @since 0.1.0
+        # @api private
+        def initialize(configuration)
+          @configuration = configuration
+        end
+
+        # @raise [Lotus::Assets::MissingDigestManifestError]
+        #
+        # @since 0.1.0
+        # @api private
+        def method_missing(*)
+          ::Kernel.raise(
+            ::Lotus::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 [Lotus::Assets::Config::Manifest] a new instance
+        #
+        # @since 0.1.0
+        # @api private
+        #
+        # @see Lotus::Assets::Configuration#manifest
+        # @see Lotus::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 [Lotus::Assets::MissingDigestAssetError] when the asset can't be
+        #   found in manifest
+        def resolve(asset)
+          @assets.fetch(asset.to_s) do
+            raise Lotus::Assets::MissingDigestAssetError.new(asset, @manifest_path)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+require 'lotus/utils/load_paths'
+
+module Lotus
+  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 Lotus::Assets.duplicate
+      # @see http://www.rubydoc.info/gems/lotus-utils/Lotus/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