bunto-assets 1.0.0.pre.alpha

data/lib/bunto/assets/hook.rb

@@ -0,0 +1,78 @@
+# ----------------------------------------------------------------------------
+# Frozen-string-literal: true
+# Copyright: 2016-present - MIT License
+# Encoding: utf-8
+# ----------------------------------------------------------------------------
+
+module Bunto
+  module Assets
+    class Hook
+      class UnknownHookError < RuntimeError
+        def initialize(base: nil, point: nil)
+          super "Unknown hook #{base ? "base" : "point"} '#{base || point}'"
+        end
+      end
+
+      # ----------------------------------------------------------------------
+
+      HOOK_ALIASES = {
+        :env => {
+          :post_init => :init,
+          :pre_init  => :init
+        }
+      }
+
+      # ----------------------------------------------------------------------
+
+      HOOK_POINTS = {
+        :env => [
+          :init
+        ]
+      }
+
+      # ----------------------------------------------------------------------
+
+      def self.all
+        @_all ||= {}
+      end
+
+      # ----------------------------------------------------------------------
+      # Trigger a hook, giving an optional block where we pass you the,
+      # proc we got and then you can do as you please (such as instance eval)
+      # but if you do not give us one then we simply pass the args.
+      # ----------------------------------------------------------------------
+
+      def self.trigger(base, point_, *args, &block)
+        raise ArgumentError, "Do not give args with a block" if args.size > 0 && block_given?
+        if all.key?(base) && all[base].key?(point_)
+          Set.new.merge(point(base, point_, :early)).merge(point(base, point_)).map do |v|
+            block_given?? block.call(v) : v.call(*args)
+          end
+        end
+      end
+
+      # ----------------------------------------------------------------------
+
+      def self.point(base, point, when_ = :late)
+        point = all[base][point] ||= {
+          :early => Set.new,
+          :late  => Set.new
+        }
+
+        point[when_]
+      end
+
+      # ----------------------------------------------------------------------
+
+      def self.register(base, point, when_ = :late, &block)
+        raise UnknownHookError, base: base unless HOOK_POINTS.key?(base)
+        point = HOOK_ALIASES[base][point] if HOOK_ALIASES.fetch(base, {}).key?(point)
+        raise UnknownHookError, point: point unless HOOK_POINTS[base].include?(point)
+        all[base] ||= {}
+
+        point(base, point, when_) \
+          .add(block)
+      end
+    end
+  end
+end

data/lib/bunto/assets/hooks/bunto/drops.rb

@@ -0,0 +1,9 @@
+# ----------------------------------------------------------------------------
+# Frozen-string-literal: true
+# Copyright: 2016-present - MIT License
+# Encoding: utf-8
+# ----------------------------------------------------------------------------
+
+Bunto::Hooks.register :site, :pre_render do |bunto, payload|
+  payload["assets"] = bunto.sprockets.to_liquid_payload
+end

data/lib/bunto/assets/hooks/bunto/setup.rb

@@ -0,0 +1,13 @@
+# ----------------------------------------------------------------------------
+# Frozen-string-literal: true
+# Copyright: 2016-present - MIT License
+# Encoding: utf-8
+# ----------------------------------------------------------------------------
+
+Bunto::Hooks.register :site, :after_reset do |bunto|
+  Bunto::Assets::Env.new(bunto)
+
+  excludes = Set.new(bunto.config["exclude"])
+  bunto.sprockets.excludes.map(&excludes.method(:add))
+  bunto.config["exclude"] = excludes.to_a
+end

data/lib/bunto/assets/hooks/bunto/write.rb

@@ -0,0 +1,9 @@
+# ----------------------------------------------------------------------------
+# Frozen-string-literal: true
+# Copyright: 2016-present - MIT License
+# Encoding: utf-8
+# ----------------------------------------------------------------------------
+
+Bunto::Hooks.register :site, :post_write do |bunto|
+  bunto.sprockets.write_all
+end

data/lib/bunto/assets/hooks/cache.rb

@@ -0,0 +1,15 @@
+# ----------------------------------------------------------------------------
+# Frozen-string-literal: true
+# Copyright: 2016-present - MIT License
+# Encoding: utf-8
+# ----------------------------------------------------------------------------
+
+Bunto::Assets::Hook.register :env, :init do
+  cache_dir = asset_config.fetch("cache", ".asset-cache")
+
+  if cache_dir
+    self.cache = Sprockets::Cache::FileStore.new(
+      bunto.in_source_dir(cache_dir)
+    )
+  end
+end

data/lib/bunto/assets/hooks/compression.rb

@@ -0,0 +1,17 @@
+# ----------------------------------------------------------------------------
+# Frozen-string-literal: true
+# Copyright: 2016-present - MIT License
+# Encoding: utf-8
+# ----------------------------------------------------------------------------
+
+Bunto::Assets::Hook.register :env, :init do
+  if compress?("css")
+    self.css_compressor = :sass
+  end
+
+  if compress?("js")
+    try_require "uglifier" do
+      self.js_compressor = :uglify
+    end
+  end
+end

data/lib/bunto/assets/hooks/configuration.rb

@@ -0,0 +1,12 @@
+# ----------------------------------------------------------------------------
+# Frozen-string-literal: true
+# Copyright: 2016-present - MIT License
+# Encoding: utf-8
+# ----------------------------------------------------------------------------
+
+Bunto::Assets::Hook.register :env, :init, :early do
+  bunto.config["assets"] = Bunto::Assets::Config.merge(asset_config)
+  Bunto::Assets::Config.merge_sources(
+    bunto, asset_config
+  )
+end

data/lib/bunto/assets/hooks/context.rb

@@ -0,0 +1,11 @@
+# ----------------------------------------------------------------------------
+# Frozen-string-literal: true
+# Copyright: 2016-present - MIT License
+# Encoding: utf-8
+# ----------------------------------------------------------------------------
+
+Bunto::Assets::Hook.register :env, :init do
+  context_class.class_eval(
+    &self.class.context_patches
+  )
+end

data/lib/bunto/assets/hooks/erb.rb

@@ -0,0 +1,15 @@
+# ----------------------------------------------------------------------------
+# Frozen-string-literal: true
+# Copyright: 2016-present - MIT License
+# Encoding: utf-8
+# ----------------------------------------------------------------------------
+
+Bunto::Assets::Hook.register :env, :init, :early do
+  self.config = hash_reassoc(config, :engines) do |hash|
+    hash.delete(
+      ".erb"
+    )
+
+    hash
+  end
+end

data/lib/bunto/assets/hooks/helpers.rb

@@ -0,0 +1,14 @@
+# ----------------------------------------------------------------------------
+# Frozen-string-literal: true
+# Copyright: 2016-present - MIT License
+# Encoding: utf-8
+# ----------------------------------------------------------------------------
+
+require "sprockets/helpers"
+
+Bunto::Assets::Hook.register :env, :init do
+  Sprockets::Helpers.configure do |config|
+    config.prefix = prefix_path
+    config.digest = digest?
+  end
+end

data/lib/bunto/assets/hooks/logger.rb

@@ -0,0 +1,9 @@
+# ----------------------------------------------------------------------------
+# Frozen-string-literal: true
+# Copyright: 2016-present - MIT License
+# Encoding: utf-8
+# ----------------------------------------------------------------------------
+
+Bunto::Assets::Hook.register :env, :init do
+  self.logger = Bunto::Assets::Logger.new
+end

data/lib/bunto/assets/hooks/sources.rb

@@ -0,0 +1,13 @@
+# ----------------------------------------------------------------------------
+# Frozen-string-literal: true
+# Copyright: 2016-present - MIT License
+# Encoding: utf-8
+# ----------------------------------------------------------------------------
+
+Bunto::Assets::Hook.register :env, :init do
+  asset_config["sources"] ||= []
+
+  asset_config["sources"].each do |path|
+    append_path bunto.in_source_dir(path)
+  end
+end

data/lib/bunto/assets/hooks/sprockets.rb

@@ -0,0 +1,9 @@
+# ----------------------------------------------------------------------------
+# Frozen-string-literal: true
+# Copyright: 2016-present - MIT License
+# Encoding: utf-8
+# ----------------------------------------------------------------------------
+
+Bunto::Assets::Hook.register :env, :init do
+  bunto.sprockets = self
+end

data/lib/bunto/assets/hooks/version.rb

@@ -0,0 +1,11 @@
+# ----------------------------------------------------------------------------
+# Frozen-string-literal: true
+# Copyright: 2016-present - MIT License
+# Encoding: utf-8
+# ----------------------------------------------------------------------------
+
+Bunto::Assets::Hook.register :env, :init do
+  self.version = Digest::MD5.hexdigest(
+    asset_config.inspect
+  )
+end

data/lib/bunto/assets/hooks.rb

@@ -0,0 +1,20 @@
+# ----------------------------------------------------------------------------
+# Frozen-string-literal: true
+# Copyright: 2016-present - MIT License
+# Encoding: utf-8
+# ----------------------------------------------------------------------------
+
+require_relative "hooks/bunto/drops"
+require_relative "hooks/bunto/setup"
+require_relative "hooks/bunto/write"
+
+require_relative "hooks/context"
+require_relative "hooks/compression"
+require_relative "hooks/configuration"
+require_relative "hooks/helpers"
+require_relative "hooks/logger"
+require_relative "hooks/sources"
+require_relative "hooks/sprockets"
+require_relative "hooks/version"
+require_relative "hooks/cache"
+require_relative "hooks/erb"

data/lib/bunto/assets/liquid/drop.rb

@@ -0,0 +1,76 @@
+# ----------------------------------------------------------------------------
+# Frozen-string-literal: true
+# Copyright: 2016-present - MIT License
+# Encoding: utf-8
+# ----------------------------------------------------------------------------
+
+require "fastimage"
+
+module Bunto
+  module Assets
+    module Liquid
+      class Drop < ::Liquid::Drop
+        extend Forwardable
+        def initialize(path, bunto)
+          @path = path
+          @bunto = bunto
+          @asset = nil
+        end
+
+        # --------------------------------------------------------------------
+        
+        def_delegator :asset, :digest_path
+        def_delegator :asset, :logical_path
+        def_delegator :asset, :content_type, :type
+        def_delegator :asset, :content_type
+        def_delegator :asset, :filename
+
+        # --------------------------------------------------------------------
+
+        def basename
+          File.basename(@path)
+        end
+
+        # --------------------------------------------------------------------
+
+        def width
+          if image?
+            dimensions.first
+          end
+        end
+
+        # --------------------------------------------------------------------
+
+        def height
+          if image?
+            dimensions.last
+          end
+        end
+
+        # --------------------------------------------------------------------
+
+        def dimensions
+          if image?
+            @dimensions ||= FastImage.new(asset.filename).size
+          end
+        end
+
+        # --------------------------------------------------------------------
+
+        private
+        def image?
+          %W(image/png image/jpeg image/gif).include?(
+            asset.content_type
+          )
+        end
+
+        # --------------------------------------------------------------------
+
+        private
+        def asset
+          @asset ||= @bunto.sprockets.find_asset(@path)
+        end
+      end
+    end
+  end
+end

data/lib/bunto/assets/liquid/filters.rb

@@ -0,0 +1,28 @@
+# Frozen-string-literal: true
+# Copyright: 2016-present - MIT License
+# Encoding: utf-8
+
+module Bunto
+  module Assets
+    module Liquid
+      module Filters
+        ACCEPTABLE_FILTERS = [:css, :img, :asset_path, :stylesheet,
+          :javascript, :style, :img, :js]
+
+        # --------------------------------------------------------------------
+
+        ACCEPTABLE_FILTERS.each do |val|
+          define_method val do |path, args = ""|
+            Tag.send(:new, val, "#{path} #{args}", "").render(@context)
+          end
+        end
+      end
+    end
+  end
+end
+
+# ----------------------------------------------------------------------------
+# Register it with Liquid, good luck from here.
+# ----------------------------------------------------------------------------
+
+Liquid::Template.register_filter(Bunto::Assets::Liquid::Filters)

