jekyll-assets 2.0.0.pre.beta2 → 2.0.0.pre.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48edfcaf7a230379b1678a465004e4edf5381f3c
-  data.tar.gz: 0362698b9e266c37d035ecf3ac25ca4f4bc0e12d
+  metadata.gz: 2b637a94a5115e155d2c7a33811f8d61bbdc60be
+  data.tar.gz: a1c781f2d2902d9c748a5ab9ada53e0d2753a610
 SHA512:
-  metadata.gz: 24ba84fa3da852fe6dac197bbca6fddb81b9a5fd3537e107801263b48a91cece82500aa1a542f45be1cd44301b9f715dbfe5745a8a8fde3272704b14874bec9e
-  data.tar.gz: 256d59c5e6d68739be12120cfb10a4438ca9529a58178bdf20f6dce1515f1e0547bdf7a8052724e27b40854dc85ff440d5950034293951d86401645c4d562c5e
+  metadata.gz: 4a722a4ed9f298f846bc0d3f63cdb7059f50dbc59946fbe386f794c8fcfda876ba00909859c4489d6d045b1439dbd1b20c78f66dd5e57f4619585fd1f02e9ec2
+  data.tar.gz: 2f072f5cecab004b8bdc03da5a032a9b33cfd6108215287e9d062c955711f22781342e4f3278fef97a4a863fbde2b3dfffcfe5803fea1abccdab27b9d4a6ad42

data/Gemfile

@@ -3,14 +3,14 @@ gemspec
 
 gem "rake"
 group :development do
-  gem "pry"
   gem "therubyracer", :platforms => :mri
-  gem "guard-rspec"
-  gem "guard"
+  gem "pry"
 end
 
+gem "uglifier"
 gem "sprockets-es6", "~> 0.6"
 gem "autoprefixer-rails", "~> 6.0"
 gem "font-awesome-sass", "~> 4.4.0"
+gem "bootstrap-sass", "~> 3.3"
 gem "mini_magick", "~> 4.2"
-gem "uglifier"
+gem "compass-core"

data/README.md

