matchi 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 294443e7f304a5c154aa48af9c20145bba9ff2caaf090bb7336c9bb7538be19d
-  data.tar.gz: c89f84d45eaf0923a7a023bd11b9cf54830054a178ce93e1074aea63cb7a9658
+  metadata.gz: aabf9e773ac6210d1170b3a0f3aa19f38845ea0215bb07280d97c35ef66add16
+  data.tar.gz: 2900c9b936d50bfbe50ba31c6418dcb1402c1fbef5cfbb9f7a1ce289ff6450c0
 SHA512:
-  metadata.gz: 9fe569142636d1acbba97f47dc7efbe38da3c02e9b19e77ab7ad723b6c03a52c03c3d8cd730a9948b4c45b21cdb6e807c29c181fd5d27f77aeee11c92c9738f4
-  data.tar.gz: 2bd24bb8f545496e7bbb115f9bd1577f60d03e67198a0452cd2393f977f063ac0e168f699930c6819a0c478a9c208627db75f7c49a63e5f5905256ba0ef3c8ca
+  metadata.gz: e2cfb5b1c32a01b84c1e2eec84cfc3ad34df2a7a17c91ecb1e6012ef84d5b4ef5b11f24817de7dcea77e08006e72c578d0d88947470436f231efef8fed18f061
+  data.tar.gz: 235a73246185fec310960caf6b8c868cbc2daf7598f29c863def9b560ec66ba7a0f43ab303cd164b04c81b5ebbcbddae3224c5550002f9ab924f8202f58a289f

data/README.md

@@ -14,6 +14,7 @@
 
 * Adding matchers should be as simple as possible.
 * Being framework agnostic and easy to integrate.
+* Avoid false positives/negatives due to malicious actual values.
 
 ## Installation
 
@@ -53,11 +54,7 @@ All examples here assume that this has been done.
 
 A __Matchi__ matcher is an object that must respond to the `matches?` method with a block as argument, and return a boolean.
 
-To facilitate the integration of the matchers in other tools, it is recommended to expose the expected value via the `expected` method.
-
-That's all it is.
-
-Let's see some examples.
+To facilitate the integration of the matchers in other tools, __Matchi__ matchers may expose expected values via the `expected` method.
 
 ### Built-in matchers
 
@@ -81,6 +78,15 @@ matcher.expected          # => :foo
 matcher.matches? { :foo } # => true
 ```
 
+**Comparisons** matcher:
+
+```ruby
+matcher = Matchi::BeWithin.new(8).of(37)
+
+matcher.expected        # => 37
+matcher.matches? { 42 } # => true
+```
+
 **Regular expressions** matcher:
 
 ```ruby
@@ -183,8 +189,6 @@ require "prime"
 
 module Matchi
   class BePrime
-    attr_reader :expected
-
     def matches?
       Prime.prime?(yield)
     end
@@ -193,7 +197,6 @@ end
 
 matcher = Matchi::BePrime.new
 
-matcher.expected        # => nil
 matcher.matches? { 42 } # => false
 ```
 

data/lib/matchi/be_within.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative File.join("be_within", "of")
+
+module Matchi
+  # Wraps the target of a be_within matcher.
+  class BeWithin
+    # Initialize a wrapper of the be_within matcher with a numeric value.
+    #
+    # @example
+    #   require "matchi/be_within"
+    #
+    #   Matchi::BeWithin.new(1)
+    #
+    # @param delta [Numeric] A numeric value.
+    def initialize(delta)
+      @delta = delta
+    end
+
+    # Specifies an expected numeric value.
+    #
+    # @example
+    #   require "matchi/be_within"
+    #
+    #   be_within_wrapper = Matchi::BeWithin.new(1)
+    #   be_within_wrapper.of(41)
+    #
+    # @param expected [Numeric] The expected value.
+    #
+    # @return [#matches?] A *be_within of* matcher.
+    def of(expected)
+      Of.new(@delta, expected)
+    end
+  end
+end

data/lib/matchi/be_within/of.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Matchi
+  class BeWithin
+    # *BeWithin of* matcher.
+    class Of
+      # @return [Numeric] An expected value.
+      attr_reader :expected
+
+      # Initialize the matcher with a delta and an expected value.
+      #
+      # @example
+      #   require "matchi/be_within/of"
+      #
+      #   Matchi::BeWithin::Of.new(1, 41)
+      #
+      # @param delta    [Numeric] The accepted variation of the actual value.
+      # @param expected [Numeric] The expected value.
+      def initialize(delta, expected)
+        @delta    = delta
+        @expected = expected
+      end
+
+      # Boolean comparison on the expected be_within by comparing the actual
+      # value and the expected value.
+      #
+      # @example
+      #   require "matchi/be_within/of"
+      #
+      #   matcher = Matchi::BeWithin::Of.new(1, 41)
+      #
+      #   matcher.expected        # => 41
+      #   matcher.matches? { 42 } # => true
+      #
+      # @yieldreturn [Numeric] The block of code to execute.
+      #
+      # @return [Boolean] Comparison between the actual and the expected values.
+      def matches?
+        (expected - yield).abs <= @delta
+      end
+
+      # A string containing a human-readable representation of the matcher.
+      def inspect
+        "#{self.class}(#{@delta}, #{expected})"
+      end
+
+      # Returns a string representing the matcher.
+      def to_s
+        "be within #{@delta} of #{expected}"
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matchi
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-23 00:00:00.000000000 Z
+date: 2021-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -133,6 +133,8 @@ files:
 - lib/matchi.rb
 - lib/matchi/be.rb
 - lib/matchi/be_an_instance_of.rb
+- lib/matchi/be_within.rb
+- lib/matchi/be_within/of.rb
 - lib/matchi/change.rb
 - lib/matchi/change/by.rb
 - lib/matchi/change/by_at_least.rb