r_spec-clone 1.0.0.rc1

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

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

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

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

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

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

data/lib/r_spec/clone/expectation_helper.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative File.join("expectation_helper", "it")
+require_relative File.join("expectation_helper", "its")
+
+module RSpec
+  module Clone
+    # Namespace for {Dsl.it} and {Dsl.its}'s helper modules.
+    module ExpectationHelper
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "shared"
+require_relative File.join("..", "expectation_target")
+
+module RSpec
+  module Clone
+    module ExpectationHelper
+      # {RSpec::Clone::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:0x00007fb6b823 @actual="foo">
+        #   expect { Boom } # => #<RSpec::ExpectationTarget::Block:0x00007fb6b826 @callable=#<Proc:0x00007fb6b826>>
+        #
+        # @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
+end

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

@@ -0,0 +1,27 @@
+# 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::ExpectationTarget::Block:0x00007fb6b8263df8 @callable=#<Proc:0x00007fb6b8263e20>>
+        #
+        # @api public
+        def is_expected
+          ExpectationTarget::Block.new(method(:actual))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "matchi/rspec"
+
+require_relative File.join("..", "error", "pending_expectation")
+
+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 🤹
+      #
+      # @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
+end

data/lib/r_spec/clone/expectation_target.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative File.join("expectation_target", "block")
+require_relative File.join("expectation_target", "value")
+
+module RSpec
+  module Clone
+    # 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
+end

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "expresenter"
+require "test_tube"
+
+require_relative File.join("..", "console")
+
+module RSpec
+  module Clone
+    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
+        # 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
+        #   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 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  [#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.
+        #
+        # @api private
+        def result(passed, actual:, error:, got:, matcher:, negate:)
+          Console.passed_spec ::Expresenter.call(passed).with(
+            actual:   actual,
+            error:    error,
+            expected: matcher.expected,
+            got:      got,
+            negate:   negate,
+            matcher:  matcher.class.to_sym,
+            level:    :MUST
+          )
+        rescue ::Expresenter::Fail => e
+          Console.failed_spec(e)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# 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::ExpectationTarget::Block` is not intended to be instantiated
+      #   directly by users. Use `expect` instead.
+      class Block < Base
+        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:)
+          experiment = ::TestTube.invoke(
+            @actual,
+            isolation: false,
+            matcher:   matcher,
+            negate:    negate
+          )
+
+          result(
+            experiment.got.equal?(true),
+            actual:  experiment.actual,
+            error:   experiment.error,
+            got:     experiment.got,
+            matcher: matcher,
+            negate:  negate
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# 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::ExpectationTarget::Value` is not intended to be instantiated
+      #   directly by users. Use `expect` instead.
+      class Value < Base
+        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:)
+          experiment = ::TestTube.pass(
+            @actual,
+            matcher: matcher,
+            negate:  negate
+          )
+
+          result(
+            experiment.got.equal?(true),
+            actual:  experiment.actual,
+            error:   experiment.error,
+            got:     experiment.got,
+            matcher: matcher,
+            negate:  negate
+          )
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,247 @@
+--- !ruby/object:Gem::Specification
+name: r_spec-clone
+version: !ruby/object:Gem::Version
+  version: 1.0.0.rc1
+platform: ruby
+authors:
+- Cyril Kato
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aw
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.12
+- !ruby/object:Gem::Dependency
+  name: expresenter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: matchi-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: test_tube
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-md
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-thread_safety
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A minimalist RSpec clone with all the essentials.
+email: contact@cyril.email
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/r_spec.rb
+- lib/r_spec/clone.rb
+- lib/r_spec/clone/console.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_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
+homepage: https://clone.r-spec.dev/
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/cyril/r_spec-clone.rb/issues
+  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
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: A minimalist RSpec clone
+test_files: []