userializer 0.1.5 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97fa2e63cfd59d981e9a7f8eac172e31830d53ad572aaab8683e62fa26410d27
-  data.tar.gz: 1a6c4b3947dcbe65c7b915ef3f5538e68f0b35805860cd5eb2fe03d01e9b7299
+  metadata.gz: c60edc59f0b2c8635bec13e771422371ec92bf1eb696957321cea2cd56d14161
+  data.tar.gz: 1d7b6365abd81700080e4d63c0995dcca6ff3a24047e22596ea954dd73c4db50
 SHA512:
-  metadata.gz: 1f58f0270860f307e07c2d80a8ee620e338e75db06316e1fedd0f7f916c1cafa96122363b5ff7c775cdc2376483718ca07aa84264a284546d4f9bc72c1e373ab
-  data.tar.gz: '0539527fde035a912a6c97dc1e25d83a49e2a1ada7a30ee9df93f890e7e9d5b76e7b120f88704a2b37f2b9dbaa9c170c4229aeb33f602bb4d4a104c9b4419e7c'
+  metadata.gz: 7339df9d80d2fcad0b5fe7504b9df90c99d8eb2be1d36886a21c4efbd89b793bb37bd3b464b62aa97af05ae68815e6460e0b7e72fdc99e67d5a8387caf828fd9
+  data.tar.gz: '01383c0f9f6e9b0290d25ac88042bd21465d4d10818c38d1c9c37d4f4ec49e64172506744551c0f4720d65a543467149450b4aad46a0ca7d8f9a6f736bf756d6'

data/.circleci/config.yml

@@ -0,0 +1,18 @@
+version: 2
+jobs:
+  run_tests:
+    docker:
+      - image: circleci/ruby:2.7
+
+    working_directory: ~/userializer
+
+    steps:
+      - checkout
+      - run: bundle install --path=vendor/bundle
+      - run: bundle exec rspec --color --require spec_helper --format progress spec
+
+workflows:
+  version: 2
+  test:
+    jobs:
+      - run_tests

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+Gemfile.lock

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

@@ -19,14 +19,18 @@ module USerializer
         ActiveSupport::Inflector.underscore(obj_class.name).split('/').last
       ).to_sym if obj_class
 
-      @serializer = opts[:each_serializer] || USerializer.infered_serializer_class(
-        obj_class
-      )
+      serializer = opts[:each_serializer]
+
+      @serializer = if serializer&.is_a?(Proc)
+                      serializer
+                    elsif serializer
+                      proc { serializer }
+                    end
     end
 
     def merge_root(res, opts)
       @objs.each do |obj|
-        @serializer.new(obj, @opts).merge_root(res, @root_key, false, opts)
+        serializer(obj, opts).merge_root(res, @root_key, false, opts)
       end
     end
 
@@ -46,5 +50,14 @@ module USerializer
     end
 
     def scope; @opts[:scope]; 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
 end

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

@@ -6,7 +6,7 @@ module USerializer
       @key = key
 
       @opts = opts
-      @id_key = "#{ActiveSupport::Inflector.singularize(key)}_ids".to_sym
+      @ids_key = opts[:ids_key] || build_ids_key(key)
 
       @embed_key = opts[:embed_key] || :id
       @conditional_block = opts[:if] || proc { true }
@@ -15,17 +15,30 @@ module USerializer
     def merge_attributes(res, ser, opts)
       return unless @conditional_block.call(ser.object, opts)
 
-      res[@id_key] = (ser.send(@key) || []).compact.map do |obj|
+      res[@ids_key] = (entities(ser) || []).compact.map do |obj|
         obj.nil? ? nil : obj.send(@embed_key)
       end.compact
     end
 
     def merge_root(res, ser, opts)
-      objs = ser.send(@key) || []
+      objs = entities(ser) || []
 
       return if objs.empty? || !@conditional_block.call(ser.object, opts)
 
       ArraySerializer.new(objs, @opts).merge_root(res, opts)
     end
+
+    def entities(ser)
+      obj = ser.send(@key) || []
+      return obj unless @opts[:scope]
+
+      obj.send(@opts[:scope])
+    end
+
+    private
+
+    def build_ids_key(key)
+      "#{ActiveSupport::Inflector.singularize(key)}_ids".to_sym
+    end
   end
 end

data/lib/userializer/has_one.rb

@@ -3,10 +3,17 @@ module USerializer
     def initialize(key, opts)
       @key = key
       @opts = opts
-      @id_key = "#{key}_id".to_sym
+      @id_key = opts[:id_key] || "#{key}_id".to_sym
       @root_key = opts[:root]&.to_sym
 
-      @serializer = opts[:serializer]
+      serializer = opts[:serializer]
+
+      @serializer = if serializer&.is_a?(Proc)
+                      @serializer = serializer
+                    elsif serializer
+                      proc { serializer }
+                    end
+
       @embed_key = opts[:embed_key] || :id
       @conditional_block = opts[:if] || proc { true }
     end
@@ -25,13 +32,13 @@ module USerializer
 
       return if obj.nil? || !@conditional_block.call(ser.object, opts)
 
-      serializer(obj).merge_root(res, root_key(obj), false, opts)
+      serializer(obj, opts).merge_root(res, root_key(obj), false, opts)
     end
 
     private
 
-    def serializer(obj)
-      return @serializer.new(obj, @opts) if @serializer
+    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)

data/lib/userializer/version.rb

@@ -1,3 +1,3 @@
 module USerializer
-  VERSION = "0.1.5"
+  VERSION = "0.3.1"
 end

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/userializer.gemspec

@@ -20,8 +20,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_dependency "oj"
   spec.add_dependency "activesupport"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: userializer
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.3.1
 platform: ruby
 authors:
 - Alexis Montagne
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-06-17 00:00:00.000000000 Z
+date: 2021-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -87,11 +87,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - bin/console
@@ -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
@@ -107,7 +108,7 @@ files:
 homepage: https://github.com/upfluence/userializer
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -122,9 +123,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Write a short summary, because RubyGems requires one.
 test_files: []

data/Gemfile.lock

@@ -1,50 +0,0 @@
-PATH
-  remote: .
-  specs:
-    userializer (0.1.5)
-      activesupport
-      oj
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (5.2.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    concurrent-ruby (1.1.5)
-    diff-lcs (1.3)
-    i18n (1.6.0)
-      concurrent-ruby (~> 1.0)
-    minitest (5.11.3)
-    oj (3.7.12)
-    rake (10.4.2)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  userializer!
-
-BUNDLED WITH
-   1.16.1