expresenter 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb63ac6ae40169d1d98b61f79fc0b4f90fe2977d80baf5949c0ba6c9853cfe59
-  data.tar.gz: 313bc8ef04d5916a19c0bef468835fb8b59c9dfb5b16a58b3cd11ea4b85c07f3
+  metadata.gz: f131ba55891e3abc10e518e86df59ab1ed2051f8c8dcdaddfe06ad40f62bde85
+  data.tar.gz: 1e717b60df591416909fa9d4d1772347924dd99904e2d5f85efb6cfbd4ba0bdb
 SHA512:
-  metadata.gz: f79e27247f4ec36d4e77ac7dd34f77486dac59b57a917992887eb0e8d7cfd308a39b429557e23bffaebc0d5e8799ed5584031c06dad043385755cd9f4340263a
-  data.tar.gz: fa66a109000fbc04de1122d92727b1c410e85f2d12cf3072e994a601bf4b6f8349086459398c7bcefd5ccb1f15d80b747c2e2c2df9e77e63fe820f54d2f72fd3
+  metadata.gz: eff6bc9cb5101af90834ee70cc856ddcd3796bb848e0c30eda86227293058dec97bcf401cd8807238282dd790fddb3d7c3792b9a304ddf96866a97c156750663
+  data.tar.gz: 2104cc18ff071a607e8e5a932f5c85c537f06f0f41060a849b4d6954b306e6a00dff1bf4f2f55d1e4647dbeb9b13dd5f9893287e5f531d229b189c10ffa0baa3

data/README.md

@@ -26,32 +26,67 @@ Or install it yourself as:
 
 ## Usage
 
+Assuming that an expectation is an assertion that is either `true` or `false`,
+qualifying it with `MUST`, `SHOULD` and `MAY`, we can draw up several scenarios:
+
+| Requirement levels        | **MUST** | **SHOULD** | **MAY** |
+| ------------------------- | -------- | ---------- | ------- |
+| Implemented & Matched     | `true`   | `true`     | `true`  |
+| Implemented & Not matched | `false`  | `true`     | `false` |
+| Implemented & Exception   | `false`  | `false`    | `false` |
+| Not implemented           | `false`  | `false`    | `true`  |
+
+Then,
+
+* for a `true` assertion, a `Expresenter::Pass` instance can be returned;
+* for a `false` assertion, a `Expresenter::Fail` exception can be raised.
+
+Both class share a common interface.
+
+Passed expectations can be classified as:
+
+* ✅ success
+* ⚠️ warning
+* 💡 info
+
+Failed expectations can be classified as:
+
+* ❌ failure
+* 💥 error
+
+## Example
+
 ```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 = Expresenter.call(true).with(actual: "FOO", error: nil, expected: "foo", got: true, negate: true, valid: true, matcher: :eql, level: :MUST)
+
+result.failed? # => false
+result.failure? # => false
+result.info? # => false
+result.warning? # => false
+result.to_sym # => :success
+result.char # => "."
+result.emoji # => "✅"
+result.passed? # => true
+result.negate? # => true
+result.error? # => false
+result.success? # => true
+result.valid? # => true
+result.inspect # => "Expresenter::Pass(actual: \"FOO\", error: nil, expected: \"foo\", got: true, matcher: :eql, negate: true, level: :MUST, valid: true)"
+result.definition # => "eql \"foo\""
+result.maybe_negate # => " not"
+result.summary # => "expected \"FOO\" not to eql \"foo\""
+result.colored_char # => "\e[32m.\e[0m"
+result.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"
+result.to_s # => "Success: expected \"FOO\" not to eql \"foo\"."
+result.titre # => "Success"
 ```
 
+### More Examples
+
+A full list of unit tests can be viewed (and executed) here:
+[./test.rb](https://github.com/fixrb/expresenter/blob/main/test.rb)
+
 ## Contact
 
 * Home page: https://github.com/fixrb/expresenter

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: expresenter
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Cyril Kato