bcdd-result 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dda53cc516fcb8d18b2bd3c8431f2ca8d5d7363b6e58fd57d3fe3d1b49877e20
-  data.tar.gz: 367b97ba29f35dd2d6918817db38a2253929252c616aebcb47d7fc024888d258
+  metadata.gz: 6e4fa0b7a751971ae5fd7987906342e6436535b9bb8729252c7651a5c533302c
+  data.tar.gz: c2f2359525d2c24e28da5d400ef3e7284ccb2c13b8955da84cddb8da7b229cb3
 SHA512:
-  metadata.gz: 3618c5090981f4923977708944d94c257879fe57c06d1b2c922b7378c026e4d39c8ab13fdf64ad6277cfea4229d43d120b0d3ec3d7cb676676f0bf8d6714892d
-  data.tar.gz: 880a2f0ebcd8f7bb9ee32b2967c39011211e604981d43b59735fc912ec414635bc152ab13549ba64c87af987f66a7c334fae909cd860d3f36f6b092565b8cf24
+  metadata.gz: 1fba0932c35635a248eeef6c88b8c386ce2f8a55f235784ea6c144299a0a17f8501efa16f5a171babd2a883b90a8d06726bd47bfcb2261196d726068b8d6e097
+  data.tar.gz: 66722933fdb17f8317c0989ee103a38479b49ffb151ac23199ad91669a48a693af9ccce2b863dda913c54bc3b9d446ce802b0b4221352dffd68a08de4c647a23

data/.rubocop.yml

@@ -58,6 +58,7 @@ Metrics/BlockLength:
 
 Metrics/ClassLength:
   Exclude:
+    - lib/bcdd/result.rb
     - test/**/*.rb
 
 Minitest/MultipleAssertions:
@@ -65,3 +66,10 @@ Minitest/MultipleAssertions:
 
 Minitest/AssertEmptyLiteral:
   Enabled: false
+
+Minitest/AssertOperator:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - lib/bcdd-result.rb

data/CHANGELOG.md

@@ -1,5 +1,147 @@
+- [\[Unreleased\]](#unreleased)
+- [\[0.9.0\] - 2023-12-12](#090---2023-12-12)
+  - [Added](#added)
+  - [Changed](#changed)
+- [\[0.8.0\] - 2023-12-11](#080---2023-12-11)
+  - [Added](#added-1)
+  - [Changed](#changed-1)
+  - [Removed](#removed)
+- [\[0.7.0\] - 2023-10-27](#070---2023-10-27)
+  - [Added](#added-2)
+  - [Changed](#changed-2)
+- [\[0.6.0\] - 2023-10-11](#060---2023-10-11)
+  - [Added](#added-3)
+  - [Changed](#changed-3)
+- [\[0.5.0\] - 2023-10-09](#050---2023-10-09)
+  - [Added](#added-4)
+- [\[0.4.0\] - 2023-09-28](#040---2023-09-28)
+  - [Added](#added-5)
+  - [Changed](#changed-4)
+  - [Removed](#removed-1)
+- [\[0.3.0\] - 2023-09-26](#030---2023-09-26)
+  - [Added](#added-6)
+- [\[0.2.0\] - 2023-09-26](#020---2023-09-26)
+  - [Added](#added-7)
+  - [Removed](#removed-2)
+- [\[0.1.0\] - 2023-09-25](#010---2023-09-25)
+  - [Added](#added-8)
+
 ## [Unreleased]
 
+## [0.9.0] - 2023-12-12
+
+### Added
+
+- Add new `BCDD::Result.config.constant_alias` options. `Context` and `BCDD::Context` are now available as aliases for `BCDD::Result::Context`.
+  ```ruby
+  BCDD::Result.config.constant_alias.enable!('Context')
+
+  BCDD::Result.config.constant_alias.enable!('BCDD::Context')
+  ```
+
+- Add `BCDD::Result#halted?` to check if the result is halted. Failure results are halted by default, but you can halt a successful result by enabling the `:continue` addon.
+
+### Changed
+
+- **(BREAKING)** Change the `:continue` addon to halt the step chain on the first `Success()` result. So, if you want to advance to the next step, you must use `Continue(value)` instead of `Success(type, value)`. Otherwise, the step chain will be halted. (Implementation of the following proposal: https://github.com/B-CDD/result/issues/14)
+
+- **(BREAKING)** Rename `BCDD::Result::Data#name` to `BCDD::Result::Data#kind`. The new word is more appropriate as it represents a result's kind (success or failure).
+
+## [0.8.0] - 2023-12-11
+
+### Added
+
+- Add `BCDD::Result.config`
+  - **Feature**
+    ```ruby
+    BCDD::Result.config.feature.options
+    BCDD::Result.config.feature.enabled?(:expectations)
+    BCDD::Result.config.feature.enable!(:expectations)
+    BCDD::Result.config.feature.disable!(:expectations)
+    ```
+  - **Default Add-ons**
+    ```ruby
+    BCDD::Result.config.addon.options
+    BCDD::Result.config.addon.enabled?(:continue)
+    BCDD::Result.config.addon.enable!(:continue)
+    BCDD::Result.config.addon.disable!(:continue)
+    ```
+  - **Pattern matching**
+    ```ruby
+    BCDD::Result.config.pattern_matching.options
+    BCDD::Result.config.pattern_matching.enabled?(:nil_as_valid_value_checking)
+    BCDD::Result.config.pattern_matching.enable!(:nil_as_valid_value_checking)
+    BCDD::Result.config.pattern_matching.disable!(:nil_as_valid_value_checking)
+    ```
+  - **Constant Aliases**
+    ```ruby
+    BCDD::Result.config.constant_alias.options
+    BCDD::Result.config.constant_alias.enabled?('Result')
+    BCDD::Result.config.constant_alias.enable!('Result')
+    BCDD::Result.config.constant_alias.disable!('Result')
+    ```
+
+- Add `BCDD::Result::configuration`. It freezes the configuration, disallowing methods that promote changes but allowing the query ones. You can use this feature to ensure integrity in your configuration.
+  ```ruby
+  BCDD::Result.configuration do |config|
+    config.addon.enable!(:continue)
+
+    config.constant_alias.enable!('Result')
+
+    config.pattern_matching.disable!(:nil_as_valid_value_checking)
+
+    config.feature.disable!(:expectations) if ::Rails.env.production?
+  end
+
+  BCDD::Result.config.addon.enabled?(:continue)         # true
+  BCDD::Result.config.constant_alias.enabled?('Result') # true
+
+  BCDD::Result.config.addon.disable!(:continue)         # raises FrozenError
+  BCDD::Result.config.constant_alias.disable!('Result') # raises FrozenError
+  ```
+
+- Allow the pattern matching feature to be turned on/off through the `BCDD::Result::Expectations.mixin`. Now, it can be used without enabling it for the whole project.
+  ```ruby
+  extend BCDD::Result::Expectations.mixin(
+    config: {
+      addon:            { continue: false },
+      pattern_matching: { nil_as_valid_value_checking: true },
+    },
+    success: {
+      numbers: ->(value) { value => [Numeric, Numeric] },
+      division_completed: Numeric
+    },
+    failure: {
+      invalid_arg: String,
+      division_by_zero: String
+    }
+  )
+  ```
+
+### Changed
+
+- **(BREAKING)** Replace `BCDD::Result::Contract.nil_as_valid_value_checking!` with `BCDD::Result::Config.pattern_matching.enable!(:nil_as_valid_value_checking)`.
+
+- **(BREAKING)** Replace `BCDD::Result::Contract.nil_as_valid_value_checking?` with `BCDD::Result::Config.pattern_matching.enabled?(:nil_as_valid_value_checking)`.
+
+- **(BREAKING)** Replace `mixin(with:)` with `mixin(config:)` keyword argument.
+
+- **(BREAKING)** Change the addons definition.
+  - **From**
+  ```ruby
+  BCDD::Result.mixin(with: :Continue)
+  BCDD::Result.mixin(with: [:Continue])
+  ```
+  - **To**
+  ```ruby
+  BCDD::Result.mixin(config: { addon: { continue: true } })
+  ```
+  - These examples are valid to all kinds of mixins (`BCDD::Result.mixin`, `BCDD::Result::Context.mixin`, `BCDD::Result::Expectations.mixin`, `BCDD::Result::Context::Expectations.mixin`)
+
+### Removed
+
+- **(BREAKING)** Remove the `lib/result` file. Now you can define `Result` as an alias for `BCDD::Result` using `BCDD::Result::Config.constant_alias.enable!('Result')`.
+
 ## [0.7.0] - 2023-10-27
 
 ### Added