userializer 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ff350c75deb5f250911135a9ea0cd76b0d0edc451186f5a870895818476862d
-  data.tar.gz: 6faf6e27adbc666f620235d15ec4d8ceb62b54ef39416c6693c81d0f59cf84ff
+  metadata.gz: f3ef32ea4a17b463844f6c5f59453e206253c59c21735ea9aa6e97c353db2c3d
+  data.tar.gz: 77c4cdcba82ef5a5470da04db24e2984ae7754d8ba25593c0097470f3c0fdf65
 SHA512:
-  metadata.gz: 55bb0fae587d95804183d68495be2e19da3fe1d3f26acb5604fd0a05a715357a14ac6027af276d42c03f59e12067f54f35b85ee09452c2455987b9bcf4be3b8a
-  data.tar.gz: d0219c7986d8bb650d247f1d6e43612f84afc6ee58f7919da08767b760c8a720e1a9d5aef343a03a43c89a8981dfdc936507e2036dfefe81c5fbb72ea3806c1c
+  metadata.gz: 4e48196e2d4264d655eb4da209e7635c56f4849eac2e977522379f358ccf7969cd6189bf3fe5675a721ef3ac9f2e89392099541189ef97f503a1ed1c0ea94f4f
+  data.tar.gz: d8a897a3e951c27488e700fb1f80385501367088219ab7b24505f1a7420b478f5171734f4641d319c9b8d9bf2a119407a8f2012c1bf4d5e6926709b33c99c7db

data/README.md

@@ -167,6 +167,33 @@ different situations:
 }
 ```
 
+### CompositeSerializer
+
+Imagine you have a compound of different data that you want to return to the same payload.
+For example, you have an **array** of a `Foo` class and a `Bar` value to return.
+You can use a `CompositeSerializer` to serialize both.
+
+```ruby
+array_foo = [Foo.new, Foo.new]
+bar = Bar.new
+
+CompositeSerializer.new(
+  { key_foo: array_foo, key_bar: bar },
+  each_serializer: { key_foo: FooCustomSerializer },
+  serializer: { key_bar: BarSerializer },
+  root: { key_foo: :foo_root, key_bar: :bar_root }
+).to_json
+```
+
+this will render:
+
+```json
+{
+  "foo_root": [{... foo1 attributes ...}, {... foo2 attributes ...}],
+  "bar_root": {... bar attributes ...}
+}
+```
+
 ## 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/lib/userializer.rb

@@ -1,6 +1,7 @@
 require 'userializer/version'
 require 'userializer/base_serializer'
 require 'userializer/array_serializer'
+require 'userializer/composite_serializer'
 
 module USerializer
   NS_SEPARATOR = '::'.freeze

data/lib/userializer/composite_serializer.rb

@@ -0,0 +1,78 @@
+require 'oj'
+
+module USerializer
+  class CompositeObject
+    def initialize(obj, opts = {})
+      @obj = obj
+      @opts = opts
+      @root_key = opts[:root].to_sym
+      serializer = opts[:serializer]
+      @serializer = if serializer.is_a?(Proc)
+                      serializer
+                    elsif serializer
+                      proc { serializer }
+                    end
+    end
+
+    def merge_root(res, opts)
+      serializer(@obj, opts).merge_root(res, @root_key, true, opts)
+    end
+
+    private
+
+    def serializer(obj, opts)
+      return @serializer.call(obj, opts).new(obj, @opts) if @serializer
+      return obj.serialize if obj.respond_to?(:serialize)
+
+      USerializer.infered_serializer_class(obj.class).new(obj, @opts)
+    end
+  end
+
+  class CompositeSerializer
+    def initialize(objs, opts = {})
+      @opts = opts
+      @objs = compose_objs(objs)
+    end
+
+    def merge_root(res, opts)
+      @objs.each do |obj|
+        obj.merge_root(res, opts)
+      end
+    end
+
+    def to_hash
+      res = {}
+
+      merge_root(res, @opts)
+      res
+    end
+
+    def serialize(*_args)
+      to_hash
+    end
+
+    def to_json(*_args)
+      Oj.dump(to_hash, mode: :compat)
+    end
+
+    private
+
+    def compose_objs(objs)
+      objs.map do |(key, obj)|
+        opts = options_for(key)
+
+        if obj.is_a? Enumerable
+          ArraySerializer.new(obj, opts)
+        else
+          CompositeObject.new(obj, opts)
+        end
+      end
+    end
+
+    def options_for(key)
+      @opts.reduce({}) do |acc, (opt_key, values)|
+        acc.merge(opt_key.to_sym => values[key.to_sym])
+      end.compact.merge(root: key) { |_, x, y| x || y }
+    end
+  end
+end

data/lib/userializer/version.rb

@@ -1,3 +1,3 @@
 module USerializer
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: userializer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Alexis Montagne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-01 00:00:00.000000000 Z
+date: 2021-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,6 +100,7 @@ files:
 - lib/userializer/array_serializer.rb
 - lib/userializer/attribute.rb
 - lib/userializer/base_serializer.rb
+- lib/userializer/composite_serializer.rb
 - lib/userializer/has_many.rb
 - lib/userializer/has_one.rb
 - lib/userializer/version.rb
@@ -122,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Write a short summary, because RubyGems requires one.