r_spec 1.0.0.beta3 → 1.0.0.beta8

data/lib/r_spec/error.rb

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

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)
+        ::Expresenter.call(true).with(
+          actual:   new(message),
+          error:    nil,
+          expected: self,
+          got:      false,
+          matcher:  :raise_exception,
+          negate:   true,
+          level:    :SHOULD,
+          valid:    false
+        )
+      end
+    end
+  end
+end

data/lib/r_spec/error/reserved_method.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Error
+    # Exception for reserved methods.
+    #
+    # @api private
+    class ReservedMethod < ::RuntimeError
+    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
+
+require_relative File.join("expectation_helper", "it")
+require_relative File.join("expectation_helper", "its")
+
+module RSpec
+  # Namespace for {Dsl.it} and {Dsl.its}'s helper modules.
+  module ExpectationHelper
+  end
+end

data/lib/r_spec/expectation_helper/it.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "shared"
+require_relative File.join("..", "expectation_target")
+
+module RSpec
+  module ExpectationHelper
+    # {RSpec::Dsl.it}'s expectation helper module.
+    module It
+      include Shared
+
+      # 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 "shared"
+require_relative File.join("..", "expectation_target", "block")
+
+module RSpec
+  module ExpectationHelper
+    # {RSpec::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::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_helper/shared.rb

@@ -0,0 +1,82 @@
+# 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 examples.
+    #
+    # 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 Shared
+      include ::Matchi::Helper
+    end
+  end
+end

data/lib/r_spec/expectation_target.rb

@@ -1,15 +1,20 @@
 # frozen_string_literal: true
 
+require_relative File.join("expectation_target", "block")
+require_relative File.join("expectation_target", "value")
+
 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 value [#object_id, nil] An actual value.
     # @param block [#call, nil] A code to evaluate.
     #
-    # @private
+    # @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
@@ -23,6 +28,3 @@ module RSpec
     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

@@ -2,12 +2,22 @@
 
 require "expresenter"
 
+require_relative File.join("..", "console")
+
 module RSpec
   module ExpectationTarget
-    # Abstract class.
+    # Abstract expectation target base class.
     #
-    # @private
+    # @note `RSpec::ExpectationTarget::Base` is not intended to be instantiated
+    #   directly by users. Use `expect` instead.
     class Base
+      # Instantiate a new expectation target.
+      #
+      # @param actual [#object_id] The actual value of the code to evaluate.
+      def initialize(actual)
+        @actual = actual
+      end
+
       # Runs the given expectation, passing if `matcher` returns true.
       #
       # @example _Absolute requirement_ definition
@@ -17,6 +27,8 @@ module RSpec
       #
       # @raise (see #result)
       # @return (see #result)
+      #
+      # @api public
       def to(matcher)
         absolute_requirement(matcher: matcher, negate: false)
       end
@@ -30,6 +42,8 @@ module RSpec
       #
       # @raise (see #result)
       # @return (see #result)
+      #
+      # @api public
       def not_to(matcher)
         absolute_requirement(matcher: matcher, negate: true)
       end
@@ -47,8 +61,10 @@ module RSpec
       #
       # @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(
+        Console.passed_spec ::Expresenter.call(valid).with(
           actual:   actual,
           error:    error,
           expected: matcher.expected,
@@ -57,9 +73,9 @@ module RSpec
           valid:    valid,
           matcher:  matcher.class.to_sym,
           level:    :MUST
-        ).colored_string
+        )
       rescue ::Expresenter::Fail => e
-        abort "  #{e.colored_string}"
+        Console.failed_spec(e)
       end
     end
   end

data/lib/r_spec/expectation_target/block.rb

@@ -6,7 +6,7 @@ require_relative "base"
 
 module RSpec
   module ExpectationTarget
-    # Wraps the target of an expectation.
+    # Wraps the target of an expectation with a block.
     #
     # @example
     #   expect { something } # => ExpectationTarget::Block wrapping something
@@ -19,30 +19,19 @@ module RSpec
     #
     # @note `RSpec::ExpectationTarget::Block` is not intended to be instantiated
     #   directly by users. Use `expect` instead.
-    #
-    # @private
     class Block < Base
-      # Instantiate a new expectation target.
-      #
-      # @param block [#call] The code to evaluate.
-      #
-      # @api private
-      def initialize(block)
-        super()
-
-        @callable = block
-      end
-
       protected
 
       # @param matcher  [#matches?] The matcher.
-      # @param negate   [Boolean]   Positive or negative assertion?
+      # @param negate   [Boolean]   The assertion is positive or negative.
+      #
+      # @return [nil] Write a message to STDOUT.
       #
-      # @raise (see Base#result)
-      # @return (see Base#result)
+      # @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,
+          callable:  @actual,
           isolation: false,
           negate:    negate,
           matcher:   matcher

data/lib/r_spec/expectation_target/value.rb

@@ -4,7 +4,7 @@ require_relative "base"
 
 module RSpec
   module ExpectationTarget
-    # Wraps the target of an expectation.
+    # Wraps the target of an expectation with a value.
     #
     # @example
     #   expect(something) # => ExpectationTarget::Value wrapping something
@@ -17,27 +17,16 @@ module RSpec
     #
     # @note `RSpec::ExpectationTarget::Value` is not intended to be instantiated
     #   directly by users. Use `expect` instead.
-    #
-    # @private
     class Value < Base
-      # Instantiate a new expectation target.
-      #
-      # @param actual [#object_id] The actual value.
-      #
-      # @api private
-      def initialize(actual)
-        super()
-
-        @actual = actual
-      end
-
       protected
 
       # @param matcher  [#matches?] The matcher.
-      # @param negate   [Boolean]   Positive or negative assertion?
+      # @param negate   [Boolean]   The assertion is positive or negative.
+      #
+      # @return [nil] Write a message to STDOUT.
       #
-      # @raise (see Base#result)
-      # @return (see Base#result)
+      # @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 }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r_spec
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta3
+  version: 1.0.0.beta8
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-05 00:00:00.000000000 Z
+date: 2021-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: expresenter
@@ -16,42 +16,42 @@ 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
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.1.2
 - !ruby/object:Gem::Dependency
   name: spectus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.2
+        version: 3.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.2
+        version: 3.3.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -187,14 +187,21 @@ files:
 - LICENSE.md
 - README.md
 - lib/r_spec.rb
+- lib/r_spec/console.rb
 - lib/r_spec/dsl.rb
+- lib/r_spec/error.rb
+- lib/r_spec/error/pending_expectation.rb
+- lib/r_spec/error/reserved_method.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/it.rb
+- lib/r_spec/expectation_helper/its.rb
+- lib/r_spec/expectation_helper/shared.rb
 - lib/r_spec/expectation_target.rb
 - lib/r_spec/expectation_target/base.rb
 - lib/r_spec/expectation_target/block.rb
 - lib/r_spec/expectation_target/value.rb
-- lib/r_spec/log.rb
-- lib/r_spec/pending.rb
-- lib/r_spec/test.rb
 homepage: https://r-spec.dev/
 licenses:
 - MIT
@@ -202,6 +209,7 @@ metadata:
   bug_tracker_uri: https://github.com/cyril/r_spec.rb/issues
   documentation_uri: https://rubydoc.info/gems/r_spec
   source_code_uri: https://github.com/cyril/r_spec.rb
+  wiki_uri: https://github.com/cyril/r_spec.rb/wiki
 post_install_message: 
 rdoc_options: []
 require_paths: