rspec-protobuf 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4edfb359c42bc196bc668c9d88916ed4cf05f9b0f465a39353efccd90dc73477
-  data.tar.gz: f5151e46350a73c03f25ac349a71ced8a295a573237aae678044711bd72328a3
+  metadata.gz: ff057c1fafc371beb4b2d2890300d27ef142158299190715fb9bef3891a24ec6
+  data.tar.gz: a9fa3d68d62d37fe63f7b556e05f221afe0de2ebe34bbf47bd91d313e04d06b5
 SHA512:
-  metadata.gz: 8a7a6963bc85ed51a6bdfd7802784e5c9c9932f3d24932bbee9c46349112ec861ec8bc289bab12ef2818f1a34117023a45265899f42d66760dfa2b67bb32f062
-  data.tar.gz: dba4658ed4fa1cae57a4ea57a83867a9313968118a10659b0acfccd229d914c4b36df054fe70428c43eb5430496f0d319ea268ed57e1b6ec2f969cae539424bc
+  metadata.gz: b5a7bd6137681147eeb3d97c9e8c162a2e71e7de3d6b2d0f1d4cac95449ea179b6e784c2b428f42fb4dc5912eb19ccbbfea5d1caec6864d7b21d339cb8d23c4e
+  data.tar.gz: a8bb57417121161efdcb3f0b876b93e1c5da578ab90c40d96617cb1eb8c04719d5a372d5edcf294d8edbbea2628d67312a65b94d43329b2bc2a33f3a5319690a

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+###  v0.2.0  (2022-11-09)
+- rspec differ
+- failure message and test coverage
+- simplify
+
 ###  v0.1.0  (2022-11-08)
 -
 

data/README.md

@@ -17,6 +17,26 @@ it { is_expected.to be_a_protobuf(msg: /^h/) }
 ```
 
 
+### Improved RSpec Errors
+Before
+```ruby
+Failure/Error: is_expected.to have_attributes(date: { month: 2 })
+     expected <ComplexMessage: complex: false, date: <DateMessage: type: :DATE_DEFAULT, month: 1, day: 0, year: 0>> to have attributes {:date => {:month => 2}} but had attributes {:date => <DateMessage: type: :DATE_DEFAULT, month: 1, day: 0, year: 0>}
+     Diff:
+     @@ -1 +1 @@
+     -:date => {:month=>2},
+     +:date => <DateMessage: type: :DATE_DEFAULT, month: 1, day: 0, year: 0>,
+```
+
+After
+```ruby
+Failure/Error: is_expected.to be_a_protobuf(date: { month: 2 })
+     Diff:
+     @@ -1 +1 @@
+     -:date => {:month=>2},
+     +:date => {:month=>1},
+```
+
 ----
 ## Contributing
 

data/lib/rspec/protobuf/refinements.rb

@@ -2,24 +2,6 @@ module RSpec
   module Protobuf
     module Refinements
       refine Google::Protobuf::MessageExts do
-        def normalized_hash(symbolize_keys: true)
-          res = {}
-
-          self.class.descriptor.each do |field|
-            key = symbolize_keys ? field.name.to_sym : field.name
-            value = field.get(self)
-
-            if value.is_a?(Google::Protobuf::MessageExts)
-              # recursively serialize sub-message
-              value = value.normalized_hash(symbolize_keys: symbolize_keys)
-            end
-
-            res[key] = value unless field.default == value
-          end
-
-          res
-        end
-
         def include?(*args)
           expected_attrs = Hash === args.last ? args.pop : {}
 
@@ -63,6 +45,23 @@ module RSpec
             end
           end
         end
+
+        def normalized_hash
+          res = {}
+
+          self.class.descriptor.each do |field|
+            value = field.get(self)
+
+            if value.is_a?(Google::Protobuf::MessageExts)
+              # recursively serialize sub-message
+              value = value.normalized_hash
+            end
+
+            res[field.name.to_sym] = value unless field.default == value
+          end
+
+          res
+        end
       end
     end
   end

data/lib/rspec/protobuf/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module Protobuf
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/rspec/protobuf.rb

@@ -9,9 +9,10 @@ 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)
-      raise TypeError, "Expected areg to be a Google::Protobuf::MessageExts, found: #{type}"
+      raise TypeError, "Expected arg to be a Google::Protobuf::MessageExts, found: #{type}"
     end
 
+    @fail_msg = "#{actual} is not a Protobuf"
     return false unless actual.is_a?(Google::Protobuf::MessageExts)
 
     # match expected message type
@@ -29,14 +30,23 @@ RSpec::Matchers.define :be_a_protobuf do |type = nil, **attrs|
       end
     end
 
+    @fail_msg = ""
+
+    # 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
+    end
+
     actual.include?(attrs)
   end
 
   description do
-    type ? "a #{type} Protobuf message" : "a Protobuf message"
+    type ? "a #{type} Protobuf" : "a Protobuf"
   end
 
   failure_message { @fail_msg }
+
+  diffable
 end
 
 RSpec::Matchers.alias_matcher :a_protobuf, :be_a_protobuf

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-protobuf
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Daniel Pepper
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-08 00:00:00.000000000 Z
+date: 2022-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf