rspec-protobuf 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 329f818e153685d7b3c9295ca051543fe6915f9277478576892152359ebd6498
-  data.tar.gz: 8b79e6616adac2977f473aac8e7dab6f12efd343b2e2f9af987e597a2ee166dc
+  metadata.gz: ae8739f180ed388f80da7486fb02c809a4cb81aa524c63986fa15d4a002b30f9
+  data.tar.gz: 11be76d911202e00bdc6084c173754d835df59eb363f239d2ae46289ce85c023
 SHA512:
-  metadata.gz: 6597c162046f769e115efbfe4f1a83b027e1d27bf850873c97df598073707156773cd05a61ff771e6e4c626eac182403a21b8c47878adb53663b1da042599de5
-  data.tar.gz: 83458a56e5694c6766c99b4f86ab1eb63b2871adb2c9e559cc1bd045c85855f6fd1629aca670089dd11dbf5b0462bae27da2d000248d0f8ff9c2f7d56570e387
+  metadata.gz: bca33b284f98f8a48fc5b5b6a69ef927d8d29212a1c093c72cfcda7425476a7d8cdaed617866f045b6b62e688b6f7165e93c4eca28b39c2476a8454f32480c67
+  data.tar.gz: 1972979254b796caafed01a06c298e7ad578e3171516363bb4c0aaf720527ce8cfd51f77501dd267ebd4e9f0bc97d10e9f4ce6e43095cedff19cb6cdb14e2008

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+###  v0.3.0  (2023-03-25)
+- match repeated field
+- match default values
+- test coverage
+- type check
+- simplify
+- symbol matching
+
+###  v0.2.4  (2023-03-15)
+- repeated field bug
+
 ###  v0.2.3  (2023-03-14)
 - repeated fields
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-protobuf (0.2.3)
+    rspec-protobuf (0.3.0)
       google-protobuf (>= 3)
       rspec-expectations (>= 3)
 

data/lib/rspec/protobuf/refinements.rb

@@ -5,63 +5,29 @@ module RSpec
         def include?(*args)
           expected_attrs = Hash === args.last ? args.pop : {}
 
-          # ensure all enumerated keys are present
+          # ensure all enumerated keys are indeed attributes
           return false unless args.all? { |attr| respond_to?(attr) }
 
           # ensure all enumerated attributes are present
           return false unless expected_attrs.keys.all? { |attr| respond_to?(attr) }
 
-          fields = {}
-          self.class.descriptor.each { |f| fields[f.name.to_sym] = f }
+          fields = Hash[
+            self.class.descriptor.map { |f| [ f.name.to_sym, f ] }
+          ]
 
-          # check expected attribute matches
+          # ensure that expected attribute matches
           expected_attrs.all? do |expected_attr, expected_value|
-            field = fields[expected_attr]
-            actual_value = field.get(self)
-
-            # convert enum to int value to match input type
-            if field.type == :enum && expected_value.is_a?(Integer)
-              actual_value = field.subtype.lookup_name(actual_value)
-            end
-
-            matches = expected_value === actual_value
-
-            if actual_value.is_a?(Google::Protobuf::MessageExts)
-              if expected_value.is_a?(Hash)
-                matches ||= actual_value.match?(**expected_value)
-              else
-                matches ||= expected_value === actual_value.to_h
-              end
-            end
-
-            matches
+            field_matches?(fields[expected_attr], expected_value)
           end
         end
 
-        def match?(**attrs)
-          # ensure all enumerated keys are present
+        def matches?(**attrs)
+          # ensure all enumerated attributes are present
           return false unless attrs.keys.all? { |attr| respond_to?(attr) }
 
-          # ensure each field matches
+          # ensure that each field matches
           self.class.descriptor.all? do |field|
-            actual_value = field.get(self)
-            expected_value = attrs[field.name.to_sym]
-
-            if actual_value.is_a?(Google::Protobuf::MessageExts) && expected_value.is_a?(Hash)
-              actual_value.match?(**expected_value)
-            else
-              unless attrs.key?(field.name.to_sym)
-                # fall back to default value
-                expected_value = field.label == :repeated ? [] : field.default
-              end
-
-              # convert enum to int value to match input type
-              if field.type == :enum && expected_value.is_a?(Integer)
-                actual_value = field.subtype.lookup_name(actual_value)
-              end
-
-              expected_value === actual_value
-            end
+            field_matches?(field, attrs[field.name.to_sym])
           end
         end
 
@@ -82,6 +48,52 @@ module RSpec
 
           res
         end
+
+        private
+
+        def field_matches?(field, expected)
+          actual = field.get(self)
+
+          if expected.nil?
+            # mimic protobuf behavior and convert to default value
+            expected = field.label == :repeated ? [] : field.default
+          elsif expected.is_a?(Symbol) && field.type == :string
+            # convert symbols to strings
+            expected = expected.to_s
+          end
+
+          # convert enum to int value to match input type
+          if field.type == :enum && expected.is_a?(Integer)
+            actual = field.subtype.lookup_name(actual)
+          end
+
+          if field.label == :repeated && expected.is_a?(Array)
+            return false unless actual.length == expected.length
+
+            actual.zip(expected).all? do |a_actual, a_expected|
+              values_match?(a_actual, a_expected)
+            end
+          else
+            values_match?(actual, expected)
+          end
+        end
+
+        def values_match?(actual, expected)
+          if actual.is_a?(Google::Protobuf::MessageExts)
+            case expected
+            when Google::Protobuf::MessageExts
+              expected === actual
+            when Hash
+              # recurse
+              actual.matches?(**expected)
+            else
+              # eg. RSpec matchers
+              expected === actual.to_h
+            end
+          else
+            expected === actual
+          end
+        end
       end
     end
   end

data/lib/rspec/protobuf/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module Protobuf
-    VERSION = "0.2.3"
+    VERSION = "0.3.0"
   end
 end

data/lib/rspec/protobuf.rb

@@ -8,7 +8,7 @@ using RSpec::Protobuf::Refinements
 RSpec::Matchers.define :be_a_protobuf do |type = nil, **attrs|
   match do |actual|
     # ensure type is a valid Protobuf message type
-    if type && !(type < Google::Protobuf::MessageExts)
+    if type && !(type.is_a?(Class) && type < Google::Protobuf::MessageExts)
       raise TypeError, "Expected arg to be a Google::Protobuf::MessageExts, found: #{type}"
     end
 
@@ -34,7 +34,9 @@ RSpec::Matchers.define :be_a_protobuf do |type = nil, **attrs|
 
     # customize differ output by removing unreferenced and default attrs
     @actual = actual.normalized_hash.slice(*attrs.keys).reject do |k, v|
-      v == actual.class.descriptor.lookup(k.to_s).default
+      field = actual.class.descriptor.lookup(k.to_s)
+      default = field.label == :repeated ? [] : field.default
+      v == default
     end
 
     actual.include?(attrs)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-protobuf
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel Pepper
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-14 00:00:00.000000000 Z
+date: 2023-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf