pb-serializer 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d65ab2cd7830751ed61e5cd72eca1d688fac910b544167994780d065e55fa3b
-  data.tar.gz: e991534beffa6fb92b4c23f05bf59b5ba0ef6872cd34dc801148e08ec3f2c075
+  metadata.gz: ed65391a95c2c1d8ebdcd7977c8c8992428c062df0f78c1ba7fbf047737e98e1
+  data.tar.gz: 1c6db98b94bde534ebbe2999509791b0e2354b15d5ee5bdde17035081e4bf3e2
 SHA512:
-  metadata.gz: 0a138f78df718b226cbf65cef851380a941c34306ed80bdc2fb65093f0dec804515d0187d3f0b11e4fcd36bbc339dfca08f2beef49989d6417ccf157ddf9da97
-  data.tar.gz: bf343a1d3f7f055370f652616fc6914dc682f2fdc6840c6975614537d5ecf02241974b8df986505f96a517401b676e0756aa2040d181898e8dc866ee76ab305c
+  metadata.gz: 7989d54a7f8f699f97387b9dee18ae93e93eb80c745af81802454d34c7b3c262c8b849248ec979a7a1e15e30a1a0a5beabfad816dbd78852198a3d09ce8a0652
+  data.tar.gz: b9f1e003472b813316869a643ab0214f59eedf1431a998204a57622dffad4287161ff8c57f746d4106b6263ff5cc366c181e948c7ce787de48c98d390ff4c7df

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+## Unreleased
+
+## 0.2.1
+
+- **BREAKING CHANGE** `required` -> `allow_nil` https://github.com/wantedly/pb-serializer/pull/21
+- Make Serializer's constructors extensible https://github.com/wantedly/pb-serializer/pull/22
+
+## 0.2.0
+
+- **BREAKING CHANGE** https://github.com/wantedly/pb-serializer/pull/17
+  - Support loading and serializing arrays
+  - Bump `computed_model` from 0.1.0 to 0.2.1
+  - Change API
+- Add example specs https://github.com/wantedly/pb-serializer/pull/18
+
+
+## 0.1.0
+
+Initial release.

data/README.md

@@ -4,9 +4,9 @@
 class UserSerializer < Pb::Serializer::Base
   message YourApp::User
 
-  attribute :id,    required: true
-  attribute :name,  required: true
-  attribute :posts, required: true
+  attribute :id
+  attribute :name
+  attribute :posts
 
   define_primary_loader :user do |subdeps, ids:, **|
     User.where(id: ids).preload(subdeps).map { |u| new(u) }
@@ -29,9 +29,9 @@ class PostSerializer < Pb::Serializer::Base
     Post.where(user_id: user_ids).preload(subdeps).map { |p| new(p) }
   end
 
-  attribute :id,    required: true
-  attribute :title, required: true
-  attribute :body,  required: true
+  attribute :id
+  attribute :title
+  attribute :body
 end
 
 class UserGrpcService < YourApp::UserService::Service

data/lib/pb/serializable.rb

@@ -22,19 +22,19 @@ module Pb
         v = public_send(attr.name)
         v = attr.convert_to_pb(v)
 
-        if attr.required && attr.field_descriptor.default == v
+        if attr.oneof?
+          if !v.nil?
+            if oneof_set.include?(attr.oneof)
+              raise ::Pb::Serializer::ConflictOneofError, "#{primary_object.class.name}##{attr.name} is oneof attribute"
+            end
+            oneof_set << attr.oneof
+          end
+        elsif !attr.allow_nil? && v.nil?
           raise ::Pb::Serializer::ValidationError, "#{primary_object.class.name}##{attr.name} is required"
         end
 
         next if v.nil?
 
-        if attr.oneof?
-          if oneof_set.include?(attr.oneof)
-            raise ::Pb::Serializer::ConflictOneofError, "#{primary_object.class.name}##{attr.name} is oneof attribute"
-          end
-          oneof_set << attr.oneof
-        end
-
         if attr.repeated?
           o.public_send(attr.name).push(*v)
         else
@@ -44,7 +44,7 @@ module Pb
 
       self.class.oneofs.each do |oneof|
         next if oneof_set.include?(oneof.name)
-        next unless oneof.required?
+        next if oneof.allow_nil?
         raise ::Pb::Serializer::ValidationError, "#{primary_object.class.name}##{oneof.name} is required"
       end
 
@@ -91,15 +91,15 @@ module Pb
       end
 
       # @param name [Symbol] An attribute name
-      # @param required [Boolean] Set true if this attribute should not zero-value
+      # @param allow_nil [Boolean] Set true if this attribute allow to be nil
       # @param serializer [Class] A serializer class for this attribute
-      def attribute(name, required: false, serializer: nil)
+      def attribute(name, allow_nil: false, serializer: nil)
         fd = message_class.descriptor.find { |fd| fd.name.to_sym == name }
         raise ::Pb::Serializer::UnknownFieldError, "#{name} is not defined in #{message_class.name}" unless fd
 
         attr = ::Pb::Serializer::Attribute.new(
           name: name,
-          required: required,
+          allow_nil: allow_nil,
           serializer_class: serializer,
           field_descriptor: fd,
           oneof: @current_oneof&.name,
@@ -126,11 +126,11 @@ module Pb
         bulk_load_and_compute(with, **args)
       end
 
-      def oneof(name, required: true)
+      def oneof(name, allow_nil: false)
         @oneof_by_name ||= {}
         @current_oneof = ::Pb::Serializer::Oneof.new(
           name: name,
-          required: required,
+          allow_nil: allow_nil,
           attributes: [],
         )
         yield

data/lib/pb/serializer/attribute.rb

@@ -2,7 +2,7 @@ module Pb
   module Serializer
     class Attribute < Struct.new(
       :name,
-      :required,
+      :allow_nil,
       :serializer_class,
       :field_descriptor,
       :oneof,
@@ -10,8 +10,8 @@ module Pb
     )
 
       # @return [Boolean]
-      def required?
-        required
+      def allow_nil?
+        allow_nil
       end
 
       # @return [Boolean]
@@ -25,6 +25,7 @@ module Pb
 
       # @param v [Object]
       def convert_to_pb(v, should_repeat: repeated?)
+        return nil if v.nil?
         return v.map { |i| convert_to_pb(i, should_repeat: false) } if should_repeat
 
         case field_descriptor.type
@@ -41,7 +42,6 @@ module Pb
           when "google.protobuf.BoolValue"   then Pb.to_boolval(v)
           when "google.protobuf.BytesValue"  then Pb.to_bytesval(v)
           else
-            return nil if v.nil?
             return serializer_class.new(v).to_pb if serializer_class
             return v.to_pb if v.kind_of?(::Pb::Serializable)
 

data/lib/pb/serializer/base.rb

@@ -8,14 +8,15 @@ module Pb
 
       attr_reader :object
 
-      def initialize(object)
+      def initialize(object, *)
         @object = object
       end
 
       module Hook
         def define_primary_loader(name, &block)
           class_eval <<~RUBY
-            def initialize(object)
+            def initialize(*args)
+              super
               @#{name} = object
             end
           RUBY

data/lib/pb/serializer/oneof.rb

@@ -2,13 +2,13 @@ module Pb
   module Serializer
     class Oneof < Struct.new(
       :name,
-      :required,
+      :allow_nil,
       :attributes,
       keyword_init: true,
     )
       # @return [Boolean]
-      def required?
-        required
+      def allow_nil?
+        allow_nil
       end
     end
   end

data/lib/pb/serializer/version.rb

@@ -1,5 +1,5 @@
 module Pb
   module Serializer
-    VERSION = "0.2.0".freeze
+    VERSION = "0.2.1".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pb-serializer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - izumin5210
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-29 00:00:00.000000000 Z
+date: 2020-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -169,6 +169,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt