expresenter 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7681f55eec320e3a594a0dd3bf83bed059059c4fe0786c21702d100cdcff4686
-  data.tar.gz: 120bfa0781682b31af511528a1271118329745a0348e11a9508eb20daf55c082
+  metadata.gz: 0ddc8ef213f1b42ee370c0e8332886cc0c0a158197bda6eaba301f0a0edeae6f
+  data.tar.gz: bee453e0190c6ce4e6a03955ad586af392ad424d2338196618ddcc608137d7ab
 SHA512:
-  metadata.gz: 9b9618acf9d062eacc9ac69ac3bca457fa6bbf7172baca826ee77f21365ef994e356fbf03b983fc39403a23fdecc7abdaa32ea4e5837a1260e5bf1696f8fb60c
-  data.tar.gz: 02a640a1f52ea92dce4e1fc8c88128142fb3ca9f2e14b811ba654008ce769f92c0d2137b88dd734a9bf91d8b68be758c0b6d862c3cf11d8b9aef4fc87bb02646
+  metadata.gz: 3589fcd607346650908c5c95f19eafe8a30813ccc869f2dde6c155112b3a9bbd64053d872f2de2c32eecc7ac520348043d9dd103bb9149c948dd76a5ad7856eb
+  data.tar.gz: bbb3b0eaa9173024a9df1d6806bb243597fcfa1b7d7e7c96e68e70f5532bfa92eaf44d8b58b4cde56810ac6fed993775805677e52f17df474790de5f138b9600

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Cyril Kato
+Copyright (c) 2021-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,21 @@
 # Expresenter
 
-[![Version](https://img.shields.io/github/v/tag/fixrb/expresenter?label=Version&logo=github)](https://github.com/fixrb/expresenter/releases)
+[![Version](https://img.shields.io/github/v/tag/fixrb/expresenter?label=Version&logo=github)](https://github.com/fixrb/expresenter/tags)
 [![Yard documentation](https://img.shields.io/badge/Yard-documentation-blue.svg?logo=github)](https://rubydoc.info/github/fixrb/expresenter/main)
-[![CI](https://github.com/fixrb/expresenter/workflows/CI/badge.svg?branch=main)](https://github.com/fixrb/expresenter/actions?query=workflow%3Aci+branch%3Amain)
+[![Ruby](https://github.com/fixrb/expresenter/workflows/Ruby/badge.svg?branch=main)](https://github.com/fixrb/expresenter/actions?query=workflow%3Aruby+branch%3Amain)
 [![RuboCop](https://github.com/fixrb/expresenter/workflows/RuboCop/badge.svg?branch=main)](https://github.com/fixrb/expresenter/actions?query=workflow%3Arubocop+branch%3Amain)
 [![License](https://img.shields.io/github/license/fixrb/expresenter?label=License&logo=github)](https://github.com/fixrb/expresenter/raw/main/LICENSE.md)
 
-> Expectation result presenter.
+> A Ruby gem for presenting test expectation results with rich formatting and requirement level support. Perfect for test frameworks and assertion libraries that need flexible result reporting with support for MUST/SHOULD/MAY requirement levels.
+
+## Features
+
+- Rich result formatting with colored output
+- Support for MUST/SHOULD/MAY requirement levels
+- Multiple result classification: success, warning, info, failure, and error
+- Emoji support for visual result indication (✅, ⚠️, 💡, ❌, 💥)
+- Flexible negation support for negative assertions
+- Detailed error reporting with custom messages
 
 ## Installation
 
@@ -19,7 +28,7 @@ gem "expresenter"
 And then execute:
 
 ```sh
-bundle
+bundle install
 ```
 
 Or install it yourself as:
@@ -65,7 +74,6 @@ The following parameters are required to instantiate the result:
 * `actual`: Returned value by the challenged subject.
 * `definition`: A readable string of the matcher and any expected values.
 * `error`: Any possible raised exception.
-* `expected`: The expected value.
 * `got`: The result of the boolean comparison between the actual value and the expected value through the matcher.
 * `negate`: Evaluated to a negative assertion?
 * `level`: The requirement level (`:MUST`, `:SHOULD` or `:MAY`).
@@ -75,7 +83,7 @@ The following parameters are required to instantiate the result:
 A passed expectation:
 
 ```ruby
-result = Expresenter.call(true).new(actual: "FOO", definition: 'eq "foo"', error: nil, expected: "foo", got: true, negate: true, level: :MUST)
+result = Expresenter.call(true).new(actual: "FOO", definition: 'eq "foo"', error: nil, got: true, negate: true, level: :MUST)
 
 result.failed? # => false
 result.failure? # => false
@@ -88,7 +96,6 @@ result.passed? # => true
 result.negate? # => true
 result.error? # => false
 result.success? # => true
-result.inspect # => "Expresenter::Pass(actual: \"FOO\", definition: \"eq \\\"foo\\\"\", error: nil, expected: \"foo\", got: true, negate: true, level: :MUST)"
 result.definition # => "eq \"foo\""
 result.summary # => "expected \"FOO\" not to eq \"foo\""
 result.colored_char # => "\e[32m.\e[0m"
@@ -101,7 +108,7 @@ result.titre # => "Success"
 A failed expectation:
 
 ```ruby
-result = Expresenter.call(false).new(actual: "foo", definition: "eq 42", error: Exception.new("BOOM"), expected: 42, got: true, negate: true, level: :MUST)
+result = Expresenter.call(false).new(actual: "foo", definition: "eq 42", error: Exception.new("BOOM"), got: true, negate: true, level: :MUST)
 
 result.failed? # => true
 result.failure? # => false
@@ -114,7 +121,6 @@ result.passed? # => false
 result.negate? # => true
 result.error? # => true
 result.success? # => true
-result.inspect # => "Expresenter::Fail(actual: \"foo\", definition: \"eq 42\", error: #<Exception: BOOM>, expected: 42, got: true, negate: true, level: :MUST)"
 result.definition # => "eq 42"
 result.summary # => "BOOM"
 result.colored_char # => "\e[31mE\e[0m"
@@ -131,13 +137,13 @@ To return the results which pass, and to raise the results which fail, the `with
 In this example, the result passes, the instance is therefore returned:
 
 ```ruby
-Expresenter.call(true).with(actual: "FOO", definition: 'eq "foo"', error: nil, expected: "foo", got: true, negate: true, level: :MUST) # => Expresenter::Pass(actual: "FOO", definition: "eq \"foo\"", error: nil, expected: "foo", got: true, negate: true, level: :MUST)
+Expresenter.call(true).with(actual: "FOO", definition: 'eq "foo"', error: nil, got: true, negate: true, level: :MUST) # => Expresenter::Pass(actual: "FOO", definition: "eq \"foo\"", error: nil, got: true, negate: true, level: :MUST)
 ```
 
 In this example, the result fails, so the exception is raised:
 
 ```ruby
-Expresenter.call(false).with(actual: "foo", definition: "eq 40", error: Exception.new("BOOM"), expected: 42, got: true, negate: true, level: :MUST)
+Expresenter.call(false).with(actual: "foo", definition: "eq 40", error: Exception.new("BOOM"), got: true, negate: true, level: :MUST)
 ```
 
 > Traceback (most recent call last):
@@ -163,13 +169,8 @@ __Expresenter__ follows [Semantic Versioning 2.0](https://semver.org/).
 
 ## License
 
-The [gem](https://rubygems.org/gems/expresenter) is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The [gem](https://rubygems.org/gems/expresenter) is available as open source under the terms of the [MIT License](https://github.com/fixrb/expresenter/raw/main/LICENSE.md).
 
-***
+## Sponsors
 
-<p>
-  This project is sponsored by:<br />
-  <a href="https://sashite.com/"><img
-    src="https://github.com/fixrb/expresenter/raw/main/img/sashite.png"
-    alt="Sashite" /></a>
-</p>
+This project is sponsored by [Sashité](https://sashite.com/)

data/lib/expresenter/common.rb

@@ -15,9 +15,6 @@ module Expresenter
     # @return [Exception, nil] Any possible raised exception.
     attr_reader :error
 
-    # @return [#object_id] The expected value.
-    attr_reader :expected
-
     # @return [#object_id] The result of the boolean comparison between the
     #   actual value and the expected value through the matcher.
     attr_reader :got
@@ -53,19 +50,6 @@ module Expresenter
       got.equal?(true)
     end
 
-    # A string containing a human-readable representation of the result.
-    #
-    # @return [String] The human-readable representation of the result.
-    def inspect
-      "#{self.class}(actual: #{actual.inspect}, " \
-        "definition: #{definition.inspect}, "     \
-        "error: #{error.inspect}, "               \
-        "expected: #{expected.inspect}, "         \
-        "got: #{got.inspect}, "                   \
-        "negate: #{negate?.inspect}, "            \
-        "level: #{level.inspect})"
-    end
-
     # The summary of the result.
     #
     # @return [String] A string representing the summary of the result.
@@ -74,8 +58,6 @@ module Expresenter
         error.message
       elsif actual.is_a?(::Exception)
         actual.message
-      elsif actual == expected
-        ["expected", negation, "to", definition].compact.join(SPACE)
       else
         ["expected", actual.inspect, negation, "to", definition].compact.join(SPACE)
       end

data/lib/expresenter/fail.rb

@@ -31,16 +31,14 @@ module Expresenter
     # @param definition [String] A readable string of the matcher and any
     #   expected values.
     # @param error      [Exception, nil] Any possible raised exception.
-    # @param expected   [#object_id] The expected value.
     # @param got        [Boolean, nil] The result of the boolean comparison
     #   between the actual value and the expected value through the matcher.
     # @param negate     [Boolean] Evaluated to a negative assertion?
     # @param level      [:MUST, :SHOULD, :MAY] The requirement level.
-    def initialize(actual:, definition:, error:, expected:, got:, negate:, level:)
+    def initialize(actual:, definition:, error:, got:, negate:, level:)
       @actual     = actual
       @definition = definition
       @error      = error
-      @expected   = expected
       @got        = got
       @negate     = negate
       @level      = level

data/lib/expresenter/pass.rb

@@ -39,16 +39,14 @@ module Expresenter
     # @param definition [String] A readable string of the matcher and any
     #   expected values.
     # @param error    [Exception, nil] Any possible raised exception.
-    # @param expected [#object_id] The expected value.
     # @param got      [Boolean, nil] The result of the boolean comparison
     #   between the actual value and the expected value through the matcher.
     # @param negate   [Boolean] Evaluated to a negative assertion?
     # @param level    [:MUST, :SHOULD, :MAY] The requirement level.
-    def initialize(actual:, definition:, error:, expected:, got:, negate:, level:)
+    def initialize(actual:, definition:, error:, got:, negate:, level:)
       @actual     = actual
       @definition = definition
       @error      = error
-      @expected   = expected
       @got        = got
       @negate     = negate
       @level      = level

data/lib/expresenter.rb

@@ -3,7 +3,7 @@
 # Namespace for the Expresenter library.
 #
 # @example A passed expectation result presenter.
-#   Expresenter.call(true).with(actual: "FOO", definition: 'eql "foo"', error: nil, expected: "foo", got: true, negate: true, level: :MUST) # => Expresenter::Pass(actual: "FOO", definition: "eql \"foo\"", error: nil, expected: "foo", got: true, negate: true, level: :MUST)
+#   Expresenter.call(true).with(actual: "FOO", definition: 'eql "foo"', error: nil, got: true, negate: true, level: :MUST) # => Expresenter::Pass(actual: "FOO", definition: "eql \"foo\"", error: nil, got: true, negate: true, level: :MUST)
 module Expresenter
   # @param is_passed [Boolean] The value of an assertion.
   #

metadata

@@ -1,141 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expresenter
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Cyril Kato
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-23 00:00:00.000000000 Z
-dependencies:
-- !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: 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'
+date: 2024-12-29 00:00:00.000000000 Z
+dependencies: []
 description: Expectation result presenter.
 email: contact@cyril.email
 executables: []
@@ -151,8 +24,8 @@ files:
 homepage: https://github.com/fixrb/expresenter
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -160,15 +33,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
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Expectation result presenter.
 test_files: []