imgix-rails 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee4ca6aecc3acbcbb35b5c9b68731403e423f9b76421e14bbf270b727aa0c75d
-  data.tar.gz: 5397fee06ecb6b23d2e5fb0464736681b3d68976a87e5959b1b33f890a164acf
+  metadata.gz: 88a3092191fe9ded77bf15aa47ab9dece604fe75b68da6066d1d26623b792885
+  data.tar.gz: ff00a1456055f474ac7bbde0e5174a33f21dfe8410e313f5add68308c31d1537
 SHA512:
-  metadata.gz: 54700c22ae9e911dd22139e4e03b45bff2c07b38ca8a23f6253a9311420424903babb1189db3a31bd0eaa70e88f8babeefe26cd95ce3d1691ab0804cdca782dc
-  data.tar.gz: df2ef3b2ba35d0f1296c6a161ff37ecbbe11a1dfda97c69b4c330b6049cdacf8129363db6b39394e6ce1146daed6f33049807763d4045753690ada32db276c98
+  metadata.gz: 0f8b5d87b939ad76463cf2dcdfed8a21dbf57abce525f7f5cbcacb9dcfb7dcd254198fc6a2537ca54220661095bec81784990bda59f7eec23c45bd23e034673a
+  data.tar.gz: d9d499115d9bd1173f5bf5c1bb54c9d2645caf4ea87e332a50dab64dab0786ff29bf63379b5c4700c9e360027053e4ea3176fd13196227fb48dbce03d7164f95

data/.travis.yml

@@ -1,5 +1,8 @@
 language: ruby
 rvm:
+  - 2.7.1
+  - 2.6.6
+  - 2.5.8
   - 2.3.1
   - 2.2.5
   - jruby

data/CHANGELOG.md

