image_flux 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea25f6fefda0f47672ccb5a18d060486feb4acf0c228daddbaf21c831b15c701
-  data.tar.gz: 9d7d7322cc2a1346dacdca8dcc1a3b2b5539b051a099e7ade5cd90375e1ffee5
+  metadata.gz: 4f04717f6c8a7171ed05a425305e8b186b70d8a5f30e17f34b970ae4069f5e5b
+  data.tar.gz: 7af62a9d8fdf0dfe46b6fd052fd6e1e9d37661893694edb895acb9ba86e3b41f
 SHA512:
-  metadata.gz: 00d3f5bc8ce49ed4a581431d2427da22e9efce02a35cb743a56a616e09a34c4f6c75bde11ab21c571b69f0519d1e685a1358c3365eb66a82bcccea6834c14009
-  data.tar.gz: 1929079e55aa1a6493c689d1ef883ced3f00eb8d65a075ddc95a4a0294678c6ed43bb626b4966ddcaed84f834c544b312a8e0989030c00284117dd489f4b83b7
+  metadata.gz: 933d58c01fb5f19bc00d82078bdee46083044b2e38b43764b44fc74bd5ff3e4fb988308a78a2d6add7bc5e2f8d8f634a0f2c3e05de4e212fb72b7cd40b1c5438
+  data.tar.gz: 5fa56b297858154ea41d0e510cae82fead63ea7f5aef024d6f996f951b883d35f7e3622f0fd9f3b0ca485374c9a9354dc2ce68955ecfb7c6a6c4bf6dd429f781

data/.circleci/config.yml

@@ -2,7 +2,7 @@ version: 2
 jobs:
   build:
     docker:
-       - image: circleci/ruby:2.6.1
+      - image: circleci/ruby:3.0.0
     working_directory: ~/repo
 
     steps:
@@ -18,18 +18,20 @@ jobs:
 
       - restore_cache:
           keys:
-          - v1-dependencies-{{ checksum "image_flux.gemspec" }}
-          - v1-dependencies-
+          - v2-dependencies-{{ checksum "image_flux.gemspec" }}
+          - v2-dependencies-
 
       - run:
           name: install dependencies
           command: |
-            bundle install --jobs=4 --retry=3 --path vendor/bundle
+            bundle config set --local path 'vendor/bundle'
+            bundle install --jobs=4 --retry=3
+            bundle update
 
       - save_cache:
           paths:
             - ./vendor/bundle
-          key: v1-dependencies-{{ checksum "image_flux.gemspec" }}
+          key: v2-dependencies-{{ checksum "image_flux.gemspec" }}
 
       - run:
           name: RSpec
@@ -41,6 +43,10 @@ jobs:
                             --out /tmp/test-results/rspec.xml \
                             --format progress
 
+      - run:
+          name: Rubocop
+          command: bundle exec rubocop
+
       # collect reports
       - store_test_results:
           path: /tmp/test-results

data/.rubocop.yml

@@ -1,82 +1,74 @@
 AllCops:
+  SuggestExtensions: false
+  NewCops: enable
+  Include:
+    - '**/Gemfile'
+    - '**/Rakefile'
+    - '**/*.rake'
+    - '**/*.rb'
+    - '**/*.gemspec'
+  Exclude:
+    - 'bin/**/*'
+    - 'vendor/bundle/**/*'
   DisplayCopNames: true
-  DisplayStyleGuide: true
 
-Layout/AlignParameters:
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Layout/ParameterAlignment:
   EnforcedStyle: with_fixed_indentation
 
 Style/ClassAndModuleChildren:
   EnforcedStyle: compact
-  Exclude:
-    - config/application.rb
 
 Style/Documentation:
   Enabled: false
 
+Layout/EmptyLines:
+  Exclude:
+    - '**/Gemfile'
+
 Style/FrozenStringLiteralComment:
-  EnforcedStyle: always
-  Enabled: true
+  Exclude:
+    - '**/Gemfile'
+
+Naming/FileName:
+  Exclude:
+    - '**/Gemfile'
+    - '**/Guardfile'
 
 Style/RegexpLiteral:
   EnforcedStyle: percent_r
+  AllowInnerSlashes: false
 
-#################### Metrics ###############################
-
-Metrics/AbcSize:
-  Max: 15
+Style/MutableConstant:
+  Enabled: false
 
 Metrics/BlockLength:
-  CountComments: false
-  Max: 25
-  ExcludedMethods: []
   Exclude:
-    - Guardfile
+    - 'test/**/*'
+    - 'spec/**/*'
 
-Metrics/BlockNesting:
-  CountBlocks: false
-  Max: 3
+Layout/LineLength:
+  Max: 240
 
 Metrics/ClassLength:
-  CountComments: false
   Max: 200
 
-Metrics/CyclomaticComplexity:
-  Max: 12
-
-Metrics/LineLength:
-  Max: 180
-
 Metrics/MethodLength:
   Max: 20
 
-Metrics/ModuleLength:
-  Max: 200
+Metrics/AbcSize:
+  Max: 35
 
-Metrics/ParameterLists:
-  Max: 5
+Metrics/CyclomaticComplexity:
+  Max: 20
 
 Metrics/PerceivedComplexity:
-  Max: 7
-
-#################### Lint ##################################
-
-Lint/UnusedBlockArgument:
-  IgnoreEmptyBlocks: true
-  AllowUnusedKeywordArguments: true
-
-Lint/UnusedMethodArgument:
-  AllowUnusedKeywordArguments: true
-  IgnoreEmptyMethods: true
-
-#################### Performance ###########################
-
-Performance/DoubleStartEndWith:
-  IncludeActiveSupportAliases: false
-
-Performance/RedundantMerge:
-  MaxKeyValuePairs: 2
+  Max: 20
 
-#################### Rails #################################
+Metrics/ParameterLists:
+  Max: 6
 
-Rails/ActionFilter:
-  EnforcedStyle: action
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/README.md

@@ -36,6 +36,17 @@ origin.image_url('/original.jpg', width: 100)
 # => https://example.imageflux.jp/c/w=100/original.jpg
 ```
 
+### Generate option with class
+
+```ruby
+option = ImageFlux::Option.new()
+option.width = 100
+option.overlay = [
+  { w: 100, path: '/hello-world.png' },
+]
+origin.image_url('/original.jpg', option)
+```
+
 ## 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.

data/image_flux.gemspec

@@ -1,7 +1,6 @@
-
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'image_flux/version'
 
@@ -24,9 +23,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '>= 1.16'
+  spec.add_development_dependency 'coveralls_reborn'
   spec.add_development_dependency 'ffaker'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec_junit_formatter'
+  spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'coveralls_reborn'
 end

data/lib/image_flux/attribute.rb

@@ -23,12 +23,15 @@ class ImageFlux::Attribute
     @enum ? @enum.fetch(value) { value } : value
   end
 
+  # rubocop:disable Metrics/MethodLength
   def querize(value, ignore_default: true)
     value = expand(value)
     return nil if !@query || (ignore_default && default == value)
 
     value = case type
-            when :string
+            when :overlay
+              return querize_overlay(value)
+            when :string, Regexp
               value.to_s
             when :integer
               value.to_i.to_s
@@ -40,12 +43,26 @@ class ImageFlux::Attribute
               value.map(&:to_f).join(':')
             when :boolean
               value ? '1' : '0'
+            when :path
+              return nil
             else
               value
             end
 
     "#{name}=#{value}"
   end
+  # rubocop:enable Metrics/MethodLength
+
+  def querize_overlay(value)
+    values = [value].flatten
+    values.map do |val|
+      option = val.is_a?(Hash) ? ImageFlux::Option.new(val) : val
+      path = option.path.to_s
+      path = "/#{path}" unless path.start_with?('/')
+      query = "#{option.to_query}#{URI.encode_www_form_component(path)}"
+      "l=(#{query})"
+    end.join(',')
+  end
 
   def validate!(value)
     errors = []
@@ -59,7 +76,7 @@ class ImageFlux::Attribute
 
   def validate_type(value)
     check = case type
-            when :string
+            when :string, :path
               value.is_a?(String) || value.respond_to?(:to_s)
             when :integer
               value.is_a?(Integer) || value.respond_to?(:to_i)
@@ -71,6 +88,8 @@ class ImageFlux::Attribute
               value.is_a?(Array) && value.all? { |elem| elem.is_a?(Float) || elem.respond_to?(:to_i) }
             when :boolean
               value.is_a?(TrueClass) || value.is_a?(FalseClass)
+            when Regexp
+              value.respond_to?(:to_s) && type.match?(value.to_s)
             else
               true
             end

data/lib/image_flux/option.rb

@@ -5,6 +5,13 @@ require 'image_flux/attribute'
 require 'image_flux/error'
 
 class ImageFlux::Option
+  REGEXP_INTEGER = %r{\d+}
+  REGEXP_FLOAT = %r{\d+(?:\.\d+)?}
+
+  REGEXP_UNSHARP = %r{\A#{REGEXP_INTEGER}x#{REGEXP_FLOAT}(?:\+#{REGEXP_FLOAT}){1,2}\z}x
+  REGEXP_BLUR = %r{\A#{REGEXP_INTEGER}x#{REGEXP_FLOAT}\z}x
+  REGEXP_MASK = %r{\A(?:white|black|alpha)(?::[01])?\z}
+
   def self.attributes
     @attributes ||= []
   end
@@ -14,12 +21,17 @@ class ImageFlux::Option
   end
 
   def self.attribute(name, type, options = {}, &block)
-    attribute = ImageFlux::Attribute.new(name, type, options)
+    attribute = ImageFlux::Attribute.new(name, type, **options)
     attribute.instance_eval(&block) if block_given?
     key_pairs[attribute.name] = attribute
     attribute.aliases.each do |key|
       key_pairs[key] = attribute
     end
+    names = [name] + (options[:aliases] || [])
+    names.each do |n|
+      define_method(:"#{n}") { @values[attribute] }
+      define_method(:"#{n}=") { |val| @values[attribute] = val }
+    end
 
     attributes.push(attribute)
   end
@@ -27,19 +39,23 @@ class ImageFlux::Option
   # Predefined prefix path
   attribute :prefix, :string, default: nil, query: false
 
-  # resize attributes
+  # scaling attributes
+  # https://console.imageflux.jp/docs/image/conversion-parameters#scaling
   attribute :w, :integer, default: nil, aliases: %i[width]
   attribute :h, :integer, default: nil, aliases: %i[height]
-  attribute :u, :boolean, default: true, aliases: %i[upscale]
-  attribute :a, :integer, default: 1, aliases: %i[aspect], enum:{
+  attribute :a, :integer, default: 1, aliases: %i[aspect], enum: {
     scale: 0,
     force_scale: 1,
     crop: 2,
     pad: 3
   }
+  attribute :b, :string, default: 'ffffff', aliases: %i[background] do
+    validate do |value|
+      'b should be a color code' unless value.to_s =~ %r{\A[0-9a-fA-F]{6}\z}
+    end
+  end
   attribute :c, :integer_array, default: nil, aliases: %i[crop]
-  attribute :cr, :float_array, default: nil, aliases: %i[]
-  attribute :g, :integer, default: 4, aliases: %i[gravity], enum: {
+  attribute :g, :integer, default: 5, aliases: %i[gravity], enum: {
     top_left: 1,
     top_center: 2,
     top_right: 3,
@@ -50,19 +66,89 @@ class ImageFlux::Option
     bottom_center: 8,
     bottom_right: 9
   }
-  attribute :b, :string, default: 'ffffff', aliases: %i[background] do
+  attribute :u, :boolean, default: true, aliases: %i[upscale]
+
+  # clipping attributes
+  # ref: https://console.imageflux.jp/docs/image/conversion-parameters#clipping
+  attribute :ic, :integer_array, default: nil, aliases: %i[input_clipping]
+  attribute :icr, :float_array, default: nil, aliases: %i[input_clipping_range]
+  attribute :ig, :integer, default: nil, aliases: %i[input_gravity], enum: {
+    top_left: 1,
+    top_center: 2,
+    top_right: 3,
+    middle_left: 4,
+    middle_center: 5,
+    middle_right: 6,
+    bottom_left: 7,
+    bottom_center: 8,
+    bottom_right: 9
+  }
+  attribute :c, :integer_array, default: nil, aliases: %i[oc output_clipping]
+  attribute :cr, :float_array, default: nil, aliases: %i[ocr output_clipping_range]
+  attribute :og, :integer, default: nil, aliases: %i[output_gravity], enum: {
+    top_left: 1,
+    top_center: 2,
+    top_right: 3,
+    middle_left: 4,
+    middle_center: 5,
+    middle_right: 6,
+    bottom_left: 7,
+    bottom_center: 8,
+    bottom_right: 9
+  }
+
+  # rotation attributes
+  # ref: https://console.imageflux.jp/docs/image/conversion-parameters#rotation
+  ALLOWED_ROTATES = %w[1 2 3 4 5 6 7 8 auto].freeze
+  attribute :ir, :string, default: '1', aliases: %i[input_rotate] do
     validate do |value|
-      'b should be a color code' unless value.to_s =~ %r{\A[0-9a-fA-F]{6}\z}
+      "rotate should be inclusion of #{ALLOWED_ROTATES.join(', ')}" unless ALLOWED_ROTATES.include?(value.to_s)
     end
   end
-  attribute :r, :integer, default: 1, aliases: %i[rotate]
-  # overlay attributes
+  attribute :r, :string, default: '1', aliases: %i[or rotate output_rotate] do
+    validate do |value|
+      "rotate should be inclusion of #{ALLOWED_ROTATES.join(', ')}" unless ALLOWED_ROTATES.include?(value.to_s)
+    end
+  end
+
+  # filter attributes
+  # ref: https://console.imageflux.jp/docs/image/conversion-parameters#filter
+  attribute :unsharp, REGEXP_UNSHARP, default: nil, aliases: %i[]
+  attribute :blur, REGEXP_BLUR, default: nil, aliases: %i[]
+  attribute :grayscale, :integer, default: nil, aliases: %i[]
+  attribute :sepia, :integer, default: nil, aliases: %i[]
+  attribute :brightnes, :integer, default: nil, aliases: %i[]
+  attribute :contrast, :integer, default: nil, aliases: %i[]
+  attribute :invert, :integer, default: nil, aliases: %i[]
+
+  # overlay attribute
+  attribute :overlay, :overlay, default: nil
+  attribute :path, :path, default: nil
+  attribute :x, :integer, default: 0
+  attribute :xr, :float, default: nil
+  attribute :y, :integer, default: 0
+  attribute :yr, :float, default: nil
+  attribute :lg, :integer, default: 5, aliases: %i[], enum: {
+    top_left: 1,
+    top_center: 2,
+    top_right: 3,
+    middle_left: 4,
+    middle_center: 5,
+    middle_right: 6,
+    bottom_left: 7,
+    bottom_center: 8,
+    bottom_right: 9
+  }
+  attribute :mask, REGEXP_MASK, default: nil
+
+  # old overlay attributes
+  # ref: https://console.imageflux.jp/docs/image/conversion-parameters#%E7%94%BB%E5%83%8F%E4%BD%8D%E7%BD%AE%E3%81%AE%E6%8C%87%E5%AE%9A-%E5%8F%A4%E3%81%84%E5%BD%A2%E5%BC%8F
   attribute :l, :string, default: nil
   attribute :lx, :integer, default: nil
   attribute :lxr, :integer, default: nil
   attribute :ly, :integer, default: nil
   attribute :lyr, :integer, default: nil
-  attribute :lg, :integer, default: 5, aliases: %i[gravity], enum: {
+  attribute :lg, :integer, default: 5, aliases: %i[], enum: {
     top_left: 1,
     top_center: 2,
     top_right: 3,
@@ -73,8 +159,10 @@ class ImageFlux::Option
     bottom_center: 8,
     bottom_right: 9
   }
+
   # output attributes
-  ALLOWED_FORMATS = %w[auto jpg png gif webp:jpeg webp:png webp:auto]
+  # ref: https://console.imageflux.jp/docs/image/conversion-parameters#output
+  ALLOWED_FORMATS = %w[auto jpg png gif webp:jpeg webp:png webp:auto].freeze
   attribute :f, :string, default: 'auto', aliases: %i[format] do
     validate do |value|
       "format should be inclusion of #{ALLOWED_FORMATS.join(', ')}" unless ALLOWED_FORMATS.include?(value.to_s)
@@ -82,6 +170,21 @@ class ImageFlux::Option
   end
   attribute :q, :integer, default: 75, aliases: %i[quality]
   attribute :o, :boolean, default: true, aliases: %i[optimize]
+  attribute :lossless, :boolean, default: nil, aliases: %i[]
+  attribute :s, :integer, default: 1, aliases: %i[strip], enum: {
+    strip: 1,
+    strip_without_orientation: 2
+  }
+
+  # through attributes
+  # https://console.imageflux.jp/docs/image/conversion-parameters#through
+  ALLOWED_THROUGH_FORMATS = %w[jpg png gif].freeze
+  attribute :t, :string, aliases: %i[through] do
+    validate do |_value|
+      values = values.to_s.split(':')
+      "format should be inclusion of #{ALLOWED_THROUGH_FORMATS.join(', ')}" unless values.all? { |format| ALLOWED_THROUGH_FORMATS.includes?(format) }
+    end
+  end
 
   attribute :sig, :nonescape_string, default: nil
 
@@ -100,7 +203,7 @@ class ImageFlux::Option
     @values[prefix_attr]
   end
 
-  def to_query(ignore_default: true)
+  def to_query
     errors = []
     queries = @values.to_a.map do |pair|
       attribute = pair.first
@@ -112,4 +215,16 @@ class ImageFlux::Option
 
     queries.reject(&:nil?).join(',')
   end
+
+  def to_h
+    hash = {}
+    @values.each_pair do |attribute, val|
+      hash[attribute.name] = val
+    end
+    hash
+  end
+
+  def merge(other)
+    to_h.merge(other)
+  end
 end

data/lib/image_flux/origin.rb

@@ -7,6 +7,7 @@ require 'image_flux'
 
 class ImageFlux::Origin
   attr_reader :domain, :scheme, :signing_version, :signing_secret
+
   def initialize(domain:, scheme: 'https', signing_version: '1', signing_secret: nil, **_options)
     @domain = domain.to_s
     @scheme = scheme.to_s
@@ -21,8 +22,7 @@ class ImageFlux::Origin
   def image_url(path, options = {})
     path = "/#{path}" unless path.start_with?('/')
 
-    options = options.merge(sig: sign(path)) if @signing_secret
-    opt = ImageFlux::Option.new(options)
+    opt = options.is_a?(ImageFlux::Option) ? options : ImageFlux::Option.new(options)
 
     path = "#{opt.prefix_path}#{path}" if opt.prefix_path
     query = opt.to_query
@@ -30,6 +30,11 @@ class ImageFlux::Origin
     url = base_url.dup
     url.path = query.length.zero? ? path : "/c/#{opt.to_query}#{path}"
 
+    if @signing_secret
+      signed_opt = ImageFlux::Option.new(options.merge(sig: sign(url.path)))
+      url.path = "/c/#{signed_opt.to_query}#{path}"
+    end
+
     url
   end
 

data/lib/image_flux/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ImageFlux
-  VERSION = '1.1.1'.freeze
+  VERSION = '1.2.0'
 end

data/renovate.json

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "config:base"
+  ]
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: image_flux
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Sho Kusano
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-20 00:00:00.000000000 Z
+date: 2021-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: coveralls_reborn
+  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'
 - !ruby/object:Gem::Dependency
   name: ffaker
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls_reborn
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -119,6 +133,7 @@ files:
 - lib/image_flux/option.rb
 - lib/image_flux/origin.rb
 - lib/image_flux/version.rb
+- renovate.json
 homepage: https://github.com/space-pirates-llc/image_flux
 licenses:
 - MIT
@@ -138,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: URL builder for ImageFlux