iknow_params 2.2.3 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b89e48380562cd7aa3238e08fbbeb1f947b336eebc3a47582de1ac648da582d0
-  data.tar.gz: 0d899f1d4a4ce279a9fe50d651769a29c542f9cdd4c7753f8cf9c512b7f47047
+  metadata.gz: c54aa3dbf703f1f04fa03e590544353685c0f06164145cba052834c1d55c0930
+  data.tar.gz: 6ab10b40f1b8bec45460c00d2bf3a8a5f78d79cc7a4cae4186625f8386c9aeca
 SHA512:
-  metadata.gz: c94310c197e1cb3537be0cbd22768e0d557402a11b40c7c692cfc7966d247bfd7455624d54e0f46a41bb049d12db2798c6cb7070a41f168285a10528d5d2d57a
-  data.tar.gz: 5df5a8a5ebc3cddcb6509faa6ed446ad23265daa5be55f65e1f959f92b554de9388f2ccda020c8dfa226f359b0fa3a39fc16e8453c59be76440e1865b1ab7a12
+  metadata.gz: a0b4538a9449e86583e8fa478759c432e66d0157da607a742201205d211121f02c85a93fcc9cdddb887af0257570488c821d814fb4d339968221307a116a5942
+  data.tar.gz: fc3d1702617b6694a3849fa4fe707475c9fc672a51e659372307d2175b2b69f481f88fa45e2902e756f3f4da0a02e9229bf14908295924a149fcb77e447eaa01

data/.circleci/config.yml

@@ -10,7 +10,7 @@ executors:
         type: string
         default: "Gemfile"
     docker:
-      - image: circleci/ruby:<< parameters.ruby-version >>
+      - image: cimg/ruby:<< parameters.ruby-version >>
         environment:
           BUNDLE_JOBS: 3
           BUNDLE_RETRY: 3
@@ -92,9 +92,13 @@ workflows:
           ruby-version: "2.6"
           gemfile: gemfiles/activesupport_5_2.gemfile
       - test:
-          name: 'ruby 2.6 ActiveSupport 6.0'
-          ruby-version: "2.6"
+          name: 'ruby 2.7 ActiveSupport 6.0'
+          ruby-version: "2.7"
           gemfile: gemfiles/activesupport_6_0.gemfile
+      - test:
+          name: 'ruby 3.1 ActiveSupport 7.0'
+          ruby-version: "3.1"
+          gemfile: gemfiles/activesupport_7_0.gemfile
       - publish:
           filters:
             branches:

data/Appraisals

@@ -1,7 +1,14 @@
-appraise "activesupport-5-2" do
-  gem "activesupport", "~> 5.2.0"
+appraise 'activesupport-5-2' do
+  gem 'activesupport', '~> 5.2.0'
+  gem 'rails', '~> 5.2.0'
 end
 
-appraise 'activesupport-6-0 do
-  gem 'activesupport', '~> 6.0.0"
+appraise 'activesupport-6-0' do
+  gem 'activesupport', '~> 6.0.0'
+  gem 'rails', '~> 6.0.0'
+end
+
+appraise 'activesupport-7-0' do
+  gem 'activesupport', '~> 7.0.0'
+  gem 'rails', '~> 7.0.0'
 end

data/gemfiles/activesupport_5_2.gemfile

@@ -4,5 +4,6 @@ source "https://rubygems.org"
 
 gem "rspec_junit_formatter"
 gem "activesupport", "~> 5.2.0"
+gem "rails", "~> 5.2.0"
 
 gemspec path: "../"

data/gemfiles/activesupport_6_0.gemfile

@@ -4,5 +4,6 @@ source "https://rubygems.org"
 
 gem "rspec_junit_formatter"
 gem "activesupport", "~> 6.0.0"
+gem "rails", "~> 6.0.0"
 
 gemspec path: "../"

data/gemfiles/activesupport_7_0.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rspec_junit_formatter"
+gem "activesupport", "~> 7.0.0"
+gem "rails", "~> 7.0.0"
+
+gemspec path: "../"

data/iknow_params.gemspec

@@ -13,22 +13,26 @@ Gem::Specification.new do |spec|
   spec.homepage      = "http://github.com/iknow/iknow_params"
   spec.license       = "MIT"
 
+  spec.required_ruby_version     = ">= 2.5"
+  spec.required_rubygems_version = ">= 2.5"
+
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "sqlite3"
-  spec.add_development_dependency "actionpack", "> 5.0"
-  spec.add_development_dependency "rails", "> 5.0"
+  spec.add_development_dependency "actionpack", "> 5.2.0"
+  spec.add_development_dependency "rails", "> 5.2.0"
 
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "tzinfo-data"
 
-  spec.add_dependency "activesupport", "> 5.0"
+  spec.add_dependency "activesupport", "> 5.2.0"
   spec.add_dependency "tzinfo"
-  spec.add_dependency "json-schema", "~> 2.8.0"
+  spec.add_dependency "json-schema", "~> 3.0.0"
 end

data/lib/iknow_params/serializer/array_of.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Serialize an array of application types to JSON types. Does not support fully
+# rendering to/from a JSON string.
+class IknowParams::Serializer::ArrayOf < IknowParams::Serializer
+  attr_reader :serializer, :allow_singleton
+  json_value!
+
+  def initialize(serializer, allow_singleton: false)
+    super(::Array)
+    @serializer = serializer
+    @allow_singleton = allow_singleton
+  end
+
+  def load(jvals)
+    if allow_singleton
+      jvals = Array.wrap(jvals)
+    else
+      unless jvals.is_a?(Array)
+        raise IknowParams::Serializer::LoadError.new(
+                "Incorrect type for ArrayOf: #{jvals.inspect}:#{jvals.class.name} is not an array")
+      end
+    end
+
+    # Special case thanks to Rails' array query param format not differentating
+    # empty arrays (i.e. `route?param[]=`). Since we can only express one of
+    # empty array and singleton array containing empty string, we pick the more
+    # useful former.
+    return [] if jvals == ['']
+
+    jvals.map { |jval| serializer.load(jval) }
+  end
+
+  def dump(vals, json: true)
+    matches_type!(vals)
+    vals.map { |val| serializer.dump(val, json: json) }
+  end
+
+  def matches_type?(vals)
+    super(vals) && vals.all? { |val| serializer.matches_type?(val) }
+  end
+end

data/lib/iknow_params/serializer/hash_of.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# Serialize a hash structure of application types to JSON types. Does not
+# support fully rendering to/from a JSON string.
+class IknowParams::Serializer::HashOf < IknowParams::Serializer
+  attr_reader :key_serializer, :value_serializer
+  json_value!
+
+  def initialize(key_serializer, value_serializer)
+    super(::Hash)
+    @key_serializer   = key_serializer
+    @value_serializer = value_serializer
+  end
+
+  def load(jstructure)
+    jstructure = jstructure.to_unsafe_h if jstructure.is_a?(ActionController::Parameters)
+
+    unless jstructure.is_a?(Hash)
+      raise IknowParams::Serializer::LoadError.new(
+              "Incorrect type for HashOf: #{jstructure.inspect}:#{jstructure.class.name} is not a hash")
+    end
+
+    jstructure.each_with_object({}) do |(jkey, jvalue), result|
+      key   = key_serializer.load(jkey)
+      value = value_serializer.load(jvalue)
+      result[key] = value
+    end
+  end
+
+  def dump(structure, json: true)
+    matches_type!(structure)
+    structure.each_with_object({}) do |(key, value), result|
+      jkey   = key_serializer.dump(key, json: false)
+      jvalue = value_serializer.dump(value, json: json)
+      result[jkey] = jvalue
+    end
+  end
+
+  def matches_type?(vals)
+    super(vals) && vals.all? do |k_val, v_val|
+      key_serializer.matches_type?(k_val) && value_serializer.matches_type?(v_val)
+    end
+  end
+end

data/lib/iknow_params/serializer/nullable.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Serialize a potentially nil application type to JSON types. Does not support
+# fully rendering to/from a string.
+class IknowParams::Serializer::Nullable < IknowParams::Serializer
+  attr_reader :serializer
+
+  def load(val)
+    if val.nil?
+      nil
+    else
+      serializer.load(val)
+    end
+  end
+
+  def dump(val, json: false)
+    if val.nil?
+      nil
+    else
+      serializer.dump(val, json: json)
+    end
+  end
+
+  def matches_type?(val)
+    val.nil? || super
+  end
+
+  def json_value?
+    true
+  end
+
+  def initialize(serializer)
+    @serializer = serializer
+  end
+end

data/lib/iknow_params/serializer.rb

@@ -83,6 +83,10 @@ class IknowParams::Serializer
     end
   end
 
+  require 'iknow_params/serializer/nullable'
+  require 'iknow_params/serializer/array_of'
+  require 'iknow_params/serializer/hash_of'
+
   class String < IknowParams::Serializer
     def initialize
       super(::String)
@@ -173,6 +177,8 @@ class IknowParams::Serializer
   # Abstract serializer for ISO8601 dates and times
   class ISO8601 < IknowParams::Serializer
     def load(str)
+      raise TypeError.new unless str.is_a?(::String)
+
       clazz.parse(str)
     rescue TypeError, ArgumentError => _e
       raise LoadError.new("Invalid type for conversion to #{clazz}")

data/lib/iknow_params/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IknowParams
-  VERSION = '2.2.3'
+  VERSION = '2.3.0'
 end

data/spec/unit/serializer/array_of_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'iknow_params'
+require 'rails'
+
+RSpec.describe IknowParams::Serializer::ArrayOf do
+  let(:subject) { IknowParams::Serializer::ArrayOf.new(IknowParams::Serializer::Date) }
+
+  let(:serialized_dates) { ['2000-01-01', '2000-01-02'] }
+  let(:dates) { serialized_dates.map { |d| Date.parse(d) } }
+
+  describe '#load' do
+    it 'can load correct values' do
+      expect(subject.load(serialized_dates)).to eq(dates)
+    end
+
+    it 'raises load error on incorrect type' do
+      expect { subject.load(12) }.to raise_error(IknowParams::Serializer::LoadError)
+    end
+  end
+
+  describe '#dump' do
+    it 'can dump correct values' do
+      expect(subject.dump(dates)).to eq(serialized_dates)
+    end
+
+    it 'raises dump error on incorrect type' do
+      expect { subject.dump(12) }.to raise_error(IknowParams::Serializer::DumpError)
+    end
+  end
+end

data/spec/unit/serializer/hash_of_spec.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'iknow_params'
+require 'rails'
+
+RSpec.describe IknowParams::Serializer::HashOf do
+  let(:subject) { IknowParams::Serializer::HashOf.new(IknowParams::Serializer::Integer, IknowParams::Serializer::Date) }
+
+  let(:serialized_dates) { { '1' => '2000-01-01', '2' => '2000-01-02' } }
+  let(:dates) do
+    { 1 => Date.parse('2000-01-01'), 2 => Date.parse('2000-01-02') }
+  end
+
+  describe '#load' do
+    it 'can load correct values' do
+      expect(subject.load(serialized_dates)).to eq(dates)
+    end
+
+    it 'raises load error on incorrect type' do
+      expect { subject.load(12) }.to raise_error(IknowParams::Serializer::LoadError)
+    end
+  end
+
+  describe '#dump' do
+    it 'can dump correct values' do
+      expect(subject.dump(dates)).to eq(serialized_dates)
+    end
+
+    it 'raises dump error on incorrect type' do
+      expect { subject.dump(12) }.to raise_error(IknowParams::Serializer::DumpError)
+    end
+  end
+end

data/spec/unit/serializer_spec.rb

@@ -4,6 +4,7 @@ require 'spec_helper'
 require 'iknow_params'
 
 require 'rails'
+require 'active_support/core_ext'
 require 'action_controller'
 
 RSpec.describe IknowParams::Serializer do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iknow_params
 version: !ruby/object:Gem::Version
-  version: 2.2.3
+  version: 2.3.0
 platform: ruby
 authors:
 - dev@iknow.jp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-26 00:00:00.000000000 Z
+date: 2022-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -72,28 +72,28 @@ dependencies:
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -122,20 +122,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: tzinfo-data
+  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: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: tzinfo
   requirement: !ruby/object:Gem::Requirement
@@ -156,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 3.0.0
 description: ''
 email:
 - ''
@@ -174,7 +188,6 @@ files:
 - ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Appraisals
 - Gemfile
 - LICENSE.txt
@@ -182,14 +195,20 @@ files:
 - Rakefile
 - gemfiles/activesupport_5_2.gemfile
 - gemfiles/activesupport_6_0.gemfile
+- gemfiles/activesupport_7_0.gemfile
 - iknow_params.gemspec
 - lib/iknow_params.rb
 - lib/iknow_params/parser.rb
 - lib/iknow_params/parser/hash_parser.rb
 - lib/iknow_params/serializer.rb
+- lib/iknow_params/serializer/array_of.rb
+- lib/iknow_params/serializer/hash_of.rb
+- lib/iknow_params/serializer/nullable.rb
 - lib/iknow_params/version.rb
 - spec/spec_helper.rb
 - spec/unit/parser_spec.rb
+- spec/unit/serializer/array_of_spec.rb
+- spec/unit/serializer/hash_of_spec.rb
 - spec/unit/serializer_spec.rb
 homepage: http://github.com/iknow/iknow_params
 licenses:
@@ -203,18 +222,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.11
 signing_key: 
 specification_version: 4
 summary: Rails parameter parser for iKnow.
 test_files:
 - spec/spec_helper.rb
 - spec/unit/parser_spec.rb
+- spec/unit/serializer/array_of_spec.rb
+- spec/unit/serializer/hash_of_spec.rb
 - spec/unit/serializer_spec.rb

data/.travis.yml

@@ -1,8 +0,0 @@
-dist: trusty
-language: ruby
-rvm:
-  - 2.4
-gemfile:
-  - gemfiles/activesupport_5_2.gemfile
-notifications:
-  email: false