fix 1.0.0.beta11 → 1.0.0.beta12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40461f87067aa8b719fc25a6256772961b8ef4c412cd043ddddc51d8b048d014
-  data.tar.gz: ad050718de8cd7c7fcede3f8c9644b91c33ec2cef4e877fd28773d576b265292
+  metadata.gz: 4d32cb2da3e2823f71175074536af7f55c981cba88f1fc39952f5c91ecc27756
+  data.tar.gz: bfbf3da66b20085030ecffadbfe908dfe90ea3fe5620fdfaceeedbb5eaec0e9e
 SHA512:
-  metadata.gz: 8d83f640bb5a086f530265eea8fab350a74e4209072aae351107b0fab393e6ebb1f3fcd266550fccc3c21cf5b9885e2444731ab28200861fcc06fff4f3facf83
-  data.tar.gz: 85a1b557e06c39c82c653e4283c0489a6bfb3aec0dff69e1f42617cf93805fe5fbe8ea9a5feb13a853d1969a63ea741c73ba1872b4b8b1939b924e388e0ec377
+  metadata.gz: 1e66633ce3e37380f20f83f3747ef158e9baadc0853898850972c7e119fe7615eadd53c3197c9bfbd8e48f341d38991060f8dfba16070f34953a08208eefa5bf
+  data.tar.gz: 798abf5941f2fbac379d6b19622d1dfe8fd278c81a715a8e1f55a0f8c91aa6b0b1febfd2a60241ddb9a12f5320ed112a77a0a39f860d3e26e43985277f4d0e99

data/README.md

@@ -14,7 +14,7 @@ Fix is a modern Ruby testing framework that emphasizes clear separation between
 Add to your Gemfile:
 
 ```ruby
-gem "fix", ">= 1.0.0.beta11"
+gem "fix", ">= 1.0.0.beta12"
 ```
 
 Then execute:
