jekyll-responsive_image 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8222a5289fe9566ef0395c25a7491215e9fd3f55
-  data.tar.gz: 2648869efed1723fb8b6b209e62b878dec1bb406
+  metadata.gz: 26a3868d77490e6edcf5c932cffb129cf05cdab6
+  data.tar.gz: d3b7bcc0c173b2938cf7486dd45967a5a0978f9a
 SHA512:
-  metadata.gz: 04aab057ea359cd2c98365acb89dbae99042d1a74c95cf0e992b201f426ecee00f33d33adb0d1bc4736aff81a716520de28a390b22182c201f525e7292768817
-  data.tar.gz: 36a5d066c75ef897cdb4ccbea51932211e37ef6dc379a612ac16584bdb2da08422b6eff7136ad2a5435a9e0ed58a09f95f003f9bcf1d211d35b4f6986d9c1cd9
+  metadata.gz: 195fda571ae489df9febc69e482b4b7ae4b3d1cc65289d4c97f70c5e2bcfe43c850cc921d94f21e1c2fd4c53d22970820ddba3586ab346e6c0268a14853e2500
+  data.tar.gz: 6f4ef84402e49e4e0f2b2278aef28d97ccebfb9f7b7e484ea9f522e67c3b49e84385dde8e6c5ce31a804fbd63f1c4afd166aa2517b54f3335bbd81b4f2c5e3d5

data/.travis.yml

@@ -1,9 +1,11 @@
+sudo: false
 language: ruby
 bundler_args: --without debug
+before_script: bundle exec jekyll --version
 script: bundle exec rake features_with_coveralls
 rvm:
-  - 2.2.0
-  - 2.1.0
-  - 2.0.0
-  - 1.9.3
-  - rbx-2
+  - 2.2
+  - 2.1
+  - 2.0
+  - 1.9
+  - rbx

data/README.md

@@ -45,11 +45,17 @@ responsive_image:
     - width: 1400
       quality: 90
 
+  # [Optional, Default: assets]
+  # The base directory where assets are stored. This is used to determine the
+  # `dirname` value in `output_path_format` below.
+  base_path: assets
+
   # [Optional, Default: assets/resized/%{filename}-%{width}x%{height}.%{extension}]
   # The template used when generating filenames for resized images. Must be a
   # relative path.
   #
   # Parameters available are:
+  #   %{dirname}     Directory of the file relative to `base_path` (assets/sub/dir/some-file.jpg => sub/dir)
   #   %{basename}    Basename of the file (assets/some-file.jpg => some-file.jpg)
   #   %{filename}    Basename without the extension (assets/some-file.jpg => some-file)
   #   %{extension}   Extension of the file (assets/some-file.jpg => jpg)
@@ -83,7 +89,7 @@ Any extra attributes will be passed straight to the template as variables.
 
 You can use Liquid variables as attributes with the `responsive_image_block` tag. This tag works in exactly the same way as the `responsive_image` tag, but is implemented as a block tag to allow for more complex logic.
 
-> **Important!** The attributes in the `responsive_image_block` tag are parsed as YAML, so whitespace and indentation are important!
+> **Important!** The attributes in the `responsive_image_block` tag are parsed as YAML, so whitespace and indentation are significant!
 
 ```twig
 {% assign path = 'assets/test.png' %}
@@ -127,7 +133,7 @@ You will need to create a template in order to use the `responsive_image` tag. B
 
 #### Responsive images using [Imager.js](https://github.com/BBC-News/Imager.js/)
 
-> This template assumes an `output_path_format` of `assets/resized/%{width}/%{basename}`
+> **Note:** This template assumes an `output_path_format` of `assets/resized/%{width}/%{basename}`
 
 ```twig
 {% assign smallest = resized | sort: 'width' | first %}
@@ -162,11 +168,12 @@ The following variables are available in the template:
 
 Image objects (like `original` and each object in `resized`) contain the following properties:
 
