imgix-rails 3.1.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d8e16e7584531189f3ccab88b74ff078b40acc6
-  data.tar.gz: c5702cdb0c68c5b56de4d3f38f9c7822d4436560
+  metadata.gz: 1dbb6ad0974d411fd8ab3e7167b211234fc0e96c
+  data.tar.gz: 0c2717ac27d3323badcc525148188c9716336d2b
 SHA512:
-  metadata.gz: d31eb0414ac415ce503ecea0f8d284ddf4c801a118fcfa6043ecbd0a71c6e4e7685730e910ab5f4768a2912854878d699e53177bf7d88e74fce0a2881a8e007f
-  data.tar.gz: 4c64313f1972d5420f7211d9666cc63df0326a52cf09d0462895ffc3b2551357a25c6add079d1934bc5451e7e1c1f4113ddd3bd0b0fc2b29d50cb64102f29912
+  metadata.gz: 924e0acf93ae7d7a6b824109261d0fd0e5370323655827c346e5b58e2018ad8341f7e013ddf1a1f402df6aca1da67257fdd6b4fad4d1b08d7e60a644b318cc88
+  data.tar.gz: 5271ff9cd004e1fe04c7b6ed2d4682891500b7ccb77e3f39229366d83fe162c95f6f0540976f3d52377556cf068a36e6844a40f1aa75de1697488643169aa5d7

data/CHANGELOG.md

@@ -3,6 +3,24 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+# [4.0.0](https://github.com/imgix/imgix-rb/compare/3.1.0...4.0.0) - December 03, 2019
+
+The v4.0.0 release of imgix-rails introduces a variety of improvements relating to how this gem handles and generates `srcset` attributes. However, in releasing this version there are some significant interface/behavioral changes that users need to be aware of. Users should note that the `min_width` and `max_width` fields (passed via `tag_options`), as well as the `widths` field, have all been moved to their own encompassing `srcset_options` field. This is done with the intention of providing a more organized and intuitive experience when fine-tuning how `srcset` width pairs are generated. See the following example demonstrating this new pattern:
+
+```erb
+<%= ix_image_tag('/unsplash/hotairballoon.jpg',
+  srcset_options: { min_width: 1000, max_width: 2500},
+  tag_options: { alt: 'A hot air balloon on a sunny day' }) %>
+```
+
+For users migrating to version 4.0 or later, it is important that all srcset-related modifiers be passed via `srcset_options`, as doing so through `tag_options` or `widths` directly will result in errors. For more details on these modifiers, please see the [ix_image_tag](https://github.com/imgix/imgix-rails#ix_image_tag) or [ix_picture_tag](https://github.com/imgix/imgix-rails#ix_picture_tag) sections.
+
+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))
+
 ## [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))

data/README.md

