test_tube 1.0.0.beta0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3e928758abf1d784bdf93e7d9128f3fc69a48bdcf532769a9f5250a0a09338ac
+  data.tar.gz: ba835fe5031d9af8fc124f6cb012008923d3080a8de953a0a31c348f693102cd
+SHA512:
+  metadata.gz: 132fe5f45b2b7317667e868aed913d856caa86fa302a6f954ef3a5ca7c11ac0c8047125df550196999208340f731cb4fc1d296974b465e6bad66afe4c4c2c37f
+  data.tar.gz: e2d7535593db0618488764c7d1d42ec6902f75912c79f2bd010c7f627722d9ff5c3fb8b8e70ef30a5b6a807a104b65ff0c688dea4c76e8b8f856afb3f002bfab

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+# 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)
+
+> A test tube to conduct software experiments 🧪
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "test_tube"
+```
+
+And then execute:
+
+```sh
+bundle
+```
+
+Or install it yourself as:
+
+```sh
+gem install test_tube
+```
+
+## Usage
+
+Let's experiment the answer to the Ultimate Question of Life, the Universe, and
+Everything:
+
+```ruby
+class BeTheAnswer
+  def matches?
+    42.equal?(yield)
+  end
+end
+
+tt = TestTube.content(
+  -> { "101010".to_i(2) },
+  isolation: false,
+  matcher:   BeTheAnswer.new,
+  negate:    false
+)
+# => #<TestTube::Content:0x00007fb3b328b248 @actual=42, @got=true, @error=nil>
+
+tt.actual # => 42
+tt.error  # => nil
+tt.got    # => true
+```
+
+## Contact
+
+* Source code: https://github.com/fixrb/test_tube
+
+## Versioning
+
+__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).
+
+***
+
+<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>

data/lib/test_tube.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative File.join("test_tube", "content")
+require_relative File.join("test_tube", "liquid")
+
+# 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.
+  #
+  # @return [Content] A software experiment.
+  def self.content(input, isolation:, matcher:, negate:)
+    Content.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.
+  #
+  # @return [Content] A software experiment.
+  def self.liquid(input, matcher:, negate:)
+    Liquid.new(input, matcher: matcher, negate: negate)
+  end
+end

data/lib/test_tube/base.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module TestTube
+  # The liquid class is great for values.
+  class Base
+    # @return [#object_id] The actual value.
+    attr_reader :actual
+
+    # @return [Exception, nil] The raised exception.
+    attr_reader :error
+
+    # @return [Boolean, nil] The test result.
+    attr_reader :got
+  end
+end

data/lib/test_tube/content.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "defi"
+
+require_relative "base"
+
+module TestTube
+  # The content class is great for blocks.
+  class Content < Base
+    # Software experiments.
+    #
+    # 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:)
+      super()
+
+      @got = negate ^ matcher.matches? do
+        value = if isolation
+                  send_call.to!(input)
+                else
+                  send_call.to(input)
+                end
+
+        @actual = value.object
+        value.call
+      end
+    rescue ::Exception => e
+      @actual = nil
+      @error  = e
+    end
+    # rubocop:enable Lint/RescueException, Metrics/MethodLength
+
+    private
+
+    # @return [::Defi::Challenge] The challenge for the callable object.
+    #
+    # @see https://github.com/fixrb/defi/blob/v2.0.5/lib/defi/challenge.rb
+    def send_call
+      ::Defi.send(:call)
+    end
+  end
+end

data/lib/test_tube/liquid.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module TestTube
+  # The liquid class is great for values.
+  class Liquid < Base
+    # Software experiments.
+    #
+    # @param input    [#object_id]  An actual value to test.
+    # @param matcher  [#matches?]   A matcher.
+    # @param negate   [Boolean]     Invert the matcher or not.
+    def initialize(input, matcher:, negate:)
+      super()
+
+      @actual = input
+      @got = negate ^ matcher.matches? { @actual }
+    end
+  end
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: test_tube
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta0
+platform: ruby
+authors:
+- Cyril Kato
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: defi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+- !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: 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'
+description: "A test tube to conduct software experiments \U0001F9EA"
+email: contact@cyril.email
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/test_tube.rb
+- lib/test_tube/base.rb
+- lib/test_tube/content.rb
+- lib/test_tube/liquid.rb
+homepage: https://github.com/fixrb/test_tube
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: "A test tube to conduct software experiments \U0001F9EA"
+test_files: []