matchi 2.4.0 → 3.2.0

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

data/lib/matchi/change.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require_relative File.join("change", "by_at_least")
+require_relative File.join("change", "by_at_most")
+require_relative File.join("change", "by")
+require_relative File.join("change", "from")
+require_relative File.join("change", "to")
+
+module Matchi
+  # Wraps the target of a change matcher.
+  class Change
+    # Initialize a wrapper of the change matcher with an object and the name of
+    # one of its methods.
+    #
+    # @example
+    #   require "matchi/change"
+    #
+    #   Matchi::Change.new("foo", :to_s)
+    #
+    # @param object [#object_id]  An object.
+    # @param method [Symbol]      The name of a method.
+    # @param args   [Array]       A list of arguments.
+    # @param kwargs [Hash]        A list of keyword arguments.
+    def initialize(object, method, *args, **kwargs, &block)
+      @state = -> { object.send(method, *args, **kwargs, &block) }
+    end
+
+    # Specifies a minimum delta of the expected change.
+    #
+    # @example
+    #   require "matchi/change"
+    #
+    #   object = []
+    #
+    #   change_wrapper = Matchi::Change.new(object, :length)
+    #   change_wrapper.by_at_least(1)
+    #
+    # @param minimum_delta [#object_id] The minimum delta of the expected change.
+    #
+    # @return [#matches?] A *change by at least* matcher.
+    def by_at_least(minimum_delta)
+      ByAtLeast.new(minimum_delta, &@state)
+    end
+
+    # Specifies a maximum delta of the expected change.
+    #
+    # @example
+    #   require "matchi/change"
+    #
+    #   object = []
+    #
+    #   change_wrapper = Matchi::Change.new(object, :length)
+    #   change_wrapper.by_at_most(1)
+    #
+    # @param maximum_delta [#object_id] The maximum delta of the expected change.
+    #
+    # @return [#matches?] A *change by at most* matcher.
+    def by_at_most(maximum_delta)
+      ByAtMost.new(maximum_delta, &@state)
+    end
+
+    # Specifies the delta of the expected change.
+    #
+    # @example
+    #   require "matchi/change"
+    #
+    #   object = []
+    #
+    #   change_wrapper = Matchi::Change.new(object, :length)
+    #   change_wrapper.by(1)
+    #
+    # @param delta [#object_id] The delta of the expected change.
+    #
+    # @return [#matches?] A *change by* matcher.
+    def by(delta)
+      By.new(delta, &@state)
+    end
+
+    # Specifies the original value.
+    #
+    # @example
+    #   require "matchi/change"
+    #
+    #   change_wrapper = Matchi::Change.new("foo", :to_s)
+    #   change_wrapper.from("foo")
+    #
+    # @param old_value [#object_id] The original value.
+    #
+    # @return [#matches?] A *change from* wrapper.
+    def from(old_value)
+      From.new(old_value, &@state)
+    end
+
+    # Specifies the new value to expect.
+    #
+    # @example
+    #   require "matchi/change"
+    #
+    #   change_wrapper = Matchi::Change.new("foo", :to_s)
+    #   change_wrapper.to("FOO")
+    #
+    # @param new_value [#object_id] The new value to expect.
+    #
+    # @return [#matches?] A *change to* matcher.
+    def to(new_value)
+      To.new(new_value, &@state)
+    end
+  end
+end

data/lib/matchi/change/by.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Matchi
+  class Change
+    # *Change by* matcher.
+    class By
+      # @return [#object_id] An expected delta.
+      attr_reader :expected
+
+      # Initialize the matcher with an object and a block.
+      #
+      # @example
+      #   require "matchi/change/by"
+      #
+      #   object = []
+      #
+      #   Matchi::Change::By.new(1) { object.length }
+      #
+      # @param expected [#object_id]  An expected delta.
+      # @param state    [Proc]        A block of code to execute to get the
+      #   state of the object.
+      def initialize(expected, &state)
+        @expected = expected
+        @state    = state
+      end
+
+      # Boolean comparison on the expected change by comparing the value
+      # before and after the code execution.
+      #
+      # @example
+      #   require "matchi/change/by"
+      #
+      #   object = []
+      #
+      #   matcher = Matchi::Change::By.new(1) { object.length }
+      #
+      #   matcher.expected                     # => 1
+      #   matcher.matches? { object << "foo" } # => true
+      #
+      # @yieldreturn [#object_id] The block of code to execute.
+      #
+      # @return [Boolean] Comparison between the value before and after the
+      #   code execution.
+      def matches?
+        value_before = @state.call
+        yield
+        value_after = @state.call
+
+        expected == (value_after - value_before)
+      end
+
+      # A string containing a human-readable representation of the matcher.
+      def inspect
+        "#{self.class}(#{expected.inspect})"
+      end
+
+      # Returns a string representing the matcher.
+      def to_s
+        "change by #{expected.inspect}"
+      end
+    end
+  end
+end

