r_spec 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b251a708b0d9e2f0dcc8a17f7ef08cfeeafa6e553446e9a650431c9aaf7b6951
-  data.tar.gz: 528cbc2cd07397ba094a5f08703be53467ac04ee85c82f1cd1465e419f4c5c92
+  metadata.gz: d4d1385151395cd826a177727b3b30e49d3c6a6987a1917227818f9e86893342
+  data.tar.gz: 96382fb495444187b3c9b1d927a08fa23a2991b208e016cb308b53a32f89df3b
 SHA512:
-  metadata.gz: 7132f226d0510929ec1a466c2c3e9a3c90a654efd399646476eb04b5fbdcad84254791eb270b83ca68e2c17ad06ca98581a79251714ae7032a9eb888f8716db2
-  data.tar.gz: 55d0b1f4e98feeca3c875c542529e1ea5a4f43093a30658f56670f380de23f7f5402e562fccfb85e69e234a066f06ec8600493fcdedd871d78183ea419d055f6
+  metadata.gz: 3481f838c965908f205e134ae8884925f64b7d2943cbf3efbd1298b00089775b75be049e15b7bdc9014967190d1def4fa13dd276b31a0b447179dafb93d1749c
+  data.tar.gz: 5191b6e4e55a363835c3f0e4e6cc30426a6852e2aa73c7e8071b71662d9c43b226fe8cba81a09f5fda1442a99ae3da585cd7a85c7b858c4a5fd99a389c4ef28e

data/README.md

@@ -1,28 +1,25 @@
 # RSpec clone
 
-A minimalist __[RSpec](https://github.com/rspec/rspec) clone__ with all the essentials.
+A minimalist __RSpec clone__ with all the essentials.
 
-![What did you RSpec?](https://github.com/cyril/r_spec.rb/raw/main/img/what-did-you-rspec.jpg)
-
-## Status
+## Important ⚠️
 
-[![Version](https://img.shields.io/github/v/tag/cyril/r_spec.rb?include_prereleases&label=Version&logo=github&sort=semver)](https://github.com/cyril/r_spec.rb/releases)
-[![Yard documentation](https://img.shields.io/badge/Yard-documentation-blue.svg?)](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)
+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!
 
 ## Project goals
 
-* Enforce the guidelines and best practices outlined in the community [RSpec style guide](https://rspec.rubystyle.guide/).
-* Provide most of RSpec's DSL to express expected outcomes of a code example with no magical powers.
+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.
 
 ## Some differences
 
-* Less features and an implementation with much less code complexity.
-* Spec files can also be executed directly with the `ruby` executable.
+* 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 to trigger the tests.
+* 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`.
@@ -33,18 +30,6 @@ A minimalist __[RSpec](https://github.com/rspec/rspec) clone__ with all the esse
 * `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.
 
-## Important ⚠️
-
-To avoid confusion in the community, please note that:
-
-- the gem of this project is **not [`rspec`](https://rubygems.org/gems/rspec)**,
-it is **[`r_spec`](https://rubygems.org/gems/r_spec)**;
-- this project is totally independent of [rspec.info](https://rspec.info/).
-
-### Note
-
-Following [RubyGems naming conventions](https://guides.rubygems.org/name-your-gem/#use-underscores-for-multiple-words), the module name for this project is `RSpec`.
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -69,7 +54,7 @@ gem install r_spec
 
 __RSpec clone__ provides a structure for writing executable examples of how your code should behave.
 
-Inspired by [RSpec](https://rspec.info/), it includes a domain specific language (DSL) that allows you to write examples in a way similar to plain english.
+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:
 
@@ -107,8 +92,6 @@ To establish certain contexts — think _empty array_ versus _array with element
 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.
 
-`describe` and `context` take an optional description as argument and a block containing the individual specs or nested groupings.
-
 ### Expectations
 
 Expectations define if the value being tested (_actual_) matches a certain value or specific criteria.
@@ -168,7 +151,7 @@ expect(actual).to be_an_instance_of(expected) # passes if expected.equal?(actual
 
 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](#rake-integration-example) below).
+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
@@ -185,7 +168,7 @@ Run a single file:
 ruby spec/my/test/file_spec.rb
 ```
 
-I know that sounds weird, but the [`rspec` command line](https://relishapp.com/rspec/rspec-core/docs/command-line) is also working pretty well:
+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
@@ -200,7 +183,7 @@ 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
+### Rake integration example
 
 The following `Rakefile` settings should be enough:
 
@@ -210,31 +193,35 @@ require "rake/testtask"
 
 Rake::TestTask.new do |t|
   t.pattern = "spec/**/*_spec.rb"
-  t.verbose = true
-  t.warning = true
 end
 
 task spec: :test
 task default: :test
 ```
 
+And then execute:
+
+```sh
+bundle exec rake
+```
+
 ## Performance
 
 ### Runtime
 
-Benchmark against [100 executions of a file containing one expectation](https://github.com/cyril/r_spec.rb/blob/main/benchmark/) (lower is better).
+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://r-spec.dev/benchmark-runtime.png)
+![Runtime](https://clone.r-spec.dev/benchmark-runtime.png)
 
 ## Test suite
 
-__RSpec clone__'s specifications are self-described here: [spec/](https://github.com/cyril/r_spec.rb/blob/main/spec/)
+__RSpec clone__'s specifications are self-described here: [spec/](https://github.com/cyril/r_spec-clone.rb/blob/main/spec/)
 
 ## Contact
 
 * Home page: [https://r-spec.dev/](https://r-spec.dev/)
-* Cheatsheet: [https://r-spec.dev/cheatsheet.html](https://r-spec.dev/cheatsheet.html)
-* Source code: [https://github.com/cyril/r_spec.rb](https://github.com/cyril/r_spec.rb)
+* 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\_)
 
@@ -247,9 +234,9 @@ Without RSpec, this clone would not have been possible.
 
 ## Buy me a coffee ☕
 
-If you like this project please consider making a small donation.
+If you like this project, please consider making a small donation to Batman.
 
-[![Donate with Ethereum](https://github.com/cyril/r_spec.rb/raw/main/img/donate-eth.svg)](https://etherscan.io/address/0x834b5c1feaff5aebf9cd0f25dc38e741d65ab773)
+[![Donate](https://img.shields.io/badge/Donate-batman.eth-purple.svg)](https://etherscan.io/address/batman.eth)
 
 ## Versioning
 
@@ -257,7 +244,7 @@ __RSpec clone__ follows [Semantic Versioning 2.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.rb/raw/main/LICENSE.md).
+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
 
@@ -265,4 +252,4 @@ Under the hood, __RSpec clone__ is largely animated by [a collection of testing
 
 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.rb/raw/main/img/fixrb.svg)
+![Fix testing tools logo for Ruby](https://github.com/cyril/r_spec-clone.rb/raw/main/img/fixrb.svg)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r_spec
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-24 00:00:00.000000000 Z
+date: 2021-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aw
@@ -220,11 +220,14 @@ homepage: https://r-spec.dev/
 licenses:
 - MIT
 metadata:
-  bug_tracker_uri: https://github.com/cyril/r_spec.rb/issues
+  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.rb
-  wiki_uri: https://github.com/cyril/r_spec.rb/wiki
-post_install_message: 
+  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!
 rdoc_options: []
 require_paths:
 - lib