matchi 2.4.0 → 3.0.0

data/lib/matchi/change/by.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Matchi
+  class Change
+    # *Change by* matcher.
+    class By
+      # 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.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,58 @@
+# frozen_string_literal: true
+
+module Matchi
+  class Change
+    # *Change by at least* matcher.
+    class ByAtLeast
+      # 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.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,58 @@
+# frozen_string_literal: true
+
+module Matchi
+  class Change
+    # *Change by at most* matcher.
+    class ByAtMost
+      # 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.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 = Matchi::Change::From.new("foo") { object.to_s }
+      #   change.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,64 @@
+# frozen_string_literal: true
+
+module Matchi
+  class Change
+    class From
+      # *Change from to* matcher.
+      class To
+        # 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.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

data/lib/matchi/change/to.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Matchi
+  class Change
+    # *Change to* matcher.
+    class To
+      # Initialize the matcher with an object and a block.
+      #
+      # @example
+      #   require "matchi/change/to"
+      #
+      #   object = "foo"
+      #
+      #   Matchi::Change::To.new("FOO") { object.to_s }
+      #
+      # @param expected [#object_id]  An expected result 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
+
+      # Boolean comparison on the expected change by comparing the value
+      # before and after the code execution.
+      #
+      # @example
+      #   require "matchi/change/to"
+      #
+      #   object = "foo"
+      #
+      #   matcher = Matchi::Change::To.new("FOO") { object.to_s }
+      #   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?(*, **)
+        yield
+        value_after = @state.call
+
+        @expected == value_after
+      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 to #{@expected.inspect}"
+      end
+    end
+  end
+end

data/lib/matchi/eq.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Matchi
+  # *Equivalence* matcher.
+  class Eq
+    # Initialize the matcher with an object.
+    #
+    # @example
+    #   require "matchi/eq"
+    #
+    #   Matchi::Eq.new("foo")
+    #
+    # @param expected [#eql?] An expected equivalent object.
+    def initialize(expected)
+      @expected = expected
+    end
+
+    # Boolean comparison between the actual value and the expected value.
+    #
+    # @example
+    #   require "matchi/eq"
+    #
+    #   matcher = Matchi::Eq.new("foo")
+    #   matcher.matches? { "foo" } # => true
+    #
+    # @yieldreturn [#object_id] The actual value to compare to the expected
+    #   one.
+    #
+    # @return [Boolean] Comparison between actual and expected values.
+    def matches?(*, **)
+      @expected.eql?(yield)
+    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
+      "eq #{@expected.inspect}"
+    end
+  end
+end

data/lib/matchi/match.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Matchi
+  # *Regular expressions* matcher.
+  class Match
+    # Initialize the matcher with an instance of Regexp.
+    #
+    # @example
+    #   require "matchi/match"
+    #
+    #   Matchi::Match.new(/^foo$/)
+    #
+    # @param expected [#match] A regular expression.
+    def initialize(expected)
+      @expected = expected
+    end
+
+    # Boolean comparison between the actual value and the expected value.
+    #
+    # @example
+    #   require "matchi/match"
+    #
+    #   matcher = Matchi::Match.new(/^foo$/)
+    #   matcher.matches? { "foo" } # => true
+    #
+    # @yieldreturn [#object_id] The actual value to compare to the expected
+    #   one.
+    #
+    # @return [Boolean] Comparison between actual and expected values.
+    def matches?(*, **)
+      @expected.match?(yield)
+    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
+      "match #{@expected.inspect}"
+    end
+  end
+end

data/lib/matchi/raise_exception.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Matchi
+  # *Expecting errors* matcher.
+  class RaiseException
+    # Initialize the matcher with a descendant of class Exception.
+    #
+    # @example
+    #   require "matchi/raise_exception"
+    #
+    #   Matchi::RaiseException.new(NameError)
+    #
+    # @param expected [Exception] The class of the expected exception.
+    def initialize(expected)
+      @expected = expected
+    end
+
+    # Boolean comparison between the actual value and the expected value.
+    #
+    # @example
+    #   require "matchi/raise_exception"
+    #
+    #   matcher = Matchi::RaiseException.new(NameError)
+    #   matcher.matches? { Boom } # => true
+    #
+    # @yieldreturn [#object_id] The actual value to compare to the expected
+    #   one.
+    #
+    # @return [Boolean] Comparison between actual and expected values.
+    def matches?(*, **)
+      yield
+    rescue @expected => _e
+      true
+    else
+      false
+    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
+      "raise exception #{@expected.inspect}"
+    end
+  end
+end