test_tube 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1c0e61708e5bd5a64d8c57b429c1dcdb74c35003fb2717aeb09777c10b58ed4
-  data.tar.gz: 99e9ee9069e4b5a3124fb42566eaf9bed7cce5328335ba8ef0abc96b285f9715
+  metadata.gz: b343e487d9f73eb0af9f0aeee5ba11c35cab9f644e7a106b3f8a259f3567d142
+  data.tar.gz: 9b28e9986b96cc1af7f1db0b9e98715364a4ff08579038d0a9663a67bd6dbf78
 SHA512:
-  metadata.gz: 3e30d9ccb6fc2186e61d6f3278da6db17568fe8144fe3008af9a1523a579eeb345246e4f5bc6675fe9d4ba3090890ef400c535f69f0fd3ba0f909f8511d17545
-  data.tar.gz: c58676b8830b438bfde6fc83a12cf8c110e0049da7b7b63385742628e304bce385bfcbed2303d21abb26bc7b76c647394caf0d6a41679bd5e3939e762b0aa83a
+  metadata.gz: 3dd6be662939a33715130137e2ea9c6f5cebf95b9c33c18bf56457f2c08ac5e50e094c7e63eff045a1d7d9b4bfcee1db2652d43bcd1fc0a324e3ad99e3e1d17e
+  data.tar.gz: 9139defd6aa5d96e1d7b2dcfd676a60757b6bb496fb8ea071164e04c624de3e2d327bede1148e5fd793b5c39c57e7715e69f2982f8de6df9bfc95ed85b7b4c27

data/README.md

@@ -1,8 +1,10 @@
 # Test Tube
 
