r_spec 1.0.0.beta7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46557ee64f6cc554942399aa9219e9102879b2b7b113e53dc4ba63d2c0c5c0af
-  data.tar.gz: a83b773e20cf2db46b28586be6836d7913a4c3b8f9bf2ce747110f2556737374
+  metadata.gz: b251a708b0d9e2f0dcc8a17f7ef08cfeeafa6e553446e9a650431c9aaf7b6951
+  data.tar.gz: 528cbc2cd07397ba094a5f08703be53467ac04ee85c82f1cd1465e419f4c5c92
 SHA512:
-  metadata.gz: b7c89ce9b933e7adcfc26e03c2f4417ed44c423ca56932f173b2161572877967df37d99c9a560e8cf64c58458777842cb0db7eb1396c89a7f052d981b45f9864
-  data.tar.gz: 51c4b747116d8f1bb3bb2e593b00aa940ec463d1b9a03506984f2b445f3607febd455884051279f73cef2fc2edac7cfe6d9b4de210c1f1cef6402bd501729f6c
+  metadata.gz: 7132f226d0510929ec1a466c2c3e9a3c90a654efd399646476eb04b5fbdcad84254791eb270b83ca68e2c17ad06ca98581a79251714ae7032a9eb888f8716db2
+  data.tar.gz: 55d0b1f4e98feeca3c875c542529e1ea5a4f43093a30658f56670f380de23f7f5402e562fccfb85e69e234a066f06ec8600493fcdedd871d78183ea419d055f6

data/README.md

@@ -6,33 +6,32 @@ A minimalist __[RSpec](https://github.com/rspec/rspec) clone__ with all the esse
 
 ## Status
 
-[![Gem Version](https://badge.fury.io/rb/r_spec.svg)](https://badge.fury.io/rb/r_spec)
-[![Build Status](https://travis-ci.org/cyril/r_spec.rb.svg?branch=main)](https://travis-ci.org/cyril/r_spec.rb)
-[![Inline Docs](https://inch-ci.org/github/cyril/r_spec.rb.svg)](https://inch-ci.org/github/cyril/r_spec.rb)
-[![Documentation](https://img.shields.io/:yard-docs-38c800.svg)](https://rubydoc.info/gems/r_spec/frames)
+[![Version](https://img.shields.io/github/v/tag/cyril/r_spec.rb?include_prereleases&label=Version&logo=github&sort=semver)](https://github.com/cyril/r_spec.rb/releases)
+[![Yard documentation](https://img.shields.io/badge/Yard-documentation-blue.svg?)](https://rubydoc.info/github/cyril/r_spec.rb/main)
+[![CI](https://github.com/cyril/r_spec.rb/workflows/CI/badge.svg?branch=main)](https://github.com/cyril/r_spec.rb/actions?query=workflow%3Aci+branch%3Amain)
+[![RuboCop](https://github.com/cyril/r_spec.rb/workflows/RuboCop/badge.svg?branch=main)](https://github.com/cyril/r_spec.rb/actions?query=workflow%3Arubocop+branch%3Amain)
+[![License](https://img.shields.io/github/license/cyril/r_spec.rb?label=License&logo=github)](https://github.com/cyril/r_spec.rb/raw/main/LICENSE.md)
 
-## Project Goals
+## Project goals
 
 * Enforce the guidelines and best practices outlined in the community [RSpec style guide](https://rspec.rubystyle.guide/).
-* Provide most of RSpec's DSL to express expected outcomes of a code example without magic power.
+* Provide most of RSpec's DSL to express expected outcomes of a code example with no magical powers.
 
-## Some Differences
+## Some differences
 
 * Less features and an implementation with much less code complexity.
 * Spec files can also be executed directly with the `ruby` executable.
 * There is no option to activate monkey-patching.
 * It does not rely on hacks such as `at_exit` hook to trigger the tests.
-* Built-in matchers do not trust _actual_ and do not send it messages.
+* Built-in matchers [do not trust _actual_](https://asciinema.org/a/29172?autoplay=1&speed=2) and do not send it messages.
 * If no `subject` has been explicitly determined, none is defined.
 * If no described class is set, `described_class` is undefined instead of `nil`.
 * Expectations cannot be added inside a `before` block.
 * [Arbitrary helper methods](https://relishapp.com/rspec/rspec-core/v/3-10/docs/helper-methods/arbitrary-helper-methods) are not exposed to examples.
 * The `let` method defines a helper method rather than a memoized helper method.
 * The one-liner `is_expected` syntax also works with block expectations.
-* All `subject` definitions must come _before_ examples.
-* All `before` definitions must come _before_ examples.
-* All `after` definitions must come _before_ examples.
-* All `let` definitions must come _before_ examples.
+* `subject`, `before`, `after` and `let` definitions must come before examples.
+* Each [`context` runs its tests in _isolation_](https://asciinema.org/a/29070?autoplay=1&speed=2) to prevent side effects.
 
 ## Important ⚠️
 
@@ -51,7 +50,7 @@ Following [RubyGems naming conventions](https://guides.rubygems.org/name-your-ge
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "r_spec", ">= 1.0.0.beta7"
+gem "r_spec"
 ```
 
 And then execute:
@@ -63,7 +62,7 @@ bundle
 Or install it yourself as:
 
 ```sh
-gem install r_spec --pre
+gem install r_spec
 ```
 
 ## Overview
@@ -74,7 +73,7 @@ Inspired by [RSpec](https://rspec.info/), it includes a domain specific language
 
 A basic spec looks something like this:
 
-[![Super DRY example](https://asciinema.org/a/418672.svg)](https://asciinema.org/a/418672?autoplay=1)
+[![RSpec clone demo](https://asciinema.org/a/422210.svg)](https://asciinema.org/a/422210?autoplay=1&speed=2)
 
 ## Usage
 
@@ -105,7 +104,8 @@ For unit tests, it is recommended to follow the conventions for method names:
 * instance methods are prefixed with `#`, class methods with `.`.
 
 To establish certain contexts — think _empty array_ versus _array with elements_ — the `context` method may be used to communicate this to the reader.
-It has a different name, but behaves exactly like `describe`.
+Its behavior is slightly different from `describe` because each `context` runs its tests in isolation,
+so side effects caused by testing do not propagate out of contexts.
 
 `describe` and `context` take an optional description as argument and a block containing the individual specs or nested groupings.
 
@@ -224,31 +224,28 @@ task default: :test
 
 Benchmark against [100 executions of a file containing one expectation](https://github.com/cyril/r_spec.rb/blob/main/benchmark/) (lower is better).
 
-| Framework   | Seconds to complete |
-|-------------|---------------------|
-| `r_spec`    | 13.0                |
-| `rspec`     | 32.2                |
-| `minitest`  | 17.5                |
-| `test-unit` | 20.5                |
+![Runtime](https://r-spec.dev/benchmark-runtime.png)
 
-## Test Suite
+## Test suite
 
 __RSpec clone__'s specifications are self-described here: [spec/](https://github.com/cyril/r_spec.rb/blob/main/spec/)
 
 ## Contact
 
-* Home page: https://r-spec.dev
-* Source code: https://github.com/cyril/r_spec.rb
+* Home page: [https://r-spec.dev/](https://r-spec.dev/)
+* Cheatsheet: [https://r-spec.dev/cheatsheet.html](https://r-spec.dev/cheatsheet.html)
+* Source code: [https://github.com/cyril/r_spec.rb](https://github.com/cyril/r_spec.rb)
+* API Doc: [https://rubydoc.info/gems/r_spec](https://rubydoc.info/gems/r_spec)
 * Twitter: [https://twitter.com/cyri\_](https://twitter.com/cyri\_)
 
-## Special Thanks ❤️
+## Special thanks ❤️
 
 I would like to thank the whole [RSpec team](https://rspec.info/about/) for all their work.
 It's a great framework and it's a pleasure to work with every day.
 
 Without RSpec, this clone would not have been possible.
 
-## Buy me a Coffee ☕
+## Buy me a coffee ☕
 
 If you like this project please consider making a small donation.
 
@@ -260,4 +257,12 @@ __RSpec clone__ follows [Semantic Versioning 2.0](https://semver.org/).
 
 ## License
 
-The [gem](https://rubygems.org/gems/r_spec) is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The [gem](https://rubygems.org/gems/r_spec) is available as open source under the terms of the [MIT License](https://github.com/cyril/r_spec.rb/raw/main/LICENSE.md).
+
+## One more thing
+
+Under the hood, __RSpec clone__ is largely animated by [a collection of testing libraries designed to make programmers happy](https://github.com/fixrb/).
+
+It's a living example of what we can do combining small libraries together that can boost the fun of programming.
+
+![Fix testing tools logo for Ruby](https://github.com/cyril/r_spec.rb/raw/main/img/fixrb.svg)

data/lib/r_spec.rb

@@ -65,7 +65,46 @@ require_relative File.join("r_spec", "dsl")
 #
 # @api public
 module RSpec
-  # Specs are built with this method.
+  # Defines an example group that establishes a specific context, like _empty
+  # array_ versus _array with elements_.
+  #
+  # Unlike {.describe}, the block is evaluated in isolation in order to scope
+  # possible side effects inside its context.
+  #
+  # @example
+  #   require "r_spec"
+  #
+  #   RSpec.context "when divided by zero" do
+  #     subject { 42 / 0 }
+  #
+  #     it { is_expected.to raise_exception ZeroDivisionError }
+  #   end
+  #
+  #   # Output to the console
+  #   #   Success: divided by 0.
+  #
+  # @param description [String] A description that usually begins with "when",
+  #   "with" or "without".
+  # @param block [Proc] The block to define the specs.
+  #
+  # @api public
+  def self.context(description, &block)
+    Dsl.context(description, &block)
+  end
+
+  # Defines an example group that describes a unit to be tested.
+  #
+  # @example
+  #   require "r_spec"
+  #
+  #   RSpec.describe String do
+  #     describe "+" do
+  #       it("concats") { expect("foo" + "bar").to eq "foobar" }
+  #     end
+  #   end
+  #
+  #   # Output to the console
+  #   #   Success: expected to eq "foobar".
   #
   # @param const [Module, String] A module to include in block context.
   # @param block [Proc] The block to define the specs.
@@ -74,4 +113,58 @@ module RSpec
   def self.describe(const, &block)
     Dsl.describe(const, &block)
   end
+
+  # Defines a concrete test case.
+  #
+  # The test is performed by the block supplied to &block.
+  #
+  # @example The integer after 41
+  #   require "r_spec"
+  #
+  #   RSpec.it { expect(41.next).to be 42 }
+  #
+  #   # Output to the console
+  #   #   Success: expected to be 42.
+  #
+  # It is usually used inside a {Dsl.describe} or {Dsl.context} section.
+  #
+  # @param name [String, nil] The name of the spec.
+  # @param block [Proc] An expectation to evaluate.
+  #
+  # @raise (see RSpec::ExpectationTarget::Base#result)
+  # @return (see RSpec::ExpectationTarget::Base#result)
+  #
+  # @api public
+  def self.it(name = nil, &block)
+    Dsl.it(name, &block)
+  end
+
+  # Defines a pending test case.
+  #
+  # `&block` is never evaluated. It can be used to describe behaviour that is
+  # not yet implemented.
+  #
+  # @example
+  #   require "r_spec"
+  #
+  #   RSpec.pending "is implemented but waiting" do
+  #     expect something to be finished
+  #   end
+  #
+  #   RSpec.pending "is not yet implemented and waiting"
+  #
+  #   # Output to the console
+  #   #   Warning: is implemented but waiting.
+  #   #   Warning: is not yet implemented and waiting.
+  #
+  # It is usually used inside a {Dsl.describe} or {Dsl.context} section.
+  #
+  # @param message [String] The reason why the example is pending.
+  #
+  # @return [nil] Write a message to STDOUT.
+  #
+  # @api public
+  def self.pending(message)
+    Dsl.pending(message)
+  end
 end

data/lib/r_spec/dsl.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "aw"
+
 require_relative "console"
 require_relative "error"
 require_relative "expectation_helper"
@@ -155,7 +157,8 @@ module RSpec
     # Defines an example group that establishes a specific context, like _empty
     # array_ versus _array with elements_.
     #
-    # It is functionally equivalent to {.describe}.
+    # Unlike {.describe}, the block is evaluated in isolation in order to scope
+    # possible side effects inside its context.
     #
     # @example
     #   require "r_spec"
@@ -177,9 +180,9 @@ module RSpec
     # @param _description [String] A description that usually begins with
     #   "when", "with" or "without".
     # @param block [Proc] The block to define the specs.
-    def self.context(_description = nil, &block)
+    def self.context(_description, &block)
       desc = ::Class.new(self)
-      desc.instance_eval(&block)
+      ::Aw.fork! { desc.instance_eval(&block) }
     end
 
     # Defines a concrete test case.
@@ -230,7 +233,7 @@ module RSpec
 
       exit false
     ensure
-      example.send(AFTER_METHOD)
+      example&.send(AFTER_METHOD)
     end
 
     # Use the {.its} method to define a single spec that specifies the actual
@@ -295,7 +298,7 @@ module RSpec
 
       exit false
     ensure
-      example.send(AFTER_METHOD)
+      example&.send(AFTER_METHOD)
     end
 
     # Defines a pending test case.

data/lib/r_spec/error/pending_expectation.rb

@@ -19,8 +19,7 @@ module RSpec
           got:      false,
           matcher:  :raise_exception,
           negate:   true,
-          level:    :SHOULD,
-          valid:    false
+          level:    :SHOULD
         )
       end
     end

data/lib/r_spec/expectation_target/base.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "expresenter"
+require "test_tube"
 
 require_relative File.join("..", "console")
 
@@ -50,12 +51,12 @@ module RSpec
 
       protected
 
+      # @param passed   [Boolean]         The high expectation passed or failed.
       # @param actual   [#object_id]      The actual value.
       # @param error    [Exception, nil]  Any raised exception.
       # @param got      [Boolean, nil]    Any returned value.
       # @param matcher  [#matches?]       The matcher.
       # @param negate   [Boolean]         The assertion is positive or negative.
-      # @param valid    [Boolean]         The result of an expectation.
       #
       # @return [nil] Write a message to STDOUT.
       #
@@ -63,14 +64,13 @@ module RSpec
       #   `Kernel.exit(false)` with a failure message written to STDERR.
       #
       # @api private
-      def result(actual:, error:, got:, matcher:, negate:, valid:)
-        Console.passed_spec ::Expresenter.call(valid).with(
+      def result(passed, actual:, error:, got:, matcher:, negate:)
+        Console.passed_spec ::Expresenter.call(passed).with(
           actual:   actual,
           error:    error,
           expected: matcher.expected,
           got:      got,
           negate:   negate,
-          valid:    valid,
           matcher:  matcher.class.to_sym,
           level:    :MUST
         )

data/lib/r_spec/expectation_target/block.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "spectus/exam"
-
 require_relative "base"
 
 module RSpec
@@ -30,20 +28,20 @@ module RSpec
       # @raise [SystemExit] Terminate execution immediately by calling
       #   `Kernel.exit(false)` with a failure message written to STDERR.
       def absolute_requirement(matcher:, negate:)
-        exam = ::Spectus::Exam.new(
-          callable:  @actual,
+        experiment = ::TestTube.invoke(
+          @actual,
           isolation: false,
-          negate:    negate,
-          matcher:   matcher
+          matcher:   matcher,
+          negate:    negate
         )
 
         result(
-          actual:  exam.actual,
-          error:   exam.exception,
-          got:     exam.got,
+          experiment.got.equal?(true),
+          actual:  experiment.actual,
+          error:   experiment.error,
+          got:     experiment.got,
           matcher: matcher,
-          negate:  negate,
-          valid:   exam.valid?
+          negate:  negate
         )
       end
     end

data/lib/r_spec/expectation_target/value.rb

@@ -28,15 +28,19 @@ module RSpec
       # @raise [SystemExit] Terminate execution immediately by calling
       #   `Kernel.exit(false)` with a failure message written to STDERR.
       def absolute_requirement(matcher:, negate:)
-        valid = negate ^ matcher.matches? { @actual }
+        experiment = ::TestTube.pass(
+          @actual,
+          matcher: matcher,
+          negate:  negate
+        )
 
         result(
-          actual:  @actual,
-          error:   nil,
-          got:     valid,
+          experiment.got.equal?(true),
+          actual:  experiment.actual,
+          error:   experiment.error,
+          got:     experiment.got,
           matcher: matcher,
-          negate:  negate,
-          valid:   valid
+          negate:  negate
         )
       end
     end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: r_spec
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta7
+  version: 1.0.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-16 00:00:00.000000000 Z
+date: 2021-06-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: aw
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.12
 - !ruby/object:Gem::Dependency
   name: expresenter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: matchi-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -39,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.1.2
 - !ruby/object:Gem::Dependency
-  name: spectus
+  name: test_tube
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.4
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.4
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -221,9 +235,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: