jekyll-assets 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 125f0a58023e5e41de8eb1fbfb21d52d81cc43ec
-  data.tar.gz: 9214d2bf1839b62ea94ec23c3803ab768b019304
+  metadata.gz: cd81b41822b8b54ab4cc4d1a78ae99bff7a322b3
+  data.tar.gz: edeadf3fc3490d45c86f8d1147cc632ad5f40367
 SHA512:
-  metadata.gz: 6d5c1ab77cc292c5630a0cc3e0d518451c5da307ea4ddb83905bdae472d43585caaf3b5f01d6c5f60e363d585490e2ff2b676122b47ce750eb04979cbae1d833
-  data.tar.gz: a6648f8282532c1ab4b64ef7be5809ac89dad5558cb1826ba8260011b14232c28b97a73bda4d052204f6d831c267351183d6dd91da1da22425b5819a2f838504
+  metadata.gz: 9a1f4e0ad128cffc1733260886fbe06439b65e38eda2ef66fef350f25262387c39d546b5de4b8a15e6ea0a812050e82ec2bc1814fd0fb6b1be031440aee1332c
+  data.tar.gz: 02ee95d9b922f750887a49095e6e56ea1c129f9dc29bc7493ca659a5dd95b33089ec3a0f84e1b8e1dae6ab7e44a6a4e26be5a5e3ad1aa5e9868bfebe309d048d

data/README.md

@@ -237,6 +237,37 @@ assets:
 [amazon-s3]: http://aws.amazon.com/s3
 
 
+### Images size (dimension) auto-guessing
+
+The image helper accepts options param (in square brackets) with `autosize`
+switch. If given, then image dimension will be calculated and
+apropriate attributes set:
+
+``` html
+{% image logo.png alt="Logo" [autosize] %}
+
+<!-- assuming logo.png is 50x50, the above will render -->
+
+<img src="/assets/logo-68b329da9893e34099c7d8ad5cb9c940.png" alt="Logo"
+     width="50" height="50">
+```
+
+You can also globally enable `autosize` in config (see `autosize` config option
+below). In this case, `image` tag will alway render dimension attributes unless
+you specify `no-autosize` switch. Assume you have `autosize` option enabled in
+config, then:
+
+``` html
+{% image logo.png [no-autosize] %}
+{% image logo.png %}
+
+<!-- assuming logo.png is 50x50, the above will render -->
+
+<img src="/assets/logo-68b329da9893e34099c7d8ad5cb9c940.png">
+<img src="/assets/logo-68b329da9893e34099c7d8ad5cb9c940.png"
+     width="50" height="50">
+```
+
 ### Custom Compressors
 
 Sprockets comes with good set of preconfigured compressors, but imagine you are
@@ -550,6 +581,12 @@ assets:
   #
   css_compressor: ~
   #
+  # Globally enables adding image width and height attributes to image tags.
+  # Does nothing if either width or height attribute already set.
+  # Disabled by default.
+  #
+  autosize: false
+  #
   # Sets cachebusting policy for generated assets.
   #
   # Possible variants:

data/jekyll-assets.gemspec

@@ -22,11 +22,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "jekyll",    "~> 2.0"
-  spec.add_dependency "sprockets", "~> 2.10"
+  spec.add_dependency "jekyll",     "~> 2.0"
+  spec.add_dependency "sass",       "~> 3.2"
+  spec.add_dependency "fastimage",  "~> 1.6"
+  spec.add_dependency "sprockets",  "~> 2.10"
   spec.add_dependency "sprockets-sass"
   spec.add_dependency "sprockets-helpers"
-  spec.add_dependency "sass", "~> 3.2"
 
   spec.add_development_dependency "bundler", "~> 1.6"
 end

data/lib/jekyll/assets_plugin/configuration.rb

@@ -5,17 +5,18 @@ module Jekyll
   module AssetsPlugin
     class Configuration
       DEFAULTS = {
-        :dirname        => "assets",
-        :sources        => %w(_assets/javascripts
-                              _assets/stylesheets
-                              _assets/images),
-        :js_compressor  => nil,
-        :css_compressor => nil,
-        :cachebust      => :hard,
-        :cache          => false,
-        :gzip           => %w(text/css application/javascript),
-        :debug          => false,
-        :version        => 1
+        :dirname         => "assets",
+        :sources         => %w(_assets/javascripts
+                               _assets/stylesheets
+                               _assets/images),
+        :js_compressor   => nil,
+        :css_compressor  => nil,
+        :autosize        => false,
+        :cachebust       => :hard,
+        :cache           => false,
+        :gzip            => %w(text/css application/javascript),
+        :debug           => false,
+        :version         => 1
       }.freeze
 
       def initialize(config = {})

data/lib/jekyll/assets_plugin/renderer.rb

@@ -1,24 +1,34 @@
+# 3rd-party
+require "fastimage"
+
 module Jekyll
   module AssetsPlugin
     class Renderer
       STYLESHEET = '<link rel="stylesheet" href="%{path}"%{attrs}>'
       JAVASCRIPT = '<script src="%{path}"%{attrs}></script>'
       IMAGE      = '<img src="%{path}"%{attrs}>'
+      IMAGESIZE  = 'width="%d" height="%d"'
 
       URI_RE     = %r{^(?:[^:]+:)?//(?:[^./]+\.)+[^./]+/}
-      PARAMS_RE  = / (?: "(?<path>[^"]+)" | '(?<path>[^']+)' | (?<path>[^ ]+) )
-                     (?<attrs>.*)
+      PARAMS_RE  = / ^
+                     \s*
+                     (?: "(?<path>[^"]+)" | '(?<path>[^']+)' | (?<path>[^ ]+) )
+                     (?<attrs>.*?)
+                     (?: \[(?<options>.*)\] )?
+                     \s*
+                     $
                    /x
 
-      attr_reader :site, :path, :attrs
+      attr_reader :site, :path, :attrs, :options
 
       def initialize(context, params)
         @site = context.registers[:site]
 
         match = params.strip.match PARAMS_RE
 
-        @path  = match["path"]
-        @attrs = match["attrs"]
+        @path     = match["path"]
+        @attrs    = match["attrs"]
+        @options  = match["options"].to_s.split(",")
       end
 
       def render_asset
@@ -40,6 +50,7 @@ module Jekyll
       end
 
       def render_image
+        autosize!
         render_tag IMAGE
       end
 
@@ -58,6 +69,26 @@ module Jekyll
         tags.join "\n"
       end
 
+      def autosize!
+        return unless autosize?
+
+        if remote?
+          width, height = FastImage.size(path)
+        else
+          width, height = FastImage.size(site.assets[path].pathname)
+        end
+
+        @attrs = %(#{@attrs} width="#{width}" height="#{height}").strip
+      end
+
+      def autosize?
+        if site.assets_config.autosize
+          !options.include? "no-autosize"
+        else
+          options.include? "autosize"
+        end
+      end
+
       def remote?
         path =~ URI_RE
       end

data/lib/jekyll/assets_plugin/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module AssetsPlugin
-    VERSION = "0.11.0"
+    VERSION = "0.12.0"
   end
 end

data/spec/lib/jekyll/assets_plugin/configuration_spec.rb

@@ -34,6 +34,11 @@ RSpec.describe Jekyll::AssetsPlugin::Configuration do
       it { is_expected.to be_nil }
     end
 
+    context "autosize" do
+      subject { config.autosize }
+      it { is_expected.to be false }
+    end
+
     context "gzip" do
       subject { config.gzip }
       it { is_expected.to match_array %w(text/css application/javascript) }
@@ -41,7 +46,7 @@ RSpec.describe Jekyll::AssetsPlugin::Configuration do
 
     context "cache_assets?" do
       subject { config.cache_assets? }
-      it { is_expected.to eq false }
+      it { is_expected.to be false }
     end
 
     context "cache_path" do
@@ -51,7 +56,7 @@ RSpec.describe Jekyll::AssetsPlugin::Configuration do
 
     context "debug" do
       subject { config.debug }
-      it { is_expected.to eq false }
+      it { is_expected.to be false }
     end
 
   end

data/spec/lib/jekyll/assets_plugin/renderer_spec.rb

@@ -94,6 +94,20 @@ RSpec.describe Jekyll::AssetsPlugin::Renderer do
     end
   end
 
+  describe "#options" do
+    subject { renderer.options }
+
+    context "with no options given" do
+      it { is_expected.to be_an Array }
+      it { is_expected.to be_empty }
+    end
+
+    context "with options given" do
+      let(:params) { "app [foo,bar]" }
+      it { is_expected.to eq %w(foo bar) }
+    end
+  end
+
   describe "#render_javascript" do
     subject { renderer.render_javascript }
 
@@ -197,6 +211,31 @@ RSpec.describe Jekyll::AssetsPlugin::Renderer do
         it { is_expected.to include "data-test=true" }
       end
     end
+
+    context "with [autosize] helper option" do
+      let(:params) { "noise.png [autosize]" }
+      it { is_expected.to include 'width="100" height="100"' }
+    end
+
+    context "with [no-autosize] helper option" do
+      let(:params) { "noise.png [no-autosize]" }
+      it { is_expected.to_not include 'width="100" height="100"' }
+    end
+
+    context "with autosize enabled in config" do
+      let(:assets_config) { Hash[:autosize, true] }
+      it { is_expected.to include 'width="100" height="100"' }
+
+      context "and [autosize] helper option given" do
+        let(:params) { "noise.png [autosize]" }
+        it { is_expected.to include 'width="100" height="100"' }
+      end
+
+      context "and [no-autosize] helper option given" do
+        let(:params) { "noise.png [no-autosize]" }
+        it { is_expected.to_not include 'width="100" height="100"' }
+      end
+    end
   end
 
   describe "#render_asset" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-assets
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Aleksey V Zapparov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-09 00:00:00.000000000 Z
+date: 2014-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -25,35 +25,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: sprockets
+  name: sass
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: sprockets-sass
+  name: fastimage
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: sprockets-helpers
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+- !ruby/object:Gem::Dependency
+  name: sprockets-sass
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,19 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sass
+  name: sprockets-helpers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -201,7 +215,7 @@ rubyforge_project:
 rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
-summary: jekyll-assets-0.11.0
+summary: jekyll-assets-0.12.0
 test_files:
 - spec/fixtures/.gitignore
 - spec/fixtures/_assets/alert.js
@@ -242,4 +256,3 @@ test_files:
 - spec/lib/jekyll/assets_plugin/tag_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixtures_helpers.rb
-has_rdoc: