imgix 3.2.1 → 4.0.1

data/lib/imgix/path.rb

@@ -1,44 +1,20 @@
 # frozen_string_literal: true
 
-require 'base64'
-require 'cgi/util'
-require 'erb'
-require 'imgix/param_helpers'
+require "base64"
+require "cgi/util"
+require "erb"
 
 module Imgix
   class Path
-    include ParamHelpers
 
-    ALIASES = {
-      width:           :w,
-      height:          :h,
-      rotation:        :rot,
-      noise_reduction: :nr,
-      sharpness:       :sharp,
-      exposure:        :exp,
-      vibrance:        :vib,
-      saturation:      :sat,
-      brightness:      :bri,
-      contrast:        :con,
-      highlight:       :high,
-      shadow:          :shad,
-      gamma:           :gam,
-      pixelate:        :px,
-      halftone:        :htn,
-      watermark:       :mark,
-      text:            :txt,
-      format:          :fm,
-      quality:         :q
-    }
-
-    def initialize(prefix, secure_url_token, path = '/')
+    def initialize(prefix, secure_url_token, path = "/")
       @prefix = prefix
       @secure_url_token = secure_url_token
       @path = path
       @options = {}
 
       @path = CGI.escape(@path) if /^https?/ =~ @path
-      @path = "/#{@path}" if @path[0] != '/'
+      @path = "/#{@path}" if @path[0] != "/"
       @target_widths = TARGET_WIDTHS.call(DEFAULT_WIDTH_TOLERANCE, MIN_WIDTH, MAX_WIDTH)
     end
 
@@ -49,7 +25,7 @@ module Imgix
       url = @prefix + path_and_params
 
       if @secure_url_token
-        url += (has_query? ? '&' : '?') + "s=#{signature}"
+        url += (has_query? ? "&" : "?") + "s=#{signature}"
       end
 
       @options = prev_options
@@ -61,47 +37,97 @@ module Imgix
       self
     end
 
+    def ixlib(lib_version)
+      @options[:ixlib] = lib_version
+    end
+
+    def ixlib=(lib_version)
+      @options[:ixlib] = lib_version
+    end
+
+    def to_srcset(options: {}, **params)
+      prev_options = @options.dup
+      @options.merge!(params)
+
+      width = @options[:w]
+      height = @options[:h]
+      aspect_ratio = @options[:ar]
+
+      srcset = if width || height
+          build_dpr_srcset(options: options, params: @options)
+        else
+          build_srcset_pairs(options: options, params: @options)
+        end
+
+      @options = prev_options
+      srcset
+    end
+
+    ALIASES = {
+      width:           :w,
+      height:          :h,
+      rotation:        :rot,
+      noise_reduction: :nr,
+      sharpness:       :sharp,
+      exposure:        :exp,
+      vibrance:        :vib,
+      saturation:      :sat,
+      brightness:      :bri,
+      contrast:        :con,
+      highlight:       :high,
+      shadow:          :shad,
+      gamma:           :gam,
+      pixelate:        :px,
+      halftone:        :htn,
+      watermark:       :mark,
+      text:            :txt,
+      format:          :fm,
+      quality:         :q,
+      fill_color:      :fillcolor
+    }.freeze
+
+    # Define query parameters on a Path (via method_missing).
+    # Normally, when overriding method_missing, it is a best practice
+    # to fall back to super, but this method works differently.
+    #
+    # method_missing intercepts messages sent to objects of this class
+    # and acts as a getter, setter, and deleter. If there are no args,
+    # e.g. `path.width`, then this method acts like a getter.
+    #
+    # Likewise, if the first argument is nil and the method name exists
+    # as a key in @options, e.g. `path.param_name = nil`, then this
+    # method acts like a deleter and the `param_name` is removed from
+    # the list of @options.
+    #
+    # Finally, in _all_ other cases, the `method` name is used as the
+    # `key` and the `*args` are used as the value.
     def method_missing(method, *args, &block)
       key = method.to_s.gsub('=', '')
-      if args.length == 0
+
+      if args.length == 0 # Get, or
         return @options[key]
-      elsif args.first.nil? && @options.has_key?(key)
+      elsif args.first.nil? && @options.has_key?(key) # Delete, or
         @options.delete(key) and return self
       end
 
-      @options[key] = args.join(',')
+      @options[key] = args.join(',') # Set the option.
       self
     end
 
