carrierwave-cloudflare 0.1.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfcbaec70caed8b3460a42e0bc1b39d1232fd43e16a5085d13e9f22f4dee3e2c
-  data.tar.gz: 95a8e0999e8b2e95ce197705166488a207e869c58a6cb971de451c0c024794ee
+  metadata.gz: 542a858721ea0a09a74b3aa0bec87cc0a43cee7377fafef29dc99bee23a22cdc
+  data.tar.gz: 73110195e913127f4d496637a69611fb3c183613a0d2154584280b6b9613b82c
 SHA512:
-  metadata.gz: a35397c051afa4e66920e22ce10a3717e789b8f5bf1b41ac970c16814c24f8b5a380a587cb886af919628eaf8aeff60d5dfbab1105d1ba61835eaf2aeeccf0fc
-  data.tar.gz: d28e1eef9d280247abb591258478dec7a0b7e9bc66b3f6354a0037aea37c9f584b32465cb9b04dcc287bde94b65b96808270185e9bec2096447b481cf5a2c34c
+  metadata.gz: d10ba26a72aa5d3c1e7c9e52720920c54918f1cfc5611dc8e9ead91a2d94337cdfd209d0057b7604db4848a4ab902528a38d20190a150c2606ccfc72a113a9e1
+  data.tar.gz: 053fd7d9086726ad54110efdfc5989c820e5a02f109e9af78795d59c613bb4c76522e79be8a65539770e0848a859c61d1f4558ad40f85e658cdec24ab45af521

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,264 @@
+Style/CollectionMethods:
+  Description: Preferred collection methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size
+  Enabled: true
+  PreferredMethods:
+    collect: map
+    collect!: map!
+    find: detect
+    find_all: select
+    reduce: inject
+
+Layout/DotPosition:
+  Description: Checks the position of the dot in multi-line method calls.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains
+  Enabled: true
+  EnforcedStyle: trailing
+  SupportedStyles:
+  - leading
+  - trailing
+
+Naming/PredicateName:
+  Description: Check the names of predicate methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark
+  Enabled: true
+  NamePrefix:
+  - is_
+  - has_
+  - have_
+  ForbiddenPrefixes:
+  - is_
+  Exclude:
+  - spec/**/*
+
+Style/SingleLineMethods:
+  Description: Avoid single-line methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-single-line-methods
+  Enabled: true
+  AllowIfMethodIsEmpty: true
+
+Style/StringLiterals:
+  Description: Checks if uses of quotes match the configured preference.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-string-literals
+  Enabled: true
+  EnforcedStyle: double_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Description: Checks if uses of quotes inside expressions in interpolated strings
+    match the configured preference.
+  Enabled: true
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+
+Metrics/AbcSize:
+  Description: A calculated magnitude based on number of assignments, branches, and
+    conditions.
+  Enabled: false
+  Max: 15
+
+Metrics/ClassLength:
+  Description: Avoid classes longer than 100 lines of code.
+  Enabled: false
+  CountComments: false
+  Max: 100
+
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 100
+  Description: Avoid modules longer than 100 lines of code.
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Description: A complexity metric that is strongly correlated to the number of test
+    cases needed to validate a method.
+  Enabled: false
+  Max: 6
+
+Metrics/MethodLength:
+  Description: Avoid methods longer than 10 lines of code.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods
+  Enabled: false
+  CountComments: false
+  Max: 10
+
+Metrics/ParameterLists:
+  Description: Avoid parameter lists longer than three or four parameters.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#too-many-params
+  Enabled: false
+  Max: 5
+  CountKeywordArgs: true
+
+Metrics/PerceivedComplexity:
+  Description: A complexity metric geared towards measuring complexity for a human
+    reader.
+  Enabled: false
+  Max: 7
+
+Lint/AssignmentInCondition:
+  Description: Don't use assignment in conditions.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition
+  Enabled: false
+  AllowSafeAssignment: true
+
+Lint/EachWithObjectArgument:
+  Description: Check for immutable argument given to each_with_object.
+  Enabled: true
+
+Lint/SuppressedException:
+  Description: Don't suppress exception.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions
+  Enabled: false
+
+Lint/LiteralAsCondition:
+  Description: Checks of literals used in conditions.
+  Enabled: false
+
+Lint/LiteralInInterpolation:
+  Description: Checks for literals used in interpolation.
+  Enabled: false
+
+Style/InlineComment:
+  Description: Avoid inline comments.
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Description: Check the naming of accessor methods for get_/set_.
+  Enabled: false
+
+Style/Alias:
+  Description: Use alias_method instead of alias.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#alias-method
+  Enabled: false
+
+Style/Documentation:
+  Description: Document classes and non-namespace modules.
+  Enabled: false
+
+Style/DoubleNegation:
+  Description: Checks for uses of double negation (!!).
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-bang-bang
+  Enabled: false
+
+Style/EachWithObject:
+  Description: Prefer `each_with_object` over `inject` or `reduce`.
+  Enabled: false
+
+Style/EmptyLiteral:
+  Description: Prefer literals to Array.new/Hash.new/String.new.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#literal-array-hash
+  Enabled: false
+
+Style/ModuleFunction:
+  Description: Checks for usage of `extend self` in modules.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#module-function
+  Enabled: false
+
+Style/OneLineConditional:
+  Description: Favor the ternary operator(?:) over if/then/else/end constructs.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#ternary-operator
+  Enabled: false
+
+Style/PerlBackrefs:
+  Description: Avoid Perl-style regex back references.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers
+  Enabled: false
+
+Style/Send:
+  Description: Prefer `Object#__send__` or `Object#public_send` to `send`, as `send`
+    may overlap with existing methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#prefer-public-send
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Description: Avoid Perl-style global variables.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-cryptic-perlisms
+  Enabled: false
+
+Style/VariableInterpolation:
+  Description: Don't interpolate global, instance and class variables directly in
+    strings.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#curlies-interpolate
+  Enabled: false
+
+Style/WhenThen:
+  Description: Use when x then ... for one-line cases.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#one-line-cases
+  Enabled: false
+
+Style/RaiseArgs:
+  Description: Checks the arguments passed to raise/fail.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#exception-class-messages
+  Enabled: false
+  EnforcedStyle: exploded
+  SupportedStyles:
+  - compact
+  - exploded
+
+Style/SignalException:
+  Description: Checks for proper usage of fail and raise.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#fail-method
+  Enabled: false
+  EnforcedStyle: semantic
+  SupportedStyles:
+  - only_raise
+  - only_fail
+  - semantic
+
+Style/SingleLineBlockParams:
+  Description: Enforces the names of some block params.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#reduce-blocks
+  Enabled: false
+  Methods:
+  - reduce:
+    - a
+    - e
+  - inject:
+    - a
+    - e
+
+Style/GuardClause:
+  Description: Check for conditionals that can be replaced with guard clauses
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals
+  Enabled: false
+  MinBodyLength: 1
+
+Style/IfUnlessModifier:
+  Description: Favor modifier if/unless usage when you have a single-line body.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier
+  Enabled: false
+
+Style/OptionHash:
+  Description: Don't use option hashes when you can use keyword arguments.
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Description: Use `%`-literal delimiters consistently
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-literal-braces
+  Enabled: false
+  PreferredDelimiters:
+    "%": "()"
+    "%i": "()"
+    "%q": "()"
+    "%Q": "()"
+    "%r": "{}"
+    "%s": "()"
+    "%w": "()"
+    "%W": "()"
+    "%x": "()"
+
+Style/TrailingCommaInArguments:
+  Description: Checks for trailing comma in parameter lists and literals.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas
+  Enabled: false
+  EnforcedStyleForMultiline: no_comma
+
+Metrics/BlockLength:
+  Description: Check if the length of a block exceeds some maximum value.
+  Enabled: true
+  Exclude:
+    - spec/**/*

