r_spec-clone 1.7.2 → 2.0.0

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

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require "matchi"
+
+module RSpec
+  module Clone
+    module ExpectationHelper
+      # The matchers of an example, as words: each one builds a matcher of
+      # Matchi, which raises `ArgumentError` for an argument it refuses. The
+      # expected value is always the one that receives the comparison, so
+      # that the actual value cannot vouch for itself.
+      #
+      # @see https://github.com/fixrb/matchi
+      module Matcher
+        # @param expected [Object] the expected value
+        # @return [Matchi::Eq] `eql?` to the expected value, of its class
+        def eq(expected)
+          ::Matchi::Eq.new(expected)
+        end
+
+        alias eql eq
+
+        # @param expected [Object] the expected object
+        # @return [Matchi::Be] the very same object
+        def be(expected)
+          ::Matchi::Be.new(expected)
+        end
+
+        alias equal be
+
+        # @param delta [Numeric] the tolerance
+        # @return [Matchi::BeWithin] to complete with `of(expected)`
+        def be_within(delta)
+          ::Matchi::BeWithin.new(delta)
+        end
+
+        # @param expected [Regexp] the pattern
+        # @return [Matchi::Match] a String or a Symbol matching the pattern
+        def match(expected)
+          ::Matchi::Match.new(expected)
+        end
+
+        # @param expected [Class, String, Symbol] the exception class, or its name
+        # @param message [String, Regexp, nil] the expected message
+        # @return [Matchi::RaiseException] raising that exception
+        def raise_exception(expected, message = nil)
+          ::Matchi::RaiseException.new(expected, message)
+        end
+
+        # @return [Matchi::Be] `true` itself
+        def be_true
+          ::Matchi::Be.new(true)
+        end
+
+        # @return [Matchi::Be] `false` itself
+        def be_false
+          ::Matchi::Be.new(false)
+        end
+
+        # @return [Matchi::Be] `nil` itself
+        def be_nil
+          ::Matchi::Be.new(nil)
+        end
+
+        # @param expected [Class, String, Symbol] the class, or its name
+        # @return [Matchi::BeAnInstanceOf] an instance of that very class
+        def be_an_instance_of(expected)
+          ::Matchi::BeAnInstanceOf.new(expected)
+        end
+
+        # @param expected [Module, String, Symbol] the module, or its name
+        # @return [Matchi::BeAKindOf] an instance of that module or of a descendant
+        def be_a_kind_of(expected)
+          ::Matchi::BeAKindOf.new(expected)
+        end
+
+        # @param object [Object] the object to observe
+        # @param method [Symbol, String] the method whose value may change,
+        #   followed by its arguments and its block
+        # @return [Matchi::Change] a change, or one to refine with `by`,
+        #   `by_at_least`, `by_at_most`, `from … to` or `to`
+        def change(object, method, ...)
+          ::Matchi::Change.new(object, method, ...)
+        end
+
+        # @yieldparam value [Object] the actual value
+        # @yieldreturn [Boolean] whether it satisfies the block
+        # @return [Matchi::Satisfy]
+        def satisfy(&)
+          ::Matchi::Satisfy.new(&)
+        end
+
+        private
+
+        # A predicate matcher for a name that starts with `be_` or `have_`:
+        # `be_empty` asks `empty?`, `have_key(:a)` asks `has_key?(:a)`.
+        def method_missing(name, ...)
+          return super unless predicate?(name)
+
+          ::Matchi::Predicate.new(name, ...)
+        end
+
+        def respond_to_missing?(name, include_private = false)
+          predicate?(name) || super
+        end
+
+        # Whether a name is the one of a predicate matcher, as Matchi
+        # accepts it.
+        def predicate?(name)
+          ::Matchi::Predicate::NAME.match?(name)
+        end
+      end
+    end
+  end
+end

data/lib/r_spec/clone/expectation_helper.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 require_relative File.join("expectation_helper", "it")
-require_relative File.join("expectation_helper", "its")
+require_relative File.join("expectation_helper", "matcher")
 
 module RSpec
   module Clone
-    # Namespace for {Dsl.it} and {Dsl.its}'s helper modules.
+    # The words an example can use, prepended to its class: {It} by
+    # {Dsl.it}, {Matcher} by {Dsl.its}, which adds `is_expected` itself.
     module ExpectationHelper
     end
   end

data/lib/r_spec/clone/expectation_target.rb

@@ -1,29 +1,61 @@
 # frozen_string_literal: true
 
-require_relative File.join("expectation_target", "block")
-require_relative File.join("expectation_target", "value")
+require "spectus"
+
+require_relative "report"
 
 module RSpec
   module Clone
-    # Wraps the target of an expectation.
-    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 valid value to pass.
-      # @param value [#object_id, nil] An actual value.
-      # @param block [#call, nil] A code to evaluate.
+    # The target of an expectation: what `expect` wraps, judged by `to` or
+    # `not_to` with a matcher. Every expectation is a MUST of Spectus: the
+    # block is called in the requirement, where what it returns or raises
+    # is kept for the matcher, and the result is written at once.
+    class ExpectationTarget
+      # @param callable [#call] gives the actual value: the block of
+      #   `expect { … }`, or a lambda holding the value of `expect(…)`
+      def initialize(callable)
+        @callable = callable
+      end
+
+      # Passes when the matcher matches the actual value.
+      #
+      # @example
+      #   expect { "foo".upcase }.to eq("FOO")
+      #
+      # @param matcher [#match?] the matcher
+      # @return [nil]
+      # @raise [ArgumentError] when the matcher does not respond to `match?`
+      # @raise [TypeError] when the `to_s` of the matcher is not a String
+      # @raise [SystemExit] when the expectation is not met
+      def to(matcher)
+        judge(::Spectus.must(matcher))
+      end
+
+      # Passes when the matcher does not match the actual value.
+      #
+      # @example
+      #   expect { "foo".size }.not_to be(4)
       #
-      # @return [Block, Value] The wrapped target of an expectation.
-      def self.call(undefined_value, value, block)
-        if undefined_value.equal?(value)
-          raise ::ArgumentError, "Pass either an argument or a block" unless block
+      # @param (see #to)
+      # @return (see #to)
+      # @raise (see #to)
+      def not_to(matcher)
+        judge(::Spectus.must_not(matcher))
+      end
+
+      private
 
-          Block.new(block)
-        else
-          raise ::ArgumentError, "Can't pass both an argument and a block" if block
+      # Judges the actual value, and writes the result where the expectation
+      # is written: the caller of `to` or `not_to`. A process the block
+      # forked and let run on, instead of ending it with exit!, is not the
+      # one that writes: it leaves here without a word.
+      def judge(requirement)
+        location = Report.location
+        pid = ::Process.pid
+        result = requirement.call(&@callable)
+        ::Process.exit! unless ::Process.pid == pid
 
-          Value.new(value)
-        end
+        Report.result(location, result)
       end
     end
   end

data/lib/r_spec/clone/report.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "defi"
+require "matchi"
+require "spectus"
+
+module RSpec
+  module Clone
+    # Writes what happened, one line each: `file:line: Outcome: summary`,
+    # as Spectus says it. A met expectation goes to the standard output; one
+    # that is not met goes to the standard error and ends the process with
+    # the status 1, since the rest of the file would run on a false premise.
+    module Report
+      # The lib directories of the clone and of the gems it runs, each found
+      # by a method of its own, not by the name of a file, which another
+      # file could bear, nor by the first file that opened its module, which
+      # a spec could be: their frames are left out of the backtrace of an
+      # error.
+      LIBRARIES = ([
+        ::Defi::Challenge.instance_method(:to).source_location,
+        ::Matchi::Be.instance_method(:match?).source_location,
+        ::Spectus::Requirement.instance_method(:call).source_location
+      ].map { |location| "#{::File.expand_path("../..", location.fetch(0))}/" } << "#{::File.expand_path("../..", __dir__)}/").freeze
+
+      private_constant :LIBRARIES
+
+      # Writes the result of an expectation.
+      #
+      # @param location [String] `file:line`, where the expectation is written
+      # @param result [Spectus::Result] how it went
+      # @return [nil]
+      # @raise [SystemExit] when the expectation is not met, after writing it
+      def self.result(location, result)
+        lines = ["#{location}: #{result}".gsub(/\R/) { "\\n" }]
+        frames = result.backtrace || []
+        frames.each { |frame| lines << "  #{frame.gsub(/\R/) { "\\n" }}" unless frame.start_with?(*LIBRARIES) }
+        return $stdout.puts(lines) if result.passed?
+
+        $stdout.flush
+        abort(lines.join("\n"))
+      end
+
+      # Writes a pending example.
+      #
+      # @param location [String] `file:line`, where the example is written
+      # @param message [String] why it is pending, written as valid UTF-8
+      # @return [nil]
+      def self.pending(location, message)
+        message = message.to_s.encode(::Encoding::UTF_8, invalid: :replace, undef: :replace)
+        $stdout.puts("#{location}: Pending: #{message}".gsub(/\R/) { "\\n" })
+      end
+
+      # Where the spec is: the first frame of the caller that is not in the
+      # clone's own files, as `file:line`, the file relative to the current
+      # directory when it is under it, as valid UTF-8.
+      #
+      # @return [String]
+      def self.location
+        frame = caller_locations.find { |location| !location.path.start_with?(LIBRARIES.last) }
+        path = ::File.absolute_path(frame.path).delete_prefix(::File.join(::Dir.pwd, ""))
+        "#{path}:#{frame.lineno}".encode(::Encoding::UTF_8, invalid: :replace, undef: :replace)
+      end
+    end
+  end
+end

