userializer 0.2.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ff350c75deb5f250911135a9ea0cd76b0d0edc451186f5a870895818476862d
-  data.tar.gz: 6faf6e27adbc666f620235d15ec4d8ceb62b54ef39416c6693c81d0f59cf84ff
+  metadata.gz: 39db10c77bd519fffda4b6e6c7e613bc1105a951ab39e677dd8d1aaa0aa6f6b0
+  data.tar.gz: 5327aa7eb5e03f5abe504e4dde6d4e619df810af3802e896e28a72e9edc5c21f
 SHA512:
-  metadata.gz: 55bb0fae587d95804183d68495be2e19da3fe1d3f26acb5604fd0a05a715357a14ac6027af276d42c03f59e12067f54f35b85ee09452c2455987b9bcf4be3b8a
-  data.tar.gz: d0219c7986d8bb650d247f1d6e43612f84afc6ee58f7919da08767b760c8a720e1a9d5aef343a03a43c89a8981dfdc936507e2036dfefe81c5fbb72ea3806c1c
+  metadata.gz: 1fcc67f9270e9c8359dc4488eaf11684fcb952f563a64d41f90cae3d83c1ff31a5c271c2247bc538fa3b5877241d3a7f769a32100c9e04ed9cb327caa15fa92f
+  data.tar.gz: 982d8a1495d2c3a6eb83b498b79a6e9d40910f05226b3e4d14a0d5ab1100d04c4145c1d7e14ccd083f5329cf380089300e131848b7d9d2e6692f498793057b91

data/.github/pull_request_template.md

@@ -0,0 +1,28 @@
+### What does this PR do?
+
+<!-- A brief description of the context of this pull request and its purpose. -->
+
+### What are the observable changes?
+<!-- This question could be adequate with multiple use cases, for example: -->
+
+<!-- Frontend: explain the feature created / updated, give instructions telling how to see the change in staging -->
+<!-- Performance: what metric should be impacted, link to the right graphana dashboard for exemple -->
+<!-- Bug: a given issue trail on sentry should stop happening -->
+<!-- Feature: Implements X thrift service / Z HTTP REST API added, provide instructions on how leverage your feature from staging or your workstation -->
+
+### Good PR checklist
+
+- [ ] Title makes sense
+- [ ] Is against the correct branch
+- [ ] Only addresses one issue
+- [ ] Properly assigned
+- [ ] Added/updated tests
+- [ ] Added/updated documentation
+- [ ] Properly labeled
+
+### Additional Notes
+
+<!--
+    You can add anything you want here, an explanation on the way you built your implementation,
+    precisions on the origin of the bug, gotchas you need to mention.
+ -->

data/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: ci
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  test:
+    name: Run Tests
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        ruby: [2.7, 3.0.3]
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Install Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run the Test Suite
+      run: bundle exec rspec --color --require spec_helper --format progress spec

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

@@ -45,6 +45,7 @@ module USerializer
       @opts = opts
       @meta = opts[:meta]
       @except = Set.new([opts[:except]].flatten.compact)
+      @only = Set.new([opts[:only]].flatten.compact)
 
       @root_key = (opts[:root] || ActiveSupport::Inflector.underscore(
         obj.class.name
@@ -99,15 +100,20 @@ module USerializer
     private
 
     def attributes
-      @attributes ||= (self.class.attrs || {}).values.reject do |attr|
-        @except.include?(attr.key)
+      @attributes ||= (self.class.attrs || {}).values.select do |attr|
+        allow?(attr.key)
       end
     end
 
     def relations
-      @relations ||= (self.class.relations || {}).values.reject do |rel|
-        @except.include?(rel.key)
+      @relations ||= (self.class.relations || {}).values.select do |rel|
+        allow?(rel.key)
       end
     end
+
+    def allow?(key)
+      return @only.include?(key) if @only.any?
+      !@except.include?(key)
+    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,7 +15,7 @@ module USerializer
     def merge_attributes(res, ser, opts)
       return unless @conditional_block.call(ser.object, opts)
 
-      res[@id_key] = (entities(ser) || []).compact.map do |obj|
+      res[@ids_key] = (entities(ser) || []).compact.map do |obj|
         obj.nil? ? nil : obj.send(@embed_key)
       end.compact
     end
@@ -34,5 +34,11 @@ module USerializer
 
       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,7 +3,7 @@ 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]

data/lib/userializer/version.rb

@@ -1,3 +1,3 @@
 module USerializer
-  VERSION = "0.2.0"
+  VERSION = "0.3.2"
 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: userializer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Alexis Montagne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-01 00:00:00.000000000 Z
+date: 2022-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,7 +87,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
+- ".github/pull_request_template.md"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -100,6 +101,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 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: Write a short summary, because RubyGems requires one.

data/.circleci/config.yml

@@ -1,18 +0,0 @@
-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