jekyll-assets 2.2.8 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de1aafb18ffbc5dd93d6cc939c6aee6ccb9ff656
-  data.tar.gz: 60f99c86d63f7ee293bbd9a92eb83c917c740705
+  metadata.gz: e63acc3be463a9dcc0706d44e684dda19fcccd93
+  data.tar.gz: af8f2ecd22edbe9df64771322582e6de584a9a1f
 SHA512:
-  metadata.gz: 0d49e408b902b4c23f961d175024bddb7d19cca7306d6337e85eebc5f78fd5796d8e59a246c18fd6bd7032dbd8ae980aeffe2f0c73c146ca5941faee8266af7f
-  data.tar.gz: 94c1f84f35918fbe1700083159ac974543ccad187d709408854d7247f720e621ae9d1ce8986da8f19a976944f7b2375c834c4876f0c5eceb8c3f5d856a815700
+  metadata.gz: 6287cef50ec4b2b1a2942f73588aa8ac63d5a7bb802de180ceb6fb48fd77e7c36cb66dffd13e7daf13e8ecb55042155eaaf8896db6eda583d8a9a0c1feaaa6fe
+  data.tar.gz: 7af1fd96801d3901e03fad0bf4fcae6bb7fabbd077d68971ad1f46470a6db5c6673edaa60a0315c9cff6e2bda69e866bf6ad977eda3a1cb8d66c6ce67ac22ae0

data/Gemfile

@@ -10,14 +10,15 @@ group :development do
 end
 
 group :test do
-  gem "codeclimate-test-reporter", :require => false
-  gem "rubocop", :github => "bbatsov/rubocop", :branch => :master, :require => false
   gem "luna-rubocop-formatters", :require => false
+  gem "codeclimate-test-reporter", :require => false
+  gem "rubocop", :require => false
 end
 
 gem "uglifier", :require => false
 gem "sprockets-es6", "~> 0.6", :require => false
-gem "autoprefixer-rails", "~> 6.0", :require => false
+gem "autoprefixer-rails", "~> 7.0", :require => false
+gem "jekyll", "#{ENV["JEKYLL_VERSION"]}" if ENV["JEKYLL_VERSION"]
 gem "font-awesome-sass", "~> 4.4", :require => false
 gem "bootstrap-sass", "~> 3.3", :require => false
 gem "mini_magick", "~> 4.2", :require => false

data/README.md

@@ -7,16 +7,17 @@
 [coverage]: https://codeclimate.com/github/jekyll/jekyll-assets/coverage
 [travis]: https://travis-ci.org/jekyll/jekyll-assets
 
-# Jekyll 3 Assets
+# Jekyll Assets
 
-Jekyll 3 assets is an asset pipeline using Sprockets 3 to build especially
-for Jekyll 3. It utilizes new features of both Sprockets and Jekyll to achieve
-a clean and extensible assets platform for Jekyll.
+Jekyll assets is an asset pipeline using Sprockets 3 to build specifically for Jekyll. It utilizes new features of both Sprockets and Jekyll to try and achieve a clean and extensible assets platform.
 
 ## Using Jekyll Assets with Jekyll
 
-Add `gem "jekyll-assets"` to your `Gemfile` and add `jekyll-assets`
-to your `_config.yml` like the following:
+```ruby
+group :plugins do
+  gem "jekyll-assets"
+end
+```
 
 ```yaml
 gems:
@@ -25,20 +26,11 @@ gems:
 
 ## Configuration
 
-A lot of our configuration transforms based on the `JEKYLL_ENV` variable
-set in your environment. Such as digesting and whether or not to enable the
-CDN. Some of them can be explicitly overridden but a few cannot right now.
-You should set your `JEKYLL_ENV=development` on your development
-machine and `JEKYLL_ENV=production` when building to push.
-
 ```yaml
 assets:
   compress:
     css: false | true | default - development: false, production: true
     js: false | true | default - development: false, production: true
-
-  #
-
   autowrite: true
   cache: false | directory | default: .asset-cache
   cache_type: memory | filesystem | default: filesystem
@@ -47,15 +39,9 @@ assets:
   skip_prefix_with_cdn: false
   prefix: "/assets"
   digest: true
-
-  #
-
   assets:
     - "*.png"
     - "bundle.css"
-
-  #
-
   sources:
     - _assets/css
     - _assets/images
@@ -64,43 +50,34 @@ assets:
     - _assets/fonts
     - _assets/img
     - _assets/js
-
-  #
-
   features:
     liquid: true | false | default: false
     integrity: true | false | default: false
+    # This will add height and width attributes for an img tag.
     automatic_img_size: true | false | n(fixnum): 2,4,6,8 | default: true
+    # This will add the digest path as an alt attribute for an img tag.
     automatic_img_alt : true | false | default: true
 ```
 
 ### Liquid Processing with your Jekyll context
 
-By default (whether `features.liquid` is true or false) we will process
-all files with the extension ".liquid", so if you give us ".scss.liquid"
+By default (whether `features.liquid` is `true` or `false`) we will process
+all files with the extension `.liquid`, so if you give us `.scss.liquid`
 we will parse the liquid and then we will parse the SCSS and finally
-output your ".css" file.
-
-When `features.liquid` is set to true, we will process ***ALL*** files
-through Liquid, regardless of whether they have the ".liquid" extension.
-Use this at your own risk.
+output your `.css` file. When `features.liquid` is set to `true`, we will process ***ALL*** files through Liquid, regardless of whether they have the `.liquid` extension. ***Use this at your own risk. As it can lead to some bugs, some bad output, and even some ugly edge cases... especially with things like Handlebars.***
 
 ### 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.
+folder to your `exclude` list in Jekyll, or you will generate over and over
+and over again, `.` folders are not ignored by default as of Jekyll 3.x, so you should take heed of ignoring your own folders.
 
 ### Sources
 
 The listed resources in the example are all defaults. It should be noted
 that we append your sources instead of replace our resources with yours. So
 if you add `_assets/folder` then we will append that to our sources and
-both will work.
-
-***NOTE: if you use our `_assets` base folder container as a base folder for
-your sprockets, we will not append our sources, we will only use that
-folder as the sole source (base folder.)***
+both will work. ***NOTE: if you use our `_assets` base folder container as a base folder for your Sprockets, we will not append our sources, we will only use that folder as the sole source (base folder.)***
 
 ### Digesting
 
@@ -115,9 +92,52 @@ folder as the sole source (base folder.)***
 * Disable compression by default in development.
 * Enable by default in production.
 
+## Generating CSS with Jekyll Assets
+
+The following section shows how to get started generating CSS using Jekyll
+Assets. It applies to a newly generated Jekyll site, however this should helpanyone who has a Jekyll site. It should also be applicable for other types of assets.
+
+### Create the `_assets/css` directory
+
+The default [Jekyll Assets configuration](#configuration) expects to find all the assets in directories under `_assets`. Create a directory for the CSS:
+
+```bash
+mkdir -p _assets/css
+```
+
+### Move the CSS files to the new `_assets/css` directory
+
+Jekyll comes with a `css` directory containing a `main.css` file and then a `_sass` directory with a few Sass imports. Move all of that to the `_assets/css` directory.
+
+```bash
+mv css/main.css _assets/css
+mv _sass/* _assets/css
+```
+
+### Remove Jekyll front matter
+
+Jekyll includes some empty [front matter](https://jekyllrb.com/docs/frontmatter/) in `main.css`. Remove that as Sprockets will not understand it.
+
+### Update the layout
+
+The layout will no longer be pointing to the correct `main.css` file. Jekyll Assets supplies [liquid tags](#tags) to generate the correct HTML for these assets. Open `_includes/head.html` and replace the `<link>` to the CSS with:
+
+```liquid
+{% css main %}
+```
+
+Start up your local Jekyll server and if everything is correct, your site will be serving CSS via Sprockets. Read on for more information on how to customize your Jekyll Assets setup.
+
 ## Addons
 
-* CSS Auto Prefixer - add "autoprefixer-rails" to your Gemfile and configure target browsers in `_config.yml`:
+* Font Awesome `gem "font-awesome-sass"`
+
+  ```scss
+    @import 'font-awesome-sprockets'
+    @import 'font-awesome'
+  ```
+
+* CSS Auto-Prefixing `gem "autoprefixer-rails"`
 
     ```yml
     assets:
@@ -126,18 +146,19 @@ folder as the sole source (base folder.)***
           - "last 2 versions"
           - "IE > 9"
     ```
-    
-* ES6 Transpiler (through Babel) - add "sprockets-es6" to your Gemfile — any `.es6` files (e.g. `main.js.es6`) will be transpiled
-* Bootstrap - add "bootstrap-sass" to your Gemfile, and `@import 'boostrap-sprockets'; @import 'bootstrap'`
-* Font Awesome - add "font-awesome-sass" to your Gemfile, and `@import 'font-awesome-sprockets'; @import 'font-awesome'`
-* Image Magick - add "mini_magick" to your Gemfile, only works with `img`, `image`.
-* LESS - add "less" 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.***
+* Bootstrap `gem "bootstrap-sass"`
+
+  ```scss
+    @import 'bootstrap-sprockets'
+    @import 'bootstrap'
+  ```
 
-## Bower Components
+* ES6 `gem "sprockets-es6"`
+* Image Magick `gem "mini_magick"`
+* LESS `gem "less"`
+
+## Bower
 
 Modify your `.bowerrc` file and add:
 
@@ -238,6 +259,7 @@ The current list of available accessors:
 * `basename`
 * `width`
 * `height`
+* `digest_path`
 
 If you would like more, please feel free to add a pull request, at this
 time we will reject all pull requests that wish to add any digested paths as
@@ -279,6 +301,46 @@ Jekyll::Assets::Hook.register :env, :init do
 end
 ```
 
+## Combining Multiple Scripts / Stylesheets
+
+To minimize the number of HTTP requests, combine stylesheets and scripts into one file.
+
+### SCSS
+
+Use the `@import` statement. Given a list of files in `_assets/css`:
+
+- `main.scss`
+- `_responsive.scss`
+- `_fonts.scss`
+
+...have this in your `main.scss`:
+
+```scss
+@import 'responsive';
+@import 'fonts';
+// ...
+```
+
+Include the `main` stylesheet in your HTML: `{% css main %}`.
+
+### JavaScript
+
+Use `//= require` to import and bundle component scripts into one file. More from [#241](https://github.com/jekyll/jekyll-assets/issues/241).
+
+Given a list of files in `_assets/js`:
+
+- `main.js`
+- `jquery.js`
+
+...have this in your `main.js`:
+
+```js
+//= require jquery
+// ...
+```
+
+Include the `main` script in your HTML: `{% js main %}`.
+
 ## Sass Helpers
 
 ***Our currently supported helpers are:***
@@ -295,6 +357,9 @@ end
 **NOTE: You'll need the `mini_magick` gem installed for these to work**
 To install `mini_magick`, add `gem "mini_magick"` to your `Gemfile`
 
+See the [MiniMagick docs](https://github.com/minimagick/minimagick#usage)
+to get an idea what `<value>` can be.
+
 * `magick:resize:<value>`
 * `magick:format:<value>`
 * `magick:quality:<value>`

data/lib/jekyll/assets/env.rb

@@ -111,6 +111,12 @@ module Jekyll
         path ? super(path) : super()
         @jekyll = jekyll
 
+        # Analagous to Jekyll::Site @source and @destination paths
+        @cache_path = asset_config.fetch("cache", ".asset-cache")
+        if File.exist?(cache_path_in_source_dir = jekyll.in_source_dir(@cache_path))
+          @cache_path = cache_path_in_source_dir
+        end
+
         # XXX: In 3.0, we need to drop anything to do with instance eval,
         #   and imply pass the instance, this will make our code cleaner.
 
@@ -142,9 +148,9 @@ module Jekyll
       # @return [Pathname/Pathutil]
       # --
       def in_cache_dir(*paths)
-        jekyll.in_source_dir(asset_config["cache"] || ".asset-cache",
-          *paths
-        )
+        paths.reduce(@cache_path) do |base, path|
+          Jekyll.sanitized_path(base, path)
+        end
       end
 
       # --

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

@@ -23,7 +23,7 @@ Jekyll::Assets::Hook.register :env, :init do
     end
 
   else
-    Jekyll.logger.info "", "Caching is disabled by configuration. " \
+    Jekyll.logger.info "", "Asset caching is disabled by configuration. " \
       "However, if you're using proxies, a cache might still be created."
   end
 end

data/lib/jekyll/assets/liquid/context.rb

@@ -0,0 +1,19 @@
+# Frozen-string-literal: true
+# Copyright: 2012 - 2017 - MIT License
+# Encoding: utf-8
+
+module Jekyll
+  module Assets
+    module Liquid
+      if defined?(::Liquid::ParseContext)
+        class ParseContext < ::Liquid::ParseContext
+          #
+        end
+      else
+        class ParseContext < Array
+          #
+        end
+      end
+    end
+  end
+end

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

@@ -1,8 +1,6 @@
-# ----------------------------------------------------------------------------
 # Frozen-string-literal: true
 # Copyright: 2012 - 2016 - MIT License
 # Encoding: utf-8
-# ----------------------------------------------------------------------------
 
 require "fastimage"
 
@@ -57,7 +55,7 @@ module Jekyll
 
         def dimensions
           if image?
-            @dimensions ||= FastImage.new(asset.filename).size
+            @dimensions ||= FastImage.size(asset.filename.to_s)
           end
         end
 

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

@@ -9,14 +9,14 @@ module Jekyll
     module Liquid
       module Filters
         ACCEPTABLE_FILTERS = [:css, :img, :asset_path, :stylesheet,
-          :javascript, :style, :img, :js]
+          :javascript, :style, :image, :js]
 
         # --
         # The base filters.
         # --
         ACCEPTABLE_FILTERS.each do |val|
           define_method val do |path, args = ""|
-            Tag.send(:new, val, "#{path} #{args}", "").render(
+            Tag.send(:new, val, "#{path} #{args}", ParseContext.new).render(
               @context
             )
           end
@@ -28,7 +28,7 @@ module Jekyll
         # --
         def jekyll_asset_multi(assets)
           return Shellwords.shellsplit(assets).map { |s| s.split(":", 2) }.map do |tag, arguments|
-            Tag.send(:new, tag, arguments, "").render(
+            Tag.send(:new, tag, arguments, ParseContext.new).render(
               @context
             )
           end \

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

@@ -55,7 +55,7 @@ module Jekyll
               resize_image = @env.asset_config["features"]["automatic_img_size"]
 
               if !@env || resize_image
-                dimensions = FastImage.new(@asset.filename).size
+                dimensions = FastImage.size(@asset.filename.to_s)
                 return unless dimensions
                 @args[:html] ||= {}
 

data/lib/jekyll/assets/liquid/tag/proxied_asset.rb

@@ -16,18 +16,21 @@ module Jekyll
 
           # ------------------------------------------------------------------
 
+          attr_reader :content_type
+
           def_delegator :@asset, :liquid_tags
-          def_delegator :@asset, :filename, :source_filename
-          def_delegator :@asset, :content_type
+          def_delegator :@asset, :source_filename
           def_delegator :@asset, :mtime
 
           # ------------------------------------------------------------------
 
           def initialize(asset, args, env, tag)
             @env = env
-            @asset = asset
+            @asset = asset.dup
             @args = args
             @tag = tag
+            @path = Pathutil.new(asset.logical_path)
+            @content_type = asset.content_type
 
             cache_file
             proxy_file
@@ -59,13 +62,15 @@ module Jekyll
           # ------------------------------------------------------------------
 
           def source
-            File.binread(filename)
+            filename.binread
           end
 
           # ------------------------------------------------------------------
 
           def filename
-            env.in_cache_dir(digest_path)
+            Pathutil.new(
+              env.in_cache_dir(digest_path)
+            )
           end
 
           # ------------------------------------------------------------------
@@ -76,6 +81,15 @@ module Jekyll
             )
           end
 
+          # ------------------------------------------------------------------
+
+          def content_type=(type)
+            return if @content_type == type
+
+            @path = @path.sub_ext(_ext_for(type))
+            @content_type = type
+          end
+
           # ------------------------------------------------------------------
           # We always digest a proxied asset so it's uniq based on what
           # proxies you give us, it would be ignorant to treat it otherwise,
@@ -89,9 +103,23 @@ module Jekyll
           # ------------------------------------------------------------------
 
           def digest_path
-            name = asset.logical_path
-            ext  = File.extname(name)
-            "#{name.chomp(ext)}-#{digest}#{ext}"
+            "#{@path.sub_ext ""}-#{digest}#{@path.extname}"
+          end
+
+          # --------------------------------------------------------------------
+
+          private
+          def _mime_for(ext)
+            Sprockets.mime_exts[
+              ext
+            ]
+          end
+
+          # --------------------------------------------------------------------
+
+          private
+          def _ext_for(type)
+            Sprockets.mime_types[type][:extensions].first
           end
 
           # ------------------------------------------------------------------
@@ -100,21 +128,35 @@ module Jekyll
           def proxy_file
             unless cached?
               args.proxies.each do |key, val|
+                old_type = content_type
+                old_filename = filename
                 Proxies.get(key).first[:class].new(self, val, @args).process
+                old_filename.rm if old_type != content_type
               end
             end
           end
 
           # ------------------------------------------------------------------
 
+          private
+          def find_cached
+            glob = filename.dirname.glob(filename.basename.sub_ext('.*'))
+            @_cached = filename.dirname.directory? && !glob.first.nil?
+            if @_cached
+              self.content_type = _mime_for(File.extname(glob.first))
+            end
+
+            @_cached
+          end
+
+          # ------------------------------------------------------------------
+
           private
           def cache_file
-            @_cached = File.file?(filename)
-            return @_cached if @_cached
+            return true if @_cached || find_cached
 
-            dir = File.dirname(filename)
-            FileUtils.mkdir_p dir unless dir == env.in_cache_dir
-            FileUtils.cp asset.filename, filename
+            filename.dirname.mkdir_p
+            Pathutil.new(asset.filename).cp filename
             true
           end
         end

data/lib/jekyll/assets/manifest.rb

@@ -2,6 +2,8 @@
 # Copyright: 2012 - 2016 - MIT License
 # Encoding: utf-8
 
+require 'concurrent/future'
+
 module Jekyll
   module Assets
     class Manifest < Sprockets::Manifest

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

@@ -5,7 +5,7 @@
 # ----------------------------------------------------------------------------
 
 try_require "mini_magick" do
-  args = %W(resize quality rotate crop flip gravity)
+  args = %W(resize quality rotate crop flip format gravity)
   presets = %W(@2x @4x @1/2 @1/3 @2/3 @1/4 @2/4 @3/4
     @double @quadruple @half @one-third @two-thirds @one-fourth
       @two-fourths @three-fourths)
@@ -26,7 +26,6 @@ try_require "mini_magick" do
     # ------------------------------------------------------------------------
 
     def initialize(asset, opts, args)
-      @path = asset.filename
       @opts = opts
       @asset = asset
       @args = args
@@ -35,7 +34,7 @@ try_require "mini_magick" do
     # ------------------------------------------------------------------------
 
     def process
-      img = MiniMagick::Image.open(@path)
+      img = MiniMagick::Image.open(@asset.filename)
       methods = private_methods(true).select { |v| v.to_s.start_with?("magick_") }
       if img.respond_to?(:combine_options)
         then img.combine_options do |cmd|
@@ -55,7 +54,7 @@ try_require "mini_magick" do
       end
 
       img.write(
-        @path
+        @asset.filename
       )
     ensure
       img.destroy!
@@ -116,6 +115,15 @@ try_require "mini_magick" do
 
     # ------------------------------------------------------------------------
 
+    private
+    def magick_format(img, _)
+      if @opts.key?(:format)
+        img.format @opts[:format]
+        @asset.content_type = img.mime_type
+      end
+    end
+    # ------------------------------------------------------------------------
+
     private
     def magick_crop(_, cmd)
       if @opts.key?(:crop)

data/lib/jekyll/assets/version.rb

@@ -4,6 +4,6 @@
 
 module Jekyll
   module Assets
-    VERSION="2.2.8"
+    VERSION="2.3.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-assets
 version: !ruby/object:Gem::Version
-  version: 2.2.8
+  version: 2.3.0
 platform: ruby
 authors:
 - Jordon Bedwell
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-05 00:00:00.000000000 Z
+date: 2017-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -21,7 +21,7 @@ dependencies:
         version: '1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -31,7 +31,7 @@ dependencies:
         version: '1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: sprockets
   requirement: !ruby/object:Gem::Requirement
@@ -41,7 +41,7 @@ dependencies:
         version: '3.3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -51,7 +51,7 @@ dependencies:
         version: '3.3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: fastimage
   requirement: !ruby/object:Gem::Requirement
@@ -112,14 +112,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -200,6 +214,7 @@ files:
 - lib/jekyll/assets/hooks/sources.rb
 - lib/jekyll/assets/hooks/sprockets.rb
 - lib/jekyll/assets/hooks/version.rb
+- lib/jekyll/assets/liquid/context.rb
 - lib/jekyll/assets/liquid/drop.rb
 - lib/jekyll/assets/liquid/filters.rb
 - lib/jekyll/assets/liquid/tag.rb
@@ -239,7 +254,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Assets for Jekyll