rspec-protobuf 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 067f4cadf677ad482da31b4d3dbcb66cd53e79f434807d67e0e9522144109b32
-  data.tar.gz: fdc42f1600c8cbc1f97388a413ae81bded5cc8451e84128907854a453953d709
+  metadata.gz: e8d21cd1780e94292bac712a3d3245599858e31eb5c75bd3dfa653798c0c1469
+  data.tar.gz: 6d01c76cd09476bddb44966292e9a13407e60fb17b8d707d225eff344bc00c5a
 SHA512:
-  metadata.gz: 548a3253d3e1c1f36e1bc00472822c61eaf6f96a02865ac71533aec137958a34bbd2d24dc5f4a170eb4949b4fcbf31f1966b62d546caf3bd3d3086b2a520a163
-  data.tar.gz: 514ea10c3836b87c2f82bc7b6e9cefa8c94514238791b76c462cad5fdbed82fe21af8ba1ade18dc7a616846e8c863aad4d118621e50dd2f1d792179930216ccf
+  metadata.gz: 1c0cf6543957003dffde24c5887fec8ac59f3dd50bc537434af7ee3cd0abe6f8fa9df8e7c931391a89cc9965447a92478bc7b5a210b19235da7176bd4504de7d
+  data.tar.gz: 732cd107abf1fd848641b16f654b55db60b28621fcf8c163065b6590ac33ec5c7afb9ca45e834e08227d6a468e656d91d6c4116f58141aa5d3d741cc3c4e990d

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+###  0.4.1  (2026-11-08)
+- Fix map fields: naming one in `be_a_protobuf` raised `TypeError`, and a hash never matched one.
+- RSpec matchers on repeated and map fields see plain Ruby values with defaults kept, e.g. `be_a_protobuf(messages: include(a_hash_including(msg: "")))`, the same on google-protobuf 3 and 4.
+- Clearer failure output: given a type, the diff shows only the attributes (it showed `[Type, {...}]`); a type mismatch no longer diffs; the negation message names the message rather than a hash; `expect(nil).to be_a_protobuf` says `nil is not a Protobuf`.
+- Fix `NoMethodError` when an expectation names something that isn't a field, such as a oneof or a method like `to_h`; it now fails to match.
+
+###  0.4.0  (2026-04-19)
+- ruby version / gem upgrades
+
 ###  v0.3.1  (2023-03-27)
 - bugfix
 

data/Gemfile.lock

@@ -1,48 +1,95 @@
 PATH
   remote: .
   specs:
-    rspec-protobuf (0.3.1)
+    rspec-protobuf (0.4.1)
       google-protobuf (>= 3)
       rspec-expectations (>= 3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    byebug (11.1.3)
-    codecov (0.6.0)
-      simplecov (>= 0.15, < 0.22)
-    diff-lcs (1.5.0)
-    docile (1.4.0)
-    google-protobuf (3.22.2)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.0)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.0)
+    bigdecimal (4.1.3)
+    date (3.5.1)
+    debug (1.11.1)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    diff-lcs (1.6.2)
+    erb (6.0.4)
+    google-protobuf (4.36.2)
+      bigdecimal
+      rake (~> 13.3)
+    io-console (0.8.2)
+    irb (1.17.0)
+      pp (>= 0.6.0)
+      prism (>= 1.3.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    pp (0.6.3)
+      prettyprint
+    prettyprint (0.2.0)
+    prism (1.9.0)
+    psych (5.3.1)
+      date
+      stringio
+    rake (13.4.2)
+    rdoc (7.2.0)
+      erb
+      psych (>= 4.0.0)
+      tsort
+    reline (0.6.3)
+      io-console (~> 0.5)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.1)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.8)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    simplecov (0.21.2)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.4)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.7)
+    simplecov (1.3.2)
+    stringio (3.2.0)
+    tsort (0.2.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  byebug
-  codecov
+  debug
   rspec (>= 3)
   rspec-protobuf!
-  simplecov
+  simplecov (>= 1)
+
+CHECKSUMS
+  bigdecimal (4.1.3) sha256=61ebe1e5e559bdc3cc6f2c0ee7f427321fc838f59611c294356eb04d6e21cf66
+  bundler (4.0.14) sha256=d09a0a965cf772266a7e49e83610be7c2f4e49e61134c42a56804bb383cc24b8
+  date (3.5.1) sha256=750d06384d7b9c15d562c76291407d89e368dda4d4fff957eb94962d325a0dc0
+  debug (1.11.1) sha256=2e0b0ac6119f2207a6f8ac7d4a73ca8eb4e440f64da0a3136c30343146e952b6
+  diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
+  erb (6.0.4) sha256=38e3803694be357fe2bfe312487c74beaf9fb4e5beb3e22498952fe1645b95d9
+  google-protobuf (4.36.2) sha256=2f8daff50ae14aad36ab0ccdcf284065fa71d726c444efe114e6db82ffe62494
+  io-console (0.8.2) sha256=d6e3ae7a7cc7574f4b8893b4fca2162e57a825b223a177b7afa236c5ef9814cc
+  irb (1.17.0) sha256=168c4ddb93d8a361a045c41d92b2952c7a118fa73f23fe14e55609eb7a863aae
+  pp (0.6.3) sha256=2951d514450b93ccfeb1df7d021cae0da16e0a7f95ee1e2273719669d0ab9df6
+  prettyprint (0.2.0) sha256=2bc9e15581a94742064a3cc8b0fb9d45aae3d03a1baa6ef80922627a0766f193
+  prism (1.9.0) sha256=7b530c6a9f92c24300014919c9dcbc055bf4cdf51ec30aed099b06cd6674ef85
+  psych (5.3.1) sha256=eb7a57cef10c9d70173ff74e739d843ac3b2c019a003de48447b2963d81b1974
+  rake (13.4.2) sha256=cb825b2bd5f1f8e91ca37bddb4b9aaf345551b4731da62949be002fa89283701
+  rdoc (7.2.0) sha256=8650f76cd4009c3b54955eb5d7e3a075c60a57276766ebf36f9085e8c9f23192
+  reline (0.6.3) sha256=1198b04973565b36ec0f11542ab3f5cfeeec34823f4e54cebde90968092b1835
+  rspec (3.13.2) sha256=206284a08ad798e61f86d7ca3e376718d52c0bc944626b2349266f239f820587
+  rspec-core (3.13.6) sha256=a8823c6411667b60a8bca135364351dda34cd55e44ff94c4be4633b37d828b2d
+  rspec-expectations (3.13.5) sha256=33a4d3a1d95060aea4c94e9f237030a8f9eae5615e9bd85718fe3a09e4b58836
+  rspec-mocks (3.13.8) sha256=086ad3d3d17533f4237643de0b5c42f04b66348c28bf6b9c2d3f4a3b01af1d47
+  rspec-protobuf (0.4.1)
+  rspec-support (3.13.7) sha256=0640e5570872aafefd79867901deeeeb40b0c9875a36b983d85f54fb7381c47c
+  simplecov (1.3.2) sha256=2a22ec1759f1b8db60881a2e038758956fc69ef93ed669be0bde0678de6d0e85
+  stringio (3.2.0) sha256=c37cb2e58b4ffbd33fe5cd948c05934af997b36e0b6ca6fdf43afa234cf222e1
+  tsort (0.2.0) sha256=9650a793f6859a43b6641671278f79cfead60ac714148aabe4e3f0060480089f
 
 BUNDLED WITH
-   2.3.17
+  4.0.10

data/README.md

@@ -12,8 +12,16 @@ require "rspec/protobuf"
 subject { MyProtoMessage.new(msg: "hi") }
 
 it { is_expected.to be_a_protobuf }
+
+# check type
+it { is_expected.to be_a_protobuf(MyProtoMessage) }
+
+# check field values
 it { is_expected.to be_a_protobuf(msg: "hi") }
 it { is_expected.to be_a_protobuf(msg: /^h/) }
+
+# composite matching
+it { expect(result).to include(data: a_protobuf(MyProtoMessage, msg: starting_with("h"))) }
 ```
 
 
@@ -21,11 +29,11 @@ it { is_expected.to be_a_protobuf(msg: /^h/) }
 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>}
+     expected <ComplexMessage: date: <DateMessage: month: 1>, numbers: [], messages: []> to have attributes {date: {month: 2}} but had attributes {date: <DateMessage: month: 1>}
      Diff:
      @@ -1 +1 @@
-     -:date => {:month=>2},
-     +:date => <DateMessage: type: :DATE_DEFAULT, month: 1, day: 0, year: 0>,
+     -:date => {month: 2},
+     +:date => <DateMessage: month: 1>,
 ```
 
 After
@@ -33,18 +41,20 @@ After
 Failure/Error: is_expected.to be_a_protobuf(date: { month: 2 })
      Diff:
      @@ -1 +1 @@
-     -:date => {:month=>2},
-     +:date => {:month=>1},
+     -:date => {month: 2},
+     +:date => {month: 1},
 ```
 
 ----
-## Contributing
+## Installation
+
+```ruby
+# Gemfile
+gem "rspec-protobuf"
+```
 
-Yes please  :)
+or
 
-1. Fork it
-1. Create your feature branch (`git checkout -b my-feature`)
-1. Ensure the tests pass (`bundle exec rspec`)
-1. Commit your changes (`git commit -am 'awesome new feature'`)
-1. Push your branch (`git push origin my-feature`)
-1. Create a Pull Request
+```
+gem install rspec-protobuf
+```

data/lib/rspec/protobuf/refinements.rb

@@ -1,29 +1,42 @@
 module RSpec
   module Protobuf
     module Refinements
+      # Message#to_h, but keeping default-valued fields, which google-protobuf 4 drops
+      def self.to_h_with_defaults(value)
+        case value
+        when Google::Protobuf::MessageExts
+          value.class.descriptor.to_h do |field|
+            [ field.name.to_sym, to_h_with_defaults(field.get(value)) ]
+          end
+        when Google::Protobuf::RepeatedField
+          value.map { |x| to_h_with_defaults(x) }
+        when Google::Protobuf::Map
+          # Map#to_h ignores a block
+          res = {}
+          value.each { |k, v| res[k] = to_h_with_defaults(v) }
+          res
+        else
+          value
+        end
+      end
+
       refine Google::Protobuf::MessageExts do
         def include?(*args)
           expected_attrs = Hash === args.last ? args.pop : {}
 
           # 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 = Hash[
-            self.class.descriptor.map { |f| [ f.name.to_sym, f ] }
-          ]
+          return false unless args.all? { |attr| field_for(attr) }
 
           # ensure that expected attribute matches
-          expected_attrs.all? do |expected_attr, expected_value|
-            field_matches?(fields[expected_attr], expected_value)
+          expected_attrs.all? do |attr, expected|
+            field = field_for(attr)
+            field && field_matches?(field, expected)
           end
         end
 
         def matches?(**attrs)
           # ensure all enumerated attributes are present
-          return false unless attrs.keys.all? { |attr| respond_to?(attr) }
+          return false unless attrs.keys.all? { |attr| field_for(attr) }
 
           # ensure that each field matches
           self.class.descriptor.all? do |field|
@@ -37,13 +50,10 @@ module RSpec
           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
+            # recursively serialize sub-message
+            value = value.normalized_hash if value.is_a?(Google::Protobuf::MessageExts)
 
-            default = field.label == :repeated ? [] : field.default
-            res[field.name.to_sym] = value unless default == value
+            res[field.name.to_sym] = value unless default_value?(field, value)
           end
 
           res
@@ -51,13 +61,18 @@ module RSpec
 
         private
 
+        # nil unless attr is a Symbol naming a field, not eg. a oneof or method
+        def field_for(attr)
+          self.class.descriptor.lookup(attr.to_s) if attr.is_a?(Symbol)
+        end
+
         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
+          # mimic protobuf behavior, where nil means the default value
+          return default_value?(field, actual) if expected.nil?
+
+          if expected.is_a?(Symbol) && field.type == :string
             # convert symbols to strings
             expected = expected.to_s
           end
@@ -78,19 +93,23 @@ module RSpec
           end
         end
 
+        def default_value?(field, value)
+          field.label == :repeated ? value.length.zero? : value == field.default
+        end
+
         def values_match?(actual, expected)
-          expected === actual || 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
+          return true if expected === actual
+
+          case actual
+          when Google::Protobuf::MessageExts
+            return actual.matches?(**expected) if expected.is_a?(Hash)
+          when Google::Protobuf::RepeatedField, Google::Protobuf::Map
+          else
+            return false
           end
+
+          # eg. RSpec matchers, which expect plain Ruby values
+          expected === Refinements.to_h_with_defaults(actual)
         end
       end
     end

data/lib/rspec/protobuf/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module Protobuf
-    VERSION = "0.3.1"
+    VERSION = "0.4.1"
   end
 end

data/lib/rspec/protobuf.rb

@@ -12,7 +12,7 @@ RSpec::Matchers.define :be_a_protobuf do |type = nil, **attrs|
       raise TypeError, "Expected arg to be a Google::Protobuf::MessageExts, found: #{type}"
     end
 
-    @fail_msg = "#{actual} is not a Protobuf"
+    @fail_msg = "#{actual.inspect} is not a Protobuf"
     return false unless actual.is_a?(Google::Protobuf::MessageExts)
 
     # match expected message type
@@ -30,16 +30,22 @@ RSpec::Matchers.define :be_a_protobuf do |type = nil, **attrs|
       end
     end
 
+    return true if actual.include?(attrs)
+
+    # let the diff explain: only referenced attrs, defaults removed
     @fail_msg = ""
+    @diff_expected = attrs
+    @actual = actual.normalized_hash.slice(*attrs.keys)
+    false
+  end
 
-    # customize differ output by removing unreferenced and default attrs
-    @actual = actual.normalized_hash.slice(*attrs.keys).reject do |k, v|
-      field = actual.class.descriptor.lookup(k.to_s)
-      default = field.label == :repeated ? [] : field.default
-      v == default
-    end
+  # only an attribute mismatch has a useful diff
+  def diffable?
+    !@diff_expected.nil?
+  end
 
-    actual.include?(attrs)
+  def expected
+    @diff_expected || super
   end
 
   description do
@@ -48,7 +54,11 @@ RSpec::Matchers.define :be_a_protobuf do |type = nil, **attrs|
 
   failure_message { @fail_msg }
 
-  diffable
+  failure_message_when_negated do |actual|
+    msg = "expected #{actual} not to be #{description}"
+    msg += " with #{attrs}" unless attrs.empty?
+    msg
+  end
 end
 
 RSpec::Matchers.alias_matcher :a_protobuf, :be_a_protobuf

data/rspec-protobuf.gemspec

@@ -1,24 +1,27 @@
-package_name = File.basename(__FILE__).split(".")[0]
-load Dir.glob("lib/**/version.rb")[0]
-
-package = RSpec::Protobuf
-
+require_relative "lib/rspec/protobuf/version"
 
 Gem::Specification.new do |s|
-  s.name        = package_name
-  s.version     = package.const_get "VERSION"
+  s.name        = "rspec-protobuf"
+  s.version     = RSpec::Protobuf::VERSION
   s.authors     = ["Daniel Pepper"]
-  s.summary     = package.to_s
+  s.summary     = "RSpec::Protobuf"
   s.description = "RSpec matchers for Protobuf"
-  s.homepage    = "https://github.com/dpep/#{package_name}"
+  s.homepage    = "https://github.com/dpep/rspec-protobuf"
   s.license     = "MIT"
-  s.files       = `git ls-files * ':!:spec'`.split("\n")
+  s.files       = `git ls-files * ':!:spec' ':!:gemfiles'`.split("\n")
+
+  s.metadata = {
+    "changelog_uri" => "#{s.homepage}/blob/main/CHANGELOG.md",
+    "rubygems_mfa_required" => "true",
+    "source_code_uri" => s.homepage,
+  }
+
+  s.required_ruby_version = ">= 3.3"
 
   s.add_dependency "google-protobuf", ">= 3"
   s.add_dependency "rspec-expectations", ">= 3"
 
-  s.add_development_dependency "byebug"
-  s.add_development_dependency "codecov"
+  s.add_development_dependency "debug"
   s.add_development_dependency "rspec", ">= 3"
-  s.add_development_dependency "simplecov"
+  s.add_development_dependency "simplecov", ">= 1"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rspec-protobuf
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Daniel Pepper
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-27 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -39,21 +38,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: codecov
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -86,16 +71,15 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 description: RSpec matchers for Protobuf
-email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -113,8 +97,10 @@ files:
 homepage: https://github.com/dpep/rspec-protobuf
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  changelog_uri: https://github.com/dpep/rspec-protobuf/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/dpep/rspec-protobuf
 rdoc_options: []
 require_paths:
 - lib
@@ -122,15 +108,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
-summary: Gem::Specification::RSpec::Protobuf
+summary: RSpec::Protobuf
 test_files: []