test_tube 2.1.3 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27985c322404e783924126aac5671af89d2852979dc9cf10deae5ca2821dada7
-  data.tar.gz: a383583d7360975bf5f1e98a0271a566be78f97a293bd8d4cec7437c6e315c4c
+  metadata.gz: a511d50711ff51b4ca13b4e6228f2e0d88dbfcb04b89ccb37619b1b2a3248073
+  data.tar.gz: 2eac86be8bdfc2733ed2fb11aa90bd4177c548e5319765549c04dd458dfd56e5
 SHA512:
-  metadata.gz: e71d511063d6f166ddce31450773f149b679ba21f95a70ffad6f92e527c4819fe44d177d676e1b774d5478f71f31ac61cd6c971d4ad1445e89a3dcab2532d59e
-  data.tar.gz: bf01ae4ec42fdf5075663b61b91933456bbce5a572c5582faa7c06d35cb857a90a23e18cf8cd4cf3109d1c1e4dbf4b49cd420ec0dbcb92c3517c8c5feaa360a9
+  metadata.gz: 80032c8cfacc36e4e49b48ba74dfbf0f0f82d8198fc2c40d66e42046d331312eb15a05bd11db0aa92fb748d3e9c6856731d3643bb543d0a90d4d725d43de9fd5
+  data.tar.gz: 4948793c91f4f2842af624a91d791875542c0eca3855780d266d88bc2c9153cb14fea30daf4e3f4afcd0671e439a80bb006ffba760b9669a93e4c577e8c9e345

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Cyril Kato
+Copyright (c) 2021-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,8 +1,8 @@
 # Test Tube
 
-[![Version](https://img.shields.io/github/v/tag/fixrb/test_tube?label=Version&logo=github)](https://github.com/fixrb/test_tube/releases)
+[![Version](https://img.shields.io/github/v/tag/fixrb/test_tube?label=Version&logo=github)](https://github.com/fixrb/test_tube/tags)
 [![Yard documentation](https://img.shields.io/badge/Yard-documentation-blue.svg?logo=github)](https://rubydoc.info/github/fixrb/test_tube/main)
-[![CI](https://github.com/fixrb/test_tube/workflows/CI/badge.svg?branch=main)](https://github.com/fixrb/test_tube/actions?query=workflow%3Aci+branch%3Amain)
+[![Ruby](https://github.com/fixrb/test_tube/workflows/Ruby/badge.svg?branch=main)](https://github.com/fixrb/test_tube/actions?query=workflow%3Aruby+branch%3Amain)
 [![RuboCop](https://github.com/fixrb/test_tube/workflows/RuboCop/badge.svg?branch=main)](https://github.com/fixrb/test_tube/actions?query=workflow%3Arubocop+branch%3Amain)
 [![License](https://img.shields.io/github/license/fixrb/test_tube?label=License&logo=github)](https://github.com/fixrb/test_tube/raw/main/LICENSE.md)
 
@@ -21,7 +21,7 @@ gem "test_tube"
 And then execute:
 
 ```sh
-bundle
+bundle install
 ```
 
 Or install it yourself as:
@@ -43,7 +43,7 @@ the Universe, and Everything with the following matcher:
 
 ```ruby
 class BeTheAnswer
-  def matches?
+  def match?
     42.equal?(yield)
   end
 end
@@ -54,7 +54,7 @@ One possibility would be to `invoke` a whole block of code:
 ```ruby
 block_of_code = -> { "101010".to_i(2) }
 
-experiment = TestTube.invoke(isolate: false, matcher: BeTheAnswer.new, negate: false, &block_of_code)
+experiment = TestTube.invoke(matcher: BeTheAnswer.new, negate: false, &block_of_code)
 # => <TestTube actual=42 error=nil got=true>
 
 experiment.actual # => 42
@@ -78,7 +78,7 @@ experiment.got    # => true
 ### __Matchi__ matchers
 
 To facilitate the addition of matchers, a collection is available via the
-[__Matchi__ project](https://github.com/fixrb/matchi/).
+[Matchi project](https://github.com/fixrb/matchi/).
 
 Let's use a built-in __Matchi__ matcher:
 
@@ -94,7 +94,6 @@ An example of successful experience:
 
 ```ruby
 experiment = TestTube.invoke(
-  isolate: false,
   matcher: Matchi::RaiseException.new(:NoMethodError),
   negate:  false
 ) { "foo".blank? }
@@ -109,7 +108,6 @@ Another example of an experiment that fails:
 
 ```ruby
 experiment = TestTube.invoke(
-  isolate: false,
   matcher: Matchi::Be.new(0.3),
   negate:  false,
   &-> { 0.1 + 0.2 }
@@ -124,7 +122,6 @@ Finally, an experiment which causes an error:
 
 ```ruby
 experiment = TestTube.invoke(
-  isolate: false,
   matcher: Matchi::Match.new(/^foo$/),
   negate:  false
 ) { BOOM }
@@ -135,45 +132,6 @@ experiment.error  # => #<NameError: uninitialized constant BOOM>
 experiment.got    # => nil
 ```
 
-### Code isolation
-
-When experimenting tests, side-effects may occur. Because they may or may not be
-desired, an `isolate` option is available.
-
-Let's for instance consider this block of code:
-
-```ruby
-greeting = "Hello, world!"
-block_of_code = -> { greeting.gsub!("world", "Alice") } # => #<Proc:0x00007f87f71b9690 (irb):42 (lambda)>
-```
-
-By setting the `isolate` option to `true`, we can experiment while avoiding
-side effects:
-
-```ruby
-experiment = TestTube.invoke(
-  isolate: true,
-  matcher: Matchi::Eq.new("Hello, Alice!"),
-  negate:  false,
-  &block_of_code
-) # => <TestTube actual="Hello, Alice!" error=nil got=true>
-
-greeting # => "Hello, world!"
-```
-
-Otherwise, we can experiment without any code isolation:
-
-```ruby
-experiment = TestTube.invoke(
-  isolate: false,
-  matcher: Matchi::Eq.new("Hello, Alice!"),
-  negate:  false,
-  &block_of_code
-) # => <TestTube actual="Hello, Alice!" error=nil got=true>
-
-greeting # => "Hello, Alice!"
-```
-
 ## Contact
 
 * Source code: https://github.com/fixrb/test_tube
@@ -188,11 +146,6 @@ __Test Tube__ follows [Semantic Versioning 2.0](https://semver.org/).
 
 The [gem](https://rubygems.org/gems/test_tube) is available as open source under the terms of the [MIT License](https://github.com/fixrb/test_tube/raw/main/LICENSE.md).
 
-***
+## Sponsors
 
-<p>
-  This project is sponsored by:<br />
-  <a href="https://sashite.com/"><img
-    src="https://github.com/fixrb/test_tube/raw/main/img/sashite.png"
-    alt="Sashite" /></a>
-</p>
+This project is sponsored by [Sashité](https://sashite.com/)

data/lib/test_tube/invoker.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "defi"
+require "defi/method"
 
 require_relative "base"
 
@@ -9,24 +9,18 @@ module TestTube
   #
   # @api private
   class Invoker < Base
-    # rubocop:disable Lint/RescueException, Metrics/MethodLength
+    # rubocop:disable Lint/RescueException
 
     # Class initializer.
     #
-    # @param isolate  [Boolean]   Compute in a subprocess.
-    # @param matcher  [#matches?] A matcher.
+    # @param matcher  [#match?]   A matcher.
     # @param negate   [Boolean]   Invert the matcher or not.
     # @param input    [Proc]      The callable object to test.
-    def initialize(isolate:, matcher:, negate:, &input)
+    def initialize(matcher:, negate:, &input)
       super()
 
-      @got = negate ^ matcher.matches? do
-        value = if isolate
-                  send_call.to!(input)
-                else
-                  send_call.to(input)
-                end
-
+      @got = negate ^ matcher.match? do
+        value = send_call.to(input)
         @actual = value.object
         value.call
       end
@@ -35,15 +29,15 @@ module TestTube
       @error  = e
     end
 
-    # rubocop:enable Lint/RescueException, Metrics/MethodLength
+    # rubocop:enable Lint/RescueException
 
     private
 
-    # @return [::Defi::Challenge] The challenge for the callable object.
+    # @return [::Defi::Method] The challenge for the callable object.
     #
-    # @see https://github.com/fixrb/defi/blob/v2.0.5/lib/defi/challenge.rb
+    # @see https://github.com/fixrb/defi/blob/v3.0.0/lib/defi/method.rb
     def send_call
-      ::Defi.send(:call)
+      ::Defi::Method.new(:call)
     end
   end
 end

data/lib/test_tube/passer.rb

@@ -10,13 +10,13 @@ module TestTube
     # Class initializer.
     #
     # @param input    [#object_id]  The actual value to test.
-    # @param matcher  [#matches?]   A matcher.
+    # @param matcher  [#match?]     A matcher.
     # @param negate   [Boolean]     Invert the matcher or not.
     def initialize(input, matcher:, negate:)
       super()
 
       @actual = input
-      @got = negate ^ matcher.matches? { input }
+      @got = negate ^ matcher.match? { input }
     end
   end
 end

data/lib/test_tube.rb

@@ -7,38 +7,37 @@ require_relative File.join("test_tube", "passer")
 #
 # @api public
 module TestTube
-  # @param isolate  [Boolean]   Compute in a subprocess.
-  # @param matcher  [#matches?] A matcher.
-  # @param negate   [Boolean]   Invert the matcher or not.
-  # @param input    [Proc]      The callable object to test.
+  # Invokes a block for testing.
+  #
+  # @see TestTube::Invoker#initialize for parameter details
   #
   # @example
   #   require "test_tube"
   #
   #   class BeTheAnswer
-  #     def matches?
+  #     def match?
   #       42.equal?(yield)
   #     end
   #   end
   #
-  #   TestTube.invoke(isolate: false, matcher: BeTheAnswer.new, negate: false) do
+  #   TestTube.invoke(matcher: BeTheAnswer.new, negate: false) do
   #     "101010".to_i(2)
   #   end
   #
-  # @return [Invoker] A software experiment.
-  def self.invoke(isolate:, matcher:, negate:, &input)
-    Invoker.new(isolate: isolate, matcher: matcher, negate: negate, &input)
+  # @return [TestTube::Invoker] A software experiment.
+  def self.invoke(...)
+    Invoker.new(...)
   end
 
-  # @param input    [#object_id]  The actual value to test.
-  # @param matcher  [#matches?]   A matcher.
-  # @param negate   [Boolean]     Invert the matcher or not.
+  # Tests a value directly.
+  #
+  # @see TestTube::Passer#initialize for parameter details
   #
   # @example
   #   require "test_tube"
   #
   #   class BeTheAnswer
-  #     def matches?
+  #     def match?
   #       42.equal?(yield)
   #     end
   #   end
@@ -48,8 +47,8 @@ module TestTube
   #     negate: false
   #   )
   #
-  # @return [Passer] A software experiment.
-  def self.pass(input, matcher:, negate:)
-    Passer.new(input, matcher: matcher, negate: negate)
+  # @return [TestTube::Passer] A software experiment.
+  def self.pass(...)
+    Passer.new(...)
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: test_tube
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 4.0.0
 platform: ruby
 authors:
 - Cyril Kato
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-04 00:00:00.000000000 Z
+date: 2024-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: defi
@@ -16,154 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.6
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.6
-- !ruby/object:Gem::Dependency
-  name: brutal
-  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: 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: matchi
-  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: 3.0.0
 description: "A test tube to conduct software experiments \U0001F9EA"
 email: contact@cyril.email
 executables: []
@@ -179,8 +38,8 @@ files:
 homepage: https://github.com/fixrb/test_tube
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -188,15 +47,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: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: "A test tube to conduct software experiments \U0001F9EA"
 test_files: []