r_spec-clone 1.3.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8475d853643279af5a0a255bf7b3fd5b4547f4dd596bc044fa37a5ac2d69ff0
-  data.tar.gz: 3d22158ee01cb6f0e4924bd57345225e35d40920b2bffaf0cf862575db4b62ca
+  metadata.gz: d2e7a16588ed11ac0ab9cd7eebcb01c3d6e914d351c5041cfbed6015c88128ea
+  data.tar.gz: 96dfc31819a59b319c06c777a63aa09daf5630a3db7cf5860c59474b1809f94c
 SHA512:
-  metadata.gz: 2f6826b996db0d6b3f727a7bc16b7757f7fc1ae350ca2285cf81aaf4ce8bfb15f0c37a8910bb2413800821524109cd6c655275aa2b800f52ba25aba1c31c9ac7
-  data.tar.gz: 53b85ef4eb8b249cdf2f717de35a6c29916c65d28a125e28656e300a5bfb7263d62865fba6d53a2517ae035cf64daa0c2b7b04a82ecaca93903502b0f5c2a59d
+  metadata.gz: f34d7820173f21ffdafe71d206314aee90904ab7b9a46c29511aed5e4191742e87a14ef2e9da512e48917c080c97d52b5618ce545519f49955fb3edc6b20022d
+  data.tar.gz: d2ad326e9150e95b19f9f62994568e5a44474b6567727e15c38020ede970f1c20b4bd0ddc1d1ab450f968fedfd109ed795accda5724b0424ef666fe09e31e92c

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2021 Cyril Kato
+Copyright (c) 2015-2022 Cyril Kato
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -32,7 +32,8 @@ 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.
-* Runs much faster.
+* 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.
 
 ## Installation
 
@@ -72,9 +73,10 @@ To use the `RSpec` module and its DSL, you need to add `require "r_spec"` to you
 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.
+An optional (but recommended) descriptive string or module indicates the purpose of the test and a block contains the main logic of 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.
+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.
@@ -96,28 +98,7 @@ 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.
 
