json-schema-serializer 1.6.0 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54b6ef10587ab0aaeb6bb6aa85ae56daef39f714c356ace19352336c04864ae8
-  data.tar.gz: 360d4fef03c36d567ae2e229c2632bca7af26ce9c4e19ec036590917ecffdd93
+  metadata.gz: 8520da63406ec92ce27f94214e6377eb0235fa22745c1dd9473fb597bfc2acdd
+  data.tar.gz: 36de8e40ad358955d937e2b46141c0da13e9b7cff328a26194e6e52991c1b2cc
 SHA512:
-  metadata.gz: 4a1fe23e623221c1651c681562fedaa146578f6e495fb23989e4358e75e63d78b63b8d18443e3a52db0ff0f65a3bca58b263177cac8f616ceabe6b9bb964b2ae
-  data.tar.gz: 929372326ff9c370c1d04df9d36e3da7d2183a05354cb34cbaee7fe334b7e609eec75267371108c3953db7efa8edfc8208f40155bc79496e8f0632dec539df43
+  metadata.gz: a6a9d1927d21adc4c7a499313b195e63465302018e4575a83c9095236c31df86eb1037e5d06618ad07fa0674c620c5cd2b58aad0aae2ae04884f3c0f9b6592c8
+  data.tar.gz: f3d64406270a9b00f816106611cf1327ed5eab8bd9ec5472bb577fbfda8f0ef415404563fda4fd50008441388d03f655d82c0085f9dd8b5aba95438c1d50d9f7

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## 1.7.0
+
+- add: `with_context!` api
+- add: `:inject_by_keyword` option
+
+## 1.6.0
+
+- add: inject context
+
 ## 1.5.0
 
 - add: many options

data/README.md

@@ -157,6 +157,133 @@ serializer_injected_with_context = JSON::Schema::Serializer.new(
 
 serializer_injected_with_context.serialize({ id: 1 })
 # => { "id" => 1, "score" => 100 }
+
+#
+# inject in serializer
+#
+
+class ParentSerializer
+  include JSON::Schema::Serializer::WithContext
+
+  def initialize(model, context = nil)
+    @model = model
+    @context = context
+  end
+
+  def id
+    @model[:id]
+  end
+
+  def score
+    @context[:parent_scores][@model[:id]]
+  end
+
+  def child
+    # it can be
+    # with_context(context) { data }
+    # with_context(data, context)
+    # with_context(data: data, context: context)
+    with_context(@context.merge(child_scores: { 1 => 100, 2 => 200 })) do
+      @model[:child]
+    end
+  end
+end
+
+class ChildSerializer
+  def initialize(model, context = nil)
+    @model = model
+    @context = context
+  end
+
+  def id
+    @model[:id]
+  end
+
+  def score
+    @context[:child_scores][@model[:id]]
+  end
+end
+
+serializer_injected_with_context_in_serializer = JSON::Schema::Serializer.new(
+  {
+    type: :object,
+    inject: :Parent,
+    properties: {
+      id: { type: :integer },
+      score: { type: :integer },
+      child: {
+        type: :object,
+        inject: :Child,
+        properties: {
+          id: { type: :integer },
+          score: { type: :integer },
+        },
+      },
+    },
+  },
+  {
+    inject_key: :inject,
+    injectors: {
+      Parent: ParentSerializer,
+      Child: ChildSerializer,
+    },
+    inject_context: { 1 => 10, 2 => 20 },
+  },
+)
+
+serializer_injected_with_context_in_serializer.serialize({ id: 1, child: { id: 2 } })
+# => { "id" => 1, "score" => 10, "child" => { "id" => 2, "score" => 200 } }
+
+#
+# also you can inject context with arraylike data
+#
+
+class ItemsSerializer
+  include JSON::Schema::Serializer::WithContext
+
+  def initialize(models, context = nil)
+    @models = models
+    @context = context
+  end
+
+  def map(&block)
+    context = (@context || {}).merge(scores: {...})
+    @models.map { |model| block.call(with_context(model, context)) }
+    # CAUTION!
+    # not like below!
+    # with_context(@models.map(&block), context)
+    # with_context(context) { @models.map(&block) }
+  end
+end
+
+#
+# inject model can initialize by keywords
+#
+
+class KeywordSerializer
+  def initialize(data:, context: nil)
+    @data = data
+    @context = context
+  end
+
+  ...
+end
+
+serializer_with_keyword_init_inject = JSON::Schema::Serializer.new(
+  {
+    type: :object,
+    inject: :Keyword,
+    properties: { ... },
+  },
+  {
+    inject_key: :inject,
+    injectors: {
+      Keyword: KeywordSerializer,
+      Child: ChildSerializer,
+    },
+    inject_by_keyword: true, # <- keyword_init!
+  },
+)
 ```
 
 ### "additionalProperties"
@@ -256,12 +383,14 @@ new({
 }, { schema_key_transform_for_output: ->(name) { name.underscore } }).serialize({ userCount: 1 }) == { "user_count" => 1 }
 ```
 
-#### options[:injectors] [Hashlike<String, Class>, Class], options[:inject_key] [String, Symbol], options[:inject_context] [any]
+#### options[:injectors] [Hashlike<String, Class>, Class], options[:inject_key] [String, Symbol], options[:inject_context] [any], options[:inject_by_keyword] [Boolean]
 
 If schema has inject key, the serializer treats data by `injectors[inject_key].new(data)` (or `injectors.send(inject_key).new(data)`).
 
 And if `inject_context` is present, `injectors[inject_key].new(data, inject_context)` (or `injectors.send(inject_key).new(data, inject_context)`).
 
+And if `inject_by_keyword` is true, `new(data, inject_context)` will be `new(data: data, context: inject_context)`.
+
 See examples in [Usage](#usage).
 
 CAUTION: In many case you should define the `nil?` method in the injector class because Injector always initialized by `Injector.new(obj)` even if obj == nil.
@@ -324,6 +453,14 @@ Serialize the object data by the schema.
 
 Serialize target object. The serializer tries data["foo"], data[:foo] and data.foo!
 
+## JSON::Schema::Serializer::WithContext API
+
+### #with_context!(data, context), #with_context!(data: data, context: context), #with_context!(context) { data }
+
+If you use `with_context!(data, context)` as the return value of the serializer, then "child" serializer can use that context.
+
+See examples in [Usage](#usage).
+
 ## License
 
 Zlib License

data/lib/json/schema/serializer.rb

@@ -14,6 +14,22 @@ module JSON
         Walker.walk(@schema, data, true, @options)
       end
 
+      DataWithContext = Struct.new(:data, :context, keyword_init: true)
+
+      module WithContext
+        ARG2_NOT_GIVEN = :__json_schema_serializer_arg2_not_given__
+
+        def with_context!(arg1, arg2 = ARG2_NOT_GIVEN) # rubocop:disable Airbnb/OptArgParameters
+          if block_given?
+            DataWithContext.new(data: yield, context: arg1)
+          elsif arg2 == ARG2_NOT_GIVEN
+            DataWithContext.new(arg1)
+          else
+            DataWithContext.new(data: arg1, context: arg2)
+          end
+        end
+      end
+
       class Walker
         class << self
           TimeWithZone = defined?(ActiveSupport::TimeWithZone) ? ActiveSupport::TimeWithZone : nil
@@ -27,11 +43,25 @@ module JSON
             if options[:inject_key]
               inject_key = try_hash(schema, options[:inject_key])
               injector = try_hash(options[:injectors], inject_key) if inject_key
+              if obj.instance_of?(JSON::Schema::Serializer::DataWithContext)
+                options = options.merge(inject_context: obj.context)
+                obj = obj.data
+              end
               if injector
                 if options[:inject_context]
-                  obj = injector.new(obj, options[:inject_context])
+                  obj =
+                    if options[:inject_by_keyword]
+                      injector.new(data: obj, context: options[:inject_context])
+                    else
+                      injector.new(obj, options[:inject_context])
+                    end
                 else
-                  obj = injector.new(obj)
+                  obj =
+                    if options[:inject_by_keyword]
+                      injector.new(data: obj)
+                    else
+                      injector.new(obj)
+                    end
                 end
               end
             end

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

@@ -1,7 +1,7 @@
 module JSON
   class Schema
     class Serializer
-      VERSION = "1.6.0".freeze
+      VERSION = "1.7.1".freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json-schema-serializer
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.1
 platform: ruby
 authors:
 - Narazaka
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-10 00:00:00.000000000 Z
+date: 2020-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -195,7 +195,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.6.0
+  documentation_uri: https://www.rubydoc.info/gems/json-schema-serializer/1.7.1
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -211,8 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: JSON Schema based serializer