duck_typer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06033bd68c3648b66718874887865c212abf0da7597d8904d511551fc2e651da
-  data.tar.gz: 18a800f2632fe5233946b4220df58a0728a5443d63881fa08d8f1296c4455e48
+  metadata.gz: 2fa69aacb39291c263a7cd2d09e094ee7cf18e62f90b1148e5747f5515107c8c
+  data.tar.gz: dec6c2a99167fe5cdcc06e2a6d9b2a0e9c42b1898969d0637c717f7122875184
 SHA512:
-  metadata.gz: 99787de2400a1d21667f64c981e6ad1047c866a00645ec1f2b8534c3d1a692a1204a8e6f6d422c45caca61ef17123aa814a82f046ea5848c62a6b926cf35027c
-  data.tar.gz: 9034b7b8e3df7342e51ec9bbf1cb8cfc58d0f1f0d9d64839c53545585a2d5dfa5af0ee7c6d6cfc6fac613015ce8dfc9dbb9e5579d68ff1b607414fd608a46dbc
+  metadata.gz: 94070439840328f9faac3275ad69b57230981bcac9369aff4b26ee93b87cdf127e74848b7d44d4aed78bd5f37f6308ba19ec9c97a1264c86f5809db920897361
+  data.tar.gz: 7007b8b442e0ac7528a8aed5646d03e2e5a5256e1eb5a79a6dc20c665de1f8a9df52a29d11ab25ddc6857da9b9211f1d218ad0ab9bc2b697ef00ff475d6ddc2c

data/README.md

@@ -77,7 +77,7 @@ class PaymentProcessorTest < Minitest::Test
 end
 ```
 
-To make `assert_interface_matches` available across all tests,
+To make `assert_interfaces_match` available across all tests,
 require the integration in `test_helper.rb` and include the module
 in your base test class:
 
@@ -98,19 +98,19 @@ class Minitest::Test
 end
 ```
 
-Then use `assert_interface_matches` to assert that a list of
+Then use `assert_interfaces_match` to assert that a list of
 classes share compatible interfaces:
 
 ```ruby
 def test_payment_processors_have_compatible_interfaces
-  assert_interface_matches [StripeProcessor, PaypalProcessor, BraintreeProcessor]
+  assert_interfaces_match [StripeProcessor, PaypalProcessor, BraintreeProcessor]
 end
 ```
 
 The same `type:` and `methods:` options are supported:
 
 ```ruby
-assert_interface_matches [StripeProcessor, PaypalProcessor],
+assert_interfaces_match [StripeProcessor, PaypalProcessor],
   type: :class_methods,
   methods: %i[charge refund]
 ```
@@ -157,9 +157,8 @@ by calling:
 DuckTyper::RSpec.define_shared_example
 ```
 
-This registers a shared example named `"an interface"`. To avoid
-conflicts with an existing shared example of the same name, pass
-a custom name:
+This registers a shared example named `"an interface"`. The name
+can be changed by passing a custom one:
 
 ```ruby
 DuckTyper::RSpec.define_shared_example("a compatible interface")

data/lib/duck_typer/bulk_interface_checker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DuckTyper
   # Runs interface checks across all consecutive pairs of classes in a list.
   class BulkInterfaceChecker

data/lib/duck_typer/interface_checker/method_inspector.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DuckTyper
   class InterfaceChecker
     class MethodInspector

data/lib/duck_typer/interface_checker/params_normalizer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DuckTyper
   class InterfaceChecker
     # Normalizes method parameters to enable interface comparison. For

data/lib/duck_typer/interface_checker/result.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DuckTyper
   class InterfaceChecker
     class Result
@@ -19,15 +21,9 @@ module DuckTyper
           Expected #{@left} and #{@right} to have compatible method \
           signatures, but the following signatures do not match:
 
-          #{method_signatures}
+          #{@method_signatures.call}
         MSG
       end
-
-      private
-
-      def method_signatures
-        @method_signatures.call
-      end
     end
   end
 end

data/lib/duck_typer/interface_checker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "interface_checker/result"
 require_relative "interface_checker/method_inspector"
 require_relative "interface_checker/params_normalizer"

data/lib/duck_typer/minitest.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require_relative "../duck_typer"
 
 module DuckTyper
   module Minitest
-    def assert_interface_matches(objects, type: :instance_methods, methods: nil)
+    def assert_interfaces_match(objects, type: :instance_methods, methods: nil)
       checker = BulkInterfaceChecker
         .new(objects, type:, partial_interface_methods: methods)
 

data/lib/duck_typer/rspec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "../duck_typer"
 
 RSpec::Matchers.define :have_matching_interfaces do |type: :instance_methods, methods: nil|
@@ -18,9 +20,20 @@ module DuckTyper
   module RSpec
     def self.define_shared_example(name = "an interface")
       ::RSpec.shared_examples name do |objects, type: :instance_methods, methods: nil|
+        # We intentionally avoid reusing the have_matching_interfaces matcher
+        # here. Since this shared example is defined in gem code, RSpec filters
+        # it from its backtrace, causing the Failure/Error: line to show an
+        # internal RSpec constant instead of useful context.
         it "has compatible interfaces" do
-          failures = DuckTyper::BulkInterfaceChecker.new(objects, type:, partial_interface_methods: methods).call.reject(&:match?)
-          raise ::RSpec::Expectations::ExpectationNotMetError, failures.map(&:failure_message).join("\n") if failures.any?
+          checker = DuckTyper::BulkInterfaceChecker
+            .new(objects, type:, partial_interface_methods: methods)
+
+          failures = checker.call.reject(&:match?)
+
+          if failures.any?
+            message = failures.map(&:failure_message).join("\n")
+            raise ::RSpec::Expectations::ExpectationNotMetError, message
+          end
         end
       end
     end

data/lib/duck_typer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DuckTyper
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: duck_typer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Thiago A. Silva