+    # Use ALIASES to define setters for a subset of imgix parameters.
+    # E.g. `path.width(100)` would result in `send(:w, [100])`.
     ALIASES.each do |from, to|
       define_method from do |*args|
         self.send(to, *args)
       end
 
+      # E.g. `path.width = 100` would result in `send(":w=", [100])`.
       define_method "#{from}=" do |*args|
         self.send("#{to}=", *args)
         return self
       end
     end
 
-    def to_srcset(options: {}, **params)
-      prev_options = @options.dup
-      @options.merge!(params)
-
-      width = @options['w'.to_sym]
-      height = @options['h'.to_sym]
-      aspect_ratio = @options['ar'.to_sym]
-
-      if ((width) || (height && aspect_ratio))
-        srcset = build_dpr_srcset(options: options, params:@options)
-      else
-        srcset = build_srcset_pairs(options: options, params: @options)
-      end
-
-      @options = prev_options
-      srcset
-    end
-    
     private
 
     def signature
@@ -121,33 +147,34 @@ module Imgix
         else
           escaped_key << "=" << ERB::Util.url_encode(val.to_s)
         end
-      end.join('&')
+      end.join("&")
     end
 
     def has_query?
-      query.length > 0
+      !query.empty?
     end
 
     def build_srcset_pairs(options:, params:)
-      srcset = ''
+      srcset = ""
 
-      widths = options['widths'.to_sym] || []
-      width_tolerance = options['width_tolerance'.to_sym] ||  DEFAULT_WIDTH_TOLERANCE
-      min_srcset = options['min_width'.to_sym] || MIN_WIDTH
-      max_srcset = options['max_width'.to_sym] || MAX_WIDTH
+      widths = options[:widths] || []
+      width_tolerance = options[:width_tolerance] || DEFAULT_WIDTH_TOLERANCE
+      min_width = options[:min_width] || MIN_WIDTH
+      max_width = options[:max_width] || MAX_WIDTH
 
       if !widths.empty?
         validate_widths!(widths)
         srcset_widths = widths
-      elsif width_tolerance != DEFAULT_WIDTH_TOLERANCE or min_srcset != MIN_WIDTH or max_srcset != MAX_WIDTH
-        validate_range!(min_srcset, max_srcset)
-        srcset_widths = TARGET_WIDTHS.call(width_tolerance, min_srcset, max_srcset)
+      elsif width_tolerance != DEFAULT_WIDTH_TOLERANCE || min_width != MIN_WIDTH || max_width != MAX_WIDTH
+        validate_range!(min_width, max_width)
+        validate_width_tolerance!(width_tolerance)
+        srcset_widths = TARGET_WIDTHS.call(width_tolerance, min_width, max_width)
       else
         srcset_widths = @target_widths
       end
 
-      for width in srcset_widths do
-        params['w'.to_sym] = width
+      srcset_widths.each do |width|
+        params[:w] = width
         srcset += "#{to_url(params)} #{width}w,\n"
       end
 
@@ -155,20 +182,18 @@ module Imgix
     end
 
     def build_dpr_srcset(options:, params:)
-      srcset = ''
+      srcset = ""
 
-      disable_variable_quality = options['disable_variable_quality'.to_sym] || false
+      disable_variable_quality = options[:disable_variable_quality] || false
       validate_variable_qualities!(disable_variable_quality)
 
-      target_ratios = [1,2,3,4,5]
-      quality = params['q'.to_sym]
+      target_ratios = [1, 2, 3, 4, 5]
+      quality = params[:q]
 
-      for ratio in target_ratios do
-        params['dpr'.to_sym] = ratio
+      target_ratios.each do |ratio|
+        params[:dpr] = ratio
 
-        unless disable_variable_quality
-          params['q'.to_sym] = quality || DPR_QUALITY[ratio]
-        end
+        params[:q] = quality || DPR_QUALITY[ratio] unless disable_variable_quality
 
         srcset += "#{to_url(params)} #{ratio}x,\n"
       end
@@ -176,30 +201,31 @@ module Imgix
       srcset[0..-3]
     end
 
+    def validate_width_tolerance!(width_tolerance)
+      width_increment_error = "error: `width_tolerance` must be a positive `Numeric` value"
+
+      raise ArgumentError, width_increment_error if !width_tolerance.is_a?(Numeric) || width_tolerance <= 0
+    end
+
     def validate_widths!(widths)
