matchi-fix 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ccabebdd23eb7e82cbfd9a24decb4b6e310019699c5b4960357c84be7c2853a
-  data.tar.gz: d72041ff77469fa635b4454212760a1185556684eec0369aa6b78d0eb5a1d7f3
+  metadata.gz: 8dda03096cb67cd0a3552246a0e0ae676a346e3483cbfd5fd88eaded3ed9020e
+  data.tar.gz: 01b9f0fa9e7dfe4b07c279209f7dfdc36085d1652bf5167b67e6c890d7ff7653
 SHA512:
-  metadata.gz: fb77ea77128e0dd6949828125a9dbcb877c8585a4fa0eafbbc4054ab0b612f89cd7ecc2a416d5d82181dafd58b689855ca746102b956f8760f88e25060922cda
-  data.tar.gz: a74e2afd1548eecefbd6f9b65b8916158bfc20f6525850fa53acf7036ef77ab4fa7228a3e13f14d053e5d7fefcb80c98144df2dd08a7c16437e21c9875eb819e
+  metadata.gz: d96d65f1086745d2f8a71aeb007911c93b2f14b7943762c5068f31090185b54af4d1bd96c469762cff956ce13bdcfd99593e0c192e3265515be8d2d9100ceec8
+  data.tar.gz: cd08c56a584d6c460d621d4e29de1c9f4ddb1bbc783ef23e04cc56e41bf9cc04ca2e6b0a612933ed067ac2a5981435436057719b1bd0a81b31e31139eb6a1cb3

data/README.md

@@ -6,7 +6,7 @@
 [![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) expectation matcher for [Matchi](https://github.com/fixrb/matchi).
+> A [Fix](https://github.com/fixrb/fix) specifications matcher compatible with [Matchi](https://github.com/fixrb/matchi).
 
 ## Installation
 
@@ -30,15 +30,38 @@ gem install matchi-fix
 
 ## Usage
 
+To make __Matchi::Fix__ available:
+
 ```ruby
 require "matchi/fix"
+```
+
+All examples here assume that this has been done.
+
+### With a block of specifications
 
+```ruby
 matcher = Matchi::Fix.new { it MUST be 42 }
 
 matcher.expected        # => #<Fix::Set:0x00007fd96915dc28 ...>
 matcher.matches? { 42 } # => true
 ```
 
+### With the constant name of the specifications
+
+If specifications have been defined and named, they can be mentioned:
+
+```ruby
+Fix :Answer do
+  it MUST be 42
+end
+
+matcher = Matchi::Fix.new(:Answer)
+
+matcher.expected        # => #<Fix::Set:0x00007fd96915dc28 ...>
+matcher.matches? { 42 } # => true
+```
+
 ## Contact
 
 * Source code: https://github.com/fixrb/matchi-fix
@@ -49,7 +72,7 @@ __Matchi::Fix__ follows [Semantic Versioning 2.0](https://semver.org/).
 
 ## License
 
-The [gem](https://rubygems.org/gems/matchi-fix) is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+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).
 
 ***
 

data/lib/matchi/fix.rb

@@ -6,24 +6,43 @@ require "fix"
 module Matchi
   # **Fix** matcher.
   class Fix
-    # @return [Proc] A set of specifications.
+    # @return [#test] A set of specifications.
     attr_reader :expected
 
-    # Initialize the matcher with a block of specs.
+    # Initialize the matcher with a behavioral definition.
     #
-    # @example
+    # @example With a block of specifications
     #   require "matchi/fix"
     #
     #   Matchi::Fix.new { it MUST be 42 }
     #
-    # @param block [Proc] A block of code.
-    def initialize(&block)
-      @expected = Fix(&block)
+    # @example With the constant name of the specifications
+    #   require "matchi/fix"
+    #
+    #   Fix :Answer do
+    #     it MUST be 42
+    #   end
+    #
+    #   Matchi::Fix.new(:Answer)
+    #
+    # @param name   [String, Symbol]  The constant name of the specifications.
+    # @param block  [Proc]            A block of specifications.
+    def initialize(name = nil, &block)
+      @expected = if name.nil?
+                    raise ::ArgumentError, "Pass either an argument or a block" unless block
+
+                    Fix(&block)
+                  else
+                    raise ::ArgumentError, "Can't pass both an argument and a block" if block
+
+                    @name = name
+                    ::Fix[name]
+                  end
     end
 
-    # Boolean comparison between the actual value and the expected specs.
+    # Boolean comparison between an actual value and the expected specs.
     #
-    # @example
+    # @example With a block of specifications
     #   require "matchi/fix"
     #
     #   matcher = Matchi::Fix.new { it MUST be 42 }
@@ -31,10 +50,21 @@ module Matchi
     #   matcher.expected        # => #<Fix::Set:0x00007fd96915dc28 ...>
     #   matcher.matches? { 42 } # => true
     #
-    # @yieldreturn [#object_id] The actual value to compare to the expected
-    #   one.
+    # @example With the constant name of the specifications
+    #   require "matchi/fix"
+    #
+    #   Fix :Answer do
+    #     it MUST be 42
+    #   end
+    #
+    #   matcher = Matchi::Fix.new(:Answer)
+    #
+    #   matcher.expected        # => #<Fix::Set:0x00007fd96915dc28 ...>
+    #   matcher.matches? { 42 } # => true
+    #
+    # @yieldreturn [#object_id] The value to be compared to the specifications.
     #
-    # @return [Boolean] Comparison between actual and expected values.
+    # @return [Boolean] Actual value test on specifications.
     def matches?(&block)
       expected.test(log_level: 0, &block)
     rescue ::SystemExit => e
@@ -43,12 +73,18 @@ module Matchi
 
     # A string containing a human-readable representation of the matcher.
     def inspect
-      "#{self.class}(&specs)"
+      "#{self.class}(#{parameter})"
     end
 
     # Returns a string representing the matcher.
     def to_s
-      "fix &specs"
+      "fix #{parameter}"
+    end
+
+    private
+
+    def parameter
+      @name.nil? ? "&specs" : ":#{@name}"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matchi-fix
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-27 00:00:00.000000000 Z
+date: 2021-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fix
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -150,7 +150,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A Fix expectation matcher for Matchi.
+description: A Fix specifications matcher compatible with Matchi.
 email: contact@cyril.email
 executables: []
 extensions: []
@@ -181,5 +181,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: Fix expectation matcher.
+summary: Fix specifications matcher.
 test_files: []