matchi 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8da45849405d96c572ada45280a0acb673276092d25bc56c6a423892f1e1c1b8
-  data.tar.gz: 61f642b16e141704436eb2295fd0c5bc3bda93bb3991c992d40b71f491a328f4
+  metadata.gz: 294443e7f304a5c154aa48af9c20145bba9ff2caaf090bb7336c9bb7538be19d
+  data.tar.gz: c89f84d45eaf0923a7a023bd11b9cf54830054a178ce93e1074aea63cb7a9658
 SHA512:
-  metadata.gz: 8ddb08586b88d7bc3a1447b1ba503aa3170e587ba7a82134d660706be1e5a46ecf5f6180e16feb4736ebd2558e7bfc13f8474bdcca8f0a676945daa04d4ce04f
-  data.tar.gz: f0433134ba8bc1d93e4d4dbc6c8223c3033eda63525defb8a385c4cefc4bc43618b89cb97a47668060b744cfdac57b39e19dbdfebc7867a43ff18f7065d373c1
+  metadata.gz: 9fe569142636d1acbba97f47dc7efbe38da3c02e9b19e77ab7ad723b6c03a52c03c3d8cd730a9948b4c45b21cdb6e807c29c181fd5d27f77aeee11c92c9738f4
+  data.tar.gz: 2bd24bb8f545496e7bbb115f9bd1577f60d03e67198a0452cd2393f977f063ac0e168f699930c6819a0c478a9c208627db75f7c49a63e5f5905256ba0ef3c8ca

data/README.md

@@ -95,7 +95,7 @@ matcher.matches? { "foo" } # => true
 ```ruby
 matcher = Matchi::RaiseException.new(:NameError)
 
-matcher.expected          # => :NameError
+matcher.expected          # => "NameError"
 matcher.matches? { Boom } # => true
 ```
 
@@ -104,7 +104,7 @@ matcher.matches? { Boom } # => true
 ```ruby
 matcher = Matchi::BeAnInstanceOf.new(:String)
 
-matcher.expected           # => :String
+matcher.expected           # => "String"
 matcher.matches? { "foo" } # => true
 ```
 

data/lib/matchi/be_an_instance_of.rb

@@ -3,7 +3,7 @@
 module Matchi
   # *Type/class* matcher.
   class BeAnInstanceOf
-    # @return [Symbol] The expected class name.
+    # @return [String] The expected class name.
     attr_reader :expected
 
     # Initialize the matcher with (the name of) a class or module.
@@ -15,7 +15,7 @@ module Matchi
     #
     # @param expected [Class, #to_s] The expected class name.
     def initialize(expected)
-      @expected = String(expected).to_sym
+      @expected = String(expected)
     end
 
     # Boolean comparison between the class of the actual value and the
@@ -26,7 +26,7 @@ module Matchi
     #
     #   matcher = Matchi::BeAnInstanceOf.new(String)
     #
-    #   matcher.expected           # => :String
+    #   matcher.expected           # => "String"
     #   matcher.matches? { "foo" } # => true
     #
     # @yieldreturn [#class] the actual value to compare to the expected one.

data/lib/matchi/change.rb

@@ -35,11 +35,11 @@ module Matchi
     #   change_wrapper = Matchi::Change.new(object, :length)
     #   change_wrapper.by_at_least(1)
     #
-    # @param expected [#object_id] The minimum delta of the expected change.
+    # @param minimum_delta [#object_id] The minimum delta of the expected change.
     #
     # @return [#matches?] A *change by at least* matcher.
-    def by_at_least(expected)
-      ByAtLeast.new(expected, &@state)
+    def by_at_least(minimum_delta)
+      ByAtLeast.new(minimum_delta, &@state)
     end
 
     # Specifies a maximum delta of the expected change.
@@ -52,11 +52,11 @@ module Matchi
     #   change_wrapper = Matchi::Change.new(object, :length)
     #   change_wrapper.by_at_most(1)
     #
-    # @param expected [#object_id] The maximum delta of the expected change.
+    # @param maximum_delta [#object_id] The maximum delta of the expected change.
     #
     # @return [#matches?] A *change by at most* matcher.
-    def by_at_most(expected)
-      ByAtMost.new(expected, &@state)
+    def by_at_most(maximum_delta)
+      ByAtMost.new(maximum_delta, &@state)
     end
 
     # Specifies the delta of the expected change.
@@ -69,11 +69,11 @@ module Matchi
     #   change_wrapper = Matchi::Change.new(object, :length)
     #   change_wrapper.by(1)
     #
-    # @param expected [#object_id] The delta of the expected change.
+    # @param delta [#object_id] The delta of the expected change.
     #
     # @return [#matches?] A *change by* matcher.
-    def by(expected)
-      By.new(expected, &@state)
+    def by(delta)
+      By.new(delta, &@state)
     end
 
     # Specifies the original value.
@@ -84,11 +84,11 @@ module Matchi
     #   change_wrapper = Matchi::Change.new("foo", :to_s)
     #   change_wrapper.from("foo")
     #
-    # @param expected [#object_id] The original value.
+    # @param old_value [#object_id] The original value.
     #
     # @return [#matches?] A *change from* wrapper.
-    def from(expected)
-      From.new(expected, &@state)
+    def from(old_value)
+      From.new(old_value, &@state)
     end
 
     # Specifies the new value to expect.
@@ -99,11 +99,11 @@ module Matchi
     #   change_wrapper = Matchi::Change.new("foo", :to_s)
     #   change_wrapper.to("FOO")
     #
-    # @param expected [#object_id] The new value to expect.
+    # @param new_value [#object_id] The new value to expect.
     #
     # @return [#matches?] A *change to* matcher.
-    def to(expected)
-      To.new(expected, &@state)
+    def to(new_value)
+      To.new(new_value, &@state)
     end
   end
 end

data/lib/matchi/raise_exception.rb

@@ -3,7 +3,7 @@
 module Matchi
   # *Expecting errors* matcher.
   class RaiseException
-    # @return [Symbol] The expected exception name.
+    # @return [String] The expected exception name.
     attr_reader :expected
 
     # Initialize the matcher with a descendant of class Exception.
@@ -15,7 +15,7 @@ module Matchi
     #
     # @param expected [Exception, #to_s] The expected exception name.
     def initialize(expected)
-      @expected = String(expected).to_sym
+      @expected = String(expected)
     end
 
     # Boolean comparison between the actual value and the expected value.
@@ -25,7 +25,7 @@ module Matchi
     #
     #   matcher = Matchi::RaiseException.new(NameError)
     #
-    #   matcher.expected          # => :NameError
+    #   matcher.expected          # => "NameError"
     #   matcher.matches? { Boom } # => true
     #
     # @yieldreturn [#object_id] The actual value to compare to the expected

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matchi
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-22 00:00:00.000000000 Z
+date: 2021-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler