r_spec 1.0.0.beta4 → 1.0.0.beta9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d94ad6d7ba01dc04c4bcbe727543524f6a3d83cf69549a34453c1eefc5282e9
-  data.tar.gz: 61b3ebe1299e69d7ef1f2c180325e85e1bda05e2347176ae507fc7430cf311ca
+  metadata.gz: 6599635e0de35bec4d9bae9f58ab1417a364eb2a0bd64db49b523be4d9ab1d16
+  data.tar.gz: 658671a666d8173ce075558dc7dc0f5604e2a98f86e0448485c2ad713ec518be
 SHA512:
-  metadata.gz: 5d44ce99f58c17711be4b3f76cdfaf3c9923d031aa9a7d214db50b990825673b9bb485ce095195594fbeb45977763dc5a0be31770f089cd17dcb1e3ef1d6885b
-  data.tar.gz: ca64a27f7cf4032b6b073b9fc2eb05aa37654c02a58289c41094e9afa000deccc3886d03d2043642a02e38cf10b6cc0fbd775e7ef9bc1c29cb592b813dcf5d04
+  metadata.gz: 45babe5acbed804ce1a61476c39028cdaa46256c343b0b6001b83e0bd5cda35a83770bd06776c7b76d22cb0dd3cbc07be7978d30d99c04cc1585e9cdeb933778
+  data.tar.gz: 78f72312fc8c2ad764647a1e6698f4a094bfc3129c0b2911f809502ba9a11d9a0da88ffafc2420c68d55fdaeeb8062258e8ff738013bded1bcf1970f536f192d

data/README.md

@@ -2,18 +2,18 @@
 
 A minimalist __[RSpec](https://github.com/rspec/rspec) clone__ with all the essentials.
 
-![What did you RSpec?](https://github.com/cyril/r_spec.rb/raw/main/img/what-did-you-rspec.svg)
+![What did you RSpec?](https://github.com/cyril/r_spec.rb/raw/main/img/what-did-you-rspec.jpg)
 
 ## 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)
 
-## Goal
+## Project goals
 
-This clone attempts to provide most of RSpec's DSL to express expected outcomes of a code example without magic power.
+* 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.
 
 ## Some differences
 
@@ -22,11 +22,13 @@ This clone attempts to provide most of RSpec's DSL to express expected outcomes
 * 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.
-* The `subject` must be explicitly defined, otherwise it is not implemented.
+* 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.
+* `subject`, `before`, `after` and `let` definitions must come before examples.
 
 ## Important ⚠️
 
@@ -45,7 +47,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.beta4"
+gem "r_spec", ">= 1.0.0.beta9"
 ```
 
 And then execute:
@@ -80,16 +82,15 @@ Many projects use a custom spec helper which organizes these includes.
 Concrete test cases are defined in `it` blocks.
 An optional descriptive string states it's purpose and a block contains the main logic performing the test.
 
+Test cases that have been defined or outlined but are not yet expected to work can be defined using `pending` instead of `it`. They will not be run but show up in the spec report as pending.
+
 An `it` block contains an example that should invoke the code to be tested and define what is expected of it.
 Each example can contain multiple expectations, but it should test only one specific behaviour.
 
-To express an expectation, wrap an object or block in `expect`, call `to` or `not_to` and pass it a matcher object.
-
+To express an expectation, wrap an object or block in `expect`, call `to` (or `not_to`) and pass it a matcher object.
 If the expectation is met, code execution continues.
 Otherwise the example has _failed_ and other code will not be executed.
 
-Test cases that have been defined or outlined but are not yet expected to work can be defined using `pending` instead of `expect`. They will not be run but show up in the spec report as pending.
-
 In test files, specs are structured by example groups which are defined by `describe` and `context` sections.
 Typically a top level `describe` defines the outer unit (such as a class) to be tested by the spec.
 Further `describe` sections can be nested within the outer unit to specify smaller units under test (such as individual methods).
@@ -99,7 +100,7 @@ For unit tests, it is recommended to follow the conventions for method names:
 * outer `describe` is the name of the class, inner `describe` targets methods;
 * 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.
+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`.
 
 `describe` and `context` take an optional description as argument and a block containing the individual specs or nested groupings.
@@ -213,6 +214,19 @@ task spec: :test
 task default: :test
 ```
 
+## Performance
+
+### Runtime
+
+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                |
+
 ## Test suite
 
 __RSpec clone__'s specifications are self-described here: [spec/](https://github.com/cyril/r_spec.rb/blob/main/spec/)
@@ -223,16 +237,22 @@ __RSpec clone__'s specifications are self-described here: [spec/](https://github
 * Source code: https://github.com/cyril/r_spec.rb
 * Twitter: [https://twitter.com/cyri\_](https://twitter.com/cyri\_)
 
-## Versioning
-
-__RSpec clone__ follows [Semantic Versioning 2.0](https://semver.org/).
-
-## 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. ❤️
+Without RSpec, this clone would not have been possible.
+
+## Buy me a coffee ☕
+
+If you like this project please consider making a small donation.
+
+[![Donate with Ethereum](https://github.com/cyril/r_spec.rb/raw/main/img/donate-eth.svg)](https://etherscan.io/address/0x834b5c1feaff5aebf9cd0f25dc38e741d65ab773)
+
+## Versioning
+
+__RSpec clone__ follows [Semantic Versioning 2.0](https://semver.org/).
 
 ## License
 

data/lib/r_spec.rb

@@ -1,14 +1,19 @@
 # frozen_string_literal: true
 
+require_relative File.join("r_spec", "dsl")
+
 # Top level namespace for the RSpec clone.
 #
 # @example The true from the false
 #   require "r_spec"
 #
-#   RSpec.describe do
+#   RSpec.describe "The true from the false" do
 #     it { expect(false).not_to be true }
 #   end
 #
+#   # Output to the console
+#   #   Success: expected false not to be true.
+#
 # @example The basic behavior of arrays
 #   require "r_spec"
 #
@@ -30,6 +35,11 @@
 #     end
 #   end
 #
+#   # Output to the console
+#   #   Success: expected to eq 3.
+#   #   Success: expected true to be true.
+#   #   Success: expected false to be false.
+#
 # @example An inherited definition of let
 #   require "r_spec"
 #
@@ -49,6 +59,10 @@
 #     end
 #   end
 #
+#   # Output to the console
+#   #   Success: expected to be 42.
+#   #   Success: expected to be 43.
+#
 # @api public
 module RSpec
   # Specs are built with this method.
@@ -57,9 +71,7 @@ module RSpec
   # @param block [Proc] The block to define the specs.
   #
   # @api public
-  def self.describe(const = nil, &block)
+  def self.describe(const, &block)
     Dsl.describe(const, &block)
   end
 end
-
-require_relative File.join("r_spec", "dsl")

data/lib/r_spec/console.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module RSpec
+  # Send log messages to the console.
+  #
+  # @api private
+  module Console
+    # @param report [::Expresenter::Pass] Passed expectation result presenter.
+    #
+    # @see https://github.com/fixrb/expresenter
+    #
+    # @return [nil] Add a colored message to `$stdout`.
+    def self.passed_spec(report)
+      puts report.colored_string
+    end
+
+    # @param report [::Expresenter::Fail] Failed expectation result presenter.
+    #
+    # @see https://github.com/fixrb/expresenter
+    #
+    # @raise [SystemExit] Terminate execution immediately with colored message.
+    def self.failed_spec(report)
+      abort report.colored_string
+    end
+
+    # The Ruby source filename and line number containing this method or nil if
+    # this method was not defined in Ruby (i.e. native).
+    #
+    # @param filename [String, nil] The Ruby source filename.
+    # @param line     [Integer, nil] The Ruby source line number.
+    #
+    # @return [String] The Ruby source filename and line number associated with
+    #   the evaluated spec.
+    def self.source(filename, line)
+      puts [filename, line].compact.join(":")
+    end
+  end
+end

data/lib/r_spec/dsl.rb

@@ -1,78 +1,243 @@
 # frozen_string_literal: true
 
-require "securerandom"
+require_relative "console"
+require_relative "error"
+require_relative "expectation_helper"
 
 module RSpec
   # Abstract class for handling the domain-specific language.
   class Dsl
-    # Instructs the spec runner to execute the given block before each spec in
-    # the spec suite.
+    BEFORE_METHOD = :initialize
+    AFTER_METHOD  = :terminate
+
+    private_constant :BEFORE_METHOD, :AFTER_METHOD
+
+    # Executes the given block before each spec in the current context runs.
+    #
+    # @example
+    #   require "r_spec"
+    #
+    #   RSpec.describe Integer do
+    #     before do
+    #       @value = 123
+    #     end
+    #
+    #     it { expect(@value).to be 123 }
+    #
+    #     describe "nested" do
+    #       before do
+    #         @value -= 81
+    #       end
+    #
+    #       it { expect(@value).to be 42 }
+    #     end
+    #
+    #     it { expect(@value).to be 123 }
+    #   end
+    #
+    #   # Output to the console
+    #   #   Success: expected to be 123.
+    #   #   Success: expected to be 42.
+    #   #   Success: expected to be 123.
     #
     # @param block [Proc] The content to execute at the class initialization.
     def self.before(&block)
-      define_method(:initialize) do |*args, **kwargs|
+      define_method(BEFORE_METHOD) do
         super()
-        instance_exec(*args, **kwargs, &block)
+        instance_eval(&block)
       end
+
+      private BEFORE_METHOD
+    end
+
+    # Executes the given block after each spec in the current context runs.
+    #
+    # @example
+    #   require "r_spec"
+    #
+    #   RSpec.describe Integer do
+    #     after do
+    #       puts "That is the answer to everything."
+    #     end
+    #
+    #     it { expect(42).to be 42 }
+    #   end
+    #
+    #   # Output to the console
+    #   #   Success: expected to be 42.
+    #   #   That is the answer to everything.
+    #
+    # @param block [Proc] The content to execute at the class initialization.
+    def self.after(&block)
+      define_method(AFTER_METHOD) do
+        instance_exec(&block)
+        super()
+      end
+
+      private AFTER_METHOD
     end
 
     # Sets a user-defined property.
     #
+    # @example
+    #   require "r_spec"
+    #
+    #   RSpec.describe "Name stories" do
+    #     let(:name) { "Bob" }
+    #
+    #     it { expect(name).to eq "Bob" }
+    #
+    #     context "with last name" do
+    #       let(:name) { "#{super()} Smith" }
+    #
+    #       it { expect(name).to eq "Bob Smith" }
+    #     end
+    #   end
+    #
+    #   # Output to the console
+    #   #   Success: expected to eq "Bob".
+    #   #   Success: expected to eq "Bob Smith".
+    #
     # @param name   [String, Symbol] The name of the property.
     # @param block  [Proc] The content of the method to define.
     #
-    # @return [Symbol] A protected method that define the block content.
+    # @return [Symbol] A private method that define the block content.
     def self.let(name, *args, **kwargs, &block)
-      protected define_method(name.to_sym, *args, **kwargs, &block)
+      raise Error::ReservedMethod if [BEFORE_METHOD, AFTER_METHOD].include?(name.to_sym)
+
+      private define_method(name, *args, **kwargs, &block)
     end
 
-    # Sets a user-defined property named `subject`.
+    # Sets a user-defined property named {#subject}.
+    #
+    # @example
+    #   require "r_spec"
+    #
+    #   RSpec.describe Array do
+    #     subject { [1, 2, 3] }
+    #
+    #     it "has the prescribed elements" do
+    #       expect(subject).to eq([1, 2, 3])
+    #     end
+    #   end
+    #
+    #   # Output to the console
+    #   #   Success: expected to eq [1, 2, 3].
     #
     # @param block [Proc] The subject to set.
-    # @return [Symbol] A `subject` method that define the block content.
+    # @return [Symbol] A {#subject} method that define the block content.
     def self.subject(&block)
       let(__method__, &block)
     end
 
-    # Create a group of specs.
+    # 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
     #
-    # @param const [Module, #object_id] A module to include in block context.
+    #   # 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.
-    def self.describe(const = nil, &block)
-      desc = Sandbox.const_set(random_test_const_name, ::Class.new(self))
-
-      if const.is_a?(::Module)
-        desc.define_method(:described_class) { const }
-        desc.send(:protected, :described_class)
-      end
-
+    def self.describe(const, &block)
+      desc = ::Class.new(self)
+      desc.let(:described_class) { const } if const.is_a?(::Module)
       desc.instance_eval(&block)
-      desc
     end
 
-    # Add `context` to the DSL.
-    singleton_class.send(:alias_method, :context, :describe)
+    # Defines an example group that establishes a specific context, like _empty
+    # array_ versus _array with elements_.
+    #
+    # It is functionally equivalent to {.describe}.
+    #
+    # @example
+    #   require "r_spec"
+    #
+    #   RSpec.describe "web resource" do
+    #     context "when resource is not found" do
+    #       pending "responds with 404"
+    #     end
+    #
+    #     context "when resource is found" do
+    #       pending "responds with 200"
+    #     end
+    #   end
+    #
+    #   # Output to the console
+    #   #   Warning: responds with 404.
+    #   #   Warning: responds with 200.
+    #
+    # @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)
+      desc = ::Class.new(self)
+      desc.instance_eval(&block)
+    end
 
-    # Define a single spec. A spec should contain one or more expectations that
-    # test the state of the code.
+    # Defines a concrete test case.
     #
+    # The test is performed by the block supplied to `&block`.
+    #
+    # @example The integer after 41
+    #   require "r_spec"
+    #
+    #   RSpec.describe Integer do
+    #     it { expect(41.next).to be 42 }
+    #   end
+    #
+    #   # Output to the console
+    #   #   Success: expected to be 42.
+    #
+    # @example A division by zero
+    #   require "r_spec"
+    #
+    #   RSpec.describe Integer do
+    #     subject { 41 }
+    #
+    #     it { is_expected.to be_an_instance_of described_class }
+    #
+    #     it "raises an error" do
+    #       expect { subject / 0 }.to raise_exception ZeroDivisionError
+    #     end
+    #   end
+    #
+    #   # Output to the console
+    #   #   Success: expected 41 to be an instance of Integer.
+    #   #   Success: divided by 0.
+    #
+    # It can be used inside a {.describe} or {.context} section.
+    #
+    # @param _name [String, nil] The name of the spec.
     # @param block [Proc] An expectation to evaluate.
     #
     # @raise (see ExpectationTarget::Base#result)
     # @return (see ExpectationTarget::Base#result)
     def self.it(_name = nil, &block)
-      raise ::ArgumentError, "Missing block" unless block
+      raise ::ArgumentError, "Missing example block" unless block
 
-      puts "\e[37m#{block.source_location.join(':')}\e[0m"
+      example = ::Class.new(self) { include ExpectationHelper::It }.new
+      example.instance_eval(&block)
+    rescue ::SystemExit
+      Console.source(*block.source_location)
 
-      i = it_example.new
-      i.instance_eval(&block)
+      exit false
+    ensure
+      example&.send(AFTER_METHOD)
     end
 
-    # Define a single spec. A spec should contain one or more expectations that
-    # test the state of the code.
+    # Use the {.its} method to define a single spec that specifies the actual
+    # value of an attribute of the subject using
+    # {ExpectationHelper::Its#is_expected}.
     #
-    # @example The value after 41
+    # @example The integer after 41
     #   require "r_spec"
     #
     #   RSpec.describe Integer do
@@ -81,55 +246,100 @@ module RSpec
     #     its(:next) { is_expected.to be 42 }
     #   end
     #
-    # @example Without defining a subject
+    #   # Output to the console
+    #   #   Success: expected to be 42.
+    #
+    # @example A division by zero
     #   require "r_spec"
     #
     #   RSpec.describe Integer do
-    #     its(:next) { is_expected.to raise_exception NameError }
+    #     subject { 41 }
+    #
+    #     its(:/, 0) { is_expected.to raise_exception ZeroDivisionError }
     #   end
     #
+    #   # Output to the console
+    #   #   Success: divided by 0.
+    #
+    # @example A spec without subject
+    #   require "r_spec"
+    #
+    #   RSpec.describe Integer do
+    #     its(:boom) { is_expected.to raise_exception RSpec::Error::UndefinedSubject }
+    #   end
+    #
+    #   # Output to the console
+    #   #   Success: subject not explicitly defined.
+    #
     # @param attribute [String, Symbol] The property to call to subject.
+    # @param args [Array] An optional list of arguments.
+    # @param kwargs [Hash] An optional list of keyword arguments.
+    # @param block [Proc] An expectation to evaluate.
     #
     # @raise (see ExpectationTarget::Base#result)
     # @return (see ExpectationTarget::Base#result)
     def self.its(attribute, *args, **kwargs, &block)
-      raise ::ArgumentError, "Missing block" unless block
+      raise ::ArgumentError, "Missing example block" unless block
 
-      puts "\e[37m#{block.source_location.join(':')}\e[0m"
+      example = ::Class.new(self) do
+        include ExpectationHelper::Its
 
-      i = its_example.new
+        define_method(:actual) do
+          subject.public_send(attribute, *args, **kwargs)
+        end
+      end.new
 
-      i.define_singleton_method(:actual) do
-        subject.public_send(attribute, *args, **kwargs)
-      end
+      example.instance_eval(&block)
+    rescue ::SystemExit
+      Console.source(*block.source_location)
 
-      i.instance_eval(&block)
+      exit false
+    ensure
+      example&.send(AFTER_METHOD)
     end
 
-    # @private
+    # 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.describe "an example" do
+    #     pending "is implemented but waiting" do
+    #       expect something to be finished
+    #     end
+    #
+    #     pending "is not yet implemented and waiting"
+    #   end
+    #
+    #   # Output to the console
+    #   #   Warning: is implemented but waiting.
+    #   #   Warning: is not yet implemented and waiting.
+    #
+    # @param message [String] The reason why the example is pending.
+    #
+    # @return [nil] Write a message to STDOUT.
     #
-    # @return [Class<Dsl>] The class of the example to be tested.
-    def self.it_example
-      ::Class.new(self) { include ExpectationHelper::It }
+    # @api public
+    def self.pending(message)
+      Console.passed_spec Error::PendingExpectation.result(message)
     end
 
-    # @private
-    #
-    # @return [Class<Dsl>] The class of the example to be tested.
-    def self.its_example
-      ::Class.new(self) { include ExpectationHelper::Its }
+    private
+
+    def described_class
+      raise Error::UndefinedDescribedClass,
+            "the first argument to at least one example group must be a module"
     end
 
-    # @private
-    #
-    # @return [String] A random constant name for a test class.
-    def self.random_test_const_name
-      "Test#{::SecureRandom.hex(4).to_i(16)}"
+    def subject
+      raise Error::UndefinedSubject, "subject not explicitly defined"
     end
 
-    private_class_method :it_example, :its_example, :random_test_const_name
+    define_method(AFTER_METHOD) do
+      # do nothing by default
+    end
   end
 end
-
-require_relative "expectation_helper"
-require_relative "sandbox"

data/lib/r_spec/error.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative File.join("error", "pending_expectation")
+require_relative File.join("error", "reserved_method")
+require_relative File.join("error", "undefined_described_class")
+require_relative File.join("error", "undefined_subject")
+
+module RSpec
+  # Namespace for exceptions.
+  #
+  # @api private
+  module Error
+  end
+end

data/lib/r_spec/error/pending_expectation.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "expresenter"
+
+module RSpec
+  module Error
+    # Exception for pending expectations.
+    #
+    # @api private
+    class PendingExpectation < ::RuntimeError
+      # @param message [String] The not implemented expectation description.
+      #
+      # @return [nil] Write a pending expectation to STDOUT.
+      def self.result(message)
+        ::Expresenter.call(true).with(
+          actual:   new(message),
+          error:    nil,
+          expected: self,
+          got:      false,
+          matcher:  :raise_exception,
+          negate:   true,
+          level:    :SHOULD
+        )
+      end
+    end
+  end
+end

data/lib/r_spec/error/reserved_method.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Error
+    # Exception for reserved methods.
+    #
+    # @api private
+    class ReservedMethod < ::RuntimeError
+    end
+  end
+end

data/lib/r_spec/error/undefined_described_class.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Error
+    # Exception for undefined described classes.
+    #
+    # @api private
+    class UndefinedDescribedClass < ::RuntimeError
+    end
+  end
+end

data/lib/r_spec/error/undefined_subject.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Error
+    # Exception for undefined subjects.
+    #
+    # @api private
+    class UndefinedSubject < ::RuntimeError
+    end
+  end
+end

data/lib/r_spec/expectation_helper.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
+require_relative File.join("expectation_helper", "it")
+require_relative File.join("expectation_helper", "its")
+
 module RSpec
-  # Namespace for `it` and `its` helper modules.
+  # Namespace for {Dsl.it} and {Dsl.its}'s helper modules.
   module ExpectationHelper
   end
 end
-
-require_relative File.join("expectation_helper", "it")
-require_relative File.join("expectation_helper", "its")

data/lib/r_spec/expectation_helper/it.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require_relative "base"
+require_relative "shared"
 require_relative File.join("..", "expectation_target")
 
 module RSpec
   module ExpectationHelper
-    # `it` expectation helper module.
+    # {RSpec::Dsl.it}'s expectation helper module.
     module It
-      include Base
+      include Shared
 
       # Create an expectation for a spec.
       #
@@ -27,7 +27,7 @@ module RSpec
 
       # Wraps the target of an expectation with the subject as actual value.
       #
-      # @return (see #expect)
+      # @return [Block] The wrapped target of an expectation.
       #
       # @example
       #   is_expected # => #<RSpec::ExpectationTarget::Block:0x00007fb6b8263df8 @callable=#<Proc:0x00007fb6b8263e20>>

data/lib/r_spec/expectation_helper/its.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require_relative "base"
+require_relative "shared"
 require_relative File.join("..", "expectation_target", "block")
 
 module RSpec
   module ExpectationHelper
-    # `its` expectation helper module.
+    # {RSpec::Dsl.its}'s expectation helper module.
     module Its
-      include Base
+      include Shared
 
       # Wraps the target of an expectation with the actual value.
       #

data/lib/r_spec/expectation_helper/{base.rb → shared.rb}

@@ -2,14 +2,14 @@
 
 require "matchi/rspec"
 
-require_relative File.join("..", "pending")
+require_relative File.join("..", "error", "pending_expectation")
 
 module RSpec
   module ExpectationHelper
     # Abstract expectation helper base module.
     #
     # This module defines a number of methods to create expectations, which are
-    # automatically included into example namespaces.
+    # automatically included into examples.
     #
     # It also includes a collection of expectation matchers 🤹
     #
@@ -75,22 +75,8 @@ module RSpec
     #
     # @see https://github.com/fixrb/matchi
     # @see https://github.com/fixrb/matchi-rspec
-    module Base
+    module Shared
       include ::Matchi::Helper
-
-      # Mark a spec as pending, expectation results will be ignored.
-      #
-      # @param description [String] The reason why the example is pending.
-      #
-      # @return [nil] Write a message to STDOUT.
-      #
-      # @example Output a message to the console and return nil
-      #   pending("something else getting finished") # => nil
-      #
-      # @api public
-      def pending(description)
-        Pending.result(description)
-      end
     end
   end
 end

data/lib/r_spec/expectation_target.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require_relative File.join("expectation_target", "block")
+require_relative File.join("expectation_target", "value")
+
 module RSpec
   # Wraps the target of an expectation.
   #
@@ -25,6 +28,3 @@ module RSpec
     end
   end
 end
-
-require_relative File.join("expectation_target", "block")
-require_relative File.join("expectation_target", "value")

data/lib/r_spec/expectation_target/base.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require "expresenter"
+require "test_tube"
+
+require_relative File.join("..", "console")
 
 module RSpec
   module ExpectationTarget
@@ -9,6 +12,13 @@ module RSpec
     # @note `RSpec::ExpectationTarget::Base` is not intended to be instantiated
     #   directly by users. Use `expect` instead.
     class Base
+      # Instantiate a new expectation target.
+      #
+      # @param actual [#object_id] The actual value of the code to evaluate.
+      def initialize(actual)
+        @actual = actual
+      end
+
       # Runs the given expectation, passing if `matcher` returns true.
       #
       # @example _Absolute requirement_ definition
@@ -41,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.
       #
@@ -54,19 +64,18 @@ module RSpec
       #   `Kernel.exit(false)` with a failure message written to STDERR.
       #
       # @api private
-      def result(actual:, error:, got:, matcher:, negate:, valid:)
-        puts "  " + ::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
-        ).colored_string
+        )
       rescue ::Expresenter::Fail => e
-        abort "  #{e.colored_string}"
+        Console.failed_spec(e)
       end
     end
   end

data/lib/r_spec/expectation_target/block.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "spectus/exam"
-
 require_relative "base"
 
 module RSpec
@@ -20,15 +18,6 @@ module RSpec
     # @note `RSpec::ExpectationTarget::Block` is not intended to be instantiated
     #   directly by users. Use `expect` instead.
     class Block < Base
-      # Instantiate a new expectation target.
-      #
-      # @param block [#call] The code to evaluate.
-      def initialize(block)
-        super()
-
-        @callable = block
-      end
-
       protected
 
       # @param matcher  [#matches?] The matcher.
@@ -39,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:  @callable,
+        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

@@ -18,15 +18,6 @@ module RSpec
     # @note `RSpec::ExpectationTarget::Value` is not intended to be instantiated
     #   directly by users. Use `expect` instead.
     class Value < Base
-      # Instantiate a new expectation target.
-      #
-      # @param actual [#object_id] The actual value.
-      def initialize(actual)
-        super()
-
-        @actual = actual
-      end
-
       protected
 
       # @param matcher  [#matches?] The matcher.
@@ -37,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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r_spec
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta4
+  version: 1.0.0.beta9
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-08 00:00:00.000000000 Z
+date: 2021-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: expresenter
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: matchi-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 1.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        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.2
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.2
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -187,17 +187,21 @@ files:
 - LICENSE.md
 - README.md
 - lib/r_spec.rb
+- lib/r_spec/console.rb
 - lib/r_spec/dsl.rb
+- lib/r_spec/error.rb
+- lib/r_spec/error/pending_expectation.rb
+- lib/r_spec/error/reserved_method.rb
+- lib/r_spec/error/undefined_described_class.rb
+- lib/r_spec/error/undefined_subject.rb
 - lib/r_spec/expectation_helper.rb
-- lib/r_spec/expectation_helper/base.rb
 - lib/r_spec/expectation_helper/it.rb
 - lib/r_spec/expectation_helper/its.rb
+- lib/r_spec/expectation_helper/shared.rb
 - lib/r_spec/expectation_target.rb
 - lib/r_spec/expectation_target/base.rb
 - lib/r_spec/expectation_target/block.rb
 - lib/r_spec/expectation_target/value.rb
-- lib/r_spec/pending.rb
-- lib/r_spec/sandbox.rb
 homepage: https://r-spec.dev/
 licenses:
 - MIT

data/lib/r_spec/pending.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require "expresenter"
-
-module RSpec
-  # Exception for pending expectations.
-  #
-  # @api private
-  class Pending < ::NotImplementedError
-    # @param message [String] The not implemented expectation description.
-    #
-    # @return [nil] Write a pending expectation to STDOUT.
-    def self.result(message)
-      warn "  " + ::Expresenter.call(true).with(
-        actual:   new(message),
-        error:    nil,
-        expected: self,
-        got:      false,
-        matcher:  :raise_exception,
-        negate:   true,
-        level:    :SHOULD,
-        valid:    false
-      ).colored_string
-    end
-  end
-end

data/lib/r_spec/sandbox.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module RSpec
-  # Namespace to collect test classes.
-  #
-  # @api private
-  module Sandbox
-  end
-end