@@ -226,6 +226,67 @@ Running the test:
 Fix[:Duck].test { Duck.new }
 ```
 
+## Available Matchers
+
+Fix includes a comprehensive set of matchers through its integration with the [Matchi library](https://github.com/fixrb/matchi):
+
+### Basic Comparison Matchers
+- `eq(expected)` - Tests equality using `eql?`
+- `be(expected)` - Tests object identity using `equal?`
+
+### Type Checking Matchers
+- `be_an_instance_of(class)` - Verifies exact class match
+- `be_a_kind_of(class)` - Checks class inheritance and module inclusion
+
+### Change Testing Matchers
+- `change(object, method)` - Base matcher for state changes
+  - `.by(n)` - Expects exact change by n
+  - `.by_at_least(n)` - Expects minimum change by n
+  - `.by_at_most(n)` - Expects maximum change by n
+  - `.from(old).to(new)` - Expects change from old to new value
+  - `.to(new)` - Expects change to new value
+
+### Numeric Matchers
+- `be_within(delta).of(value)` - Tests if a value is within ±delta of expected value
+
+### Pattern Matchers
+- `match(regex)` - Tests string against regular expression pattern
+- `satisfy { |value| ... }` - Custom matching with block
+
+### State Matchers
+- `be_true` - Tests for true
+- `be_false` - Tests for false
+- `be_nil` - Tests for nil
+
+### Exception Matchers
+- `raise_exception(class)` - Tests if code raises specified exception
+
+### Dynamic Predicate Matchers
+- `be_*` - Dynamically matches `object.*?` methods (e.g., `be_empty` calls `empty?`)
+- `have_*` - Dynamically matches `object.has_*?` methods (e.g., `have_key` calls `has_key?`)
+
+Example usage:
+
+```ruby
+Fix :Calculator do
+  it MUST be_an_instance_of Calculator
+
+  on :add, 2, 3 do
+    it MUST eq 5
+    it MUST be_within(0.001).of(5.0)
+  end
+
+  on :divide, 1, 0 do
+    it MUST raise_exception ZeroDivisionError
+  end
+
+  with numbers: [1, 2, 3] do
+    it MUST_NOT be_empty
+    it MUST satisfy { |result| result.all? { |n| n.positive? } }
+  end
+end
+```
+
 ## Why Choose Fix?
 
 Fix brings several unique advantages to Ruby testing that set it apart from traditional testing frameworks:

data/lib/fix/matcher.rb

@@ -5,237 +5,45 @@ require "matchi"
 module Fix
   # Collection of expectation matchers.
   #
+  # The following matchers are available:
+  #
+  # Basic Comparison:
+  # - eq(expected)         # Checks equality using eql?
+  # - eql(expected)        # Alias for eq
+  # - be(expected)         # Checks exact object identity using equal?
+  # - equal(expected)      # Alias for be
+  #
+  # Type Checking:
+  # - be_an_instance_of(class) # Checks exact class match
+  # - be_a_kind_of(class)      # Checks class inheritance and module inclusion
+  #
+  # State & Changes:
+  # - change(object, method)     # Base for checking state changes
+  #   .by(n)                     # Exact change by n
+  #   .by_at_least(n)            # Minimum change by n
+  #   .by_at_most(n)             # Maximum change by n
+  #   .from(old).to(new)         # Change from old to new value
+  #   .to(new)                   # Change to new value
+  #
+  # Value Testing:
+  # - be_within(delta).of(value) # Checks numeric value within delta
+  # - match(regex)               # Tests against regular expression
+  # - satisfy { |value| ... }    # Custom matcher with block
+  #
+  # Exceptions:
+  # - raise_exception(class)     # Checks if code raises exception
+  #
+  # State Testing:
+  # - be_true                    # Tests for true
+  # - be_false                   # Tests for false
+  # - be_nil                     # Tests for nil
+  #
+  # Predicate Matchers:
+  # - be_*                       # Matches object.*? method
+  # - have_*                     # Matches object.has_*? method
+  #
   # @api private
   module Matcher
-    # Equivalence matcher
-    #
-    # @example
-    #   matcher = eq("foo")
-    #   matcher.match? { "foo" } # => true
-    #   matcher.match? { "bar" } # => false
-    #
-    # @param expected [#eql?] An expected equivalent object.
-    #
-    # @return [#match?] An equivalence matcher.
-    #
-    # @api public
-    def eq(expected)
-      ::Matchi::Eq.new(expected)
-    end
-
-    alias eql eq
-
-    # Identity matcher
-    #
-    # @example
-    #   object = "foo"
-    #   matcher = be(object)
-    #   matcher.match? { object } # => true
-    #   matcher.match? { "foo" } # => false
-    #
-    # @param expected [#equal?] The expected identical object.
-    #
-    # @return [#match?] An identity matcher.
-    #
-    # @api public
-    def be(expected)
-      ::Matchi::Be.new(expected)
-    end
-
-    alias equal be
-
-    # Comparisons matcher
-    #
-    # @example
-    #   matcher = be_within(1).of(41)
-    #   matcher.match? { 42 } # => true
-    #   matcher.match? { 43 } # => false
-    #
-    # @param delta [Numeric] A numeric value.
-    #
-    # @return [#match?] A comparison matcher.
-    #
-    # @api public
-    def be_within(delta)
-      ::Matchi::BeWithin.new(delta)
-    end
-
-    # Regular expressions matcher
-    #
-    # @example
-    #   matcher = match(/^foo$/)
-    #   matcher.match? { "foo" } # => true
-    #   matcher.match? { "bar" } # => false
-    #
-    # @param expected [#match] A regular expression.
-    #
-    # @return [#match?] A regular expression matcher.
-    #
-    # @api public
-    def match(expected)
-      ::Matchi::Match.new(expected)
-    end
-
-    # Expecting errors matcher
-    #
-    # @example
-    #   matcher = raise_exception(NameError)
-    #   matcher.match? { Boom } # => true
-    #   matcher.match? { true } # => false
-    #
-    # @param expected [Exception, #to_s] The expected exception name.
-    #
-    # @return [#match?] An error matcher.
-    #
-    # @api public
-    def raise_exception(expected)
-      ::Matchi::RaiseException.new(expected)
-    end
-
-    # True matcher
-    #
-    # @example
-    #   matcher = be_true
-    #   matcher.match? { true } # => true
-    #   matcher.match? { false } # => false
-    #   matcher.match? { nil } # => false
-    #   matcher.match? { 4 } # => false
-    #
-    # @return [#match?] A `true` matcher.
-    #
-    # @api public
-    def be_true
-      be(true)
-    end
-
-    # False matcher
-    #
-    # @example
-    #   matcher = be_false
-    #   matcher.match? { false } # => true
-    #   matcher.match? { true } # => false
-    #   matcher.match? { nil } # => false
-    #   matcher.match? { 4 } # => false
-    #
-    # @return [#match?] A `false` matcher.
-    #
-    # @api public
-    def be_false
-      be(false)
-    end
-
-    # Nil matcher
-    #
-    # @example
-    #   matcher = be_nil
-    #   matcher.match? { nil } # => true
-    #   matcher.match? { false } # => false
-    #   matcher.match? { true } # => false
-    #   matcher.match? { 4 } # => false
-    #
-    # @return [#match?] A `nil` matcher.
-    #
-    # @api public
-    def be_nil
-      be(nil)
-    end
-
-    # Type/class matcher
-    #
-    # @example
-    #   matcher = be_an_instance_of(String)
-    #   matcher.match? { "foo" } # => true
-    #   matcher.match? { 4 } # => false
-    #
-    # @param expected [Class, #to_s] The expected class name.
-    #
-    # @return [#match?] A type/class matcher.
-    #
-    # @api public
-    def be_an_instance_of(expected)
-      ::Matchi::BeAnInstanceOf.new(expected)
-    end
-
-    # Change matcher
-    #
-    # @example
-    #   object = []
-    #   matcher = change(object, :length).by(1)
-    #   matcher.match? { object << 1 } # => true
-    #
-    #   object = []
-    #   matcher = change(object, :length).by_at_least(1)
-    #   matcher.match? { object << 1 } # => true
-    #
-    #   object = []
-    #   matcher = change(object, :length).by_at_most(1)
-    #   matcher.match? { object << 1 } # => true
-    #
-    #   object = "foo"
-    #   matcher = change(object, :to_s).from("foo").to("FOO")
-    #   matcher.match? { object.upcase! } # => true
-    #
-    #   object = "foo"
-    #   matcher = change(object, :to_s).to("FOO")
-    #   matcher.match? { object.upcase! } # => true
-    #
-    # @param object [#object_id]  An object.
-    # @param method [Symbol]      The name of a method.
-    #
-    # @return [#match?] A change matcher.
-    #
-    # @api public
-    def change(object, method, ...)
-      ::Matchi::Change.new(object, method, ...)
-    end
-
-    # Satisfy matcher
-    #
-    # @example
-    #   matcher = satisfy { |value| value == 42 }
-    #   matcher.match? { 42 } # => true
-    #
-    # @yield [value] A block that defines the satisfaction criteria
-    # @yieldparam value The value to test
-    # @yieldreturn [Boolean] true if the value satisfies the criteria
-    #
-    # @return [#match?] A satisfy matcher.
-    #
-    # @api public
-    def satisfy(&)
-      ::Matchi::Satisfy.new(&)
-    end
-
-    private
-
-    # Predicate matcher, or default method missing behavior.
-    #
-    # @example Empty predicate matcher
-    #   matcher = be_empty
-    #   matcher.match? { [] } # => true
-    #   matcher.match? { [4] } # => false
-    def method_missing(name, ...)
-      return super unless predicate_matcher_name?(name)
-
-      ::Matchi::Predicate.new(name, ...)
-    end
-
-    # :nocov:
-
-    # Hook method to return whether the obj can respond to id method or not.
-    def respond_to_missing?(name, include_private = false)
-      predicate_matcher_name?(name) || super
-    end
-
-    # :nocov:
-
-    # Predicate matcher name detector.
-    #
-    # @param name [Array, Symbol] The name of a potential predicate matcher.
-    #
-    # @return [Boolean] Indicates if it is a predicate matcher name or not.
-    def predicate_matcher_name?(name)
-      name.start_with?("be_", "have_") && !name.end_with?("!", "?")
-    end
+    include Matchi
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: fix
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta11
+  version: 1.0.0.beta12
 platform: ruby
 authors:
 - Cyril Kato
 bindir: bin
 cert_chain: []
-date: 2024-12-30 00:00:00.000000000 Z
+date: 2024-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: defi
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.1.0
 - !ruby/object:Gem::Dependency
   name: spectus
   requirement: !ruby/object:Gem::Requirement