data/lib/r_spec/clone.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
 module RSpec
-  # Clone namespace.
-  #
-  # @api private
+  # The clone itself: the language, the examples and the report.
   module Clone
   end
 end

data/lib/r_spec.rb

@@ -2,71 +2,33 @@
 
 require_relative File.join("r_spec", "clone", "dsl")
 
-# Top level namespace for the RSpec clone.
+# The namespace of RSpec, which the clone takes for its words: `describe`,
+# `context`, `it` and `pending`, at the top level of a spec file.
 #
-# @example The true from the false
-#   require "r_spec"
-#
-#   RSpec.describe "The true from the false" do
-#     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
+# @example
 #   require "r_spec"
 #
 #   RSpec.describe Array do
 #     describe "#size" do
-#       it "correctly reports the number of elements in the Array" do
+#       it "reports the number of elements" do
 #         expect([1, 2, 3].size).to eq 3
 #       end
 #     end
 #
 #     describe "#empty?" do
-#       it "is empty when no elements are in the array" do
+#       it "is true when the array holds nothing" do
 #         expect([].empty?).to be_true
 #       end
-#
-#       it "is not empty if there are elements in the array" do
-#         expect([1].empty?).to be_false
-#       end
 #     end
 #   end
 #
-#   # Output to the console
-#   #   Success: expected to eq 3.
-#   #   Success: expected to be true.
-#   #   Success: expected to be false.
-#
-# @example An inherited definition of let
-#   require "r_spec"
-#
-#   RSpec.describe Integer do
-#     let(:answer) { 42 }
-#
-#     it "returns the value" do
-#       expect(answer).to be(42)
-#     end
-#
-#     context "when the number is incremented" do
-#       let(:answer) { super().next }
-#
-#       it "returns the next value" do
-#         expect(answer).to be(43)
-#       end
-#     end
-#   end
-#
-#   # Output to the console
-#   #   Success: expected to be 42.
-#   #   Success: expected to be 43.
+#   # spec/array_spec.rb:6: Success: expected 3 to eq 3
+#   # spec/array_spec.rb:12: Success: expected true to be true
 #
 # @api public
 module RSpec
-  # Defines an example group that establishes a specific context, like _empty
-  # array_ versus _array with elements_.
+  # Defines an example group that establishes a context, like _empty array_
+  # versus _array with elements_, and runs it in a child process.
   #
   # @example
   #   require "r_spec"
@@ -77,18 +39,19 @@ module RSpec
   #     it { is_expected.to raise_exception ZeroDivisionError }
   #   end
   #
-  #   # Output to the console
-  #   #   Success: divided by 0.
+  #   # spec/zero_spec.rb:6: Success: expected #<ZeroDivisionError: divided by 0> to raise exception ZeroDivisionError
   #
-  # @param description [String] A description that usually begins with "when",
-  #   "with" or "without".
-  # @param block [Proc] The block to define the specs.
+  # @param description [String] a description, usually beginning with "when",
+  #   "with" or "without"
+  # @yield the specs of the context
+  # @return [nil]
+  # @raise [ArgumentError] without a block
+  # @raise [NotImplementedError] when this Ruby cannot fork
+  # @raise [SystemExit] when a spec of the context did not succeed
   def self.context(description, &)
     Clone::Dsl.context(description, &)
   end
 
-  # :nocov:
-
   # Defines an example group that describes a unit to be tested.
   #
   # @example
@@ -98,82 +61,47 @@ module RSpec
   #     it { expect(described_class).to be String }
   #   end
   #
-  #   # Output to the console
-  #   #   Success: expected to be String.
+  #   # spec/string_spec.rb:4: Success: expected String to be String
   #
-  # @example
-  #   require "r_spec"
-  #
-  #   RSpec.describe String do
-  #     let(:foo) { "foo" }
-  #
-  #     describe "+" do
-  #       it("concats") { expect(foo + "bar").to eq "foobar" }
-  #     end
-  #   end
-  #
-  #   # Output to the console
-  #   #   Success: expected to eq "foobar".
-  #
-  # @param const [Module, String] A module to include in block context.
-  # @param block [Proc] The block to define the specs.
+  # @param const [Module, String] the module under test, or a description
+  # @yield the specs of the group
+  # @return [nil]
+  # @raise [ArgumentError] without a block
   def self.describe(const, &)
     Clone::Dsl.describe(const, &)
   end
 
-  # :nocov:
-
   # Defines a concrete test case.
   #
-  # The test is performed by the block supplied to &block.
-  #
-  # @example The integer after 41
+  # @example
   #   require "r_spec"
   #
   #   RSpec.it { expect(41.next).to be 42 }
   #
