r_spec-clone 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d314d17896138ce2ff2b6d7eb389a1ba2316690f40923684c68632227692a5f
-  data.tar.gz: af8efe2d9ab1b773db062263503221dd56b6b7a604e73d5f1a84baf0ccbf2b35
+  metadata.gz: 0e923f4f11f83ba71f2c7267393691edf8bf8ea9be1ae3598f57cb637d71c411
+  data.tar.gz: 18d34b05058e5f17eca7c874f03d52fdac54e995858e1531ee5acff77ceed552
 SHA512:
-  metadata.gz: a57d31c77a3da5d120651efbbc1f6d28f808fa47d9c7184e04f79723273df0ce6d84ba08628bc2f60c98c7756a0f2cf1d46774f42d1c505ca9f4e522f418e404
-  data.tar.gz: 2b2cb13a1620fd98107b3f82e8d7427ae11eb054e9e4bd8c36fe21402efc9dc38af0f6aa41850dc65c05eeba9cfc918a23dfcdea743658963459ef9e5b35c689
+  metadata.gz: 80419c1141a6efc61b8f47294d08c8932a416b8c983419a63afdab4bbf8a593d865c37ecb37f84e186459004cd7f807d87d5f99e5625ded0bb8fa885b2ad50d0
+  data.tar.gz: 7796a4e33df45136434543f1f2dc2a0ae32a8d93d61bf11515ab0b8d3df7b300b78bd4f5976c913b777ea75da9500b85389268c51f4851eaf30fbe6012aa25fc

data/README.md

@@ -14,16 +14,15 @@ A minimalist __RSpec clone__ with all the essentials.
 
 ## Project goals
 
-1. Keep a low level of code complexity and ensure thread safety.
-2. The interface must translate into atomic and simple Ruby objects.
+1. Keep a low level of code complexity, avoid false negatives and false positives.
+2. Translate specification documents into atomic and thread safe Ruby objects.
 3. Avoid overloading the interface with additional alternative syntaxes.
 4. Provide most of RSpec's DSL to express expected outcomes of a code example.
 
 ## Some differences
 
-* Spec files can be executed with `ruby` directly.
 * 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.
+* 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.
 * If no `subject` has been explicitly determined, none is defined.
 * If no described class is set, `described_class` is undefined instead of `nil`.
@@ -32,7 +31,7 @@ A minimalist __RSpec clone__ with all the essentials.
 * 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.
-* Groups and examples are _executed in subprocesses_ the order they are defined.
+* Runs much faster.
 
 ## Installation
 
@@ -79,6 +78,8 @@ Test cases that have been defined or outlined but are not yet expected to work c
 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.
 
+The `its` method can also be used to generate a nested example group with a single example that specifies the expected value (or the block expectations) of an attribute of the subject using `is_expected`.
+
 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.
@@ -94,6 +95,13 @@ 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:
+
+* `describe!`
+* `context!`
+* `it!`
+* `its!`
+
 ### Expectations
 
 Expectations define if the value being tested (_actual_) matches a certain value or specific criteria.
@@ -211,9 +219,15 @@ bundle exec rake
 
 ### Boot time
 
-Benchmark against [100 executions of a file containing one expectation](https://github.com/cyril/r_spec-clone.rb/blob/main/benchmark/) (lower is better).
+Benchmark against [100 executions of a file containing 1 expectation](https://github.com/cyril/r_spec-clone.rb/blob/main/benchmark/boot_time/) (lower is better).
+
+![Boot time](https://r-spec.dev/benchmark-boot-time.svg)
+
+### Run time
+
+Benchmark against [1 execution of a file containing 1,000,000 expectations](https://github.com/cyril/r_spec-clone.rb/blob/main/benchmark/run_time/) (lower is better).
 
-![Runtime](https://r-spec.dev/benchmark-boot-time.svg)
+![Run time](https://r-spec.dev/benchmark-run-time.svg)
 
 ## Test suite
 

data/lib/r_spec.rb

@@ -89,6 +89,16 @@ module RSpec
     Clone::Dsl.context(description, &block)
   end
 
+  # :nocov:
+  #
+  # Runs a context example group in a subprocess to isolate side effects.
+  #
+  # @param (see #context)
+  def self.context!(description, &block)
+    Clone::Dsl.context!(description, &block)
+  end
+  # :nocov:
+
   # Defines an example group that describes a unit to be tested.
   #
   # @example
@@ -111,6 +121,16 @@ module RSpec
     Clone::Dsl.describe(const, &block)
   end
 
+  # :nocov:
+  #
+  # Runs a describe example group in a subprocess to isolate side effects.
+  #
+  # @param (see #describe)
+  def self.describe!(const, &block)
+    Clone::Dsl.describe!(const, &block)
+  end
+  # :nocov:
+
   # Defines a concrete test case.
   #
   # The test is performed by the block supplied to &block.
@@ -137,6 +157,32 @@ module RSpec
     Clone::Dsl.it(name, &block)
   end
 
+  # :nocov:
+  #
+  # Runs a concrete test case in a subprocess to isolate side effects.
+  #
+  # @example
+  #   app = "Hello, world!"
+  #
+  #   RSpec.it! { expect(app.gsub!("world", "Alice")).to eq "Hello, Alice!" }
+  #
+  #   # Output to the console
+  #   #   Success: expected to eq "Hello, Alice!".
+  #
+  #   RSpec.it { expect(app).to eq "Hello, world!" }
+  #
+  #   # Output to the console
+  #   #   Success: expected to eq "Hello, world!".
+  #
+  # @param (see #it)
+  #
+  # @raise (see ExpectationTarget::Base#result)
+  # @return (see ExpectationTarget::Base#result)
+  def self.it!(name = nil, &block)
+    Clone::Dsl.it!(name, &block)
+  end
+  # :nocov:
+
   # Defines a pending test case.
   #
   # `&block` is never evaluated. It can be used to describe behaviour that is

data/lib/r_spec/clone/dsl.rb

@@ -150,9 +150,19 @@ module RSpec
       def self.describe(const, &block)
         desc = ::Class.new(self)
         desc.let(:described_class) { const } if const.is_a?(::Module)
-        fork! { desc.instance_eval(&block) }
+        desc.instance_eval(&block)
       end
 
+      # :nocov:
+      #
+      # Runs a describe example group in a subprocess to isolate side effects.
+      #
+      # @param (see #describe)
+      def self.describe!(const, &block)
+        fork! { describe(const, &block) }
+      end
+      # :nocov:
+
       # Defines an example group that establishes a specific context, like
       # _empty array_ versus _array with elements_.
       #
@@ -178,9 +188,19 @@ module RSpec
       # @param block [Proc] The block to define the specs.
       def self.context(_description, &block)
         desc = ::Class.new(self)
-        fork! { desc.instance_eval(&block) }
+        desc.instance_eval(&block)
       end
 
+      # :nocov:
+      #
+      # Runs a context example group in a subprocess to isolate side effects.
+      #
+      # @param (see #context)
+      def self.context!(description, &block)
+        fork! { context(description, &block) }
+      end
+      # :nocov:
+
       # Defines a concrete test case.
       #
       # The test is performed by the block supplied to `&block`.
@@ -221,12 +241,24 @@ module RSpec
       # @return (see ExpectationTarget::Base#result)
       def self.it(_name = nil, &block)
         example = ::Class.new(self) { include ExpectationHelper::It }.new
-        fork! { run(example, &block) }
+        run(example, &block)
+      end
+
+      # :nocov:
+      #
+      # Runs a concrete test case in a subprocess to isolate side effects.
+      #
+      # @param (see #it)
+      #
+      # @raise (see ExpectationTarget::Base#result)
+      # @return (see ExpectationTarget::Base#result)
+      def self.it!(name = nil, &block)
+        fork! { it(name, &block) }
       end
+      # :nocov:
 
-      # 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}.
+      # Defines a single concrete test case that specifies the actual value of
+      # an attribute of the subject using {ExpectationHelper::Its#is_expected}.
       #
       # @example The integer after 41
       #   require "r_spec/clone"
@@ -256,7 +288,7 @@ module RSpec
       #   require "r_spec/clone"
       #
       #   RSpec.describe Integer do
-      #     its(:boom) { is_expected.to raise_exception RSpec::Error::UndefinedSubject }
+      #     its(:boom) { is_expected.to raise_exception RSpec::Clone::Error::UndefinedSubject }
       #   end
       #
       #   # Output to the console
@@ -278,8 +310,22 @@ module RSpec
           end
         end.new
 
-        fork! { run(example, &block) }
+        run(example, &block)
+      end
+
+      # :nocov:
+      #
+      # Runs a single concrete test case in a subprocess to isolate side
+      # effects.
+      #
+      # @param (see #it)
+      #
+      # @raise (see ExpectationTarget::Base#result)
+      # @return (see ExpectationTarget::Base#result)
+      def self.its!(attribute, *args, **kwargs, &block)
+        fork! { its(attribute, *args, **kwargs, &block) }
       end
+      # :nocov:
 
       # Defines a pending test case.
       #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r_spec-clone
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-30 00:00:00.000000000 Z
+date: 2021-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: expresenter