-| Variable    | Type    | Description                                                             |
-|-------------|---------|-------------------------------------------------------------------------|
-| `path`      | String  | The path to the image.                                                  |
-| `width`     | Integer | The width of the image.                                                 |
-| `height`    | Integer | The height of the image.                                                |
-| `basename`  | String  | Basename of the file (`assets/some-file.jpg` => `some-file.jpg`).       |
-| `filename`  | String  | Basename without the extension (`assets/some-file.jpg` => `some-file`). |
-| `extension` | String  | Extension of the file (`assets/some-file.jpg` => `jpg`).                |
+| Variable    | Type    | Description                                                                                  |
+|-------------|---------|----------------------------------------------------------------------------------------------|
+| `path`      | String  | The path to the image.                                                                       |
+| `width`     | Integer | The width of the image.                                                                      |
+| `height`    | Integer | The height of the image.                                                                     |
+| `basename`  | String  | Basename of the file (`assets/some-file.jpg` => `some-file.jpg`).                            |
+| `dirname`   | String  | Directory of the file relative to `base_path` (`assets/sub/dir/some-file.jpg` => `sub/dir`). |
+| `filename`  | String  | Basename without the extension (`assets/some-file.jpg` => `some-file`).                      |
+| `extension` | String  | Extension of the file (`assets/some-file.jpg` => `jpg`).                                     |

data/features/image-generation.feature

@@ -0,0 +1,35 @@
+Feature: Responsive image generation
+  As a Jekyll user
+  I want to generate responsive images
+  In order to use them on my pages
+
+  Scenario: Resizing images
+    Given I have a responsive_image configuration with:
+      """
+        template: _includes/responsive-image.html
+        sizes:
+          - width: 100
+      """
+
+    And I have a file "index.html" with "{% responsive_image path: assets/test.png alt: Foobar %}"
+    When I run Jekyll
+    Then the image "assets/resized/test-100x50.png" should have the dimensions "100x50"
+
+  Scenario: Handling subdirectories
+    Given I have a responsive_image configuration with:
+      """
+        template: _includes/responsive-image.html
+        output_path_format: assets/resized/%{dirname}/%{filename}-%{width}.%{extension}
+        sizes:
+          - width: 100
+      """
+
+    And I have a file "index.html" with:
+      """
+        {% responsive_image path: assets/test.png %}
+        {% responsive_image path: assets/subdir/test.png %}
+      """
+
+    When I run Jekyll
+    Then the file "assets/resized/test-100.png" should exist
+    And the file "assets/resized/subdir/test-100.png" should exist

data/features/responsive-image-tag.feature

@@ -69,7 +69,7 @@ Feature: Jekyll responsive_image tag
     Given I have a responsive_image configuration with:
       """
         template: _includes/responsive-image.html
-        output_path_format: assets/%{basename}-resized/%{width}/%{filename}-%{height}.%{extension}
+        output_path_format: assets/%{dirname}/%{basename}-resized/%{width}/%{filename}-%{height}.%{extension}
         sizes:
           - width: 100
       """

data/features/step_definitions/jekyll_steps.rb

@@ -36,6 +36,12 @@ Then /^the file "(.+)" should exist$/ do |path|
   assert File.exists?(path)
 end
 
+Then /^the image "(.+)" should have the dimensions "(\d+)x(\d+)"$/ do |path, width, height|
+  img = Magick::Image::read(path).first
+  assert_equal "#{width}x#{height}", "#{img.columns}x#{img.rows}"
+  img.destroy!
+end
+
 def write_file(path, contents)
   File.open(path, 'w') do |f|
     f.write(contents)

data/jekyll-responsive_image.gemspec

@@ -29,5 +29,5 @@ Gem::Specification.new do |spec|
   end
 
   spec.add_runtime_dependency 'jekyll', ['>= 2.0', "< #{max_jekyll_version}"]
-  spec.add_runtime_dependency 'rmagick'
+  spec.add_runtime_dependency 'rmagick', ['>= 2.0', '< 3.0']
 end

data/lib/jekyll/responsive_image/common.rb

@@ -7,7 +7,9 @@ module Jekyll
         config = ResponsiveImage.defaults.dup.merge(site.config['responsive_image']).merge(:site_dest => site.dest)
 
         # Not very nice, but this is needed to create a clean path to add to keep_files
-        output_dir = format_output_path(config['output_path_format'], '*', '*', '*')
+        output_dir = format_output_path(config['output_path_format'], config['base_path'], '*', '*', '*')
+        output_dir = "#{File.dirname(output_dir)}/*"
+
         site.config['keep_files'] << output_dir unless site.config['keep_files'].include?(output_dir)
 
         config

data/lib/jekyll/responsive_image/defaults.rb

@@ -2,6 +2,7 @@ module Jekyll
   class ResponsiveImage
     @defaults = {
       'default_quality'    => 85,
+      'base_path'          => 'assets',
       'output_path_format' => 'assets/resized/%{filename}-%{width}x%{height}.%{extension}',
       'sizes'              => [],
     }.freeze

data/lib/jekyll/responsive_image/image_processor.rb

@@ -10,7 +10,7 @@ module Jekyll
         img = Magick::Image::read(image_path).first
 
         {
-          original: image_hash(image_path, img.columns, img.rows),
+          original: image_hash(config['base_path'], image_path, img.columns, img.rows),
           resized: resize_handler.resize_image(img, config),
         }
       end

data/lib/jekyll/responsive_image/resize_handler.rb

@@ -13,8 +13,8 @@ module Jekyll
 
           next unless needs_resizing?(img, width)
 
-          filepath = format_output_path(config['output_path_format'], img.filename, width, height)
-          resized.push(image_hash(filepath, width, height))
+          filepath = format_output_path(config['output_path_format'], config['base_path'], img.filename, width, height)
+          resized.push(image_hash(config['base_path'], filepath, width, height))
 
           # Don't resize images more than once
           next if File.exists?(filepath)

data/lib/jekyll/responsive_image/utils.rb

@@ -1,3 +1,5 @@
+require 'pathname'
+
 module Jekyll
   class ResponsiveImage
     module Utils
@@ -9,22 +11,31 @@ module Jekyll
         result
       end
 
-      def format_output_path(format, path, width, height)
-        params = symbolize_keys(image_hash(path, width, height))
-        format % params
+      def format_output_path(format, base_path, image_path, width, height)
+        params = symbolize_keys(image_hash(base_path, image_path, width, height))
+
+        Pathname.new(format % params).cleanpath.to_s
       end
 
       # Build a hash containing image information
-      def image_hash(path, width, height)
+      def image_hash(base_path, image_path, width, height)
         {
-          'path'      => path,
-          'basename'  => File.basename(path),
-          'filename'  => File.basename(path, '.*'),
-          'extension' => File.extname(path).delete('.'),
+          'path'      => image_path,
+          'dirname'   => relative_dirname(base_path, image_path),
+          'basename'  => File.basename(image_path),
+          'filename'  => File.basename(image_path, '.*'),
+          'extension' => File.extname(image_path).delete('.'),
           'width'     => width,
           'height'    => height,
         }
       end
+
+      def relative_dirname(base_path, image_path)
+        path = Pathname.new(image_path).expand_path
+        base = Pathname.new(base_path).expand_path
+
+        path.relative_path_from(base).dirname.to_s.delete('.')
+      end
     end
   end
 end

data/lib/jekyll/responsive_image/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   class ResponsiveImage
-    VERSION = '0.13.0'.freeze
+    VERSION = '0.14.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-responsive_image
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Joseph Wynn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-05 00:00:00.000000000 Z
+date: 2016-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -36,14 +36,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: "\n    Jekyll Responsive Images is a Jekyll plugin and utility for automatically
   resizing images.\n    Its intended use is for sites which want to display responsive
   images using something like srcset or Imager.js.\n  "
@@ -63,7 +69,9 @@ files:
 - features/fixtures/_includes/base-url.html
 - features/fixtures/_includes/custom-template.html
 - features/fixtures/_includes/responsive-image.html
+- features/fixtures/assets/subdir/test.png
 - features/fixtures/assets/test.png
+- features/image-generation.feature
 - features/responsive-image-block.feature
 - features/responsive-image-tag.feature
 - features/step_definitions/jekyll_steps.rb
@@ -107,7 +115,9 @@ test_files:
 - features/fixtures/_includes/base-url.html
 - features/fixtures/_includes/custom-template.html
 - features/fixtures/_includes/responsive-image.html
+- features/fixtures/assets/subdir/test.png
 - features/fixtures/assets/test.png
+- features/image-generation.feature
 - features/responsive-image-block.feature
 - features/responsive-image-tag.feature
 - features/step_definitions/jekyll_steps.rb