data/lib/matchi/change/by_at_least.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Matchi
+  class Change
+    # *Change by at least* matcher.
+    class ByAtLeast
+      # @return [#object_id] An expected delta.
+      attr_reader :expected
+
+      # Initialize the matcher with an object and a block.
+      #
+      # @example
+      #   require "matchi/change/by_at_least"
+      #
+      #   object = []
+      #
+      #   Matchi::Change::ByAtLeast.new(1) { object.length }
+      #
+      # @param expected [#object_id]  An expected delta.
+      # @param state    [Proc]        A block of code to execute to get the
+      #   state of the object.
+      def initialize(expected, &state)
+        @expected = expected
+        @state    = state
+      end
+
+      # Boolean comparison on the expected change by comparing the value
+      # before and after the code execution.
+      #
+      # @example
+      #   require "matchi/change/by_at_least"
+      #
+      #   object = []
+      #
+      #   matcher = Matchi::Change::ByAtLeast.new(1) { object.length }
+      #
+      #   matcher.expected                     # => 1
+      #   matcher.matches? { object << "foo" } # => true
+      #
+      # @yieldreturn [#object_id] The block of code to execute.
+      #
+      # @return [Boolean] Comparison between the value before and after the
+      #   code execution.
+      def matches?
+        value_before = @state.call
+        yield
+        value_after = @state.call
+
+        expected <= (value_after - value_before)
+      end
+
+      # A string containing a human-readable representation of the matcher.
+      def inspect
+        "#{self.class}(#{expected.inspect})"
+      end
+
+      # Returns a string representing the matcher.
+      def to_s
+        "change by at least #{expected.inspect}"
+      end
+    end
+  end
+end

data/lib/matchi/change/by_at_most.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Matchi
+  class Change
+    # *Change by at most* matcher.
+    class ByAtMost
+      # @return [#object_id] An expected delta.
+      attr_reader :expected
+
+      # Initialize the matcher with an object and a block.
+      #
+      # @example
+      #   require "matchi/change/by_at_most"
+      #
+      #   object = []
+      #
+      #   Matchi::Change::ByAtMost.new(1) { object.length }
+      #
+      # @param expected [#object_id]  An expected delta.
+      # @param state    [Proc]        A block of code to execute to get the
+      #   state of the object.
+      def initialize(expected, &state)
+        @expected = expected
+        @state    = state
+      end
+
+      # Boolean comparison on the expected change by comparing the value
+      # before and after the code execution.
+      #
+      # @example
+      #   require "matchi/change/by_at_most"
+      #
+      #   object = []
+      #
+      #   matcher = Matchi::Change::ByAtMost.new(1) { object.length }
+      #
+      #   matcher.expected                     # => 1
+      #   matcher.matches? { object << "foo" } # => true
+      #
+      # @yieldreturn [#object_id] The block of code to execute.
+      #
+      # @return [Boolean] Comparison between the value before and after the
+      #   code execution.
+      def matches?
+        value_before = @state.call
+        yield
+        value_after = @state.call
+
+        expected >= (value_after - value_before)
+      end
+
+      # A string containing a human-readable representation of the matcher.
+      def inspect
+        "#{self.class}(#{expected.inspect})"
+      end
+
+      # Returns a string representing the matcher.
+      def to_s
+        "change by at most #{expected.inspect}"
+      end
+    end
+  end
+end

data/lib/matchi/change/from.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative File.join("from", "to")
+
+module Matchi
+  class Change
+    # *Change from to* wrapper.
+    class From
+      # Initialize the wrapper with an object and a block.
+      #
+      # @example
+      #   require "matchi/change/from"
+      #
+      #   object = "foo"
+      #
+      #   Matchi::Change::From.new("foo") { object.to_s }
+      #
+      # @param expected [#object_id]  An expected initial value.
+      # @param state    [Proc]        A block of code to execute to get the
+      #   state of the object.
+      def initialize(expected, &state)
+        @expected = expected
+        @state    = state
+      end
+
+      # Specifies the new value to expect.
+      #
+      # @example
+      #   require "matchi/change/from"
+      #
+      #   object = "foo"
+      #
+      #   change_from_wrapper = Matchi::Change::From.new("foo") { object.to_s }
+      #   change_from_wrapper.to("FOO")
+      #
+      # @param expected_new_value [#object_id] The new value to expect.
+      #
+      # @return [#matches?] A *change from to* matcher.
+      def to(expected_new_value)
+        To.new(@expected, expected_new_value, &@state)
+      end
+    end
+  end
+end

data/lib/matchi/change/from/to.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Matchi
+  class Change
+    class From
+      # *Change from to* matcher.
+      class To
+        # @return [#object_id] An expected new value.
+        attr_reader :expected
+
+        # Initialize the matcher with two objects and a block.
+        #
+        # @example
+        #   require "matchi/change/from/to"
+        #
+        #   object = "foo"
+        #
+        #   Matchi::Change::From::To.new("foo", "FOO") { object.to_s }
+        #
+        # @param expected_init      [#object_id] An expected initial value.
+        # @param expected_new_value [#object_id] An expected new value.
+        # @param state              [Proc]       A block of code to execute to
+        #   get the state of the object.
+        def initialize(expected_init, expected_new_value, &state)
+          @expected_init  = expected_init
+          @expected       = expected_new_value
+          @state          = state
+        end
+
+        # Boolean comparison on the expected change by comparing the value
+        # before and after the code execution.
+        #
+        # @example
+        #   require "matchi/change/from/to"
+        #
+        #   object = "foo"
+        #
+        #   matcher = Matchi::Change::From::To.new("foo", "FOO") { object.to_s }
+        #
+        #   matcher.expected                    # => "FOO"
+        #   matcher.matches? { object.upcase! } # => true
+        #
+        # @yieldreturn [#object_id] The block of code to execute.
+        #
+        # @return [Boolean] Comparison between the value before and after the
+        #   code execution.
+        def matches?
+          value_before = @state.call
+          return false unless @expected_init == value_before
+
+          yield
+          value_after = @state.call
+
+          expected == value_after
+        end
+
+        # A string containing a human-readable representation of the matcher.
+        def inspect
+          "#{self.class}(#{@expected_init.inspect}, #{expected.inspect})"
+        end
+
+        # Returns a string representing the matcher.
+        def to_s
+          "change from #{@expected_init.inspect} to #{expected.inspect}"
+        end
+      end
+    end
+  end
+end