bcdd-result 0.11.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0043be8de0b26bac0d803f067537fbc65e4a54f3a38a2644c01bd987d87c7b5
-  data.tar.gz: f152ac78abb8847721f2b2ec3c3fd1db66016c421f5348f038a79501a86f761a
+  metadata.gz: 3375c9c36b12a792a50e285c32f1526f660360b95d2a3d85103b9147c7c61a68
+  data.tar.gz: c1f399841dad795a4fa10bc15a4c0dac774c104dc9b2237dc5b602e5956c54e5
 SHA512:
-  metadata.gz: 17abccc11ad3c7ccd2cedc6f9634659decee457e08ef1c8dfb13d59d2afc7390fdeb6fc1d48749362d691815c41b789197d2bf79b5f57f9e7e07ad770ddbb304
-  data.tar.gz: 2e0b67fbc99ef2a3a8187a2d42212e8cbadca22a2c2625c3be8e7bbfb5d2b92689b9a27b7592a295863e89437e912d34cb8f6e5a2e77e9c0afdbcbf7c4591bd6
+  metadata.gz: f00e7da2c78ae1c88998b05af02f4ebea701a22797a0a103072ce7bc2532331ecfa2202f677aa9f107e30b33b866421648a98179ddc5c4239b33ca926e584490
+  data.tar.gz: 715b1015481ed2bb317dcbbf6834832fe8df5e3542f0824606c4127c23811357459a995585c27cfd4366410b5d9ca79843cf1cee3ef04357e2a416d2e042379d

data/.rubocop.yml

@@ -8,10 +8,17 @@ require:
 AllCops:
   NewCops: enable
   TargetRubyVersion: 2.7
+  Exclude:
+    - 'examples/**/*'
+    - 'vendor/**/*'
+    - 'spec/fixtures/**/*'
+    - 'tmp/**/*'
+    - '.git/**/*'
+    - 'bin/*'
 
 Lint/RescueException:
   Exclude:
-    - lib/bcdd/result/transitions.rb
+    - lib/bcdd/result/transitions/tracking/enabled.rb
 
 Layout/LineLength:
   Max: 120
@@ -25,6 +32,10 @@ Layout/MultilineMethodCallIndentation:
 Lint/UnderscorePrefixedVariableName:
   Enabled: false
 
+Lint/UnusedMethodArgument:
+  Exclude:
+    - lib/bcdd/result/transitions/listener.rb
+
 Style/AccessModifierDeclarations:
   Enabled: false
 
@@ -65,6 +76,10 @@ Metrics/ClassLength:
     - lib/bcdd/result.rb
     - test/**/*.rb
 
+Metrics/AbcSize:
+  Exclude:
+    - lib/bcdd/result/transitions/tracking/enabled.rb
+
 Minitest/MultipleAssertions:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,41 +1,115 @@
 - [\[Unreleased\]](#unreleased)
-- [\[0.11.0\] - 2024-01-02](#0110---2024-01-02)
+- [\[0.13.0\] - 2024-02-01](#0130---2024-02-01)
   - [Added](#added)
   - [Changed](#changed)
-- [\[0.10.0\] - 2023-12-31](#0100---2023-12-31)
+- [\[0.12.0\] - 2024-01-07](#0120---2024-01-07)
   - [Added](#added-1)
-- [\[0.9.1\] - 2023-12-12](#091---2023-12-12)
   - [Changed](#changed-1)
-  - [Fixed](#fixed)
-- [\[0.9.0\] - 2023-12-12](#090---2023-12-12)
+- [\[0.11.0\] - 2024-01-02](#0110---2024-01-02)
   - [Added](#added-2)
   - [Changed](#changed-2)
-- [\[0.8.0\] - 2023-12-11](#080---2023-12-11)
+- [\[0.10.0\] - 2023-12-31](#0100---2023-12-31)
   - [Added](#added-3)
+- [\[0.9.1\] - 2023-12-12](#091---2023-12-12)
   - [Changed](#changed-3)
-  - [Removed](#removed)
-- [\[0.7.0\] - 2023-10-27](#070---2023-10-27)
+  - [Fixed](#fixed)
+- [\[0.9.0\] - 2023-12-12](#090---2023-12-12)
   - [Added](#added-4)
   - [Changed](#changed-4)
-- [\[0.6.0\] - 2023-10-11](#060---2023-10-11)
+- [\[0.8.0\] - 2023-12-11](#080---2023-12-11)
   - [Added](#added-5)
   - [Changed](#changed-5)
-- [\[0.5.0\] - 2023-10-09](#050---2023-10-09)
+  - [Removed](#removed)
+- [\[0.7.0\] - 2023-10-27](#070---2023-10-27)
   - [Added](#added-6)
-- [\[0.4.0\] - 2023-09-28](#040---2023-09-28)
-  - [Added](#added-7)
   - [Changed](#changed-6)
+- [\[0.6.0\] - 2023-10-11](#060---2023-10-11)
+  - [Added](#added-7)
+  - [Changed](#changed-7)
+- [\[0.5.0\] - 2023-10-09](#050---2023-10-09)
+  - [Added](#added-8)
+- [\[0.4.0\] - 2023-09-28](#040---2023-09-28)
+  - [Added](#added-9)
+  - [Changed](#changed-8)
   - [Removed](#removed-1)
 - [\[0.3.0\] - 2023-09-26](#030---2023-09-26)
-  - [Added](#added-8)
+  - [Added](#added-10)
 - [\[0.2.0\] - 2023-09-26](#020---2023-09-26)
-  - [Added](#added-9)
+  - [Added](#added-11)
   - [Removed](#removed-2)
 - [\[0.1.0\] - 2023-09-25](#010---2023-09-25)
-  - [Added](#added-10)
+  - [Added](#added-12)
 
 ## [Unreleased]
 
+## [0.13.0] - 2024-02-01
+
+### Added
+
+- `BCDD::Result::Context#and_expose` - Raise error when trying to expose an invalid key.
+
+- `BCDD::Result.configuration` - Accept freeze option (default: `true`). When true, the configuration will be frozen after the block execution.
+
+- `BCDD::Result.config.transitions` - Add transitions feature configuration.
+  - `config.transitions.listener =` - Set a listener to be called during the result transitions tracking. It must be a class that includes `BCDD::Result::Transitions::Listener`.
+  - `config.transitions.trace_id =` - Set a lambda (must have arity 0) to be called to get a trace id. Use to correlate different or the same operation (executed multiple times).
+
+- Add transitions metadata property `:ids_matrix`. It is a simplification of the `:ids_tree` property. The matrix rows are the direct transitions from the root transition block, and the columns are the transitions nested from the direct transitions.
+  ```ruby
+  # ids_matrix       # {
+  0 | 1 | 2 | 3 | 4  #   0 => [0, 0],
+  - | - | - | - | -  #   1 => [1, 1],
+  0 |   |   |   |    #   2 => [1, 2],
+  1 | 1 | 2 |   |    #   3 => [2, 1],
+  2 | 3 |   |   |    #   4 => [3, 1],
+  3 | 4 | 5 | 6 | 7  #   5 => [3, 2],
+  4 | 8 |   |   |    #   6 => [3, 3],
+                     #   7 => [3, 4],
+                     #   8 => [4, 1]
+                     # }
+  ```
+
+- Add `BCDD::Result::Transitions::Listeners[]` - It creates a listener of listeners, which will be called in the order they were added.
+
+### Changed
+
+- **(BREAKING)** Rename `Given()` type from `:given` to `:_given_`.
+
+- **(BREAKING)** Rename `Continue()` type from `:continued` to `:_continue_`.
+
+- **(BREAKING)** Move transition `:source` from `:and_then` to `:result` property.
+
+- **(BREAKING)** Rename transitions metadata property `:tree_map` to `:ids_tree`.
+  ```ruby
+  # ids_tree #
+  0          # [0, [
+  |- 1       #   [1, [[2, []]]],
+  |  |- 2    #   [3, []],
+  |- 3       #   [4, [
+  |- 4       #     [5, []],
+  |  |- 5    #     [6, [[7, []]]]
+  |  |- 6    #   ]],
+  |     |- 7 #   [8, []]
+  |- 8       # ]]
+  ```
+
+## [0.12.0] - 2024-01-07
+
+### Added
+
+- Add `BCDD::Result#and_then!` and `BCDD::Result::Context#and_then!` to execute a callable object (any object that responds to `#call`) to produce a result. The main difference between the `#and_then` and `#and_then!` is that the latter does not check the result source.
+  - **Attention:** to ensure the correct behavior, do not mix `#and_then` and `#and_then!` in the same result chain.
+  - This feature is turned off by default. You can enable it through the `BCDD::Result.config.feature.enable!(:and_then!)`.
+  - The method called by default (`:call`) can be changed through `BCDD::Result.config.and_then!.default_method_name_to_call=`.
+
+### Changed
+
+- **(BREAKING)** Renames the subject concept/term to `source`. When a mixin is included/extended, it defines the `Success()` and `Failure()` methods. Since the results are generated in a context (instance or singleton where the mixin was used), they will have a defined source (instance or singleton itself).
+  > Definition of source
+  >
+  > From dictionary:
+  > * a place, person, or thing from which something comes or can be obtained.
+
 ## [0.11.0] - 2024-01-02
 
 ### Added
@@ -45,6 +119,14 @@
 ### Changed
 
 - **(BREAKING)** Rename halted concept to terminal. Failures are terminal by default, but you can make a success terminal by enabling the `:continue` addon.
+  > Definition of terminal
+  >
+  > From dictionary:
+  > * of, forming, or situated at the end or extremity of something.
+  > * the end of a railroad or other transport route, or a station at such a point.
+  >
+  > From Wikipedia:
+  > * A "terminus" or "terminal" is a station at the end of a railway line.
 
 - **(BREAKING)** Rename `BCDD::Result::Context::Success#and_expose` halted keyword argument to `terminal`.