matchi 2.2.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a3c186895362318fd2c0497d3fb4b124b291a582d37ff16d02cb454f9dd52ca
-  data.tar.gz: 2fff123c60074a43feb8b81428d1dd61cb0d9e736e223531499113e794c2a2d0
+  metadata.gz: 99d5b67cbb65b32a588adc888741aa1b43d86dd26835404388de5444bee6c54c
+  data.tar.gz: 6188812229591bbb66a7fe458eaaaf4cd5707d00cefcc8502dfc3e4ed41195a2
 SHA512:
-  metadata.gz: 95e61bb5d94221542d1b3c95e67d5616f90ffbb08a501edc997ed29bf57795a5ab398f2cb6f7edc59a32c9ed3482738246028e3ae35394c84788268fefc4b049
-  data.tar.gz: bec13c5814a7e007bbff9ae3f47ed3a3b162bc4fe26e5bf941a668fbb9310b7ef9de021dd85fa4fa89d4ef68f1c35bbf7572de0f6bcd799a951c115b6ed6f345
+  metadata.gz: 3f00907f22ba9615eeab7541ddba62e6507f6c3609268699b4c20fda2435c338e9307fec63a942a9c49ad105131c6d29f47354fdf8d7e5d8b28fc418f060e9f0
+  data.tar.gz: 4aeea7b5f52278b733c58180753e95d6ab88a47fbc162242ecf63bcfc3bc44ce018976fa544ef48887724d247e6fcb37ccc6372c89fedb0661d008dcc46061b5

data/README.md

@@ -102,6 +102,37 @@ be_an_instance_of = Matchi::Matcher::BeAnInstanceOf.new(:String)
 be_an_instance_of.matches? { "foo" } # => true
 ```
 
+**Change** matcher:
+
+```ruby
+object = []
+change = Matchi::Matcher::Change.new(object, :length).by(1)
+change.matches? { object << 1 } # => true
+
+object = []
+change = Matchi::Matcher::Change.new(object, :length).by_at_least(1)
+change.matches? { object << 1 } # => true
+
+object = []
+change = Matchi::Matcher::Change.new(object, :length).by_at_most(1)
+change.matches? { object << 1 } # => true
+
+object = "foo"
+change = Matchi::Matcher::Change.new(object, :to_s).from("foo").to("FOO")
+change.matches? { object.upcase! } # => true
+
+object = "foo"
+change = Matchi::Matcher::Change.new(object, :to_s).to("FOO")
+change.matches? { object.upcase! } # => true
+```
+
+**Satisfy** matcher:
+
+```ruby
+satisfy = Matchi::Matcher::Satisfy.new { |value| value == 42 }
+satisfy.matches? { 42 } # => true
+```
+
 ### Custom matchers
 
 Custom matchers can easily be defined for expressing expectations.
@@ -183,7 +214,7 @@ The set of loaded matcher then becomes accessible via a dynamically generated in
 ```ruby
 matcher = MatcherCollection.new
 matcher.equal(42).matches? { 44 } # => false
-matcher.be_an_instance_of(String).matches? { "안녕하세요" } # => true
+matcher.be_an_instance_of(:String).matches? { "안녕하세요" } # => true
 ```
 
 ## Contact

data/lib/matchi.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 # Namespace for the Matchi library.
+#
+# @api public
 module Matchi
 end
 

data/lib/matchi/helper.rb

@@ -32,8 +32,8 @@ module Matchi
 
       matcher_klass = ::Matchi::Matcher.const_get(matcher_const)
 
-      define_method(matcher_klass.to_sym) do |*args|
-        matcher_klass.new(*args)
+      define_method(matcher_klass.to_sym) do |*args, **kwargs, &block|
+        matcher_klass.new(*args, **kwargs, &block)
       end
     end
   end

data/lib/matchi/matcher/be_an_instance_of.rb

@@ -8,13 +8,18 @@ module Matchi
     class BeAnInstanceOf < ::Matchi::Matcher::Base
       # Initialize the matcher with an object.
       #
-      # @example A string matcher
-      #   Matchi::Matcher::BeAnInstanceOf.new(String)
+      # @example A duck matcher
+      #   Matchi::Matcher::BeAnInstanceOf.new(:Duck)
       #
       # @param expected [#to_s] The name of a module.
       def initialize(expected)
         super()
-        @expected = self.class.const_get String(expected)
+        @expected = String(expected).to_sym
+      end
+
+      # (see Base#inspect)
+      def inspect
+        "#{self.class}(#{expected})"
       end
 
       # Boolean comparison between the class of the actual value and the
@@ -34,7 +39,12 @@ module Matchi
       #
       # @return [Boolean] Comparison between actual and expected values.
       def matches?(*, **)
-        expected.equal?(yield.class)
+        self.class.const_get(expected).equal?(yield.class)
+      end
+
+      # (see Base#to_s)
+      def to_s
+        "#{self.class.to_sym} #{expected}"
       end
     end
   end

data/lib/matchi/matcher/change.rb

@@ -0,0 +1,78 @@
+# 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
+  module Matcher
+    # Wraps the target of a change matcher.
+    class Change
+      # Returns a symbol identifying the matcher.
+      def self.to_sym
+        :change
+      end
+
+      # Initialize a wrapper of the change matcher with an object and the name
+      # of one of its methods.
+      #
+      # @example The wrapper of the change matcher on `"foo".to_s` value.
+      #   Matchi::Matcher::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.
+      #
+      # @param expected [#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)
+      end
+
+      # Specifies a maximum delta of the expected change.
+      #
+      # @param expected [#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)
+      end
+
+      # Specifies the delta of the expected change.
+      #
+      # @param expected [#object_id] The delta of the expected change.
+      #
+      # @return [#matches?] A *change by* matcher.
+      def by(expected)
+        By.new(expected, &@state)
+      end
+
+      # Specifies the original value.
+      #
+      # @param expected [#object_id] The original value.
+      #
+      # @return [#matches?] A *change from* wrapper.
+      def from(expected)
+        From.new(expected, &@state)
+      end
+
+      # Specifies the new value to expect.
+      #
+      # @param expected [#object_id] The new value to expect.
+      #
+      # @return [#matches?] A *change to* matcher.
+      def to(expected)
+        To.new(expected, &@state)
+      end
+    end
+  end
+end

data/lib/matchi/matcher/change/by.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative File.join("..", "base")
+
+module Matchi
+  module Matcher
+    class Change
+      # *Change by* matcher.
+      class By < ::Matchi::Matcher::Base
+        # Returns a symbol identifying the matcher.
+        def self.to_sym
+          :change
+        end
+
+        # Initialize the matcher with an object.
+        #
+        # @example The change by 1 matcher.
+        #   object = []
+        #   Matchi::Matcher::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)
+          super()
+          @expected = expected
+          @state    = state
+        end
+
+        # Boolean comparison on the expected change by comparing the value
+        # before and after the code execution.
+        #
+        # @example
+        #   object = []
+        #   change = Matchi::Matcher::Change::By.new(1) { object.length }
+        #   change.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
+
+        # (see Base#to_s)
+        def to_s
+          "change by #{expected.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/matchi/matcher/change/by_at_least.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative File.join("..", "base")
+
+module Matchi
+  module Matcher
+    class Change
+      # *Change by at least* matcher.
+      class ByAtLeast < ::Matchi::Matcher::Base
+        # Returns a symbol identifying the matcher.
+        def self.to_sym
+          :change
+        end
+
+        # Initialize the matcher with an object.
+        #
+        # @example The change by at least 1 matcher.
+        #   object = []
+        #   Matchi::Matcher::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)
+          super()
+          @expected = expected
+          @state    = state
+        end
+
+        # Boolean comparison on the expected change by comparing the value
+        # before and after the code execution.
+        #
+        # @example
+        #   object = []
+        #   change = Matchi::Matcher::Change::ByAtLeast.new(1) { object.length }
+        #   change.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
+
+        # (see Base#to_s)
+        def to_s
+          "change by at least #{expected.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/matchi/matcher/change/by_at_most.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative File.join("..", "base")
+
+module Matchi
+  module Matcher
+    class Change
+      # *Change by at most* matcher.
+      class ByAtMost < ::Matchi::Matcher::Base
+        # Returns a symbol identifying the matcher.
+        def self.to_sym
+          :change
+        end
+
+        # Initialize the matcher with an object.
+        #
+        # @example The change by at most 1 matcher.
+        #   object = []
+        #   Matchi::Matcher::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)
+          super()
+          @expected = expected
+          @state    = state
+        end
+
+        # Boolean comparison on the expected change by comparing the value
+        # before and after the code execution.
+        #
+        # @example
+        #   object = []
+        #   change = Matchi::Matcher::Change::ByAtMost.new(1) { object.length }
+        #   change.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
+
+        # (see Base#to_s)
+        def to_s
+          "change by at most #{expected.inspect}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative File.join("from", "to")
+
+module Matchi
+  module Matcher
+    class Change
+      # *Change from to* wrapper.
+      class From
+        # Initialize the matcher with an object.
+        #
+        # @example The change from "foo" to "FOO" matcher.
+        #   object = "foo"
+        #   Matchi::Matcher::Change::From.new("foo").to("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.
+        #
+        # @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
+end

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require_relative File.join("..", "..", "base")
+
+module Matchi
+  module Matcher
+    class Change
+      class From
+        # *Change from to* matcher.
+        class To < ::Matchi::Matcher::Base
+          # Returns a symbol identifying the matcher.
+          def self.to_sym
+            :change
+          end
+
+          # Initialize the matcher with an object.
+          #
+          # @example The change from "foo" to "FOO" matcher.
+          #   object = "foo"
+          #   Matchi::Matcher::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)
+            super()
+            @expected_init  = expected_init
+            @expected       = expected_new_value
+            @state          = state
+          end
+
+          # (see Base#inspect)
+          def inspect
+            "Matchi::Matcher::Change::From(#{@expected_init.inspect})::To(#{expected.inspect})"
+          end
+
+          # Boolean comparison on the expected change by comparing the value
+          # before and after the code execution.
+          #
+          # @example
+          #   object = "foo"
+          #   change = Matchi::Matcher::Change::To.new("FOO") { object.to_s }
+          #   change.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
+
+          # (see Base#to_s)
+          def to_s
+            "change from #{@expected_init.inspect} to #{expected.inspect}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative File.join("..", "base")
+
+module Matchi
+  module Matcher
+    class Change
+      # *Change to* matcher.
+      class To < ::Matchi::Matcher::Base
+        # Returns a symbol identifying the matcher.
+        def self.to_sym
+          :change
+        end
+
+        # Initialize the matcher with an object.
+        #
+        # @example The change to "FOO" matcher.
+        #   object = "foo"
+        #   Matchi::Matcher::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)
+          super()
+          @expected = expected
+          @state    = state
+        end
+
+        # Boolean comparison on the expected change by comparing the value
+        # before and after the code execution.
+        #
+        # @example
+        #   object = "foo"
+        #   change = Matchi::Matcher::Change::To.new("FOO") { object.to_s }
+        #   change.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
+
+        # (see Base#to_s)
+        def to_s
+          "change to #{expected.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/matchi/matcher/satisfy.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Matchi
+  module Matcher
+    # *Satisfy* matcher.
+    class Satisfy < ::Matchi::Matcher::Base
+      # Initialize the matcher with a block.
+      #
+      # @example The number 42 matcher.
+      #   Matchi::Matcher::Satisfy.new { |value| value == 42 }
+      #
+      # @param block [Proc] A block of code.
+      def initialize(&block)
+        super()
+        @expected = block
+      end
+
+      # (see Base#inspect)
+      def inspect
+        "#{self.class}(&block)"
+      end
+
+      # Boolean comparison between the actual value and the expected value.
+      #
+      # @example Is it equal to 42
+      #   equal = Matchi::Matcher::Satisfy.new { |value| value == 42 }
+      #   equal.matches? { 42 } # => true
+      #
+      # @yieldreturn [#object_id] The actual value to compare to the expected
+      #   one.
+      #
+      # @return [Boolean] Comparison between actual and expected values.
+      def matches?(*, **)
+        expected.call(yield)
+      end
+
+      # (see Base#to_s)
+      def to_s
+        "#{self.class.to_sym} &block"
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matchi
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-18 00:00:00.000000000 Z
+date: 2021-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -138,10 +138,18 @@ files:
 - lib/matchi/matcher/be_false.rb
 - lib/matchi/matcher/be_nil.rb
 - lib/matchi/matcher/be_true.rb
+- lib/matchi/matcher/change.rb
+- lib/matchi/matcher/change/by.rb
+- lib/matchi/matcher/change/by_at_least.rb
+- lib/matchi/matcher/change/by_at_most.rb
+- lib/matchi/matcher/change/from.rb
+- lib/matchi/matcher/change/from/to.rb
+- lib/matchi/matcher/change/to.rb
 - lib/matchi/matcher/eql.rb
 - lib/matchi/matcher/equal.rb
 - lib/matchi/matcher/match.rb
 - lib/matchi/matcher/raise_exception.rb
+- lib/matchi/matcher/satisfy.rb
 homepage: https://github.com/fixrb/matchi
 licenses:
 - MIT