imgix-rails 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1dbb6ad0974d411fd8ab3e7167b211234fc0e96c
-  data.tar.gz: 0c2717ac27d3323badcc525148188c9716336d2b
+SHA256:
+  metadata.gz: '091eb91868dd59d79ea87e37b180a14a8223ff545cd6d72c6e2d2ad07c3187fe'
+  data.tar.gz: 4509b927b6bb48013f709da6e616bd2c79557864498796380c3694ced17e2a49
 SHA512:
-  metadata.gz: 924e0acf93ae7d7a6b824109261d0fd0e5370323655827c346e5b58e2018ad8341f7e013ddf1a1f402df6aca1da67257fdd6b4fad4d1b08d7e60a644b318cc88
-  data.tar.gz: 5271ff9cd004e1fe04c7b6ed2d4682891500b7ccb77e3f39229366d83fe162c95f6f0540976f3d52377556cf068a36e6844a40f1aa75de1697488643169aa5d7
+  metadata.gz: 35e897e5aa09cd7b25156891893d07456ddcc764376cc76022a27561fa69f785e7cbe88d9791b051f3d77bf35738a8e4cbbac73b9bdd6b8d98eb38b8607d5c7a
+  data.tar.gz: c0381d48f5cf4e21b70fa07949d271ce61bb651af4a9d7ef2571ccb274956340f8d2f4060cdc835588ee6823b6083f99210a321f8decd47bffafe0049dbbff73

data/CHANGELOG.md

@@ -3,7 +3,11 @@
 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
