rspec-protobuf 0.1.0

checksums.yaml

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

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+###  v0.1.0  (2022-11-08)
+-
+

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Daniel Pepper
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,30 @@
+rspec-protobuf
+======
+![Gem](https://img.shields.io/gem/dt/rspec-protobuf?style=plastic)
+[![codecov](https://codecov.io/gh/dpep/rspec-protobuf/branch/main/graph/badge.svg)](https://codecov.io/gh/dpep/rspec-protobuf)
+
+RSpec matchers for Protobuf.
+
+
+```ruby
+require "rspec/protobuf"
+
+subject { MyProtoMessage.new(msg: "hi") }
+
+it { is_expected.to be_a_protobuf }
+it { is_expected.to be_a_protobuf(msg: "hi") }
+it { is_expected.to be_a_protobuf(msg: /^h/) }
+```
+
+
+----
+## Contributing
+
+Yes please  :)
+
+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

data/lib/rspec/protobuf/refinements.rb

@@ -0,0 +1,69 @@
+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 : {}
+
+          # ensure all enumerated keys are present
+          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) }
+
+          # check expected attribute matches
+          expected_attrs.all? do |expected_attr, expected_value|
+            actual_value = send(expected_attr)
+
+            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
+          end
+        end
+
+        def match?(**attrs)
+          # ensure all enumerated keys are present
+          return false unless attrs.keys.all? { |attr| respond_to?(attr) }
+
+          # ensure 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
+              attrs.fetch(field.name.to_sym, field.default) === actual_value
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/protobuf/version.rb

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

data/lib/rspec/protobuf.rb

@@ -0,0 +1,42 @@
+require "google/protobuf"
+require "rspec"
+require "rspec/protobuf/refinements"
+require "rspec/protobuf/version"
+
+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)
+      raise TypeError, "Expected areg to be a Google::Protobuf::MessageExts, found: #{type}"
+    end
+
+    return false unless actual.is_a?(Google::Protobuf::MessageExts)
+
+    # match expected message type
+    @fail_msg = "Expected a Protobuf message of type #{type}, found #{actual.class}"
+    return false if type && actual.class != type
+
+    return true if attrs.empty?
+
+    if type
+      # validate attrs
+      invalid_attrs = attrs.keys - type.descriptor.map { |x| x.name.to_sym }
+
+      unless invalid_attrs.empty?
+        raise ArgumentError, "invalid attribute for #{type}: #{invalid_attrs.join(", ")}"
+      end
+    end
+
+    actual.include?(attrs)
+  end
+
+  description do
+    type ? "a #{type} Protobuf message" : "a Protobuf message"
+  end
+
+  failure_message { @fail_msg }
+end
+
+RSpec::Matchers.alias_matcher :a_protobuf, :be_a_protobuf

data/lib/rspec-protobuf.rb

@@ -0,0 +1 @@
+require "rspec/protobuf"

data/rspec-protobuf.gemspec

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

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: rspec-protobuf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Pepper
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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
+  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: simplecov
+  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'
+description: RSpec matchers for Protobuf
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/rspec-protobuf.rb
+- lib/rspec/protobuf.rb
+- lib/rspec/protobuf/refinements.rb
+- lib/rspec/protobuf/version.rb
+- rspec-protobuf.gemspec
+homepage: https://github.com/dpep/rspec-protobuf
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Gem::Specification::RSpec::Protobuf
+test_files: []