test_tube 1.0.0.beta0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e928758abf1d784bdf93e7d9128f3fc69a48bdcf532769a9f5250a0a09338ac
-  data.tar.gz: ba835fe5031d9af8fc124f6cb012008923d3080a8de953a0a31c348f693102cd
+  metadata.gz: ed96729c5b8c3a0ccef89cc6739da3e46e54c70eaf3e0975ca7af8d74db23d26
+  data.tar.gz: b534c7cb0d0e5de7ce02c328b1be76960214ec4e6a4d45b031fafb1d9ffac136
 SHA512:
-  metadata.gz: 132fe5f45b2b7317667e868aed913d856caa86fa302a6f954ef3a5ca7c11ac0c8047125df550196999208340f731cb4fc1d296974b465e6bad66afe4c4c2c37f
-  data.tar.gz: e2d7535593db0618488764c7d1d42ec6902f75912c79f2bd010c7f627722d9ff5c3fb8b8e70ef30a5b6a807a104b65ff0c688dea4c76e8b8f856afb3f002bfab
+  metadata.gz: 48ac22dc6ada96e416df896a7c6e4bf7242e2391ce3788c28b2a2aeaa2ee93a18ed5f690be51dc0a434c97a8185c112a796cb7f0985dabe90eb39b33f8b4fee9
+  data.tar.gz: 5a508032716cd4836009b9ac4b2b1fcdfa07e7b579fbfae771563bdebb81cf6e68efa2a7edbe897f8162015c8e45c0ba46346785026867f227cae14da4c398ca

data/README.md

@@ -28,8 +28,8 @@ gem install test_tube
 
 ## Usage
 
-Let's experiment the answer to the Ultimate Question of Life, the Universe, and
-Everything:
+Assuming we'd like to experiment on the answer to the Ultimate Question of Life,
+the Universe, and Everything with the following matcher:
 
 ```ruby
 class BeTheAnswer
@@ -37,8 +37,12 @@ class BeTheAnswer
     42.equal?(yield)
   end
 end
+```
+
+One possibility would be to challenge a whole block of code:
 
-tt = TestTube.content(
+```ruby
+tt = TestTube.invoke(
   -> { "101010".to_i(2) },
   isolation: false,
   matcher:   BeTheAnswer.new,
@@ -51,6 +55,21 @@ tt.error  # => nil
 tt.got    # => true
 ```
 
+An alternative would be to challenge a value passed as a parameter:
+
+```ruby
+tt = TestTube.pass(
+  "101010".to_i(2),
+  matcher: BeTheAnswer.new,
+  negate:  false
+)
+# => #<TestTube::Passer:0x00007f85c229c2d8 @actual=42, @got=true>
+
+tt.actual # => 42
+tt.error  # => nil
+tt.got    # => true
+```
+
 ## Contact
 
 * Source code: https://github.com/fixrb/test_tube

data/lib/test_tube.rb

@@ -1,26 +1,41 @@
 # frozen_string_literal: true
 
-require_relative File.join("test_tube", "content")
-require_relative File.join("test_tube", "liquid")
+require_relative File.join("test_tube", "invoker")
+require_relative File.join("test_tube", "passer")
 
 # Namespace for the TestTube library.
 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      [#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.
   #
-  # @return [Content] A software experiment.
-  def self.content(input, isolation:, matcher:, negate:)
-    Content.new(input, isolation: isolation, matcher: matcher, negate: negate)
+  # @example
+  #   invoke(
+  #     -> { "101010".to_i(2) },
+  #     isolation: false,
+  #     matcher:   BeTheAnswer.new,
+  #     negate:    false
+  #   )
+  #
+  # @return [Invoker] A software experiment.
+  def self.invoke(input, isolation:, matcher:, negate:)
+    Invoker.new(input, isolation: isolation, matcher: matcher, negate: negate)
   end
 
-  # @param input      [#call]     The callable object to test.
-  # @param matcher    [#matches?] A matcher.
-  # @param negate     [Boolean]   Invert the matcher or not.
+  # @param input      [#object_id]  The callable object to test.
+  # @param matcher    [#matches?]   A matcher.
+  # @param negate     [Boolean]     Invert the matcher or not.
+  #
+  # @example
+  #   pass(
+  #     "101010".to_i(2),
+  #     matcher:   BeTheAnswer.new,
+  #     negate:    false
+  #   )
   #
-  # @return [Content] A software experiment.
-  def self.liquid(input, matcher:, negate:)
-    Liquid.new(input, matcher: matcher, negate: negate)
+  # @return [Passer] A software experiment.
+  def self.pass(input, matcher:, negate:)
+    Passer.new(input, matcher: matcher, negate: negate)
   end
 end

data/lib/test_tube/base.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module TestTube
-  # The liquid class is great for values.
+  # The base class.
   class Base
     # @return [#object_id] The actual value.
     attr_reader :actual

data/lib/test_tube/{content.rb → invoker.rb}

@@ -5,8 +5,8 @@ require "defi"
 require_relative "base"
 
 module TestTube
-  # The content class is great for blocks.
-  class Content < Base
+  # The invoker class is great for blocks.
+  class Invoker < Base
     # Software experiments.
     #
     # rubocop:disable Lint/RescueException, Metrics/MethodLength

data/lib/test_tube/{liquid.rb → passer.rb}

@@ -3,8 +3,8 @@
 require_relative "base"
 
 module TestTube
-  # The liquid class is great for values.
-  class Liquid < Base
+  # The passer class is great for values.
+  class Passer < Base
     # Software experiments.
     #
     # @param input    [#object_id]  An actual value to test.
@@ -14,7 +14,7 @@ module TestTube
       super()
 
       @actual = input
-      @got = negate ^ matcher.matches? { @actual }
+      @got = negate ^ matcher.matches? { input }
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test_tube
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta0
+  version: 1.0.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-18 00:00:00.000000000 Z
+date: 2021-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: defi
@@ -160,8 +160,8 @@ files:
 - README.md
 - lib/test_tube.rb
 - lib/test_tube/base.rb
-- lib/test_tube/content.rb
-- lib/test_tube/liquid.rb
+- lib/test_tube/invoker.rb
+- lib/test_tube/passer.rb
 homepage: https://github.com/fixrb/test_tube
 licenses:
 - MIT
@@ -177,9 +177,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.6
 signing_key: