jekyll-assets 2.0.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b81ac4f22eb832b198919b11d617d421819b1d31
-  data.tar.gz: d1d771556d778ede73e0c9067c1dc578a63f0b7b
+  metadata.gz: 5ea6db7ce6d3db7e9638ea43bc6b16ef66bda4c4
+  data.tar.gz: 0b4949e68651598f61d1fbf8589999b95984b941
 SHA512:
-  metadata.gz: 3e9718a9d8169ca570ed7f6ac60dda3c1b76c7491d88960eead9a0efe5167271aa3ca0bde980d7e2ad81cca2b25ff341077ebd321a8e37d687981d26c9532622
-  data.tar.gz: 39f73f170484aab78684abf3bb4b408bb53c877ada4465db38684fae7e26f23d3418ce0348d2d2e482b46feff417cad0e05171a919a8faebacdb02cbb114034b
+  metadata.gz: b2bffef1cdd4b4f3c61979fa5cd097dcd89f13158cdb47d21c38d8e459338551e80a4809c6d2dcd43102a846d0310f4b9c8cb5d05087a2085433ace7b6b326f5
+  data.tar.gz: e85a0acdc8a0b8842045f6702a9a6f7cabac5e49144b0ea01738727488ef011f977a384e1452a18ad5372b0e56778dc0b44b22df95f906ca7639d4dabe62310b

data/Gemfile

@@ -3,14 +3,18 @@ gemspec
 
 gem "rake"
 group :development do
-  gem "therubyracer", :platforms => :mri
-  gem "pry"
+  gem "therubyracer", :platforms => :mri, :require => false
+  gem "pry", :require => false
 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 "compass-core"
+group :test do
+  gem "codeclimate-test-reporter", :require => false
+end
+
+gem "uglifier", :require => false
+gem "sprockets-es6", "~> 0.6", :require => false
+gem "autoprefixer-rails", "~> 6.0", :require => false
+gem "font-awesome-sass", "~> 4.4.0", :require => false
+gem "bootstrap-sass", "~> 3.3", :require => false
+gem "mini_magick", "~> 4.2", :require => false
+gem "compass-core", :require => false

data/README.md