-  #   # Output to the console
-  #   #   Success: expected to be 42.
-  #
-  # It is usually used inside a {Clone::Dsl.describe} or {Clone::Dsl.context}
-  # section.
-  #
-  # @param name [String, nil] The name of the spec.
-  # @param block [Proc] An expectation to evaluate.
+  #   # spec/next_spec.rb:3: Success: expected 42 to be 42
   #
-  # @raise (see RSpec::Clone::ExpectationTarget::Base#result)
-  # @return (see RSpec::Clone::ExpectationTarget::Base#result)
+  # @param name [String, nil] the name of the example
+  # @yield the example, with its expectations
+  # @return [nil]
+  # @raise [ArgumentError] without a block
+  # @raise [SystemExit] when an expectation is not met
   def self.it(name = nil, &)
     Clone::Dsl.it(name, &)
   end
 
-  # :nocov:
-
-  # Defines a pending test case.
-  #
-  # `&block` is never evaluated. It can be used to describe behaviour that is
-  # not yet implemented.
+  # Defines a pending test case: its block, if any, is never run.
   #
   # @example
   #   require "r_spec"
   #
-  #   RSpec.pending "is implemented but waiting" do
-  #     expect something to be finished
-  #   end
-  #
-  #   RSpec.pending "is not yet implemented and waiting"
-  #
-  #   # Output to the console
-  #   #   Warning: is implemented but waiting.
-  #   #   Warning: is not yet implemented and waiting.
-  #
-  # It is usually used inside a {Clone::Dsl.describe} or {Clone::Dsl.context}
-  # section.
+  #   RSpec.pending "is not yet implemented"
   #
-  # @param message [String] The reason why the example is pending.
+  #   # spec/later_spec.rb:3: Pending: is not yet implemented
   #
-  # @return [nil] Write a message to STDOUT.
-  def self.pending(message)
-    Clone::Dsl.pending(message)
+  # @param message [String] why the example is pending
+  # @yield never: the block is not run
+  # @return [nil]
+  def self.pending(message, &)
+    Clone::Dsl.pending(message, &)
   end
 end

metadata

@@ -1,58 +1,59 @@
 --- !ruby/object:Gem::Specification
 name: r_spec-clone
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Cyril Kato
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-30 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: expresenter
+  name: defi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: matchi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: test_tube
+  name: spectus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
-description: A minimalist RSpec clone with all the essentials.
+        version: '6.0'
+description: 'The essentials of RSpec, with fewer surprises: no monkey patch, no at_exit
+  hook, no memoization, a child process per context, and the expected value always
+  on the receiving end of a comparison. Built on the testing libraries of Fixrb.'
 email: contact@cyril.email
 executables: []
 extensions: []
@@ -64,29 +65,20 @@ files:
 - lib/r_spec/clone.rb
 - lib/r_spec/clone/dsl.rb
 - lib/r_spec/clone/error.rb
-- lib/r_spec/clone/error/pending_expectation.rb
-- lib/r_spec/clone/error/reserved_method.rb
-- lib/r_spec/clone/error/undefined_described_class.rb
-- lib/r_spec/clone/error/undefined_subject.rb
 - lib/r_spec/clone/expectation_helper.rb
 - lib/r_spec/clone/expectation_helper/it.rb
-- lib/r_spec/clone/expectation_helper/its.rb
-- lib/r_spec/clone/expectation_helper/shared.rb
+- lib/r_spec/clone/expectation_helper/matcher.rb
 - lib/r_spec/clone/expectation_target.rb
-- 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/
+- lib/r_spec/clone/report.rb
+homepage: https://github.com/cyril/r_spec-clone.rb
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/cyril/r_spec-clone.rb/issues
+  changelog_uri: https://github.com/cyril/r_spec-clone.rb#changes-in-20
   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:
+  source_code_uri: https://github.com/cyril/r_spec-clone.rb
 rdoc_options: []
 require_paths:
 - lib
@@ -94,15 +86,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.4
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 4.0.23
 specification_version: 4
 summary: A minimalist RSpec clone
 test_files: []

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

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require "expresenter"
-
-module RSpec
-  module Clone
-    module Error
-      # Exception for pending expectations.
-      class PendingExpectation < ::RuntimeError
-        # @param message [String] The not implemented expectation description.
-        #
-        # @return [nil] Write a pending expectation to STDOUT.
-        def self.result(message)
-          ::Expresenter.call(true).with(
-            actual:     new(message),
-            definition: "raise exception #{self}",
-            error:      nil,
-            got:        false,
-            negate:     true,
-            level:      :SHOULD
-          )
-        end
-      end
-    end
-  end
-end

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

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module RSpec
-  module Clone
-    module Error
-      # Exception for reserved methods.
-      class ReservedMethod < ::RuntimeError
-      end
-    end
-  end
-end

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

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