pb-serializer 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1f988a05d9e793ea7b9f8e7ce7424f3f0d2f7252c536322c881d7b7921f5c1d
-  data.tar.gz: 9136b5e10daa4852db5ade8435d128851e4e1a636eb78fbe612ebca55d47de2a
+  metadata.gz: 0edb07851fb2e4ee393ca69ffbcb56ae012cf5e0dc4d55874b3a9364b9dff3d0
+  data.tar.gz: efdfa935a65fd014dc5e757d92f6e3d4162e45c4352aa4047e360bb0ca1b86c8
 SHA512:
-  metadata.gz: 959064c2628dcc51320b6c1fc4e82dffce9f60529740853333198b6a0b9c66db8acfacb5476a9898362a7f7a8fae1e8aa1261ffb32d1d33bd383749645337470
-  data.tar.gz: c8f0c9d172cebdbe9f40afca16ec79a62a2c4da32c12821e3420fe36747c6e7a6192d012a029e91427af6cdfb4da65e4f9e82212537e67beefdf8c17bbe04326
+  metadata.gz: 67a0ca4baa1bbf484a2c0b1b310a5299b0dd35864d87f9aef458f81d0c56e986be80ae2f4a15eb76be2c2f3befc74445674b0b9fc2b14a6b92feeb1438a4f954
+  data.tar.gz: 0043f9be4bf0a60631463179902b73493e7623a1f59b7d13f32e81f825767f6a0127b0ac4e2d7f3fc80f3b8b0f617c988bce778e3a28653b4e2bf98a8fdd508e

data/.github/workflows/ci.yml

@@ -9,8 +9,10 @@ jobs:
       fail-fast: false
       matrix:
         os: [ ubuntu-latest, macos-latest ]
-        # ruby: [ 2.5, 2.6, 2.7 ] # TODO: Wait for supporting Ruby 2.7 in google-protobuf
-        ruby: [ 2.5, 2.6 ]
+        # TODO: Wait for supporting Ruby 3.0 in simplecov-cobertura.
+        # See https://github.com/dashingrocket/simplecov-cobertura/pull/16
+        # ruby: [ 2.5, 2.6, 2.7, 3.0 ]
+        ruby: [ 2.5, 2.6, 2.7 ]
     runs-on: ${{ matrix.os }}
 
     steps:

data/.github/workflows/review.yml

@@ -15,11 +15,9 @@ jobs:
         sudo apt-get update
         sudo apt-get install libsqlite3-dev
 
-    - name: Setup reviewdog
-      run: |
-        mkdir -p $HOME/bin
-        curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/master/install.sh | sh -s -- -b $HOME/bin
-        echo ::add-path::$HOME/bin
+    - uses: reviewdog/action-setup@v1
+      with:
+        reviewdog_version: latest
 
     - run: gem install bundler -v 2.1.4
 
@@ -28,6 +26,8 @@ jobs:
     - run: bundle install --jobs 4 --retry 3
 
     - name: Run Rubocop with Reviewdog
+      env:
+        REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       run: |
         bundle exec rubocop --fail-level E \
           | reviewdog -f=rubocop -reporter=github-pr-review

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Unreleased
 
+## 0.4.0
+
+- Make `#initialize` extensible used with `define_primary_loader` https://github.com/wantedly/pb-serializer/pull/31
+- Supoprt `ignore` directive https://github.com/wantedly/pb-serializer/pull/36
+- Support field mask https://github.com/wantedly/pb-serializer/pull/34
+
 ## 0.3.0
 
 - Support `if` option https://github.com/wantedly/pb-serializer/pull/24

data/lib/pb/serializable.rb

@@ -6,8 +6,15 @@ module Pb
       base.singleton_class.prepend Hook
     end
 
+    # @param with [
+    #   Google::Protobuf::FieldMask,
+    #   Array<(Symbol, Hash)>,
+    #   Hash{Symbol=>(Array,Symbol,Hash)},
+    #   Pb::Serializer::NormalizedMask
+    # ]
     def to_pb(with: nil)
-      # TODO: apply masks
+      with ||= ::Pb::Serializer.build_default_mask(self.class.message_class.descriptor)
+      with = ::Pb::Serializer::NormalizedMask.build(with)
 
       oneof_set = []
 
@@ -26,12 +33,13 @@ module Pb
           next
         end
 
+        next unless with.key?(attr.name)
         next unless attr.serializable?(self)
 
         raise "#{self.name}.#{attr.name} is not defined" unless respond_to?(attr.name)
 
         v = public_send(attr.name)
-        v = attr.convert_to_pb(v)
+        v = attr.convert_to_pb(v, with: with[attr.name])
 
         if attr.oneof?
           if !v.nil?
@@ -128,7 +136,14 @@ module Pb
         end
       end
 
-      # @param with [Array, Google::Protobuf::FieldMask, nil]
+      # @param names [Array<Symbol>] Attribute names to be ignored
+      def ignore(*names)
+        names.each do |name|
+          attribute name, ignore: true
+        end
+      end
+
+      # @param with [Array, Hash, Google::Protobuf::FieldMask, nil]
       # @return [Array]
       def bulk_load_and_serialize(with: nil, **args)
         bulk_load(with: with, **args).map { |s| s.to_pb(with: with) }
@@ -136,6 +151,7 @@ module Pb
 
       def bulk_load(with: nil, **args)
         with ||= ::Pb::Serializer.build_default_mask(message_class.descriptor)
+        with = ::Pb::Serializer::NormalizedMask.build(with)
         with = with.reject { |c| (__pb_serializer_attrs & (c.kind_of?(Hash) ? c.keys : [c])).empty? }
 
         bulk_load_and_compute(with, **args)

data/lib/pb/serializer.rb

@@ -1,8 +1,10 @@
 require "pb/serializer/version"
 require "the_pb"
 require "computed_model"
+require "google/protobuf/field_mask_pb"
 
 require "pb/serializable"
+require "pb/serializer/normalized_mask"
 require "pb/serializer/base"
 require "pb/serializer/attribute"
 require "pb/serializer/oneof"

data/lib/pb/serializer/attribute.rb

@@ -8,7 +8,7 @@ module Pb
       keyword_init: true,
     )
 
-      ALLOWED_OPTIONS = Set[:allow_nil, :if, :serializer].freeze
+      ALLOWED_OPTIONS = Set[:allow_nil, :if, :serializer, :ignore].freeze
 
       def initialize(options:, **)
         super
@@ -36,6 +36,8 @@ module Pb
 
       # @return [Boolean]
       def serializable?(s)
+        return false if options[:ignore]
+
         cond = options[:if]
 
         return true unless cond
@@ -52,9 +54,10 @@ module Pb
       end
 
       # @param v [Object]
-      def convert_to_pb(v, should_repeat: repeated?)
+      # @param with [Pb::Serializer::NormalizedMask]
+      def convert_to_pb(v, with: nil, should_repeat: repeated?)
         return nil if v.nil?
-        return v.map { |i| convert_to_pb(i, should_repeat: false) } if should_repeat
+        return v.map { |i| convert_to_pb(i, should_repeat: false, with: with) } if should_repeat
 
         case field_descriptor.type
         when :message
@@ -74,8 +77,8 @@ module Pb
           when "google.protobuf.BoolValue"   then Pb.to_boolval(v)
           when "google.protobuf.BytesValue"  then Pb.to_bytesval(v)
           else
-            return serializer_class.new(v).to_pb if serializer_class
-            return v.to_pb if v.kind_of?(::Pb::Serializable)
+            return serializer_class.new(v).to_pb(with: with) if serializer_class
+            return v.to_pb(with: with) if v.kind_of?(::Pb::Serializable)
 
             raise "serializer was not found for #{field_descriptor.submsg_name}"
           end

data/lib/pb/serializer/base.rb

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

data/lib/pb/serializer/normalized_mask.rb

@@ -0,0 +1,57 @@
+module Pb::Serializer
+  class NormalizedMask < ::Hash
+    class << self
+      # @param [Google::Protobuf::FieldMask, Symbol, Array<(Symbol,Hash)>, Hash{Symbol=>(Array,Symbol,Hash)}]
+      # @return [Hash{Symbol=>Hash}]
+      def build(input)
+        return input if input.kind_of? self
+
+        normalized = new
+
+        case input
+        when Google::Protobuf::FieldMask
+          normalized = normalize_mask_paths(input.paths)
+        when Array
+          input.each do |v|
+            deep_merge!(normalized, build(v))
+          end
+        when Hash
+          input.each do |k, v|
+            normalized[k] ||= new
+            deep_merge!(normalized[k], build(v))
+          end
+        when Symbol
+          normalized[input] ||= new
+        else
+          raise "not supported field mask type: #{input.class}"
+        end
+
+        normalized
+      end
+
+      private
+
+      # @param [Array<String>]
+      # @return [Hash{Symbol=>Hash}]
+      def normalize_mask_paths(paths)
+        paths_by_key = {}
+
+        paths.each do |path|
+          key, rest = path.split('.', 2)
+          paths_by_key[key.to_sym] ||= []
+          paths_by_key[key.to_sym].push(rest) if rest && !rest.empty?
+        end
+
+        paths_by_key.keys.each_with_object(new) do |key, normalized|
+          normalized[key] = normalize_mask_paths(paths_by_key[key])
+        end
+      end
+
+      def deep_merge!(h1, h2)
+        h1.merge!(h2) do |_k, v1, v2|
+          deep_merge!(v1, v2)
+        end
+      end
+    end
+  end
+end

data/lib/pb/serializer/version.rb

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

data/pb-serializer.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   rails_versions = [">= 5.2", "< 6.1"]
   spec.add_runtime_dependency "google-protobuf", "~> 3.0"
   spec.add_runtime_dependency "the_pb", "~> 0.0.1"
-  spec.add_runtime_dependency "computed_model", "~> 0.2.1"
+  spec.add_runtime_dependency "computed_model", "~> 0.2.2"
 
   spec.add_development_dependency "activerecord", rails_versions
   spec.add_development_dependency "bundler", "~> 2.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pb-serializer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - izumin5210
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-03 00:00:00.000000000 Z
+date: 2021-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.2.2
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -210,6 +210,7 @@ files:
 - lib/pb/serializer.rb
 - lib/pb/serializer/attribute.rb
 - lib/pb/serializer/base.rb
+- lib/pb/serializer/normalized_mask.rb
 - lib/pb/serializer/oneof.rb
 - lib/pb/serializer/version.rb
 - pb-serializer.gemspec
@@ -220,7 +221,7 @@ metadata:
   homepage_uri: https://github.com/izumin5210/pb-serializer
   source_code_uri: https://github.com/izumin5210/pb-serializer
   changelog_uri: https://github.com/izumin5210/pb-serializer
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -235,8 +236,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Serialize objects into Protocol Buffers messages
 test_files: []