bcdd-result 0.12.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 677f88c68eb0f745246a910bbf4a659103a5695f3c5bd74f6ac6f0ba9ff3729f
-  data.tar.gz: 2966e659671b84bed72b2fb7ab4daaa19a1572a5480af3c19ab2a41b720d1265
+  metadata.gz: 78e33ee42ffa86c0eea3c6dc522ae0bec103bb70d24a1f31103b60cda7bead6e
+  data.tar.gz: 8919d24f1b3d903ff164717e5930f8a4e17c66ede1a93f303ffacceacdc31bb1
 SHA512:
-  metadata.gz: ee78777c66384e185ff7c1c816ea9fa2787ab14cde530a2fb2a9ec943755b86846a0a03cbc2742c2530cf9487380e9d23ce47663de366483d77af4bfe1fa3c8c
-  data.tar.gz: 7396cf7283c4d22dd7b03be855cf6f3a8e9c15ebbf8ef5194c34de762b99e9d6a41345066f7990be5a0e47e50da4bf38811191eb06916803881a12fab7a854b1
+  metadata.gz: 9c504322d2243a50ee18f1369a110af0c5fa45b07c55628f7dac30bacc2348299e1d2207474dcd15fc0a92ec071016763c4b02a0a9bbc2b402a20cf8a7b77b66
+  data.tar.gz: fd5706097d3057addfe8b9eccb3094ef3a3567e90f93bc3218b54ec192879a39d6a68464cac75b8606b1df25f55736a3b69c02682937816c710df5c17d8abcea

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/event_logs/tracking/enabled.rb
 
 Layout/LineLength:
   Max: 120
@@ -25,6 +32,10 @@ Layout/MultilineMethodCallIndentation:
 Lint/UnderscorePrefixedVariableName:
   Enabled: false
 
+Lint/UnusedMethodArgument:
+  Exclude:
+    - lib/bcdd/result/event_logs/listener.rb
+
 Style/AccessModifierDeclarations:
   Enabled: false
 
@@ -62,9 +73,13 @@ Metrics/BlockLength:
 
 Metrics/ClassLength:
   Exclude:
-    - lib/bcdd/result.rb
+    - lib/bcdd/result/_self.rb
     - test/**/*.rb
 
+Metrics/AbcSize:
+  Exclude:
+    - lib/bcdd/result/event_logs/tracking/enabled.rb
+
 Minitest/MultipleAssertions:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,44 +1,127 @@
 - [\[Unreleased\]](#unreleased)
-- [\[0.12.0\] - 2024-01-07](#0120---2024-01-07)
+- [1.0.0 - 2024-03-16](#100---2024-03-16)
   - [Added](#added)
   - [Changed](#changed)
-- [\[0.11.0\] - 2024-01-02](#0110---2024-01-02)
+- [\[0.13.0\] - 2024-02-01](#0130---2024-02-01)
   - [Added](#added-1)
   - [Changed](#changed-1)
-- [\[0.10.0\] - 2023-12-31](#0100---2023-12-31)
+- [\[0.12.0\] - 2024-01-07](#0120---2024-01-07)
   - [Added](#added-2)
-- [\[0.9.1\] - 2023-12-12](#091---2023-12-12)
   - [Changed](#changed-2)
-  - [Fixed](#fixed)
-- [\[0.9.0\] - 2023-12-12](#090---2023-12-12)
+- [\[0.11.0\] - 2024-01-02](#0110---2024-01-02)
   - [Added](#added-3)
   - [Changed](#changed-3)
-- [\[0.8.0\] - 2023-12-11](#080---2023-12-11)
+- [\[0.10.0\] - 2023-12-31](#0100---2023-12-31)
   - [Added](#added-4)
+- [\[0.9.1\] - 2023-12-12](#091---2023-12-12)
   - [Changed](#changed-4)
-  - [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-5)
   - [Changed](#changed-5)
-- [\[0.6.0\] - 2023-10-11](#060---2023-10-11)
+- [\[0.8.0\] - 2023-12-11](#080---2023-12-11)
   - [Added](#added-6)
   - [Changed](#changed-6)
-- [\[0.5.0\] - 2023-10-09](#050---2023-10-09)
+  - [Removed](#removed)
+- [\[0.7.0\] - 2023-10-27](#070---2023-10-27)
   - [Added](#added-7)
-- [\[0.4.0\] - 2023-09-28](#040---2023-09-28)
-  - [Added](#added-8)
   - [Changed](#changed-7)
+- [\[0.6.0\] - 2023-10-11](#060---2023-10-11)
+  - [Added](#added-8)
+  - [Changed](#changed-8)
+- [\[0.5.0\] - 2023-10-09](#050---2023-10-09)
+  - [Added](#added-9)
+- [\[0.4.0\] - 2023-09-28](#040---2023-09-28)
+  - [Added](#added-10)
+  - [Changed](#changed-9)
   - [Removed](#removed-1)
 - [\[0.3.0\] - 2023-09-26](#030---2023-09-26)
-  - [Added](#added-9)
+  - [Added](#added-11)
 - [\[0.2.0\] - 2023-09-26](#020---2023-09-26)
-  - [Added](#added-10)
+  - [Added](#added-12)
   - [Removed](#removed-2)
 - [\[0.1.0\] - 2023-09-25](#010---2023-09-25)
-  - [Added](#added-11)
+  - [Added](#added-13)
 
 ## [Unreleased]
 
+## 1.0.0 - 2024-03-16
+
+### Added
+
+- Add the `BCDD::Success` and `BCDD::Failure` modules. They are key to checking whether a result is a success or a failure independently of whether it is a `BCDD::Result` or a `BCDD::Context`.
+- Add `BCDD::Result#type?` to check if the given type is the result type.
+- Add `BCDD::Result#is?` as an alias for `BCDD::Result#type?`.
+- Add `BCDD::Result#method_missing` to allow the type checking through method calls. For example, `result.ok?` will check if the result type is `:ok`.
+
+> Note: All the methods above are available for the `BCDD::Context` as well.
+
+### Changed
+
+- **(BREAKING)** Replace transitions with event_logs concept.
+  - The `BCDD::Result::Transitions` module was renamed to `BCDD::Result::EventLogs`
+  - The `BCDD::Result.transitions` to `BCDD::Result.event_logs`.
+
+- **(BREAKING)** Change `BCDD::Result#deconstruct_keys` to return a hash with the keys `:type` and `:value` when one of these keys is present. Otherwise, it will return the value itself.
+
+- **(BREAKING)** Replace trasitions metadata `:ids_tree`, and `:ids_matrix` with `:ids` property. This property is a hash with the following keys:
+  - `:tree`, a graph/tree representation of the transitions ids.
+  - `:level_parent`, a hash with the level (depth) of each transition and its parent id.
+  - `:matrix`, a matrix representation of the transitions ids. It is a simplification of the `:tree` property.
+
+- Transform `BCDD::Result::Context` into `BCDD::Context`. But a constant alias was added to keep the old name. You can use `BCDD::Result::Context` or `BCDD::Context` to access the same class.
+
+## [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