imgix-rails 2.1.4 → 4.2.0

data/lib/imgix/rails/tag.rb

@@ -1,174 +1,31 @@
 require "imgix/rails/url_helper"
+require "action_view"
 
 class Imgix::Rails::Tag
   include Imgix::Rails::UrlHelper
   include ActionView::Helpers
 
-  @@parameters = nil
-
-  # Store our parameter information on the class instance so that
-  # each instance of any this class or our subclasses doesn't have to
-  # go back to disk to get this configuration information
-  def self.available_parameters
-    @@available_parameters ||= parameters.keys
-  end
-
-  def self.parameters
-    return @@parameters if @@parameters
-
-    path = File.expand_path("../../../../vendor/parameters.json", __FILE__)
-    @@parameters = JSON.parse(File.read(path), symbolize_names: true)[:parameters]
-    @@parameters[:widths] = nil
-
-    @@parameters
-  end
-
-  def initialize(source, options={})
+  def initialize(path, source: nil, tag_options: {}, url_params: {}, srcset_options: {}, attribute_options: {})
+    @path = path
     @source = source
-    @options = options
+    @tag_options = tag_options
+    @url_params = url_params
+    @srcset_options = srcset_options
+    @attribute_options = attribute_options
   end
 
 protected
 
-  def srcset(opts=@options)
-    @source = replace_hostname(@source)
-    widths = opts[:widths] || target_widths
-
-    widths.map do |width|
-      srcset_options = opts.slice(*self.class.available_parameters).except(:widths)
-      srcset_options[:w] = width
-
-      if opts[:w].present? && opts[:h].present?
-        srcset_options[:h] = (width * (opts[:h].to_f / opts[:w])).round
-      end
-
-      "#{ix_image_url(@source, srcset_options)} #{width}w"
-    end.join(', ')
-  end
-
-private
-
-  MAXIMUM_SCREEN_WIDTH = 2560 * 2 # Physical resolution of 27" iMac (2016)
-  SCREEN_STEP = 100
-
-  # Taken from http://mydevice.io/devices/
-
-  # Phones
-  IPHONE = { css_width: 320, dpr: 1 }
-  IPHONE_4 = { css_width: 320, dpr: 2 }
-  IPHONE_6 = { css_width: 375, dpr: 2 }
-  LG_G3 = { css_width: 360, dpr: 4 }
-
-  # Phablets
-  IPHONE_6_PLUS = { css_width: 414, dpr: 3 }
-  IPHONE_6_PLUS_LANDSCAPE = { css_width: 736, dpr: 3 }
-  MOTO_NEXUS_6 = { css_width: 412, dpr: 3.5 }
-  MOTO_NEXUS_6_LANDSCAPE = { css_width: 690, dpr: 3.5 }
-  LUMIA_1520 = { css_width: 432, dpr: 2.5 }
-  LUMIA_1520_LANDSCAPE = { css_width: 768, dpr: 2.5 }
-  GALAXY_NOTE_3 = { css_width: 360, dpr: 3 }
-  GALAXY_NOTE_3_LANDSCAPE = { css_width: 640, dpr: 3 }
-  GALAXY_NOTE_4 = { css_width: 360, dpr: 4 }
-  GALAXY_NOTE_4_LANDSCAPE = { css_width: 640, dpr: 4 }
-
-  # Tablets
-  IPAD = { css_width: 768, dpr: 1 };
-  IPAD_LANDSCAPE = { css_width: 1024, dpr: 1 };
-  IPAD_3 = { css_width: 768, dpr: 2 };
-  IPAD_3_LANDSCAPE = { css_width: 1024, dpr: 2 };
-  IPAD_PRO = { css_width: 1024, dpr: 2 };
-  IPAD_PRO_LANDSCAPE = { css_width: 1366, dpr: 2 };
-
-  BOOTSTRAP_SM = { css_width: 576, dpr: 1 }
-  BOOTSTRAP_MD = { css_width: 720, dpr: 1 }
-  BOOTSTRAP_LG = { css_width: 940, dpr: 1 }
-  BOOTSTRAP_XL = { css_width: 1140, dpr: 1 }
+  def srcset(source: @source, path: @path, url_params: @url_params, srcset_options: @srcset_options, tag_options: @tag_options)
+    params = url_params.clone
 
-  def devices
-    phones + phablets + tablets + bootstrap_breaks
-  end
-
-  def bootstrap_breaks
-    breaks = [
-      BOOTSTRAP_SM,
-      BOOTSTRAP_MD,
-      BOOTSTRAP_LG,
-      BOOTSTRAP_XL
-    ]
-
-    breaks + breaks.map { |b| b[:dpr] = 2; b }
-  end
-
-  def phones
-    [
-      IPHONE,
-      IPHONE_4,
-      IPHONE_6,
-      LG_G3
-    ]
-  end
-
-  def phablets
-    [
-      IPHONE_6_PLUS,
-      IPHONE_6_PLUS_LANDSCAPE,
-      MOTO_NEXUS_6,
-      MOTO_NEXUS_6_LANDSCAPE,
-      LUMIA_1520,
-      LUMIA_1520_LANDSCAPE,
-      GALAXY_NOTE_3,
-      GALAXY_NOTE_3_LANDSCAPE,
-      GALAXY_NOTE_4,
-      GALAXY_NOTE_4_LANDSCAPE
-    ]
-  end
-
-  def tablets
-    [
-      IPAD,
-      IPAD_LANDSCAPE,
-      IPAD_3,
-      IPAD_3_LANDSCAPE,
-      IPAD_PRO,
-      IPAD_PRO_LANDSCAPE
-    ]
-  end
-
-  # 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_screen_width_required = @options[:min_width] || SCREEN_STEP
-    max_screen_width_required = @options[:max_width] || MAXIMUM_SCREEN_WIDTH
-
-    widths = (device_widths + screen_widths).select do |w|
-      w <= max_screen_width_required && w >= min_screen_width_required
-    end.compact.uniq.sort
-
-    # Add exact widths for 1x, 2x, and 3x devices
-    if @options[:w]
-      widths.push(@options[:w], @options[:w] * 2, @options[:w] * 3)
-    end
-
-    widths
-  end
-
-  def device_widths
-    devices.map do |device|
-      (device[:css_width] * device[:dpr]).round
-    end
-  end
+    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}
 
-  # Generates an array of physical screen widths to represent
-  # the different potential viewport sizes.
-  #
-  # We step by `SCREEN_STEP` to give some sanity to the amount
-  # of widths we output.
-  #
-  # The upper bound is the widest known screen on the planet.
-  # @return {Array} An array of {Fixnum} instances
-  def screen_widths
-    (0..MAXIMUM_SCREEN_WIDTH).step(SCREEN_STEP).to_a + [MAXIMUM_SCREEN_WIDTH]
+    ix_image_srcset(@source, @path, params, options)
   end
 end

data/lib/imgix/rails/url_helper.rb

@@ -3,56 +3,118 @@ module Imgix
     class ConfigurationError < StandardError; end
 
     module UrlHelper
-      def ix_image_url(source, options={})
+      def ix_image_url(*args)
         validate_configuration!
 
-        source = replace_hostname(source)
+        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]
+        else
+          raise RuntimeError.new('path missing')
+        end
+
+        imgix_client(source).path(path).to_url(params).html_safe
+      end
+
+      protected
+
+      def ix_image_srcset(*args)
+        validate_configuration!
 
-        imgix_client.path(source).to_url(options).html_safe
+        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
 
       def validate_configuration!
         imgix = ::Imgix::Rails.config.imgix
-        unless imgix.try(:[], :source)
-          raise ConfigurationError.new("imgix source is not configured. Please set config.imgix[:source].")
-        end
 
-        unless imgix[:source].is_a?(Array) || imgix[:source].is_a?(String)
-          raise ConfigurationError.new("imgix source must be a String or an Array.")
+        if imgix.slice(:source, :sources).size != 1
+          raise ConfigurationError.new("Exactly one of :source, :sources is required")
         end
-      end
-
-      def replace_hostname(source)
-        new_source = source.dup
 
-        # Replace any hostnames configured to trim things down just to their paths.
-        # We use split to remove the protocol in the process.
-        hostnames_to_remove.each do |hostname|
-          splits = source.split(hostname)
-          new_source = splits.last if splits.size > 1
+        if imgix[:source]
+          unless imgix[:source].is_a?(String)
+            raise ConfigurationError.new("imgix source must be a String.")
+          end
         end
 