data/lib/bunto/assets/liquid/tag/defaults/image.rb

@@ -0,0 +1,69 @@
+# ----------------------------------------------------------------------------
+# Frozen-string-literal: true
+# Copyright: 2016-present - MIT License
+# Encoding: utf-8
+# ----------------------------------------------------------------------------
+
+module Bunto
+  module Assets
+    module Liquid
+      class Tag
+        module Defaults
+          class Image
+            def self.for?(tag)
+              tag == "img" || tag == "image"
+            end
+
+            # ----------------------------------------------------------------
+            # TODO: In 3.0 env needs to be enforced if this is not changed,
+            #   for now it's not enforced to maintain the 2.0 API.
+            # ----------------------------------------------------------------
+
+            def initialize(args, asset, env = nil)
+              @args = args
+              @asset = asset
+              @env = env
+            end
+
+            # ----------------------------------------------------------------
+
+            def set!
+              set_img_dimensions
+              set_img_alt
+            end
+
+            # ----------------------------------------------------------------
+            # TODO: 3.0 - Remove the `!@env`
+            # ----------------------------------------------------------------
+
+            private
+            def set_img_alt
+              if !@env || @env.asset_config["features"]["automatic_img_alt"]
+                @args[:html] ||= {}
+                unless @args[:html].key?("alt")
+                  @args[:html]["alt"] = @asset.logical_path
+                end
+              end
+            end
+
+            # ----------------------------------------------------------------
+            # TODO: 3.0 - Remove the `!@env`
+            # ----------------------------------------------------------------
+
+            private
+            def set_img_dimensions
+              if !@env || @env.asset_config["features"]["automatic_img_size"]
+                dimensions = FastImage.new(@asset.filename).size
+                return unless dimensions
+                @args[:html] ||= {}
+
+                @args[:html][ "width"] ||= dimensions.first
+                @args[:html]["height"] ||= dimensions. last
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bunto/assets/liquid/tag/defaults.rb

@@ -0,0 +1,23 @@
+module Bunto
+  module Assets
+    module Liquid
+      class Tag
+        module Defaults
+          require_relative "defaults/image"
+
+          # ------------------------------------------------------------------
+          # TODO: In 1.0 env needs to be enforced, right now it's not
+          #   because it's maintain 2.0 API.
+          # ------------------------------------------------------------------
+
+          module_function
+          def set_defaults_for!(tag, args, asset, env = nil)
+            constants.select { |const| const_get(const).for?(tag) }.each do |const|
+              const_get(const).new(args, asset, env).set!
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bunto/assets/liquid/tag/parser.rb

@@ -0,0 +1,200 @@
+# ----------------------------------------------------------------------------
+# Frozen-string-literal: true
+# Copyright: 2016-present - MIT License
+# Encoding: utf-8
+# ----------------------------------------------------------------------------
+
+require_relative "proxies"
+require "forwardable"
+
+module Bunto
+  module Assets
+    module Liquid
+
+      # ----------------------------------------------------------------------
+      # Examples:
+      #   - {% tag value argument:value %}
+      #   - {% tag value "argument:value" %}
+      #   - {% tag value argument:"I have spaces" %}
+      #   - {% tag value argument:value\:with\:colon %}
+      #   - {% tag value argument:"I can even escape \\: here too!" %}
+      #   - {% tag value proxy:key:value %}
+      # ----------------------------------------------------------------------
+
+      class Tag
+        class Parser
+          attr_reader :args, :raw_args
+          extend Forwardable
+
+          def_delegator :@args, :each
+          def_delegator :@args, :key?
+          def_delegator :@args, :fetch
+          def_delegator :@args, :store
+          def_delegator :@args, :to_h
+          def_delegator :@args, :[]=
+          def_delegator :@args, :[]
+
+          # ------------------------------------------------------------------
+
+          ACCEPT = {
+            "css" => "text/css", "js" => "application/javascript"
+          }
+
+          # ------------------------------------------------------------------
+
+          class UnescapedColonError < StandardError
+            def initialize
+              super "Unescaped double colon argument."
+            end
+          end
+
+          # ------------------------------------------------------------------
+
+          class UnknownProxyError < StandardError
+            def initialize
+              super "Unknown proxy argument."
+            end
+          end
+
+          # ------------------------------------------------------------------
+
+          def initialize(args, tag, processed: false, raw_args: nil)
+            if processed && raw_args
+              @args = args
+              @raw_args = raw_args
+              @tag = tag
+
+            elsif processed && !raw_args
+              raise ArgumentError, "You must provide raw_args if you pre-process." \
+                "Please provide the raw args."
+
+            else
+              @tag = tag
+              @raw_args = args
+              parse_raw
+              set_accept
+            end
+          end
+
+          # ------------------------------------------------------------------
+
+          def parse_liquid(context)
+            return self unless context.is_a?(Object::Liquid::Context)
+            liquid = context.registers[:site].liquid_renderer.file("(bunto:assets)")
+            out = parse_hash_liquid(to_h, liquid, context)
+            self.class.new(out, @tag, raw_args: @raw_args, \
+              processed: true)
+          end
+
+          # ------------------------------------------------------------------
+
+          def to_html
+            (self[:html] || {}).map do |key, val|
+              %{ #{key}="#{val}"}
+            end.join
+          end
+
+          # ------------------------------------------------------------------
+
+          def proxies
+            keys = (args.keys - Proxies.base_keys - [:file, :html])
+            args.select do |key, _|
+              keys.include?(key)
+            end
+          end
+
+          # ------------------------------------------------------------------
+
+          def proxies?
+            proxies.any?
+          end
+
+          # ------------------------------------------------------------------
+
+          private
+          def parse_hash_liquid(hash_, liquid, context)
+            hash_.each_with_object({}) do |(key, val), hash|
+              val = liquid.parse(val).render(context) if val.is_a?(String)
+              val = parse_hash_liquid(val, liquid, context) if val.is_a?(Hash)
+              hash[key] = val
+            end
+          end
+
+          # ------------------------------------------------------------------
+
+          private
+          def parse_raw
+            @args = from_shellwords.each_with_index.each_with_object({}) do |(key, index), hash|
+              if index == 0 then hash.store(:file, key)
+              elsif key =~ /:/ && (key = key.split(/(?<!\\):/))
+                parse_col hash, key
+
+              else
+                (hash[:html] ||= {})[key] = true
+              end
+
+              hash
+            end
+          end
+
+          # ------------------------------------------------------------------
+
+          private
+          def parse_col(hash, key)
+            key.push(key.delete_at(-1).gsub(/\\:/, ":"))
+            return as_proxy hash, key if key.size == 3
+            return as_bool_or_html hash, key if key.size == 2
+            raise UnescapedColonError
+          end
+
+          # ------------------------------------------------------------------
+
+          private
+          def as_bool_or_html(hash, key)
+            okey = key
+            key, sub_key = key
+            if Proxies.has?(key, @tag, "@#{sub_key}")
+              (hash[key.to_sym] ||= {})[sub_key.to_sym] = true
+            else
+              (hash[:html] ||= {})[key] = \
+                okey[1]
+            end
+          end
+
+          # ------------------------------------------------------------------
+
+          private
+          def as_proxy(hash, key)
+            key, sub_key, val = key
+            if Proxies.has?(key, @tag, sub_key)
+              (hash[key.to_sym] ||= {})[sub_key.to_sym] = \
+                val
+
+            elsif Proxies.has?(key)
+              raise UnknownProxyError
+            end
+          end
+
+          # ------------------------------------------------------------------
+
+          private
+          def set_accept
+            if ACCEPT.key?(@tag) && (!@args.key?(:sprockets) || \
+                  !@args[:sprockets].key?(:accept))
+
+              (@args[:sprockets] ||= {})[:accept] = \
+                ACCEPT[@tag]
+            end
+          end
+
+          # ------------------------------------------------------------------
+
+          private
+          def from_shellwords
+            Shellwords.shellwords(@raw_args)
+          end
+        end
+      end
+    end
+  end
+end