r_spec-clone 1.7.2 → 2.0.0

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

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

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

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "shared"
-require_relative File.join("..", "expectation_target", "block")
-
-module RSpec
-  module Clone
-    module ExpectationHelper
-      # {RSpec::Clone::Dsl.its}'s expectation helper module.
-      module Its
-        include Shared
-
-        # Wraps the target of an expectation with the actual value.
-        #
-        # @return [Block] The wrapped target of an expectation.
-        #
-        # @example
-        #   is_expected # => #<RSpec::Clone::ExpectationTarget::Block:0x00007f @callable=#<Proc:0x00007f>>
-        #
-        # @api public
-        def is_expected
-          ExpectationTarget::Block.new(method(:actual))
-        end
-      end
-    end
-  end
-end

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

@@ -1,250 +0,0 @@
-# frozen_string_literal: true
-
-require "matchi"
-
-module RSpec
-  module Clone
-    module ExpectationHelper
-      # Abstract expectation helper base module.
-      #
-      # This module defines a number of methods to create expectations, which
-      # are automatically included into examples.
-      #
-      # It also includes a collection of expectation matchers.
-      #
-      # @see https://github.com/fixrb/matchi
-      module Shared
-        # Equivalence matcher
-        #
-        # @example
-        #   matcher = eq("foo")
-        #   matcher.match? { "foo" } # => true
-        #   matcher.match? { "bar" } # => false
-        #
-        # @param expected [#eql?] An expected equivalent object.
-        #
-        # @return [#match?] An equivalence matcher.
-        #
-        # @api public
-        def eq(expected)
-          ::Matchi::Eq.new(expected)
-        end
-
-        alias eql eq
-
-        # Identity matcher
-        #
-        # @example
-        #   object = "foo"
-        #   matcher = be(object)
-        #   matcher.match? { object } # => true
-        #   matcher.match? { "foo" } # => false
-        #
-        # @param expected [#equal?] The expected identical object.
-        #
-        # @return [#match?] An identity matcher.
-        #
-        # @api public
-        def be(expected)
-          ::Matchi::Be.new(expected)
-        end
-
-        alias equal be
-
-        # Comparisons matcher
-        #
-        # @example
-        #   matcher = be_within(1).of(41)
-        #   matcher.match? { 42 } # => true
-        #   matcher.match? { 43 } # => false
-        #
-        # @param delta [Numeric] A numeric value.
-        #
-        # @return [#match?] A comparison matcher.
-        #
-        # @api public
-        def be_within(delta)
-          ::Matchi::BeWithin.new(delta)
-        end
-
-        # Regular expressions matcher
-        #
-        # @example
-        #   matcher = match(/^foo$/)
-        #   matcher.match? { "foo" } # => true
-        #   matcher.match? { "bar" } # => false
-        #
-        # @param expected [#match] A regular expression.
-        #
-        # @return [#match?] A regular expression matcher.
-        #
-        # @api public
-        def match(expected)
-          ::Matchi::Match.new(expected)
-        end
-
-        # Expecting errors matcher
-        #
-        # @example
-        #   matcher = raise_exception(NameError)
-        #   matcher.match? { RSpec::Clone::Boom! } # => true
-        #   matcher.match? { true } # => false
-        #
-        # @param expected [Exception, #to_s] The expected exception name.
-        #
-        # @return [#match?] An error matcher.
-        #
-        # @api public
-        def raise_exception(expected)
-          ::Matchi::RaiseException.new(expected)
-        end
-
-        # True matcher
-        #
-        # @example
-        #   matcher = be_true
-        #   matcher.match? { true } # => true
-        #   matcher.match? { false } # => false
-        #   matcher.match? { nil } # => false
-        #   matcher.match? { 4 } # => false
-        #
-        # @return [#match?] A `true` matcher.
-        #
-        # @api public
-        def be_true
-          be(true)
-        end
-
-        # False matcher
-        #
-        # @example
-        #   matcher = be_false
-        #   matcher.match? { false } # => true
-        #   matcher.match? { true } # => false
-        #   matcher.match? { nil } # => false
-        #   matcher.match? { 4 } # => false
-        #
-        # @return [#match?] A `false` matcher.
-        #
-        # @api public
-        def be_false
-          be(false)
-        end
-
-        # Nil matcher
-        #
-        # @example
-        #   matcher = be_nil
-        #   matcher.match? { nil } # => true
-        #   matcher.match? { false } # => false
-        #   matcher.match? { true } # => false
-        #   matcher.match? { 4 } # => false
-        #
-        # @return [#match?] A `nil` matcher.
-        #
-        # @api public
-        def be_nil
-          be(nil)
-        end
-
-        # Type/class matcher
-        #
-        # @example
-        #   matcher = be_an_instance_of(String)
-        #   matcher.match? { "foo" } # => true
-        #   matcher.match? { 4 } # => false
-        #
-        # @param expected [Class, #to_s] The expected class name.
-        #
-        # @return [#match?] A type/class matcher.
-        #
-        # @api public
-        def be_an_instance_of(expected)
-          ::Matchi::BeAnInstanceOf.new(expected)
-        end
-
-        # Change matcher
-        #
-        # @example
-        #   object = []
-        #   matcher = change(object, :length).by(1)
-        #   matcher.match? { object << 1 } # => true
-        #
-        #   object = []
-        #   matcher = change(object, :length).by_at_least(1)
-        #   matcher.match? { object << 1 } # => true
-        #
-        #   object = []
-        #   matcher = change(object, :length).by_at_most(1)
-        #   matcher.match? { object << 1 } # => true
-        #
-        #   object = "foo"
-        #   matcher = change(object, :to_s).from("foo").to("FOO")
-        #   matcher.match? { object.upcase! } # => true
-        #
-        #   object = "foo"
-        #   matcher = change(object, :to_s).to("FOO")
-        #   matcher.match? { object.upcase! } # => true
-        #
-        # @param object [#object_id]  An object.
-        # @param method [Symbol]      The name of a method.
-        # @param args   [Array]       A list of arguments.
-        # @param kwargs [Hash]        A list of keyword arguments.
-        #
-        # @return [#match?] A change matcher.
-        #
-        # @api public
-        def change(object, method, ...)
-          ::Matchi::Change.new(object, method, ...)
-        end
-
-        # Satisfy matcher
-        #
-        # @example
-        #   matcher = satisfy { |value| value == 42 }
-        #   matcher.match? { 42 } # => true
-        #
-        # @param expected [Proc] A block of code.
-        #
-        # @return [#match?] A satisfy matcher.
-        #
-        # @api public
-        def satisfy(&)
-          ::Matchi::Satisfy.new(&)
-        end
-
-        private
-
-        # Predicate matcher, or default method missing behavior.
-        #
-        # @example Empty predicate matcher
-        #   matcher = be_empty
-        #   matcher.match? { [] } # => true
-        #   matcher.match? { [4] } # => false
-        def method_missing(name, ...)
-          return super unless predicate_matcher_name?(name)
-
-          ::Matchi::Predicate.new(name, ...)
-        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
-end

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

@@ -1,115 +0,0 @@
-# frozen_string_literal: true
-
-require "expresenter"
-require "test_tube"
-
-require_relative File.join("..", "logger")
-
-module RSpec
-  module Clone
-    module ExpectationTarget
-      # Abstract expectation target base class.
-      #
-      # @note `RSpec::Clone::ExpectationTarget::Base` is not intended to be
-      #   instantiated directly by users. Use `expect` instead.
-      class Base
-        # Instantiate a new expectation target.
-        #
-        # @param input [#object_id, Proc] The code to evaluate.
-        def initialize(input)
-          @input = input
-        end
-
-        # Runs the given expectation, passing if `matcher` returns true.
-        #
-        # @example _Absolute requirement_ definition
-        #   expect { "foo".upcase }.to eq("foo")
-        #
-        # @param matcher [#match?] The matcher.
-        #
-        # @raise (see #result)
-        # @return (see #result)
-        #
-        # @api public
-        def to(matcher)
-          absolute_requirement(matcher:, negate: false)
-        end
-
-        # Runs the given expectation, passing if `matcher` returns false.
-        #
-        # @example _Absolute prohibition_ definition
-        #   expect { "foo".size }.not_to be(4)
-        #
-        # @param (see #to)
-        #
-        # @raise (see #result)
-        # @return (see #result)
-        #
-        # @api public
-        def not_to(matcher)
-          absolute_requirement(matcher:, negate: true)
-        end
-
-        protected
-
-        # @param test     [::TestTube::Base] The state of the experiment.
-        # @param matcher  [#match?]   The matcher.
-        # @param negate   [Boolean]   The assertion is positive or negative.
-        #
-        # @return [nil] Write a message to STDOUT.
-        #
-        # @raise [SystemExit] Terminate execution immediately by calling
-        #   `Kernel.exit(false)` with a failure message written to STDERR.
-        def absolute_requirement(test, matcher:, negate:)
-          result(
-            passed?(test),
-            actual:  test.actual,
-            error:   test.error,
-            got:     test.got,
-            matcher:,
-            negate:
-          )
-        end
-
-        # Code experiment result.
-        #
-        # @param test [::TestTube::Base] The state of the experiment.
-        #
-        # @see https://github.com/fixrb/test_tube
-        #
-        # @return [Boolean] The result of the test (passed or failed).
-        def passed?(test)
-          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.
-        # @param got      [Boolean, nil]    Any returned value.
-        # @param matcher  [#match?]         The matcher.
-        # @param negate   [Boolean]         The assertion is positive or negative.
-        #
-        # @return [nil] Write a message to STDOUT.
-        #
-        # @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:)
-          Logger.passed_spec ::Expresenter.call(passed).with(
-            actual:,
-            definition: matcher.to_s,
-            error:,
-            got:,
-            negate:,
-            level:      :MUST
-          )
-        rescue ::Expresenter::Fail => e
-          Logger.failed_spec(e)
-        end
-
-        # :nocov:
-      end
-    end
-  end
-end

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

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "base"
-
-module RSpec
-  module Clone
-    module ExpectationTarget
-      # Wraps the target of an expectation with a block.
-      #
-      # @example
-      #   expect { something } # => ExpectationTarget::Block wrapping something
-      #
-      #   # used with `to`
-      #   expect { actual }.to be(42)
-      #
-      #   # with `not_to`
-      #   expect { actual }.not_to be(4)
-      #
-      # @note `RSpec::Clone::ExpectationTarget::Block` is not intended to be
-      #   instantiated directly by users. Use `expect` instead.
-      class Block < Base
-        protected
-
-        # @param matcher  [#match?]   The matcher.
-        # @param negate   [Boolean]   The assertion is positive or negative.
-        #
-        # @return (see Base#absolute_requirement)
-        #
-        # @raise (see Base#absolute_requirement)
-        def absolute_requirement(matcher:, negate:)
-          super(
-            ::TestTube.invoke(matcher:, negate:, &@input),
-            matcher:,
-            negate:
-          )
-        end
-      end
-    end
-  end
-end

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

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "base"
-
-module RSpec
-  module Clone
-    module ExpectationTarget
-      # Wraps the target of an expectation with a value.
-      #
-      # @example
-      #   expect(something) # => ExpectationTarget::Value wrapping something
-      #
-      #   # used with `to`
-      #   expect(actual).to be(42)
-      #
-      #   # with `not_to`
-      #   expect(actual).not_to be(4)
-      #
-      # @note `RSpec::Clone::ExpectationTarget::Value` is not intended to be
-      #   instantiated directly by users. Use `expect` instead.
-      class Value < Base
-        protected
-
-        # @param matcher  [#match?]   The matcher.
-        # @param negate   [Boolean]   The assertion is positive or negative.
-        #
-        # @return (see Base#absolute_requirement)
-        #
-        # @raise (see Base#absolute_requirement)
-        def absolute_requirement(matcher:, negate:)
-          super(
-            ::TestTube.pass(@input, matcher:, negate:),
-            matcher:,
-            negate:
-          )
-        end
-      end
-    end
-  end
-end

data/lib/r_spec/clone/logger.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module RSpec
-  module Clone
-    # Send log messages to the console.
-    module Logger
-      # @param report [::Expresenter::Pass] Passed expectation result presenter.
-      #
-      # @see https://github.com/fixrb/expresenter
-      #
-      # @return [nil] Add a colored message to `$stdout`.
-      def self.passed_spec(report)
-        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 message.
-      def self.failed_spec(report)
-        abort report.colored_string
-      end
-
-      # :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.
-      #
-      # @return [String] The Ruby source filename and line number associated with
-      #   the evaluated spec.
-      def self.source(filename, line)
-        puts [filename, line].compact.join(":")
-      end
-    end
-  end
-end