iknow_params 2.2.3 → 2.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b89e48380562cd7aa3238e08fbbeb1f947b336eebc3a47582de1ac648da582d0
-  data.tar.gz: 0d899f1d4a4ce279a9fe50d651769a29c542f9cdd4c7753f8cf9c512b7f47047
+  metadata.gz: e04e6c4dd0a375bed586bd4c0107dccfa2a1226fd42e16397cf7e8cbc74a5dc9
+  data.tar.gz: a1b11326a2487733f032f2a095ae1e15bf56e2254dc11eab6522710178109a29
 SHA512:
-  metadata.gz: c94310c197e1cb3537be0cbd22768e0d557402a11b40c7c692cfc7966d247bfd7455624d54e0f46a41bb049d12db2798c6cb7070a41f168285a10528d5d2d57a
-  data.tar.gz: 5df5a8a5ebc3cddcb6509faa6ed446ad23265daa5be55f65e1f959f92b554de9388f2ccda020c8dfa226f359b0fa3a39fc16e8453c59be76440e1865b1ab7a12
+  metadata.gz: 7d883780b8b0ba7bf8175f99d79454451a0767d42c3eadc4965d31a8f73cc8cd6748d79d99411da10dcdeb686bb154e3294d4074a2a0ffbdaae84996e26bce8f
+  data.tar.gz: c478dacd778625d53f71f28bbd793d00b4558d9e327b52d3f0a77a4ae1b8f879c91bd3bdbdcdca77a0fea8cab188d495e12895d58f98128364c4e69f28cb5ab8

data/iknow_params.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
 
   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 "tzinfo"

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)

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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IknowParams
-  VERSION = '2.2.3'
+  VERSION = '2.2.4'
 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iknow_params
 version: !ruby/object:Gem::Version
-  version: 2.2.3
+  version: 2.2.4
 platform: ruby
 authors:
 - dev@iknow.jp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-26 00:00:00.000000000 Z
+date: 2020-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,20 @@ 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
@@ -187,9 +201,14 @@ files:
 - 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:
@@ -217,4 +236,6 @@ 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