r_spec-clone 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90252cd64a48b7b40aa2424c1c09c69227e45e414ac5fd8d14a53697c0b1c180
-  data.tar.gz: 7eb7211ac34e5dfc2f1f74ae17d354f2704feb41e400d5fada1ccaa764912413
+  metadata.gz: 7ca7e0d020bebba8aec767197a6c765fa4c0ded5bb96fb58723e5de8321ba1bf
+  data.tar.gz: 3e9fd96ec29c5341bb5b8f8a3fb60c9672a816e3dd22e1d80d7593ef78689f74
 SHA512:
-  metadata.gz: a7fc657a588d0efd081ead62736ddd0f2595e09f0e4db6df235550503325d46cb4814110e16a4fb55244c07de645878d1e08eab40e5ddcc0226b3a64e318091d
-  data.tar.gz: ff205ff80822fea221bbcd27bf8a43925617146be2bf48d0c24d525bbe530921ce6f835530bce0cad53ef6f3e694278b6bd9655dbd4506f3691365cb15ce800a
+  metadata.gz: 7ae195dc7673cdd06068d376763ca3b67904eb1bea7ec502cdaf74424ffacb2d44c685988e7c22db21e7be2295a9d3de3b93d587e1c0d8696739dfdb8f37216d
+  data.tar.gz: 2b3522c31de373f4b9dc3a5d88a9a8e2ec7443d11205d6f93eae91f43a136bead79774333d3d8bac04b96cd07f89eb8c9792c379af0eb380b644da0931d639b4

data/README.md

@@ -6,6 +6,7 @@ A minimalist __RSpec clone__ with all the essentials.
 
 ## Status
 
+[![Home](https://img.shields.io/badge/Home-r--spec.dev-00af8b)](https://r-spec.dev/)
 [![Version](https://img.shields.io/github/v/tag/cyril/r_spec-clone.rb?label=Version&logo=github)](https://github.com/cyril/r_spec-clone.rb/releases)
 [![Yard documentation](https://img.shields.io/badge/Yard-documentation-blue.svg?logo=github)](https://rubydoc.info/github/cyril/r_spec-clone.rb/main)
 [![CI](https://github.com/cyril/r_spec-clone.rb/workflows/CI/badge.svg?branch=main)](https://github.com/cyril/r_spec-clone.rb/actions?query=workflow%3Aci+branch%3Amain)
@@ -23,7 +24,7 @@ A minimalist __RSpec clone__ with all the essentials.
 
 * There is no option to activate monkey-patching.
 * It does not rely on [hacks such as `at_exit` hook](https://blog.arkency.com/2013/06/are-we-abusing-at-exit/) to trigger the tests.
-* Built-in matchers [do not trust _actual_](https://asciinema.org/a/29172?autoplay=1&speed=2) and do not send it messages.
+* Malicious _actual values_ cannot [hack results](https://asciinema.org/a/423547?autoplay=1&speed=2).
 * 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.
@@ -95,12 +96,26 @@ For unit tests, it is recommended to follow the conventions for method names:
 
 To establish certain contexts — think _empty array_ versus _array with elements_ — the `context` method may be used to communicate this to the reader.
 
-Finally, each block of code can be run in a subprocess to isolate side effects with the equivalent methods:
+To execute unit tests while isolating side effects in a sub-process, declined methods can be used: `describe!`, `context!`, `it!`, `its!`. Here is an example:
 
-* `describe!`
-* `context!`
-* `it!`
-* `its!`
+```ruby
+app = "foo"
+
+RSpec.describe "Side effects per example" do
+  it! "runs the example in isolation" do
+    expect { app.gsub!("foo", "bar") }.to eq "bar"
+    expect(app).to eq "bar"
+  end
+
+  it "runs the example" do
+    expect(app).to eq "foo"
+  end
+end
+
+# Success: expected to eq "bar".
+# Success: expected to eq "bar".
+# Success: expected to eq "foo".
+```
 
 ### Expectations
 
@@ -237,6 +252,7 @@ __RSpec clone__'s specifications are self-described here: [spec/](https://github
 
 * Home page: [https://r-spec.dev/](https://r-spec.dev/)
 * Cheatsheet: [https://r-spec.dev/cheatsheet.html](https://r-spec.dev/cheatsheet.html)
+* Blog post: [https://batman.buzz/introducing-a-new-rspec-850d48c0f901](https://batman.buzz/introducing-a-new-rspec-850d48c0f901)
 * Source code: [https://github.com/cyril/r_spec-clone.rb](https://github.com/cyril/r_spec-clone.rb)
 * API Doc: [https://rubydoc.info/gems/r_spec-clone](https://rubydoc.info/gems/r_spec-clone)
 * Twitter: [https://twitter.com/cyri\_](https://twitter.com/cyri\_)

data/lib/r_spec.rb

@@ -201,8 +201,8 @@ module RSpec
   # @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)
+  # @raise (see RSpec::Clone::ExpectationTarget::Base#result)
+  # @return (see RSpec::Clone::ExpectationTarget::Base#result)
   def self.it(name = nil, &block)
     Clone::Dsl.it(name, &block)
   end

data/lib/r_spec/clone/dsl.rb

@@ -329,8 +329,7 @@ module RSpec
       #
       # @api public
       def self.it(_name = nil, &block)
-        example = ::Class.new(self) { include ExpectationHelper::It }.new
-        run(example, &block)
+        run(example_without_attribute.new, &block)
       end
 
       # :nocov:
@@ -417,15 +416,7 @@ module RSpec
       #
       # @api public
       def self.its(attribute, *args, **kwargs, &block)
-        example = ::Class.new(self) do
-          include ExpectationHelper::Its
-
-          define_method(:actual) do
-            subject.public_send(attribute, *args, **kwargs)
-          end
-        end.new
-
-        run(example, &block)
+        run(example_with_attribute(attribute, *args, **kwargs).new, &block)
       end
 
       # :nocov:
@@ -495,6 +486,25 @@ module RSpec
         Console.passed_spec Error::PendingExpectation.result(message)
       end
 
+      # Example class for concrete test case.
+      def self.example_without_attribute
+        ::Class.new(self) do
+          prepend ExpectationHelper::It
+        end
+      end
+
+      # Example class for concrete test case that specifies the actual value of
+      # an attribute of the subject.
+      def self.example_with_attribute(attribute, *args, **kwargs)
+        ::Class.new(self) do
+          prepend ExpectationHelper::Its
+
+          define_method(:actual) do
+            subject.public_send(attribute, *args, **kwargs)
+          end
+        end
+      end
+
       # Creates a subprocess and runs the block inside.
       def self.fork!(&block)
         pid = fork(&block)
@@ -514,7 +524,7 @@ module RSpec
         example&.send(AFTER_METHOD)
       end
 
-      private_class_method :fork!, :run
+      private_class_method :example_without_attribute, :example_with_attribute, :fork!, :run
 
       private
 

data/lib/r_spec/clone/expectation_helper/it.rb

@@ -18,8 +18,8 @@ module RSpec
         # @return [Block, Value] The wrapped target of an expectation.
         #
         # @example
-        #   expect("foo") # => #<RSpec::ExpectationTarget::Value:0x00007fb6b823 @actual="foo">
-        #   expect { Boom } # => #<RSpec::ExpectationTarget::Block:0x00007fb6b826 @callable=#<Proc:0x00007fb6b826>>
+        #   expect("foo") # => #<RSpec::Clone::ExpectationTarget::Value:0x00007f @actual="foo">
+        #   expect { Boom } # => #<RSpec::Clone::ExpectationTarget::Block:0x00007f @callable=#<Proc:0x00007f>>
         #
         # @api public
         def expect(value = self.class.superclass, &block)
@@ -31,7 +31,7 @@ module RSpec
         # @return [Block] The wrapped target of an expectation.
         #
         # @example
-        #   is_expected # => #<RSpec::ExpectationTarget::Block:0x00007fb6b8263df8 @callable=#<Proc:0x00007fb6b8263e20>>
+        #   is_expected # => #<RSpec::Clone::ExpectationTarget::Block:0x00007fb6b8 @callable=#<Proc:0x00007fb6b8>>
         #
         # @api public
         def is_expected

data/lib/r_spec/clone/expectation_helper/its.rb

@@ -15,7 +15,7 @@ module RSpec
         # @return [Block] The wrapped target of an expectation.
         #
         # @example
-        #   is_expected # => #<RSpec::ExpectationTarget::Block:0x00007fb6b8263df8 @callable=#<Proc:0x00007fb6b8263e20>>
+        #   is_expected # => #<RSpec::Clone::ExpectationTarget::Block:0x00007f @callable=#<Proc:0x00007f>>
         #
         # @api public
         def is_expected

data/lib/r_spec/clone/expectation_helper/shared.rb

@@ -2,15 +2,13 @@
 
 require "matchi/rspec"
 
-require_relative File.join("..", "error", "pending_expectation")
-
 module RSpec
   module Clone
     module ExpectationHelper
       # Abstract expectation helper base module.
       #
-      # This module defines a number of methods to create expectations, which are
-      # automatically included into examples.
+      # This module defines a number of methods to create expectations, which
+      # are automatically included into examples.
       #
       # It also includes a collection of expectation matchers 🤹
       #

data/lib/r_spec/clone/expectation_target.rb

@@ -8,8 +8,8 @@ module RSpec
     # Wraps the target of an expectation.
     module ExpectationTarget
       # @param undefined_value A sentinel value to be able to tell when the user
-      #   did not pass an argument. We can't use `nil` for that because `nil` is a
-      #   valid value to pass.
+      #   did not pass an argument. We can't use `nil` for that because `nil` is
+      #   a valid value to pass.
       # @param value [#object_id, nil] An actual value.
       # @param block [#call, nil] A code to evaluate.
       #

data/lib/r_spec/clone/expectation_target/base.rb

@@ -10,14 +10,14 @@ module RSpec
     module ExpectationTarget
       # Abstract expectation target base class.
       #
-      # @note `RSpec::ExpectationTarget::Base` is not intended to be instantiated
-      #   directly by users. Use `expect` instead.
+      # @note `RSpec::Clone::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
+        # @param input [#object_id, Proc] The code to evaluate.
+        def initialize(input)
+          @input = input
         end
 
         # Runs the given expectation, passing if `matcher` returns true.
@@ -52,6 +52,36 @@ module RSpec
 
         protected
 
+        # @param test     [::TestTube::Base] The state of the experiment.
+        # @param matcher  [#matches?] The matcher.
+        # @param negate   [Boolean]   The assertion is positive or negative.
+        #
+        # @return [nil] Write a message to STDOUT.
+        #
+        # @raise [SystemExit] Terminate execution immediately by calling
+        #   `Kernel.exit(false)` with a failure message written to STDERR.
+        def absolute_requirement(test, matcher:, negate:)
+          result(
+            passed?(test),
+            actual:  test.actual,
+            error:   test.error,
+            got:     test.got,
+            matcher: matcher,
+            negate:  negate
+          )
+        end
+
+        # Code experiment result.
+        #
+        # @param test [::TestTube::Base] The state of the experiment.
+        #
+        # @see https://github.com/fixrb/test_tube
+        #
+        # @return [Boolean] The result of the test (passed or failed).
+        def passed?(test)
+          test.got.equal?(true)
+        end
+
         # @param passed   [Boolean]         The high expectation passed or failed.
         # @param actual   [#object_id]      The actual value.
         # @param error    [Exception, nil]  Any raised exception.

data/lib/r_spec/clone/expectation_target/block.rb

@@ -16,31 +16,20 @@ module RSpec
       #   # with `not_to`
       #   expect { actual }.not_to be(4)
       #
-      # @note `RSpec::ExpectationTarget::Block` is not intended to be instantiated
-      #   directly by users. Use `expect` instead.
+      # @note `RSpec::Clone::ExpectationTarget::Block` is not intended to be
+      #   instantiated directly by users. Use `expect` instead.
       class Block < Base
         protected
 
         # @param matcher  [#matches?] The matcher.
         # @param negate   [Boolean]   The assertion is positive or negative.
         #
-        # @return [nil] Write a message to STDOUT.
+        # @return (see Base#absolute_requirement)
         #
-        # @raise [SystemExit] Terminate execution immediately by calling
-        #   `Kernel.exit(false)` with a failure message written to STDERR.
+        # @raise (see Base#absolute_requirement)
         def absolute_requirement(matcher:, negate:)
-          experiment = ::TestTube.invoke(
-            @actual,
-            isolation: false,
-            matcher:   matcher,
-            negate:    negate
-          )
-
-          result(
-            experiment.got.equal?(true),
-            actual:  experiment.actual,
-            error:   experiment.error,
-            got:     experiment.got,
+          super(
+            ::TestTube.invoke(isolation: false, matcher: matcher, negate: negate, &@input),
             matcher: matcher,
             negate:  negate
           )

data/lib/r_spec/clone/expectation_target/value.rb

@@ -16,30 +16,20 @@ module RSpec
       #   # with `not_to`
       #   expect(actual).not_to be(4)
       #
-      # @note `RSpec::ExpectationTarget::Value` is not intended to be instantiated
-      #   directly by users. Use `expect` instead.
+      # @note `RSpec::Clone::ExpectationTarget::Value` is not intended to be
+      #   instantiated directly by users. Use `expect` instead.
       class Value < Base
         protected
 
         # @param matcher  [#matches?] The matcher.
         # @param negate   [Boolean]   The assertion is positive or negative.
         #
-        # @return [nil] Write a message to STDOUT.
+        # @return (see Base#absolute_requirement)
         #
-        # @raise [SystemExit] Terminate execution immediately by calling
-        #   `Kernel.exit(false)` with a failure message written to STDERR.
+        # @raise (see Base#absolute_requirement)
         def absolute_requirement(matcher:, negate:)
-          experiment = ::TestTube.pass(
-            @actual,
-            matcher: matcher,
-            negate:  negate
-          )
-
-          result(
-            experiment.got.equal?(true),
-            actual:  experiment.actual,
-            error:   experiment.error,
-            got:     experiment.got,
+          super(
+            ::TestTube.pass(@input, matcher: matcher, negate: negate),
             matcher: matcher,
             negate:  negate
           )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r_spec-clone
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-02 00:00:00.000000000 Z
+date: 2021-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: expresenter
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement