r_spec 0.3.3 → 1.0.0.beta5

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.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RSpec
+  # Namespace for `it` and `its` helper modules.
+  module ExpectationHelper
+  end
+end
+
+require_relative File.join("expectation_helper", "it")
+require_relative File.join("expectation_helper", "its")

data/lib/r_spec/expectation_helper/base.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require "matchi/rspec"
+
+require_relative File.join("..", "error", "pending_expectation")
+
+module RSpec
+  module ExpectationHelper
+    # Abstract expectation helper base module.
+    #
+    # This module defines a number of methods to create expectations, which are
+    # automatically included into example namespaces.
+    #
+    # It also includes a collection of expectation matchers 🤹
+    #
+    # @example Equivalence matcher
+    #   matcher = eql("foo") # => Matchi::Matcher::Eql.new("foo")
+    #   matcher.matches? { "foo" } # => true
+    #   matcher.matches? { "bar" } # => false
+    #
+    #   matcher = eq("foo") # => Matchi::Matcher::Eq.new("foo")
+    #   matcher.matches? { "foo" } # => true
+    #   matcher.matches? { "bar" } # => false
+    #
+    # @example Identity matcher
+    #   object = "foo"
+    #
+    #   matcher = equal(object) # => Matchi::Matcher::Equal.new(object)
+    #   matcher.matches? { object } # => true
+    #   matcher.matches? { "foo" } # => false
+    #
+    #   matcher = be(object) # => Matchi::Matcher::Be.new(object)
+    #   matcher.matches? { object } # => true
+    #   matcher.matches? { "foo" } # => false
+    #
+    # @example Regular expressions matcher
+    #   matcher = match(/^foo$/) # => Matchi::Matcher::Match.new(/^foo$/)
+    #   matcher.matches? { "foo" } # => true
+    #   matcher.matches? { "bar" } # => false
+    #
+    # @example Expecting errors matcher
+    #   matcher = raise_exception(NameError) # => Matchi::Matcher::RaiseException.new(NameError)
+    #   matcher.matches? { Boom } # => true
+    #   matcher.matches? { true } # => false
+    #
+    # @example Truth matcher
+    #   matcher = be_true # => Matchi::Matcher::BeTrue.new
+    #   matcher.matches? { true } # => true
+    #   matcher.matches? { false } # => false
+    #   matcher.matches? { nil } # => false
+    #   matcher.matches? { 4 } # => false
+    #
+    # @example Untruth matcher
+    #   matcher = be_false # => Matchi::Matcher::BeFalse.new
+    #   matcher.matches? { false } # => true
+    #   matcher.matches? { true } # => false
+    #   matcher.matches? { nil } # => false
+    #   matcher.matches? { 4 } # => false
+    #
+    # @example Nil matcher
+    #   matcher = be_nil # => Matchi::Matcher::BeNil.new
+    #   matcher.matches? { nil } # => true
+    #   matcher.matches? { false } # => false
+    #   matcher.matches? { true } # => false
+    #   matcher.matches? { 4 } # => false
+    #
+    # @example Type/class matcher
+    #   matcher = be_instance_of(String) # => Matchi::Matcher::BeInstanceOf.new(String)
+    #   matcher.matches? { "foo" } # => true
+    #   matcher.matches? { 4 } # => false
+    #
+    #   matcher = be_an_instance_of(String) # => Matchi::Matcher::BeAnInstanceOf.new(String)
+    #   matcher.matches? { "foo" } # => true
+    #   matcher.matches? { 4 } # => false
+    #
+    # @see https://github.com/fixrb/matchi
+    # @see https://github.com/fixrb/matchi-rspec
+    module Base
+      include ::Matchi::Helper
+
+      # Mark a spec as pending, expectation results will be ignored.
+      #
+      # @param description [String] The reason why the example is pending.
+      #
+      # @return [nil] Write a message to STDOUT.
+      #
+      # @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)
+        Error::PendingExpectation.result(description)
+      end
+    end
+  end
+end

data/lib/r_spec/expectation_helper/it.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "base"
+require_relative File.join("..", "expectation_target")
+
+module RSpec
+  module ExpectationHelper
+    # `it` expectation helper module.
+    module It
+      include Base
+
+      # Create an expectation for a spec.
+      #
+      # @param value [#object_id, nil]  An actual value.
+      # @param block [#call, nil]       A code to evaluate.
+      #
+      # @return [Block, Value] The wrapped target of an expectation.
+      #
+      # @example
+      #   expect("foo") # => #<RSpec::ExpectationTarget::Value:0x00007fb6b82311a0 @actual="foo">
+      #   expect { Boom } # => #<RSpec::ExpectationTarget::Block:0x00007fb6b8263df8 @callable=#<Proc:0x00007fb6b8263e20>>
+      #
+      # @api public
+      def expect(value = self.class.superclass, &block)
+        ExpectationTarget.call(self.class.superclass, value, block)
+      end
+
+      # Wraps the target of an expectation with the subject as actual value.
+      #
+      # @return [Block] The wrapped target of an expectation.
+      #
+      # @example
+      #   is_expected # => #<RSpec::ExpectationTarget::Block:0x00007fb6b8263df8 @callable=#<Proc:0x00007fb6b8263e20>>
+      #
+      # @api public
+      def is_expected
+        expect { subject }
+      end
+    end
+  end
+end

data/lib/r_spec/expectation_helper/its.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "base"
+require_relative File.join("..", "expectation_target", "block")
+
+module RSpec
+  module ExpectationHelper
+    # `its` expectation helper module.
+    module Its
+      include Base
+
+      # Wraps the target of an expectation with the actual value.
+      #
+      # @return [Block] The wrapped target of an expectation.
+      #
+      # @example
+      #   is_expected # => #<RSpec::ExpectationTarget::Block:0x00007fb6b8263df8 @callable=#<Proc:0x00007fb6b8263e20>>
+      #
+      # @api public
+      def is_expected
+        ExpectationTarget::Block.new(method(:actual))
+      end
+    end
+  end
+end

data/lib/r_spec/expectation_target.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module RSpec
+  # 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
+    #   valid value to pass.
+    # @param value [#object_id, nil] An actual value.
+    # @param block [#call, nil] A code to evaluate.
+    #
+    # @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
+
+        Block.new(block)
+      else
+        raise ::ArgumentError, "Can't pass both an argument and a block" if block
+
+        Value.new(value)
+      end
+    end
+  end
+end
+
+require_relative File.join("expectation_target", "block")
+require_relative File.join("expectation_target", "value")

data/lib/r_spec/expectation_target/base.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "expresenter"
+
+module RSpec
+  module ExpectationTarget
+    # Abstract expectation target base class.
+    #
+    # @note `RSpec::ExpectationTarget::Base` is not intended to be instantiated
+    #   directly by users. Use `expect` instead.
+    class Base
+      # Runs the given expectation, passing if `matcher` returns true.
+      #
+      # @example _Absolute requirement_ definition
+      #   expect { "foo".upcase }.to eq("foo")
+      #
+      # @param matcher [#matches?] The matcher.
+      #
+      # @raise (see #result)
+      # @return (see #result)
+      #
+      # @api public
+      def to(matcher)
+        absolute_requirement(matcher: 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: matcher, negate: true)
+      end
+
+      protected
+
+      # @param actual   [#object_id]      The actual value.
+      # @param error    [Exception, nil]  Any raised exception.
+      # @param got      [Boolean, nil]    Any returned value.
+      # @param matcher  [#matches?]       The matcher.
+      # @param negate   [Boolean]         The assertion is positive or negative.
+      # @param valid    [Boolean]         The result of an expectation.
+      #
+      # @return [nil] Write a message to STDOUT.
+      #
+      # @raise [SystemExit] Terminate execution immediately by calling
+      #   `Kernel.exit(false)` with a failure message written to STDERR.
+      #
+      # @api private
+      def result(actual:, error:, got:, matcher:, negate:, valid:)
+        puts "  " + ::Expresenter.call(valid).with(
+          actual:   actual,
+          error:    error,
+          expected: matcher.expected,
+          got:      got,
+          negate:   negate,
+          valid:    valid,
+          matcher:  matcher.class.to_sym,
+          level:    :MUST
+        ).colored_string
+      rescue ::Expresenter::Fail => e
+        abort "  #{e.colored_string}"
+      end
+    end
+  end
+end

data/lib/r_spec/expectation_target/block.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "spectus/exam"
+
+require_relative "base"
+
+module RSpec
+  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::ExpectationTarget::Block` is not intended to be instantiated
+    #   directly by users. Use `expect` instead.
+    class Block < Base
+      # Instantiate a new expectation target.
+      #
+      # @param block [#call] The code to evaluate.
+      def initialize(block)
+        super()
+
+        @callable = block
+      end
+
+      protected
+
+      # @param matcher  [#matches?] 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(matcher:, negate:)
+        exam = ::Spectus::Exam.new(
+          callable:  @callable,
+          isolation: false,
+          negate:    negate,
+          matcher:   matcher
+        )
+
+        result(
+          actual:  exam.actual,
+          error:   exam.exception,
+          got:     exam.got,
+          matcher: matcher,
+          negate:  negate,
+          valid:   exam.valid?
+        )
+      end
+    end
+  end
+end

data/lib/r_spec/expectation_target/value.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module RSpec
+  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::ExpectationTarget::Value` is not intended to be instantiated
+    #   directly by users. Use `expect` instead.
+    class Value < Base
+      # Instantiate a new expectation target.
+      #
+      # @param actual [#object_id] The actual value.
+      def initialize(actual)
+        super()
+
+        @actual = actual
+      end
+
+      protected
+
+      # @param matcher  [#matches?] 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(matcher:, negate:)
+        valid = negate ^ matcher.matches? { @actual }
+
+        result(
+          actual:  @actual,
+          error:   nil,
+          got:     valid,
+          matcher: matcher,
+          negate:  negate,
+          valid:   valid
+        )
+      end
+    end
+  end
+end