1.6.0

Add registers.site to context when rendering template

.gitattributes

@@ -0,0 +1 @@
+features/test-site/* linguist-vendored

.github/stale.yml

@@ -0,0 +1,10 @@
+daysUntilStale: 18
+daysUntilClose: 3
+staleLabel: stale
+exemptLabels:
+  - pinned
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+closeComment: false

.travis.yml

@@ -1,9 +1,12 @@
 sudo: false
+dist: trusty
 language: ruby
 bundler_args: --without debug
 before_script: bundle exec jekyll --version
 script: bundle exec rake features_with_coveralls
 rvm:
-  - 2.2
-  - 2.1
-  - 2.0
+  - '2.6'
+  - '2.5'
+  - '2.4'
+  - '2.3'
+  - '2.2'

Gemfile

@@ -4,8 +4,8 @@ gemspec
 
 group :development do
   gem 'rake'
-  gem 'cucumber', '~> 2.1'
-  gem 'test-unit', '~> 3.1'
+  gem 'cucumber', '~> 3.1'
+  gem 'test-unit', '~> 3.2'
 
   gem 'simplecov', :require => false
   gem 'coveralls', :require => false

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 Joseph Wynn
+Copyright (c) 2018 Joseph Wynn
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,81 +1,53 @@
 # jekyll-responsive-image
 
-A [Jekyll](http://jekyllrb.com/) plugin and utility for automatically resizing images. Its intended use is for sites which want to display responsive images using something like [`srcset`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Img#Specifications) or [Imager.js](https://github.com/BBC-News/Imager.js/).
+A [Jekyll](http://jekyllrb.com/) plugin for automatically resizing images. Fully configurable and unopinionated, jekyll-responsive-image allows you to display responsive images however you like: using [`<img srcset>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Img#attr-srcset), [`<picture>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/picture), or [Imager.js](https://github.com/BBC-News/Imager.js/).
 
 [![Build Status](https://img.shields.io/travis/wildlyinaccurate/jekyll-responsive-image.svg?style=flat-square)](https://travis-ci.org/wildlyinaccurate/jekyll-responsive-image)
 [![Coverage Status](https://img.shields.io/coveralls/wildlyinaccurate/jekyll-responsive-image.svg?style=flat-square)](https://coveralls.io/repos/github/wildlyinaccurate/jekyll-responsive-image/badge.svg?branch=master)
-[![Dependency Status](https://img.shields.io/gemnasium/wildlyinaccurate/jekyll-responsive-images.svg?style=flat-square)](https://gemnasium.com/wildlyinaccurate/jekyll-responsive-images)
 
 ## Installation
 
-First, install the gem:
+This plugin can be installed in three steps:
+
+### 1. Install the gem
+
+Either add `jekyll-responsive-image` to your Gemfile, or run the following command to install the gem:
 
 ```
 $ gem install jekyll-responsive-image
 ```
 
-Then you can either add it to the `gems` section of your `_config.yml`:
+Then you can either add `jekyll-responsive-image` to the `plugins` section of your `_config.yml`:
 
 ```yaml
-gems:
+plugins:
   - jekyll-responsive-image
 ```
+Note: If you are using a Jekyll version less than 3.5.0, use the `gems` key instead of `plugins`.
 
 Or you can copy the contents of [`responsive_image.rb`](lib/jekyll-responsive-image.rb) into your `_plugins` directory.
 
-## Configuration
+### 2. Create an image template file
 
-An example configuration is below.
+You will need to create a template in order to use the `responsive_image` and `responsive_image_block` tags. Normally the template lives in your `_includes/` directory. Not sure where to start? [Take a look at the sample templates](sample-templates).
+
+For more advanced templates, see the [**Templates**](#templates) section below.
+
+### 3. Configure the plugin
+
+You **must** have a `responsive_image` block in your `_config.yml` for this plugin to work. At a minimum, your `responsive_image` configuration should have a template path and a list of sizes.
 
 ```yaml
 responsive_image:
-  # [Required]
-  # Path to the image template.
   template: _includes/responsive-image.html
-
-  # [Optional, Default: 85]
-  # Quality to use when resizing images.
-  default_quality: 90
-
-  # [Optional, Default: []]
-  # An array of resize configuration objects. Each object must contain at least
-  # a `width` value.
   sizes:
-    - width: 480  # [Required] How wide the resized image will be.
-      quality: 80 # [Optional] Overrides default_quality for this size.
+    - width: 320
+    - width: 480
     - width: 800
-    - 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)
-  #   %{width}       Width of the resized image
-  #   %{height}      Height of the resized image
-  #
-  output_path_format: assets/resized/%{width}/%{basename}
-
-  # [Optional, Default: []]
-  # By default, only images referenced by the responsive_image and responsive_image_block
-  # tags are resized. Here you can set a list of paths or path globs to resize other
-  # images. This is useful for resizing images which will be referenced from stylesheets.
-  extra_images:
-    - assets/foo/bar.png
-    - assets/bgs/*.png
-    - assets/avatars/*.{jpeg,jpg}
 ```
 
+For a list of all the available configuration options, see the [**All configuration options**](#all-configuration-options) section below.
+
 ## Usage
 
 Replace your images with the `responsive_image` tag, specifying the path to the image in the `path` attribute.
@@ -107,73 +79,34 @@ You can use Liquid variables as attributes with the `responsive_image_block` tag
 {% assign alt = 'Lorem ipsum...' %}
 
 {% responsive_image_block %}
-    path: {{ path }}
-    alt: {{ alt }}
-    {% if title %}
-    title: {{ title }}
-    {% endif %}
+  path: {{ path }}
+  alt: {{ alt }}
+  {% if title %}
+  title: {{ title }}
+  {% endif %}
 {% endresponsive_image_block %}
 ```
 
-### Template
+## Templates
 
-You will need to create a template in order to use the `responsive_image` tag. Below are some sample templates to get you started.
-
-#### Responsive images with `srcset`
-
-```twig
-{% capture srcset %}
-    {% for i in resized %}
-        /{{ i.path }} {{ i.width }}w,
-    {% endfor %}
-{% endcapture %}
-
-<img src="/{{ path }}" alt="{{ alt }}" srcset="{{ srcset | strip_newlines }} /{{ original.path }} {{ original.width }}w">
-```
-
-#### Responsive images with `<picture>`
-
-```twig
-<picture>
-    {% for i in resized %}
-        <source media="(min-width: {{ i.width }}px)" srcset="/{{ i.path }}">
-    {% endfor %}
-    <img src="/{{ path }}">
-</picture>
-```
-
-#### Responsive images using [Imager.js](https://github.com/BBC-News/Imager.js/)
-
-> **Note:** This template assumes an `output_path_format` of `assets/resized/%{width}/%{basename}`
-
-```twig
-{% assign smallest = resized | sort: 'width' | first %}
-
-<div class="responsive-image">
-    <img class="responsive-image__placeholder" src="/{{ smallest.path }}">
-    <div class="responsive-image__delayed" data-src="/assets/resized/{width}/{{ original.basename }}"></div>
-</div>
-
-<script>
-    new Imager('.responsive-image__delayed', {
-        availableWidths: [{{ resized | map: 'width' | join: ', ' }}]
-        onImagesReplaced: function() {
-            $('.responsive-image__placeholder').hide();
-        }
-    });
-</script>
-```
+It's easy to build your own custom templates to render images however you want using the template variables provided by jekyll-responsive-image.
 
 ### Template Variables
 
 The following variables are available in the template:
 
-| Variable   | Type   | Description                                                                                          |
-|----------- |--------|------------------------------------------------------------------------------------------------------|
-| `path`     | String | The path of the unmodified image. This is always the same as the `path` attribute passed to the tag. |
-| `resized`  | Array  | An array of all the resized images. Each image is an **Image Object**.                               |
-| `original` | Object | An **Image Object** containing information about the original image.                                 |
-| `*`        | String | Any other attributes will be passed to the template verbatim as strings.                             |
+| Variable   | Type          | Description                                                                                          |
+|------------|---------------|------------------------------------------------------------------------------------------------------|
+| `path`     | String        | The path of the unmodified image. This is always the same as the `path` attribute passed to the tag. |
+| `resized`  | Array<Object> | An array of all the resized images. Each image is an **Image Object**.                               |
+| `original` | Object        | An **Image Object** containing information about the original image.                                 |
+| `*`        | String        | Any other attributes will be passed to the template verbatim as strings (see below).                 |
+
+Any other attributes that are given to the `responsive_image` or `responsive_image_block` tags will be available in the template. For example the following tag will provide an `{{ alt }}` variable to the template:
+
+```twig
+{% responsive_image path: assets/my-file.jpg alt: "A description of the image" %}
+```
 
 #### Image Objects
 
@@ -188,3 +121,135 @@ Image objects (like `original` and each object in `resized`) contain the followi
 | `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`).                                     |
+
+## All configuration options
+
+A full list of all of the available configuration options is below.
+
+```yaml
+responsive_image:
+  # [Required]
+  # Path to the image template.
+  template: _includes/responsive-image.html
+
+  # [Optional, Default: 85]
+  # Quality to use when resizing images.
+  default_quality: 90
+
+  # [Optional, Default: []]
+  # An array of resize configuration objects. Each object must contain at least
+  # a `width` value.
+  sizes:
+    - width: 480  # [Required] How wide the resized image will be.
+      quality: 80 # [Optional] Overrides default_quality for this size.
+    - width: 800
+    - width: 1400
+      quality: 90
+
+  # [Optional, Default: false]
+  # Rotate resized images depending on their EXIF rotation attribute. Useful for
+  # working with JPGs directly from digital cameras and smartphones
+  auto_rotate: false
+
+  # [Optional, Default: false]
+  # Strip EXIF and other JPEG profiles. Helps to minimize JPEG size and win friends
+  # at Google PageSpeed.
+  strip: false
+
+  # [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)
+  #   %{width}       Width of the resized image
+  #   %{height}      Height of the resized image
+  #
+  output_path_format: assets/resized/%{width}/%{basename}
+
+  # [Optional, Default: true]
+  # Whether or not to save the generated assets into the source folder.
+  save_to_source: false
+
+  # [Optional, Default: false]
+  # Cache the result of {% responsive_image %} and {% responsive_image_block %}
+  # tags. See the "Caching" section of the README for more information.
+  cache: false
+
+  # [Optional, Default: []]
+  # By default, only images referenced by the responsive_image and responsive_image_block
+  # tags are resized. Here you can set a list of paths or path globs to resize other
+  # images. This is useful for resizing images which will be referenced from stylesheets.
+  extra_images:
+    - assets/foo/bar.png
+    - assets/bgs/*.png
+    - assets/avatars/*.{jpeg,jpg}
+```
+
+## Troubleshooting
+
+### Error: Can't install RMagick
+
+`jekyll-responsive-image` uses `rmagick` which is currently incompatible with ImageMagick 7. If you get an error like:
+
+```
+Can't install RMagick 2.16.0. Can't find MagickWand.h
+```
+
+Then you will need to install ImageMagick 6. If you are using Homebrew on Mac OS, this can be done with the following commands:
+
+```
+$ brew uninstall imagemagick
+$ brew install imagemagick@6 && brew link imagemagick@6 --force
+```
+
+## Caching
+
+You may be able to speed up the build of large sites by enabling render caching. This is usually only effective when the same image is used many times, for example a header image that is rendered in every post.
+
+The recommended way to enable caching is on an image-by-image basis, by adding `cache: true` to the tag:
+
+```twig
+{% responsive_image path: 'assets/my-file.jpg' cache: true %}
+
+{% responsive_image_block %}
+    path: assets/my-file.jpg
+    cache: true
+{% endresponsive_image_block %}
+```
+
+You can also enable it for all images by adding `cache: true` to your `_config.yml`:
+
+```yaml
+responsive_image:
+  cache: true
+  template: _includes/responsive-image.html
+  sizes:
+    - ...
+```
+
+## Development
+
+If you'd like to contribute to this repository, here's how you can set it up for development:
+
+1. Fork this repository
+2. Clone the fork to your local machine
+3. Install [ImageMagick](http://www.imagemagick.org/) (if you haven't already)
+4. Run `bundle install`
+5. Run the tests like this: `cucumber`
+
+If you'd like your Jekyll project to use your local fork directly, you can add the `:path` parameter to your gem command in the project's Gemfile:
+
+```ruby
+gem 'jekyll-responsive-image', :path => "/your/local/path/to/jekyll-responsive-image"
+```
+
+If you'd like your changes to be considered for the original repository, simply submit a pull request after you've made your changes. Please make sure all tests pass.

features/extra-image-generation.feature

@@ -1,8 +1,4 @@
 Feature: Extra image generation
-  As a Jekyll user
-  I want to resize images that aren't used in posts or pages
-  In order to use them in my stylesheets
-
   Scenario: Specifying a single image and glob patterns
     Given I have a responsive_image configuration with:
       """
@@ -19,6 +15,25 @@ Feature: Extra image generation
     And the file "_site/assets/resized/everybody-loves-jalapeño-pineapple-cornbread-100x50.png" should exist
     And the file "_site/assets/resized/progressive-100x50.jpeg" should exist
 
+  Scenario: Specifying a recursive glob pattern
+    Given I have a responsive_image configuration with:
+      """
+        sizes:
+          - width: 100
+        extra_images:
+          - assets/**/*
+      """
+    And I have a file "index.html" with "Hello, world!"
+    When I run Jekyll
+    Then the image "assets/resized/everybody-loves-jalapeño-pineapple-cornbread-100x50.png" should have the dimensions "100x50"
+    And the image "assets/resized/exif-rotation-100x50.jpeg" should have the dimensions "100x50"
+    And the image "assets/resized/progressive-100x50.jpeg" should have the dimensions "100x50"
+    And the image "assets/resized/test-100x50.png" should have the dimensions "100x50"
+    And the file "_site/assets/resized/everybody-loves-jalapeño-pineapple-cornbread-100x50.png" should exist
+    And the file "_site/assets/resized/exif-rotation-100x50.jpeg" should exist
+    And the file "_site/assets/resized/progressive-100x50.jpeg" should exist
+    And the file "_site/assets/resized/test-100x50.png" should exist
+
   Scenario: Honouring Jekyll 'source' configuration
     Given I have copied my site to "sub-dir/my-site-copy"
     And I have a configuration with:
@@ -34,13 +49,4 @@ Feature: Extra image generation
     When I run Jekyll
     Then the image "sub-dir/my-site-copy/assets/resized/everybody-loves-jalapeño-pineapple-cornbread-100x50.png" should have the dimensions "100x50"
     And the file "_site/assets/resized/everybody-loves-jalapeño-pineapple-cornbread-100x50.png" should exist
-
-  Scenario: No extra images
-    Given I have a responsive_image configuration with:
-      """
-        sizes:
-          - width: 100
-      """
-    And I have a file "index.html" with "Hello, world!"
-    When I run Jekyll
-    Then the file "assets/resized/everybody-loves-jalapeño-pineapple-cornbread-100x50.png" should not exist
+    And the file "_site/assets/resized/progressive-100x50.jpeg" should not exist

features/image-generation.feature

@@ -1,8 +1,4 @@
 Feature: Responsive image generation
-  As a Jekyll user
-  I want to resize my images
-  In order to render them on my pages
-
   Scenario: Resizing images
     Given I have a responsive_image configuration with:
       """
@@ -62,3 +58,62 @@ Feature: Responsive image generation
     When I run Jekyll
     Then the image "my-site-copy/src/assets/resized/subdir/100/test.png" should have the dimensions "100x50"
     And the file "_site/assets/resized/subdir/100/test.png" should exist
+
+  Scenario: Images can be auto-rotated based on EXIF rotation
+    Given I have a responsive_image configuration with:
+      """
+        template: _includes/responsive-image.html
+        sizes:
+          - width: 100
+        auto_rotate: true
+      """
+    And I have a file "index.html" with "{% responsive_image path: assets/exif-rotation.jpeg %}"
+    When I run Jekyll
+    Then the file "_site/assets/resized/exif-rotation-100x200.jpeg" should exist
+
+  Scenario: Images aren't auto-rotated by default
+    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/exif-rotation.jpeg %}
+        {% responsive_image path: assets/progressive.jpeg %}
+      """
+    When I run Jekyll
+    Then the file "_site/assets/resized/exif-rotation-100x50.jpeg" should exist
+    Then the file "_site/assets/resized/progressive-100x50.jpeg" should exist
+
+  Scenario: Images should not be stripped of EXIF info by default
+    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/exif-rotation.jpeg %}
+      """
+    When I run Jekyll
+    Then the file "_site/assets/resized/exif-rotation-100x50.jpeg" should exist
+    Then the image "_site/assets/resized/exif-rotation-100x50.jpeg" should have an EXIF orientation
+
+  Scenario: Images can be stripped of EXIF info
+    Given I have a responsive_image configuration with:
+      """
+        template: _includes/responsive-image.html
+        sizes:
+          - width: 100
+        strip: true
+      """
+    And I have a file "index.html" with:
+      """
+        {% responsive_image path: assets/exif-rotation.jpeg %}
+      """
+    When I run Jekyll
+    Then the file "_site/assets/resized/exif-rotation-100x50.jpeg" should exist
+    Then the image "_site/assets/resized/exif-rotation-100x50.jpeg" should have no EXIF orientation

features/image-hashes.feature

@@ -1,8 +1,4 @@
 Feature: Image hashes inside responsive image templates
-  As a Jekyll template developer
-  I want to have access to image hashes
-  In order to create custom responsive image templates
-
   Scenario: Using the {% responsive_image %} tag
     Given I have copied my site to "my-site-copy/src"
     And I have a configuration with:

features/plugin.feature

@@ -0,0 +1,12 @@
+Feature: General plugin usage
+  Scenario: No config at all
+    Given I have no configuration
+    When I run Jekyll
+    Then there should be no errors
+
+  Scenario: Config with empty responsive_image block
+    Given I have a responsive_image configuration with:
+      """
+      """
+    When I run Jekyll
+    Then there should be no errors

features/responsive-image-block.feature

@@ -1,8 +1,4 @@
 Feature: Jekyll responsive_image_block tag
-  As a Jekyll template developer
-  I want to include Liquid variables when rendering my responsive images
-  In order to dynamically generate my responsive images
-
   Scenario: Simple image tag
     Given I have a responsive_image configuration with "template" set to "_includes/responsive-image.html"
     And I have a file "index.html" with:
@@ -17,6 +13,20 @@ Feature: Jekyll responsive_image_block tag
     When I run Jekyll
     Then I should see "<img alt=\"Lorem ipsum\" src=\"/assets/everybody-loves-jalapeño-pineapple-cornbread.png\" title=\"Magic rainbow adventure!\"" in "_site/index.html"
 
+  Scenario: Tabs for indentation
+    Given I have a responsive_image configuration with "template" set to "_includes/responsive-image.html"
+    And I have a file "index.html" with:
+      """
+      {% assign path = 'assets/everybody-loves-jalapeño-pineapple-cornbread.png' %}
+      {% responsive_image_block %}
+      	path: {{ path }}
+      	title: Magic rainbow adventure!
+      	alt: Lorem ipsum
+      {% endresponsive_image_block %}
+      """
+    When I run Jekyll
+    Then I should see "<img alt=\"Lorem ipsum\" src=\"/assets/everybody-loves-jalapeño-pineapple-cornbread.png\" title=\"Magic rainbow adventure!\"" in "_site/index.html"
+
   Scenario: Global variables available in templates
     Given I have a file "index.html" with:
       """
@@ -60,4 +70,4 @@ Feature: Jekyll responsive_image_block tag
           path: {{ path }}
       {% endresponsive_image_block %}
       """
-    Then Jekyll should throw a "SyntaxError"
+    Then Jekyll should throw a "Magick::ImageMagickError"

features/responsive-image-tag.feature

@@ -1,7 +1,4 @@
 Feature: Jekyll responsive_image tag
-  As a Jekyll template developer
-  I want to include responsive images in my page
-
   Scenario: Simple image tag
     Given I have a responsive_image configuration with "template" set to "_includes/responsive-image.html"
     And I have a file "index.html" with "{% responsive_image path: assets/everybody-loves-jalapeño-pineapple-cornbread.png alt: Foobar %}"
@@ -21,10 +18,7 @@ Feature: Jekyll responsive_image tag
 
   Scenario: Adding custom attributes
     Given I have a responsive_image configuration with "template" set to "_includes/responsive-image.html"
-    And I have a file "index.html" with:
-      """
-      {% responsive_image path: assets/everybody-loves-jalapeño-pineapple-cornbread.png alt: 'Foobar bazbar' title: "Lorem Ipsum" %}
-      """
+    And I have a file "index.html" with "{% responsive_image path: assets/everybody-loves-jalapeño-pineapple-cornbread.png alt: 'Foobar bazbar' title: 'Lorem Ipsum' %}"
     When I run Jekyll
     Then I should see "<img alt=\"Foobar bazbar\" src=\"/assets/everybody-loves-jalapeño-pineapple-cornbread.png\" title=\"Lorem Ipsum\"" in "_site/index.html"
 

features/save-to-source.feature

@@ -0,0 +1,28 @@
+Feature: Save to source
+  Scenario: Resized images are saved to the source directory by default
+    Given I have a responsive_image configuration with:
+      """
+        sizes:
+          - width: 100
+        extra_images:
+          - assets/everybody-loves-jalapeño-pineapple-cornbread.png
+      """
+    And I have a file "index.html" with "Hello, world!"
+    When I run Jekyll
+    Then the file "assets/resized/everybody-loves-jalapeño-pineapple-cornbread-100x50.png" should exist
+    And the file "_site/assets/resized/everybody-loves-jalapeño-pineapple-cornbread-100x50.png" should exist
+
+  Scenario: Resized images can be saved to the destination directory only with save_to_source: false
+    Given I have a responsive_image configuration with:
+      """
+        save_to_source: false
+        sizes:
+          - width: 100
+        extra_images:
+          - assets/everybody-loves-jalapeño-pineapple-cornbread.png
+          - assets/*.jpeg
+      """
+    And I have a file "index.html" with "Hello, world!"
+    When I run Jekyll
+    Then the file "assets/resized/everybody-loves-jalapeño-pineapple-cornbread-100x50.png" should not exist
+    But the file "_site/assets/resized/everybody-loves-jalapeño-pineapple-cornbread-100x50.png" should exist

features/step_definitions/jekyll_steps.rb

@@ -6,6 +6,10 @@ Then /^Jekyll should throw a "(.+)"$/ do |error_class|
   assert_raise(Object.const_get(error_class)) { run_jekyll }
 end
 
+Then /^there should be no errors$/ do
+  # Implicit pass
+end
+
 Given /^I have copied my site to "(.+)"$/ do |path|
   new_site_dir = File.join(TEST_DIR, path)
 
@@ -16,6 +20,10 @@ Given /^I have copied my site to "(.+)"$/ do |path|
     .each { |f| FileUtils.mv(f, new_site_dir) }
 end
 
+Given /^I have no configuration$/ do
+  write_file('_config.yml', '')
+end
+
 Given /^I have a configuration with:$/ do |config|
   write_file('_config.yml', config)
 end
@@ -65,6 +73,18 @@ Then /^the image "(.+)" should be interlaced$/ do |path|
   img.destroy!
 end
 
+Then /^the image "(.+)" should have an EXIF orientation$/ do |path|
+  img = Magick::Image::read(path).first
+  assert_not_equal img.orientation.to_i, 0
+  img.destroy!
+end
+
+Then /^the image "(.+)" should have no EXIF orientation$/ do |path|
+  img = Magick::Image::read(path).first
+  assert_equal img.orientation.to_i, 0
+  img.destroy!
+end
+
 def write_file(path, contents)
   File.open(path, 'w') do |f|
     f.write(contents)

features/test-site/_includes/responsive-image.html

@@ -1 +1,3 @@
+{% assign largest = resized | sort: 'width' | last %}
+
 <img alt="{{ alt }}" src="/{{ original.path }}" title="{{ title }}" srcset="{% for i in resized %}/{{ i.path }} {{ i.width }}w,{% endfor %}/{{ original.path }} {{ original.width }}w">

jekyll-responsive-image.gemspec

@@ -22,6 +22,6 @@ Gem::Specification.new do |spec|
   spec.executables   = []
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'jekyll', ['>= 2.0', "< 4.0"]
-  spec.add_runtime_dependency 'rmagick', ['>= 2.0', '< 3.0']
+  spec.add_runtime_dependency 'jekyll', ['>= 2.0', "< 5.0"]
+  spec.add_runtime_dependency 'rmagick', ['>= 2.0', '< 5.0']
 end

lib/jekyll-responsive-image/block.rb

@@ -4,7 +4,13 @@ module Jekyll
       include Jekyll::ResponsiveImage::Utils
 
       def render(context)
-        attributes = YAML.load(super)
+        content = super
+
+        if content.include?("\t")
+          content = content.lines.map {|line| line.gsub(/\G[\t ]/, "  ")}.join("\n")
+        end
+
+        attributes = YAML.load(content)
         Renderer.new(context.registers[:site], attributes).render_responsive_image
       end
     end

lib/jekyll-responsive-image/config.rb

@@ -6,15 +6,30 @@ module Jekyll
         'base_path'          => 'assets',
         'output_path_format' => 'assets/resized/%{filename}-%{width}x%{height}.%{extension}',
         'sizes'              => [],
-        'extra_images'       => []
+        'extra_images'       => [],
+        'auto_rotate'        => false,
+        'save_to_source'     => true,
+        'cache'              => false,
+        'strip'              => false
       }
 
       def initialize(site)
         @site = site
       end
 
+      def valid_config(config)
+        config.has_key?('responsive_image') && config['responsive_image'].is_a?(Hash)
+      end
+
       def to_h
-        DEFAULTS.merge(@site.config['responsive_image'])
+        config = {}
+
+        if valid_config(@site.config)
+          config = @site.config['responsive_image']
+        end
+
+
+        DEFAULTS.merge(config)
                 .merge(site_source: @site.source, site_dest: @site.dest)
       end
     end

lib/jekyll-responsive-image/extra_image_generator.rb

@@ -2,6 +2,7 @@ module Jekyll
   module ResponsiveImage
     class ExtraImageGenerator < Jekyll::Generator
       include Jekyll::ResponsiveImage::Utils
+      include FileTest
 
       def generate(site)
         config = Config.new(site).to_h
@@ -9,11 +10,13 @@ module Jekyll
 
         config['extra_images'].each do |pathspec|
           Dir.glob(site.in_source_dir(pathspec)) do |image_path|
-            path = Pathname.new(image_path)
-            relative_image_path = path.relative_path_from(site_source)
+            if FileTest.file?(image_path)
+              path = Pathname.new(image_path)
+              relative_image_path = path.relative_path_from(site_source)
 
-            result = ImageProcessor.process(relative_image_path, config)
-            result[:resized].each { |image| keep_resized_image!(site, image) }
+              result = ImageProcessor.process(relative_image_path, config)
+              result[:resized].each { |image| keep_resized_image!(site, image) }
+            end
           end
         end
       end

lib/jekyll-responsive-image/image_processor.rb

@@ -6,14 +6,13 @@ module Jekyll
       def process(image_path, config)
         absolute_image_path = File.expand_path(image_path.to_s, config[:site_source])
 
-        raise SyntaxError.new("Invalid image path specified: #{image_path}") unless File.file?(absolute_image_path)
+        Jekyll.logger.warn "Invalid image path specified: #{image_path.inspect}" unless File.file?(absolute_image_path)
 
-        resize_handler = ResizeHandler.new
-        img = Magick::Image::read(absolute_image_path).first
+        resize_handler = ResizeHandler.new(absolute_image_path, config)
 
         {
-          original: image_hash(config, image_path, img.columns, img.rows),
-          resized: resize_handler.resize_image(img, config),
+          original: image_hash(config, image_path, resize_handler.original_image.columns, resize_handler.original_image.rows),
+          resized: resize_handler.resize_image,
         }
       end
 

lib/jekyll-responsive-image/renderer.rb

@@ -9,12 +9,12 @@ module Jekyll
       end
 
       def render_responsive_image
+        config = Config.new(@site).to_h
+        use_cache = config['cache'] || @attributes['cache']
         cache_key = @attributes.to_s
-        result = @attributes['cache'] ? RenderCache.get(cache_key) : nil
+        result = use_cache ? RenderCache.get(cache_key) : nil
 
         if result.nil?
-          config = Config.new(@site).to_h
-
           image = ImageProcessor.process(@attributes['path'], config)
           @attributes['original'] = image[:original]
           @attributes['resized'] = image[:resized]
@@ -25,7 +25,11 @@ module Jekyll
           partial = File.read(image_template)
           template = Liquid::Template.parse(partial)
 
-          result = template.render!(@attributes.merge(@site.site_payload))
+          info = {
+            registers: { site: @site }
+          }
+
+          result = template.render!(@attributes.merge(@site.site_payload), info)
 
           RenderCache.set(cache_key, result)
         end

lib/jekyll-responsive-image/resize_handler.rb

@@ -3,45 +3,77 @@ module Jekyll
     class ResizeHandler
       include ResponsiveImage::Utils
 
-      def resize_image(img, config)
+      attr_reader :original_image
+
+      def initialize(original_image_absolute_path, config)
+        @config = config
+
+        @original_image_absolute_path = original_image_absolute_path
+
+        if @config['auto_rotate']
+          load_full_image
+          @original_image.auto_orient!
+        else
+          load_image_properties_only
+        end
+      end
+
+      def resize_image
         resized = []
 
-        config['sizes'].each do |size|
+        @config['sizes'].each do |size|
           width = size['width']
-          ratio = width.to_f / img.columns.to_f
-          height = (img.rows.to_f * ratio).round
+          ratio = width.to_f / @original_image.columns.to_f
+          height = (@original_image.rows.to_f * ratio).round
 
-          next unless needs_resizing?(img, width)
+          next unless needs_resizing?(width)
 
-          image_path = img.filename.force_encoding(Encoding::UTF_8)
-          filepath = format_output_path(config['output_path_format'], config, image_path, width, height)
-          resized.push(image_hash(config, filepath, width, height))
+          image_path = @original_image.filename.force_encoding(Encoding::UTF_8)
+          filepath = format_output_path(@config['output_path_format'], @config, image_path, width, height)
+          resized.push(image_hash(@config, filepath, width, height))
 
-          site_source_filepath = File.expand_path(filepath, config[:site_source])
-          site_dest_filepath = File.expand_path(filepath, config[:site_dest])
+          site_source_filepath = File.expand_path(filepath, @config[:site_source])
+          site_dest_filepath = File.expand_path(filepath, @config[:site_dest])
 
-          # Don't resize images more than once
-          next if File.exist?(site_source_filepath)
-
-          ensure_output_dir_exists!(site_source_filepath)
-          ensure_output_dir_exists!(site_dest_filepath)
-
-          Jekyll.logger.info "Generating #{site_source_filepath}"
-
-          i = img.scale(ratio)
-          i.write(site_source_filepath) do |f|
-            f.interlace = i.interlace
-            f.quality = size['quality'] || config['default_quality']
+          if @config['save_to_source']
+            target_filepath = site_source_filepath
+          else
+            target_filepath = site_dest_filepath
           end
 
-          # Ensure the generated file is copied to the _site directory
-          Jekyll.logger.info "Copying resized image to #{site_dest_filepath}"
-          FileUtils.copy_file(site_source_filepath, site_dest_filepath)
+          # Don't resize images more than once
+          next if File.exist?(target_filepath)
+
+          ensure_output_dir_exists!(target_filepath)
+          ensure_output_dir_exists!(site_dest_filepath)
+
+          Jekyll.logger.info "Generating #{target_filepath}"
+
+          load_full_image unless @original_image_pixels_loaded
+
+          if @config['strip']
+            @original_image.strip!
+          end
+
+          i = @original_image.scale(ratio)
+
+          quality = size['quality'] || @config['default_quality']
+
+          i.write(target_filepath) do |f|
+            f.interlace = i.interlace
+            f.quality = quality
+          end
+
+          if @config['save_to_source']
+            # Ensure the generated file is copied to the _site directory
+            Jekyll.logger.info "Copying resized image to #{site_dest_filepath}"
+            FileUtils.copy_file(site_source_filepath, site_dest_filepath)
+          end
 
           i.destroy!
         end
 
-        img.destroy!
+        @original_image.destroy!
 
         resized
       end
@@ -52,8 +84,18 @@ module Jekyll
         Pathname.new(format % params).cleanpath.to_s
       end
 
-      def needs_resizing?(img, width)
-        img.columns > width
+      def needs_resizing?(width)
+        @original_image.columns > width
+      end
+
+      def load_full_image
+        @original_image = Magick::Image::read(@original_image_absolute_path).first
+        @original_image_pixels_loaded = true
+      end
+
+      def load_image_properties_only
+        @original_image = Magick::Image::ping(@original_image_absolute_path).first
+        @original_image_pixels_loaded = false
       end
 
       def ensure_output_dir_exists!(path)

lib/jekyll-responsive-image/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module ResponsiveImage
-    VERSION = '1.1.0'.freeze
+    VERSION = '1.6.0'.freeze
   end
 end

sample-templates/imager-js.html

@@ -0,0 +1,25 @@
+{% comment %}
+Render your responsive images using Imager.js (https://github.com/BBC-News/Imager.js/), with the smallest resized image used as a fallback.
+
+Usage:
+
+	{% responsive_image path: assets/image.jpg alt: "A description of the image" %}
+
+(P.S. You can safely delete this comment block)
+{% endcomment %}
+
+{% assign smallest = resized | sort: 'width' | first %}
+
+<div class="responsive-image">
+    <img class="responsive-image__placeholder" src="/{{ smallest.path }}">
+    <div class="responsive-image__delayed" data-src="/assets/resized/{width}/{{ original.basename }}"></div>
+</div>
+
+<script>
+new Imager('.responsive-image__delayed', {
+    availableWidths: [{{ resized | map: 'width' | join: ', ' }}],
+    onImagesReplaced: function() {
+        $('.responsive-image__placeholder').hide()
+    }
+})
+</script>

sample-templates/picture.html

@@ -0,0 +1,16 @@
+{% comment %}
+Render your responsive images using <picture>, with the original asset used as a fallback. Note: If your original assets are not web-friendly (e.g. they are very large), you can use a resized image as the fallback instead. See the srcset-resized-fallback.html template for how to do this.
+
+Usage:
+
+	{% responsive_image path: assets/image.jpg alt: "A description of the image" %}
+
+(P.S. You can safely delete this comment block)
+{% endcomment %}
+
+<picture>
+    {% for i in resized %}
+        <source media="(min-width: {{ i.width }}px)" srcset="/{{ i.path }}">
+    {% endfor %}
+    <img src="/{{ path }}">
+</picture>

sample-templates/srcset-resized-fallback.html

@@ -0,0 +1,18 @@
+{% comment %}
+Render your responsive images using <img srcset>, with the largest resized image used as a fallback.
+
+Usage:
+
+	{% responsive_image path: assets/image.jpg alt: "A description of the image" %}
+
+(P.S. You can safely delete this comment block)
+{% endcomment %}
+
+{% assign largest = resized | sort: 'width' | last %}
+{% capture srcset %}
+{% for i in resized %}
+    /{{ i.path }} {{ i.width }}w,
+{% endfor %}
+{% endcapture %}
+
+<img src="/{{ largest.path }}" alt="{{ alt }}" srcset="{{ srcset | strip_newlines }} /{{ path }} {{ original.width }}w">

sample-templates/srcset.html

@@ -0,0 +1,17 @@
+{% comment %}
+Render your responsive images using <img srcset>, with the original asset used as a fallback. Note: If your original assets are not web-friendly (e.g. they are very large), you might prefer to use the srcset-resized-fallback.html template.
+
+Usage:
+
+	{% responsive_image path: assets/image.jpg alt: "A description of the image" %}
+
+(P.S. You can safely delete this comment block)
+{% endcomment %}
+
+{% capture srcset %}
+{% for i in resized %}
+    /{{ i.path }} {{ i.width }}w,
+{% endfor %}
+{% endcapture %}
+
+<img src="/{{ path }}" alt="{{ alt }}" srcset="{{ srcset | strip_newlines }} /{{ path }} {{ original.width }}w">