@@ -3,9 +3,14 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [4.2.0](https://github.com/imgix/imgix-rb/compare/4.1.0...4.2.0) - January 05, 2021
+
+- Add support for lazy image loading ([#108](https://github.com/imgix/imgix-rails/pull/108))
+
 ## [4.1.0](https://github.com/imgix/imgix-rb/compare/4.0.2...4.1.0) - October 13, 2020
 
 ### Release Notes
+
 Version 4.1.0 has been released! The goal of this release is to offer flexibility to those using imgix-rb's purger capabilities through imgix-rails.
 
 Prior to this release, this gem offered purging capability through `imgix '~> 3.0'`. However, that purging capability has been deprecated in favor of the new-style purging API––available now in [imgix-rb v4.0.0](https://github.com/imgix/imgix-rb/releases/tag/4.0.0).
@@ -17,9 +22,11 @@ To upgrade to the new purging API used in `imgix '~> 4.0'`:
 - use this new key in your imgix client: `Imgix::Client.new(domain: '...', api_key: NEW_API_KEY)`
 
 ### Changes
+
 - build: use optimistic constraint for imgix >= 3.0 ([#104](https://github.com/imgix/imgix-rails/pull/104))
 
 ## [4.0.2](https://github.com/imgix/imgix-rb/compare/4.0.1...4.0.2) - July 31, 2020
+
 - fix: replace `opts[:host`] with `opts[:domain]` to resolve deprecation warnings ([#96](https://github.com/imgix/imgix-rails/pull/96))
 
 ## [4.0.1](https://github.com/imgix/imgix-rb/compare/4.0.0...4.0.1) - June 10, 2020
@@ -40,13 +47,13 @@ For users migrating to version 4.0 or later, it is important that all srcset-rel
 
 In addition to these changes, imgix-rails is now capable of producing [fixed-image srcsets](https://github.com/imgix/imgix-rb#fixed-image-rendering). Users should note that when certain dimension information is provided, imgix-rails will produce a `srcset` at different screen resolutions rather than the typical width pairs. This feature provides expanded functionality to cover more `srcset` use cases that users can take advantage of. We are always happy to provide our users with more tools to assist them in their efforts to build out responsive images on the web.
 
-* feat: utilize Imgix::Path#to_srcset when constructing srcsets ([#83](https://github.com/imgix/imgix-rails/pull/83))
-* chore: remove deprecated domain sharding behavior ([#80](https://github.com/imgix/imgix-rails/pull/80))
-* fix: deprecate resizing height when maintaining aspect ratio ([#78](https://github.com/imgix/imgix-rails/pull/78))
+- feat: utilize Imgix::Path#to_srcset when constructing srcsets ([#83](https://github.com/imgix/imgix-rails/pull/83))
+- chore: remove deprecated domain sharding behavior ([#80](https://github.com/imgix/imgix-rails/pull/80))
+- fix: deprecate resizing height when maintaining aspect ratio ([#78](https://github.com/imgix/imgix-rails/pull/78))
 
 ## [3.1.0](https://github.com/imgix/imgix-rb/compare/3.0.2...3.1.0) - October 25, 2019
 
-* Update bundler dev dependency to include new major version 2.x ([#71](https://github.com/imgix/imgix-rb/pull/71))
-* README: Fix typo ([#73](https://github.com/imgix/imgix-rb/pull/73))
-* docs: add ActiveStorage instructions to README ([#74](https://github.com/imgix/imgix-rb/pull/74))
-* chore(deprecate): emit warning when generating srcsets ([ccc906b](https://github.com/imgix/imgix-rails/commit/ccc906be749945f6f843b5eeb04ab03a292ccbfb)) ([e2ffc2b](https://github.com/imgix/imgix-rails/commit/e2ffc2b4f847c15ea73fa161b673885e704e4cf2))
+- Update bundler dev dependency to include new major version 2.x ([#71](https://github.com/imgix/imgix-rb/pull/71))
+- README: Fix typo ([#73](https://github.com/imgix/imgix-rb/pull/73))
+- docs: add ActiveStorage instructions to README ([#74](https://github.com/imgix/imgix-rb/pull/74))
+- chore(deprecate): emit warning when generating srcsets ([ccc906b](https://github.com/imgix/imgix-rails/commit/ccc906be749945f6f843b5eeb04ab03a292ccbfb)) ([e2ffc2b](https://github.com/imgix/imgix-rails/commit/e2ffc2b4f847c15ea73fa161b673885e704e4cf2))

data/README.md

@@ -4,7 +4,7 @@
 `imgix-rails` is a gem for integrating [imgix](https://www.imgix.com/) into Ruby on Rails applications. It builds on [imgix-rb](https://github.com/imgix/imgix-rb) to offer a few Rails-specific interfaces.
 
 [![Gem Version](https://img.shields.io/gem/v/imgix-rails.svg)](https://rubygems.org/gems/imgix-rails)
-[![Build Status](https://travis-ci.org/imgix/imgix-rails.svg?branch=main)](https://travis-ci.org/imgix/imgix-rails)
+[![Build Status](https://travis-ci.com/imgix/imgix-rails.svg?branch=main)](https://travis-ci.com/imgix/imgix-rails)
 ![Downloads](https://img.shields.io/gem/dt/imgix-rails)
 [![License](https://img.shields.io/github/license/imgix/imgix-rails)](https://github.com/imgix/imgix-rails/blob/main/LICENSE)
 
@@ -17,8 +17,10 @@
     - [Multi-source configuration](#multi-source-configuration)
   - [`ix_image_tag`](#iximagetag)
     - [Fixed image rendering](#fixed-image-rendering)
+    - [Lazy Loading](#lazy-loading)
   - [`ix_picture_tag`](#ixpicturetag)
   - [`ix_image_url`](#iximageurl)
+    - [Usage in Model](#usage-in-model)
     - [Usage in Sprockets](#usage-in-sprockets)
 - [Using With Image Uploading Libraries](#using-with-image-uploading-libraries)
   - [Paperclip and CarrierWave](#paperclip-and-carrierwave)
@@ -108,6 +110,8 @@ The `ix_image_tag` helper method makes it easy to pass parameters to imgix to ha
   * [`min_width`](https://github.com/imgix/imgix-rb#minimum-and-maximum-width-ranges): The minimum width that `srcset` pairs will be generated with. Will be ignored if `widths` are provided.
   * [`max_width`](https://github.com/imgix/imgix-rb#minimum-and-maximum-width-ranges): The maximum width that `srcset` pairs will be generated with. Will be ignored if `widths` are provided.
   * [`disable_variable_quality`](https://github.com/imgix/imgix-rb#variable-qualities): Pass `true` to disable variable quality parameters when generating a `srcset` ([fixed-images only](https://github.com/imgix/imgix-rails#fixed-image-rendering)). In addition, imgix-rails will respect an overriding `q` (quality) parameter if one is provided through `url_params`.
+  * `attribute_options`: Allow you to change where imgix-rails renders
+    attributes. This can be helpful if you want to add lazy-loading.
 
 ```erb
 <%= ix_image_tag('/unsplash/hotairballoon.jpg', url_params: { w: 300, h: 500, fit: 'crop', crop: 'right'}, tag_options: { alt: 'A hot air balloon on a sunny day' }) %>
@@ -177,6 +181,29 @@ https://assets.imgix.net/image.jpg?ixlib=rails-3.0.2&amp;w=1000&amp;dpr=5&amp;q=
 
 Fixed image rendering will automatically append a variable `q` parameter mapped to each `dpr` parameter when generating a `srcset`. This technique is commonly used to compensate for the increased filesize of high-DPR images. Since high-DPR images are displayed at a higher pixel density on devices, image quality can be lowered to reduce overall filesize without sacrificing perceived visual quality. For more information and examples of this technique in action, see [this blog post](https://blog.imgix.com/2016/03/30/dpr-quality?_ga=utm_medium=referral&utm_source=sdk&utm_campaign=rails-readme). This behavior will respect any overriding `q` value passed in via `url_params` and can be disabled altogether with `srcset_options: { disable_variable_quality: true }`.
 
+#### Lazy loading
+
+If you'd like to lazy load images, we recommend using [lazysizes](https://github.com/aFarkas/lazysizes). In order to use imgix-rails with lazysizes, you need to use `attribute_options` as well as set `tag_options[:src]`:
+
+```erb
+<%= ix_image_tag('image.jpg', attribute_options: {src: "data-src",
+srcset: "data-srcset", sizes: "data-sizes"}, url_params: {w: 1000},
+tag_options: {src: "lqip.jpg"}) %>
+```
+
+Will render the following HTML:
+
+```html
+<img data-srcset="https://assets.imgix.net/image.jpg?ixlib=rails-3.0.2&amp;w=1000&amp;dpr=1&amp;q=75 1x,
+https://assets.imgix.net/image.jpg?ixlib=rails-3.0.2&amp;w=1000&amp;dpr=2&amp;q=50 2x,
+https://assets.imgix.net/image.jpg?ixlib=rails-3.0.2&amp;w=1000&amp;dpr=3&amp;q=35 3x,
+https://assets.imgix.net/image.jpg?ixlib=rails-3.0.2&amp;w=1000&amp;dpr=4&amp;q=23 4x,
+https://assets.imgix.net/image.jpg?ixlib=rails-3.0.2&amp;w=1000&amp;dpr=5&amp;q=20 5x"
+data-sizes="100vw"
+data-src="https://assets.imgix.net/image.jpg?ixlib=rails-3.0.2&amp;w=1000"
+src="lqip.jpg">
+```
+
 ### `ix_picture_tag`
 
 The `ix_picture_tag` helper method makes it easy to generate `picture` elements in your Rails app. `picture` elements are useful when an images needs to be art directed differently at different screen sizes.
@@ -252,7 +279,7 @@ To generate a `picture` element on a different source:
 
 The `ix_image_url` helper makes it easy to generate a URL to an image in your Rails app.
 
-`ix_image_url` takes four arguments:
+`ix_image_url` takes three arguments:
 
 * `source`: an optional String indicating the source to be used. If unspecified `:source` or `:default_source` will be used. If specified, the value must be defined in the config.
 * `path`: The path or URL of the image to display.
@@ -270,6 +297,8 @@ https://assets.imgix.net/users/1/avatar.png?w=400&h=300
 https://assets2.imgix.net/users/1/avatar.png?w=400&h=300
 ```
 
+#### Usage in Model
+
 Since `ix_image_url` lives inside `UrlHelper`, it can also be used in places other than your views quite easily. This is useful for things such as including imgix URLs in JSON output from a serializer class.
 
 ```rb
@@ -279,6 +308,8 @@ puts ix_image_url('/users/1/avatar.png', { w: 400, h: 300 })
 # => https://assets.imgix.net/users/1/avatar.png?w=400&h=300
 ```
 
+Alternatively, you can also use the imgix [Ruby client](https://github.com/imgix/imgix-rb) in the same way.
+
 #### Usage in Sprockets
 
 `ix_image_url` is also pulled in as a Sprockets helper, so you can generate imgix URLs in your asset pipeline files. For example, here's how it would work inside an `.scss.erb` file:

data/lib/imgix/rails/image_tag.rb

@@ -3,9 +3,28 @@ require "imgix/rails/tag"
 class Imgix::Rails::ImageTag < Imgix::Rails::Tag
 
   def render
-    @tag_options[:srcset] = srcset
-    @tag_options[:sizes] ||= '100vw'
+    url = ix_image_url(@source, @path, @url_params)
 
-    image_tag(ix_image_url(@source, @path, @url_params), @tag_options)
+    if @attribute_options[:srcset].present?
+      @tag_options[@attribute_options[:srcset]] = srcset
+    else
+      @tag_options[:srcset] = srcset
+    end
+
+    if @attribute_options[:size].present?
+      @tag_options[@attribute_options[:size]] ||= '100vw'
+    else
+      @tag_options[:sizes] ||= '100vw'
+    end
+
+    if @attribute_options[:src].present?
+      @tag_options[@attribute_options[:src]] = url
+    end
+
+    if @tag_options[:src].present?
+      image_tag(@tag_options[:src], @tag_options)
+    else
+      image_tag(url, @tag_options)
+    end
   end
 end

data/lib/imgix/rails/tag.rb

@@ -5,12 +5,13 @@ class Imgix::Rails::Tag
   include Imgix::Rails::UrlHelper
   include ActionView::Helpers
 
-  def initialize(path, source: nil, tag_options: {}, url_params: {}, srcset_options: {})
+  def initialize(path, source: nil, tag_options: {}, url_params: {}, srcset_options: {}, attribute_options: {})
     @path = path
     @source = source
     @tag_options = tag_options
     @url_params = url_params
     @srcset_options = srcset_options
+    @attribute_options = attribute_options
   end
 
 protected

data/lib/imgix/rails/version.rb

@@ -1,5 +1,5 @@
 module Imgix
   module Rails
-    VERSION = '4.1.0'
+    VERSION = '4.2.0'
   end
 end

data/lib/imgix/rails/view_helper.rb

@@ -8,8 +8,8 @@ module Imgix
     module ViewHelper
       include UrlHelper
 
-      def ix_image_tag(source=nil, path, tag_options: {}, url_params: {}, srcset_options: {})
-        return Imgix::Rails::ImageTag.new(path, source: source, tag_options: tag_options, url_params: url_params, srcset_options: srcset_options).render
+      def ix_image_tag(source=nil, path, tag_options: {}, url_params: {}, srcset_options: {}, attribute_options: {})
+        return Imgix::Rails::ImageTag.new(path, source: source, tag_options: tag_options, url_params: url_params, srcset_options: srcset_options, attribute_options: attribute_options).render
       end
 
       def ix_picture_tag(source=nil, path, tag_options: {}, url_params: {}, breakpoints: {}, srcset_options: {})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: imgix-rails
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Kelly Sutton
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-15 00:00:00.000000000 Z
+date: 2021-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: imgix
@@ -121,8 +121,8 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/imgix/imgix-rails/issues
   changelog_uri: https://github.com/imgix/imgix-rails/blob/main/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/imgix-rails/4.1.0
-  source_code_uri: https://github.com/imgix/imgix-rails/tree/v4.1.0
+  documentation_uri: https://www.rubydoc.info/gems/imgix-rails/4.2.0
+  source_code_uri: https://github.com/imgix/imgix-rails/tree/v4.2.0
   allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
@@ -139,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Makes integrating imgix into your Rails app easier. It builds on imgix-rb