r_spec-clone 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2e7a16588ed11ac0ab9cd7eebcb01c3d6e914d351c5041cfbed6015c88128ea
-  data.tar.gz: 96dfc31819a59b319c06c777a63aa09daf5630a3db7cf5860c59474b1809f94c
+  metadata.gz: 6014d4cd0ffe271d71ff599cdba7ce291b5329c062aeea611c292dcb9d24d822
+  data.tar.gz: 96e14ce3c34c9d5d6e9a6c49769c94db2562e2a14eaeae94e6415884f2f5c7eb
 SHA512:
-  metadata.gz: f34d7820173f21ffdafe71d206314aee90904ab7b9a46c29511aed5e4191742e87a14ef2e9da512e48917c080c97d52b5618ce545519f49955fb3edc6b20022d
-  data.tar.gz: d2ad326e9150e95b19f9f62994568e5a44474b6567727e15c38020ede970f1c20b4bd0ddc1d1ab450f968fedfd109ed795accda5724b0424ef666fe09e31e92c
+  metadata.gz: c7bd806d2a1a220c86320a6a8fa93bf9b19f60ac2a0b4f03f510f727d6d0132995c0dde783659923c2031d7f0864b63f5137976c136d3c1c90a62ecd8996ef25
+  data.tar.gz: 4eda5fc59e05cb4a2a20e18cc403a89985552737b551d2f343fedf3b9f98f6dd572ef977c0164926b5b0703a9b91b2901189bcad6823618558c908df6a869c4a

data/LICENSE.md

@@ -1,4 +1,4 @@
-The MIT License (MIT)
+# The MIT License
 
 Copyright (c) 2015-2022 Cyril Kato
 

data/README.md

@@ -15,14 +15,14 @@ A minimalist __RSpec clone__ with all the essentials.
 
 ## Project goals
 
-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.
+1. Keep code complexity low, avoid false negatives and false positives.
+2. Load specifications in simple, atomic and thread safe Ruby primitives.
 3. Avoid overloading the interface with additional alternative syntaxes.
-4. Provide most of RSpec's DSL to express expected outcomes of a code example.
+4. Provide the basics of DSL RSpec to write tests.
 
 ## Some differences
 
-* There is no option to activate monkey-patching.
+* There is no option to enable 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.
 * 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.
@@ -31,9 +31,9 @@ A minimalist __RSpec clone__ with all the essentials.
 * [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.
+* `subject`, `before` and `let` definitions must come before examples.
 * The execution of the test suite stops as soon as an error is detected.
-* The order of the unit tests does not matter because they are executed in isolation.
+* Each `context` block isolates its tests and possible side effects.
 
 ## Installation
 
@@ -87,7 +87,7 @@ To express an expectation, wrap an object or block in `expect`, call `to` (or `n
 If the expectation is met, code execution continues.
 Otherwise the example has _failed_ and other code will not be executed.
 
-In test files, specs are structured by example groups which are defined by `describe` and `context` sections.
+In test files, specs can be 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).
 
@@ -98,6 +98,9 @@ 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.
 
+Unlike a `describe` block, all specifications executed within a `context` are isolated in a subprocess.
+This prevents possible side effects on the Ruby object environment from being propagated outside their context, which could alter the result of the unit test suite.
+
 Note: if you are wondering what kind of code might be generated by the DSL, an article that shows the dynamic transcription of the main methods with simple examples is available in [Chinese](https://ruby-china.org/topics/41441), in [English](https://dev.to/cyri_/what-ruby-code-to-expect-from-a-testing-dsl-4oe1) and in [Japanese](https://qiita.com/cyril/items/17ee758e162bae144a07).
 
 ### Expectations

data/lib/r_spec/clone/dsl.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "console"
+require_relative "logger"
 require_relative "error"
 require_relative "expectation_helper"
 
@@ -9,9 +9,8 @@ module RSpec
     # Abstract class for handling the domain-specific language.
     class Dsl
       BEFORE_METHOD = :initialize
-      AFTER_METHOD  = :terminate
 
-      private_constant :BEFORE_METHOD, :AFTER_METHOD
+      private_constant :BEFORE_METHOD
 
       # Executes the given block before each spec in the current context runs.
       #
@@ -53,35 +52,6 @@ module RSpec
         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.
-      #
-      # @api public
-      def self.after(&block)
-        define_method(AFTER_METHOD) do
-          instance_exec(&block)
-          super()
-        end
-
-        private AFTER_METHOD
-      end
-
       # Sets a user-defined property.
       #
       # @example
@@ -110,7 +80,7 @@ module RSpec
       #
       # @api public
       def self.let(name, *args, **kwargs, &block)
-        raise Error::ReservedMethod if [BEFORE_METHOD, AFTER_METHOD].include?(name.to_sym)
+        raise Error::ReservedMethod if BEFORE_METHOD.equal?(name.to_sym)
 
         private define_method(name, *args, **kwargs, &block)
       end
@@ -176,6 +146,11 @@ module RSpec
       # Defines an example group that establishes a specific context, like
       # _empty array_ versus _array with elements_.
       #
+      # Unlike a `describe` block, all specifications executed within a
+      # `context` are isolated in a subprocess. This prevents possible side
+      # effects on the Ruby object environment from being propagated outside
+      # their context, which could alter the result of the unit test suite.
+      #
       # @example
       #   require "r_spec"
       #
@@ -199,8 +174,8 @@ module RSpec
       #
       # @api public
       def self.context(_description, &block)
-        desc = ::Class.new(self)
-        desc.instance_eval(&block)
+        pid = ::Process.fork { ::Class.new(self).instance_eval(&block) }
+        exit false unless ::Process::Status.wait(pid).exitstatus.zero?
       end
 
       # :nocov:
@@ -246,7 +221,8 @@ module RSpec
       #
       # @api public
       def self.it(_name = nil, &block)
-        exit false unless ::Aw.fork? { run(example_without_attribute.new, &block) }
+        Logger.source(*block.source_location)
+        example_without_attribute.new.instance_eval(&block)
       end
 
       # :nocov:
@@ -298,7 +274,9 @@ module RSpec
       #
       # @api public
       def self.its(attribute, *args, **kwargs, &block)
-        exit false unless ::Aw.fork? { run(example_with_attribute(attribute, *args, **kwargs).new, &block) }
+        Logger.source(*block.source_location)
+        example_with_attribute(attribute, *args, **kwargs).new
+                                                          .instance_eval(&block)
       end
 
       # :nocov:
@@ -329,7 +307,7 @@ module RSpec
       #
       # @api public
       def self.pending(message)
-        Console.passed_spec Error::PendingExpectation.result(message)
+        Logger.passed_spec Error::PendingExpectation.result(message)
       end
 
       # Example class for concrete test case.
@@ -351,15 +329,7 @@ module RSpec
         end
       end
 
-      # Execution of specifications.
-      def self.run(example, &block)
-        Console.source(*block.source_location)
-        exit false unless ::Aw.fork? { example.instance_eval(&block) }
-      ensure
-        example&.send(AFTER_METHOD)
-      end
-
-      private_class_method :example_without_attribute, :example_with_attribute, :run
+      private_class_method :example_without_attribute, :example_with_attribute
 
       private
 
@@ -374,10 +344,6 @@ module RSpec
       def subject
         raise Error::UndefinedSubject, "subject not explicitly defined"
       end
-
-      define_method(AFTER_METHOD) do
-        # do nothing by default
-      end
     end
   end
 end

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

@@ -3,7 +3,7 @@
 require "expresenter"
 require "test_tube"
 
-require_relative File.join("..", "console")
+require_relative File.join("..", "logger")
 
 module RSpec
   module Clone
@@ -82,6 +82,8 @@ module RSpec
           test.got.equal?(true)
         end
 
+        # :nocov:
+
         # @param passed   [Boolean]         The high expectation passed or failed.
         # @param actual   [#object_id]      The actual value.
         # @param error    [Exception, nil]  Any raised exception.
@@ -94,7 +96,7 @@ module RSpec
         # @raise [SystemExit] Terminate execution immediately by calling
         #   `Kernel.exit(false)` with a failure message written to STDERR.
         def result(passed, actual:, error:, got:, matcher:, negate:)
-          Console.passed_spec ::Expresenter.call(passed).with(
+          Logger.passed_spec ::Expresenter.call(passed).with(
             actual:     actual,
             definition: matcher.to_s,
             error:      error,
@@ -104,8 +106,10 @@ module RSpec
             level:      :MUST
           )
         rescue ::Expresenter::Fail => e
-          Console.failed_spec(e)
+          Logger.failed_spec(e)
         end
+
+        # :nocov:
       end
     end
   end

data/lib/r_spec/clone/{console.rb → logger.rb}

@@ -3,7 +3,7 @@
 module RSpec
   module Clone
     # Send log messages to the console.
-    module Console
+    module Logger
       # @param report [::Expresenter::Pass] Passed expectation result presenter.
       #
       # @see https://github.com/fixrb/expresenter
@@ -13,17 +13,21 @@ module RSpec
         puts report.colored_string
       end
 
+      # :nocov:
+
       # @param report [::Expresenter::Fail] Failed expectation result presenter.
       #
       # @see https://github.com/fixrb/expresenter
       #
-      # @raise [SystemExit] Terminate execution immediately with colored message.
+      # @raise [SystemExit] Terminate execution immediately with 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).
+      # :nocov:
+
+      # 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.

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: r_spec-clone
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-02 00:00:00.000000000 Z
+date: 2022-08-05 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: aw
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: expresenter
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.3.1
 - !ruby/object:Gem::Dependency
   name: test_tube
   requirement: !ruby/object:Gem::Requirement
@@ -202,7 +188,6 @@ files:
 - README.md
 - lib/r_spec.rb
 - lib/r_spec/clone.rb
-- lib/r_spec/clone/console.rb
 - lib/r_spec/clone/dsl.rb
 - lib/r_spec/clone/error.rb
 - lib/r_spec/clone/error/pending_expectation.rb
@@ -217,6 +202,7 @@ files:
 - lib/r_spec/clone/expectation_target/base.rb
 - lib/r_spec/clone/expectation_target/block.rb
 - lib/r_spec/clone/expectation_target/value.rb
+- lib/r_spec/clone/logger.rb
 homepage: https://r-spec.dev/
 licenses:
 - MIT
@@ -234,14 +220,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.5
+      version: 3.0.4
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: A minimalist RSpec clone