spectus 4.0.3 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d2dc0863871f3794105ca9de38893d86ca937fe09bc8f90772d22f23551db79
-  data.tar.gz: efda8aae27fb68317b3d450ede09c13e22c7d5c8e638ba8c8fd8169ce5b93f03
+  metadata.gz: 3f0cce51d702c1c3d143fdad6af9384ebe7cbca8718a671d928ca8b5a111fe04
+  data.tar.gz: 1648b947935ac87ef6c5b02c16a066b92bf44bbcf5d8bfae0d87c07d3697cf91
 SHA512:
-  metadata.gz: 07e371fdb35d33e5451ca8188be95e153d08e58b0e32791081ecfed6d42a7eb16917ed711cff89bcaca7e27b2b10a59ba6676e1896e7f6cd15eb255861c1f2d4
-  data.tar.gz: 777d8c69e1beede896cd074c3c839707497a6775fe2e4263f309d66128a25b914beeee4ae822fa43c58d0b6279215c0f8a39ffe08b595ced35cdf02714e15a4e
+  metadata.gz: 165ed9b4d2528c514dcf9856124a9da2d43c414757e2bd31716b9098f9fa55c5b4f9db4d65f35a0b94696c9bde2143c40a7285ddc428171496b1f56d285ac87f
+  data.tar.gz: 8c4a74459502da707d751ac829efccd41bdb9f49667eb7b94d460f93fbf427b25e7c888d16c207889366bb56e51f58ccad6e3716c2709bb28d2af4d5dd985bee

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-2021 Cyril Kato
+Copyright (c) 2014-2024 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,12 +1,14 @@
 # Spectus
 
-[![Version](https://img.shields.io/github/v/tag/fixrb/spectus?label=Version&logo=github)](https://github.com/fixrb/spectus/releases)
+[![Version](https://img.shields.io/github/v/tag/fixrb/spectus?label=Version&logo=github)](https://github.com/fixrb/spectus/tags)
 [![Yard documentation](https://img.shields.io/badge/Yard-documentation-blue.svg?logo=github)](https://rubydoc.info/github/fixrb/spectus/main)
-[![CI](https://github.com/fixrb/spectus/workflows/CI/badge.svg?branch=main)](https://github.com/fixrb/spectus/actions?query=workflow%3Aci+branch%3Amain)
+[![Ruby](https://github.com/fixrb/spectus/workflows/Ruby/badge.svg?branch=main)](https://github.com/fixrb/spectus/actions?query=workflow%3Aruby+branch%3Amain)
 [![RuboCop](https://github.com/fixrb/spectus/workflows/RuboCop/badge.svg?branch=main)](https://github.com/fixrb/spectus/actions?query=workflow%3Arubocop+branch%3Amain)
 [![License](https://img.shields.io/github/license/fixrb/spectus?label=License&logo=github)](https://github.com/fixrb/spectus/raw/main/LICENSE.md)
 
-> Expectation library with [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt) requirement levels 🚥
+> A Ruby library for defining expectations with precision, using [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt) compliance levels. 🚥
+
+![A traffic light with three distinct sections](https://github.com/fixrb/spectus/raw/main/img/spectus.png)
 
 ## Installation
 
@@ -19,7 +21,7 @@ gem "spectus"
 And then execute:
 
 ```sh
-bundle
+bundle install
 ```
 
 Or install it yourself as:
@@ -113,43 +115,11 @@ My bad! ActiveSupport was not imported. 🤦‍♂️
 
 Anyways, the test passes because the exception produced is `NoMethodError`, meaning that the functionality is not implemented.
 
-## Code Isolation
-
-When executing expectations, side-effects may occur.
-Because they may or may not be desired, each requirement level has 2 versions:
-
-* if it does not end with `!`, its test is performed without isolation;
-* if it ends with `!`, its test is performed in isolation.
-
-Example of test without isolation:
-
-```ruby
-greeting = "Hello, world!"
-
-definition = Spectus.must Matchi::Eq.new("Hello, Alice!")
-definition.call { greeting.gsub!("world", "Alice") }
-# => Expresenter::Pass(actual: "Hello, Alice!", definition: "eq \"Hello, Alice!\"", error: nil, expected: "Hello, Alice!", got: true, negate: false, level: :MUST)
-
-greeting # => "Hello, Alice!"
-```
-
-Example of test in isolation:
-
-```ruby
-greeting = "Hello, world!"
-
-definition = Spectus.must! Matchi::Eq.new("Hello, Alice!")
-definition.call { greeting.gsub!("world", "Alice") }
-# => Expresenter::Pass(actual: "Hello, Alice!", definition: "eq \"Hello, Alice!\"", error: nil, expected: "Hello, Alice!", got: true, negate: false, level: :MUST)
-
-greeting # => "Hello, world!"
-```
-
 ## Contact
 
 * Home page: https://github.com/fixrb/spectus
 * Bugs/issues: https://github.com/fixrb/spectus/issues
-* Blog post: https://batman.buzz/a-spectus-tutorial-expectations-with-rfc-2119-compliance-1fc769861c1
+* Blog post: https://cyrilllllll.medium.com/a-spectus-tutorial-expectations-with-rfc-2119-compliance-1fc769861c1
 
 ## Versioning
 
@@ -159,11 +129,11 @@ __Spectus__ follows [Semantic Versioning 2.0](https://semver.org/).
 
 The [gem](https://rubygems.org/gems/spectus) is available as open source under the terms of the [MIT License](https://github.com/fixrb/spectus/raw/main/LICENSE.md).
 
-***
+---
 
 <p>
   This project is sponsored by:<br />
   <a href="https://sashite.com/"><img
     src="https://github.com/fixrb/spectus/raw/main/img/sashite.png"
-    alt="Sashite" /></a>
+    alt="Sashité" /></a>
 </p>

data/lib/spectus/requirement/base.rb

@@ -10,11 +10,9 @@ module Spectus
     class Base
       # Initialize the requirement level class.
       #
-      # @param isolate  [Boolean]   Compute actual in a subprocess.
       # @param matcher  [#matches?] The matcher.
       # @param negate   [Boolean]   Invert the matcher or not.
-      def initialize(isolate:, matcher:, negate:)
-        @isolate  = isolate
+      def initialize(matcher:, negate:)
         @matcher  = matcher
         @negate   = negate
       end
@@ -27,8 +25,8 @@ module Spectus
       # @see https://github.com/fixrb/expresenter
       #
       # @api public
-      def call(&block)
-        test = ::TestTube.invoke(isolate: @isolate, matcher: @matcher, negate: @negate, &block)
+      def call(&)
+        test = ::TestTube.invoke(matcher: @matcher, negate: @negate, &)
 
         ::Expresenter.call(passed?(test)).with(
           actual:     test.actual,
@@ -51,13 +49,13 @@ module Spectus
       #
       #   definition = Spectus.must Matchi::Be.new(1)
       #   definition.inspect
-      #   # => "#<MUST Matchi::Be(1) isolate=false negate=false>"
+      #   # => "#<MUST Matchi::Be(1) negate=false>"
       #
       # @return [String] The human-readable representation of the definition.
       #
       # @api public
       def inspect
-        "#<#{self.class.level} #{@matcher.inspect} isolate=#{@isolate} negate=#{@negate}>"
+        "#<#{self.class.level} #{@matcher.inspect} negate=#{@negate}>"
       end
 
       # :nocov:

data/lib/spectus.rb

@@ -15,7 +15,7 @@ module Spectus
   #   require "matchi/eq"
   #
   #   Spectus.must Matchi::Eq.new("FOO")
-  #   # => #<MUST Matchi::Eq("FOO") isolate=false negate=false>
+  #   # => #<MUST Matchi::Eq("FOO") negate=false>
   #
   # @param matcher [#matches?] The matcher.
   #
@@ -23,27 +23,7 @@ module Spectus
   #
   # @api public
   def self.must(matcher)
-    Requirement::Required.new(
-      isolate: false,
-      negate:  false,
-      matcher: matcher
-    )
-  end
-
-  # @example An absolute requirement definition with isolation
-  #   require "spectus"
-  #   require "matchi/eq"
-  #
-  #   Spectus.must! Matchi::Eq.new("FOO")
-  #   # => #<MUST Matchi::Eq("FOO") isolate=true negate=false>
-  #
-  # @see must
-  def self.must!(matcher)
-    Requirement::Required.new(
-      isolate: true,
-      negate:  false,
-      matcher: matcher
-    )
+    Requirement::Required.new(negate: false, matcher:)
   end
 
   # This method mean that the definition is an absolute prohibition of the specification.
@@ -53,33 +33,13 @@ module Spectus
   #   require "matchi/be"
   #
   #   Spectus.must_not Matchi::Be.new(42)
-  #   # => #<MUST Matchi::Be(42) isolate=false negate=true>
+  #   # => #<MUST Matchi::Be(42) negate=true>
   #
   # @param matcher [#matches?] The matcher.
   #
   # @return [Requirement::Required] An absolute prohibition level instance.
   def self.must_not(matcher)
-    Requirement::Required.new(
-      isolate: false,
-      negate:  true,
-      matcher: matcher
-    )
-  end
-
-  # @example An absolute prohibition definition with isolation
-  #   require "spectus"
-  #   require "matchi/be"
-  #
-  #   Spectus.must_not! Matchi::Be.new(42)
-  #   # => #<MUST Matchi::Be(42) isolate=true negate=true>
-  #
-  # @see must_not
-  def self.must_not!(matcher)
-    Requirement::Required.new(
-      isolate: true,
-      negate:  true,
-      matcher: matcher
-    )
+    Requirement::Required.new(negate: true, matcher:)
   end
 
   # This method mean that there may exist valid reasons in particular
@@ -91,33 +51,13 @@ module Spectus
   #   require "matchi/be"
   #
   #   Spectus.should Matchi::Be.new(true)
-  #   # => #<SHOULD Matchi::Be(true) isolate=false negate=false>
+  #   # => #<SHOULD Matchi::Be(true) negate=false>
   #
   # @param matcher [#matches?] The matcher.
   #
   # @return [Requirement::Recommended] A recommended requirement level instance.
   def self.should(matcher)
-    Requirement::Recommended.new(
-      isolate: false,
-      negate:  false,
-      matcher: matcher
-    )
-  end
-
-  # @example A recommended definition with isolation
-  #   require "spectus"
-  #   require "matchi/be"
-  #
-  #   Spectus.should! Matchi::Be.new(true)
-  #   # => #<SHOULD Matchi::Be(true) isolate=true negate=false>
-  #
-  # @see should
-  def self.should!(matcher)
-    Requirement::Recommended.new(
-      isolate: true,
-      negate:  false,
-      matcher: matcher
-    )
+    Requirement::Recommended.new(negate: false, matcher:)
   end
 
   # This method mean that there may exist valid reasons in particular
@@ -130,34 +70,14 @@ module Spectus
   #   require "matchi/raise_exception"
   #
   #   Spectus.should_not Matchi::RaiseException.new(NoMethodError)
-  #   # => #<SHOULD Matchi::RaiseException(NoMethodError) isolate=false negate=true>
+  #   # => #<SHOULD Matchi::RaiseException(NoMethodError) negate=true>
   #
   # @param matcher [#matches?] The matcher.
   #
   # @return [Requirement::Recommended] A not recommended requirement level
   #   instance.
   def self.should_not(matcher)
-    Requirement::Recommended.new(
-      isolate: false,
-      negate:  true,
-      matcher: matcher
-    )
-  end
-
-  # @example A not recommended definition with isolation
-  #   require "spectus"
-  #   require "matchi/raise_exception"
-  #
-  #   Spectus.should_not! Matchi::RaiseException.new(NoMethodError)
-  #   # => #<SHOULD Matchi::RaiseException(NoMethodError) isolate=true negate=true>
-  #
-  # @see should_not
-  def self.should_not!(matcher)
-    Requirement::Recommended.new(
-      isolate: true,
-      negate:  true,
-      matcher: matcher
-    )
+    Requirement::Recommended.new(negate: true, matcher:)
   end
 
   # This method mean that an item is truly optional.
@@ -176,32 +96,12 @@ module Spectus
   #   require "matchi/match"
   #
   #   Spectus.may Matchi::Match.new(/^foo$/)
-  #   # => #<MAY Matchi::Match(/^foo$/) isolate=false negate=false>
+  #   # => #<MAY Matchi::Match(/^foo$/) negate=false>
   #
   # @param matcher [#matches?] The matcher.
   #
   # @return [Requirement::Optional] An optional requirement level instance.
   def self.may(matcher)
-    Requirement::Optional.new(
-      isolate: false,
-      negate:  false,
-      matcher: matcher
-    )
-  end
-
-  # @example An optional definition with isolation
-  #   require "spectus"
-  #   require "matchi/match"
-  #
-  #   Spectus.may! Matchi::Match.new(/^foo$/)
-  #   # => #<MAY Matchi::Match(/^foo$/) isolate=true negate=false>
-  #
-  # @see may
-  def self.may!(matcher)
-    Requirement::Optional.new(
-      isolate: true,
-      negate:  false,
-      matcher: matcher
-    )
+    Requirement::Optional.new(negate: false, matcher:)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spectus
 version: !ruby/object:Gem::Version
-  version: 4.0.3
+  version: 5.0.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-31 00:00:00.000000000 Z
+date: 2024-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: expresenter
@@ -16,168 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.4.1
 - !ruby/object:Gem::Dependency
   name: test_tube
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.1
-- !ruby/object:Gem::Dependency
-  name: brutal
-  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: 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: matchi
-  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-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'
+        version: 3.0.0
 description: "Expectation library with RFC 2119's requirement levels \U0001F6A5"
 email: contact@cyril.email
 executables: []
@@ -195,7 +55,8 @@ files:
 homepage: https://github.com/fixrb/spectus
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -204,14 +65,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: "Expectation library with RFC 2119's requirement levels \U0001F6A5"