-[![Build Status](https://api.travis-ci.org/fixrb/test_tube.svg?branch=main)](https://travis-ci.org/fixrb/test_tube)
-[![Gem Version](https://badge.fury.io/rb/test_tube.svg)](https://rubygems.org/gems/test_tube)
-[![Documentation](https://img.shields.io/:yard-docs-38c800.svg)](https://rubydoc.info/gems/test_tube)
+[![Version](https://img.shields.io/github/v/tag/fixrb/test_tube?label=Version&logo=github)](https://github.com/fixrb/test_tube/releases)
+[![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)
+[![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)
 
 > A test tube to conduct software experiments 🧪
 
@@ -57,10 +59,10 @@ of code:
 block_of_code = -> { "101010".to_i(2) }
 
 experiment = TestTube.invoke(
-  block_of_code,
   isolation: false,
   matcher:   BeTheAnswer.new,
-  negate:    false
+  negate:    false,
+  &block_of_code
 )
 
 experiment.actual # => 42
@@ -85,6 +87,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/).
 
@@ -102,11 +105,12 @@ An example of successful experience:
 
 ```ruby
 experiment = TestTube.invoke(
-  -> { "foo".blank? },
   isolation: false,
   matcher:   Matchi::Matcher::RaiseException.new(NoMethodError),
   negate:    false
-)
+) do
+  "foo".blank?
+end
 
 experiment.actual # => #<NoMethodError: undefined method `blank?' for "foo":String>
 experiment.error  # => nil
@@ -117,10 +121,10 @@ Another example of an experiment that fails:
 
 ```ruby
 experiment = TestTube.invoke(
-  -> { 0.1 + 0.2 },
   isolation: false,
   matcher:   Matchi::Matcher::Equal.new(0.3),
-  negate:    false
+  negate:    false,
+  &-> { 0.1 + 0.2 }
 )
 
 experiment.actual # => 0.30000000000000004
@@ -132,11 +136,10 @@ Finally, an experiment which causes an error:
 
 ```ruby
 experiment = TestTube.invoke(
-  -> { BOOM },
   isolation: false,
   matcher:   Matchi::Matcher::Match.new(/^foo$/),
   negate:    false
-)
+) { BOOM }
 
 experiment.actual # => nil
 experiment.error  # => #<NameError: uninitialized constant BOOM>
@@ -160,10 +163,10 @@ side effects:
 
 ```ruby
 experiment = TestTube.invoke(
-  block_of_code,
   isolation: true,
   matcher:   Matchi::Matcher::Eql.new("Hello, Alice!"),
-  negate:    false
+  negate:    false,
+  &block_of_code
 )
 
 experiment.inspect # => <TestTube actual="Hello, Alice!" error=nil got=true>
@@ -175,10 +178,10 @@ Otherwise, we can experiment without any code isolation:
 
 ```ruby
 experiment = TestTube.invoke(
-  block_of_code,
   isolation: false,
   matcher:   Matchi::Matcher::Eql.new("Hello, Alice!"),
-  negate:    false
+  negate:    false,
+  &block_of_code
 )
 
 experiment.inspect # => <TestTube actual="Hello, Alice!" error=nil got=true>

data/lib/test_tube.rb

@@ -4,11 +4,13 @@ require_relative File.join("test_tube", "invoker")
 require_relative File.join("test_tube", "passer")
 
 # Namespace for the TestTube library.
+#
+# @api public
 module TestTube
-  # @param input      [#call]       The callable object to test.
   # @param isolation  [Boolean]     Compute in isolation or not.
   # @param matcher    [#matches?]   A matcher.
   # @param negate     [Boolean]     Invert the matcher or not.
+  # @param input      [Proc]        The callable object to test.
   #
   # @example
   #   require "test_tube"
@@ -19,16 +21,13 @@ module TestTube
   #     end
   #   end
   #
-  #   TestTube.invoke(
-  #     -> { "101010".to_i(2) },
-  #     isolation: false,
-  #     matcher:   BeTheAnswer.new,
-  #     negate:    false
-  #   )
+  #   TestTube.invoke(isolation: false, matcher: BeTheAnswer.new, negate: false) do
+  #     "101010".to_i(2)
+  #   end
   #
   # @return [Invoker] A software experiment.
-  def self.invoke(input, isolation:, matcher:, negate:)
-    Invoker.new(input, isolation: isolation, matcher: matcher, negate: negate)
+  def self.invoke(isolation:, matcher:, negate:, &input)
+    Invoker.new(isolation: isolation, matcher: matcher, negate: negate, &input)
   end
 
   # @param input      [#object_id]  The callable object to test.
@@ -44,10 +43,9 @@ module TestTube
   #     end
   #   end
   #
-  #   TestTube.pass(
-  #     "101010".to_i(2),
-  #     matcher:   BeTheAnswer.new,
-  #     negate:    false
+  #   TestTube.pass("101010".to_i(2),
+  #     matcher: BeTheAnswer.new,
+  #     negate: false
   #   )
   #
   # @return [Passer] A software experiment.

data/lib/test_tube/base.rb

@@ -2,6 +2,8 @@
 
 module TestTube
   # Abstract class representing the state of an experiment.
+  #
+  # @api private
   class Base
     # Expectation's actual value.
     #

data/lib/test_tube/invoker.rb

@@ -6,16 +6,18 @@ require_relative "base"
 
 module TestTube
   # Evaluate an actual value invoking it with #call method.
+  #
+  # @api private
   class Invoker < Base
     # Class initializer.
     #
     # rubocop:disable Lint/RescueException, Metrics/MethodLength
     #
-    # @param input      [#call]     The callable object to test.
     # @param isolation  [Boolean]   Compute in isolation or not.
     # @param matcher    [#matches?] A matcher.
     # @param negate     [Boolean]   Invert the matcher or not.
-    def initialize(input, isolation:, matcher:, negate:)
+    # @param input      [Proc]      The callable object to test.
+    def initialize(isolation:, matcher:, negate:, &input)
       super()
 
       @got = negate ^ matcher.matches? do

data/lib/test_tube/passer.rb

@@ -4,6 +4,8 @@ require_relative "base"
 
 module TestTube
   # Evaluate an actual value passed in parameter.
+  #
+  # @api private
   class Passer < Base
     # Class initializer.
     #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test_tube
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-20 00:00:00.000000000 Z
+date: 2021-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: defi