r_spec 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4d1385151395cd826a177727b3b30e49d3c6a6987a1917227818f9e86893342
-  data.tar.gz: 96382fb495444187b3c9b1d927a08fa23a2991b208e016cb308b53a32f89df3b
+  metadata.gz: 07a1c8219cd7741811c7d89f5df7eba78b3bdc1ff33e08ca4d254c25d9787b7e
+  data.tar.gz: bc3e131d7934aa091b03d7bbd258afb69f1aaa53ef1cec1661a1f4580589209d
 SHA512:
-  metadata.gz: 3481f838c965908f205e134ae8884925f64b7d2943cbf3efbd1298b00089775b75be049e15b7bdc9014967190d1def4fa13dd276b31a0b447179dafb93d1749c
-  data.tar.gz: 5191b6e4e55a363835c3f0e4e6cc30426a6852e2aa73c7e8071b71662d9c43b226fe8cba81a09f5fda1442a99ae3da585cd7a85c7b858c4a5fd99a389c4ef28e
+  metadata.gz: a8f167f145ade88ba9c45c3e744034c69145068a5fb42653cd52a6d068214c36da8160c447f993d07483bb76340a540e4917c26af29802178111c09fcc2e7e26
+  data.tar.gz: c3a8c57f1744d88d54640077e68be99a614b22d695830a3a1572b4a45ad900943879ccb5286de7cfd426d2b171d6916a102d30018a6e035edceb2032a184424f

data/LICENSE.md

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+# The MIT License
 
-Copyright (c) 2015-2021 Cyril Kato
+Copyright (c) 2015-2022 Cyril Kato
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,34 +1,32 @@
-# RSpec clone
+# RSpec (clone)
 
