r_spec-clone 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e923f4f11f83ba71f2c7267393691edf8bf8ea9be1ae3598f57cb637d71c411
-  data.tar.gz: 18d34b05058e5f17eca7c874f03d52fdac54e995858e1531ee5acff77ceed552
+  metadata.gz: 90252cd64a48b7b40aa2424c1c09c69227e45e414ac5fd8d14a53697c0b1c180
+  data.tar.gz: 7eb7211ac34e5dfc2f1f74ae17d354f2704feb41e400d5fada1ccaa764912413
 SHA512:
-  metadata.gz: 80419c1141a6efc61b8f47294d08c8932a416b8c983419a63afdab4bbf8a593d865c37ecb37f84e186459004cd7f807d87d5f99e5625ded0bb8fa885b2ad50d0
-  data.tar.gz: 7796a4e33df45136434543f1f2dc2a0ae32a8d93d61bf11515ab0b8d3df7b300b78bd4f5976c913b777ea75da9500b85389268c51f4851eaf30fbe6012aa25fc
+  metadata.gz: a7fc657a588d0efd081ead62736ddd0f2595e09f0e4db6df235550503325d46cb4814110e16a4fb55244c07de645878d1e08eab40e5ddcc0226b3a64e318091d
+  data.tar.gz: ff205ff80822fea221bbcd27bf8a43925617146be2bf48d0c24d525bbe530921ce6f835530bce0cad53ef6f3e694278b6bd9655dbd4506f3691365cb15ce800a

data/README.md

@@ -67,7 +67,7 @@ A basic spec looks something like this:
 
 ### Anatomy of a spec file
 
-To use the `RSpec` module and its DSL, you need to add `require "r_spec/clone"` to your spec files.
+To use the `RSpec` module and its DSL, you need to add `require "r_spec"` to your spec files.
 Many projects use a custom spec helper which organizes these includes.
 
 Concrete test cases are defined in `it` blocks.

data/lib/r_spec.rb

@@ -5,7 +5,7 @@ require_relative File.join("r_spec", "clone", "dsl")
 # Top level namespace for the RSpec clone.
 #
 # @example The true from the false
-#   require "r_spec/clone"
+#   require "r_spec"
 #
 #   RSpec.describe "The true from the false" do
 #     it { expect(false).not_to be true }
@@ -15,7 +15,7 @@ require_relative File.join("r_spec", "clone", "dsl")
 #   #   Success: expected false not to be true.
 #
 # @example The basic behavior of arrays
-#   require "r_spec/clone"
+#   require "r_spec"
 #
 #   RSpec.describe Array do
 #     describe "#size" do
@@ -41,7 +41,7 @@ require_relative File.join("r_spec", "clone", "dsl")
 #   #   Success: expected false to be false.
 #
 # @example An inherited definition of let
-#   require "r_spec/clone"
+#   require "r_spec"
 #
 #   RSpec.describe Integer do
 #     let(:answer) { 42 }
@@ -69,7 +69,7 @@ module RSpec
   # array_ versus _array with elements_.
   #
   # @example
-  #   require "r_spec/clone"
+  #   require "r_spec"
   #
   #   RSpec.context "when divided by zero" do
   #     subject { 42 / 0 }
@@ -83,30 +83,62 @@ module RSpec
   # @param description [String] A description that usually begins with "when",
   #   "with" or "without".
   # @param block [Proc] The block to define the specs.
-  #
-  # @api public
   def self.context(description, &block)
     Clone::Dsl.context(description, &block)
   end
 
   # :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
-  #   require "r_spec/clone"
+  #   require "r_spec"
+  #
+  #   RSpec.describe String do
+  #     it { expect(described_class).to be String }
+  #   end
+  #
+  #   # Output to the console
+  #   #   Success: expected to be String.
+  #
+  # @example
+  #   require "r_spec"
   #
   #   RSpec.describe String do
+  #     let(:foo) { "foo" }
+  #
   #     describe "+" do
-  #       it("concats") { expect("foo" + "bar").to eq "foobar" }
+  #       it("concats") { expect(foo + "bar").to eq "foobar" }
   #     end
   #   end
   #
@@ -115,20 +147,40 @@ module RSpec
   #
   # @param const [Module, String] A module to include in block context.
   # @param block [Proc] The block to define the specs.
-  #
-  # @api public
   def self.describe(const, &block)
     Clone::Dsl.describe(const, &block)
   end
 
   # :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.
@@ -136,7 +188,7 @@ module RSpec
   # The test is performed by the block supplied to &block.
   #
   # @example The integer after 41
-  #   require "r_spec/clone"
+  #   require "r_spec"
   #
   #   RSpec.it { expect(41.next).to be 42 }
   #
@@ -151,19 +203,19 @@ module RSpec
   #
   # @raise (see RSpec::ExpectationTarget::Base#result)
   # @return (see RSpec::ExpectationTarget::Base#result)
-  #
-  # @api public
   def self.it(name = nil, &block)
     Clone::Dsl.it(name, &block)
   end
 
   # :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