@@ -1,10 +1,10 @@
 [![](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/coverage.svg)][coverage]
 [![](https://codeclimate.com/github/jekyll/jekyll-assets/badges/gpa.svg)][code-climate] [![](https://gemnasium.com/jekyll/jekyll-assets.svg)][gemnasium]
 
 [gemnasium]: https://gemnasium.com/jekyll/jekyll-assets
 [code-climate]: https://codeclimate.com/github/jekyll/jekyll-assets
-[coveralls]: https://coveralls.io/r/jekyll/jekyll-assets
+[coverage]: https://codeclimate.com/github/jekyll/jekyll-assets/coverage
 [travis]: https://travis-ci.org/jekyll/jekyll-assets
 
 # Jekyll 3 Assets
@@ -57,10 +57,16 @@ assets:
     - _assets/img
     - _assets/js
   features:
-    automatic_image_size: true | false | default: true
-    automatic_image_alt : true | false | default: true
+    automatic_img_size: true | false | default: true
+    automatic_img_alt : true | false | default: true
 ```
 
+### Cache Folder
+
+If you plan to change the `cache` folder, please make sure to add that
+folder to your `exclude` list in Jekyll or you will generate over and over
+and over again, `.` folders are not ignored by default.
+
 ### Sources
 
 The listed resources in the example are all defaults. It should be noted
@@ -77,6 +83,8 @@ folder as the sole source (base folder.)***
 * Disable digesting by default in development.
 * Digest by default in production
 
+***You can force digesting with `digest: true` in your `_config.yml`***
+
 ### Compression
 
 * Requires sass and uglify.
@@ -84,7 +92,7 @@ folder as the sole source (base folder.)***
 * Enable by default in production.
 
 
-### Bower (web components support.)
+### Bower Components
 
 Modify your `.bowerrc` file and add:
 
@@ -98,7 +106,9 @@ And then add `_assets/bower` to your sources list and Sprockets will do the
 the rest for you... you can even `//= require bower_asset.js`.  We will even
 compress them for you per normal if Sprockets supports it and allows us to.
 
-***You can force digesting with `digest: true` in your `_config.yml`***
+***You do not need to modify your `.bowerrc` file, you can optionally just
+add it to your sources list and it will work that way too!  As long as it's in
+your Jekyll folder.***
 
 ## Tags
 
@@ -136,11 +146,14 @@ rules for our tags as a specification.
 * `sprockets:accept:<value>`
 * `sprockets:write_to:<value>`
 
-## Liquid Variables in Arguments
+## Liquid Variables
+
+We support liquid arguments for tag values (but not tag keys), and we also
+support Liquid pre-processing (with your Jekyll context) sass/less/css files
+you need do nothing special for the preprocessing an entire file, it's
+always done.
 
-You can use Liquid variables inside of your arguments, but you must quote
-them to get them to work, this can be a partial argument quote a full argument
-quote or otherwise, it just must be quoted or escaped.
+An example of using Liquid in your tags:
 
 ```liquid
 {% img '{{ image_path }}' %}
@@ -148,6 +161,19 @@ quote or otherwise, it just must be quoted or escaped.
 {% img {{\ image_path\ }} %}
 ```
 
+An example of using Liquid in your SCSS:
+
+```scss
+.bg {
+  background: url(asset_path("{{ site.background_image }}"));
+}
+```
+
+You have full access to your entire Jekyll context from any liquid
+processing we do, so you can do whatever you like and be as dynamic as you
+like, including full loops and conditional Liquid based CSS since we
+pre-process your text files.
+
 ## Getting a list of your assets and basic info from Liquid
 
 We provide all *your* assets as a hash of Liquid Drops so you can get basic

data/Rakefile

@@ -1,3 +1,43 @@
 require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 task :default => [:spec]
+
+task :analysis do
+  require "open3"
+  begin require "jekyll/utils/ansi"
+  rescue LoadError
+    require_relative "spec/support/ansi"
+  end
+
+  cmd = [
+    "docker", "run", "--rm", "--env=CODE_PATH=#{Dir.pwd}", \
+    "--volume='#{Dir.pwd}:/code'", "--volume=/var/run/docker.sock:/var/run/docker.sock", \
+    "--volume=/tmp/cc:/tmp/cc", "-i", "codeclimate/codeclimate", "analyze"
+  ]
+
+  ansi = Jekyll::Utils::Ansi
+  file = File.open(".analysis", "w+")
+  Open3.popen3(cmd.shelljoin) do |_, out, err, _|
+    while data = out.gets
+      file.write data
+      if data =~ /\A==/
+        $stdout.print ansi.yellow(data)
+
+      elsif data !~ %r!\A[0-9\-]+!
+        $stdout.puts data
+
+      else
+        h, d = data.split(":", 2)
+        $stdout.print ansi.cyan(h)
+        $stdout.print ":", d
+      end
+    end
+
+    while data = err.gets
+      file.write data
+      $stderr.print ansi.red(data)
+    end
+  end
+
+  file.close
+end

data/lib/jekyll/assets.rb

@@ -2,20 +2,23 @@
 # Copyright: 2012-2015 - MIT License
 # Encoding: utf-8
 
+autoload :Tilt, "tilt"
 require "sprockets"
 require "jekyll"
 
+require "jekyll/assets/patches"
+require "jekyll/assets/version"
+
 module Jekyll
   module Assets
-    require_relative "assets/version"
-    require_relative "assets/patches"
-    require_relative "assets/cached"
-    require_relative "assets/config"
-    require_relative "assets/env"
-    require_relative "assets/hook"
-    require_relative "assets/logger"
-    require_relative "assets/hooks"
-    require_relative "assets/liquid"
-    require_relative "assets/addons"
+    autoload :Hook,   "jekyll/assets/hook"
+    autoload :Cached, "jekyll/assets/cached"
+    autoload :Config, "jekyll/assets/config"
+    autoload :Logger, "jekyll/assets/logger"
+    autoload :Liquid, "jekyll/assets/liquid"
+    autoload :Env,    "jekyll/assets/env"
+
+    require "jekyll/assets/hooks"
+    require "jekyll/assets/addons"
   end
 end

data/lib/jekyll/assets/addons.rb

@@ -2,9 +2,10 @@
 # Copyright: 2012-2015 - MIT License
 # Encoding: utf-8
 
-require_relative "addons/compass"
-require_relative "addons/bootstrap"
-require_relative "addons/autoprefixer"
-require_relative "addons/proxies/magick"
-require_relative "addons/font_awesome"
-require_relative "addons/js_es6"
+require "jekyll/assets/addons/compass"
+require "jekyll/assets/addons/bootstrap"
+require "jekyll/assets/addons/autoprefixer"
+require "jekyll/assets/addons/processors/liquid"
+require "jekyll/assets/addons/proxies/magick"
+require "jekyll/assets/addons/font_awesome"
+require "jekyll/assets/addons/js_es6"

data/lib/jekyll/assets/addons/processors/liquid.rb

@@ -0,0 +1,31 @@
+module Jekyll
+  module Assets
+    module Addons
+      module Processors
+        class Liquid < Tilt::Template
+          PROCESSING_FOR = %W(text/css text/sass text/less application/javascript
+            text/scss text/coffeescript text/javascript).freeze
+          def prepare
+            #
+          end
+
+          # Render the file with the sites current context, anything you
+          # can do in a normal liquid file with Jekyll, you can do here inc,
+          # accessing the entirety of your posts and pages, though I don't
+          # know why you would want to, and I ain't judging you.
+
+          def evaluate(scope, _, jekyll = scope.environment.jekyll, &_block)
+            jekyll.liquid_renderer.file(@file).parse(data).render!(jekyll.site_payload, :registers => {
+              :site => jekyll
+            })
+          end
+        end
+      end
+    end
+  end
+end
+
+# There might be a few missing, if there is please do let me know.
+Jekyll::Assets::Addons::Processors::Liquid::PROCESSING_FOR.each do |val|
+  Sprockets.register_preprocessor val, Jekyll::Assets::Addons::Processors::Liquid
+end

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

@@ -9,7 +9,9 @@ try_require "mini_magick" do
       @two-fourths @three-fourths)
 
   Jekyll::Assets::Env.liquid_proxies.add :magick, :img, *(args + presets) do
-    Presets, Args = presets, args
+    PRESETS = presets
+    ARGS = args
+
     class DoubleResizeError < RuntimeError
       def initialize
         "Both resize and @*x provided, this is not supported."
@@ -54,14 +56,14 @@ try_require "mini_magick" do
 
     private
     def preset?
-      (@opts.keys - Args.map(&:to_sym)).any?
+      (@opts.keys - ARGS.map(&:to_sym)).any?
     end
 
     #
 
     private
     def magick_quality(img)
-      if @opts.has_key?(:quality)
+      if @opts.key?(:quality)
         then img.quality @opts[:quality]
       end
     end
@@ -70,8 +72,8 @@ try_require "mini_magick" do
 
     private
     def magick_resize(img)
-      raise DoubleResizeError if @opts.has_key?(:resize) && preset?
-      if @opts.has_key?(:resize)
+      raise DoubleResizeError if @opts.key?(:resize) && preset?
+      if @opts.key?(:resize)
         then img.resize @opts[:resize]
       end
     end
@@ -80,7 +82,7 @@ try_require "mini_magick" do
 
     private
     def magick_rotate(img)
-      if @opts.has_key?(:rotate)
+      if @opts.key?(:rotate)
         then img.rotate @opts[:rotate]
       end
     end
@@ -89,7 +91,7 @@ try_require "mini_magick" do
 
     private
     def magick_flip(img)
-      if @opts.has_key?(:flip)
+      if @opts.key?(:flip)
         then img.flip @opts[:flip]
       end
     end
@@ -98,7 +100,7 @@ try_require "mini_magick" do
 
     private
     def magick_crop(img)
-      if @opts.has_key?(:crop)
+      if @opts.key?(:crop)
         then img.crop @opts[:crop]
       end
     end

data/lib/jekyll/assets/config.rb

@@ -9,7 +9,7 @@ module Jekyll
         _assets/css _assets/stylesheets
         _assets/images _assets/img _assets/fonts
         _assets/javascripts _assets/js
-      )
+      ).freeze
 
       Development = {
         "skip_baseurl_with_cdn" => false,
@@ -27,7 +27,7 @@ module Jekyll
           "automatic_img_alt"  => true,
           "automatic_img_size" => true
         }
-      }
+      }.freeze
 
       #
 
@@ -36,16 +36,19 @@ module Jekyll
         "compress"  => {
           "css"     => true,
           "js"      => true
-        },
-      })
+        }
+      }).freeze
 
       #
 
       def self.merge_sources(jekyll, config)
-        return if config["sources"] && config["sources"].grep(/\A\s*_assets\/?\s*\Z/).size > 0
-        config["sources"] = (DefaultSources + (config["sources"] ||= [])).map do |val|
+        config["sources"] ||= []
+        return if config["sources"].grep(/\A\s*_assets\/?\s*\Z/).size > 0
+        sources = DefaultSources + config["sources"].to_a
+
+        config["sources"] = Set.new(sources.map do |val|
           jekyll.in_source_dir(val)
-        end
+        end)
       end
 
       #
@@ -57,7 +60,7 @@ module Jekyll
       #
 
       def self.merge(new_hash, old_hash = defaults)
-        old_hash.merge(new_hash) do |key, old_val, new_val|
+        old_hash.merge(new_hash) do |_, old_val, new_val|
           old_val.is_a?(Hash) && new_val.is_a?(Hash) ? merge(new_val, old_val) : new_val
         end
       end

data/lib/jekyll/assets/env.rb

@@ -10,12 +10,21 @@ module Jekyll
       class << self
         attr_accessor :past
         def liquid_proxies
-          return Liquid::Tag::Proxies
+          Liquid::Tag::Proxies
         end
       end
 
       #
 
+      def excludes
+        excludes = Set.new
+        excludes << strip_path(in_cache_dir)
+        jekyll.sprockets.asset_config["sources"].each { |path| excludes << strip_path(path) }
+        excludes
+      end
+
+      #
+
       def all_unparsed_assets
         @unparsed_assets ||= logical_paths.select do |(_, val)|
           val.start_with?(jekyll.in_source_dir)
@@ -25,9 +34,8 @@ module Jekyll
       #
 
       def to_liquid_payload
-        jekyll.sprockets.all_unparsed_assets.inject({}) do |hsh, (key, val)|
-          hsh[key] = Jekyll::Assets::Liquid::Drop.new(val, jekyll)
-        hsh
+        jekyll.sprockets.all_unparsed_assets.each_with_object({}) do |(key, val), hash|
+          hash[key] = Jekyll::Assets::Liquid::Drop.new(val, jekyll)
         end
       end
 
@@ -35,19 +43,19 @@ module Jekyll
 
       def initialize(path, jekyll = nil)
         jekyll, path = path, nil if path.is_a?(Jekyll::Site)
-        @used, @jekyll = Set.new, jekyll
+        @jekyll = jekyll
+        @used = Set.new
 
         path ? super(path) : super()
         Hook.trigger :env, :init do |hook|
-          hook.arity > 0 || 0 > hook.arity ? hook.call(self) : \
-            instance_eval(&hook)
+          hook.arity > 0 || 0 > hook.arity ? hook.call(self) : instance_eval(&hook)
         end
       end
 
       #
 
       def liquid_proxies
-        return self.class.liquid_proxies
+        self.class.liquid_proxies
       end
 
       # Make sure a path falls withint our cache dir.
@@ -76,7 +84,7 @@ module Jekyll
       #
 
       def cdn?
-        !dev? && asset_config.has_key?("cdn") && \
+        !dev? && asset_config.key?("cdn") && \
           asset_config["cdn"]
       end
 
@@ -101,8 +109,8 @@ module Jekyll
       #
 
       def compress?(what)
-        !!asset_config["compress"]. \
-          fetch(what, false)
+        !!asset_config["compress"] \
+          .fetch(what, false)
       end
 
       #
@@ -122,14 +130,15 @@ module Jekyll
       # the baseurl and asset prefix.  All of these can be adjusted.
 
       def prefix_path(path = nil)
-        _baseurl = baseurl
         cdn = asset_config["cdn"]
-        _path = []
+        base_url = baseurl
+
+        path_ = []
+        path_ << base_url unless base_url.empty?
+        path_ << path unless path.nil?
 
-        _path << _baseurl unless _baseurl.empty?
-        _path << path unless path.nil?
-        cdn? && cdn ? File.join(cdn, *_path).chomp("/") : \
-          File.join(*_path).chomp("/")
+        url = cdn && cdn?? File.join(cdn, *path_) : File.join(*path_)
+        url.chomp("/")
       end
 
       #
@@ -151,6 +160,13 @@ module Jekyll
 
       #
 
+      private
+      def strip_path(path)
+        path.sub(jekyll.in_source_dir("/"), "")
+      end
+
+      #
+
       private
       def as_path(v)
         path = digest?? v.digest_path : v.logical_path