bcdd-result 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b49559a4258169692f89f3263c14485cde2e17e36c90ccde9bf88dab355d458
-  data.tar.gz: b62c215886f572f942a752767db89544ae5e483a496975882fcc9108d99edc0f
+  metadata.gz: 6e4fa0b7a751971ae5fd7987906342e6436535b9bb8729252c7651a5c533302c
+  data.tar.gz: c2f2359525d2c24e28da5d400ef3e7284ccb2c13b8955da84cddb8da7b229cb3
 SHA512:
-  metadata.gz: 2794daec03ab43d9d9549887dae87d0138195f0c85f65ddcc1015d74a9a940c639e7dc73086c9f948de00c8ce95d576105a3ad9e671b068d56d39e4ef075c3ff
-  data.tar.gz: 197572b1a2dc61a72de744af1bbb50a642731dc4e248133164da36fb8ff8d257fe89c2874798ea9f77533aa462e386dd002cc2dd25f241ca12cd02ff8d080fa4
+  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:

data/CHANGELOG.md

@@ -1,30 +1,52 @@
 - [\[Unreleased\]](#unreleased)
-- [\[0.8.0\] - 2023-12-11](#080---2023-12-11)
+- [\[0.9.0\] - 2023-12-12](#090---2023-12-12)
   - [Added](#added)
   - [Changed](#changed)
-  - [Removed](#removed)
-- [\[0.7.0\] - 2023-10-27](#070---2023-10-27)
+- [\[0.8.0\] - 2023-12-11](#080---2023-12-11)
   - [Added](#added-1)
   - [Changed](#changed-1)
-- [\[0.6.0\] - 2023-10-11](#060---2023-10-11)
+  - [Removed](#removed)
+- [\[0.7.0\] - 2023-10-27](#070---2023-10-27)
   - [Added](#added-2)
   - [Changed](#changed-2)
-- [\[0.5.0\] - 2023-10-09](#050---2023-10-09)
+- [\[0.6.0\] - 2023-10-11](#060---2023-10-11)
   - [Added](#added-3)
-- [\[0.4.0\] - 2023-09-28](#040---2023-09-28)
-  - [Added](#added-4)
   - [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-5)
-- [\[0.2.0\] - 2023-09-26](#020---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-7)
+  - [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

data/README.md

@@ -1,6 +1,6 @@
 <p align="center">
   <h1 align="center" id="-bcddresult">🔀 BCDD::Result</h1>
-  <p align="center"><i>Empower Ruby apps with pragmatic use of Result monad, Railway Oriented Programming, and B/CDD.</i></p>
+  <p align="center"><i>Empower Ruby apps with pragmatic use of Result pattern (monad), Railway Oriented Programming, and B/CDD.</i></p>
   <p align="center">
     <img src="https://img.shields.io/badge/ruby->%3D%202.7.0-ruby.svg?colorA=99004d&colorB=cc0066" alt="Ruby">
     <a href="https://rubygems.org/gems/bcdd-result"><img src="https://badge.fury.io/rb/bcdd-result.svg" alt="bcdd-result gem version" height="18"></a>
@@ -63,6 +63,7 @@ Use it to enable the [Railway Oriented Programming](https://fsharpforfunandprofi
     - [`BCDD::Result::Expectations.mixin` add-ons](#bcddresultexpectationsmixin-add-ons)
   - [`BCDD::Result::Context`](#bcddresultcontext)
     - [Defining successes and failures](#defining-successes-and-failures)
+    - [Constant aliases](#constant-aliases)
     - [`BCDD::Result::Context.mixin`](#bcddresultcontextmixin)
       - [Class example (Instance Methods)](#class-example-instance-methods-1)
       - [`and_expose`](#and_expose)
@@ -71,7 +72,7 @@ Use it to enable the [Railway Oriented Programming](https://fsharpforfunandprofi
     - [Mixin add-ons](#mixin-add-ons)
   - [`BCDD::Result.configuration`](#bcddresultconfiguration)
     - [`config.addon.enable!(:continue)`](#configaddonenablecontinue)
-    - [`config.constant_alias.enable!('Result')`](#configconstant_aliasenableresult)
+    - [`config.constant_alias.enable!('Result', 'BCDD::Context')`](#configconstant_aliasenableresult-bcddcontext)
     - [`config.pattern_matching.disable!(:nil_as_valid_value_checking)`](#configpattern_matchingdisablenil_as_valid_value_checking)
     - [`config.feature.disable!(:expectations)`](#configfeaturedisableexpectations)
   - [`BCDD::Result.config`](#bcddresultconfig)
@@ -482,7 +483,7 @@ divide(100, 0).value_or { 0 } # 0
 
 #### `result.data`
 
-The `BCDD::Result#data` exposes the result attributes (name, type, value) directly and as a hash (`to_h`/`to_hash`) and array (`to_a`/`to_ary`).
+The `BCDD::Result#data` exposes the result attributes (kind, type, value) directly and as a hash (`to_h`/`to_hash`) and array (`to_a`/`to_ary`).
 
 This is helpful if you need to access the result attributes generically or want to use Ruby features like splat (`*`) and double splat (`**`) operators.
 
@@ -491,25 +492,25 @@ See the examples below to understand how to use it.
 ```ruby
 result = BCDD::Result::Success(:ok, 1)
 
-success_data = result.data # #<BCDD::Result::Data name=:success type=:ok value=1>
+success_data = result.data # #<BCDD::Result::Data kind=:success type=:ok value=1>
 
-success_data.name  # :success
+success_data.kind  # :success
 success_data.type  # :ok
 success_data.value # 1
 
-success_data.to_h  # {:name=>:success, :type=>:ok, :value=>1}
+success_data.to_h  # {:kind=>:success, :type=>:ok, :value=>1}
 success_data.to_a  # [:success, :ok, 1]
 
-name, type, value = success_data
+kind, type, value = success_data
 
-[name, type, value] # [:success, :ok, 1]
+[kind, type, value] # [:success, :ok, 1]
 
-def print_to_ary(name, type, value)
-  puts [name, type, value].inspect
+def print_to_ary(kind, type, value)
+  puts [kind, type, value].inspect
 end
 
-def print_to_hash(name:, type:, value:)
-  puts [name, type, value].inspect
+def print_to_hash(kind:, type:, value:)
+  puts [kind, type, value].inspect
 end
 
 print_to_ary(*success_data)   # [:success, :ok, 1]
@@ -917,7 +918,9 @@ The `BCDD::Result.mixin` also accepts the `config:` argument. It is a hash that
 
 **continue**
 
-This addon will create the `Continue(value)` method, which will know how to produce a `Success(:continued, value)`. It is useful when you want to perform a sequence of operations but want to avoid returning a specific result for each step.
+This addon will create the `Continue(value)` method and change the `Success()` behavior to halt the step chain.
+
+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.
 
 ```ruby
 module Divide
@@ -1350,7 +1353,9 @@ The `BCDD::Result::Expectations.mixin` also accepts the `config:` argument. It i
 
 **Continue**
 
-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.
+It is similar to `BCDD::Result.mixin(config: { addon: { continue: true } })`. The key difference is that the expectations will ignore the `Continue(value)`.
+
+Based on this, use the `Success()` to produce a terminal result and `Continue()` to produce a result that will be used in the next step.
 
 ```ruby
 class Divide
@@ -1435,6 +1440,22 @@ BCDD::Result::Context::Success(:ok, **{ message: 'hashes can be converted to key
 
 <p align="right"><a href="#-bcddresult">⬆️ &nbsp;back to top</a></p>
 
+#### Constant aliases
+
+You can configure `Context` or `BCDD::Context` as an alias for `BCDD::Result::Context`. This is helpful to define a standard way to avoid the full constant name/path in your code.
+
+```ruby
+BCDD::Result.configuration do |config|
+  config.context_alias.enable!('BCDD::Context')
+
+  # or
+
+  config.context_alias.enable!('Context')
+end
+```
+
+<p align="right"><a href="#-bcddresult">⬆️ &nbsp;back to top</a></p>
+
 #### `BCDD::Result::Context.mixin`
 
 As in the `BCDD::Result`, you can use the `BCDD::Result::Context.mixin` to add the `Success()` and `Failure()` methods to your classes/modules.
@@ -1655,7 +1676,9 @@ The `BCDD::Result::Context.mixin` and `BCDD::Result::Context::Expectations.mixin
 
 **Continue**
 
-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.
+The `BCDD::Result::Context.mixin(config: { addon: { continue: true } })` or `BCDD::Result::Context::Expectations.mixin(config: { addon: { continue: true } })` creates the `Continue(value)` method and change the `Success()` behavior to halt the step chain.
+
+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.
 
 Let's use a mix of `BCDD::Result::Context` features to see in action with this add-on:
 
@@ -1730,11 +1753,11 @@ The `BCDD::Result.configuration` allows you to configure default behaviors for `
 BCDD::Result.configuration do |config|
   config.addon.enable!(:continue)
 
-  config.constant_alias.enable!('Result')
+  config.constant_alias.enable!('Result', 'BCDD::Context')
 
   config.pattern_matching.disable!(:nil_as_valid_value_checking)
 
-  config.feature.disable!(:expectations) if ::Rails.env.production?
+  # config.feature.disable!(:expectations) if ::Rails.env.production?
 end
 ```
 
@@ -1744,11 +1767,15 @@ Let's see what each configuration in the example above does:
 
 #### `config.addon.enable!(:continue)`
 
-This configuration enables the `Continue()` method for `BCDD::Result` and `BCDD::Result::Context`. Link to documentations: [(1)](#add-ons) [(2)](#mixin-add-ons).
+This configuration enables the `Continue()` method for `BCDD::Result`, `BCDD::Result::Context`, `BCDD::Result::Expectation`, and `BCDD::Result::Context::Expectation`. Link to documentations: [(1)](#add-ons) [(2)](#mixin-add-ons).
 
-#### `config.constant_alias.enable!('Result')`
+#### `config.constant_alias.enable!('Result', 'BCDD::Context')`
 
-This configuration make `Result` a constant alias for `BCDD::Result`. Link to [documentation](#bcddresult-versus-result).
+This configuration make `Result` a constant alias for `BCDD::Result`, and `BCDD::Context` a constant alias for `BCDD::Result::Context`.
+
+Link to documentations:
+- [Result alias](#bcddresult-versus-result)
+- [Context aliases](#constant-aliases)
 
 #### `config.pattern_matching.disable!(:nil_as_valid_value_checking)`
 
@@ -1789,15 +1816,14 @@ BCDD::Result.config.addon.options
 
 ```ruby
 BCDD::Result.config.constant_alias.enabled?('Result')
+BCDD::Result.config.constant_alias.enabled?('Context')
+BCDD::Result.config.constant_alias.enabled?('BCDD::Context')
 
 BCDD::Result.config.constant_alias.options
 # {
-#   "Result"=>{
-#     :enabled=>false,
-#     :affects=>[
-#       "Object"
-#     ]
-#   }
+#   "Result"=>{:enabled=>false, :affects=>["Object"]},
+#   "Context"=>{:enabled=>false, :affects=>["Object"]},
+#   "BCDD::Context"=>{:enabled=>false, :affects=>["BCDD"]}
 # }
 ```
 

data/lib/bcdd/result/config/constant_alias.rb

@@ -3,16 +3,18 @@
 class BCDD::Result
   class Config
     module ConstantAlias
-      RESULT = 'Result'
-
-      OPTIONS = {
-        RESULT => { default: false, affects: %w[Object] }
-      }.transform_values!(&:freeze).freeze
-
       MAPPING = {
-        RESULT => { target: ::Object, name: :Result, value: ::BCDD::Result }
+        'Result' => { target: ::Object, name: :Result, value: ::BCDD::Result },
+        'Context' => { target: ::Object, name: :Context, value: ::BCDD::Result::Context },
+        'BCDD::Context' => { target: ::BCDD, name: :Context, value: ::BCDD::Result::Context }
       }.transform_values!(&:freeze).freeze
 
+      OPTIONS = MAPPING.to_h do |option_name, mapping|
+        affects = mapping.fetch(:target).name.freeze
+
+        [option_name, { default: false, affects: [affects].freeze }]
+      end.freeze
+
       Listener = ->(option_name, boolean) do
         mapping = MAPPING.fetch(option_name)
 

data/lib/bcdd/result/config/options.rb

@@ -13,13 +13,14 @@ class BCDD::Result
         default_flags.merge(config_flags).slice(*default_flags.keys)
       end
 
-      def self.filter_map(all_flags, config:, from:)
+      def self.select(all_flags, config:, from:)
         with_defaults(all_flags, config)
-          .filter_map { |name, truthy| from[name] if truthy }
+          .filter_map { |name, truthy| [name, from[name]] if truthy }
+          .to_h
       end
 
       def self.addon(map:, from:)
-        filter_map(map, config: :addon, from: from)
+        select(map, config: :addon, from: from)
       end
     end
   end

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

@@ -4,7 +4,7 @@ class BCDD::Result::Context
   module Expectations::Mixin
     Factory = BCDD::Result::Expectations::Mixin::Factory
 
-    METHODS = BCDD::Result::Expectations::Mixin::METHODS
+    Methods = BCDD::Result::Expectations::Mixin::Methods
 
     module Addons
       module Continuable

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

@@ -15,11 +15,11 @@ class BCDD::Result::Context
     private_class_method :mixin!, :mixin_module, :result_factory_without_expectations
 
     def Success(type, **value)
-      Success.new(type: type, value: value, subject: subject, expectations: contract)
+      _ResultAs(Success, type, value)
     end
 
     def Failure(type, **value)
-      Failure.new(type: type, value: value, subject: subject, expectations: contract)
+      _ResultAs(Failure, type, value)
     end
   end
 end

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

@@ -6,18 +6,26 @@ class BCDD::Result::Context
 
     module Methods
       def Success(type, **value)
-        Success.new(type: type, value: value, subject: self)
+        _ResultAs(Success, type, value)
       end
 
       def Failure(type, **value)
-        Failure.new(type: type, value: value, subject: self)
+        _ResultAs(Failure, type, value)
+      end
+
+      private def _ResultAs(kind_class, type, value, halted: nil)
+        kind_class.new(type: type, value: value, subject: self, halted: halted)
       end
     end
 
     module Addons
       module Continuable
+        def Success(type, **value)
+          _ResultAs(Success, type, value, halted: true)
+        end
+
         private def Continue(**value)
-          Success.new(type: :continued, value: value, subject: self)
+          _ResultAs(Success, :continued, value)
         end
       end
 

data/lib/bcdd/result/context.rb

@@ -15,7 +15,7 @@ class BCDD::Result
       Failure.new(type: type, value: value)
     end
 
-    def initialize(type:, value:, subject: nil, expectations: nil)
+    def initialize(type:, value:, subject: nil, expectations: nil, halted: nil)
       value.is_a?(::Hash) or raise ::ArgumentError, 'value must be a Hash'
 
       @acc = {}

data/lib/bcdd/result/contract/evaluator.rb

@@ -35,7 +35,7 @@ class BCDD::Result
     private
 
     def for(data)
-      case data.name
+      case data.kind
       when :unknown then Contract::Disabled
       when :success then success
       else failure

data/lib/bcdd/result/data.rb

@@ -2,26 +2,26 @@
 
 class BCDD::Result
   class Data
-    attr_reader :name, :type, :value
+    attr_reader :kind, :type, :value
 
-    def initialize(name, type, value)
-      @name = name
+    def initialize(kind, type, value)
+      @kind = kind
       @type = type.to_sym
       @value = value
     end
 
     def to_h
-      { name: name, type: type, value: value }
+      { kind: kind, type: type, value: value }
     end
 
     def to_a
-      [name, type, value]
+      [kind, type, value]
     end
 
     def inspect
       format(
-        '#<%<class_name>s name=%<name>p type=%<type>p value=%<value>p>',
-        class_name: self.class.name, name: name, type: type, value: value
+        '#<%<class_name>s kind=%<kind>p type=%<type>p value=%<value>p>',
+        class_name: self.class.name, kind: kind, type: type, value: value
       )
     end
 

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

@@ -11,21 +11,29 @@ class BCDD::Result
       end
     end
 
-    METHODS = <<~RUBY
-      def Success(...)
-        _Result.Success(...)
-      end
+    module Methods
+      BASE = <<~RUBY
+        def Success(...)
+          _Result.Success(...)
+        end
 
-      def Failure(...)
-        _Result.Failure(...)
-      end
+        def Failure(...)
+          _Result.Failure(...)
+        end
+      RUBY
 
-      private
+      FACTORY = <<~RUBY
+        private def _Result
+          @_Result ||= Result.with(subject: self, halted: %<halted>s)
+        end
+      RUBY
+
+      def self.to_eval(addons)
+        halted = addons.key?(:continue) ? 'true' : 'nil'
 
-      def _Result
-        @_Result ||= Result.with(subject: self)
+        "#{BASE}\n#{format(FACTORY, halted: halted)}"
       end
-    RUBY
+    end
 
     module Addons
       module Continuable

data/lib/bcdd/result/expectations.rb

@@ -15,8 +15,8 @@ class BCDD::Result
 
       mod = mixin_module::Factory.module!
       mod.const_set(:Result, new(success: success, failure: failure, config: config).freeze)
-      mod.module_eval(mixin_module::METHODS)
-      mod.send(:include, *addons) unless addons.empty?
+      mod.module_eval(mixin_module::Methods.to_eval(addons), __FILE__, __LINE__ + 1)
+      mod.send(:include, *addons.values) unless addons.empty?
       mod
     end
 
@@ -38,28 +38,38 @@ class BCDD::Result
 
     private_class_method :mixin!, :mixin_module, :result_factory_without_expectations
 
-    def initialize(subject: nil, success: nil, failure: nil, contract: nil, config: nil)
+    def initialize(subject: nil, contract: nil, halted: nil, **options)
+      @halted = halted
+
       @subject = subject
 
       @contract = contract if contract.is_a?(Contract::Evaluator)
 
-      @contract ||= Contract.new(success: success, failure: failure, config: config).freeze
+      @contract ||= Contract.new(
+        success: options[:success],
+        failure: options[:failure],
+        config: options[:config]
+      ).freeze
     end
 
     def Success(type, value = nil)
-      Success.new(type: type, value: value, subject: subject, expectations: contract)
+      _ResultAs(Success, type, value)
     end
 
     def Failure(type, value = nil)
-      Failure.new(type: type, value: value, subject: subject, expectations: contract)
+      _ResultAs(Failure, type, value)
     end
 
-    def with(subject:)
-      self.class.new(subject: subject, contract: contract)
+    def with(subject:, halted: nil)
+      self.class.new(subject: subject, halted: halted, contract: contract)
     end
 
     private
 
-    attr_reader :subject, :contract
+    def _ResultAs(kind_class, type, value)
+      kind_class.new(type: type, value: value, subject: subject, expectations: contract, halted: halted)
+    end
+
+    attr_reader :subject, :halted, :contract
   end
 end

data/lib/bcdd/result/failure/methods.rb

@@ -15,7 +15,7 @@ module BCDD::Result::Failure::Methods
 
   private
 
-  def name
+  def kind
     :failure
   end
 end

data/lib/bcdd/result/mixin.rb

@@ -13,18 +13,26 @@ class BCDD::Result
 
     module Methods
       def Success(type, value = nil)
-        Success.new(type: type, value: value, subject: self)
+        _ResultAs(Success, type, value)
       end
 
       def Failure(type, value = nil)
-        Failure.new(type: type, value: value, subject: self)
+        _ResultAs(Failure, type, value)
+      end
+
+      private def _ResultAs(kind_class, type, value, halted: nil)
+        kind_class.new(type: type, value: value, subject: self, halted: halted)
       end
     end
 
     module Addons
       module Continuable
+        def Success(type, value = nil)
+          _ResultAs(Success, type, value, halted: true)
+        end
+
         private def Continue(value)
-          Success(:continued, value)
+          _ResultAs(Success, :continued, value)
         end
       end
 
@@ -42,7 +50,7 @@ class BCDD::Result
     mod = mixin_module::Factory.module!
     mod.send(:include, mixin_module::Methods)
     mod.const_set(:Result, result_factory)
-    mod.send(:include, *addons) unless addons.empty?
+    mod.send(:include, *addons.values) unless addons.empty?
     mod
   end
 

data/lib/bcdd/result/success/methods.rb

@@ -15,7 +15,7 @@ module BCDD::Result::Success::Methods
 
   private
 
-  def name
+  def kind
     :success
   end
 end

data/lib/bcdd/result/version.rb

@@ -2,6 +2,6 @@
 
 module BCDD
   class Result
-    VERSION = '0.8.0'
+    VERSION = '0.9.0'
   end
 end

data/lib/bcdd/result.rb

@@ -3,7 +3,6 @@
 require_relative 'result/version'
 require_relative 'result/error'
 require_relative 'result/data'
-require_relative 'result/config'
 require_relative 'result/handler'
 require_relative 'result/failure'
 require_relative 'result/success'
@@ -11,11 +10,12 @@ require_relative 'result/mixin'
 require_relative 'result/contract'
 require_relative 'result/expectations'
 require_relative 'result/context'
+require_relative 'result/config'
 
 class BCDD::Result
   attr_accessor :unknown
 
-  attr_reader :subject, :data, :type_checker
+  attr_reader :subject, :data, :type_checker, :halted
 
   protected :subject
 
@@ -31,16 +31,21 @@ class BCDD::Result
     config.freeze
   end
 
-  def initialize(type:, value:, subject: nil, expectations: nil)
-    data = Data.new(name, type, value)
+  def initialize(type:, value:, subject: nil, expectations: nil, halted: nil)
+    data = Data.new(kind, type, value)
 
     @type_checker = Contract.evaluate(data, expectations)
     @subject = subject
+    @halted = halted || kind == :failure
     @data = data
 
     self.unknown = true
   end
 
+  def halted?
+    halted
+  end
+
   def type
     data.type
   end
@@ -80,7 +85,7 @@ class BCDD::Result
   end
 
   def and_then(method_name = nil, context = nil)
-    return self if failure?
+    return self if halted?
 
     method_name && block_given? and raise ::ArgumentError, 'method_name and block are mutually exclusive'
 
@@ -116,7 +121,7 @@ class BCDD::Result
   end
 
   def deconstruct_keys(_keys)
-    { name => { type => value } }
+    { kind => { type => value } }
   end
 
   alias eql? ==
@@ -124,7 +129,7 @@ class BCDD::Result
 
   private
 
-  def name
+  def kind
     :unknown
   end
 

data/sig/bcdd/result.rbs

@@ -10,6 +10,7 @@ class BCDD::Result
 
   attr_reader data: BCDD::Result::Data
   attr_reader subject: untyped
+  attr_reader halted: bool
 
   def self.config: -> BCDD::Result::Config
   def self.configuration: { (BCDD::Result::Config) -> void } -> BCDD::Result::Config
@@ -18,12 +19,14 @@ class BCDD::Result
     type: Symbol,
     value: untyped,
     ?subject: untyped,
-    ?expectations: BCDD::Result::Contract::Evaluator
+    ?expectations: BCDD::Result::Contract::Evaluator,
+    ?halted: bool
   ) -> void
 
   def type: -> Symbol
   def value: -> untyped
 
+  def halted?: -> bool
   def success?: (?Symbol type) -> bool
   def failure?: (?Symbol type) -> bool
 
@@ -50,7 +53,7 @@ class BCDD::Result
 
   private
 
-  def name: -> Symbol
+  def kind: -> Symbol
   def known: (Proc) -> untyped
   def call_subject_method: (Symbol, untyped) -> BCDD::Result
   def ensure_result_object: (untyped, origin: Symbol) -> BCDD::Result
@@ -65,7 +68,8 @@ class BCDD::Result
       def value: -> untyped
 
       private
-      def name: -> Symbol
+
+      def kind: -> Symbol
       def type_checker: -> BCDD::Result::Contract::TypeChecker
     end
 
@@ -85,7 +89,8 @@ class BCDD::Result
       def value: -> untyped
 
       private
-      def name: -> Symbol
+
+      def kind: -> Symbol
       def type_checker: -> BCDD::Result::Contract::TypeChecker
     end
 
@@ -105,6 +110,10 @@ class BCDD::Result
       def Success: (Symbol type, ?untyped value) -> BCDD::Result::Success
 
       def Failure: (Symbol type, ?untyped value) -> BCDD::Result::Failure
+
+      private
+
+      def _ResultAs: (singleton(BCDD::Result), Symbol, untyped, ?halted: bool) -> untyped
     end
 
     module Addons
@@ -118,7 +127,7 @@ class BCDD::Result
 
       OPTIONS: Hash[Symbol, Module]
 
-      def self.options: (Hash[Symbol, Hash[Symbol, bool]]) -> Array[Module]
+      def self.options: (Hash[Symbol, Hash[Symbol, bool]]) -> Hash[Symbol, Module]
     end
   end
 
@@ -131,7 +140,7 @@ end
 
 class BCDD::Result
   class Data
-    attr_reader name: Symbol
+    attr_reader kind: Symbol
     attr_reader type: Symbol
     attr_reader value: untyped
     attr_reader to_h: Hash[Symbol, untyped]
@@ -365,18 +374,16 @@ class BCDD::Result::Expectations
 
   def self.new: (
     ?subject: untyped,
-    ?success: Hash[Symbol, untyped] | Array[Symbol],
-    ?failure: Hash[Symbol, untyped] | Array[Symbol],
     ?contract: BCDD::Result::Contract::Evaluator,
-    ?config: Hash[Symbol, Hash[Symbol, bool]]
+    ?halted: bool,
+    **untyped
   ) -> (BCDD::Result::Expectations | untyped)
 
   def initialize: (
     ?subject: untyped,
-    ?success: Hash[Symbol, untyped] | Array[Symbol],
-    ?failure: Hash[Symbol, untyped] | Array[Symbol],
     ?contract: BCDD::Result::Contract::Evaluator,
-    ?config: Hash[Symbol, Hash[Symbol, bool]]
+    ?halted: bool,
+    **untyped
   ) -> void
 
   def Success: (Symbol, ?untyped) -> BCDD::Result::Success
@@ -386,8 +393,11 @@ class BCDD::Result::Expectations
 
   private
 
+  def _ResultAs: (singleton(BCDD::Result), Symbol, untyped) -> untyped
+
   attr_reader subject: untyped
   attr_reader contract: BCDD::Result::Contract::Evaluator
+  attr_reader halted: bool
 end
 
 module BCDD::Result::Expectations::Mixin
@@ -395,7 +405,12 @@ module BCDD::Result::Expectations::Mixin
     def self.module!: -> Module
   end
 
-  METHODS: String
+  module Methods
+    BASE: String
+    FACTORY: String
+
+    def self.to_eval: (Hash[Symbol, untyped]) -> String
+  end
 
   module Addons
     module Continuable
@@ -404,7 +419,7 @@ module BCDD::Result::Expectations::Mixin
 
     OPTIONS: Hash[Symbol, Module]
 
-    def self.options: (Hash[Symbol, Hash[Symbol, bool]]) -> Array[Module]
+    def self.options: (Hash[Symbol, Hash[Symbol, bool]]) -> Hash[Symbol, Module]
   end
 end
 
@@ -419,7 +434,8 @@ class BCDD::Result::Context < BCDD::Result
     type: Symbol,
     value: untyped,
     ?subject: untyped,
-    ?expectations: BCDD::Result::Contract::Evaluator
+    ?expectations: BCDD::Result::Contract::Evaluator,
+    ?halted: bool
   ) -> void
 
   def and_then: (?Symbol, **untyped) ?{ (Hash[Symbol, untyped]) -> untyped } -> BCDD::Result::Context
@@ -460,6 +476,10 @@ class BCDD::Result::Context
       def Success: (Symbol, **untyped) -> BCDD::Result::Context::Success
 
       def Failure: (Symbol, **untyped) -> BCDD::Result::Context::Failure
+
+      private
+
+      def _ResultAs: (singleton(BCDD::Result::Context), Symbol, untyped, ?halted: bool) -> untyped
     end
 
     module Addons
@@ -473,7 +493,7 @@ class BCDD::Result::Context
 
       OPTIONS: Hash[Symbol, Module]
 
-      def self.options: (Hash[Symbol, Hash[Symbol, bool]]) -> Array[Module]
+      def self.options: (Hash[Symbol, Hash[Symbol, bool]]) -> Hash[Symbol, Module]
     end
   end
 
@@ -492,7 +512,7 @@ class BCDD::Result::Context::Expectations < BCDD::Result::Expectations
 end
 
 module BCDD::Result::Context::Expectations::Mixin
-  METHODS: String
+  Methods: singleton(BCDD::Result::Expectations::Mixin::Methods)
   Factory: singleton(BCDD::Result::Expectations::Mixin::Factory)
 
   module Addons
@@ -502,7 +522,7 @@ module BCDD::Result::Context::Expectations::Mixin
 
     OPTIONS: Hash[Symbol, Module]
 
-    def self.options: (Hash[Symbol, Hash[Symbol, bool]]) -> Array[Module]
+    def self.options: (Hash[Symbol, Hash[Symbol, bool]]) -> Hash[Symbol, Module]
   end
 end
 
@@ -563,10 +583,8 @@ class BCDD::Result::Config::Switcher
 end
 
 module BCDD::Result::Config::ConstantAlias
-  RESULT: String
-
-  OPTIONS: Hash[String, Hash[Symbol, untyped]]
   MAPPING: Hash[String, Hash[Symbol, untyped]]
+  OPTIONS: Hash[String, Hash[Symbol, untyped]]
   Listener: Proc
 
   def self.switcher: -> BCDD::Result::Config::Switcher
@@ -578,14 +596,14 @@ module BCDD::Result::Config::Options
     Symbol
   ) -> Hash[Symbol, bool]
 
-  def self.filter_map: (
+  def self.select: (
     Hash[Symbol, Hash[Symbol, bool]],
     config: Symbol,
     from: Hash[Symbol, untyped]
-  ) -> Array[untyped]
+  ) -> Hash[Symbol, untyped]
 
   def self.addon: (
     map: Hash[Symbol, Hash[Symbol, bool]],
     from: Hash[Symbol, Module]
-  ) -> Array[Module]
+  ) -> Hash[Symbol, Module]
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: bcdd-result
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-11 00:00:00.000000000 Z
+date: 2023-12-12 00:00:00.000000000 Z
 dependencies: []
-description: Empower Ruby apps with pragmatic use of Result monad, Railway Oriented
-  Programming, and B/CDD.
+description: Empower Ruby apps with pragmatic use of Result pattern (monad), Railway
+  Oriented Programming, and B/CDD.
 email:
 - rodrigo.serradura@gmail.com
 executables: []
@@ -86,6 +86,6 @@ requirements: []
 rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
-summary: Empower Ruby apps with pragmatic use of Result monad, Railway Oriented Programming,
-  and B/CDD.
+summary: Empower Ruby apps with pragmatic use of Result pattern (monad), Railway Oriented
+  Programming, and B/CDD.
 test_files: []