json-schema-serializer 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b4c5d9d360e8b71d59ffaf2dbaef3a19cb782acdbb4c97548188f4c3339d654
-  data.tar.gz: 180e413608d626170441274fa43c82a20cf62d78a5509cc1cee6b8ade65dbeae
+  metadata.gz: 0efb6d3beb44452ee9a2aa14ac89bd465e8c23ecbaf7cb650ff39faeaf22f19d
+  data.tar.gz: f9d35967622b23c02a1a09cfad3c33c3af0f1bf38de295d365732231d0926011
 SHA512:
-  metadata.gz: 6b5e545a90241344d73da7d4a015ba83e0d96ec71df27f98652f755018c2c241b612cdbbcbdcf0b3fc5b10a447e493047a035cdf93c770f42214a41e90935b7b
-  data.tar.gz: 8c875c4c2681df2ef05ae8bde119c6cd1a9cc6621e667616e8df935acfe34c2a4c459cf648730aa9e9439240d805382ff9d8033f2edecd804e8a697def9877e5
+  metadata.gz: c1905cf229d6fd7c484fb3703eb507a4fb7641c28b840ee2e045b250fd688502b8c09dcb36bb28d191b1d36a7c5772040c0bd10297f6ba533e4d676d191c02a1
+  data.tar.gz: c24cd2d21e573339dd9b861b4f6936753f78ed63d6f7988316608d9315d1322689c3bac080873ee4e54a0327073d89545c77d51576ebd4bc6ebe842ce6fb2b19

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 1.5.0
+
+- add: many options
+
 ## 1.4.0
 
 - add: "additionalProperties" support

data/README.md

