test_tube 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b343e487d9f73eb0af9f0aeee5ba11c35cab9f644e7a106b3f8a259f3567d142
-  data.tar.gz: 9b28e9986b96cc1af7f1db0b9e98715364a4ff08579038d0a9663a67bd6dbf78
+  metadata.gz: 6aa09337dc5d35dd53da1f517ff92bced3b0d0c4f9c25eef1cd9287b63e14bbf
+  data.tar.gz: 36026bb1f5f3532e70ff51ebc25a1ddcf8c6098214c438e6a6fb6ad0305b249c
 SHA512:
-  metadata.gz: 3dd6be662939a33715130137e2ea9c6f5cebf95b9c33c18bf56457f2c08ac5e50e094c7e63eff045a1d7d9b4bfcee1db2652d43bcd1fc0a324e3ad99e3e1d17e
-  data.tar.gz: 9139defd6aa5d96e1d7b2dcfd676a60757b6bb496fb8ea071164e04c624de3e2d327bede1148e5fd793b5c39c57e7715e69f2982f8de6df9bfc95ed85b7b4c27
+  metadata.gz: 668493142591c985ece8e150691d7e60d6834b5da976361ff4c4aea34204b0c645aea61352424daf6964366014df424f881fd6b27fb416c581399395b9c7f8af
+  data.tar.gz: ea4ce58827e8643b54811082bee5861502d339daa4489ac69355fc06c172ca15f6c1129c6db2bbee171184d06211dba70cca56995302e18d176b3801e61e9f8f

data/README.md

@@ -58,12 +58,8 @@ of code:
 ```ruby
 block_of_code = -> { "101010".to_i(2) }
 
-experiment = TestTube.invoke(
-  isolation: false,
-  matcher:   BeTheAnswer.new,
-  negate:    false,
-  &block_of_code
-)
+experiment = TestTube.invoke(isolate: false, matcher: BeTheAnswer.new, negate: false, &block_of_code)
+# => <TestTube actual=42 error=nil got=true>
 
 experiment.actual # => 42
 experiment.error  # => nil
@@ -75,11 +71,8 @@ An alternative would be to `pass` directly the actual value as a parameter:
 ```ruby
 actual_value = "101010".to_i(2)
 
-experiment = TestTube.pass(
-  actual_value,
-  matcher: BeTheAnswer.new,
-  negate:  false
-)
+experiment = TestTube.pass(actual_value, matcher: BeTheAnswer.new, negate: false)
+# => <TestTube actual=42 error=nil got=true>
 
 experiment.actual # => 42
 experiment.error  # => nil
@@ -105,12 +98,11 @@ An example of successful experience:
 
 ```ruby
 experiment = TestTube.invoke(
-  isolation: false,
-  matcher:   Matchi::Matcher::RaiseException.new(NoMethodError),
-  negate:    false
-) do
-  "foo".blank?
-end
+  isolate: false,
+  matcher: Matchi::Matcher::RaiseException.new(NoMethodError),
+  negate:  false
+) { "foo".blank? }
+# => <TestTube actual=#<NoMethodError: undefined method `blank?' for "foo":String> error=nil got=true>
 
 experiment.actual # => #<NoMethodError: undefined method `blank?' for "foo":String>
 experiment.error  # => nil
@@ -121,11 +113,11 @@ Another example of an experiment that fails:
 
 ```ruby
 experiment = TestTube.invoke(
-  isolation: false,
-  matcher:   Matchi::Matcher::Equal.new(0.3),
-  negate:    false,
+  isolate: false,
+  matcher: Matchi::Matcher::Equal.new(0.3),
+  negate:  false,
   &-> { 0.1 + 0.2 }
-)
+) # => <TestTube actual=0.30000000000000004 error=nil got=false>
 
 experiment.actual # => 0.30000000000000004
 experiment.error  # => nil
@@ -136,10 +128,11 @@ Finally, an experiment which causes an error:
 
 ```ruby
 experiment = TestTube.invoke(
-  isolation: false,
-  matcher:   Matchi::Matcher::Match.new(/^foo$/),
-  negate:    false
+  isolate: false,
+  matcher: Matchi::Matcher::Match.new(/^foo$/),
+  negate:  false
 ) { BOOM }
+# => <TestTube actual=nil error=#<NameError: uninitialized constant BOOM> got=nil>
 
 experiment.actual # => nil
 experiment.error  # => #<NameError: uninitialized constant BOOM>
@@ -149,27 +142,25 @@ experiment.got    # => nil
 ### Code isolation
 
 When experimenting tests, side-effects may occur. Because they may or may not be
-desired, an `isolation` option is available.
+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") }
+block_of_code = -> { greeting.gsub!("world", "Alice") } # => #<Proc:0x00007f87f71b9690 (irb):42 (lambda)>
 ```
 
-By setting the `isolation` option to `true`, we can experiment while avoiding
+By setting the `isolate` option to `true`, we can experiment while avoiding
 side effects:
 
 ```ruby
 experiment = TestTube.invoke(
-  isolation: true,
-  matcher:   Matchi::Matcher::Eql.new("Hello, Alice!"),
-  negate:    false,
+  isolate: true,
+  matcher: Matchi::Matcher::Eql.new("Hello, Alice!"),
+  negate:  false,
   &block_of_code
-)
-
-experiment.inspect # => <TestTube actual="Hello, Alice!" error=nil got=true>
+) # => <TestTube actual="Hello, Alice!" error=nil got=true>
 
 greeting # => "Hello, world!"
 ```
@@ -178,13 +169,11 @@ Otherwise, we can experiment without any code isolation:
 
 ```ruby
 experiment = TestTube.invoke(
-  isolation: false,
-  matcher:   Matchi::Matcher::Eql.new("Hello, Alice!"),
-  negate:    false,
+  isolate: false,
+  matcher: Matchi::Matcher::Eql.new("Hello, Alice!"),
+  negate:  false,
   &block_of_code
-)
-
-experiment.inspect # => <TestTube actual="Hello, Alice!" error=nil got=true>
+) # => <TestTube actual="Hello, Alice!" error=nil got=true>
 
 greeting # => "Hello, Alice!"
 ```
@@ -192,6 +181,8 @@ greeting # => "Hello, Alice!"
 ## Contact
 
 * Source code: https://github.com/fixrb/test_tube
+* Chinese blog post: https://ruby-china.org/topics/41390
+* Japanese blog post: https://qiita.com/cyril/items/36174b619ff1852c80ec
 
 ## Versioning
 
@@ -199,7 +190,7 @@ __Test Tube__ follows [Semantic Versioning 2.0](https://semver.org/).
 
 ## License
 
-The [gem](https://rubygems.org/gems/test_tube) is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+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).
 
 ***
 

data/lib/test_tube.rb

@@ -7,10 +7,10 @@ require_relative File.join("test_tube", "passer")
 #
 # @api public
 module TestTube
-  # @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.
+  # @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.
   #
   # @example
   #   require "test_tube"
@@ -21,18 +21,18 @@ module TestTube
   #     end
   #   end
   #
-  #   TestTube.invoke(isolation: false, matcher: BeTheAnswer.new, negate: false) do
+  #   TestTube.invoke(isolate: false, matcher: BeTheAnswer.new, negate: false) do
   #     "101010".to_i(2)
   #   end
   #
   # @return [Invoker] A software experiment.
-  def self.invoke(isolation:, matcher:, negate:, &input)
-    Invoker.new(isolation: isolation, matcher: matcher, negate: negate, &input)
+  def self.invoke(isolate:, matcher:, negate:, &input)
+    Invoker.new(isolate: isolate, matcher: matcher, negate: negate, &input)
   end
 
-  # @param input      [#object_id]  The callable object to test.
-  # @param matcher    [#matches?]   A matcher.
-  # @param negate     [Boolean]     Invert the matcher or not.
+  # @param input    [#object_id]  The actual value to test.
+  # @param matcher  [#matches?]   A matcher.
+  # @param negate   [Boolean]     Invert the matcher or not.
   #
   # @example
   #   require "test_tube"

data/lib/test_tube/base.rb

@@ -8,21 +8,29 @@ module TestTube
     # Expectation's actual value.
     #
     # @return [#object_id] The actual value.
+    #
+    # @api public
     attr_reader :actual
 
     # Expectation's raised error.
     #
     # @return [Exception, nil] The raised error.
+    #
+    # @api public
     attr_reader :error
 
     # Expectation's returned boolean value.
     #
     # @return [Boolean, nil] The returned boolean value.
+    #
+    # @api public
     attr_reader :got
 
     # A string containing a human-readable representation of the experiment.
     #
     # @return [String] The human-readable representation of the experiment.
+    #
+    # @api public
     def inspect
       "<TestTube actual=#{actual.inspect} error=#{error.inspect} got=#{got.inspect}>"
     end

data/lib/test_tube/invoker.rb

@@ -13,15 +13,15 @@ module TestTube
     #
     # rubocop:disable Lint/RescueException, Metrics/MethodLength
     #
-    # @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.
-    def initialize(isolation:, matcher:, negate:, &input)
+    # @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.
+    def initialize(isolate:, matcher:, negate:, &input)
       super()
 
       @got = negate ^ matcher.matches? do
-        value = if isolation
+        value = if isolate
                   send_call.to!(input)
                 else
                   send_call.to(input)

data/lib/test_tube/passer.rb

@@ -9,7 +9,7 @@ module TestTube
   class Passer < Base
     # Class initializer.
     #
-    # @param input    [#object_id]  An actual value to test.
+    # @param input    [#object_id]  The actual value to test.
     # @param matcher  [#matches?]   A matcher.
     # @param negate   [Boolean]     Invert the matcher or not.
     def initialize(input, matcher:, negate:)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test_tube
 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-11 00:00:00.000000000 Z
+date: 2021-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: defi