userializer 0.3.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3ef32ea4a17b463844f6c5f59453e206253c59c21735ea9aa6e97c353db2c3d
-  data.tar.gz: 77c4cdcba82ef5a5470da04db24e2984ae7754d8ba25593c0097470f3c0fdf65
+  metadata.gz: 3cb0544f358655737798992e56aca1d2b2637508bf05c1968788832028fe2048
+  data.tar.gz: e5ad28d55ce77894acbf6763553f478e257375d3f2cbb11e2c267d35e14d1841
 SHA512:
-  metadata.gz: 4e48196e2d4264d655eb4da209e7635c56f4849eac2e977522379f358ccf7969cd6189bf3fe5675a721ef3ac9f2e89392099541189ef97f503a1ed1c0ea94f4f
-  data.tar.gz: d8a897a3e951c27488e700fb1f80385501367088219ab7b24505f1a7420b478f5171734f4641d319c9b8d9bf2a119407a8f2012c1bf4d5e6926709b33c99c7db
+  metadata.gz: 59bcbc899d524be1e2804845cef37c3eddf446fdfb8f40c6d30ede4909561f5aadf2d9f7ad8b2564aa8e39d6bc79cf206c12966e020cca3528eb5e041fd2719b
+  data.tar.gz: 8a6e2acf4fb731529b867e0ef33f146a410662a0edd566c34a4a18edf08c67e822d9c2c0ac789cc657c3893bc906c90b974f78486ce4c91f4ae228e07b78c0a0

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/lib/userializer/attribute.rb

@@ -7,13 +7,18 @@ module USerializer
       @opts = opts
       @block = block
 
+      @skip_nil = opts[:skip_nil] || false
       @conditional_block = opts[:if] || proc { true }
     end
 
     def merge_attributes(res, ser, opts)
       return unless @conditional_block.call(ser.object, opts)
 
-      res[@key] = @block ? @block.call(ser.object, opts) : ser.send(@key)
+      value = @block ? @block.call(ser.object, opts) : ser.send(@key)
+
+      return if value.nil? && @skip_nil
+
+      res[@key] = value
     end
   end
 end

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/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.3.0"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: userializer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.3
 platform: ruby
 authors:
 - Alexis Montagne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-10 00:00:00.000000000 Z
+date: 2022-05-31 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"
@@ -123,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+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