Change addons definition (mixin + config)

Author: serradura

CHANGELOG.md

@@ -53,9 +53,7 @@
   ```
   - **To**
   ```ruby
-  BCDD::Result.mixin(with: :continue)
-  BCDD::Result.mixin(with: [:continue])
-  BCDD::Result.mixin(with: { continue: true })
+  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`)
 

README.md

@@ -746,10 +746,10 @@ class Divide
   private
 
   def validate_numbers
-    arg1.is_a?(::Numeric) or return BCDD::Result::Failure(:invalid_arg, 'arg1 must be numeric') # This will raise an error
+    arg1.is_a?(::Numeric) or return Failure(:invalid_arg, 'arg1 must be numeric') # This will raise an error
     arg2.is_a?(::Numeric) or return Failure(:invalid_arg, 'arg2 must be numeric')
 
-    BCDD::Result::Success(:ok, [arg1, arg2]) # This will raise an error
+    Success(:ok, [arg1, arg2]) # This will raise an error
   end
 
   def validate_non_zero(numbers)
@@ -838,7 +838,7 @@ This addon will create the `Continue(value)` method, which will know how to prod
 
 ```ruby
 module Divide
-  extend self, BCDD::Result.mixin(config: :continue)
+  extend self, BCDD::Result.mixin(config: { addon: { continue: true } })
 
   def call(arg1, arg2)
     validate_numbers(arg1, arg2)
@@ -947,10 +947,10 @@ class Divide
 end
 ```
 
-This mode also defines an `Expected` constant to be used inside and outside the module.
+This mode also defines an `Result` constant to be used inside and outside the module.
 
 > **PROTIP:**
-> You can use the `Expected` constant to mock the result's type and value in your tests. As they will have the exact expectations, your tests will check if the result clients are handling the result correctly.
+> You can use the `Result` constant to mock the result's type and value in your tests. As they will have the exact expectations, your tests will check if the result clients are handling the result correctly.
 
 Now that you know the two modes, let's understand how expectations can be beneficial and powerful for defining contracts.
 
@@ -1274,12 +1274,12 @@ The `BCDD::Result::Expectations.mixin` also accepts the `with:` argument. It is
 
 **Continue**
 
-It is similar to `BCDD::Result.mixin(config: :continue)`, the key difference is that the `Continue(value)` will be ignored by the expectations. This is extremely useful when you want to use `Continue(value)` to chain operations, but you don't want to declare N success types in the expectations.
+It is similar to `BCDD::Result.mixin(config: { addon: { continue: true } })`, the key difference is that the `Continue(value)` will be ignored by the expectations. This is extremely useful when you want to use `Continue(value)` to chain operations, but you don't want to declare N success types in the expectations.
 
 ```ruby
 class Divide
   include BCDD::Result::Expectations.mixin(
-    config: :continue,
+    config: { addon: { continue: true } },
     success: :division_completed,
     failure: %i[invalid_arg division_by_zero]
   )
@@ -1581,7 +1581,7 @@ The `BCDD::Result::Context.mixin` and `BCDD::Result::Context::Expectations.mixin
 
 **Continue**
 
-The `BCDD::Result::Context.mixin(config: :continue)` or `BCDD::Result::Context::Expectations.mixin(config: :continue)` adds a `Continue(**input)` that will be ignored by the expectations. This is extremely useful when you want to use `Continue()` to chain operations, but you don't want to declare N success types in the expectations.
+The `BCDD::Result::Context.mixin(config: { addon: { continue: true } })` or `BCDD::Result::Context::Expectations.mixin(config: { addon: { continue: true } })` adds a `Continue(**input)` that will be ignored by the expectations. This is extremely useful when you want to use `Continue()` to chain operations, but you don't want to declare N success types in the expectations.
 
 Let's use a mix of `BCDD::Result::Context` features to see in action with this add-on:
 
@@ -1596,7 +1596,7 @@ module Divide
   require 'logger'
 
   extend self, BCDD::Result::Context::Expectations.mixin(
-    config: :continue,
+    config: { addon: { continue: true } },
     success: {
       division_completed: ->(value) { value => { number: Numeric } }
     },

lib/bcdd/result/context/expectations/mixin.rb

@@ -15,8 +15,8 @@ module Continuable
 
       OPTIONS = { continue: Continuable }.freeze
 
-      def self.options(names)
-        ::BCDD::Result::Config::Options.filter(names, OPTIONS)
+      def self.options(config_flags)
+        ::BCDD::Result::Config::Options.unwrap(options: { addon: OPTIONS }, flags: config_flags)
       end
     end
   end

lib/bcdd/result/context/mixin.rb

@@ -23,8 +23,8 @@ module Continuable
 
       OPTIONS = { continue: Continuable }.freeze
 
-      def self.options(names)
-        ::BCDD::Result::Config::Options.filter(names, OPTIONS)
+      def self.options(config_flags)
+        ::BCDD::Result::Config::Options.unwrap(options: { addon: OPTIONS }, flags: config_flags)
       end
     end
   end

lib/bcdd/result/expectations/mixin.rb

@@ -36,8 +36,8 @@ module Continuable
 
       OPTIONS = { continue: Continuable }.freeze
 
-      def self.options(names)
-        Config::Options.filter(names, OPTIONS)
+      def self.options(config_flags)
+        Config::Options.unwrap(options: { addon: OPTIONS }, flags: config_flags)
       end
     end
   end

lib/bcdd/result/mixin.rb

@@ -30,8 +30,8 @@ module Continuable
 
       OPTIONS = { continue: Continuable }.freeze
 
-      def self.options(names)
-        Config::Options.filter(names, OPTIONS)
+      def self.options(config_flags)
+        Config::Options.unwrap(options: { addon: OPTIONS }, flags: config_flags)
       end
     end
   end

sig/bcdd/result.rbs

@@ -118,11 +118,11 @@ class BCDD::Result
 
       OPTIONS: Hash[Symbol, Module]
 
-      def self.options: (Array[Symbol]) -> Array[Module]
+      def self.options: (Hash[Symbol, Hash[Symbol, bool]]) -> Array[Module]
     end
   end
 
-  def self.mixin: (?config: Array[Symbol]) -> Module
+  def self.mixin: (?config: Hash[Symbol, Hash[Symbol, bool]]) -> Module
 
   def self.mixin_module: -> singleton(BCDD::Result::Mixin)
 end
@@ -342,7 +342,7 @@ end
 
 class BCDD::Result::Expectations
   def self.mixin: (
-    ?config: Symbol,
+    ?config: Hash[Symbol, Hash[Symbol, bool]],
     ?success: Hash[Symbol, untyped] | Array[Symbol],
     ?failure: Hash[Symbol, untyped] | Array[Symbol]
   ) -> Module
@@ -381,7 +381,7 @@ module BCDD::Result::Expectations::Mixin
 
     OPTIONS: Hash[Symbol, Module]
 
-    def self.options: (Symbol) -> Array[Module]
+    def self.options: (Hash[Symbol, Hash[Symbol, bool]]) -> Array[Module]
   end
 end
 
@@ -450,7 +450,7 @@ class BCDD::Result::Context
 
       OPTIONS: Hash[Symbol, Module]
 
-      def self.options: (Array[Symbol]) -> Array[Module]
+      def self.options: (Hash[Symbol, Hash[Symbol, bool]]) -> Array[Module]
     end
   end
 
@@ -475,7 +475,7 @@ module BCDD::Result::Context::Expectations::Mixin
 
     OPTIONS: Hash[Symbol, Module]
 
-    def self.options: (Symbol) -> Array[Module]
+    def self.options: (Hash[Symbol, Hash[Symbol, bool]]) -> Array[Module]
   end
 end
 

test/bcdd/result/and_then/with_subject/continue_instance_test.rb

@@ -4,7 +4,7 @@
 
 class BCDD::Result::AndThenWithSubjectContinueInstanceTest < Minitest::Test
   class Divide
-    include BCDD::Result.mixin(config: :continue)
+    include BCDD::Result.mixin(config: { addon: { continue: true } })
 
     def call(arg1, arg2)
       validate_numbers(arg1, arg2)

test/bcdd/result/and_then/with_subject/continue_singleton_test.rb

@@ -4,7 +4,7 @@
 
 class BCDD::Result::AndThenWithSubjectContinueSingletonTest < Minitest::Test
   module Divide
-    extend self, BCDD::Result.mixin(config: :continue)
+    extend self, BCDD::Result.mixin(config: { addon: { continue: true } })
 
     def call(arg1, arg2)
       validate_numbers(arg1, arg2)

test/bcdd/result/context/and_then/with_subject/continue_instance_test.rb

@@ -4,7 +4,7 @@
 
 class BCDD::Result::Context::AndThenWithSubjectContinueInstanceTest < Minitest::Test
   class Divide
-    include BCDD::Result::Context.mixin(config: :continue)
+    include BCDD::Result::Context.mixin(config: { addon: { continue: true } })
 
     def call(arg1, arg2)
       validate_numbers(arg1, arg2)