fix 1.0.0.beta8 → 1.0.0.beta9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d095777befeb78f0e16a218f3f14c0f8b39955265db3848cd26a0afb0b224f3
-  data.tar.gz: d918e8bfd693765450dfb14477f4fe9285642e22a35995446b89acac78662837
+  metadata.gz: 0d266f76f9d9f0ee694cade79ee90b02d1a662709bb31c548da80be1ab42d689
+  data.tar.gz: e38fa445573fe8b23df2cea139c4d2879a49652afdb6543aebd05525a5ca0da9
 SHA512:
-  metadata.gz: c063f295f4d133635d70da15659c613018b51931db21d40c3bedb7db9b442fa756e8ed52833fc49333a816749df99c73956d43c237159f7bd6e728ea36e7791d
-  data.tar.gz: 1e4317121e610e67d0d396571b86e0a82b07c16122cc0be5c2c7ee5514136d9ec349282b643f06fe6d7f7b33cd04584048cf72ec3d8d88345e93f1135e7d5dee
+  metadata.gz: 2496a36150fc8640b16ab0942592dfcb47cf0cc0db0abb9d6c716387e73a8a16f329459be64d74c00a7604ec9081191d0580de45cbe62f585fdc9aff744d2b4f
+  data.tar.gz: 0b09e865870d08db2b9147fd9977aa7b0df27d44a63e3138c8e699258cc49dfcee3f81000f4491a896275b79d54c45b1e3b1f3e9fe881cc9152fa7e48a1f0f61

data/LICENSE.md

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+# The MIT License
 
-Copyright (c) 2014-2021 Cyril Kato
+Copyright (c) 2014-2024 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

@@ -1,38 +1,36 @@
 # Fix
 
 [![Home](https://img.shields.io/badge/Home-fixrb.dev-00af8b)](https://fixrb.dev/)
-[![Version](https://img.shields.io/github/v/tag/fixrb/fix?label=Version&logo=github)](https://github.com/fixrb/fix/releases)
+[![Version](https://img.shields.io/github/v/tag/fixrb/fix?label=Version&logo=github)](https://github.com/fixrb/fix/tags)
 [![Yard documentation](https://img.shields.io/badge/Yard-documentation-blue.svg?logo=github)](https://rubydoc.info/github/fixrb/fix/main)
-[![CI](https://github.com/fixrb/fix/workflows/CI/badge.svg?branch=main)](https://github.com/fixrb/fix/actions?query=workflow%3Aci+branch%3Amain)
+[![Ruby](https://github.com/fixrb/fix/workflows/Ruby/badge.svg?branch=main)](https://github.com/fixrb/fix/actions?query=workflow%3Aruby+branch%3Amain)
 [![RuboCop](https://github.com/fixrb/fix/workflows/RuboCop/badge.svg?branch=main)](https://github.com/fixrb/fix/actions?query=workflow%3Arubocop+branch%3Amain)
 [![License](https://img.shields.io/github/license/fixrb/fix?label=License&logo=github)](https://github.com/fixrb/fix/raw/main/LICENSE.md)
 
-⚠️ This project is still in the experimental phase. May be used at your own risk.
+![Fix specing framework for Ruby](https://fixrb.dev/fix.webp "Fix")
 
-![Fix specing framework for Ruby](https://fixrb.dev/fix.webp)
+## Project Goals
 
-## Project goals
-
-* Extract specs from the tests.
-* Look like English documents.
-* Be minimalist and easy to use.
-* Run tests quickly.
+- **Distinguish Specifications from Examples**: Clear separation between what is expected (specifications) and how it's demonstrated (examples).
+- **Logic-Free Specification Documents**: Create specifications that are straightforward and free of complex logic, focusing purely on defining expected behaviors.
+- **Nuanced Semantic Language in Specifications**: Utilize a rich, nuanced semantic language, similar to that in RFC 2119, employing keywords like MUST, SHOULD, and MAY to define different levels of requirement in specifications.
+- **Fast and Individual Test Execution**: Enable quick execution of tests on an individual basis, providing immediate feedback on compliance with specifications.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add to your Gemfile:
 
 ```ruby
-gem "fix", ">= 1.0.0.beta8"
+gem "fix", ">= 1.0.0.beta9"
 ```
 
-And then execute:
+Then execute:
 
 ```sh
-bundle
+bundle install
 ```
 
-Or install it yourself as:
+Or install it yourself:
 
 ```sh
 gem install fix --pre
@@ -40,7 +38,7 @@ gem install fix --pre
 
 ## Example
 
-Given these specifications:
+Specifications for a `Duck` class:
 
 ```ruby
 # examples/duck/fix.rb
@@ -65,10 +63,11 @@ Fix :Duck do
 end
 ```
 
-When we load this `Duck` application:
+Implementing the `Duck` class:
 
 ```ruby
 # examples/duck/app.rb
+
 class Duck
   def walks
     "Klop klop!"
@@ -84,7 +83,7 @@ class Duck
 end
 ```
 
-And we run this test:
+Running the test:
 
 ```ruby
 # examples/duck/test.rb
@@ -92,14 +91,16 @@ And we run this test:
 require_relative "app"
 require_relative "fix"
 
-Fix[:Duck].against { Duck.new }
+Fix[:Duck].test { Duck.new }
 ```
 
+Execute:
+
 ```sh
 ruby examples/duck/test.rb
 ```
 
-We should see this output:
+Expected output:
 
 ```txt
 (irb):3 Success: expected #<Duck:0x00007fb2fa208708> to be an instance of Duck.
@@ -111,10 +112,10 @@ We should see this output:
 
 ## Contact
 
-* Home page: [https://fixrb.dev/](https://fixrb.dev/)
-* Source code: [https://github.com/fixrb/fix](https://github.com/fixrb/fix)
-* API Doc: [https://rubydoc.info/gems/fix](https://rubydoc.info/gems/fix)
-* Twitter: [https://twitter.com/fix\_rb](https://twitter.com/fix\_rb)
+- [Home page](https://fixrb.dev/)
+- [Source code](https://github.com/fixrb/fix)
+- [API Documentation](https://rubydoc.info/gems/fix)
+- [Twitter](https://twitter.com/fix_rb)
 
 ## Versioning
 
@@ -124,11 +125,11 @@ __Fix__ follows [Semantic Versioning 2.0](https://semver.org/).
 
 The [gem](https://rubygems.org/gems/fix) is available as open source under the terms of the [MIT License](https://github.com/fixrb/fix/raw/main/LICENSE.md).
 
-***
+---
 
 <p>
   This project is sponsored by:<br />
   <a href="https://sashite.com/"><img
     src="https://github.com/fixrb/fix/raw/main/img/sashite.png"
-    alt="Sashite" /></a>
+    alt="Sashité" /></a>
 </p>

data/lib/fix/dsl.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "defi"
+require "defi/method"
 
 require_relative "matcher"
 require_relative "requirement"
@@ -28,8 +28,8 @@ module Fix
     # @return [Symbol] A private method that define the block content.
     #
     # @api public
-    def self.let(name, &block)
-      private define_method(name, &block)
+    def self.let(name, &)
+      private define_method(name, &)
     end
 
     # Defines an example group with user-defined properties that describes a
@@ -48,11 +48,11 @@ module Fix
     # @param block [Proc] The block to define the specs.
     #
     # @api public
-    def self.with(**kwargs, &block)
+    def self.with(**kwargs, &)
       klass = ::Class.new(self)
       klass.const_get(:CONTEXTS) << klass
       kwargs.each { |name, value| klass.let(name) { value } }
-      klass.instance_eval(&block)
+      klass.instance_eval(&)
       klass
     end
 
@@ -75,10 +75,10 @@ module Fix
       klass = ::Class.new(self)
       klass.const_get(:CONTEXTS) << klass
 
-      const_set("Child#{block.object_id}", klass)
+      const_set(:"Child#{block.object_id}", klass)
 
       klass.define_singleton_method(:challenges) do
-        challenge = ::Defi.send(method_name, *args, **kwargs)
+        challenge = ::Defi::Method.new(method_name, *args, **kwargs)
         super() + [challenge]
       end
 
@@ -98,14 +98,14 @@ module Fix
       location = caller_locations(1, 1).fetch(0)
       location = [location.path, location.lineno].join(":")
 
-      define_method("test_#{requirement.object_id}") do
+      define_method(:"test_#{requirement.object_id}") do
         [location, requirement, self.class.challenges]
       end
     end
 
     # The list of challenges to be addressed to the object to be tested.
     #
-    # @return [Array<Defi::Challenge>] A list of challenges.
+    # @return [Array<Defi::Method>] A list of challenges.
     def self.challenges
       []
     end

data/lib/fix/matcher.rb

@@ -181,14 +181,12 @@ module Fix
     #
     # @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.
     #
     # @return [#matches?] A change matcher.
     #
     # @api public
-    def change(object, method, *args, **kwargs, &block)
-      ::Matchi::Change.new(object, method, *args, **kwargs, &block)
+    def change(object, method, ...)
+      ::Matchi::Change.new(object, method, ...)
     end
 
     # Satisfy matcher
@@ -202,8 +200,8 @@ module Fix
     # @return [#matches?] A satisfy matcher.
     #
     # @api public
-    def satisfy(&expected)
-      ::Matchi::Satisfy.new(&expected)
+    def satisfy(&)
+      ::Matchi::Satisfy.new(&)
     end
 
     private
@@ -214,10 +212,10 @@ module Fix
     #   matcher = be_empty
     #   matcher.matches? { [] } # => true
     #   matcher.matches? { [4] } # => false
-    def method_missing(name, *args, **kwargs, &block)
+    def method_missing(name, ...)
       return super unless predicate_matcher_name?(name)
 
-      ::Matchi::Predicate.new(name, *args, **kwargs, &block)
+      ::Matchi::Predicate.new(name, ...)
     end
 
     # :nocov:

data/lib/fix/requirement.rb

@@ -20,22 +20,7 @@ module Fix
     #
     # @api public
     def MUST(matcher)
-      ::Spectus::Requirement::Required.new(
-        isolate: false,
-        negate:  false,
-        matcher: matcher
-      )
-    end
-
-    # @see MUST
-    #
-    # @api public
-    def MUST!(matcher)
-      ::Spectus::Requirement::Required.new(
-        isolate: true,
-        negate:  false,
-        matcher: matcher
-      )
+      ::Spectus::Requirement::Required.new(negate: false, matcher:)
     end
 
     # This method mean that the definition is an absolute prohibition of the specification.
@@ -46,22 +31,7 @@ module Fix
     #
     # @api public
     def MUST_NOT(matcher)
-      ::Spectus::Requirement::Required.new(
-        isolate: false,
-        negate:  true,
-        matcher: matcher
-      )
-    end
-
-    # @see MUST_NOT
-    #
-    # @api public
-    def MUST_NOT!(matcher)
-      ::Spectus::Requirement::Required.new(
-        isolate: true,
-        negate:  true,
-        matcher: matcher
-      )
+      ::Spectus::Requirement::Required.new(negate: true, matcher:)
     end
 
     # This method mean that there may exist valid reasons in particular
@@ -74,22 +44,7 @@ module Fix
     #
     # @api public
     def SHOULD(matcher)
-      ::Spectus::Requirement::Recommended.new(
-        isolate: false,
-        negate:  false,
-        matcher: matcher
-      )
-    end
-
-    # @see SHOULD
-    #
-    # @api public
-    def SHOULD!(matcher)
-      ::Spectus::Requirement::Recommended.new(
-        isolate: true,
-        negate:  false,
-        matcher: matcher
-      )
+      ::Spectus::Requirement::Recommended.new(negate: false, matcher:)
     end
 
     # This method mean that there may exist valid reasons in particular
@@ -104,22 +59,7 @@ module Fix
     #
     # @api public
     def SHOULD_NOT(matcher)
-      ::Spectus::Requirement::Recommended.new(
-        isolate: false,
-        negate:  true,
-        matcher: matcher
-      )
-    end
-
-    # @see SHOULD_NOT
-    #
-    # @api public
-    def SHOULD_NOT!(matcher)
-      ::Spectus::Requirement::Recommended.new(
-        isolate: true,
-        negate:  true,
-        matcher: matcher
-      )
+      ::Spectus::Requirement::Recommended.new(negate: true, matcher:)
     end
 
     # This method mean that an item is truly optional.
@@ -139,22 +79,7 @@ module Fix
     #
     # @api public
     def MAY(matcher)
-      ::Spectus::Requirement::Optional.new(
-        isolate: false,
-        negate:  false,
-        matcher: matcher
-      )
-    end
-
-    # @see MAY
-    #
-    # @api public
-    def MAY!(matcher)
-      ::Spectus::Requirement::Optional.new(
-        isolate: true,
-        negate:  false,
-        matcher: matcher
-      )
+      ::Spectus::Requirement::Optional.new(negate: false, matcher:)
     end
 
     # rubocop:enable Naming/MethodName

data/lib/fix/run.rb

@@ -13,12 +13,12 @@ module Fix
     # @return [::Spectus::Requirement::Base] An expectation.
     attr_reader :requirement
 
-    # @return [Array<::Defi::Challenge>] A list of challenges.
+    # @return [Array<::Defi::Method>] A list of challenges.
     attr_reader :challenges
 
     # @param environment  [::Fix::Dsl]                    A context instance.
     # @param requirement  [::Spectus::Requirement::Base]  An expectation.
-    # @param challenges   [Array<::Defi::Challenge>]      A list of challenges.
+    # @param challenges   [Array<::Defi::Method>]         A list of challenges.
     def initialize(environment, requirement, *challenges)
       @environment = environment
       @requirement = requirement
@@ -33,7 +33,7 @@ module Fix
     # @return [::Expresenter::Pass] A passed spec instance.
     #
     # @see https://github.com/fixrb/expresenter
-    def against(&subject)
+    def test(&subject)
       requirement.call { actual_value(&subject) }
     rescue ::Expresenter::Fail => e
       e

data/lib/fix/set.rb

@@ -50,15 +50,15 @@ module Fix
     # @raise [::SystemExit] The test set failed!
     #
     # @api public
-    def against(log_level: 5, &subject)
+    def test(log_level: 5, &subject)
       randomize!
 
       specs.each do |environment, location, requirement, challenges|
         runner = Run.new(environment, requirement, *challenges)
-        result = runner.against(&subject)
+        result = runner.test(&subject)
 
         failed! if result.failed?
-        report!(location, result, log_level: log_level)
+        report!(location, result, log_level:)
       end
 
       passed? || ::Kernel.exit(false)
@@ -80,13 +80,13 @@ module Fix
     end
 
     def report!(path, result, log_level:)
-      return unless report?(result, log_level: log_level)
+      return unless report?(result, log_level:)
 
       puts "#{path} #{result.colored_string}"
     end
 
     def report?(result, log_level:)
-      LOG_LEVELS[1..log_level].any? { |name| result.public_send("#{name}?") }
+      LOG_LEVELS[1..log_level].any? { |name| result.public_send(:"#{name}?") }
     end
   end
 end

data/lib/fix.rb

@@ -11,7 +11,7 @@ module Fix
   # Test a built specification.
   #
   # @example Run _Answer_ specification against `42`.
-  #   Fix[:Answer].against(42)
+  #   Fix[:Answer].test { 42 }
   #
   # @param name [String, Symbol] The constant name of the specifications.
   #

data/lib/kernel.rb

@@ -17,20 +17,21 @@ module Kernel
   #   end
   #
   #   # A test
-  #   Fix[:Answer].against { 42 }
+  #   Fix[:Answer].test { 42 }
   #
   # @param name   [String, Symbol]  The constant name of the specifications.
   # @param block  [Proc]            The specifications.
   #
-  # @return [#against] The collection of specifications.
+  # @return [#test] The collection of specifications.
   #
   # @api public
-  def Fix(name = nil, &block)
+  def Fix(name = nil, &)
     klass = ::Class.new(::Fix::Dsl)
     klass.const_set(:CONTEXTS, [klass])
-    klass.instance_eval(&block)
+    klass.instance_eval(&)
     ::Fix::Doc.const_set(name, klass) unless name.nil?
     ::Fix::Set.new(*klass.const_get(:CONTEXTS))
   end
+
   # rubocop:enable Naming/MethodName
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fix
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta8
+  version: 1.0.0.beta9
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-30 00:00:00.000000000 Z
+date: 2024-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: defi
@@ -16,154 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.5
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.5
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: matchi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.3.2
 - !ruby/object:Gem::Dependency
   name: spectus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.2
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.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'
+        version: 5.0.0
 description: Specing framework.
 email: contact@cyril.email
 executables: []
@@ -188,6 +76,7 @@ metadata:
   documentation_uri: https://rubydoc.info/gems/fix
   source_code_uri: https://github.com/fixrb/fix
   wiki_uri: https://github.com/fixrb/fix/wiki
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -196,14 +85,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Specing framework.