matchi-fix 2.1.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40d7531073da5b8a4303fc9c3cae6b9caae05084ab3d9522a8e1f5c5e7f1fe18
-  data.tar.gz: 6886e9b0c8339f4270522436eab1ed9df61a8ad98eea7486733afe4c113d849e
+  metadata.gz: 3b42bc77b68d62f4c3bed7bf25c7a78dbc48968db05bcdfb234f96ec0e903310
+  data.tar.gz: f508566e09920d7a88aabc3588350a4679eac62f4e605c35c00db29334fa63bb
 SHA512:
-  metadata.gz: 6c884e1a53abe424c671cc9a2b9f66584422a045ae92c72009431c41c15bf7e970806ea09e6cbff6e447f362fd24e830bdac58a755d30700809d701d649dfe04
-  data.tar.gz: 6d053108ce76597356f41122a4718432cb78bd508c728ebdfa6f002382ae65f6cab6fbb6f87a8ecc783d821fdce6bc5a44e5ee2fb3a4d80c5667a47493b8b010
+  metadata.gz: b019c450b570dd51b99e0202b3d44a26943f743e0c676fc044a7125cfbc68a1c43b23d540971dec16456d2acf05b0685c9c0e1186f8a455a5e31fa05e34647e4
+  data.tar.gz: 7b0dcaaa92f49aff5eba4604b112b57c18fe038098d477dbac459b4065c1a400f758f18d2e5078d70aef2d464558ec80a7d0f18c926533e6d9b82f6fef15744b

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2021 Cyril Kato
+Copyright (c) 2015-2025 Cyril Kato
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -2,11 +2,9 @@
 
 [![Version](https://img.shields.io/github/v/tag/fixrb/matchi-fix?label=Version&logo=github)](https://github.com/fixrb/matchi-fix/releases)
 [![Yard documentation](https://img.shields.io/badge/Yard-documentation-blue.svg?logo=github)](https://rubydoc.info/github/fixrb/matchi-fix/main)
-[![CI](https://github.com/fixrb/matchi-fix/workflows/CI/badge.svg?branch=main)](https://github.com/fixrb/matchi-fix/actions?query=workflow%3Aci+branch%3Amain)
-[![RuboCop](https://github.com/fixrb/matchi-fix/workflows/RuboCop/badge.svg?branch=main)](https://github.com/fixrb/matchi-fix/actions?query=workflow%3Arubocop+branch%3Amain)
 [![License](https://img.shields.io/github/license/fixrb/matchi-fix?label=License&logo=github)](https://github.com/fixrb/matchi-fix/raw/main/LICENSE.md)
 
-> A [Fix](https://github.com/fixrb/fix) specifications matcher compatible with [Matchi](https://github.com/fixrb/matchi).
+[Matchi](https://github.com/fixrb/matchi)-compatible matcher for testing implementations against [Fix](https://github.com/fixrb/fix) specifications.
 
 ## Installation
 
@@ -18,16 +16,24 @@ gem "matchi-fix"
 
 And then execute:
 
-```sh
-bundle
+```shell
+bundle install
 ```
 
-Or install it yourself as:
+Or install it yourself:
 
-```sh
+```shell
 gem install matchi-fix
 ```
 
+## Description
+
+A Matchi-compatible matcher that allows testing objects against Fix specifications.
+Enables verification of implementation conformance to Fix test specifications
+across different testing frameworks like Minitest and RSpec. Integrates seamlessly
+with the Fix testing framework's powerful specification system while maintaining
+Matchi's clean matcher interface.
+
 ## Usage
 
 To make __Matchi::Fix__ available:
@@ -36,30 +42,47 @@ To make __Matchi::Fix__ available:
 require "matchi/fix"
 ```
 
-All examples here assume that this has been done.
+The Fix matcher allows testing values against Fix specifications. After requiring `matchi-fix`, you can use the `Fix` matcher in your tests through anonymous specification:
+
+```ruby
+Matchi::Fix.new { it MUST be 42 }.match? { 42 } # => true
+```
 
-### With a block of specifications
+or through registered specification by name:
 
 ```ruby
-matcher = Matchi::Fix.new { it MUST be 42 }
+# First, define a Fix specification
+Fix :Calculator do
+  on(:add, 2, 3) do
+    it MUST eq 5
+  end
+
+  on(:multiply, 2, 3) do
+    it MUST eq 6
+  end
+end
+
+# Then use the matcher to test implementations
+calculator = MyCalculator.new
 
-matcher.expected        # => #<Fix::Set:0x00007fd96915dc28 ...>
-matcher.matches? { 42 } # => true
+# Using direct matcher syntax
+Matchi::Fix.new(:Calculator).matches?(calculator) #=> true/false
 ```
 
-### With the constant name of the specifications
+### Error Handling
 
-If specifications have been defined and named, they can be mentioned:
+On missing specifications:
 
 ```ruby
-Fix :Answer do
-  it MUST be 42
-end
+Matchi::Fix.new(:NonExistent)
+# => KeyError
+```
 
-matcher = Matchi::Fix.new(:Answer)
+On passing both specification name and specification code:
 
-matcher.expected        # => #<Fix::Set:0x00007fd96915dc28 ...>
-matcher.matches? { 42 } # => true
+```ruby
+Matchi::Fix.new(:SpecName) { "Spec block" }
+# => ArgumentError
 ```
 
 ## Contact
@@ -74,11 +97,6 @@ __Matchi::Fix__ follows [Semantic Versioning 2.0](https://semver.org/).
 
 The [gem](https://rubygems.org/gems/matchi-fix) is available as open source under the terms of the [MIT License](https://github.com/fixrb/matchi-fix/raw/main/LICENSE.md).
 
-***
+## Sponsors
 
-<p>
-  This project is sponsored by:<br />
-  <a href="https://sashite.com/"><img
-    src="https://github.com/fixrb/matchi-fix/raw/main/img/sashite.png"
-    alt="Sashite" /></a>
-</p>
+This project is sponsored by [Sashité](https://sashite.com/)

data/lib/matchi/fix.rb

@@ -2,89 +2,127 @@
 
 require "fix"
 
-# Namespace for the Matchi library.
 module Matchi
-  # **Fix** matcher.
+  # Specification conformance matcher that verifies objects against Fix test specifications.
+  #
+  # This matcher allows testing objects against Fix specifications, enabling verification
+  # of implementation conformance across different testing frameworks. It supports both
+  # anonymous specifications defined inline and named specifications registered with Fix.
+  # The matcher provides a bridge between Matchi's matcher interface and Fix's powerful
+  # specification system.
+  #
+  # @example Basic usage with anonymous specification
+  #   matcher = Matchi::Fix.new { it MUST be 42 }
+  #   matcher.match? { 42 }              # => true
+  #   matcher.match? { 41 }              # => false
+  #
+  # @example Using named specifications
+  #   # Define a Fix specification
+  #   Fix :Calculator do
+  #     on(:add, 2, 3) do
+  #       it MUST eq 5
+  #     end
+  #
+  #     on(:multiply, 2, 3) do
+  #       it MUST eq 6
+  #     end
+  #   end
+  #
+  #   # Test implementations
+  #   calculator = Calculator.new
+  #   matcher = Matchi::Fix.new(:Calculator)
+  #   matcher.match? { calculator }      # => true if calculator meets spec
+  #
+  # @example Complex specifications
+  #   Fix :UserValidator do
+  #     on(:validate, name: "Alice", age: 30) do
+  #       it MUST be true
+  #     end
+  #
+  #     on(:validate, name: "", age: -1) do
+  #       it MUST be false
+  #     end
+  #   end
+  #
+  #   validator = UserValidator.new
+  #   matcher = Matchi::Fix.new(:UserValidator)
+  #   matcher.match? { validator }       # => true if validation logic is correct
+  #
+  # @see https://github.com/fixrb/fix
+  # @see https://github.com/fixrb/matchi
   class Fix
-    # @return [#against] A set of specifications.
-    attr_reader :expected
-
-    # Initialize the matcher with a behavioral definition.
+    # Initialize the matcher with either a name or a specification block.
     #
-    # @example With a block of specifications
-    #   require "matchi/fix"
+    # @api public
     #
-    #   Matchi::Fix.new { it MUST be 42 }
+    # @param name [Symbol, nil] The name of a registered Fix specification
+    # @param block [Proc, nil] A block containing the specification
     #
-    # @example With the constant name of the specifications
-    #   require "matchi/fix"
+    # @raise [ArgumentError] if neither name nor block is provided
+    # @raise [ArgumentError] if both name and block are provided
+    # @raise [KeyError] if the named specification doesn't exist
     #
-    #   Fix :Answer do
-    #     it MUST be 42
-    #   end
+    # @return [Fix] a new instance of the matcher
     #
-    #   Matchi::Fix.new(:Answer)
+    # @example With anonymous specification
+    #   Fix.new { it MUST be_positive }
     #
-    # @param name   [String, Symbol]  The constant name of the specifications.
-    # @param block  [Proc]            A block of specifications.
+    # @example With named specification
+    #   Fix.new(:Calculator)
     def initialize(name = nil, &block)
-      @expected = if name.nil?
-                    raise ::ArgumentError, "Pass either an argument or a block" unless block
+      raise ::ArgumentError, "a name or a block must be provided" if name.nil? && block.nil?
+      raise ::ArgumentError, "a name or a block must be provided" if !name.nil? && !block.nil?
 
-                    Fix(&block)
-                  else
-                    raise ::ArgumentError, "Can't pass both an argument and a block" if block
-
-                    @name = name
-                    ::Fix[name]
-                  end
+      @expected = name.nil? ? ::Fix.spec(&block) : ::Fix[name]
     end
 
-    # Boolean comparison between an actual value and the expected specs.
+    # Checks if the yielded object satisfies the Fix specification.
     #
-    # @example With a block of specifications
-    #   require "matchi/fix"
+    # This method executes the Fix specification against the provided object,
+    # verifying that all specified behaviors and conditions are met. It works
+    # with both anonymous and named specifications.
     #
-    #   matcher = Matchi::Fix.new { it MUST be 42 }
+    # @api public
     #
-    #   matcher.expected        # => #<Fix::Set:0x00007fd96915dc28 ...>
-    #   matcher.matches? { 42 } # => true
+    # @yield [] Block that returns the object to verify
+    # @yieldreturn [Object] The object to check against the specification
     #
-    # @example With the constant name of the specifications
-    #   require "matchi/fix"
+    # @return [Boolean] true if the object satisfies the specification
     #
-    #   Fix :Answer do
-    #     it MUST be 42
-    #   end
+    # @raise [ArgumentError] if no block is provided
     #
-    #   matcher = Matchi::Fix.new(:Answer)
+    # @example With anonymous specification
+    #   matcher = Fix.new { it MUST be_zero }
+    #   matcher.match? { 0 }             # => true
+    #   matcher.match? { 1 }             # => false
     #
-    #   matcher.expected        # => #<Fix::Set:0x00007fd96915dc28 ...>
-    #   matcher.matches? { 42 } # => true
-    #
-    # @yieldreturn [#object_id] The value to be compared to the specifications.
+    # @example With named specification
+    #   Fix :Sortable do
+    #     on(:sort) do
+    #       it MUST be_kind_of(Array)
+    #       it MUST be_sorted
+    #     end
+    #   end
     #
-    # @return [Boolean] Determines whether the test has passed or failed.
-    def matches?(&block)
-      expected.against(log_level: 0, &block)
-    rescue ::SystemExit => e
-      e.success?
-    end
+    #   matcher = Fix.new(:Sortable)
+    #   matcher.match? { [1, 2, 3] }     # => true if array meets spec
+    def match?
+      raise ::ArgumentError, "a block must be provided" unless block_given?
 
-    # A string containing a human-readable representation of the matcher.
-    def inspect
-      "#{self.class}(#{parameter})"
+      @expected.match?(yield)
     end
 
-    # Returns a string representing the matcher.
+    # Returns a human-readable description of the matcher.
+    #
+    # @api public
+    #
+    # @return [String] A string describing what this matcher verifies
+    #
+    # @example
+    #   Fix.new(:Calculator).to_s # => "fix Calculator"
+    #   Fix.new { it MUST be 42 }.to_s # => "fix #<Fix::Spec:...>"
     def to_s
-      "fix #{parameter}"
-    end
-
-    private
-
-    def parameter
-      @name.nil? ? "&specs" : ":#{@name}"
+      "fix #{@expected.inspect}"
     end
   end
 end

metadata

@@ -1,156 +1,50 @@
 --- !ruby/object:Gem::Specification
 name: matchi-fix
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Cyril Kato
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-30 00:00:00.000000000 Z
+date: 2025-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fix
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta8
+        version: '0.21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta8
+        version: '0.21'
 - !ruby/object:Gem::Dependency
   name: matchi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-md
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-thread_safety
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: A Fix specifications matcher compatible with Matchi.
+        version: '4.1'
+description: 'A Matchi-compatible matcher that allows testing objects against Fix
+  specifications. Enables verification of implementation conformance to Fix test specifications
+  across different testing frameworks like Minitest and RSpec. Integrates seamlessly
+  with the Fix testing framework''s powerful specification system while maintaining
+  Matchi''s clean matcher interface.
+
+  '
 email: contact@cyril.email
 executables: []
 extensions: []
@@ -162,8 +56,12 @@ files:
 homepage: https://github.com/fixrb/matchi-fix
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/fixrb/matchi-fix/issues
+  documentation_uri: https://rubydoc.info/gems/matchi-fix
+  source_code_uri: https://github.com/fixrb/matchi-fix
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -171,15 +69,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.27
+signing_key:
 specification_version: 4
-summary: Fix specifications matcher.
+summary: Matcher for testing implementations against Fix specifications.
 test_files: []