r_spec 1.0.0.beta4 → 1.0.0.beta5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d94ad6d7ba01dc04c4bcbe727543524f6a3d83cf69549a34453c1eefc5282e9
-  data.tar.gz: 61b3ebe1299e69d7ef1f2c180325e85e1bda05e2347176ae507fc7430cf311ca
+  metadata.gz: 5df8b9cdb685bc7388fdbdbc0a7de755a3c5c2426e5c6f8346c464562ed16e30
+  data.tar.gz: 9b22d8599741dd00b0a812931cbf4c575acf948b0e4914dd662decc23fd8eea6
 SHA512:
-  metadata.gz: 5d44ce99f58c17711be4b3f76cdfaf3c9923d031aa9a7d214db50b990825673b9bb485ce095195594fbeb45977763dc5a0be31770f089cd17dcb1e3ef1d6885b
-  data.tar.gz: ca64a27f7cf4032b6b073b9fc2eb05aa37654c02a58289c41094e9afa000deccc3886d03d2043642a02e38cf10b6cc0fbd775e7ef9bc1c29cb592b813dcf5d04
+  metadata.gz: 27938ad6a4ab512ef8c564402064188c67bfb40430897f14be5cbd07eefae04bce7bf5709b5a4fbb11f82b4e51b9aaaaa36278ad3ff34cc829fd54a76d643660
+  data.tar.gz: b2ee9bccf5f59bb9d1a0a03d800a8824f643b5875854e57465c640d5eacce8a1ae86a45ccfe42c968921c6587a07d973b1e622bf19ac9e19eee22d906d396f16

data/README.md

@@ -22,7 +22,8 @@ This clone attempts to provide most of RSpec's DSL to express expected outcomes
 * There is no option to activate monkey-patching.
 * It does not rely on hacks such as `at_exit` hook to trigger the tests.
 * Built-in matchers do not trust _actual_ and do not send it messages.
-* The `subject` must be explicitly defined, otherwise it is not implemented.
+* 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.
 * [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.
@@ -45,7 +46,7 @@ Following [RubyGems naming conventions](https://guides.rubygems.org/name-your-ge
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "r_spec", ">= 1.0.0.beta4"
+gem "r_spec", ">= 1.0.0.beta5"
 ```
 
 And then execute:
@@ -227,12 +228,18 @@ __RSpec clone__'s specifications are self-described here: [spec/](https://github
 
 __RSpec clone__ follows [Semantic Versioning 2.0](https://semver.org/).
 
-## Special thanks
+## Special thanks ❤️
 
 I would like to thank the whole [RSpec team](https://rspec.info/about/) for all their work.
 It's a great framework and it's a pleasure to work with every day.
 
-Without RSpec, this clone would not have been possible. ❤️
+Without RSpec, this clone would not have been possible.
+
+## Buy me a coffee ☕
+
+If you like this project please consider making a small donation.
+
+[![Donate with Ethereum](https://github.com/cyril/r_spec.rb/raw/main/img/donate-eth.svg)](https://etherscan.io/address/0x834b5c1feaff5aebf9cd0f25dc38e741d65ab773)
 
 ## License
 

data/lib/r_spec.rb

@@ -9,6 +9,9 @@
 #     it { expect(false).not_to be true }
 #   end
 #
+#   # Output to the console
+#   #   Success: expected false not to be true.
+#
 # @example The basic behavior of arrays
 #   require "r_spec"
 #
@@ -30,6 +33,11 @@
 #     end
 #   end
 #
+#   # Output to the console
+#   #   Success: expected to eq 3.
+#   #   Success: expected true to be true.
+#   #   Success: expected false to be false.
+#
 # @example An inherited definition of let
 #   require "r_spec"
 #
@@ -49,6 +57,10 @@
 #     end
 #   end
 #
+#   # Output to the console
+#   #   Success: expected to be 42.
+#   #   Success: expected to be 43.
+#
 # @api public
 module RSpec
   # Specs are built with this method.

data/lib/r_spec/dsl.rb

@@ -53,9 +53,37 @@ module RSpec
     # Add `context` to the DSL.
     singleton_class.send(:alias_method, :context, :describe)
 
-    # Define a single spec. A spec should contain one or more expectations that
-    # test the state of the code.
+    # Use the `it` method to define a single spec. A spec should contain one or
+    # more expectations that test the state of the code.
     #
+    # @example The integer after 41
+    #   require "r_spec"
+    #
+    #   RSpec.describe Integer do
+    #     it { expect(41.next).to be 42 }
+    #   end
+    #
+    #   # Output to the console
+    #   #   Success: expected to be 42.
+    #
+    # @example A division by zero
+    #   require "r_spec"
+    #
+    #   RSpec.describe Integer do
+    #     subject { 41 }
+    #
+    #     it { is_expected.to be_an_instance_of described_class }
+    #
+    #     it "raises an error" do
+    #       expect { subject / 0 }.to raise_exception ZeroDivisionError
+    #     end
+    #   end
+    #
+    #   # Output to the console
+    #   #   Success: expected 41 to be an instance of Integer.
+    #   #   Success: divided by 0.
+    #
+    # @param _name [String, nil] The name of the spec.
     # @param block [Proc] An expectation to evaluate.
     #
     # @raise (see ExpectationTarget::Base#result)
@@ -69,10 +97,10 @@ module RSpec
       i.instance_eval(&block)
     end
 
-    # Define a single spec. A spec should contain one or more expectations that
-    # test the state of the code.
+    # Use the `its` method to define a single spec that specifies the actual
+    # value of an attribute of the subject using `is_expected`.
     #
-    # @example The value after 41
+    # @example The integer after 41
     #   require "r_spec"
     #
     #   RSpec.describe Integer do
@@ -81,14 +109,35 @@ module RSpec
     #     its(:next) { is_expected.to be 42 }
     #   end
     #
-    # @example Without defining a subject
+    #   # Output to the console
+    #   #   Success: expected to be 42.
+    #
+    # @example A division by zero
     #   require "r_spec"
     #
     #   RSpec.describe Integer do
-    #     its(:next) { is_expected.to raise_exception NameError }
+    #     subject { 41 }
+    #
+    #     its(:/, 0) { is_expected.to raise_exception ZeroDivisionError }
+    #   end
+    #
+    #   # Output to the console
+    #   #   Success: divided by 0.
+    #
+    # @example A spec without subject
+    #   require "r_spec"
+    #
+    #   RSpec.describe Integer do
+    #     its(:boom) { is_expected.to raise_exception RSpec::Error::UndefinedSubject }
     #   end
     #
+    #   # Output to the console
+    #   #   Success: subject not explicitly defined.
+    #
     # @param attribute [String, Symbol] The property to call to subject.
+    # @param args [Array] An optional list of arguments.
+    # @param kwargs [Hash] An optional list of keyword arguments.
+    # @param block [Proc] An expectation to evaluate.
     #
     # @raise (see ExpectationTarget::Base#result)
     # @return (see ExpectationTarget::Base#result)
@@ -128,8 +177,20 @@ module RSpec
     end
 
     private_class_method :it_example, :its_example, :random_test_const_name
+
+    protected
+
+    def described_class
+      raise Error::UndefinedDescribedClass,
+            "the first argument to at least one example group must be a module"
+    end
+
+    def subject
+      raise Error::UndefinedSubject, "subject not explicitly defined"
+    end
   end
 end
 
+require_relative "error"
 require_relative "expectation_helper"
 require_relative "sandbox"

data/lib/r_spec/error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RSpec
+  # Namespace for exceptions.
+  #
+  # @api private
+  module Error
+  end
+end
+
+require_relative File.join("error", "pending_expectation")
+require_relative File.join("error", "undefined_described_class")
+require_relative File.join("error", "undefined_subject")

data/lib/r_spec/error/pending_expectation.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "expresenter"
+
+module RSpec
+  module Error
+    # Exception for pending expectations.
+    #
+    # @api private
+    class PendingExpectation < ::RuntimeError
+      # @param message [String] The not implemented expectation description.
+      #
+      # @return [nil] Write a pending expectation to STDOUT.
+      def self.result(message)
+        warn "  " + ::Expresenter.call(true).with(
+          actual:   new(message),
+          error:    nil,
+          expected: self,
+          got:      false,
+          matcher:  :raise_exception,
+          negate:   true,
+          level:    :SHOULD,
+          valid:    false
+        ).colored_string
+      end
+    end
+  end
+end

data/lib/r_spec/error/undefined_described_class.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Error
+    # Exception for undefined described classes.
+    #
+    # @api private
+    class UndefinedDescribedClass < ::RuntimeError
+    end
+  end
+end

data/lib/r_spec/error/undefined_subject.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Error
+    # Exception for undefined subjects.
+    #
+    # @api private
+    class UndefinedSubject < ::RuntimeError
+    end
+  end
+end

data/lib/r_spec/expectation_helper/base.rb

@@ -2,7 +2,7 @@
 
 require "matchi/rspec"
 
-require_relative File.join("..", "pending")
+require_relative File.join("..", "error", "pending_expectation")
 
 module RSpec
   module ExpectationHelper
@@ -87,9 +87,12 @@ module RSpec
       # @example Output a message to the console and return nil
       #   pending("something else getting finished") # => nil
       #
+      #   # Output to the console
+      #   #   Warning: something else getting finished.
+      #
       # @api public
       def pending(description)
-        Pending.result(description)
+        Error::PendingExpectation.result(description)
       end
     end
   end

data/lib/r_spec/expectation_helper/it.rb

@@ -27,7 +27,7 @@ module RSpec
 
       # Wraps the target of an expectation with the subject as actual value.
       #
-      # @return (see #expect)
+      # @return [Block] The wrapped target of an expectation.
       #
       # @example
       #   is_expected # => #<RSpec::ExpectationTarget::Block:0x00007fb6b8263df8 @callable=#<Proc:0x00007fb6b8263e20>>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r_spec
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta4
+  version: 1.0.0.beta5
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-08 00:00:00.000000000 Z
+date: 2021-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: expresenter
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: matchi-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.2
+        version: 3.3.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.2
+        version: 3.3.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -188,6 +188,10 @@ files:
 - README.md
 - lib/r_spec.rb
 - lib/r_spec/dsl.rb
+- lib/r_spec/error.rb
+- lib/r_spec/error/pending_expectation.rb
+- lib/r_spec/error/undefined_described_class.rb
+- lib/r_spec/error/undefined_subject.rb
 - lib/r_spec/expectation_helper.rb
 - lib/r_spec/expectation_helper/base.rb
 - lib/r_spec/expectation_helper/it.rb
@@ -196,7 +200,6 @@ files:
 - lib/r_spec/expectation_target/base.rb
 - lib/r_spec/expectation_target/block.rb
 - lib/r_spec/expectation_target/value.rb
-- lib/r_spec/pending.rb
 - lib/r_spec/sandbox.rb
 homepage: https://r-spec.dev/
 licenses:

data/lib/r_spec/pending.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require "expresenter"
-
-module RSpec
-  # Exception for pending expectations.
-  #
-  # @api private
-  class Pending < ::NotImplementedError
-    # @param message [String] The not implemented expectation description.
-    #
-    # @return [nil] Write a pending expectation to STDOUT.
-    def self.result(message)
-      warn "  " + ::Expresenter.call(true).with(
-        actual:   new(message),
-        error:    nil,
-        expected: self,
-        got:      false,
-        matcher:  :raise_exception,
-        negate:   true,
-        level:    :SHOULD,
-        valid:    false
-      ).colored_string
-    end
-  end
-end