+## [4.0.1](https://github.com/imgix/imgix-rb/compare/4.0.0...4.0.1) - June 10, 2020
+
+- fix: update rake version ([#94](https://github.com/imgix/imgix-rails/pull/94))
+
+## [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:
 

data/README.md

@@ -1,54 +1,58 @@
-[![imgix logo](https://assets.imgix.net/imgix-logo-web-2014.pdf?page=2&fm=png&w=200&h=200)](https://imgix.com)
+<!-- ix-docs-ignore -->
+![imgix logo](https://assets.imgix.net/sdk-imgix-logo.svg)
+
+`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=master)](https://travis-ci.org/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/master/LICENSE)
+
+---
+<!-- /ix-docs-ignore -->
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Configuration](#configuration)
+    - [Multi-source configuration](#multi-source-configuration)
+  - [`ix_image_tag`](#iximagetag)
+    - [Fixed image rendering](#fixed-image-rendering)
+  - [`ix_picture_tag`](#ixpicturetag)
+  - [`ix_image_url`](#iximageurl)
+    - [Usage in Sprockets](#usage-in-sprockets)
+- [Using With Image Uploading Libraries](#using-with-image-uploading-libraries)
+  - [Paperclip and CarrierWave](#paperclip-and-carrierwave)
+  - [Refile](#refile)
+  - [Active Storage](#active-storage)
+- [Upgrade Guides](#upgrade-guides)
+  - [3.x to 4.0](#3x-to-40)
+- [Development](#development)
+- [Contributing](#contributing)
+- [Code of Conduct](#code-of-conduct)
 
-# imgix-rails [![Build Status](https://travis-ci.org/imgix/imgix-rails.svg?branch=master)](https://travis-ci.org/imgix/imgix-rails)
-
-`imgix-rails` is a gem designed to make integrating imgix into your Rails app easier. It builds on [imgix-rb](https://github.com/imgix/imgix-rb) to offer a few Rails-specific interfaces.
-
-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 [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)
-  * [Configuration](#configuration)
-  * [ix_image_tag](#ix_image_tag)
-  * [ix_picture_tag](#ix_picture_tag)
-  * [ix_image_url](#ix_image_url)
-    * [Usage in Sprockets](#usage-in-sprockets)
-* [Using With Image Uploading Libraries](#using-with-image-uploading-libraries)
-  * [Paperclip and CarrierWave](#paperclip-and-carrierwave)
-  * [Refile](#refile)
-  * [Active Storage](#activestorage)
-* [Upgrade Guides](#upgrade-guides)
-* [Development](#development)
-* [Contributing](#contributing)
-
-
-<a name="installation"></a>
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
+```rb
 gem 'imgix-rails'
 ```
 
 And then execute:
 
-    $ bundle
-
+```bash
+$ bundle
+```
 
-<a name="usage"></a>
 ## Usage
 
 imgix-rails provides a few different hooks to work with your existing Rails application. All current methods are drop-in replacements for the `image_tag` helper.
 
-<a name="configuration"></a>
 ### Configuration
 
 Before you get started, you will need to define your imgix configuration in your `config/application.rb`, or in an environment-specific configuration file.
 
-```ruby
+```rb
 Rails.application.configure do
   config.imgix = {
     source: "assets.imgix.net"
@@ -62,6 +66,7 @@ The following configuration flags will be respected:
 - `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
+- `include_library_param`: toggles the inclusion of the [`ixlib` parameter](https://github.com/imgix/imgix-rb#what-is-the-ixlib-param-on-every-request). Defaults to `true`.
 
 #### Multi-source configuration
 
@@ -72,7 +77,7 @@ In addition to the standard configuration flags, the following options can be us
 
 Example:
 
-```ruby
+```rb
 Rails.application.configure do
   config.imgix = {
     sources: {
@@ -84,8 +89,7 @@ Rails.application.configure do
 end
 ```
 
-<a name="ix_image_tag"></a>
-### ix_image_tag
+### `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://docs.imgix.com/tutorials/responsive-images-srcset-imgix?_ga=utm_medium=referral&utm_source=sdk&utm_campaign=rails-readme).
 
@@ -133,7 +137,7 @@ Will generate URLs using `assets2.imgix.net` source.
 
 We recommend leveraging this to generate powerful helpers within your application like the following:
 
-```ruby
+```rb
 def profile_image_tag(user)
   ix_image_tag(user.profile_image_url, url_params: { w: 100, h: 200, fit: 'crop' })
 end
@@ -171,8 +175,7 @@ https://assets.imgix.net/image.jpg?ixlib=rails-3.0.2&w=1000&dpr=5&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 }`.
 
-<a name="ix_picture_tag"></a>
-### ix_picture_tag
+### `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.
 
@@ -243,8 +246,7 @@ To generate a `picture` element on a different source:
    ) %>
 ```
 
-<a name="ix_image_url"></a>
-### ix_image_url
+### `ix_image_url`
 
 The `ix_image_url` helper makes it easy to generate a URL to an image in your Rails app.
 
@@ -268,14 +270,13 @@ https://assets2.imgix.net/users/1/avatar.png?w=400&h=300
 
 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.
 
-```ruby
+```rb
 include Imgix::Rails::UrlHelper
 
 puts ix_image_url('/users/1/avatar.png', { w: 400, h: 300 })
 # => https://assets.imgix.net/users/1/avatar.png?w=400&h=300
 ```
 
-<a name="usage-in-sprockets"></a>
 #### 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:
@@ -286,13 +287,10 @@ puts ix_image_url('/users/1/avatar.png', { w: 400, h: 300 })
 }
 ```
 
-<a name="using-with-image-uploading-libraries"></a>
 ## Using With Image Uploading Libraries
 
 imgix-rails plays well with image uploading libraries, because it just requires a URL and optional parameters as arguments. A good way to handle this interaction is by creating helpers that bridge between your uploading library of choice and imgix-rails. Below are examples of how this can work with some common libraries. Please submit an issue if you'd like to see specific examples for another!
 
-
-<a name="paperclip-and-carrierwave"></a>
 ### Paperclip and CarrierWave
 
 Paperclip and CarrierWave can directly provide paths to uploaded images, so we can use them with imgix-rails without a bridge.
@@ -301,8 +299,6 @@ Paperclip and CarrierWave can directly provide paths to uploaded images, so we c
 <%= ix_image_tag(@user.avatar.path, { auto: 'format', fit: 'crop', w: 500}) %>
 ```
 
-
-<a name="refile"></a>
 ### Refile
 
 Since Refile doesn't actually store URLs or paths in the database (instead using a "prefix" + image identifier), the basic setup is slightly different. In this case, we use a couple helpers that bridge between Refile and imgix-rails.
@@ -333,12 +329,12 @@ end
 <%= ix_refile_image_tag(@blog_post, :hero_photo, {auto: 'format', fit: 'crop', w: 500}) %>
 ```
 
-<a name="activestorage"></a>
 ### Active Storage
 
 To set up imgix with ActiveStorage, first ensure that the remote source your ActiveStorage service is pointing to is the same as your imgix source — such as an s3 bucket.
 
-#### config/storage.yml
+**config/storage.yml**
+
 ```yml
 service: S3
 access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %>
@@ -349,15 +345,17 @@ bucket: your_own_bucket
 
 Modify your active_storage.service setting depending on what environment you are using. For example, to use Amazon s3 in production, make the following change:
 
-#### config/environments/production.rb
-```ruby
+**config/environments/production.rb**
+
+```rb
 config.active_storage.service = :amazon
 ```
 
 As you would normally with imgix-rails, configure your application to point to your imgix source:
 
-#### config/application.rb
-```ruby
+**config/application.rb**
+
+```rb
 Rails.application.configure do
       config.imgix = {
         source: your_domain,
@@ -369,12 +367,12 @@ end
 
 Finally, the two can be used together by passing in the filename of the ActiveStorage blob into the imgix-rails helper function:
 
-#### show.html.erb
+**show.html.erb**
+
 ```erb
 <%= ix_image_tag(@your_model.image.key) %>
 ```
 
-<a name="upgrade-guides"></a>
 ## Upgrade Guides
 
 ### 3.x to 4.0
@@ -391,15 +389,12 @@ 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.
 
-<a name="development"></a>
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-
-<a name="contributing"></a>
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/imgix-rails/fork )

data/imgix-rails.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "imgix", "~> 3.0"
 
   spec.add_development_dependency "bundler", ">=1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 12.3"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rspec-rails"
 end

data/lib/imgix/rails/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: imgix-rails
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Kelly Sutton
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-03 00:00:00.000000000 Z
+date: 2020-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: imgix
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -116,8 +116,8 @@ licenses:
 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
+  documentation_uri: https://www.rubydoc.info/gems/imgix-rails/4.0.1
+  source_code_uri: https://github.com/imgix/imgix-rails/tree/v4.0.1
   allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
@@ -134,8 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Makes integrating imgix into your Rails app easier. It builds on imgix-rb