-        new_source
+        if imgix[:sources]
+          unless imgix[:sources].is_a?(Hash)
+            raise ConfigurationError.new(":sources must be a Hash")
+          end
+        end
       end
 
-      def hostnames_to_remove
-        Array(::Imgix::Rails.config.imgix[:hostname_to_replace] || ::Imgix::Rails.config.imgix[:hostnames_to_replace])
+      def imgix_client(source)
+        begin
+          return imgix_clients.fetch(source)
+        rescue KeyError
+          raise RuntimeError.new("Unknown source '#{source}'")
+        end
       end
 
-      def imgix_client
-        return @imgix_client if @imgix_client
+      def imgix_clients
+        return @imgix_clients if @imgix_clients
         imgix = ::Imgix::Rails.config.imgix
 
         opts = {
-          host: imgix[:source],
           library_param: "rails",
           library_version: Imgix::Rails::VERSION,
           use_https: true,
-          secure_url_token: imgix[:secure_url_token]
         }
 
+        if imgix[:source].is_a?(String)
+          opts[:domain] = imgix[:source]
+        end
+
         if imgix.has_key?(:include_library_param)
           opts[:include_library_param] = imgix[:include_library_param]
         end
@@ -61,7 +123,21 @@ module Imgix
           opts[:use_https] = imgix[:use_https]
         end
 
-        @imgix_client = ::Imgix::Client.new(opts)
+        sources = imgix[:sources] || { imgix[:source] => imgix[:secure_url_token] }
+        @imgix_clients = {}
+
+        sources.map do |source, token|
+          opts[:domain] = source
+          opts[:secure_url_token] = token
+          @imgix_clients[source] = ::Imgix::Client.new(opts)
+        end
+
+        default_source = imgix[:default_source] || imgix[:source]
+        if default_source
+          @imgix_clients[nil] = @imgix_clients.fetch(default_source)
+        end
+
+        @imgix_clients
       end
     end
   end

data/lib/imgix/rails/version.rb

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

data/lib/imgix/rails/view_helper.rb

@@ -1,4 +1,5 @@
 require "imgix"
+require "imgix/rails/tag"
 require "imgix/rails/image_tag"
 require "imgix/rails/picture_tag"
 
@@ -7,12 +8,12 @@ module Imgix
     module ViewHelper
       include UrlHelper
 
-      def ix_image_tag(source, options={})
-        Imgix::Rails::ImageTag.new(source, options).render
+      def ix_image_tag(source=nil, path, tag_options: {}, url_params: {}, srcset_options: {}, attribute_options: {})
+        return Imgix::Rails::ImageTag.new(path, source: source, tag_options: tag_options, url_params: url_params, srcset_options: srcset_options, attribute_options: attribute_options).render
       end
 
-      def ix_picture_tag(source, picture_tag_options:, imgix_default_options:, breakpoints:)
-        Imgix::Rails::PictureTag.new(source, picture_tag_options, imgix_default_options, breakpoints).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: 2.1.4
+  version: 4.2.0
 platform: ruby
 authors:
 - Kelly Sutton
@@ -9,40 +9,34 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-01 00:00:00.000000000 Z
+date: 2021-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: imgix
   requirement: !ruby/object:Gem::Requirement
     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
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.9'
 - !ruby/object:Gem::Dependency
@@ -51,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
@@ -97,10 +91,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/CODEOWNERS"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/ISSUE_TEMPLATE/question.md"
+- ".github/pull_request_template.md"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
@@ -114,11 +115,14 @@ files:
 - lib/imgix/rails/version.rb
 - lib/imgix/rails/view_helper.rb
 - lib/imgix/railtie.rb
-- vendor/parameters.json
 homepage: https://github.com/imgix/imgix-rails
 licenses:
-- MIT
+- BSD-2-Clause
 metadata:
+  bug_tracker_uri: https://github.com/imgix/imgix-rails/issues
+  changelog_uri: https://github.com/imgix/imgix-rails/blob/main/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/imgix-rails/4.2.0
+  source_code_uri: https://github.com/imgix/imgix-rails/tree/v4.2.0
   allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
@@ -135,8 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Makes integrating imgix into your Rails app easier. It builds on imgix-rb