data/README.md

@@ -1,6 +1,10 @@
 # Carrierwave::Cloudflare
 
-This gem provides a simple wrapper for transformation images via Cloudflare
+[![Tests](https://github.com/resume-io/carrierwave-cloudflare/actions/workflows/run-specs.yml/badge.svg?branch=master)](https://github.com/resume-io/carrierwave-cloudflare/actions/workflows/run-specs.yml)
+[![Gem Version](https://badge.fury.io/rb/carrierwave-cloudflare.svg)](https://badge.fury.io/rb/carrierwave-cloudflare)
+
+This gem integrates CarrierWave with [Cloudflare Image Resizing](https://developers.cloudflare.com/images/)
+
 
 ## Installation
 
@@ -28,8 +32,8 @@ class BaseUploader < CarrierWave::Uploader::Base
 end
 ```
 
+Use `cdn_transform` for define Cloudflare's version (this means that now the file will not be stored on the, but will be transformed on the cloudflare side)
 
-Define `virtual` version in some uploader:
 ```ruby
 class AvatarUploader < BaseUploader
   version(:medium) do
@@ -37,14 +41,13 @@ class AvatarUploader < BaseUploader
   end
 end
 
-
-User.avatar.medium # CarrierWave::Uploader
-User.avatar.url # "https://s3.resume.io/users/avatar/1.jpg"
-User.avatar.medium_url   # "https://s3.resume.io/cdn-cgi/.../users/avatar/1.jpg"
-User.avatar.medium.url   # "https://s3.resume.io/cdn-cgi/.../users/avatar/1.jpg"
-User.avatar.url(:medium) # "https://s3.resume.io/cdn-cgi/.../users/avatar/1.jpg"
-User.avatar.medium.url(dpr: 1)
-User.avatar.resize(width: 1200, fit: :cover).url
+user = User.find(some_id)
+user.avatar.medium # CarrierWave::Uploader
+user.avatar.url # "https://s3.your-website.com/users/avatar/1.jpg"
+user.avatar.medium_url   # "https://s3.your-website.com/cdn-cgi/width=100,height=100,dpr=2/users/avatar/1.jpg"
+user.avatar.url(:medium) # "https://s3.your-website.com/cdn-cgi/width=100,height=100,dpr=2/users/avatar/1.jpg"
+user.avatar.medium.url(dpr: 1) # "https://s3.your-website.com/cdn-cgi/width=100,height=100,dpr=1/users/avatar/1.jpg"
+user.avatar.resize(width: 1200, fit: :cover).url # "https://s3.your-website.com/cdn-cgi/width=1200,height=100,dpr=2,fit=cover/users/avatar/1.jpg"
 ```
 
 ### Options
@@ -53,7 +56,7 @@ Supported options:
 
 `width`, `height`, `dpr`, `fit`, `gravity`, `quality`, `format`, `onerror`, `metadata`
 
-See details in Cloudflare [documentation](https://developers.cloudflare.com/images/about)
+See details in Cloudflare [documentation](https://developers.cloudflare.com/images/url-format)
 
 Also, you can define default options (supports all options described above)
 
@@ -63,21 +66,71 @@ class BaseUploader < CarrierWave::Uploader::Base
 end
 ```
 
-## Development
+### In development env
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+In development, you don't need to generate URLs for Cloudflare, because they will not work and therefore you need to disable the Cloudflare transform
 
-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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+``` ruby
+CarrierWave::Cloudflare.configure do |config|
+  config.cloudflare_transform(false)
+end
+```
+
+`cloudflare_transform: false` disables links generation and put all Cloudflare's arguments into query string (for easy debugging)
 
-## Contributing
+e.g:
+
+```
+/1.jpg?cdn-cgi=width-11.height-300.fit-pad
+```
+
+## Rails views helpers
+
+### cdn_transformed(url, **options)
+Returns an image URL with CDN transformations applied. Can process already transformed URLs, in that case the options will be merged together.
+
+```ruby
+cdn_transformed('/img.jpg', width: 400)
+# => '/cdn-cgi/image/width=400/img.jpg'
+
+cdn_transformed('/cdn-cgi/image/width=100,fit=pad/img.jpg', width: 333)
+# => '/cdn-cgi/image/width=333,fit=pad/img.jpg'
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/resume-io/carrierwave-cloudflare. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/resume-io/carrierwave-cloudflare/blob/master/CODE_OF_CONDUCT.md).
 
+### hidpi_image_tag(url, dprs: nil, **options)
 
-## License
+Returns an image tag with with scaled variations (via `srcset`) attribute for devices with different DPR values.
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## Code of Conduct
+The transformation of the original image should be specified via options.
 
-Everyone interacting in the Carrierwave::Cloudflare project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/resume-io/carrierwave-cloudflare/blob/master/CODE_OF_CONDUCT.md).
+```ruby
+hidpi_image_tag('/bird.jpg', width: 400, drps: [1, 2])
+# => <img srcset="/cdn-cgi/image/width=400,dpr=1/img.jpg 1x, /cdn-cgi/image/width=400,dpr=2/img.jpg 2x" src="/cdn-cgi/image/width=400/img.jpg" />
+```
+
+
+### responsive_image_tag(url, width:, sizes: nil, dprs: [1, 2], **options)
+
+Returns a reponsive image tag with variations.
+
+```ruby
+responsive_image_tag('/bird.jpg', width: 1200, sizes: { phone: 600, tablet: 800 })
+
+# => <img srcset="/cdn-cgi/image/width=1200,dpr=0.5/bird.jpg 600w,
+#                  /cdn-cgi/image/width=1200,dpr=1.0/bird.jpg 1200w,
+#                  /cdn-cgi/image/width=1200,dpr=0.67/bird.jpg 800w,
+#                  /cdn-cgi/image/width=1200,dpr=1.33/bird.jpg 1600w,
+#                  /cdn-cgi/image/width=1200,dpr=2.0/bird.jpg 2400w"
+#                  sizes="(max-width: 767px) 600px, (max-width: 1023px) 800px, 1200px"
+#                  src="/cdn-cgi/image/width=1200/bird.jpg" />
+
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/carrierwave-cloudflare.gemspec

@@ -1,36 +1,36 @@
 # frozen_string_literal: true
 
-require_relative 'lib/carrierwave/cloudflare/version'
+require_relative "lib/carrierwave/cloudflare/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'carrierwave-cloudflare'
-  spec.version       = Carrierwave::Cloudflare::VERSION
-  spec.authors       = ['Mark Frost', 'Alexey Taktarov']
-  spec.email         = ['cheerful.mf@gmail.com']
+  spec.name          = "carrierwave-cloudflare"
+  spec.version       = CarrierWave::Cloudflare::VERSION
+  spec.authors       = ["Mark Frost", "Alexey Taktarov"]
+  spec.email         = ["cheerful.mf@gmail.com"]
 
-  spec.summary       = 'Wrapper for cloudflare transforming images'
-  spec.homepage      = 'https://github.com/resume-io/carrierwave-cloudflare'
-  spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.summary       = "Wrapper for cloudflare transforming images"
+  spec.homepage      = "https://github.com/resume-io/carrierwave-cloudflare"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/resume-io/carrierwave-cloudflare'
-  spec.metadata['changelog_uri'] = 'https://github.com/resume-io/carrierwave-cloudflare/blob/master/CHANGELOG.md'
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/resume-io/carrierwave-cloudflare"
+  spec.metadata["changelog_uri"] = "https://github.com/resume-io/carrierwave-cloudflare/blob/master/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = 'exe'
+  spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.add_development_dependency 'activesupport', '~> 5.2'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rack', '~> 2.0'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-
-  spec.add_dependency 'carrierwave', '~> 1.3'
+  spec.add_development_dependency "actionview", "~> 5.2"
+  spec.add_development_dependency "activesupport", "~> 5.2"
+  spec.add_development_dependency "carrierwave", "~> 1.3"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rack", "~> 2.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

data/lib/carrierwave/cloudflare.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'active_support'
+require "active_support"
 
-require 'carrierwave/cloudflare/version'
+require "carrierwave/cloudflare/version"
 
 module CarrierWave
   module Cloudflare
@@ -72,7 +72,7 @@ module CarrierWave
     def resize(**options)
       # build temporary uploader
       uploader = self.class.dup
-      self.class.const_set("Uploader#{uploader.object_id}".tr('-', '_'), uploader)
+      self.class.const_set("Uploader#{uploader.object_id}".tr("-", "_"), uploader)
       uploader.version_options = { cdn_transform: options }
 
       # init the instance uploader and set parent_version
@@ -102,4 +102,4 @@ module CarrierWave
   end
 end
 
-require_relative 'cloudflare/url'
+require "carrierwave/cloudflare/url"

data/lib/carrierwave/cloudflare/action_view/responsive_images_helper.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module CarrierWave
+  module Cloudflare
+    module ActionView
+      module ResponsiveImagesHelper
+        CDN_TRANSFORM_KEYS = CarrierWave::Cloudflare::URL::ALLOWED_OPTIONS.map(&:to_sym)
+
+        # Returns an image URL with CDN transformations applied.
+        # Can process already transformed URLs, in that case the
+        # options will be merged together.
+        #
+        # ==== Examples
+        #
+        #   cdn_transformed('/img.jpg', width: 400)
+        #   # => '/cdn-cgi/image/width=400/img.jpg'
+        #
+        #   cdn_transformed('/cdn-cgi/image/width=100,fit=pad/img.jpg', width: 333)
+        #   # => '/cdn-cgi/image/width=333,fit=pad/img.jpg'
+        #
+        def cdn_transformed(url, **options)
+          base_options = BaseUploader.default_cdn_options
+
+          CarrierWave::Cloudflare::URL.transform(
+            url,
+            **base_options,
+            **options
+          )
+        end
+
+        # Returns an image tag with with scaled variations (via `srcset`)
+        # attribute for devices with different DPR values.
+        #
+        # The transformation of the original image should be specified via
+        # options.
+        #
+        # ==== Examples
+        #
+        #   hidpi_image_tag('/bird.jpg', width: 400, height: 100, alt: 'A bird')
+        #
+        #   hidpi_image_tag('/bird.jpg', width: 400, drps: [1, 2])
+        #
+        def hidpi_image_tag(url, dprs: nil, **options)
+          url = url.url if url.is_a?(CarrierWave::Uploader)
+          transform, rest = split_cdn_transform_options(options)
+
+          image_tag(
+            cdn_transformed(url, **transform),
+            srcset: hidpi_image_srcset(url, dprs: dprs, **transform),
+            **rest
+          )
+        end
+
+        # Like #hidpi_image_tag, but returns an scrset attribute value.
+        def hidpi_image_srcset(url, dprs: nil, **options)
+          return nil unless url.present?
+
+          url = url.url if url.is_a?(CarrierWave::Uploader)
+
+          (dprs || [1, 2]).map do |dpr|
+            [cdn_transformed(url, dpr: dpr, **options), "#{dpr}x"].join(" ")
+          end.join(", ")
+        end
+
+        # Returns a reponsive image tag with variations.
+        #
+        # ==== Examples
+        #
+        #   responsive_image_tag('/bird.jpg', width: 1200, sizes:
+        #                        { phone: 600, tablet: 800 })
+        #
+        def responsive_image_tag(url, width:, sizes: nil, dprs: [1, 2], **options)
+          url = url.url if url.is_a?(CarrierWave::Uploader)
+
+          if sizes.nil?
+            return hidpi_image_tag(url, **options)
+          end
+
+          sizes[:default] = width
+
+          breakpoints = {
+            phone: "(max-width: 767px)",
+            mobile: "(max-width: 767px)", # an alias for :phone
+            tablet: "(max-width: 1023px)",
+            laptop: "(max-width: 1279px)",
+            desktop: "(min-width: 1280px)",
+            default: nil
+          }
+
+          sizes_attr = breakpoints.map do |device, media|
+            next nil unless sizes[device]
+
+            [media, "#{sizes[device]}px"].compact.join(" ")
+          end.compact.join(", ")
+
+          transform, rest = split_cdn_transform_options(options)
+          base_version = cdn_transformed(url, width: width, **transform)
+
+          # construct the array of available variation sizes in `srcset`
+          variations = scrset_variations_from_breakpoints(sizes, dprs: dprs)
+
+          srcset = variations.map do |size|
+            scale = (size.to_f / width).round(2)
+            [cdn_transformed(url, width: width, **transform, dpr: scale), "#{size}w"]
+          end
+
+          image_tag(
+            base_version,
+            srcset: srcset,
+            sizes: sizes_attr,
+            **rest
+          )
+        end
+
+        def scrset_variations_from_breakpoints(breakpoints, dprs:, granularity: 180)
+          # [300, 900] => [300, 600, 900, 1800]
+          doubled = breakpoints.values.product(dprs).map { |s, d| (s * d).round }
+
+          # [100, 101, 150, 250, 320] => [100, 250, 320]
+          doubled.uniq { |s| s / granularity }
+        end
+
+        # returns a pair of transformation options and other options
+        def split_cdn_transform_options(options)
+          [
+            options.slice(*CDN_TRANSFORM_KEYS),
+            options.except(*CDN_TRANSFORM_KEYS)
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/carrierwave/cloudflare/railtie.rb

@@ -0,0 +1,15 @@
+require "rails/railtie"
+
+module CarrierWave
+  module Cloudflare
+    class Railtie < ::Rails::Railtie
+      initializer "carrierwave-cloudflare.action_view" do |_app|
+        ActiveSupport.on_load :action_view do
+          require "carrierwave/cloudflare/action_view/responsive_images_helper"
+
+          include CarrierWave::Cloudflare::ActionView::ResponsiveImagesHelper
+        end
+      end
+    end
+  end
+end

data/lib/carrierwave/cloudflare/url.rb

@@ -1,86 +1,90 @@
 # frozen_string_literal: true
 
-require_relative 'url/query_string'
+require "carrierwave/cloudflare/url/query_string"
 
-module CarrierWave::Cloudflare
-  module URL
-    ALLOWED_OPTIONS = %w[width height dpr fit gravity quality format onerror metadata].freeze
+module CarrierWave
+  module Cloudflare
+    module URL
+      ALLOWED_OPTIONS = %w[width height dpr fit gravity quality format onerror metadata].freeze
 
-    module_function
+      module_function
 
-    def should_modify_path?
-      ::CarrierWave::Cloudflare.cloudflare_transform
-    end
+      def should_modify_path?
+        ::CarrierWave::Cloudflare.cloudflare_transform
+      end
 
-    def extract(url)
-      uri = URI.parse(url)
-      options = {}
+      def extract(url)
+        uri = URI.parse(url)
+        options = {}
 
-      if should_modify_path?
-        if %r{/cdn-cgi/image/([^/]+)(/.*)} =~ uri.path
-          formatted = $LAST_MATCH_INFO[1]
-          original_path = $LAST_MATCH_INFO[2]
+        if should_modify_path?
+          if %r{/cdn-cgi/image/([^/]+)(/.*)} =~ uri.path
+            formatted = $LAST_MATCH_INFO[1]
+            original_path = $LAST_MATCH_INFO[2]
 
-          options = parse_options(formatted)
-          uri.path = original_path
-        end
-      else
-        query = QueryString.new(uri.query)
+            options = parse_options(formatted)
+            uri.path = original_path
+          end
+        else
+          query = QueryString.new(uri.query)
 
-        if query.key?('cdn-cgi')
-          options = parse_options(query['cdn-cgi'], separator: '.', assigner: '-')
+          if query.key?("cdn-cgi")
+            options = parse_options(query["cdn-cgi"], separator: ".", assigner: "-")
+          end
         end
-      end
 
-      [uri, options]
-    end
+        [uri, options]
+      end
 
-    def transform(url, **options)
-      uri, existing_opts = extract(url)
-      options = existing_opts.merge(options.transform_keys(&:to_s))
+      def transform(url, **options)
+        uri, existing_opts = extract(url)
+        options = existing_opts.merge(options.transform_keys(&:to_s))
 
-      pairs = sanitized_options(options)
+        pairs = sanitized_options(options)
 
-      if pairs.empty?
-        url
-      else
-        append_options!(uri, pairs)
-        uri.to_s
+        if pairs.empty?
+          url
+        else
+          append_options!(uri, pairs)
+          uri.to_s
+        end
       end
-    end
 
-    def append_options!(uri, options)
-      if should_modify_path?
-        segment = '/cdn-cgi/image/' + options.map { |k, v| "#{k}=#{v}" }.join(',')
-        uri.path = segment + uri.path
-      else
-        uri.query = QueryString.new(uri.query).tap do |params|
-          # the format is "width-500.height.200", only safe symbols are used
-          param_with_options = options.map { |k, v| "#{k}-#{v}" }.join('.')
-
-          params['cdn-cgi'] = param_with_options
-        end.to_query
-      end
-    end
+      def append_options!(uri, options)
+        if should_modify_path?
+          query = options.map { |k, v| "#{k}=#{v}" }.join(",")
+
+          segment = "/cdn-cgi/image/#{query}"
+          uri.path = segment + uri.path
+        else
+          uri.query = QueryString.new(uri.query).tap do |params|
+            # the format is "width-500.height.200", only safe symbols are used
+            param_with_options = options.map { |k, v| "#{k}-#{v}" }.join(".")
 
-    def sanitized_options(options)
-      ordered = options.map do |k, v|
-        idx = ALLOWED_OPTIONS.index(k)
-        [idx, [k, v]]
+            params["cdn-cgi"] = param_with_options
+          end.to_query
+        end
       end
 
-      filtered = ordered.select { |i,| i }.sort
+      def sanitized_options(options)
+        ordered = options.map do |k, v|
+          idx = ALLOWED_OPTIONS.index(k)
+          [idx, [k, v]]
+        end
+
+        filtered = ordered.select { |i,| i }.sort
 
-      filtered.map do |_, (k, v)|
-        v = v.join('x') if v.is_a?(Array)
-        [k, v]
+        filtered.map do |_, (k, v)|
+          v = v.join("x") if v.is_a?(Array)
+          [k, v]
+        end
       end
-    end
 
-    # converts strings "w=foo,h=bar" into hashes
-    def parse_options(str, separator: ',', assigner: '=')
-      kv = str.split(separator).map { |s| s.strip.split(assigner) }
-      Hash[kv]
+      # converts strings "w=foo,h=bar" into hashes
+      def parse_options(str, separator: ",", assigner: "=")
+        kv = str.split(separator).map { |s| s.strip.split(assigner) }
+        Hash[kv]
+      end
     end
   end
 end

data/lib/carrierwave/cloudflare/url/query_string.rb

@@ -1,26 +1,30 @@
 # frozen_string_literal: true
 
-require 'rack/utils'
+require "rack/utils"
 
-module CarrierWave::Cloudflare::URL
-  class QueryString < Hash
-    Parser = Object.new.tap do |obj|
-      obj.extend(Rack::Utils)
+module CarrierWave
+  module Cloudflare
+    module URL
+      class QueryString < Hash
+        Parser = Object.new.tap do |obj|
+          obj.extend(Rack::Utils)
 
-      # these methods are private in Rack::Utils
-      obj.singleton_class.instance_eval { public :build_query, :parse_query }
-    end
+          # these methods are private in Rack::Utils
+          obj.singleton_class.instance_eval { public :build_query, :parse_query }
+        end
 
-    def initialize(query = '')
-      super()
-      merge!(Parser.parse_query(query))
-    end
+        def initialize(query = "")
+          super()
+          merge!(Parser.parse_query(query))
+        end
 
-    def to_query
-      result = Parser.build_query(self)
-      result unless result.empty?
-    end
+        def to_query
+          result = Parser.build_query(self)
+          result unless result.empty?
+        end
 
-    alias to_s to_query
+        alias to_s to_query
+      end
+    end
   end
 end

data/lib/carrierwave/cloudflare/version.rb

@@ -1,5 +1,7 @@
-module Carrierwave
+# frozen_string_literal: true
+
+module CarrierWave
   module Cloudflare
-    VERSION = "0.1.1"
+    VERSION = "0.3.1"
   end
 end

metadata

@@ -1,16 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: carrierwave-cloudflare
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Mark Frost
 - Alexey Taktarov
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-22 00:00:00.000000000 Z
+date: 2021-08-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -25,6 +39,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: carrierwave
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -81,36 +109,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: carrierwave
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-description: 
+description:
 email:
 - cheerful.mf@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/publish-gem.yml"
 - ".github/workflows/run-specs.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -118,6 +130,8 @@ files:
 - bin/setup
 - carrierwave-cloudflare.gemspec
 - lib/carrierwave/cloudflare.rb
+- lib/carrierwave/cloudflare/action_view/responsive_images_helper.rb
+- lib/carrierwave/cloudflare/railtie.rb
 - lib/carrierwave/cloudflare/url.rb
 - lib/carrierwave/cloudflare/url/query_string.rb
 - lib/carrierwave/cloudflare/version.rb
@@ -128,7 +142,7 @@ metadata:
   homepage_uri: https://github.com/resume-io/carrierwave-cloudflare
   source_code_uri: https://github.com/resume-io/carrierwave-cloudflare
   changelog_uri: https://github.com/resume-io/carrierwave-cloudflare/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -143,8 +157,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Wrapper for cloudflare transforming images
 test_files: []

data/.github/workflows/publish-gem.yml

@@ -1,49 +0,0 @@
-name: Publish Gem
-
-on:
-  # Manually publish
-  workflow_dispatch:
-  # Alternatively, publish whenever changes are merged to the `main` branch.
-  push:
-    branches: "*"
-  pull_request:
-    branches: "*"
-
-jobs:
-  build:
-    name: Build + Publish
-    runs-on: ubuntu-latest
-    permissions:
-      packages: write
-      contents: read
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Ruby 2.6
-        uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
-        with:
-          ruby-version: 2.6
-      - run: bundle install
-
-      # - name: Publish to GPR
-      #   run: |
-      #     mkdir -p $HOME/.gem
-      #     touch $HOME/.gem/credentials
-      #     chmod 0600 $HOME/.gem/credentials
-      #     printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-      #     gem build *.gemspec
-      #     gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
-      #   env:
-      #     GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
-      #     OWNER: ${{ github.repository_owner }}
-
-      - name: Publish to RubyGems
-        run: |
-          mkdir -p $HOME/.gem
-          touch $HOME/.gem/credentials
-          chmod 0600 $HOME/.gem/credentials
-          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-          gem build *.gemspec
-          gem push *.gem
-        env:
-          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at cheerful.mf@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [https://contributor-covenant.org/version/1/4][version]
-
-[homepage]: https://contributor-covenant.org
-[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile.lock

@@ -1,67 +0,0 @@
-PATH
-  remote: .
-  specs:
-    carrierwave-cloudflare (0.1.1)
-      carrierwave (~> 1.3)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (5.2.3)
-      activesupport (= 5.2.3)
-    activesupport (5.2.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    carrierwave (1.3.2)
-      activemodel (>= 4.0.0)
-      activesupport (>= 4.0.0)
-      mime-types (>= 1.16)
-      ssrf_filter (~> 1.0)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.6)
-    diff-lcs (1.4.4)
-    i18n (1.8.5)
-      concurrent-ruby (~> 1.0)
-    method_source (1.0.0)
-    mime-types (3.3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2020.1104)
-    minitest (5.14.1)
-    pry (0.13.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    rack (2.2.3)
-    rake (13.0.3)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.1)
-    ssrf_filter (1.0.7)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activesupport (~> 5.2)
-  carrierwave-cloudflare!
-  pry
-  rack (~> 2.0)
-  rake
-  rspec
-
-BUNDLED WITH
-   2.1.4