-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:
-
-```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".
-```
-
-Note: if you are wondering what the Ruby code generated by using the DSL might look like, an article presents the correspondence between each method via simple examples, available in [English](https://dev.to/cyri_/what-ruby-code-to-expect-from-a-testing-dsl-4oe1), [Chinese](https://ruby-china.org/topics/41441) and [Japanese](https://qiita.com/cyril/items/17ee758e162bae144a07).
+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
 
@@ -137,6 +118,12 @@ expect(actual).to equal(expected) # passes if expected.equal?(actual)
 expect(actual).to be(expected)    # passes if expected.equal?(actual)
 ```
 
+#### Comparisons
+
+```ruby
+expect(actual).to be_within(delta).of(expected) # passes if (expected - actual).abs <= delta
+```
+
 #### Regular expressions
 
 ```ruby
@@ -174,9 +161,24 @@ expect(actual).to be_instance_of(expected)    # passes if expected.equal?(actual
 expect(actual).to be_an_instance_of(expected) # passes if expected.equal?(actual.class)
 ```
 
+#### Predicate
+
+```ruby
+expect(actual).to be_xxx            # passes if actual.xxx?
+expect(actual).to be_have_xxx(:yyy) # passes if actual.has_xxx?(:yyy)
+```
+
+##### Examples
+
+```ruby
+expect([]).to be_empty
+expect(foo: 1).to have_key(:foo)
+```
+
 #### Change
 
 ```ruby
+expect { object.action }.to change(object, :value).to(new)
 expect { object.action }.to change(object, :value).from(old).to(new)
 expect { object.action }.to change(object, :value).by(delta)
 expect { object.action }.to change(object, :value).by_at_least(minimum_delta)
@@ -263,7 +265,7 @@ Benchmark against [100 executions of a file containing 1 expectation](https://gi
 
 ### Runtime
 
-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).
+Benchmark against [1 execution of a file containing 100,000 expectations](https://github.com/cyril/r_spec-clone.rb/blob/main/benchmark/run_time/) (lower is better).
 
 ![Runtime benchmark](https://r-spec.dev/benchmark-run-time.svg)
 
@@ -275,7 +277,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)
+* Blog post: [https://cyrilllllll.medium.com/introducing-a-new-rspec-850d48c0f901](https://cyrilllllll.medium.com/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\_)
@@ -289,9 +291,9 @@ Without RSpec, this clone would not have been possible.
 
 ## Buy me a coffee ☕
 
-If you like this project, please consider making a small donation to Batman.
+If you like this project, please consider making a small donation.
 
-[![Donate](https://img.shields.io/badge/Donate-batman.eth-purple.svg)](https://etherscan.io/address/batman.eth)
+[![Donate](https://img.shields.io/badge/Donate-cyr.eth-purple.svg)](https://etherscan.io/address/cyr.eth)
 
 ## Versioning
 

data/lib/r_spec/clone/dsl.rb

@@ -173,47 +173,6 @@ module RSpec
 
       # :nocov:
 
-      # Runs a describe example group in a subprocess to isolate side effects.
-      #
-      # @example
-      #   $app = "foo"
-      #
-      #   require "r_spec"
-      #
-      #   RSpec.describe "Scoped side effects" do
-      #     describe! "#gsub!" do
-      #       before do
-      #         $app.gsub!("o", "0")
-      #       end
-      #
-      #       context! "when isolated in the context" do
-      #         before do
-      #           $app.gsub!("f", "F")
-      #         end
-      #
-      #         it { expect($app).to eq "F00" }
-      #       end
-      #
-      #       it { expect($app).to eq "f00" }
-      #     end
-      #
-      #     it { expect($app).to eq "foo" }
-      #   end
-      #
-      #   # Output to the console
-      #   #   Success: expected to eq "F00".
-      #   #   Success: expected to eq "f00".
-      #   #   Success: expected to eq "foo".
-      #
-      # @param (see #describe)
-      #
-      # @api public
-      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_.
       #
@@ -246,48 +205,6 @@ module RSpec
 
       # :nocov:
 
-      # Runs a context example group in a subprocess to isolate side effects.
-      #
-      # @example
-      #   app = "Hello, world!"
-      #
-      #   require "r_spec"
-      #
-      #   RSpec.describe String do
-      #     subject do
-      #       app
-      #     end
-      #
-      #     before do
-      #       subject.gsub!("world", person)
-      #     end
-      #
-      #     context! "when Alice is greeted" do
-      #       let(:person) { "Alice" }
-      #
-      #       it { is_expected.to eq "Hello, Alice!" }
-      #     end
-      #
-      #     context! "when Bob is greeted" do
-      #       let(:person) { "Bob" }
-      #
-      #       it { is_expected.to eq "Hello, Bob!" }
-      #     end
-      #   end
-      #
-      #   # Output to the console
-      #   #   Success: expected to eq "Hello, Alice!".
-      #   #   Success: expected to eq "Hello, Bob!".
-      #
-      # @param (see #context)
-      #
-      # @api public
-      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`.
@@ -329,42 +246,7 @@ module RSpec
       #
       # @api public
       def self.it(_name = nil, &block)
-        run(example_without_attribute.new, &block)
-      end
-
-      # :nocov:
-
-      # Runs a concrete test case in a subprocess to isolate side effects.
-      #
-      # @example
-      #   app = "foo"
-      #
-      #   require "r_spec"
-      #
-      #   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
-      #
-      #   # Output to the console
-      #   #   Success: expected to eq "bar".
-      #   #   Success: expected to eq "bar".
-      #   #   Success: expected to eq "foo".
-      #
-      # @param (see #it)
-      #
-      # @raise (see ExpectationTarget::Base#result)
-      # @return (see ExpectationTarget::Base#result)
-      #
-      # @api public
-      def self.it!(name = nil, &block)
-        fork! { it(name, &block) }
+        exit false unless ::Aw.fork? { run(example_without_attribute.new, &block) }
       end
 
       # :nocov:
@@ -416,43 +298,7 @@ module RSpec
       #
       # @api public
       def self.its(attribute, *args, **kwargs, &block)
-        run(example_with_attribute(attribute, *args, **kwargs).new, &block)
-      end
-
-      # :nocov:
-
-      # Runs a single concrete test case in a subprocess to isolate side
-      # effects.
-      #
-      # @example
-      #   app = "foo"
-      #
-      #   require "r_spec"
-      #
-      #   RSpec.describe "Isolated side effect" do
-      #     subject do
-      #       app
-      #     end
-      #
-      #     its!(:upcase) { is_expected.to eq "FOO" }
-      #
-      #     it "tests the original value" do
-      #       expect(app).to eq "foo"
-      #     end
-      #   end
-      #
-      #   # Output to the console
-      #   #   Success: expected to eq "FOO".
-      #   #   Success: expected to eq "foo".
-      #
-      # @param (see #it)
-      #
-      # @raise (see ExpectationTarget::Base#result)
-      # @return (see ExpectationTarget::Base#result)
-      #
-      # @api public
-      def self.its!(attribute, *args, **kwargs, &block)
-        fork! { its(attribute, *args, **kwargs, &block) }
+        exit false unless ::Aw.fork? { run(example_with_attribute(attribute, *args, **kwargs).new, &block) }
       end
 
       # :nocov:
@@ -505,26 +351,15 @@ module RSpec
         end
       end
 
-      # Creates a subprocess and runs the block inside.
-      def self.fork!(&block)
-        pid = fork(&block)
-        thread = ::Process.detach(pid)
-        exitstatus = thread.join.value.exitstatus
-        exit false unless exitstatus.zero?
-      end
-
       # Execution of specifications.
       def self.run(example, &block)
-        example.instance_eval(&block)
-      rescue ::SystemExit
         Console.source(*block.source_location)
-
-        exit false
+        exit false unless ::Aw.fork? { example.instance_eval(&block) }
       ensure
         example&.send(AFTER_METHOD)
       end
 
-      private_class_method :example_without_attribute, :example_with_attribute, :fork!, :run
+      private_class_method :example_without_attribute, :example_with_attribute, :run
 
       private
 

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

@@ -19,7 +19,7 @@ module RSpec
         #
         # @example
         #   expect("foo") # => #<RSpec::Clone::ExpectationTarget::Value:0x00007f @actual="foo">
-        #   expect { Boom } # => #<RSpec::Clone::ExpectationTarget::Block:0x00007f @callable=#<Proc:0x00007f>>
+        #   expect { RSpec::Clone::Boom! } # => #<RSpec::Clone::ExpectationTarget::Block:0x... @callable=#<Proc:0x...>>
         #
         # @api public
         def expect(value = self.class.superclass, &block)

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

@@ -51,6 +51,22 @@ module RSpec
 
         alias equal be
 
+        # Comparisons matcher
+        #
+        # @example
+        #   matcher = be_within(1).of(41)
+        #   matcher.matches? { 42 } # => true
+        #   matcher.matches? { 43 } # => false
+        #
+        # @param delta [Numeric] A numeric value.
+        #
+        # @return [#matches?] A comparison matcher.
+        #
+        # @api public
+        def be_within(delta)
+          ::Matchi::BeWithin.new(delta)
+        end
+
         # Regular expressions matcher
         #
         # @example
@@ -71,7 +87,7 @@ module RSpec
         #
         # @example
         #   matcher = raise_exception(NameError)
-        #   matcher.matches? { Boom } # => true
+        #   matcher.matches? { RSpec::Clone::Boom! } # => true
         #   matcher.matches? { true } # => false
         #
         # @param expected [Exception, #to_s] The expected exception name.
@@ -196,6 +212,38 @@ module RSpec
         def satisfy(&expected)
           ::Matchi::Satisfy.new(&expected)
         end
+
+        private
+
+        # Predicate matcher, or default method missing behavior.
+        #
+        # @example Empty predicate matcher
+        #   matcher = be_empty
+        #   matcher.matches? { [] } # => true
+        #   matcher.matches? { [4] } # => false
+        def method_missing(name, *args, **kwargs, &block)
+          return super unless predicate_matcher_name?(name)
+
+          ::Matchi::Predicate.new(name, *args, **kwargs, &block)
+        end
+
+        # :nocov:
+
+        # Hook method to return whether the obj can respond to id method or not.
+        def respond_to_missing?(name, include_private = false)
+          predicate_matcher_name?(name) || super
+        end
+
+        # :nocov:
+
+        # Predicate matcher name detector.
+        #
+        # @param name [Array, Symbol] The name of a potential predicate matcher.
+        #
+        # @return [Boolean] Indicates if it is a predicate matcher name or not.
+        def predicate_matcher_name?(name)
+          name.start_with?("be_", "have_") && !name.end_with?("!", "?")
+        end
       end
     end
   end

data/lib/r_spec.rb

@@ -89,36 +89,6 @@ module RSpec
 
   # :nocov:
 
-  # Runs a context example group in a subprocess to isolate side effects.
-  #
-  # @example
-  #   str = "Hello, world!"
-  #
-  #   require "r_spec"
-  #
-  #   RSpec.context! "when a string becomes uppercase" do
-  #     before do
-  #       str.upcase!
-  #     end
-  #
-  #     it { expect(str).to eq "HELLO, WORLD!" }
-  #   end
-  #
-  #   # Output to the console
-  #   #   Success: expected to eq "HELLO, WORLD!".
-  #
-  #   RSpec.it { expect(str).to eq "Hello, world!" }
-  #
-  #   # Output to the console
-  #   #   Success: expected to eq "Hello, world!".
-  #
-  # @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
@@ -153,36 +123,6 @@ module RSpec
 
   # :nocov:
 
-  # Runs a describe example group in a subprocess to isolate side effects.
-  #
-  # @example
-  #   $app = "foo"
-  #
-  #   require "r_spec"
-  #
-  #   RSpec.describe! "#gsub!" do
-  #     before do
-  #       $app.gsub!("o", "0")
-  #     end
-  #
-  #     it { expect($app).to eq "f00" }
-  #   end
-  #
-  #   # Output to the console
-  #   #   Success: expected to eq "f00".
-  #
-  #   RSpec.it { expect($app).to eq "foo" }
-  #
-  #   # Output to the console
-  #   #   Success: expected to eq "foo".
-  #
-  # @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.
@@ -209,33 +149,6 @@ module RSpec
 
   # :nocov:
 
-  # Runs a concrete test case in a subprocess to isolate side effects.
-  #
-  # @example
-  #   app = "Hello, world!"
-  #
-  #   require "r_spec"
-  #
-  #   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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: r_spec-clone
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-23 00:00:00.000000000 Z
+date: 2022-04-02 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
@@ -30,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.1
+        version: 3.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.1
+        version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: test_tube
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.1.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -211,6 +225,7 @@ metadata:
   documentation_uri: https://rubydoc.info/gems/r_spec-clone
   source_code_uri: https://github.com/cyril/r_spec-clone.rb
   wiki_uri: https://github.com/cyril/r_spec-clone.rb/wiki
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -219,7 +234,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 2.7.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="