@@ -1,9 +1,11 @@
-[![Build Status](https://travis-ci.org/jekyll/jekyll-assets.png?branch=master)](https://travis-ci.org/jekyll/jekyll-assets) [![Coverage Status](https://coveralls.io/repos/jekyll/jekyll-assets/badge.png?branch=master)](https://coveralls.io/r/jekyll/jekyll-assets) [![Code Climate](https://codeclimate.com/github/jekyll/jekyll-assets/badges/gpa.svg)](https://codeclimate.com/github/jekyll/jekyll-assets) [![Dependency Status](https://gemnasium.com/jekyll/jekyll-assets.svg)](https://gemnasium.com/jekyll/jekyll-assets)
+[![](https://travis-ci.org/jekyll/jekyll-assets.png?branch=master)][travis]
+[![](https://coveralls.io/repos/jekyll/jekyll-assets/badge.png?branch=master)][coveralls]
+[![](https://codeclimate.com/github/jekyll/jekyll-assets/badges/gpa.svg)][code-climate] [![](https://gemnasium.com/jekyll/jekyll-assets.svg)][gemnasium]
 
-
-## Are you looking for the docs for Jekyll Assets < 2.0.0?
-
-See: https://github.com/jekyll-assets/jekyll-assets/tree/legacy#jekyllassets
+[gemnasium]: https://gemnasium.com/jekyll/jekyll-assets
+[code-climate]: https://codeclimate.com/github/jekyll/jekyll-assets
+[coveralls]: https://coveralls.io/r/jekyll/jekyll-assets
+[travis]: https://travis-ci.org/jekyll/jekyll-assets
 
 # Jekyll 3 Assets
 
@@ -33,7 +35,8 @@ assets:
      js: false | true | default - development: false, production: true
   cache: false | directory | default: .asset-cache
   cdn: https://cdn.example.com
-  skip_prefix_with_cdn: false
+  skip_baseurl_with_cdn: false
+   skip_prefix_with_cdn: false
   prefix: "/assets"
   assets:
     - "*.png"
@@ -43,12 +46,12 @@ assets:
     - "_assets/folder"
 ```
 
-## Asset Digesting
+### Digesting
 
 * Disable digesting by default in development.
 * Digest by default in production
 
-## Asset Compression
+### Compression
 
 * Requires sass and uglify.
 * Disable compression by default in development.
@@ -95,16 +98,8 @@ rules for our tags as a specification.
 
 ### Current Proxies:
 
-* `sprockets:accept:<value>` - Tell Sprockets your preferred content type.
-* `sprockets:write_to:<value>` - The filename you wish us to write your file to.
-* `magick:resize:<value>` - Takes standard ImageMagick resize values.
-* `magick:format:<value>` - Takes standard ImageMagick format values.
-* `magick:rotate:<value>` - Takes standard ImageMagick resize values.
-* `magick:crop:<value>` - Takes standard ImageMagick crop values.
-* `magick:flip:<value>` - Takes standard ImageMagick flip values.
-* `magick:2x` - Tells us to write a double width/height image.
-* `magick:4x` - Tells us to write a quadruple width/height image.
-* `magick:half` - Tells us to shrink the image to half.
+* `sprockets:accept:<value>`
+* `sprockets:write_to:<value>`
 
 ## Filters
 
@@ -112,47 +107,45 @@ There is a full suite of filters, actually, any tag and any proxy can be a
 filter by way of filter arguments, take the following example:
 
 ```liquid
-{{ src | img : "magick:2x" }}
+{{ src | img : "magick:2x magick:quality:92" }}
 ```
 
 ## Hooks
 
-* `:env => [
-    :pre_init, :post_init
-  ]`
+* `:env => [:init]`
 
 You can register and trigger hooks like so:
 
 ```ruby
-Jekyll::Assets::Hook.trigger  :env, :post_init
-Jekyll::Assets::Hook.register :env, :post_init do
+Jekyll::Assets::Hook.register :env, :init do
   # Your Work
 end
 ```
 
-## Optional Processing Engines
+## Addons
 
-* ES6 Transpiler (through Babel) - add "sprockets-es6" to your Gemfile.
 * CSS Auto Prefixer - add "autoprefixer-rails" to your Gemfile.
+* ES6 Transpiler (through Babel) - add "sprockets-es6" to your Gemfile.
+* Image Magick - add "mini_magick"  to your Gemfile, only works with `img`, `image`.
+* Bootstrap - add "bootstrap-sass" to your Gemfile and "@import 'bootstrap'"
+* Compass - add "compass-core" to your Gemfile and "@import 'compass'"
+* Font Awesome - add "font-awesome-sass" to your Gemfile.
 
 ***Please note that some of these (if not all) have trouble with Rhino --
 `therubyrhino` so you would probably be best to just use Node.js or io.js at
 that point rather than trying to fight it.***
 
-### Engine Settings
-
-Some engines take settings, if they do you can add them like so:
-
-```YAML
-assets:
-  engines:
-    engine_name:
-      option: value
-```
-
-Only whitelisted options are allowed by default, so that we can guard against
-using paths we don't want to be used.  If you wish to have an option
-whitelisted please file a ticket or submit a pull request.
+### Image Magick Proxy arguments:
+
+* `magick:resize:<value>`
+* `magick:format:<value>`
+* `magick:quality:<value>`
+* `magick:rotate:<value>`
+* `magick:crop:<value>`
+* `magick:flip:<value>`
+* `magick:half`
+* `magick:2x`
+* `magick:4x`
 
 ## Plugins where did they go?
 

data/lib/jekyll/assets.rb

@@ -1,20 +1,22 @@
 require "sprockets"
-require "sprockets/helpers"
 require "jekyll"
 
-require_relative "assets/hook"
-require_relative "assets/helpers"
-require_relative "assets/extras/es6"
-require_relative "assets/extras/font-awesome"
-require_relative "assets/extras/helpers"
-require_relative "assets/extras/prefix"
+Dir.glob(File.expand_path("hooks/*.rb", __dir__)).map do |file|
+  require file
+end
 
-require_relative "assets/env"
-require_relative "assets/patches/jekyll/cleaner"
-require_relative "assets/patches/sprockets/asset"
-require_relative "assets/patches/jekyll/site"
-
-require_relative "assets/hooks/post_read"
-require_relative "assets/hooks/post_write"
-require_relative "assets/filters"
-require_relative "assets/tag"
+module Jekyll
+  module Assets
+    %W(patches/**/* cached config env hook logger version liquid/*
+         hooks/* addons/{*,**/*}).each do |path|
+      if path !~ /\*/
+        require_relative "assets/#{path}"
+      else
+        Dir.glob(File.expand_path("assets/#{path}.rb", __dir__)). \
+            map do |file|
+          require file
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/assets/addons/autoprefixer.rb

@@ -0,0 +1,5 @@
+try_require_if_javascript "autoprefixer-rails" do
+  Jekyll::Assets::Hook.register :env, :init do |env|
+    AutoprefixerRails.install(env)
+  end
+end

data/lib/jekyll/assets/addons/bootstrap.rb

@@ -0,0 +1 @@
+try_require "bootstrap-sass"

data/lib/jekyll/assets/addons/compass.rb

@@ -0,0 +1,7 @@
+try_require "compass/core" do
+  Jekyll::Assets::Hook.register :env, :init do
+    Compass::Frameworks::ALL.each do |framework|
+      append_path framework.stylesheets_directory
+    end
+  end
+end

data/lib/jekyll/assets/addons/font_awesome.rb

@@ -0,0 +1 @@
+try_require "font-awesome-sass"

data/lib/jekyll/assets/{extras/es6.rb → addons/js_es6.rb}

@@ -1,4 +1,4 @@
-Jekyll::Assets::Helpers.try_require_if_javascript? "sprockets/es6" do
+try_require_if_javascript "sprockets/es6" do
   if ExecJS.runtime.is_a?(ExecJS::RubyRhinoRuntime)
     Jekyll.logger.warn "ES6 transpiler has trouble with RubyRhino, use Node"
   end

data/lib/jekyll/assets/addons/proxies/magick.rb

@@ -0,0 +1,92 @@
+try_require "mini_magick" do
+  args = %W(resize quality rotate crop flip @2x @4x @half)
+  Jekyll::Assets::Env.liquid_proxies.add :magick, :img, *args do
+    class DoubleResizeError < RuntimeError
+      def initialize
+        "Both resize and @*x provided, this is not supported."
+      end
+    end
+
+    # -----------------------------------------------------------------
+    # @see https://github.com/minimagick/minimagick#usage -- All but
+    #   the boolean @ options are provided by Minimagick.
+    # -----------------------------------------------------------------
+
+    def initialize(asset, opts)
+      @asset, @path, @opts = asset, asset.filename, opts
+    end
+
+    # ---------------------------------------------------------------
+
+    def process
+      img = MiniMagick::Image.open(@path)
+      private_methods(true).select { |v| v =~ /\Amagick_/ }.each do |method|
+        send(method, img)
+      end
+
+      img.write(
+        @path
+      )
+    end
+
+    # ---------------------------------------------------------------
+
+    private
+    def magick_quality(img)
+      if @opts.has_key?(:quality)
+        img.quality @opts.fetch(:quality)
+      end
+    end
+
+    # ---------------------------------------------------------------
+
+    private
+    def magick_resize(img)
+      if @opts.has_key?(:resize) && (@opts.has_key?(:"2x") || \
+            @opts.has_key?(:"4x") || @opts.has_key?(:half))
+        raise DoubleResizeError
+
+      elsif @opts.has_key?(:resize)
+        img.resize @opts.fetch(:resize)
+      end
+    end
+
+    # ---------------------------------------------------------------
+
+    private
+    def magick_rotate(img)
+      if @opts.has_key?(:rotate)
+        img.rotate @opts.fetch(:rotate)
+      end
+    end
+
+    # ---------------------------------------------------------------
+
+    private
+    def magick_flip(img)
+      if @opts.has_key?(:flip)
+        img.flip @opts.fetch(:flip)
+      end
+    end
+
+    # ---------------------------------------------------------------
+
+    private
+    def magick_crop(img)
+      if @opts.has_key?(:crop)
+        img.crop @opts.fetch(:crop)
+      end
+    end
+
+    # ---------------------------------------------------------------
+
+    private
+    def magick_preset_resize(img)
+      return unless @opts.has_key?(:"2x") || @opts.has_key?(:"4x") || @opts.has_key?(:half)
+      width, height = img.width * 2, img.height * 2 if @opts.has_key?(:"2x")
+      width, height = img.width * 4, img.height * 4 if @opts.has_key?(:"4x")
+      width, height = img.width / 2, img.height / 2 if @opts.has_key?(:half)
+      img.resize "#{width}x#{height}"
+    end
+  end
+end

data/lib/jekyll/assets/config.rb

@@ -0,0 +1,48 @@
+module Jekyll
+  module Assets
+    module Config
+      Development = {
+        "skip_baseurl_with_cdn" => false,
+        "skip_prefix_with_cdn"  => false,
+        "prefix"    => "/assets",
+        "digest"    => false,
+        "assets"    => [],
+
+        "compress"  => {
+          "css"     => false,
+          "js"      => false
+        },
+
+        "sources"   => [
+          "_assets/css", "_assets/stylesheets",
+          "_assets/images", "_assets/img", "_assets/fonts",
+          "_assets/javascripts", "_assets/js"
+        ]
+      }
+
+      # -----------------------------------------------------------------------
+
+      Production = Development.merge({
+        "digest"    => true,
+        "compress"  => {
+          "css"     => true,
+          "js"      => true
+        },
+      })
+
+      # -----------------------------------------------------------------------
+
+      def self.defaults
+        %W(development test).include?(Jekyll.env) ? Development : Production
+      end
+
+      # -----------------------------------------------------------------------
+
+      def self.merge(nhash, ohash = defaults)
+        ohash.merge(nhash) do |key, oval, nval|
+          oval.is_a?(Hash) && nval.is_a?(Hash) ? merge(nval, oval) : nval
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/assets/env.rb

@@ -1,88 +1,157 @@
-require_relative "logger"
-require_relative "configuration"
-require_relative "context"
-require_relative "cached"
-
 module Jekyll
   module Assets
     class Env < Sprockets::Environment
       attr_reader :jekyll, :used
+
       class << self
-        attr_accessor :digest_cache, :assets_cache
+        attr_accessor :assets_cache, :digest_cache
         def digest_cache
-          @_digest_cache ||= \
-            {}
+          return @digest_cache ||= {}
+        end
+
+        # ---------------------------------------------------------------------
+
+        def liquid_proxies
+          return Liquid::Tag::Proxies
         end
       end
 
+      # -----------------------------------------------------------------------
+
+      def inspect
+        "<#{self.class.name} compress_js=#{compress?("js")} compress_css=#{compress?("css")} asset_path=#{
+          path
+        }>"
+      end
+
+      # -----------------------------------------------------------------------
+
       def initialize(path, jekyll = nil)
         jekyll, path = path, nil if path.is_a?(Jekyll::Site)
         @used, @jekyll = Set.new, jekyll
         path ? super(path) : super()
-        disable_erb
+        Hook.trigger(:env, :init) do |hook|
+          hook.arity > 0 || 0 > hook.arity ? hook.call(self) : instance_eval(&hook)
+        end
+      end
+
+      # -----------------------------------------------------------------------
 
-        jekyll.config["assets"] = Configuration.merge(asset_config)
-        private_methods(false).select { |v| v =~ %r!\Asetup_! }.map { |v| send(v) }
-        Hook.trigger :env, :post_init, self
-        jekyll.sprockets = self
+      def liquid_proxies
+        return self.class.liquid_proxies
       end
 
+      # -----------------------------------------------------------------------
+      # Make sure a path falls withint our cache dir.
+      # -----------------------------------------------------------------------
+
       def in_cache_dir(*paths)
         cache_dir = asset_config.fetch("cache", ".asset-cache") || nil
-        jekyll.in_source_dir(
-          cache_dir, *paths
-        )
+        jekyll.in_source_dir(cache_dir, *paths)
       end
 
+      # -----------------------------------------------------------------------
+      # Whether or not we are writing from the cache.
+      # -----------------------------------------------------------------------
+
       def cached_write?
         !@used.any?
       end
 
+      # -----------------------------------------------------------------------
+      # Merged form of `#extra_assets` and `@used` assets.
+      # -----------------------------------------------------------------------
+
       def all_assets(cached = false)
         if !cached
           then Set.new(@used).merge extra_assets
-          else Set.new(self.class.assets_cache).merge extra_assets
+          else Set.new(self.class.assets_cache).merge(extra_assets)
         end
       end
 
+      # -----------------------------------------------------------------------
+      # Assets you tell us you want to always compile, even if you do not
+      # use them.  Just like Rails this is probably normally used.
+      # -----------------------------------------------------------------------
+
       def extra_assets
         each_logical_path(*asset_config.fetch("assets", [])).map do |v|
           find_asset v
         end
       end
 
-      def cdn?() !dev? && !!asset_config["cdn"] end
-      def baseurl() jekyll.config["baseurl"] || "" end
-      def dev?() %W(development test).include? Jekyll.env end
-      def compress?(what) !!asset_config["compress"][what] end
-      def asset_config() jekyll.config["assets"] ||= {} end
-      def digest?() !!asset_config["digest"] end
-      def prefix() asset_config["prefix"] end
+      # -----------------------------------------------------------------------
+
+      def cdn?
+        !dev? && asset_config.has_key?("cdn") && asset_config.fetch("cdn")
+      end
+
+      # -----------------------------------------------------------------------
+
+      def baseurl
+        jekyll.config.fetch("baseurl", "")
+      end
+
+      # -----------------------------------------------------------------------
+
+      def dev?
+        %W(development test).include?(Jekyll.env)
+      end
+
+      # -----------------------------------------------------------------------
+
+      def compress?(what)
+        !!asset_config.fetch("compress").fetch(what, false)
+      end
+
+      # -----------------------------------------------------------------------
+
+      def asset_config
+        jekyll.config.fetch_or_store("assets", {})
+      end
+
+      # -----------------------------------------------------------------------
+
+      def digest?
+        !!asset_config.fetch("digest")
+      end
+
+      # -----------------------------------------------------------------------
+
+      def prefix
+        asset_config.fetch("prefix", "")
+      end
+
+      # -----------------------------------------------------------------------
+      # Prefixes a path with both the #base_url, the prefix and the CDN.
+      # -----------------------------------------------------------------------
 
       def prefix_path(path = "")
-        prefix = cdn? && asset_config["skip_prefix_with_cdn"] ? "" : self.prefix
-        path   = [baseurl, prefix, path]
-        if cdn? && (cdn = asset_config["cdn"])
-          File.join(cdn, *path).chomp(
-            "/"
-          )
-        else
-          File.join(*path).chomp(
-            "/"
-          )
-        end
+        prefix  = cdn? && asset_config.fetch( "skip_prefix_with_cdn") ? "" : self. prefix
+        baseurl = cdn? && asset_config.fetch("skip_baseurl_with_cdn") ? "" : self.baseurl
+        path    = [baseurl, prefix, path]
+
+        cdn = asset_config.fetch("cdn") if asset_config.has_key?("cdn")
+        cdn? && cdn ? File.join(cdn, *path).chomp("/") : \
+          File.join(*path).chomp("/")
       end
 
+      # -----------------------------------------------------------------------
+
       def cached
         Cached.new(self)
       end
 
+      # -----------------------------------------------------------------------
+
       def write_all
         if cached_write?
-          then write_cached_assets else write_assets
+          write_cached_assets else write_assets
         end
       end
 
+      # -----------------------------------------------------------------------
+
       private
       def write_assets(assets = self.all_assets)
         self.class.assets_cache = assets
@@ -95,10 +164,12 @@ module Jekyll
         end
       end
 
+      # -----------------------------------------------------------------------
+
       private
       def write_cached_assets(assets = all_assets(true))
         assets.each do |a|
-          if !a.is_a?(Tag::ProxiedAsset)
+          if !a.is_a?(Liquid::Tag::ProxiedAsset)
             viejo = self.class.digest_cache[a.logical_path]
             nuevo = find_asset(a.logical_path).digest
             path  = as_path a
@@ -117,65 +188,13 @@ module Jekyll
         end
       end
 
+      # -----------------------------------------------------------------------
+
       private
       def as_path(v)
         path = digest?? v.digest_path : v.logical_path
         jekyll.in_dest_dir(File.join(prefix, path))
       end
-
-      def disable_erb
-        self.config = hash_reassoc(config, :engines) do |h|
-          h.delete(".erb")
-        h
-        end
-      end
-
-      private
-      def setup_css_compressor
-        if compress?("css")
-          self.css_compressor = :sass
-        end
-      end
-
-      private
-      def setup_js_compressor
-        if compress?("js")
-          Helpers.try_require "uglifier" do
-            self.js_compressor = :uglify
-          end
-        end
-      end
-
-      private
-      def setup_context
-        Context.new(context_class)
-      end
-
-      private
-      def setup_version
-        self.version = Digest::MD5.hexdigest \
-          jekyll.config.fetch("assets", {}).to_s
-      end
-
-      private
-      def setup_sources
-        asset_config["sources"].each do |v|
-          append_path jekyll.in_source_dir(v)
-        end
-      end
-
-      private
-      def setup_logger
-        self.logger = Logger.new
-      end
-
-      private
-      def setup_cache
-        if cache_dir = asset_config.fetch("cache", ".asset-cache")
-          self.cache = Sprockets::Cache::FileStore.new \
-            jekyll.in_source_dir(cache_dir)
-        end
-      end
     end
   end
 end