expresenter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb63ac6ae40169d1d98b61f79fc0b4f90fe2977d80baf5949c0ba6c9853cfe59
+  data.tar.gz: 313bc8ef04d5916a19c0bef468835fb8b59c9dfb5b16a58b3cd11ea4b85c07f3
+SHA512:
+  metadata.gz: f79e27247f4ec36d4e77ac7dd34f77486dac59b57a917992887eb0e8d7cfd308a39b429557e23bffaebc0d5e8799ed5584031c06dad043385755cd9f4340263a
+  data.tar.gz: fa66a109000fbc04de1122d92727b1c410e85f2d12cf3072e994a601bf4b6f8349086459398c7bcefd5ccb1f15d80b747c2e2c2df9e77e63fe820f54d2f72fd3

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+# Expresenter
+
+[![Build Status](https://api.travis-ci.org/fixrb/expresenter.svg?branch=main)][travis]
+[![Code Climate](https://codeclimate.com/github/fixrb/expresenter/badges/gpa.svg)][codeclimate]
+[![Gem Version](https://badge.fury.io/rb/expresenter.svg)][gem]
+[![Inline docs](https://inch-ci.org/github/fixrb/expresenter.svg?branch=main)][inchpages]
+[![Documentation](https://img.shields.io/:yard-docs-38c800.svg)][rubydoc]
+
+> Expectation result presenter.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "expresenter"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install expresenter
+
+## Usage
+
+```ruby
+result = Expresenter.call(true, actual: "FOO", error: nil, expected: "foo", got: true, negate: true, valid: true, matcher: :eql, level: :MUST)
+
+actual.failed? # => false
+actual.failure? # => false
+actual.info? # => false
+actual.warning? # => false
+actual.to_sym # => :success
+actual.char # => "."
+actual.emoji # => "✅"
+actual.passed? # => true
+actual.negate? # => true
+actual.error? # => false
+actual.success? # => true
+actual.valid? # => true
+actual.inspect # => "Expresenter::Pass(actual: \"FOO\", error: nil, expected: \"foo\", got: true, matcher: :eql, negate: true, level: :MUST, valid: true)"
+actual.definition # => "eql \"foo\""
+actual.maybe_negate # => " not"
+actual.summary # => "expected \"FOO\" not to eql \"foo\""
+actual.colored_char # => "\e[32m.\e[0m"
+actual.colored_string # => "\e[32mSuccess: expected \"FOO\" not to eql \"foo\".\e[0m"
+result.message # => "Success: expected \"FOO\" not to eql \"foo\"."
+actual.to_s # => "Success: expected \"FOO\" not to eql \"foo\"."
+actual.titre # => "Success"
+```
+
+## Contact
+
+* Home page: https://github.com/fixrb/expresenter
+* Bugs/issues: https://github.com/fixrb/expresenter/issues
+
+## Rubies
+
+* [MRI](https://www.ruby-lang.org/)
+* [Rubinius](https://rubinius.com/)
+* [JRuby](https://www.jruby.org/)
+
+## Versioning
+
+__Expresenter__ follows [Semantic Versioning 2.0](https://semver.org/).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+***
+
+<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>
+
+[gem]: https://rubygems.org/gems/expresenter
+[travis]: https://travis-ci.org/fixrb/expresenter
+[codeclimate]: https://codeclimate.com/github/fixrb/expresenter
+[inchpages]: https://inch-ci.org/github/fixrb/expresenter
+[rubydoc]: https://rubydoc.info/gems/expresenter/frames

data/lib/expresenter.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Namespace for the Expresenter library.
+module Expresenter
+  # @raise [Fail] A failed spec result.
+  # @return [Pass] A passed spec result.
+  def self.call(is_passed)
+    is_passed ? Pass : Fail
+  end
+end
+
+require_relative File.join("expresenter", "fail")
+require_relative File.join("expresenter", "pass")

data/lib/expresenter/base.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+module Expresenter
+  # Common collection of methods for Result's classes.
+  module Base
+    # @return [#object_id] Returned value by the challenged subject.
+    attr_reader :actual
+
+    # @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
+
+    # @return [#object_id] The matcher.
+    attr_reader :matcher
+
+    # @return [:MUST, :SHOULD, :MAY] The requirement level of the expectation.
+    attr_reader :level
+
+    # Common initialize method.
+    #
+    # @param actual   [#object_id] Returned value by the challenged subject.
+    # @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 valid    [Boolean] Report if the test was true or false?
+    # @param matcher  [Symbol] The matcher.
+    # @param level    [:MUST, :SHOULD, :MAY] The requirement level.
+    def initialize(actual:, error:, expected:, got:, negate:, valid:,
+                   matcher:, level:)
+
+      @actual   = actual
+      @error    = error
+      @expected = expected
+      @got      = got
+      @negate   = negate
+      @valid    = valid
+      @matcher  = matcher
+      @level    = level
+
+      super(to_s) if failed?
+    end
+
+    # Did the test pass?
+    #
+    # @return [Boolean] The spec passed or failed?
+    def passed?
+      !failed?
+    end
+
+    # The value of the negate instance variable.
+    #
+    # @return [Boolean] Evaluated to a negative assertion?
+    def negate?
+      @negate
+    end
+
+    # The state of error.
+    #
+    # @return [Boolean] The test raised an error?
+    def error?
+      !error.nil?
+    end
+
+    # The state of success.
+    #
+    # @return [Boolean] The test was a success?
+    def success?
+      got.equal?(true)
+    end
+
+    # The value of the boolean comparison between the actual value and the
+    # expected value.
+    #
+    # @return [Boolean] The test was true or false?
+    def valid?
+      @valid
+    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}, "     \
+                    "error: #{error.inspect}, "       \
+                    "expected: #{expected.inspect}, " \
+                    "got: #{got.inspect}, "           \
+                    "matcher: #{matcher.inspect}, "   \
+                    "negate: #{negate?.inspect}, "    \
+                    "level: #{level.inspect}, "       \
+                    "valid: #{valid?.inspect})"       \
+    end
+
+    # The readable definition.
+    #
+    # @return [String] A readable string of the definition.
+    def definition
+      [matcher, expected&.inspect].compact.join(" ")
+    end
+
+    # The negation, if any.
+    #
+    # @return [String] The negation, or an empty string.
+    def maybe_negate
+      negate? ? " not" : ""
+    end
+
+    # The summary of the result.
+    #
+    # @return [String] A string representing the summary of the result.
+    def summary
+      if error?
+        error.message
+      elsif actual.is_a?(::Exception)
+        actual.message
+      elsif actual == expected
+        "expected#{maybe_negate} to #{definition}"
+      else
+        "expected #{actual.inspect}#{maybe_negate} to #{definition}"
+      end
+    end
+
+    # Express the result with one colored char.
+    #
+    # @return [String] The colored char that identify the result.
+    def colored_char
+      color(char)
+    end
+
+    # The colored string representation of the result.
+    #
+    # @return [String] A string representing the result.
+    def colored_string
+      color(to_s)
+    end
+
+    # The representation of the result.
+    #
+    # @return [String] A string representing the result.
+    def to_s
+      "#{titre}: #{summary}."
+    end
+
+    # Titre for the result.
+    #
+    # @return [String] A string representing the titre.
+    def titre
+      if error?
+        error.class.name
+      else
+        to_sym.to_s.capitalize
+      end
+    end
+
+    protected
+
+    def color(str)
+      if success?
+        "\e[32m#{str}\e[0m"
+      elsif info?
+        "\e[36m#{str}\e[0m"
+      elsif warning?
+        "\e[33m#{str}\e[0m"
+      elsif failure?
+        "\e[35m#{str}\e[0m"
+      else
+        "\e[31m#{str}\e[0m"
+      end
+    end
+  end
+end

data/lib/expresenter/fail.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Expresenter
+  # The class that is responsible for reporting that the expectation is false.
+  class Fail < ::StandardError
+    include Base
+
+    # @raise [Fail] A failed spec result.
+    def self.with(**details)
+      raise new(**details)
+    end
+
+    # Did the test fail?
+    #
+    # @return [Boolean] The spec passed or failed?
+    def failed?
+      true
+    end
+
+    # The state of failure.
+    #
+    # @return [Boolean] The test was a failure?
+    def failure?
+      !error?
+    end
+
+    # The state of info.
+    #
+    # @return [Boolean] The test was an info?
+    def info?
+      false
+    end
+
+    # The state of warning.
+    #
+    # @return [Boolean] The test was a warning?
+    def warning?
+      false
+    end
+
+    # Identify the state of the result.
+    #
+    # @return [Symbol] The identifier of the state.
+    def to_sym
+      failure? ? :failure : :error
+    end
+
+    # Express the result with one char.
+    #
+    # @return [String] The char that identify the result.
+    def char
+      if failure?
+        "F"
+      else
+        "E"
+      end
+    end
+
+    # Express the result with one emoji.
+    #
+    # @return [String] The emoji that identify the result.
+    def emoji
+      if failure?
+        "❌"
+      else
+        "💥"
+      end
+    end
+  end
+end

data/lib/expresenter/pass.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Expresenter
+  # The class that is responsible for reporting that the expectation is true.
+  class Pass
+    include Base
+
+    # @return [Pass] A passed spec result.
+    def self.with(**details)
+      new(**details)
+    end
+
+    alias message to_s
+
+    # Did the test fail?
+    #
+    # @return [Boolean] The spec passed or failed?
+    def failed?
+      false
+    end
+
+    # The state of failure.
+    #
+    # @return [Boolean] The test was a failure?
+    def failure?
+      false
+    end
+
+    # The state of info.
+    #
+    # @return [Boolean] The test was an info?
+    def info?
+      !error.nil?
+    end
+
+    # The state of warning.
+    #
+    # @return [Boolean] The test was a warning?
+    def warning?
+      got.equal?(false)
+    end
+
+    # Identify the state of the result.
+    #
+    # @return [Symbol] The identifier of the state.
+    def to_sym
+      return :success if success?
+      return :warning if warning?
+
+      :info
+    end
+
+    # Express the result with one char.
+    #
+    # @return [String] The char that identify the result.
+    def char
+      if success?
+        "."
+      elsif warning?
+        "W"
+      else
+        "I"
+      end
+    end
+
+    # Express the result with one emoji.
+    #
+    # @return [String] The emoji that identify the result.
+    def emoji
+      if success?
+        "✅"
+      elsif warning?
+        "⚠️"
+      else
+        "💡"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: expresenter
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cyril Kato
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-05-11 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'
+description: Expectation result presenter.
+email: contact@cyril.email
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/expresenter.rb
+- lib/expresenter/base.rb
+- lib/expresenter/fail.rb
+- lib/expresenter/pass.rb
+homepage: https://github.com/fixrb/expresenter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Expectation result presenter.
+test_files: []