@@ -1,4 +1,4 @@
-# Json::Schema::Serializer
+# JSON::Schema::Serializer
 
 [![Actions Status](https://github.com/Narazaka/json-schema-serializer/workflows/Ruby/badge.svg)](https://github.com/Narazaka/json-schema-serializer/actions)
 [![Gem Version](https://badge.fury.io/rb/json-schema-serializer.svg)](https://badge.fury.io/rb/json-schema-serializer)
@@ -116,7 +116,7 @@ serializer_injected.serialize([1, 2, 3])
 
 ### "additionalProperties"
 
-"additionalProperties" is allowed but must be a schema object. (not boolean)
+"additionalProperties" is allowed but must be a schema object or `false`. (not `true`)
 
 If "additionalProperties" does not exists, this serializer works as `{ additionalProperties": false }`.
 
@@ -167,6 +167,121 @@ serializer2 = JSON::Schema::Serializer.new(schema["properties"]["bar"], {
 })
 ```
 
+## JSON::Schema::Serializer API
+
+### .new(schema, options = nil)
+
+The initializer.
+
+      # @param schema [any] JSON schema object. The serializer tries schema["type"], schema[:type] and schema.type!
+      # @param options [Hash] options
+      # @option options [Proc] :resolver schema object resolver
+      # @option options [Hashlike<String, Class>] :injectors If schema has inject key, the serializer treats injectors[inject_key].new(data).
+      # @option options [String, Symbol] :inject_key inject key
+      # @option 
+
+#### schema [any]
+
+JSON schema object. The serializer tries schema["type"], schema[:type] and schema.type!
+
+#### options [Hash]
+
+options
+
+#### options[:resolver] [Proc]
+
+schema object `$ref` resolver
+
+#### options[:input_key_transform] [Proc]
+
+input key transform
+
+```ruby
+new({
+  type: :object,
+  properties: {
+    userCount: { type: :integer },
+  },
+}, { input_key_transform: ->(name) { name.underscore } }).serialize({ user_count: 1 }) == { "userCount" => 1 }
+```
+
+#### options[:output_key_transform] [Proc]
+
+output key transform
+
+```ruby
+new({
+  type: :object,
+  properties: {
+    userCount: { type: :integer },
+  },
+}, { output_key_transform: ->(name) { name.underscore } }).serialize({ userCount: 1 }) == { "user_count" => 1 }
+```
+
+#### options[:injectors] [Hashlike<String, Class>, Class], options[:inject_key] [String, Symbol]
+
+If schema has inject key, the serializer treats data by `injectors[inject_key].new(data)` (or `injectors.send(inject_key).new(data)`).
+
+See examples in [Usage](#usage).
+
+#### options[:null_through] [Boolean]
+
+If data is null, always serialize null.
+
+```ruby
+new({ type: :string }, { null_through: true }).serialize(nil) == nil
+```
+
+#### options[:empty_string_number_coerce_null] [Boolean]
+
+If data == "" in integer or number schema, returns nil.
+
+```ruby
+new({ type: :integer }, { empty_string_number_coerce_null: true }).serialize("") == nil
+```
+
+#### options[:empty_string_boolean_coerce_null] [Boolean]
+
+If data == "" in boolean schema, returns nil.
+
+```ruby
+new({ type: :boolean }, { empty_string_boolean_coerce_null: true }).serialize("") == nil
+```
+
+#### options[:false_values] [Enumerable]
+
+If specified, boolean schema treats `!false_values.include?(data)`.
+
+```ruby
+new({ type: :boolean }, { false_values: Set.new([false]) }).serialize(nil) == true
+```
+
+#### options[:no_boolean_coerce] [Boolean]
+
+If true, boolean schema treats only `true` to be `true`.
+
+```ruby
+new({ type: :boolean }, { no_boolean_coerce: true }).serialize(1) == false
+```
+
+#### options[:guard_primitive_in_structure] [Boolean]
+
+If true, array or object schema does not accept primitive data and returns empty value.
+
+
+```ruby
+new({ type: :object }, { guard_primitive_in_structure: true }).serialize(1) == {}
+new({ type: :object }, { guard_primitive_in_structure: true, null_through: true }).serialize(1) == nil
+```
+
+### #serialize(data)
+
+Serialize the object data by the schema.
+
+#### data [any]
+
+Serialize target object. The serializer tries data["foo"], data[:foo] and data.foo!
+
 ## License
 
 Zlib License

data/json-schema-serializer.gemspec

@@ -4,7 +4,7 @@ require "json/schema/serializer/version"
 
 Gem::Specification.new do |spec|
   spec.name = "json-schema-serializer"
-  spec.version = Json::Schema::Serializer::VERSION
+  spec.version = JSON::Schema::Serializer::VERSION
   spec.authors = %w[Narazaka]
   spec.email = %w[info@narazaka.net]
   spec.licenses = %w[Zlib]

data/lib/json/schema/serializer.rb

@@ -5,13 +5,13 @@ require "set"
 module JSON
   class Schema
     class Serializer
-      def initialize(obj, options = {})
-        @schema = options && options[:resolver] ? options[:resolver].call(obj) : obj
-        @options = options
+      def initialize(schema, options = nil)
+        @schema = options && options[:resolver] ? options[:resolver].call(schema) : schema
+        @options = options || {}
       end
 
-      def serialize(obj)
-        Walker.walk(@schema, obj, true, @options)
+      def serialize(data)
+        Walker.walk(@schema, data, true, @options)
       end
 
       class Walker
@@ -121,7 +121,7 @@ module JSON
             when "string"
               case obj
               when nil
-                ""
+                options[:null_through] ? nil : ""
               when DateTime, Date, Time, TimeWithZone
                 case format.to_s
                 when "date-time"
@@ -134,7 +134,7 @@ module JSON
                   obj.to_s
                 end
               when Regexp
-                obj.inspect.gsub(%r`^/|/[a-z]*$`, '')
+                obj.inspect.gsub(%r{^/|/[a-z]*$}, "")
               else
                 obj.to_s
               end
@@ -144,6 +144,10 @@ module JSON
                 1
               when false
                 0
+              when nil
+                options[:null_through] ? nil : 0
+              when ""
+                options[:empty_string_number_coerce_null] ? nil : 0
               else
                 obj.to_i
               end
@@ -153,28 +157,55 @@ module JSON
                 1.0
               when false
                 0.0
+              when nil
+                options[:null_through] ? nil : 0.0
+              when ""
+                options[:empty_string_number_coerce_null] ? nil : 0.0
               else
                 obj.to_f
               end
             when "boolean"
-              obj == true
+              if obj.nil? && options[:null_through]
+                nil
+              elsif options[:empty_string_boolean_coerce_null] && obj == ""
+                nil
+              elsif options[:false_values]
+                !options[:false_values].include?(obj)
+              elsif options[:no_boolean_coerce]
+                obj == true
+              else
+                obj ? true : false
+              end
             when "array"
               items_schema = try_hash(schema, :items)
-              obj.nil? ? [] : obj.map { |item| walk(items_schema, item, true, options) }
+              return options[:null_through] ? nil : [] if obj.nil? || !obj.respond_to?(:map)
+              return options[:null_through] ? nil : [] if options[:guard_primitive_in_structure] && is_primitive?(obj)
+
+              obj.map { |item| walk(items_schema, item, true, options) }
             when "object"
+              return nil if obj.nil? && options[:null_through]
+              return options[:null_through] ? nil : {} if options[:guard_primitive_in_structure] && is_primitive?(obj)
+
               properties_schema = try_hash(schema, :properties)
               additional_properties_schema = try_hash(schema, :additionalProperties)
               required_schema = Set.new(try_hash(schema, :required)&.map(&:to_s))
-              ret = properties_schema.map do |name, property_schema|
-                [name.to_s, walk(property_schema, try_hash(obj, name), required_schema.include?(name.to_s), options)]
-              end.to_h
+              input_key_transform = options[:input_key_transform] # schema key -> input obj key
+              output_key_transform = options[:output_key_transform] # schema key -> out
+              ret =
+                properties_schema.map do |name, property_schema|
+                  input_key = input_key_transform ? input_key_transform.call(name.to_s) : name
+                  output_key = output_key_transform ? output_key_transform.call(name.to_s) : name.to_s
+                  [output_key, walk(property_schema, try_hash(obj, input_key), required_schema.include?(name.to_s), options)]
+                end.to_h
               if additional_properties_schema
-                not_additional_keys = Set.new(properties_schema.keys.map(&:to_s))
+                not_additional_keys_array = properties_schema.keys.map(&:to_s)
+                not_additional_keys = Set.new(input_key_transform ? not_additional_keys_array.map { |k| input_key_transform.call(k) } : not_additional_keys_array)
                 additional_keys = obj.keys.reject { |key| not_additional_keys.include?(key.to_s) }
                 ret.merge(
                   additional_keys.map do |name|
-                    [name.to_s, walk(additional_properties_schema, try_hash(obj, name), false, options)]
-                  end.to_h
+                    output_key = output_key_transform ? output_key_transform.call(name.to_s) : name.to_s
+                    [output_key, walk(additional_properties_schema, try_hash(obj, name), false, options)]
+                  end.to_h,
                 )
               else
                 ret
@@ -186,11 +217,20 @@ module JSON
 
           def try_hash(obj, name)
             if obj.respond_to?(:"[]")
-              obj[name] || obj[name.is_a?(Symbol) ? name.to_s : name.to_sym]
+              obj[name] || obj[name.is_a?(String) ? name.to_sym : name.to_s]
             elsif obj.respond_to?(name)
               obj.send(name)
             end
           end
+
+          def is_primitive?(obj)
+            case obj
+            when String, Integer, Float, true, false, nil
+              true
+            else
+              false
+            end
+          end
         end
       end
     end

data/lib/json/schema/serializer/version.rb

@@ -1,7 +1,7 @@
-module Json
-  module Schema
-    module Serializer
-      VERSION = "1.4.0".freeze
+module JSON
+  class Schema
+    class Serializer
+      VERSION = "1.5.0".freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json-schema-serializer
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Narazaka
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-01 00:00:00.000000000 Z
+date: 2019-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -181,7 +181,7 @@ metadata:
   homepage_uri: https://github.com/Narazaka/json-schema-serializer
   source_code_uri: https://github.com/Narazaka/json-schema-serializer.git
   changelog_uri: https://github.com/Narazaka/json-schema-serializer/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/json-schema-serializer/1.4.0
+  documentation_uri: https://www.rubydoc.info/gems/json-schema-serializer/1.5.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -197,7 +197,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: JSON Schema based serializer