-      unless widths.is_a? Array
-        raise ArgumentError, "The widths argument must be passed a valid array of integers"
-      else
-        positive_integers = widths.all? {|i| i.is_a?(Integer) and i > 0}
-        unless positive_integers
-          raise ArgumentError, "A custom widths array must only contain positive integer values"  
-        end
-      end
+      widths_error = "error: `widths` must be an array of positive `Numeric` values"
+      raise ArgumentError, widths_error unless widths.is_a?(Array)
+
+      all_positive_integers = widths.all? { |i| i.is_a?(Integer) && i > 0 }
+      raise ArgumentError, widths_error unless all_positive_integers
     end
 
-    def validate_range!(min_srcset, max_srcset)
-      if min_srcset.is_a? Numeric and max_srcset.is_a? Numeric
-        unless min_srcset > 0 and max_srcset > 0
-          raise ArgumentError, "The min and max arguments must be passed positive Numeric values"
-        end
-      else
-        raise ArgumentError, "The min and max arguments must be passed positive Numeric values"
-      end
+    def validate_range!(min_width, max_width)
+      range_numeric_error = "error: `min_width` and `max_width` must be positive `Numeric` values"
+      raise ArgumentError, range_numeric_error unless min_width.is_a?(Numeric) && max_width.is_a?(Numeric)
+
+      raise ArgumentError, range_numeric_error unless min_width > 0 && max_width > 0
     end
 
-    def validate_variable_qualities!(disable_variable_quality)
-      unless disable_variable_quality.is_a?(TrueClass) || disable_variable_quality.is_a?(FalseClass)
-        raise ArgumentError, "The disable_variable_quality argument must be passed a Boolean value"
+    def validate_variable_qualities!(disable_quality)
+      disable_quality_error = "error: `disable_quality` must be a Boolean value"
+      unless disable_quality.is_a?(TrueClass) || disable_quality.is_a?(FalseClass)
+        raise ArgumentError, disable_quality_error
       end
     end
   end

data/lib/imgix/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Imgix
-  VERSION = '3.2.1'
+  VERSION = "4.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: imgix
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 4.0.1
 platform: ruby
 authors:
 - Kelly Sutton
@@ -10,39 +10,11 @@ authors:
 - Antony Denyer
 - Paul Straw
 - Sherwin Heydarbeygi
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-20 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: addressable
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2021-03-25 00:00:00.000000000 Z
+dependencies: []
 description: Easily create and sign imgix URLs.
 email:
 - kelly@imgix.com
@@ -56,6 +28,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Contributing.markdown
@@ -66,24 +39,17 @@ files:
 - imgix.gemspec
 - lib/imgix.rb
 - lib/imgix/client.rb
-- lib/imgix/param_helpers.rb
 - lib/imgix/path.rb
 - lib/imgix/version.rb
-- test/test_helper.rb
-- test/units/domains_test.rb
-- test/units/path_test.rb
-- test/units/purge_test.rb
-- test/units/srcset_test.rb
-- test/units/url_test.rb
 homepage: https://github.com/imgix/imgix-rb
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/imgix/imgix-rb/issues
-  changelog_uri: https://github.com/imgix/imgix-rb/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/imgix/3.2.1
-  source_code_uri: https://github.com/imgix/imgix-rb/tree/3.2.1
-post_install_message: 
+  changelog_uri: https://github.com/imgix/imgix-rb/blob/main/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/imgix/4.0.1
+  source_code_uri: https://github.com/imgix/imgix-rb/tree/4.0.1
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -98,15 +64,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Official Ruby Gem for easily creating and signing imgix URLs.
-test_files:
-- test/test_helper.rb
-- test/units/domains_test.rb
-- test/units/path_test.rb
-- test/units/purge_test.rb
-- test/units/srcset_test.rb
-- test/units/url_test.rb
+test_files: []

data/lib/imgix/param_helpers.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Imgix
-  module ParamHelpers
-    def rect(position)
-      @options[:rect] = position and return self if position.is_a?(String)
-
-      @options[:rect] = [
-        position[:x] || position[:left],
-        position[:y] || position[:top],
-        position[:width] || (position[:right] - position[:left]),
-        position[:height] || (position[:bottom] - position[:top])
-      ].join(',')
-
-      return self
-    end
-  end
-end

data/test/test_helper.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubygems'
-require 'bundler'
-Bundler.require :test
-
-require 'minitest/autorun'
-require 'imgix'
-require 'webmock/minitest'
-include WebMock::API
-
-class Imgix::Test < MiniTest::Test
-end