r_spec 1.0.0.beta6 → 1.0.0.beta7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6facf7764beddac81425ab44d80ed3b306f6c63c3532401bb658240654b06845
-  data.tar.gz: 944d53b22a1ffeeca3afe990aa99a613493f9ff1b3aad3ceaa43ae0b9a8ec019
+  metadata.gz: 46557ee64f6cc554942399aa9219e9102879b2b7b113e53dc4ba63d2c0c5c0af
+  data.tar.gz: a83b773e20cf2db46b28586be6836d7913a4c3b8f9bf2ce747110f2556737374
 SHA512:
-  metadata.gz: c28b4fbd53cf2a368022418c2ccbbf31cf4a35abce141f0999285bff90b4c84d7f36209894dafcf5362464d01fad3dcb724d942ae5db5c1095387997b087964f
-  data.tar.gz: 4c7a23212c2ce90a67b04e9fe25dda7812c37902eba8f6febdb9e4e2dcd33633fa43642d6905f9bfffa6215b467eb88cbb921d596f0276fb788cc876bc63e291
+  metadata.gz: b7c89ce9b933e7adcfc26e03c2f4417ed44c423ca56932f173b2161572877967df37d99c9a560e8cf64c58458777842cb0db7eb1396c89a7f052d981b45f9864
+  data.tar.gz: 51c4b747116d8f1bb3bb2e593b00aa940ec463d1b9a03506984f2b445f3607febd455884051279f73cef2fc2edac7cfe6d9b4de210c1f1cef6402bd501729f6c

data/README.md

@@ -11,11 +11,12 @@ A minimalist __[RSpec](https://github.com/rspec/rspec) clone__ with all the esse
 [![Inline Docs](https://inch-ci.org/github/cyril/r_spec.rb.svg)](https://inch-ci.org/github/cyril/r_spec.rb)
 [![Documentation](https://img.shields.io/:yard-docs-38c800.svg)](https://rubydoc.info/gems/r_spec/frames)
 
-## Goal
+## Project Goals
 
-This clone attempts to provide most of RSpec's DSL to express expected outcomes of a code example without magic power.
+* 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 without magic power.
 
-## Some differences
+## Some Differences
 
 * Less features and an implementation with much less code complexity.
 * Spec files can also be executed directly with the `ruby` executable.
@@ -28,6 +29,10 @@ This clone attempts to provide most of RSpec's DSL to express expected outcomes
 * [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.
+* All `subject` definitions must come _before_ examples.
+* All `before` definitions must come _before_ examples.
+* All `after` definitions must come _before_ examples.
+* All `let` definitions must come _before_ examples.
 
 ## Important ⚠️
 
@@ -46,7 +51,7 @@ Following [RubyGems naming conventions](https://guides.rubygems.org/name-your-ge
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "r_spec", ">= 1.0.0.beta6"
+gem "r_spec", ">= 1.0.0.beta7"
 ```
 
 And then execute:
@@ -215,15 +220,18 @@ task default: :test
 
 ## Performance
 
-Benchmark against an single expectation executed 100 times from the console.
+### Runtime
+
+Benchmark against [100 executions of a file containing one expectation](https://github.com/cyril/r_spec.rb/blob/main/benchmark/) (lower is better).
 
 | Framework   | Seconds to complete |
 |-------------|---------------------|
-| RSpec clone | [13.2](https://github.com/cyril/r_spec.rb/blob/main/benchmark/r_spec.rb) |
-| RSpec       | [32.7](https://github.com/cyril/r_spec.rb/blob/main/benchmark/rspec.rb) |
-| minitest    | [17.6](https://github.com/cyril/r_spec.rb/blob/main/benchmark/minitest.rb) |
+| `r_spec`    | 13.0                |
+| `rspec`     | 32.2                |
+| `minitest`  | 17.5                |
+| `test-unit` | 20.5                |
 
-## Test suite
+## Test Suite
 
 __RSpec clone__'s specifications are self-described here: [spec/](https://github.com/cyril/r_spec.rb/blob/main/spec/)
 
@@ -233,14 +241,14 @@ __RSpec clone__'s specifications are self-described here: [spec/](https://github
 * Source code: https://github.com/cyril/r_spec.rb
 * Twitter: [https://twitter.com/cyri\_](https://twitter.com/cyri\_)
 
-## Special thanks ❤️
+## 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 ☕
+## Buy me a Coffee ☕
 
 If you like this project please consider making a small donation.
 

data/lib/r_spec.rb

@@ -7,7 +7,7 @@ require_relative File.join("r_spec", "dsl")
 # @example The true from the false
 #   require "r_spec"
 #
-#   RSpec.describe do
+#   RSpec.describe "The true from the false" do
 #     it { expect(false).not_to be true }
 #   end
 #
@@ -71,7 +71,7 @@ module RSpec
   # @param block [Proc] The block to define the specs.
   #
   # @api public
-  def self.describe(const = nil, &block)
+  def self.describe(const, &block)
     Dsl.describe(const, &block)
   end
 end

data/lib/r_spec/dsl.rb

@@ -1,15 +1,17 @@
 # frozen_string_literal: true
 
-require "securerandom"
-
 require_relative "console"
 require_relative "error"
 require_relative "expectation_helper"
-require_relative "sandbox"
 
 module RSpec
   # Abstract class for handling the domain-specific language.
   class Dsl
+    BEFORE_METHOD = :initialize
+    AFTER_METHOD  = :terminate
+
+    private_constant :BEFORE_METHOD, :AFTER_METHOD
+
     # Executes the given block before each spec in the current context runs.
     #
     # @example
@@ -40,12 +42,12 @@ module RSpec
     #
     # @param block [Proc] The content to execute at the class initialization.
     def self.before(&block)
-      define_method(:initialize) do
+      define_method(BEFORE_METHOD) do
         super()
         instance_eval(&block)
       end
 
-      private :initialize
+      private BEFORE_METHOD
     end
 
     # Executes the given block after each spec in the current context runs.
@@ -67,12 +69,12 @@ module RSpec
     #
     # @param block [Proc] The content to execute at the class initialization.
     def self.after(&block)
-      define_method(:terminate) do
+      define_method(AFTER_METHOD) do
         instance_exec(&block)
         super()
       end
 
-      private :terminate
+      private AFTER_METHOD
     end
 
     # Sets a user-defined property.
@@ -80,7 +82,7 @@ module RSpec
     # @example
     #   require "r_spec"
     #
-    #   RSpec.describe do
+    #   RSpec.describe "Name stories" do
     #     let(:name) { "Bob" }
     #
     #     it { expect(name).to eq "Bob" }
@@ -99,9 +101,11 @@ module RSpec
     # @param name   [String, Symbol] The name of the property.
     # @param block  [Proc] The content of the method to define.
     #
-    # @return [Symbol] A protected method that define the block content.
+    # @return [Symbol] A private method that define the block content.
     def self.let(name, *args, **kwargs, &block)
-      protected define_method(name.to_sym, *args, **kwargs, &block)
+      raise Error::ReservedMethod if [BEFORE_METHOD, AFTER_METHOD].include?(name.to_sym)
+
+      private define_method(name, *args, **kwargs, &block)
     end
 
     # Sets a user-defined property named {#subject}.
@@ -140,16 +144,11 @@ module RSpec
     #   # Output to the console
     #   #   Success: expected to eq "foobar".
     #
-    # @param const [Module, #object_id] A module to include in block context.
+    # @param const [Module, String] A module to include in block context.
     # @param block [Proc] The block to define the specs.
-    def self.describe(const = nil, &block)
-      desc = Sandbox.const_set(random_context_const_name, ::Class.new(self))
-
-      if const.is_a?(::Module)
-        desc.define_method(:described_class) { const }
-        desc.send(:protected, :described_class)
-      end
-
+    def self.describe(const, &block)
+      desc = ::Class.new(self)
+      desc.let(:described_class) { const } if const.is_a?(::Module)
       desc.instance_eval(&block)
     end
 
@@ -161,7 +160,7 @@ module RSpec
     # @example
     #   require "r_spec"
     #
-    #   RSpec.describe do
+    #   RSpec.describe "web resource" do
     #     context "when resource is not found" do
     #       pending "responds with 404"
     #     end
@@ -179,7 +178,7 @@ module RSpec
     #   "when", "with" or "without".
     # @param block [Proc] The block to define the specs.
     def self.context(_description = nil, &block)
-      desc = Sandbox.const_set(random_context_const_name, ::Class.new(self))
+      desc = ::Class.new(self)
       desc.instance_eval(&block)
     end
 
@@ -224,14 +223,14 @@ module RSpec
     def self.it(_name = nil, &block)
       raise ::ArgumentError, "Missing example block" unless block
 
-      i = it_example.new
-      i.instance_eval(&block)
+      example = ::Class.new(self) { include ExpectationHelper::It }.new
+      example.instance_eval(&block)
     rescue ::SystemExit
       Console.source(*block.source_location)
 
       exit false
     ensure
-      i.send(:terminate)
+      example.send(AFTER_METHOD)
     end
 
     # Use the {.its} method to define a single spec that specifies the actual
@@ -282,19 +281,21 @@ module RSpec
     def self.its(attribute, *args, **kwargs, &block)
       raise ::ArgumentError, "Missing example block" unless block
 
-      i = its_example.new
+      example = ::Class.new(self) do
+        include ExpectationHelper::Its
 
-      i.define_singleton_method(:actual) do
-        subject.public_send(attribute, *args, **kwargs)
-      end
+        define_method(:actual) do
+          subject.public_send(attribute, *args, **kwargs)
+        end
+      end.new
 
-      i.instance_eval(&block)
+      example.instance_eval(&block)
     rescue ::SystemExit
       Console.source(*block.source_location)
 
       exit false
     ensure
-      i.send(:terminate)
+      example.send(AFTER_METHOD)
     end
 
     # Defines a pending test case.
@@ -305,23 +306,16 @@ module RSpec
     # @example
     #   require "r_spec"
     #
-    #   RSpec.describe do
+    #   RSpec.describe "an example" do
     #     pending "is implemented but waiting" do
-    #       expect("something").to eq("getting finished")
+    #       expect something to be finished
     #     end
-    #   end
     #
-    #   # Output to the console
-    #   #   Warning: is implemented but waiting.
-    #
-    # @example
-    #   require "r_spec"
-    #
-    #   RSpec.describe do
     #     pending "is not yet implemented and waiting"
     #   end
     #
     #   # Output to the console
+    #   #   Warning: is implemented but waiting.
     #   #   Warning: is not yet implemented and waiting.
     #
     # @param message [String] The reason why the example is pending.
@@ -333,30 +327,7 @@ module RSpec
       Console.passed_spec Error::PendingExpectation.result(message)
     end
 
-    # @private
-    #
-    # @return [Class<Dsl>] The class of the example to be tested.
-    def self.it_example
-      ::Class.new(self) { include ExpectationHelper::It }
-    end
-
-    # @private
-    #
-    # @return [Class<Dsl>] The class of the example to be tested.
-    def self.its_example
-      ::Class.new(self) { include ExpectationHelper::Its }
-    end
-
-    # @private
-    #
-    # @return [String] A random constant name for a test class.
-    def self.random_context_const_name
-      "Context#{::SecureRandom.hex(4).to_i(16)}"
-    end
-
-    private_class_method :it_example, :its_example, :random_context_const_name
-
-    protected
+    private
 
     def described_class
       raise Error::UndefinedDescribedClass,
@@ -367,6 +338,8 @@ module RSpec
       raise Error::UndefinedSubject, "subject not explicitly defined"
     end
 
-    def terminate; end
+    define_method(AFTER_METHOD) do
+      # do nothing by default
+    end
   end
 end

data/lib/r_spec/error.rb

@@ -1,6 +1,7 @@
 # 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")
 

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

@@ -4,7 +4,7 @@ require_relative File.join("expectation_helper", "it")
 require_relative File.join("expectation_helper", "its")
 
 module RSpec
-  # Namespace for `it` and `its` helper modules.
+  # Namespace for {Dsl.it} and {Dsl.its}'s helper modules.
   module ExpectationHelper
   end
 end

data/lib/r_spec/expectation_helper/it.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require_relative "base"
+require_relative "shared"
 require_relative File.join("..", "expectation_target")
 
 module RSpec
   module ExpectationHelper
-    # {RSpec::DSL#it}'s expectation helper module.
+    # {RSpec::Dsl.it}'s expectation helper module.
     module It
-      include Base
+      include Shared
 
       # Create an expectation for a spec.
       #

data/lib/r_spec/expectation_helper/its.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require_relative "base"
+require_relative "shared"
 require_relative File.join("..", "expectation_target", "block")
 
 module RSpec
   module ExpectationHelper
-    # {RSpec::DSL#its}'s expectation helper module.
+    # {RSpec::Dsl.its}'s expectation helper module.
     module Its
-      include Base
+      include Shared
 
       # Wraps the target of an expectation with the actual value.
       #

data/lib/r_spec/expectation_helper/{base.rb → shared.rb}

@@ -75,7 +75,7 @@ module RSpec
     #
     # @see https://github.com/fixrb/matchi
     # @see https://github.com/fixrb/matchi-rspec
-    module Base
+    module Shared
       include ::Matchi::Helper
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r_spec
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta6
+  version: 1.0.0.beta7
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-13 00:00:00.000000000 Z
+date: 2021-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: expresenter
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 1.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 1.1.2
 - !ruby/object:Gem::Dependency
   name: spectus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.3
+        version: 3.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.3
+        version: 3.3.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -191,17 +191,17 @@ files:
 - 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/base.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/sandbox.rb
 homepage: https://r-spec.dev/
 licenses:
 - MIT

data/lib/r_spec/sandbox.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module RSpec
-  # Namespace to collect test classes.
-  #
-  # @api private
-  module Sandbox
-  end
-end