bcdd-result 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d43af37c2ffd8d2764fc62039ac1d3e4398b2872fa25bc80192a9aca1b08dfb5
-  data.tar.gz: 8aaab364445f279d207390479bce6680c4ed4b7fe4b2fc026e203ddece47a398
+  metadata.gz: 2b49559a4258169692f89f3263c14485cde2e17e36c90ccde9bf88dab355d458
+  data.tar.gz: b62c215886f572f942a752767db89544ae5e483a496975882fcc9108d99edc0f
 SHA512:
-  metadata.gz: 6dbac4fdded1e36d6f2af6e5c7e0d0bebfe44b489410a35445935c8da656fe244fca7a6e769a5b73d6070929e790be420887b2576cb9b523a798fe3ff759e564
-  data.tar.gz: 12055de39a9a3a93f69670da7b3a93a0e3749568590be14d02ce750cb5b5e5b00c7b56da422941bdea8842b073573e589d2a11681496f18f7160ddeaf3ceb7bb
+  metadata.gz: 2794daec03ab43d9d9549887dae87d0138195f0c85f65ddcc1015d74a9a940c639e7dc73086c9f948de00c8ce95d576105a3ad9e671b068d56d39e4ef075c3ff
+  data.tar.gz: 197572b1a2dc61a72de744af1bbb50a642731dc4e248133164da36fb8ff8d257fe89c2874798ea9f77533aa462e386dd002cc2dd25f241ca12cd02ff8d080fa4

data/.rubocop.yml

@@ -15,31 +15,41 @@ Layout/LineLength:
 Layout/ExtraSpacing:
   AllowBeforeTrailingComments: true
 
-Style/ClassAndModuleChildren:
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Lint/UnderscorePrefixedVariableName:
+  Enabled: false
+
+Style/AccessModifierDeclarations:
   Enabled: false
 
 Style/CaseEquality:
-  Exclude:
-    - lib/bcdd/result/expectations/contract/for_types_and_values.rb
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
 
 Style/Lambda:
   EnforcedStyle: literal
 
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/SingleLineMethods:
+  Enabled: false
+
 Style/MapToSet:
-  Exclude:
-    - lib/bcdd/result/expectations/contract/for_types.rb
+  Enabled: false
 
 Style/MixinGrouping:
   Enabled: false
 
-Style/AccessModifierDeclarations:
+Naming/MethodName:
   Enabled: false
 
-Naming/MethodName:
-  Exclude:
-    - lib/bcdd/result/mixin.rb
-    - lib/bcdd/result/expectations.rb
-    - lib/bcdd/result/expectations/mixin.rb
+Naming/VariableName:
+  Enabled: false
 
 Metrics/BlockLength:
   Exclude:
@@ -52,3 +62,13 @@ Metrics/ClassLength:
 
 Minitest/MultipleAssertions:
   Enabled: false
+
+Minitest/AssertEmptyLiteral:
+  Enabled: false
+
+Minitest/AssertOperator:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - lib/bcdd-result.rb

data/CHANGELOG.md

@@ -1,5 +1,153 @@
+- [\[Unreleased\]](#unreleased)
+- [\[0.8.0\] - 2023-12-11](#080---2023-12-11)
+  - [Added](#added)
+  - [Changed](#changed)
+  - [Removed](#removed)
+- [\[0.7.0\] - 2023-10-27](#070---2023-10-27)
+  - [Added](#added-1)
+  - [Changed](#changed-1)
+- [\[0.6.0\] - 2023-10-11](#060---2023-10-11)
+  - [Added](#added-2)
+  - [Changed](#changed-2)
+- [\[0.5.0\] - 2023-10-09](#050---2023-10-09)
+  - [Added](#added-3)
+- [\[0.4.0\] - 2023-09-28](#040---2023-09-28)
+  - [Added](#added-4)
+  - [Changed](#changed-3)
+  - [Removed](#removed-1)
+- [\[0.3.0\] - 2023-09-26](#030---2023-09-26)
+  - [Added](#added-5)
+- [\[0.2.0\] - 2023-09-26](#020---2023-09-26)
+  - [Added](#added-6)
+  - [Removed](#removed-2)
+- [\[0.1.0\] - 2023-09-25](#010---2023-09-25)
+  - [Added](#added-7)
+
 ## [Unreleased]
 
+## [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
+
+- Add `BCDD::Result::Context`. It is a `BCDD::Result`, meaning it has all the features of the `BCDD::Result`. The main difference is that it only accepts keyword arguments as a value, which applies to the `and_then`: The called methods must receive keyword arguments, and the dependency injection will be performed through keyword arguments.<br/><br/>
+As the input/output are hashes, the results of each `and_then` call will automatically accumulate. This is useful in operations chaining, as the result of the previous operations will be automatically available for the next one. Because of this behavior, the `BCDD::Result::Context` has the `#and_expose` method to expose only the desired keys from the accumulated result.
+
+- Add `BCDD::Result::Context::Expectations.new` and `BCDD::Result::Context::Expectations.mixin`. Both are similar to `BCDD::Result::Expectations.new` and `BCDD::Result::Expectations.mixin`, but they are for `BCDD::Result::Context` instead of `BCDD::Result`.
+  - The `BCDD::Result::Context.mixin` and `BCDD::Result::Context::Expectations.mixin` support the `with: :Continue` option.
+
+- Enhance Pattern Matching support. When a `NoMatchingPatternError` occurs inside a value checking, the `BCDD::Result::Contract::Error::UnexpectedValue` message will include the value and the expected patterns.
+
+- Add `BCDD::Result::Success::Methods` to be share common methods between `BCDD::Result::Success` and `BCDD::Result::Context::Success`.
+
+- Add `BCDD::Result::Failure::Methods` to be share common methods between `BCDD::Failure::Success` and `BCDD::Result::Context::Failure`.
+
+- Make all mixin generators produce a named module. The module name will be added to the target class/module (who included/extended a `BCDD::Result`/`BCDD::Result::Context` mixin module).
+
+- Add `BCDD::Result::Contract.nil_as_valid_value_checking!`. Please use this method when using the one-line pattern-matching operators on the result's value expectations.
+
+### Changed
+
+- **(BREAKING)** Rename `BCDD::Result::WrongResultSubject` to `BCDD::Result::Error::InvalidResultSubject`.
+- **(BREAKING)** Rename `BCDD::Result::WrongSubjectMethodArity` to `BCDD::Result::Error::InvalidSubjectMethodArity`.
+- **(BREAKING)** Rename the constant produced by `BCDD::Result::Expectations.mixins` from `Expected` to `Result`.
+- Extract the major part of the `BCDD::Result::Expectations` components/features to `BCDD::Result::Contract`.
+  - **(BREAKING)** `BCDD::Result::Expectations::Error` became `BCDD::Result::Contract::Error`. So, `BCDD::Result::Expectations::Error::UnexpectedType` and `BCDD::Result::Expectations::Error::UnexpectedValue` are now `BCDD::Result::Contract::Error::UnexpectedType` and `BCDD::Result::Contract::Error::UnexpectedValue`.
+
 ## [0.6.0] - 2023-10-11
 
 ### Added