@@ -6,7 +6,7 @@
 
 imgix is a real-time image processing service and CDN. It allows you to manipulate images merely by changing their URL parameters. For a full list of URL parameters, please see the [imgix URL API documentation](https://www.imgix.com/docs/reference).
 
-We recommend using something like [Paperclip](https://github.com/thoughtbot/paperclip), [Refile](https://github.com/refile/refile), [Carrierwave](https://github.com/carrierwaveuploader/carrierwave), or [s3_direct_upload](https://github.com/waynehoover/s3_direct_upload) to handle uploads. After they've been uploaded, you can then serve them using this gem.
+We recommend using something like [Paperclip](https://github.com/thoughtbot/paperclip), [Refile](https://github.com/refile/refile), [Carrierwave](https://github.com/carrierwaveuploader/carrierwave), or [Active Storage](https://github.com/rails/rails/tree/master/activestorage) to handle uploads. After they've been uploaded, you can then serve them using this gem.
 
 * [Installation](#installation)
 * [Usage](#usage)
@@ -19,6 +19,7 @@ We recommend using something like [Paperclip](https://github.com/thoughtbot/pape
   * [Paperclip and CarrierWave](#paperclip-and-carrierwave)
   * [Refile](#refile)
   * [Active Storage](#activestorage)
+* [Upgrade Guides](#upgrade-guides)
 * [Development](#development)
 * [Contributing](#contributing)
 
@@ -57,18 +58,17 @@ end
 
 The following configuration flags will be respected:
 
-- `:use_https` toggles the use of HTTPS. Defaults to `true`
-- `:source` a String or Array that specifies the imgix Source address. Should be in the form of `"assets.imgix.net"`.
-- `:srcset_width_tolerance` an optional numeric value determining the maximum tolerance allowable, between the downloaded dimensions and rendered dimensions of the image (default `.08` i.e. `8%`).
-- `:secure_url_token` an optional secure URL token found in your dashboard (https://dashboard.imgix.com) used for signing requests
-- `:shard_strategy` Specify [domain sharding strategy](https://github.com/imgix/imgix-rb#domain-sharded-urls) with multiple sources. Acceptable values are `:cycle` and `:crc`. `:crc` is used by default.
+- `use_https`: toggles the use of HTTPS. Defaults to `true`
+- `source`: a String or Array that specifies the imgix Source address. Should be in the form of `"assets.imgix.net"`.
+- `srcset_width_tolerance`: an optional numeric value determining the maximum tolerance allowable, between the downloaded dimensions and rendered dimensions of the image (default `0.08` i.e. `8%`).
+- `secure_url_token`: an optional secure URL token found in your dashboard (https://dashboard.imgix.com) used for signing requests
 
 #### Multi-source configuration
 
 In addition to the standard configuration flags, the following options can be used for multi-source support.
 
-- `:sources` a Hash of imgix source-secure_url_token key-value pairs. If the value for a source is `nil`, URLs generated for the corresponding source won't be secured. `:sources` and `:source` *cannot* be used together.
-- `:default_source` optionally specify a default source for generating URLs.
+- `sources`: a Hash of imgix source-secure_url_token key-value pairs. If the value for a source is `nil`, URLs generated for the corresponding source won't be secured. `sources` and `source` *cannot* be used together.
+- `default_source`: optionally specify a default source for generating URLs.
 
 Example:
 
@@ -87,16 +87,21 @@ end
 <a name="ix_image_tag"></a>
 ### ix_image_tag
 
-The `ix_image_tag` helper method makes it easy to pass parameters to imgix to handle resizing, cropping, etc. It also simplifies adding responsive imagery to your Rails app by automatically generating a `srcset` based on the parameters you pass. We talk a bit about using the `srcset` attribute in an application in the following blog post: [“Responsive Images with `srcset` and imgix.”](https://blog.imgix.com/2015/08/18/responsive-images-with-srcset-imgix.html).
+The `ix_image_tag` helper method makes it easy to pass parameters to imgix to handle resizing, cropping, etc. It also simplifies adding responsive imagery to your Rails app by automatically generating a `srcset` based on the parameters you pass. We talk a bit about using the `srcset` attribute in an application in the following blog post: [“Responsive Images with `srcset` and imgix.”](https://docs.imgix.com/tutorials/responsive-images-srcset-imgix?_ga=utm_medium=referral&utm_source=sdk&utm_campaign=rails-readme).
 
-`ix_image_tag` generates `<img>` tags with a filled-out `srcset` attribute that leans on imgix to do the hard work. If you already know the minimum or maximum number of physical pixels that this image will need to be displayed at, you can pass the `min_width` and/or `max_width` options. This will result in a smaller, more tailored `srcset`.
+`ix_image_tag` generates `<img>` tags with a filled-out `srcset` attribute that leans on [imgix-rb](https://github.com/imgix/imgix-rb) to do the hard work. It also makes a variety of options available for customizing how the `srcset` is generated. For example, if you already know the minimum or maximum number of physical pixels that this image will need to be displayed at, you can pass the `min_width` and/or `max_width` options. This will result in a smaller, more tailored `srcset`.
 
 `ix_image_tag` takes the following 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.
+* `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.
-* `tag_options`: Any options to apply to the generated `img` element. This is useful for adding class names, etc.
+* `tag_options`: HTML attributes to apply to the generated `img` element. This is useful for adding class names, alt tags, etc.
 * `url_params`: The imgix URL parameters to apply to this image. These will be applied to each URL in the `srcset` attribute, as well as the fallback `src` attribute.
+* `srcset_options`: A variety of options that allow for fine tuning `srcset` generation. More information on each of these modifiers can be found in the [imgix-rb documentation](https://github.com/imgix/imgix-rb#srcset-generation). Any of the following can be passed as arguments:
+  * [`widths`](https://github.com/imgix/imgix-rb#custom-widths): An array of exact widths that `srcset` pairs will be generated with.
+  * [`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`.
 
 ```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' }) %>
@@ -143,9 +148,28 @@ Then rendering the portrait in your application is very easy:
 If you already know all the exact widths you need images for, you can specify that by passing the `widths` option as an array. In this case, imgix-rails will only generate `srcset` pairs for the specified `widths`.
 
 ```erb
-<%= ix_image_tag('/unsplash/hotairballoon.jpg', widths: [320, 640, 960, 1280], url_params: { w: 300, h: 500, fit: 'crop', crop: 'right'}, tag_options: { alt: 'A hot air balloon on a sunny day' }) %>
+<%= ix_image_tag('/unsplash/hotairballoon.jpg', srcset_options: { widths: [320, 640, 960, 1280] }, tag_options: { alt: 'A hot air balloon on a sunny day' }) %>
+```
+
+#### Fixed image rendering
+
+In cases where enough information is provided about an image's dimensions, `ix_image_tag` will instead build a `srcset` that will allow for an image to be served at different resolutions. The parameters taken into consideration when determining if an image is fixed-width are `w`, `h`, and `ar`. By invoking `ix_image_tag` with either a width or the height and aspect ratio (along with `fit=crop`, typically) provided, a different srcset will be generated for a fixed-size image instead.
+
+```erb
+<%= ix_image_tag('/unsplash/hotairballoon.jpg', url_params: {w: 1000}) %>
+```
+
+Will render the following HTML:
+
+```html
+<img 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" sizes="100vw" src="https://assets.imgix.net/image.jpg?ixlib=rails-3.0.2&amp;w=1000">
 ```
 
+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 }`.
 
 <a name="ix_picture_tag"></a>
 ### ix_picture_tag
@@ -159,6 +183,11 @@ The `ix_picture_tag` helper method makes it easy to generate `picture` elements
 * `tag_options`: Any options to apply to the parent `picture` element. This is useful for adding class names, etc.
 * `url_params`: Default imgix options. These will be used to generate a fallback `img` tag for older browsers, and used in each `source` unless overridden by `breakpoints`.
 * `breakpoints`: A hash describing the variants. Each key must be a media query (e.g. `(max-width: 880px)`), and each value must be a hash of parameter overrides for that media query. A `source` element will be generated for each breakpoint specified.
+* `srcset_options`: A variety of options that allow for fine tuning `srcset` generation. More information on each of these modifiers can be found in the [imgix-rb documentation](https://github.com/imgix/imgix-rb#srcset-generation). Any of the following can be passed as arguments:
+  * [`widths`](https://github.com/imgix/imgix-rb#custom-widths): An array of exact widths that `srcset` pairs will be generated with.
+  * [`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`.
 
 ```erb
 <%= ix_picture_tag('bertandernie.jpg',
@@ -345,6 +374,23 @@ Finally, the two can be used together by passing in the filename of the ActiveSt
 <%= ix_image_tag(@your_model.image.key) %>
 ```
 
+<a name="upgrade-guides"></a>
+## Upgrade Guides
+
+### 3.x to 4.0
+
+The v4.0.0 release of imgix-rails introduces a variety of improvements relating to how this gem handles and generates `srcset` attributes. However, in releasing this version there are some significant interface/behavioral changes that users need to be aware of. Users should note that the `min_width` and `max_width` fields (passed via `tag_options`), as well as the `widths` field, have all been moved to their own encompassing `srcset_options` field. This is done with the intention of providing a more organized and intuitive experience when fine-tuning how `srcset` width pairs are generated. See the following example demonstrating this new pattern:
+
+```erb
+<%= ix_image_tag('/unsplash/hotairballoon.jpg',
+  srcset_options: { min_width: 1000, max_width: 2500},
+  tag_options: { alt: 'A hot air balloon on a sunny day' }) %>
+```
+
+For users migrating to version 4.0 or later, it is important that all srcset-related modifiers be passed via `srcset_options`, as doing so through `tag_options` or `widths` directly will result in errors. For more details on these modifiers, please see the [ix_image_tag](https://github.com/imgix/imgix-rails#ix_image_tag) or [ix_picture_tag](https://github.com/imgix/imgix-rails#ix_picture_tag) sections.
+
+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.
+
 <a name="development"></a>
 ## Development
 

data/imgix-rails.gemspec

@@ -14,6 +14,12 @@ Gem::Specification.new do |spec|
   spec.description   = %q{Makes integrating imgix into your Rails app easier. It builds on imgix-rb to offer a few Rails-specific interfaces. Please see https://github.com/imgix/imgix-rails for more details.}
   spec.homepage      = "https://github.com/imgix/imgix-rails"
 
+  spec.metadata = {
+    'bug_tracker_uri'   => 'https://github.com/imgix/imgix-rails/issues',
+    'changelog_uri'     => 'https://github.com/imgix/imgix-rails/blob/master/CHANGELOG.md',
+    'documentation_uri' => "https://www.rubydoc.info/gems/imgix-rails/#{spec.version}",
+    'source_code_uri'   => "https://github.com/imgix/imgix-rails/tree/v#{spec.version}"
+  }
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
   # delete this section to allow pushing this gem to any host.
   if spec.respond_to?(:metadata)
@@ -27,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "imgix", "~> 1.1", ">= 1.1.0"
+  spec.add_runtime_dependency "imgix", "~> 3.0"
 
   spec.add_development_dependency "bundler", ">=1.9"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/imgix/rails.rb

@@ -8,7 +8,6 @@ require "active_support"
 
 module Imgix
   module Rails
-    STRATEGIES = [:crc, :cycle]
     class Config < ::ActiveSupport::OrderedOptions; end
 
     def self.config

data/lib/imgix/rails/picture_tag.rb

@@ -1,35 +1,42 @@
 require "imgix/rails/tag"
 require "imgix/rails/image_tag"
+require "action_view"
 
 class Imgix::Rails::PictureTag < Imgix::Rails::Tag
   include ActionView::Context
 
-  def initialize(path, source: nil, tag_options: {}, url_params: {}, breakpoints: {}, widths: [])
+  def initialize(path, source: nil, tag_options: {}, url_params: {}, breakpoints: {}, srcset_options: {})
     @path = path
     @source = source
     @tag_options = tag_options
     @url_params = url_params
     @breakpoints = breakpoints
-    @widths = widths.length > 0 ? widths : target_widths
+    @srcset_options = srcset_options
   end
 
   def render
     content_tag(:picture, @tag_options) do
       @breakpoints.each do |media, opts|
+        validate_opts(opts)
+
         source_tag_opts = opts[:tag_options] || {}
         source_tag_url_params = opts[:url_params] || {}
-        widths = opts[:widths]
-        unsupported_opts = opts.except(:tag_options, :url_params, :widths)
-        if unsupported_opts.length > 0
-          raise "'#{unsupported_opts.keys.join("', '")}' key(s) not supported; use tag_options, url_params, widths."
-        end
-
+        srcset_options = opts[:srcset_options] || {}
         source_tag_opts[:media] ||= media
-        source_tag_opts[:srcset] ||= srcset(url_params: @url_params.clone.merge(source_tag_url_params), widths: widths)
+        source_tag_opts[:srcset] ||= srcset(url_params: @url_params.clone.merge(source_tag_url_params), srcset_options: srcset_options)
+
         concat(content_tag(:source, nil, source_tag_opts))
       end
 
-      concat Imgix::Rails::ImageTag.new(@path, source: @source, url_params: @url_params).render
+      concat Imgix::Rails::ImageTag.new(@path, source: @source, url_params: @url_params, srcset_options: @srcset_options).render
     end
   end
+
+  private
+    def validate_opts(opts = {})
+      unsupported_opts = opts.except(:tag_options, :url_params, :srcset_options)
+        if unsupported_opts.length > 0
+          raise "'#{unsupported_opts.keys.join("', '")}' key(s) not supported; use tag_options, url_params, srcset_options."
+        end
+    end
 end

data/lib/imgix/rails/tag.rb

@@ -1,83 +1,30 @@
 require "imgix/rails/url_helper"
+require "action_view"
 
 class Imgix::Rails::Tag
   include Imgix::Rails::UrlHelper
   include ActionView::Helpers
 
-  def initialize(path, source: nil, tag_options: {}, url_params: {}, widths: [])
+  def initialize(path, source: nil, tag_options: {}, url_params: {}, srcset_options: {})
     @path = path
     @source = source
     @tag_options = tag_options
     @url_params = url_params
-    @widths = widths.length > 0 ? widths : target_widths
+    @srcset_options = srcset_options
   end
 
 protected
 
-  def srcset(url_params: @url_params, widths: @widths)
-    if url_params[:w].present?
-      warn "Warning: srcset generation will be refactored in the next major release. "\
-      "Please consult this project\'s documentation when upgrading to better understand the expected behavior."
-    end
-    widths = widths || target_widths
+  def srcset(source: @source, path: @path, url_params: @url_params, srcset_options: @srcset_options, tag_options: @tag_options)
+    params = url_params.clone
 
-    srcset_url_params = url_params.clone
-    srcsetvalue = widths.map do |width|
-      srcset_url_params[:w] = width
+    width_tolerance = ::Imgix::Rails.config.imgix[:srcset_width_tolerance]
+    min_width = @srcset_options[:min_width]
+    max_width = @srcset_options[:max_width]
+    widths = @srcset_options[:widths]
+    disable_variable_quality = @srcset_options[:disable_variable_quality]
+    options = { widths: widths, width_tolerance: width_tolerance, min_width: min_width, max_width: max_width, disable_variable_quality: disable_variable_quality}
 
-      if url_params[:w].present? && url_params[:h].present?
-        srcset_url_params[:h] = (width * (url_params[:h].to_f / url_params[:w])).round
-      end
-
-      "#{ix_image_url(@source, @path, srcset_url_params)} #{width}w"
-    end.join(', ')
-  end
-
-  @@standard_widths = nil
-
-  def compute_standard_widths
-    tolerance = ::Imgix::Rails.config.imgix[:srcset_width_tolerance] || SRCSET_TOLERANCE
-    prev = MINIMUM_SCREEN_WIDTH
-    widths = []
-    while prev <= MAXIMUM_SCREEN_WIDTH do
-      widths.append(2 * (prev/2).round)   # Ensure widths are even
-      prev = prev * (1 + tolerance*2.0)
-    end
-
-    widths
+    ix_image_srcset(@source, @path, params, options)
   end
-
-  def standard_widths
-    return @@standard_widths if @@standard_widths
-
-    @@standard_widths = compute_standard_widths
-    @@standard_widths.freeze
-
-    @@standard_widths
-  end
-
-private
-
-  MINIMUM_SCREEN_WIDTH = 100
-  MAXIMUM_SCREEN_WIDTH = 8192   # Maximum width supported by imgix
-  SRCSET_TOLERANCE = 0.08
-
-  # Return the widths to generate given the input `sizes`
-  # attribute.
-  #
-  # @return {Array} An array of {Fixnum} instances representing the unique `srcset` URLs to generate.
-  def target_widths
-    min_width = @tag_options[:min_width]
-    max_width = @tag_options[:max_width]
-    if min_width || max_width
-      min_width = min_width || MINIMUM_SCREEN_WIDTH
-      max_width = max_width || MAXIMUM_SCREEN_WIDTH
-      widths = standard_widths.select { |w| min_width <= w && w <= max_width }
-    else
-      widths = standard_widths
-    end
-
-    widths
-  end
-
 end

data/lib/imgix/rails/url_helper.rb

@@ -10,28 +10,65 @@ module Imgix
         when 1
           path = args[0]
           source = nil
-          options = {}
+          params = {}
         when 2
           if args[0].is_a?(String) && args[1].is_a?(Hash)
             source = nil
             path = args[0]
-            options = args[1]
+            params = args[1]
           elsif args[0].is_a?(String) && args[1].is_a?(String)
             source = args[0]
             path = args[1]
-            options = {}
+            params = {}
           else
-            raise RuntimeError.new("path and source must be of type String; options must be of type Hash")
+            raise RuntimeError.new("path and source must be of type String; params must be of type Hash")
           end
         when 3
           source = args[0]
           path = args[1]
-          options = args[2]
+          params = args[2]
         else
           raise RuntimeError.new('path missing')
         end
 
-        imgix_client(source).path(path).to_url(options).html_safe
+        imgix_client(source).path(path).to_url(params).html_safe
+      end
+
+      protected
+
+      def ix_image_srcset(*args)
+        validate_configuration!
+
+        case args.size
+        when 1
+          path = args[0]
+          source = nil
+          params = {}
+        when 2
+          if args[0].is_a?(String) && args[1].is_a?(Hash)
+            source = nil
+            path = args[0]
+            params = args[1]
+          elsif args[0].is_a?(String) && args[1].is_a?(String)
+            source = args[0]
+            path = args[1]
+            params = {}
+          else
+            raise RuntimeError.new("path and source must be of type String; params must be of type Hash")
+          end
+        when 3
+          source = args[0]
+          path = args[1]
+          params = args[2]
+        when 4
+          source = args[0]
+          path = args[1]
+          params = args[2]
+          options = args[3]
+        else
+          raise RuntimeError.new('path missing')
+        end
+        imgix_client(source).path(path).to_srcset(options: options, **params).html_safe
       end
 
       private
@@ -44,8 +81,8 @@ module Imgix
         end
 
         if imgix[:source]
-          unless imgix[:source].is_a?(Array) || imgix[:source].is_a?(String)
-            raise ConfigurationError.new("imgix source must be a String or an Array.")
+          unless imgix[:source].is_a?(String)
+            raise ConfigurationError.new("imgix source must be a String.")
           end
         end
 
@@ -54,10 +91,6 @@ module Imgix
             raise ConfigurationError.new(":sources must be a Hash")
           end
         end
-
-        unless !imgix.key?(:shard_strategy) || STRATEGIES.include?(imgix[:shard_strategy])
-          raise ConfigurationError.new("#{imgix[:shard_strategy]} is not supported")
-        end
       end
 
       def imgix_client(source)
@@ -80,8 +113,6 @@ module Imgix
 
         if imgix[:source].is_a?(String)
           opts[:host] = imgix[:source]
-        else
-          opts[:hosts] = imgix[:source]
         end
 
         if imgix.has_key?(:include_library_param)
@@ -92,10 +123,6 @@ module Imgix
           opts[:use_https] = imgix[:use_https]
         end
 
-        if imgix.has_key?(:shard_strategy)
-          opts[:shard_strategy] = imgix[:shard_strategy]
-        end
-
         sources = imgix[:sources] || { imgix[:source] => imgix[:secure_url_token] }
         @imgix_clients = {}
 

data/lib/imgix/rails/version.rb

@@ -1,5 +1,5 @@
 module Imgix
   module Rails
-    VERSION = '3.1.0'
+    VERSION = '4.0.0'
   end
 end

data/lib/imgix/rails/view_helper.rb

@@ -8,12 +8,12 @@ module Imgix
     module ViewHelper
       include UrlHelper
 
-      def ix_image_tag(source=nil, path, tag_options: {}, url_params: {}, widths: [])
-        return Imgix::Rails::ImageTag.new(path, source: source, tag_options: tag_options, url_params: url_params, widths: widths).render
+      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
       end
 
-      def ix_picture_tag(source=nil, path, tag_options: {}, url_params: {}, breakpoints: {}, widths: [])
-        return Imgix::Rails::PictureTag.new(path, source: source, tag_options: tag_options, url_params: url_params, breakpoints: breakpoints, widths: widths).render
+      def ix_picture_tag(source=nil, path, tag_options: {}, url_params: {}, breakpoints: {}, srcset_options: {})
+        return Imgix::Rails::PictureTag.new(path, source: source, tag_options: tag_options, url_params: url_params, breakpoints: breakpoints, srcset_options: srcset_options).render
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: imgix-rails
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Kelly Sutton
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-25 00:00:00.000000000 Z
+date: 2019-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: imgix
@@ -17,20 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -120,6 +114,10 @@ homepage: https://github.com/imgix/imgix-rails
 licenses:
 - BSD-2-Clause
 metadata:
+  bug_tracker_uri: https://github.com/imgix/imgix-rails/issues
+  changelog_uri: https://github.com/imgix/imgix-rails/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/imgix-rails/4.0.0
+  source_code_uri: https://github.com/imgix/imgix-rails/tree/v4.0.0
   allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []