userializer 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 005acb6633b44efdcba248bb884d037db223f4fcd214922d0b3f652fc4e31bea
-  data.tar.gz: 11297dd72a7cc9db42e90dc47567b66cbaea86ae511507fadc59bdef91e2d3ee
+  metadata.gz: 6ff350c75deb5f250911135a9ea0cd76b0d0edc451186f5a870895818476862d
+  data.tar.gz: 6faf6e27adbc666f620235d15ec4d8ceb62b54ef39416c6693c81d0f59cf84ff
 SHA512:
-  metadata.gz: aed7569fce17d28d3f8d774487ce0743c4e5b11d4a90d41f077b52efe6013ced67e1eef9e8c4d10435a309a62a69beefdc1736571b1859b4af99a9783a2c1519
-  data.tar.gz: ec13d1091403bce5a7d9b87a5f10e27e6f98494795117501fdf5155642c9f2ed802dc015ae4a5c46b5c125831572350d8ed923696b49b4dad9dadd37e08215d4
+  metadata.gz: 55bb0fae587d95804183d68495be2e19da3fe1d3f26acb5604fd0a05a715357a14ac6027af276d42c03f59e12067f54f35b85ee09452c2455987b9bcf4be3b8a
+  data.tar.gz: d0219c7986d8bb650d247f1d6e43612f84afc6ee58f7919da08767b760c8a720e1a9d5aef343a03a43c89a8981dfdc936507e2036dfefe81c5fbb72ea3806c1c

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

@@ -20,7 +20,152 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+USerializer's DSL is relatively close to Active Model Serializer's,
+while having a few additional features including:
+* Attributes Conditional Declaration
+* Attributes Inline Definition
+
+### Attributes Conditional Declaration
+
+USerializer allows you to dynamically decide wether an attribute should
+be serialized or not by passing its definition an `if` block as follows:
+```ruby
+attributes :conditional_attr, if: proc { |_, opts| ... }
+```
+
+Eg: Let's say you want to serialize an `Order` object but want to
+include its `price` only if it's superior to *10*, your serializer
+would look like the following:
+```ruby
+class Order < ActiveRecord::Base
+  def price
+    10
+  end
+end
+
+class OrderSerializer < USerializer::BaseSerializer
+  attributes :price, if: proc do |obj, _|
+    obj.price > 10
+  end
+end
+```
+
+In that case for example, the `price` attribute would be omitted from
+the final response.
+
+### Attributes Inline Definition
+
+Using AMS, the only way to rewrite an attribute prior to serialization
+is to override it using a method with the same name, leading to
+something like this:
+```ruby
+class MyObject < ActiveRecord::Base
+  def random_attr
+    0
+  end
+end
+
+class MyObjectSerializer < ActiveModel::Serializer
+  attributes :random_attr
+
+  def random_attr
+    object.random_attr + 1
+  end
+end
+```
+
+While this code works perfectly, it pushes the serialized attribute
+value definition back from its declaration, causing developers to lose
+focus when listing their serialized attributes because the overriding is
+done farther.
+
+With USerializer, all of this is done in an inline way, so that you can
+override the attribute's value while declaring using a block as
+follows:
+```ruby
+attributes :your_attribute do |object, _|
+  ...
+end
+```
+
+Our `random_attr` serialization would then looks like this with
+USerializer:
+```ruby
+class MyObjectSerializer < USerializer::BaseSerializer
+  attributes :random_attr do |object, _|
+    object.random_attr + 1
+  end
+end
+```
+
+Way nicer, right?
+
+### Relationships
+
+Just like AMS, USerializer supports `has_one` and `has_many`
+relationships
+
+### Serialized Output
+
+The following outputs will be based an on our `Order` object in
+different situations:
+
+* Order is serialized without any relationships:
+```json
+{
+  "order": {
+    "id": 1,
+    "attr_1": "value_1",
+    "attr_2": "value_2",
+    "attr_3": "value_3",
+  }
+}
+```
+
+* Order has a `has_one` relationship with a `Client` model
+```json
+{
+  "clients": [
+    {
+      "id": 4,
+      "name": "userializer client",
+      ...
+    }
+  ],
+  "order": {
+    "id": 1,
+    "attr_1": "value_1",
+    "attr_2": "value_2",
+    "attr_3": "value_3",
+    "client_id": 4
+  }
+}
+```
+
+* Order has a `has_many` relationship with an `Article` model
+```json
+{
+  "articles": [
+    {
+      "id": 1,
+      "name": "Article #1",
+      ...
+    },
+    {
+      "id": 1,
+      "name": "Article #2",
+      ...
+    }
+  ],
+  "order": {
+    "id": 1,
+    "attr_1": "value_1",
+    "attr_2": "value_2",
+    "attr_3": "value_3",
+    "article_ids": [1, 2]
+  }
+}
+```
 
 ## Development
 

data/lib/userializer/array_serializer.rb

@@ -14,24 +14,31 @@ module USerializer
 
       raise HeterogeneousArray if clss.count > 1
 
-      @root_key = opts[:root] || ActiveSupport::Inflector.pluralize(
+      @root_key = opts[:root]
+      @root_key ||= ActiveSupport::Inflector.pluralize(
         ActiveSupport::Inflector.underscore(obj_class.name).split('/').last
-      ).to_sym
+      ).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
 
     def to_hash
       res = {}
 
+      res[@root_key] = [] if @root_key
+
       merge_root(res, @opts)
       res[:meta] = @meta if @meta
 
@@ -43,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/base_serializer.rb

@@ -8,8 +8,8 @@ module USerializer
   class BaseSerializer
     class << self
       def inherited(subclass)
-        subclass.attrs = self.attrs || { id: Attribute.new(:id, {}, nil) }
-        subclass.relations = self.relations || {}
+        subclass.attrs = self.attrs.dup || { id: Attribute.new(:id, {}, nil) }
+        subclass.relations = self.relations.dup || {}
       end
 
       def attributes(*attrs, &block)

data/lib/userializer/has_many.rb

@@ -8,21 +8,31 @@ module USerializer
       @opts = opts
       @id_key = "#{ActiveSupport::Inflector.singularize(key)}_ids".to_sym
 
+      @embed_key = opts[:embed_key] || :id
       @conditional_block = opts[:if] || proc { true }
     end
 
     def merge_attributes(res, ser, opts)
       return unless @conditional_block.call(ser.object, opts)
 
-      res[@id_key] = (ser.send(@key) || []).compact.map(&:id).compact
+      res[@id_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
   end
 end

data/lib/userializer/has_one.rb

@@ -6,8 +6,15 @@ module USerializer
       @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
 
@@ -17,7 +24,7 @@ module USerializer
       return unless @conditional_block.call(ser.object, opts)
 
       obj = ser.send(@key)
-      res[@id_key] = obj&.id
+      res[@id_key] = obj.nil? ? nil : obj.send(@embed_key)
     end
 
     def merge_root(res, ser, opts)
@@ -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.2"
+  VERSION = "0.2.0"
 end

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.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexis Montagne
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-05-10 00:00:00.000000000 Z
+date: 2021-02-01 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
@@ -107,7 +107,7 @@ files:
 homepage: https://github.com/upfluence/userializer
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -122,9 +122,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.0.3
+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.2)
-      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