matchi 2.4.0 → 3.0.0

data/lib/matchi/satisfy.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Matchi
+  # *Satisfy* matcher.
+  class Satisfy
+    # Initialize the matcher with a block.
+    #
+    # @example
+    #   require "matchi/satisfy"
+    #
+    #   Matchi::Satisfy.new { |value| value == 42 }
+    #
+    # @param block [Proc] A block of code.
+    def initialize(&block)
+      @expected = block
+    end
+
+    # Boolean comparison between the actual value and the expected value.
+    #
+    # @example
+    #   require "matchi/satisfy"
+    #
+    #   matcher = Matchi::Satisfy.new { |value| value == 42 }
+    #   matcher.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
+
+    # A string containing a human-readable representation of the matcher.
+    def inspect
+      "#{self.class}(&block)"
+    end
+
+    # Returns a string representing the matcher.
+    def to_s
+      "satisfy &block"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matchi
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-21 00:00:00.000000000 Z
+date: 2021-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,7 +122,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: "Collection of expectation matchers for Ruby \U0001F939"
+description: "Collection of expectation matchers for Rubyists \U0001F939"
 email: contact@cyril.email
 executables: []
 extensions: []
@@ -131,25 +131,19 @@ files:
 - LICENSE.md
 - README.md
 - lib/matchi.rb
-- lib/matchi/helper.rb
-- lib/matchi/matcher.rb
-- lib/matchi/matcher/base.rb
-- lib/matchi/matcher/be_an_instance_of.rb
-- 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
+- lib/matchi/be.rb
+- lib/matchi/be_an_instance_of.rb
+- lib/matchi/change.rb
+- lib/matchi/change/by.rb
+- lib/matchi/change/by_at_least.rb
+- lib/matchi/change/by_at_most.rb
+- lib/matchi/change/from.rb
+- lib/matchi/change/from/to.rb
+- lib/matchi/change/to.rb
+- lib/matchi/eq.rb
+- lib/matchi/match.rb
+- lib/matchi/raise_exception.rb
+- lib/matchi/satisfy.rb
 homepage: https://github.com/fixrb/matchi
 licenses:
 - MIT
@@ -172,5 +166,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: "Collection of expectation matchers for Ruby \U0001F939"
+summary: "Collection of expectation matchers for Rubyists \U0001F939"
 test_files: []

data/lib/matchi/helper.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "matcher"
-
-module Matchi
-  # When included, this module defines a helper instance method per matcher.
-  #
-  # @example Define and use the dynamic helper instance method of a custom matcher
-  #   require "matchi/matcher/base"
-  #
-  #   module Matchi
-  #     module Matcher
-  #       class BeTheAnswer < ::Matchi::Matcher::Base
-  #         def matches?
-  #           42.equal?(yield)
-  #         end
-  #       end
-  #     end
-  #   end
-  #
-  #   require "matchi/helper"
-  #
-  #   class MatcherBase
-  #     include ::Matchi::Helper
-  #   end
-  #
-  #   matcher_base = MatcherBase.new
-  #   matcher_base.be_the_answer.matches? { 42 } # => true
-  module Helper
-    ::Matchi::Matcher.constants.each do |matcher_const|
-      next if matcher_const.equal?(:Base)
-
-      matcher_klass = ::Matchi::Matcher.const_get(matcher_const)
-
-      define_method(matcher_klass.to_sym) do |*args, **kwargs, &block|
-        matcher_klass.new(*args, **kwargs, &block)
-      end
-    end
-  end
-end

data/lib/matchi/matcher.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Matchi
-  # Collection of matcher classes.
-  module Matcher
-  end
-end
-
-Dir[File.join(File.dirname(__FILE__), "matcher", "*.rb")].each do |fname|
-  require_relative fname
-end

data/lib/matchi/matcher/base.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-module Matchi
-  module Matcher
-    # Abstract matcher class.
-    class Base
-      # Returns a symbol identifying the matcher.
-      #
-      # @example The readable definition of a FooBar matcher class.
-      #   matcher_class = Matchi::Matcher::FooBar
-      #   matcher_class.to_sym # => "foo_bar"
-      #
-      # @return [Symbol] A symbol identifying the matcher.
-      def self.to_sym
-        name.split("::")
-            .fetch(-1)
-            .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-            .gsub(/([a-z\d])([A-Z])/, '\1_\2')
-            .downcase
-            .to_sym
-      end
-
-      # @return [#object_id] Any value to give to the matcher.
-      attr_reader :expected
-
-      # A string containing a human-readable representation of the matcher.
-      #
-      # @example The human-readable representation of a FooBar matcher instance.
-      #   matcher = Matchi::Matcher::FooBar.new(42)
-      #   matcher.inspect # => "Matchi::Matcher::FooBar(42)"
-      #
-      # @return [String] The human-readable representation of the matcher.
-      def inspect
-        "#{self.class}(#{expected&.inspect})"
-      end
-
-      # Abstract matcher class.
-      #
-      # @example Test the equivalence between two "foo" strings.
-      #   eql = Matchi::Matcher::Eql.new("foo")
-      #   eql.matches? { "foo" } # => true
-      #
-      # @yieldreturn [#object_id] The actual value to compare to the expected
-      #   one.
-      #
-      # @raise [NotImplementedError] Override this method inside a matcher.
-      def matches?
-        raise ::NotImplementedError, "matcher MUST respond to this method."
-      end
-
-      # Returns a string representing the matcher instance.
-      #
-      # @example The readable definition of a FooBar matcher instance.
-      #   matcher = Matchi::Matcher::FooBar.new(42)
-      #   matcher.to_s # => "foo_bar 42"
-      #
-      # @return [String] A string representing the matcher instance.
-      def to_s
-        [self.class.to_sym, expected&.inspect].compact.join(" ")
-      end
-    end
-  end
-end

data/lib/matchi/matcher/be_an_instance_of.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "base"
-
-module Matchi
-  module Matcher
-    # *Type/class* matcher.
-    class BeAnInstanceOf < ::Matchi::Matcher::Base
-      # Initialize the matcher with an object.
-      #
-      # @example A duck matcher
-      #   Matchi::Matcher::BeAnInstanceOf.new(:Duck)
-      #
-      # @param expected [#to_s] The name of a module.
-      def initialize(expected)
-        super()
-        @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
-      # expected class.
-      #
-      # @example Is it an instance of string?
-      #   be_an_instance_of = Matchi::Matcher::BeInstanceOf.new(String)
-      #   be_an_instance_of.matches? { "foo" } # => true
-      #
-      #   be_an_instance_of = Matchi::Matcher::BeInstanceOf.new(:String)
-      #   be_an_instance_of.matches? { "foo" } # => true
-      #
-      #   be_an_instance_of = Matchi::Matcher::BeInstanceOf.new("String")
-      #   be_an_instance_of.matches? { "foo" } # => true
-      #
-      # @yieldreturn [#class] the actual value to compare to the expected one.
-      #
-      # @return [Boolean] Comparison between actual and expected values.
-      def matches?(*, **)
-        self.class.const_get(expected).equal?(yield.class)
-      end
-
-      # (see Base#to_s)
-      def to_s
-        "#{self.class.to_sym} #{expected}"
-      end
-    end
-  end
-end

data/lib/matchi/matcher/be_false.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "base"
-
-module Matchi
-  module Matcher
-    # *Untruth* matcher.
-    class BeFalse < ::Matchi::Matcher::Base
-      # Boolean comparison between the actual value and the expected value.
-      #
-      # @example Is it false?
-      #   be_false = Matchi::Matcher::BeFalse.new
-      #   be_false.matches? { false } # => true
-      #
-      # @yieldreturn [#object_id] The actual value to compare to the expected
-      #   one.
-      #
-      # @return [Boolean] Comparison between actual and expected values.
-      def matches?(*, **)
-        false.equal?(yield)
-      end
-    end
-  end
-end

data/lib/matchi/matcher/be_nil.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "base"
-
-module Matchi
-  module Matcher
-    # *Nil* matcher.
-    class BeNil < ::Matchi::Matcher::Base
-      # Boolean comparison between the actual value and the expected value.
-      #
-      # @example Is it nil?
-      #   be_nil = Matchi::Matcher::BeNil.new
-      #   be_nil.matches? { nil } # => true
-      #
-      # @yieldreturn [#object_id] The actual value to compare to the expected
-      #   one.
-      #
-      # @return [Boolean] Comparison between actual and expected values.
-      def matches?(*, **)
-        nil.equal?(yield)
-      end
-    end
-  end
-end

data/lib/matchi/matcher/be_true.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "base"
-
-module Matchi
-  module Matcher
-    # *Truth* matcher.
-    class BeTrue < ::Matchi::Matcher::Base
-      # Boolean comparison between the actual value and the expected value.
-      #
-      # @example Is it true?
-      #   be_true = Matchi::Matcher::BeTrue.new
-      #   be_true.matches? { true } # => true
-      #
-      # @yieldreturn [#object_id] The actual value to compare to the expected
-      #   one.
-      #
-      # @return [Boolean] Comparison between actual and expected values.
-      def matches?(*, **)
-        true.equal?(yield)
-      end
-    end
-  end
-end

data/lib/matchi/matcher/change.rb

@@ -1,78 +0,0 @@
-# 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

@@ -1,57 +0,0 @@
-# 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