Merge pull request #52 from wantedly/fetburner/lazy-default-mask

Generate the default mask lazily to prevent infinite recursions

lib/pb/serializable.rb

@@ -17,7 +17,7 @@ def self.included(base)
     # @param with [
     #   Google::Protobuf::FieldMask,
     #   Array<(Symbol, Hash)>,
-    #   Hash{Symbol=>(Array,Symbol,Hash)},
+    #   Hash{Symbol=>(Array,Symbol,Hash,Proc)},
     #   ]
     #   Specifies the list of fields to be serialized in the Proto message object.
     #   `nil` means that all fields defined in .proto will be serialized.

lib/pb/serializer.rb

@@ -81,7 +81,7 @@ def build_default_mask(descriptor)
                 "google.protobuf.BoolValue"  ,
                 "google.protobuf.BytesValue" then m << fd.name.to_sym
               else
-                m << { fd.name.to_sym => build_default_mask(fd.subtype) }
+                m << { fd.name.to_sym => -> { build_default_mask(fd.subtype) } }
               end
             else
               m << fd.name.to_sym
@@ -102,22 +102,24 @@ def parse_field_mask(field_mask)
         end
       end
 
-      # @param input [Google::Protobuf::FieldMask, Symbol, Array<(Symbol,Hash)>, Hash{Symbol=>(Array,Symbol,Hash)}]
-      # @return [Hash{Symbol=>(Array,Hash)}]
+      # @param input [Google::Protobuf::FieldMask, Symbol, Array<(Symbol,Hash)>, Hash{Symbol=>(Array,Symbol,Hash,Proc)}, Proc]
+      # @return [Hash{Symbol=>(Array,Hash,Proc)}]
       def normalize_mask(input)
         if input.kind_of?(Google::Protobuf::FieldMask)
           input = parse_field_mask(input)
         end
 
-        normalized = {}
-
+        input = input.call if input.kind_of?(Proc)
         input = [input] if input.kind_of?(Hash)
+
+        normalized = {}
         Array(input).each do |el|
           case el
           when Symbol
             normalized[el] ||= []
           when Hash
             el.each do |k, v|
+              v = v.call if v.kind_of?(Proc)
               v = [v] if v.kind_of?(Hash)
               normalized[k] ||= []
               normalized[k].push(*Array(v))

spec/examples/recursive_spec.rb

@@ -0,0 +1,33 @@
+RSpec.describe 'recursive models' do
+  module self::Sandbox
+    class StringListSerializer < Pb::Serializer::Base
+      message TestFixture::Recursive::StringList
+
+      attribute :car
+      attribute :cdr, allow_nil: true, serializer: StringListSerializer
+    end
+
+    StringList = Struct.new(:car, :cdr)
+  end
+
+  let(:sandbox) { self.class::Sandbox }
+
+  it "serializes recursive ruby object into protobuf type" do
+    l = sandbox::StringList.new(
+      "Alpha",
+      sandbox::StringList.new(
+        "Bravo",
+        sandbox::StringList.new(
+          "Charlie",
+          nil,
+        ),
+      ),
+    )
+    pb = sandbox::StringListSerializer.new(l).to_pb
+
+    expect(pb).to be_a(TestFixture::Recursive::StringList)
+    expect(pb.car).to eq "Alpha"
+    expect(pb.cdr.car).to eq "Bravo"
+    expect(pb.cdr.cdr.car).to eq "Charlie"
+  end
+end

spec/fixtures/recursive_model.proto

@@ -0,0 +1,10 @@
+syntax = "proto3";
+
+package example.recursive;
+
+option ruby_package = "TestFixture::Recursive";
+
+message StringList {
+  string car = 1;
+  StringList cdr = 2;
+}