@@ -181,6 +233,7 @@ module RSpec
   def self.it!(name = nil, &block)
     Clone::Dsl.it!(name, &block)
   end
+
   # :nocov:
 
   # Defines a pending test case.
@@ -189,7 +242,7 @@ module RSpec
   # not yet implemented.
   #
   # @example
-  #   require "r_spec/clone"
+  #   require "r_spec"
   #
   #   RSpec.pending "is implemented but waiting" do
   #     expect something to be finished
@@ -207,8 +260,6 @@ module RSpec
   # @param message [String] The reason why the example is pending.
   #
   # @return [nil] Write a message to STDOUT.
-  #
-  # @api public
   def self.pending(message)
     Clone::Dsl.pending(message)
   end

data/lib/r_spec/clone/console.rb

@@ -3,8 +3,6 @@
 module RSpec
   module Clone
     # Send log messages to the console.
-    #
-    # @api private
     module Console
       # @param report [::Expresenter::Pass] Passed expectation result presenter.
       #

data/lib/r_spec/clone/dsl.rb

@@ -16,7 +16,7 @@ module RSpec
       # Executes the given block before each spec in the current context runs.
       #
       # @example
-      #   require "r_spec/clone"
+      #   require "r_spec"
       #
       #   RSpec.describe Integer do
       #     before do
@@ -42,6 +42,8 @@ module RSpec
       #   #   Success: expected to be 123.
       #
       # @param block [Proc] The content to execute at the class initialization.
+      #
+      # @api public
       def self.before(&block)
         define_method(BEFORE_METHOD) do
           super()
@@ -54,7 +56,7 @@ module RSpec
       # Executes the given block after each spec in the current context runs.
       #
       # @example
-      #   require "r_spec/clone"
+      #   require "r_spec"
       #
       #   RSpec.describe Integer do
       #     after do
@@ -69,6 +71,8 @@ module RSpec
       #   #   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)
@@ -81,7 +85,7 @@ module RSpec
       # Sets a user-defined property.
       #
       # @example
-      #   require "r_spec/clone"
+      #   require "r_spec"
       #
       #   RSpec.describe "Name stories" do
       #     let(:name) { "Bob" }
@@ -103,6 +107,8 @@ module RSpec
       # @param block  [Proc] The content of the method to define.
       #
       # @return [Symbol] A private method that define the block content.
+      #
+      # @api public
       def self.let(name, *args, **kwargs, &block)
         raise Error::ReservedMethod if [BEFORE_METHOD, AFTER_METHOD].include?(name.to_sym)
 
@@ -112,7 +118,7 @@ module RSpec
       # Sets a user-defined property named {#subject}.
       #
       # @example
-      #   require "r_spec/clone"
+      #   require "r_spec"
       #
       #   RSpec.describe Array do
       #     subject { [1, 2, 3] }
@@ -120,13 +126,23 @@ module RSpec
       #     it "has the prescribed elements" do
       #       expect(subject).to eq([1, 2, 3])
       #     end
+      #
+      #     it { is_expected.to be_an_instance_of described_class }
+      #
+      #     its(:size) { is_expected.to be 3 }
+      #     its(:downcase) { is_expected.to raise_exception NoMethodError }
       #   end
       #
       #   # Output to the console
       #   #   Success: expected to eq [1, 2, 3].
+      #   #   Success: expected [1, 2, 3] to be an instance of Array.
+      #   #   Success: expected to be 3.
+      #   #   Success: undefined method `downcase' for [1, 2, 3]:Array.
       #
       # @param block [Proc] The subject to set.
       # @return [Symbol] A {#subject} method that define the block content.
+      #
+      # @api public
       def self.subject(&block)
         let(__method__, &block)
       end
@@ -134,7 +150,7 @@ module RSpec
       # Defines an example group that describes a unit to be tested.
       #
       # @example
-      #   require "r_spec/clone"
+      #   require "r_spec"
       #
       #   RSpec.describe String do
       #     describe "+" do
@@ -147,6 +163,8 @@ module RSpec
       #
       # @param const [Module, String] A module to include in block context.
       # @param block [Proc] The block to define the specs.
+      #
+      # @api public
       def self.describe(const, &block)
         desc = ::Class.new(self)
         desc.let(:described_class) { const } if const.is_a?(::Module)
@@ -154,20 +172,53 @@ module RSpec
       end
 
       # :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_.
       #
       # @example
-      #   require "r_spec/clone"
+      #   require "r_spec"
       #
       #   RSpec.describe "web resource" do
       #     context "when resource is not found" do
@@ -186,19 +237,55 @@ module RSpec
       # @param _description [String] A description that usually begins with
       #   "when", "with" or "without".
       # @param block [Proc] The block to define the specs.
+      #
+      # @api public
       def self.context(_description, &block)
         desc = ::Class.new(self)
         desc.instance_eval(&block)
       end
 
       # :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.
@@ -206,7 +293,7 @@ module RSpec
       # The test is performed by the block supplied to `&block`.
       #
       # @example The integer after 41
-      #   require "r_spec/clone"
+      #   require "r_spec"
       #
       #   RSpec.describe Integer do
       #     it { expect(41.next).to be 42 }
@@ -216,7 +303,7 @@ module RSpec
       #   #   Success: expected to be 42.
       #
       # @example A division by zero
-      #   require "r_spec/clone"
+      #   require "r_spec"
       #
       #   RSpec.describe Integer do
       #     subject { 41 }
@@ -239,29 +326,55 @@ module RSpec
       #
       # @raise (see ExpectationTarget::Base#result)
       # @return (see ExpectationTarget::Base#result)
+      #
+      # @api public
       def self.it(_name = nil, &block)
         example = ::Class.new(self) { include ExpectationHelper::It }.new
         run(example, &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) }
       end
+
       # :nocov:
 
       # 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"
+      #   require "r_spec"
       #
       #   RSpec.describe Integer do
       #     subject { 41 }
@@ -273,7 +386,7 @@ module RSpec
       #   #   Success: expected to be 42.
       #
       # @example A division by zero
-      #   require "r_spec/clone"
+      #   require "r_spec"
       #
       #   RSpec.describe Integer do
       #     subject { 41 }
@@ -285,10 +398,10 @@ module RSpec
       #   #   Success: divided by 0.
       #
       # @example A spec without subject
-      #   require "r_spec/clone"
+      #   require "r_spec"
       #
       #   RSpec.describe Integer do
-      #     its(:boom) { is_expected.to raise_exception RSpec::Clone::Error::UndefinedSubject }
+      #     its(:abs) { is_expected.to raise_exception RSpec::Clone::Error::UndefinedSubject }
       #   end
       #
       #   # Output to the console
@@ -301,6 +414,8 @@ module RSpec
       #
       # @raise (see ExpectationTarget::Base#result)
       # @return (see ExpectationTarget::Base#result)
+      #
+      # @api public
       def self.its(attribute, *args, **kwargs, &block)
         example = ::Class.new(self) do
           include ExpectationHelper::Its
@@ -314,17 +429,41 @@ module RSpec
       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) }
       end
+
       # :nocov:
 
       # Defines a pending test case.
@@ -333,7 +472,7 @@ module RSpec
       # is not yet implemented.
       #
       # @example
-      #   require "r_spec/clone"
+      #   require "r_spec"
       #
       #   RSpec.describe "an example" do
       #     pending "is implemented but waiting" do
@@ -379,11 +518,14 @@ module RSpec
 
       private
 
+      # If the first argument to a {.describe} definition is a class (or a
+      # module), this method will be overridden to return it.
       def described_class
         raise Error::UndefinedDescribedClass,
               "the first argument to at least one example group must be a module"
       end
 
+      # If a subject is defined, this method will be overridden to return it.
       def subject
         raise Error::UndefinedSubject, "subject not explicitly defined"
       end

data/lib/r_spec/clone/error.rb

@@ -8,8 +8,6 @@ require_relative File.join("error", "undefined_subject")
 module RSpec
   module Clone
     # Namespace for exceptions.
-    #
-    # @api private
     module Error
     end
   end

data/lib/r_spec/clone/error/pending_expectation.rb

@@ -6,8 +6,6 @@ module RSpec
   module Clone
     module Error
       # Exception for pending expectations.
-      #
-      # @api private
       class PendingExpectation < ::RuntimeError
         # @param message [String] The not implemented expectation description.
         #

data/lib/r_spec/clone/error/reserved_method.rb

@@ -4,8 +4,6 @@ module RSpec
   module Clone
     module Error
       # Exception for reserved methods.
-      #
-      # @api private
       class ReservedMethod < ::RuntimeError
       end
     end

data/lib/r_spec/clone/error/undefined_described_class.rb

@@ -4,8 +4,6 @@ module RSpec
   module Clone
     module Error
       # Exception for undefined described classes.
-      #
-      # @api private
       class UndefinedDescribedClass < ::RuntimeError
       end
     end

data/lib/r_spec/clone/error/undefined_subject.rb

@@ -4,8 +4,6 @@ module RSpec
   module Clone
     module Error
       # Exception for undefined subjects.
-      #
-      # @api private
       class UndefinedSubject < ::RuntimeError
       end
     end

data/lib/r_spec/clone/expectation_target.rb

@@ -6,8 +6,6 @@ require_relative File.join("expectation_target", "value")
 module RSpec
   module Clone
     # Wraps the target of an expectation.
-    #
-    # @api private
     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

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

@@ -63,8 +63,6 @@ module RSpec
         #
         # @raise [SystemExit] Terminate execution immediately by calling
         #   `Kernel.exit(false)` with a failure message written to STDERR.
-        #
-        # @api private
         def result(passed, actual:, error:, got:, matcher:, negate:)
           Console.passed_spec ::Expresenter.call(passed).with(
             actual:   actual,

metadata

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