-A minimalist __RSpec clone__ with all the essentials.
+> A small [RSpec](https://github.com/rspec) clone based on [Fix testing tools for Ruby](https://github.com/fixrb).
 
-## Important ⚠️
+***
 
-To avoid confusion with the original [RSpec project](https://rspec.info/),
-the decision was made to rename "`r_spec`" into "`r_spec-clone`".
-Please consider renaming to [get the latest version](https://github.com/cyril/r_spec-clone.rb/). Happy testing!
+:warning: Important:
 
-## Project goals
+I'd like to avoid confusion in the Ruby community by emphasizing that the gem of this project is not [rspec](https://rubygems.org/gems/rspec) but [r_spec](https://rubygems.org/gems/r_spec).
 
-1. Keep a low level of code complexity and ensure thread safety.
-2. The interface must translate into atomic and simple Ruby objects.
-3. Avoid overloading the interface with additional alternative syntaxes.
-4. Provide most of RSpec's DSL to express expected outcomes of a code example.
+The [r_spec](https://rubygems.org/gems/r_spec) gem is a minimalist and personal reimplementation of the popular RSpec framework. My reimplementation is therefore independent of the original RSpec project.
 
-## Some differences
+For the purpose of the DSL reimplementation, I have kept the same `RSpec` module name, and following the [Ruby gems naming convention](https://guides.rubygems.org/name-your-gem/#use-underscores-for-multiple-words), I called its gem [r_spec](https://rubygems.org/gems/r_spec).
 
-* Spec files can be executed with `ruby` directly.
-* There is no option to activate monkey-patching.
-* It does not rely on hacks such as [`at_exit` hook](https://blog.arkency.com/2013/06/are-we-abusing-at-exit/) to trigger the tests.
-* Built-in matchers [do not trust _actual_](https://asciinema.org/a/29172?autoplay=1&speed=2) and do not send it messages.
-* If no `subject` has been explicitly determined, none is defined.
-* If no described class is set, `described_class` is undefined instead of `nil`.
-* Expectations cannot be added inside a `before` block.
-* [Arbitrary helper methods](https://relishapp.com/rspec/rspec-core/v/3-10/docs/helper-methods/arbitrary-helper-methods) are not exposed to examples.
-* The `let` method defines a helper method rather than a memoized helper method.
-* The one-liner `is_expected` syntax also works with block expectations.
-* `subject`, `before`, `after` and `let` definitions must come before examples.
-* Each [`context` runs its tests in _isolation_](https://asciinema.org/a/29070?autoplay=1&speed=2) to prevent side effects.
+However, to go further and explicitly indicate that this reimplementation is a clone, I have grouped all the code in a `RSpec::Clone` submodule within its [r_spec-clone](https://rubygems.org/gems/r_spec-clone) gem.
+
+***
+
+## Status
+
+[![Version](https://img.shields.io/github/v/tag/cyril/r_spec.rb?label=Version&logo=github)](https://github.com/cyril/r_spec.rb/releases)
+[![Yard documentation](https://img.shields.io/badge/Yard-documentation-blue.svg?logo=github)](https://rubydoc.info/github/cyril/r_spec.rb/main)
+[![CI](https://github.com/cyril/r_spec.rb/workflows/CI/badge.svg?branch=main)](https://github.com/cyril/r_spec.rb/actions?query=workflow%3Aci+branch%3Amain)
+[![RuboCop](https://github.com/cyril/r_spec.rb/workflows/RuboCop/badge.svg?branch=main)](https://github.com/cyril/r_spec.rb/actions?query=workflow%3Arubocop+branch%3Amain)
+[![License](https://img.shields.io/github/license/cyril/r_spec.rb?label=License&logo=github)](https://github.com/cyril/r_spec.rb/raw/main/LICENSE.md)
+
+## Why did I redid that?
+
+An urge to simplify the RSpec DSL and reduce the complexity of the code that implements it, and nothing better to do during a stay in Tokyo.
 
 ## Installation
 
@@ -41,7 +39,7 @@ gem "r_spec"
 And then execute:
 
 ```sh
-bundle
+bundle install
 ```
 
 Or install it yourself as:
@@ -50,206 +48,66 @@ Or install it yourself as:
 gem install r_spec
 ```
 
-## Overview
-
-__RSpec clone__ provides a structure for writing executable examples of how your code should behave.
-
-Inspired by RSpec, it includes a domain specific language (DSL) that allows you to write examples in a way similar to plain english.
-
-A basic spec looks something like this:
-
-[![RSpec clone demo](https://asciinema.org/a/422210.svg)](https://asciinema.org/a/422210?autoplay=1&speed=2)
-
-## Usage
-
-### Anatomy of a spec file
+## GitHub repo
 
-To use the `RSpec` module and its DSL, you need to add `require "r_spec"` to your spec files.
-Many projects use a custom spec helper which organizes these includes.
+All the code is centralized in the `RSpec::Clone` module, whose source code is versioned at <https://github.com/cyril/r_spec-clone.rb>.
 
-Concrete test cases are defined in `it` blocks.
-An optional descriptive string states it's purpose and a block contains the main logic performing the test.
+## "`Hello, World!`" example
 
-Test cases that have been defined or outlined but are not yet expected to work can be defined using `pending` instead of `it`. They will not be run but show up in the spec report as pending.
-
-An `it` block contains an example that should invoke the code to be tested and define what is expected of it.
-Each example can contain multiple expectations, but it should test only one specific behaviour.
-
-To express an expectation, wrap an object or block in `expect`, call `to` (or `not_to`) and pass it a matcher object.
-If the expectation is met, code execution continues.
-Otherwise the example has _failed_ and other code will not be executed.
-
-In test files, specs are structured by example groups which are defined by `describe` and `context` sections.
-Typically a top level `describe` defines the outer unit (such as a class) to be tested by the spec.
-Further `describe` sections can be nested within the outer unit to specify smaller units under test (such as individual methods).
-
-For unit tests, it is recommended to follow the conventions for method names:
-
-* outer `describe` is the name of the class, inner `describe` targets methods;
-* instance methods are prefixed with `#`, class methods with `.`.
-
-To establish certain contexts — think _empty array_ versus _array with elements_ — the `context` method may be used to communicate this to the reader.
-Its behavior is slightly different from `describe` because each `context` runs its tests in isolation,
-so side effects caused by testing do not propagate out of contexts.
-
-### Expectations
-
-Expectations define if the value being tested (_actual_) matches a certain value or specific criteria.
-
-#### Equivalence
+Let's imagine a `string_hello_world_spec.rb` file that contains this code:
 
 ```ruby
-expect(actual).to eql(expected) # passes if expected.eql?(actual)
-expect(actual).to eq(expected)  # passes if expected.eql?(actual)
-```
+# frozen_string_literal: false
 
-#### Identity
+require "r_spec"
 
-```ruby
-expect(actual).to equal(expected) # passes if expected.equal?(actual)
-expect(actual).to be(expected)    # passes if expected.equal?(actual)
-```
-
-#### Regular expressions
-
-```ruby
-expect(actual).to match(expected) # passes if expected.match?(actual)
-```
-
-#### Expecting errors
-
-```ruby
-expect { actual }.to raise_exception(expected) # passes if expected exception is raised
-```
+app = "Hello, World!"
 
-#### Truth
+RSpec.describe String do
+  subject do
+    app
+  end
 
-```ruby
-expect(actual).to be_true # passes if true.equal?(actual)
-```
-
-#### Untruth
-
-```ruby
-expect(actual).to be_false # passes if false.equal?(actual)
-```
+  before do
+    subject.gsub!("World", friend)
+  end
 
-#### Nil
+  context "when Alice is greeted" do
+    let(:friend) { "Alice" }
 
-```ruby
-expect(actual).to be_nil # passes if nil.equal?(actual)
-```
+    it { is_expected.to eq "Hello, Alice!" }
+  end
 
-#### Type/class
+  context "when Bob is greeted" do
+    let(:friend) { "Bob" }
 
-```ruby
-expect(actual).to be_instance_of(expected)    # passes if expected.equal?(actual.class)
-expect(actual).to be_an_instance_of(expected) # passes if expected.equal?(actual.class)
-```
-
-### Running specs
-
-By convention, specs live in the `spec/` directory of a project. Spec files should end with `_spec.rb` to be recognizable as such.
-
-Depending of the project settings, you may run the specs of a project by running `rake spec` (see _Rake integration example_ section below).
-A single file can also be executed directly with the Ruby interpreter.
-
-#### Examples
-
-Run all specs in files matching `spec/**/*_spec.rb`:
-
-```sh
-bundle exec rake spec
-```
-
-Run a single file:
-
-```sh
-ruby spec/my/test/file_spec.rb
-```
-
-It is not recommended, but the RSpec's [`rspec` command line](https://relishapp.com/rspec/rspec-core/docs/command-line) might also work:
-
-```sh
-rspec spec/my/test/file_spec.rb
-rspec spec/my/test/file_spec.rb:42
-rspec spec/my/test/
-rspec
-```
-
-### Spec helper
-
-Many projects use a custom spec helper file, usually named `spec/spec_helper.rb`.
-
-This file is used to require `r_spec` and other includes, like the code from the project needed for every spec file.
-
-### Rake integration example
-
-The following `Rakefile` settings should be enough:
-
-```ruby
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new do |t|
-  t.pattern = "spec/**/*_spec.rb"
+    it { is_expected.to eq "Hello, Bob!" }
+  end
 end
-
-task spec: :test
-task default: :test
 ```
 
-And then execute:
+We can run it with Ruby:
 
 ```sh
-bundle exec rake
+ruby string_hello_world_spec.rb
 ```
 
-## Performance
-
-### Runtime
-
-Benchmark against [100 executions of a file containing one expectation](https://github.com/cyril/r_spec-clone.rb/blob/main/benchmark/) (lower is better).
-
-![Runtime](https://clone.r-spec.dev/benchmark-runtime.png)
-
-## Test suite
+The report of the execution should be:
 
-__RSpec clone__'s specifications are self-described here: [spec/](https://github.com/cyril/r_spec-clone.rb/blob/main/spec/)
+> example/string_hello_world_spec.rb:19
+> Success: expected to eq "Hello, Alice!".
+> example/string_hello_world_spec.rb:25
+> Success: expected to eq "Hello, Bob!".
 
-## Contact
+## External links
 
-* Home page: [https://r-spec.dev/](https://r-spec.dev/)
-* Cheatsheet: [https://clone.r-spec.dev/cheatsheet.html](https://clone.r-spec.dev/cheatsheet.html)
-* Source code: [https://github.com/cyril/r_spec-clone.rb](https://github.com/cyril/r_spec-clone.rb)
-* API Doc: [https://rubydoc.info/gems/r_spec](https://rubydoc.info/gems/r_spec)
-* Twitter: [https://twitter.com/cyri\_](https://twitter.com/cyri\_)
-
-## Special thanks ❤️
-
-I would like to thank the whole [RSpec team](https://rspec.info/about/) for all their work.
-It's a great framework and it's a pleasure to work with every day.
-
-Without RSpec, this clone would not have been possible.
-
-## Buy me a coffee ☕
-
-If you like this project, please consider making a small donation to Batman.
-
-[![Donate](https://img.shields.io/badge/Donate-batman.eth-purple.svg)](https://etherscan.io/address/batman.eth)
+* [Official RSpec project](https://rspec.info/)
+* [Personal RSpec reimplementation](https://r-spec.dev/)
 
 ## Versioning
 
-__RSpec clone__ follows [Semantic Versioning 2.0](https://semver.org/).
+__RSpec__ uses [Semantic Versioning 2.0.0](https://semver.org/)
 
 ## License
 
-The [gem](https://rubygems.org/gems/r_spec) is available as open source under the terms of the [MIT License](https://github.com/cyril/r_spec-clone.rb/raw/main/LICENSE.md).
-
-## One more thing
-
-Under the hood, __RSpec clone__ is largely animated by [a collection of testing libraries designed to make programmers happy](https://github.com/fixrb/).
-
-It's a living example of what we can do combining small libraries together that can boost the fun of programming.
-
-![Fix testing tools logo for Ruby](https://github.com/cyril/r_spec-clone.rb/raw/main/img/fixrb.svg)
+The [gem](https://rubygems.org/gems/r_spec) is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/r_spec.rb

@@ -1,170 +1,8 @@
 # frozen_string_literal: true
 
-require_relative File.join("r_spec", "dsl")
-
 # Top level namespace for the RSpec clone.
-#
-# @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
-#   require "r_spec"
-#
-#   RSpec.describe Array do
-#     describe "#size" do
-#       it "correctly reports the number of elements in the Array" 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
-#         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 true to be true.
-#   #   Success: expected false 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.
-#
-# @api public
+# @see https://github.com/cyril/r_spec-clone.rb
 module RSpec
-  # Defines an example group that establishes a specific context, like _empty
-  # array_ versus _array with elements_.
-  #
-  # Unlike {.describe}, the block is evaluated in isolation in order to scope
-  # possible side effects inside its context.
-  #
-  # @example
-  #   require "r_spec"
-  #
-  #   RSpec.context "when divided by zero" do
-  #     subject { 42 / 0 }
-  #
-  #     it { is_expected.to raise_exception ZeroDivisionError }
-  #   end
-  #
-  #   # Output to the console
-  #   #   Success: divided by 0.
-  #
-  # @param description [String] A description that usually begins with "when",
-  #   "with" or "without".
-  # @param block [Proc] The block to define the specs.
-  #
-  # @api public
-  def self.context(description, &block)
-    Dsl.context(description, &block)
-  end
-
-  # Defines an example group that describes a unit to be tested.
-  #
-  # @example
-  #   require "r_spec"
-  #
-  #   RSpec.describe String do
-  #     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.
-  #
-  # @api public
-  def self.describe(const, &block)
-    Dsl.describe(const, &block)
-  end
-
-  # Defines a concrete test case.
-  #
-  # The test is performed by the block supplied to &block.
-  #
-  # @example The integer after 41
-  #   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 {Dsl.describe} or {Dsl.context} section.
-  #
-  # @param name [String, nil] The name of the spec.
-  # @param block [Proc] An expectation to evaluate.
-  #
-  # @raise (see RSpec::ExpectationTarget::Base#result)
-  # @return (see RSpec::ExpectationTarget::Base#result)
-  #
-  # @api public
-  def self.it(name = nil, &block)
-    Dsl.it(name, &block)
-  end
-
-  # Defines a pending test case.
-  #
-  # `&block` is never evaluated. It can be used to describe behaviour that is
-  # not yet implemented.
-  #
-  # @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 {Dsl.describe} or {Dsl.context} section.
-  #
-  # @param message [String] The reason why the example is pending.
-  #
-  # @return [nil] Write a message to STDOUT.
-  #
-  # @api public
-  def self.pending(message)
-    Dsl.pending(message)
-  end
 end
+
+require "r_spec/clone"

metadata

@@ -1,71 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: r_spec
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-27 00:00:00.000000000 Z
+date: 2022-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: aw
+  name: r_spec-clone
   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
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -201,33 +159,14 @@ 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
 homepage: https://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
-  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: |
-  To avoid confusion with the original RSpec project,
-  the decision was made to rename "r_spec" into "r_spec-clone".
-  Please consider renaming to get the latest version. Happy testing!
+  bug_tracker_uri: https://github.com/cyril/r_spec.rb/issues
+  source_code_uri: https://github.com/cyril/r_spec.rb
+  rubygems_mfa_required: 'true'
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -235,14 +174,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.4
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: A minimalist RSpec clone

data/lib/r_spec/console.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module RSpec
-  # Send log messages to the console.
-  #
-  # @api private
-  module Console
-    # @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
-
-    # @param report [::Expresenter::Fail] Failed expectation result presenter.
-    #
-    # @see https://github.com/fixrb/expresenter
-    #
-    # @raise [SystemExit] Terminate execution immediately with colored message.
-    def self.failed_spec(report)
-      abort report.colored_string
-    end
-
-    # 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