pb-serializer 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed65391a95c2c1d8ebdcd7977c8c8992428c062df0f78c1ba7fbf047737e98e1
-  data.tar.gz: 1c6db98b94bde534ebbe2999509791b0e2354b15d5ee5bdde17035081e4bf3e2
+  metadata.gz: d1f988a05d9e793ea7b9f8e7ce7424f3f0d2f7252c536322c881d7b7921f5c1d
+  data.tar.gz: 9136b5e10daa4852db5ade8435d128851e4e1a636eb78fbe612ebca55d47de2a
 SHA512:
-  metadata.gz: 7989d54a7f8f699f97387b9dee18ae93e93eb80c745af81802454d34c7b3c262c8b849248ec979a7a1e15e30a1a0a5beabfad816dbd78852198a3d09ce8a0652
-  data.tar.gz: b9f1e003472b813316869a643ab0214f59eedf1431a998204a57622dffad4287161ff8c57f746d4106b6263ff5cc366c181e948c7ce787de48c98d390ff4c7df
+  metadata.gz: 959064c2628dcc51320b6c1fc4e82dffce9f60529740853333198b6a0b9c66db8acfacb5476a9898362a7f7a8fae1e8aa1261ffb32d1d33bd383749645337470
+  data.tar.gz: c8f0c9d172cebdbe9f40afca16ec79a62a2c4da32c12821e3420fe36747c6e7a6192d012a029e91427af6cdfb4da65e4f9e82212537e67beefdf8c17bbe04326

data/.github/workflows/ci.yml

@@ -30,3 +30,9 @@ jobs:
     - run: bundle install --jobs 4 --retry 3
 
     - run: bundle exec rspec
+      env:
+        CI: true
+
+    - uses: codecov/codecov-action@v1
+      with:
+        file: ./coverage/coverage.xml

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## Unreleased
 
+## 0.3.0
+
+- Support `if` option https://github.com/wantedly/pb-serializer/pull/24
+- Improve error handling https://github.com/wantedly/pb-serializer/pull/26
+    - raise `MissingMessageTypeError` if `message` declaration is missed
+    - raise `MissingFieldError` if `attribute` declaration is missed
+    - raise `InvalidOptionError` when `attribute` receives invalid params
+- Introduce Pb::Serializer.configure https://github.com/wantedly/pb-serializer/pull/27
+    - Add `missing_field_behavior` config to suppress `MissingFieldError`
+    - Rename `InvalidOptionError` -> `InvalidAttributeOptionError`
+- Skip serializing when a value is already serialized https://github.com/wantedly/pb-serializer/pull/29
+
+
 ## 0.2.1
 
 - **BREAKING CHANGE** `required` -> `allow_nil` https://github.com/wantedly/pb-serializer/pull/21

data/README.md

@@ -1,4 +1,8 @@
 # Pb::Serializer
+[![CI](https://github.com/wantedly/pb-serializer/workflows/CI/badge.svg?branch=master)](https://github.com/wantedly/pb-serializer/actions?query=workflow%3ACI+branch%3Amaster)
+[![codecov](https://codecov.io/gh/wantedly/pb-serializer/branch/master/graph/badge.svg)](https://codecov.io/gh/wantedly/pb-serializer)
+[![Gem Version](https://badge.fury.io/rb/pb-serializer.svg)](https://badge.fury.io/rb/pb-serializer)
+[![License](https://img.shields.io/github/license/wantedly/pb-serializer)](./LICENSE)
 
 ```rb
 class UserSerializer < Pb::Serializer::Base

data/codecov.yml

@@ -0,0 +1,6 @@
+coverage:
+  status:
+    project:
+      default:
+        target: 95%
+    patch: off

data/lib/pb/serializable.rb

@@ -15,7 +15,18 @@ module Pb
       self.class.message_class.descriptor.each do |fd|
         attr = self.class.find_attribute_by_field_descriptor(fd)
 
-        next unless attr # TODO
+        unless attr
+          msg = "#{self.class.message_class.name}.#{fd.name} is missed in #{self.class.name}"
+
+          case Pb::Serializer.configuration.missing_field_behavior
+          when :raise then raise ::Pb::Serializer::MissingFieldError, msg
+          when :warn  then Pb::Serializer.logger.warn msg
+          end
+
+          next
+        end
+
+        next unless attr.serializable?(self)
 
         raise "#{self.name}.#{attr.name} is not defined" unless respond_to?(attr.name)
 
@@ -91,16 +102,20 @@ module Pb
       end
 
       # @param name [Symbol] An attribute name
-      # @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, allow_nil: false, serializer: nil)
+      # @param [Hash] opts options
+      # @option opts [Boolean] :allow_nil Set true if this attribute allow to be nil
+      # @option opts [Class] :serializer A serializer class for this attribute
+      # @option opts [String, Symbol, Proc] :if A method, proc or string to call to determine to serialize this field
+      def attribute(name, opts = {})
+        raise ::Pb::Serializer::MissingMessageTypeError, "message specificaiton is missed" unless message_class
+
         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,
-          allow_nil: allow_nil,
-          serializer_class: serializer,
+          options: opts,
           field_descriptor: fd,
           oneof: @current_oneof&.name,
         )
@@ -145,7 +160,7 @@ module Pb
       # @param fd [Google::Protobuf::FieldDescriptor] a field descriptor
       # @return [Pb::Serializer::Attribute, nil]
       def find_attribute_by_field_descriptor(fd)
-        @attr_by_name[fd.name.to_sym]
+        (@attr_by_name || {})[fd.name.to_sym]
       end
 
       def oneofs

data/lib/pb/serializer.rb

@@ -10,11 +10,58 @@ require "pb/serializer/oneof"
 module Pb
   module Serializer
     class Error < StandardError; end
+    class InvalidConfigurationError < Error; end
+    class MissingMessageTypeError < Error; end
     class UnknownFieldError < Error; end
     class ValidationError < Error; end
     class ConflictOneofError < Error; end
+    class InvalidAttributeOptionError < Error; end
+    class MissingFieldError < Error; end
+
+    class Configuration
+      # @!attribute logger
+      #   @return [Logger]
+      attr_accessor :logger
+      # @!attribute [r] missing_field_behavior
+      #   @return [:raise, :warn, :ignore] default: `:raise`
+      attr_reader :missing_field_behavior
+
+      def initialize
+        self.missing_field_behavior = :raise
+        self.logger = Logger.new(STDOUT)
+      end
+
+      # @param v [:raise, :warn, :ignore]
+      def missing_field_behavior=(v)
+        @missing_field_behavior = v
+
+        unless %i(raise warn ignore).include?(v)
+          raise InvalidConfigurationError, "missing_field_behavior #{v} is not allowed"
+        end
+      end
+    end
 
     class << self
+      # @example
+      #   Pb::Serializer.configuration do |c|
+      #     c.missing_field_behavior = :raise  # :raise, :warn or :ignore (defualt: :raise)
+      #   end
+      # @yield [c]
+      # @yieldparam [Configuration] config
+      def configure
+        yield configuration
+      end
+
+      # @return [Pb::Serializer::Configuration]
+      def configuration
+        @configuraiton ||= Configuration.new
+      end
+
+      # @return [Logger]
+      def logger
+        configuration.logger
+      end
+
       # @param [Google::Protobuf::Descriptor]
       def build_default_mask(descriptor)
         set =

data/lib/pb/serializer/attribute.rb

@@ -2,16 +2,31 @@ module Pb
   module Serializer
     class Attribute < Struct.new(
       :name,
-      :allow_nil,
-      :serializer_class,
+      :options,
       :field_descriptor,
       :oneof,
       keyword_init: true,
     )
 
+      ALLOWED_OPTIONS = Set[:allow_nil, :if, :serializer].freeze
+
+      def initialize(options:, **)
+        super
+
+        unknown_options = options.keys.to_set - ALLOWED_OPTIONS
+        unless unknown_options.empty?
+          raise InvalidAttributeOptionError, "unknown options are specified in #{name} attribute: #{unknown_options.to_a}"
+        end
+      end
+
       # @return [Boolean]
       def allow_nil?
-        allow_nil
+        options.fetch(:allow_nil, false)
+      end
+
+      # @return [Class]
+      def serializer_class
+        options[:serializer]
       end
 
       # @return [Boolean]
@@ -19,6 +34,19 @@ module Pb
         field_descriptor.label == :repeated
       end
 
+      # @return [Boolean]
+      def serializable?(s)
+        cond = options[:if]
+
+        return true unless cond
+
+        case cond
+        when String, Symbol; then s.send(cond)
+        when Proc;           then s.instance_exec(&cond)
+        else raise InvalidAttributeOptionError, "`if` option can accept only Symbol, String or Proc. but got #{cond.class}"
+        end
+      end
+
       def oneof?
         !oneof.nil?
       end
@@ -30,6 +58,10 @@ module Pb
 
         case field_descriptor.type
         when :message
+          if v.class < Google::Protobuf::MessageExts && v.class.descriptor.name == field_descriptor.submsg_name
+            return v
+          end
+
           case field_descriptor.submsg_name
           when "google.protobuf.Timestamp"   then Pb.to_timestamp(v)
           when "google.protobuf.StringValue" then Pb.to_strval(v)

data/lib/pb/serializer/version.rb

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

data/pb-serializer.gemspec

@@ -38,4 +38,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rubocop", "0.67.2" # for onkcop
   spec.add_development_dependency "sqlite3", "~> 1.4"
+  spec.add_development_dependency "simplecov", "~> 0.18.5"
+  spec.add_development_dependency "simplecov-cobertura", "~> 1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pb-serializer
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - izumin5210
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-31 00:00:00.000000000 Z
+date: 2020-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -156,6 +156,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 description: Serialize objects into Protocol Buffers messages
 email:
 - m@izum.in
@@ -177,6 +205,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- codecov.yml
 - lib/pb/serializable.rb
 - lib/pb/serializer.rb
 - lib/pb/serializer/attribute.rb