protobuf-cucumber 3.10.4 → 3.10.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d5f47cc32a8f84f7c2a2cd64f483ef150aea5a981ffc7cdca01481a8b94c75d
-  data.tar.gz: 866f9b48ff06138d972914353fb94ee7d29a0a08e2318d204d79ae1f6be3d994
+  metadata.gz: fc5a3e75ddaabfabd15289e76ddf4c16ae40a5a8107c515d8cb605a90bf51716
+  data.tar.gz: 6feeaf6f26b112f74b117155eafd1219b2407e9b3c23b8bbdbcfe865498924a9
 SHA512:
-  metadata.gz: f01a5f01d801feb5dfefc5ab246e8bca0c75b0a12780de746f7a76b8b8a8bc5bad0298d32946a79c4311adacce9cdc7293024a4582ffd0c3a1eecdd70153c2ec
-  data.tar.gz: 6eddd168836a9e1f21658d75fe094868872fce43702e6254aee044e9fa2eb8fe0cf47e6222255ff18bdc6e687a19c6456c51ed5d7f96256cfdb2312f2b324a50
+  metadata.gz: 5f489187daae60da534b03eec2ba25e2cb5800d3e27496e5340e4a18bf3573f5dda1e0986bc87e79d3e85ccd477b8ce022c275135e4c863443b1accba1962cb9
+  data.tar.gz: cb46bbeeac294ba9a5dd7b70d2a01b9ebbd3e742ff64ca1ae72d78d36bef9afd1c4c4d417be19d8c1052416c952952ac0872c75f00347df45eb00e5a2819b882

data/lib/protobuf/field/int64_field.rb

@@ -29,6 +29,13 @@ module Protobuf
         return false
       end
 
+      def json_encode(value, options = {})
+        if options[:proto3]
+          value == 0 ? nil : value.to_s
+        else
+          value
+        end
+      end
     end
   end
 end

data/lib/protobuf/field/sint64_field.rb

@@ -16,6 +16,13 @@ module Protobuf
         INT64_MIN
       end
 
+      def json_encode(value, options = {})
+        if options[:proto3]
+          value == 0 ? nil : value.to_s
+        else
+          value
+        end
+      end
     end
   end
 end

data/lib/protobuf/field/uint64_field.rb

@@ -16,6 +16,13 @@ module Protobuf
         0
       end
 
+      def json_encode(value, options = {})
+        if options[:proto3]
+          value == 0 ? nil : value.to_s
+        else
+          value
+        end
+      end
     end
   end
 end

data/lib/protobuf/message.rb

@@ -158,7 +158,7 @@ module Protobuf
     def to_json_hash(options = {})
       result = {}
 
-      lower_camel_case = options[:lower_camel_case]
+      proto3 = options[:proto3] || options[:lower_camel_case]
 
       @values.each_key do |field_name|
         value = self[field_name]
@@ -169,13 +169,17 @@ module Protobuf
         hashed_value = if value.respond_to?(:to_json_hash_value) && !field.is_a?(::Protobuf::Field::EnumField)
                          value.to_json_hash_value(options)
                        elsif field.respond_to?(:json_encode)
-                         field.json_encode(value)
+                         field.json_encode(value, options)
                        else
                          value
                        end
 
-        key = lower_camel_case ? field.name.to_s.camelize(:lower).to_sym : field.name
-        result[key] = hashed_value
+        if proto3 && (hashed_value.nil? || value == field.default)
+          result.delete(field.name)
+        else
+          key = proto3 ? field.name.to_s.camelize(:lower).to_sym : field.name
+          result[key] = hashed_value
+        end
       end
 
       result

data/lib/protobuf/version.rb

@@ -1,3 +1,3 @@
 module Protobuf
-  VERSION = '3.10.4' # rubocop:disable Style/MutableConstant
+  VERSION = '3.10.5' # rubocop:disable Style/MutableConstant
 end

data/spec/lib/protobuf/field/fixed64_field_spec.rb

@@ -4,4 +4,30 @@ RSpec.describe Protobuf::Field::Fixed64Field do
 
   it_behaves_like :packable_field, described_class
 
+  let(:message) do
+    Class.new(::Protobuf::Message) do
+      optional :fixed64, :some_field, 1
+    end
+  end
+
+  # https://developers.google.com/protocol-buffers/docs/proto3#json
+  describe '.{to_json, from_json}' do
+    it 'serialises 0' do
+      instance = message.new(some_field: 0)
+      expect(instance.to_json(proto3: true)).to eq('{}')
+      expect(instance.to_json).to eq('{"some_field":0}')
+    end
+
+    it 'serialises max value' do
+      instance = message.new(some_field: described_class.max)
+      expect(instance.to_json(proto3: true)).to eq('{"someField":"18446744073709551615"}')
+      expect(instance.to_json).to eq('{"some_field":18446744073709551615}')
+    end
+
+    it 'serialises min value' do
+      instance = message.new(some_field: described_class.min)
+      expect(instance.to_json(proto3: true)).to eq('{}')
+      expect(instance.to_json).to eq('{"some_field":0}')
+    end
+  end
 end

data/spec/lib/protobuf/field/int64_field_spec.rb

@@ -4,4 +4,30 @@ RSpec.describe Protobuf::Field::Int64Field do
 
   it_behaves_like :packable_field, described_class
 
+  let(:message) do
+    Class.new(::Protobuf::Message) do
+      optional :int64, :some_field, 1
+    end
+  end
+
+  # https://developers.google.com/protocol-buffers/docs/proto3#json
+  describe '.{to_json, from_json}' do
+    it 'serialises 0' do
+      instance = message.new(some_field: 0)
+      expect(instance.to_json(proto3: true)).to eq('{}')
+      expect(instance.to_json).to eq('{"some_field":0}')
+    end
+
+    it 'serialises max value' do
+      instance = message.new(some_field: described_class.max)
+      expect(instance.to_json(proto3: true)).to eq('{"someField":"9223372036854775807"}')
+      expect(instance.to_json).to eq('{"some_field":9223372036854775807}')
+    end
+
+    it 'serialises min value' do
+      instance = message.new(some_field: described_class.min)
+      expect(instance.to_json(proto3: true)).to eq('{"someField":"-9223372036854775808"}')
+      expect(instance.to_json).to eq('{"some_field":-9223372036854775808}')
+    end
+  end
 end

data/spec/lib/protobuf/field/sfixed64_field_spec.rb

@@ -6,4 +6,30 @@ RSpec.describe Protobuf::Field::Sfixed64Field do
     let(:value) { [-1, 0, 1] }
   end
 
+  let(:message) do
+    Class.new(::Protobuf::Message) do
+      optional :sfixed64, :some_field, 1
+    end
+  end
+
+  # https://developers.google.com/protocol-buffers/docs/proto3#json
+  describe '.{to_json, from_json}' do
+    it 'serialises 0' do
+      instance = message.new(some_field: 0)
+      expect(instance.to_json(proto3: true)).to eq('{}')
+      expect(instance.to_json).to eq('{"some_field":0}')
+    end
+
+    it 'serialises max value' do
+      instance = message.new(some_field: described_class.max)
+      expect(instance.to_json(proto3: true)).to eq('{"someField":"9223372036854775807"}')
+      expect(instance.to_json).to eq('{"some_field":9223372036854775807}')
+    end
+
+    it 'serialises min value as string' do
+      instance = message.new(some_field: described_class.min)
+      expect(instance.to_json(proto3: true)).to eq('{"someField":"-9223372036854775808"}')
+      expect(instance.to_json).to eq('{"some_field":-9223372036854775808}')
+    end
+  end
 end

data/spec/lib/protobuf/field/sint64_field_spec.rb

@@ -6,4 +6,30 @@ RSpec.describe Protobuf::Field::Sint64Field do
     let(:value) { [-1, 0, 1] }
   end
 
+  let(:message) do
+    Class.new(::Protobuf::Message) do
+      optional :sint64, :some_field, 1
+    end
+  end
+
+  # https://developers.google.com/protocol-buffers/docs/proto3#json
+  describe '.{to_json, from_json}' do
+    it 'serialises 0' do
+      instance = message.new(some_field: 0)
+      expect(instance.to_json(proto3: true)).to eq('{}')
+      expect(instance.to_json).to eq('{"some_field":0}')
+    end
+
+    it 'serialises max value as string' do
+      instance = message.new(some_field: described_class.max)
+      expect(instance.to_json(proto3: true)).to eq('{"someField":"9223372036854775807"}')
+      expect(instance.to_json).to eq('{"some_field":9223372036854775807}')
+    end
+
+    it 'serialises min value as string' do
+      instance = message.new(some_field: described_class.min)
+      expect(instance.to_json(proto3: true)).to eq('{"someField":"-9223372036854775808"}')
+      expect(instance.to_json).to eq('{"some_field":-9223372036854775808}')
+    end
+  end
 end

data/spec/lib/protobuf/field/uint64_field_spec.rb

@@ -4,4 +4,30 @@ RSpec.describe Protobuf::Field::Uint64Field do
 
   it_behaves_like :packable_field, described_class
 
+  let(:message) do
+    Class.new(::Protobuf::Message) do
+      optional :uint64, :some_field, 1
+    end
+  end
+
+  # https://developers.google.com/protocol-buffers/docs/proto3#json
+  describe '.{to_json, from_json}' do
+    it 'serialises 0' do
+      instance = message.new(some_field: 0)
+      expect(instance.to_json(proto3: true)).to eq('{}')
+      expect(instance.to_json).to eq('{"some_field":0}')
+    end
+
+    it 'serialises max value' do
+      instance = message.new(some_field: described_class.max)
+      expect(instance.to_json(proto3: true)).to eq('{"someField":"18446744073709551615"}')
+      expect(instance.to_json).to eq('{"some_field":18446744073709551615}')
+    end
+
+    it 'serialises min value' do
+      instance = message.new(some_field: described_class.min)
+      expect(instance.to_json(proto3: true)).to eq('{}')
+      expect(instance.to_json).to eq('{"some_field":0}')
+    end
+  end
 end

data/spec/lib/protobuf/message_spec.rb

@@ -438,14 +438,14 @@ RSpec.describe Protobuf::Message do
       specify { expect(subject.to_json).to eq '{"widget_bytes":["Bo0xSFAXOmI="]}' }
     end
 
-    context 'using lower camel case field names' do
+    context 'using proto3 produces lower case field names' do
       let(:bytes) { "\x06\x8D1HP\x17:b".force_encoding(Encoding::ASCII_8BIT) }
 
       subject do
         ::Test::ResourceFindRequest.new(:widget_bytes => [bytes])
       end
 
-      specify { expect(subject.to_json(:lower_camel_case => true)).to eq '{"widgetBytes":["Bo0xSFAXOmI="]}' }
+      specify { expect(subject.to_json(:proto3 => true)).to eq '{"widgetBytes":["Bo0xSFAXOmI="]}' }
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protobuf-cucumber
 version: !ruby/object:Gem::Version
-  version: 3.10.4
+  version: 3.10.5
 platform: ruby
 authors:
 - BJ Neilsen
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-08 00:00:00.000000000 Z
+date: 2020-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport