bcdd-result 0.7.0 → 0.9.0

data/lib/bcdd/result/mixin.rb

@@ -2,44 +2,65 @@
 
 class BCDD::Result
   module Mixin
+    module Factory
+      def self.module!
+        ::Module.new do
+          def self.included(base); base.const_set(:ResultMixin, self); end
+          def self.extended(base); base.const_set(:ResultMixin, self); end
+        end
+      end
+    end
+
     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
 
-      OPTIONS = { Continue: Continuable }.freeze
+      OPTIONS = { continue: Continuable }.freeze
 
-      def self.options(names)
-        Array(names).filter_map { |name| OPTIONS[name] }
-      end
-    end
-
-    def self.module!
-      ::Module.new do
-        def self.included(base); base.const_set(:ResultMixin, self); end
-        def self.extended(base); base.const_set(:ResultMixin, self); end
+      def self.options(config_flags)
+        Config::Options.addon(map: config_flags, from: OPTIONS)
       end
     end
   end
 
-  def self.mixin(with: nil)
-    addons = Mixin::Addons.options(with)
+  def self.mixin(config: nil)
+    addons = mixin_module::Addons.options(config)
 
-    mod = Mixin.module!
-    mod.send(:include, Mixin::Methods)
-    mod.send(:include, *addons) unless addons.empty?
+    mod = mixin_module::Factory.module!
+    mod.send(:include, mixin_module::Methods)
+    mod.const_set(:Result, result_factory)
+    mod.send(:include, *addons.values) unless addons.empty?
     mod
   end
+
+  def self.mixin_module
+    Mixin
+  end
+
+  def self.result_factory
+    ::BCDD::Result
+  end
+
+  private_class_method :mixin_module, :result_factory
 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.7.0'
+    VERSION = '0.9.0'
   end
 end

data/lib/bcdd/result.rb

@@ -10,26 +10,42 @@ 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
 
   private :unknown, :unknown=, :type_checker
 
-  def initialize(type:, value:, subject: nil, expectations: nil)
-    data = Data.new(name, type, value)
+  def self.config
+    Config.instance
+  end
+
+  def self.configuration
+    yield(config)
+
+    config.freeze
+  end
+
+  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
@@ -69,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'
 
@@ -105,7 +121,7 @@ class BCDD::Result
   end
 
   def deconstruct_keys(_keys)
-    { name => { type => value } }
+    { kind => { type => value } }
   end
 
   alias eql? ==
@@ -113,7 +129,7 @@ class BCDD::Result
 
   private
 
-  def name
+  def kind
     :unknown
   end
 

data/lib/bcdd-result.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'bcdd/result'

data/sig/bcdd/result.rbs

@@ -10,17 +10,23 @@ 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
 
   def initialize: (
     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
 
@@ -47,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
@@ -62,7 +68,8 @@ class BCDD::Result
       def value: -> untyped
 
       private
-      def name: -> Symbol
+
+      def kind: -> Symbol
       def type_checker: -> BCDD::Result::Contract::TypeChecker
     end
 
@@ -82,7 +89,8 @@ class BCDD::Result
       def value: -> untyped
 
       private
-      def name: -> Symbol
+
+      def kind: -> Symbol
       def type_checker: -> BCDD::Result::Contract::TypeChecker
     end
 
@@ -94,10 +102,18 @@ end
 
 class BCDD::Result
   module Mixin
+    module Factory
+      def self.module!: -> Module
+    end
+
     module Methods
       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
@@ -111,18 +127,20 @@ class BCDD::Result
 
       OPTIONS: Hash[Symbol, Module]
 
-      def self.options: (Array[Symbol]) -> Array[Module]
+      def self.options: (Hash[Symbol, Hash[Symbol, bool]]) -> Hash[Symbol, Module]
     end
-
-    def self.module!: -> Module
   end
 
-  def self.mixin: (?with: Array[Symbol]) -> Module
+  def self.mixin: (?config: Hash[Symbol, Hash[Symbol, bool]]) -> Module
+
+  def self.mixin_module: -> singleton(BCDD::Result::Mixin)
+
+  def self.result_factory: -> singleton(BCDD::Result)
 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]
@@ -225,16 +243,14 @@ module BCDD::Result::Contract
     BCDD::Result::Contract::Evaluator
   ) -> BCDD::Result::Contract::TypeChecker
 
-  ToEnsure: ^(Hash[Symbol, untyped] | Array[Symbol])
-    -> BCDD::Result::Contract::Evaluator
+  ToEnsure: ^(Hash[Symbol, untyped] | Array[Symbol], Hash[Symbol, Hash[Symbol, bool]])
+    -> BCDD::Result::Contract::Interface
 
   def self.new: (
     success: Hash[Symbol, untyped] | Array[Symbol],
-    failure: Hash[Symbol, untyped] | Array[Symbol]
+    failure: Hash[Symbol, untyped] | Array[Symbol],
+    config: Hash[Symbol, Hash[Symbol, bool]]
   ) -> BCDD::Result::Contract::Evaluator
-
-  def self.nil_as_valid_value_checking!: (?enabled: bool) -> void
-  def self.nil_as_valid_value_checking?: -> bool
 end
 
 module BCDD::Result::Contract
@@ -309,7 +325,14 @@ module BCDD::Result::Contract
   class ForTypesAndValues
     include Interface
 
-    def initialize: (Hash[Symbol, untyped]) -> void
+    def initialize: (
+      Hash[Symbol, untyped],
+      Hash[Symbol, Hash[Symbol, bool]]
+    ) -> void
+
+    private
+
+    def nil_as_valid_value_checking?: -> bool
   end
 end
 
@@ -334,16 +357,33 @@ end
 
 class BCDD::Result::Expectations
   def self.mixin: (
-    ?with: Symbol,
+    ?config: Hash[Symbol, Hash[Symbol, bool]],
+    ?success: Hash[Symbol, untyped] | Array[Symbol],
+    ?failure: Hash[Symbol, untyped] | Array[Symbol]
+  ) -> Module
+
+  def self.mixin!: (
+    ?config: Hash[Symbol, Hash[Symbol, bool]],
     ?success: Hash[Symbol, untyped] | Array[Symbol],
     ?failure: Hash[Symbol, untyped] | Array[Symbol]
   ) -> Module
 
+  def self.mixin_module: -> singleton(BCDD::Result::Expectations::Mixin)
+
+  def self.result_factory_without_expectations: -> singleton(BCDD::Result)
+
+  def self.new: (
+    ?subject: untyped,
+    ?contract: BCDD::Result::Contract::Evaluator,
+    ?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
+    ?contract: BCDD::Result::Contract::Evaluator,
+    ?halted: bool,
+    **untyped
   ) -> void
 
   def Success: (Symbol, ?untyped) -> BCDD::Result::Success
@@ -353,12 +393,24 @@ 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
-  METHODS: String
+  module Factory
+    def self.module!: -> Module
+  end
+
+  module Methods
+    BASE: String
+    FACTORY: String
+
+    def self.to_eval: (Hash[Symbol, untyped]) -> String
+  end
 
   module Addons
     module Continuable
@@ -367,10 +419,8 @@ module BCDD::Result::Expectations::Mixin
 
     OPTIONS: Hash[Symbol, Module]
 
-    def self.options: (Symbol) -> Array[Module]
+    def self.options: (Hash[Symbol, Hash[Symbol, bool]]) -> Hash[Symbol, Module]
   end
-
-  def self.module!: -> Module
 end
 
 class BCDD::Result::Context < BCDD::Result
@@ -384,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
@@ -419,10 +470,16 @@ end
 
 class BCDD::Result::Context
   module Mixin
+    Factory: singleton(BCDD::Result::Mixin::Factory)
+
     module Methods
       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
@@ -436,40 +493,27 @@ class BCDD::Result::Context
 
       OPTIONS: Hash[Symbol, Module]
 
-      def self.options: (Array[Symbol]) -> Array[Module]
+      def self.options: (Hash[Symbol, Hash[Symbol, bool]]) -> Hash[Symbol, Module]
     end
   end
 
-  def self.mixin: (?with: Array[Symbol]) -> Module
+  def self.mixin_module: -> singleton(BCDD::Result::Context::Mixin)
+
+  def self.result_factory: -> singleton(BCDD::Result::Context)
 end
 
-class BCDD::Result::Context::Expectations
-  def self.mixin: (
-    ?with: Symbol,
-    ?success: Hash[Symbol, untyped] | Array[Symbol],
-    ?failure: Hash[Symbol, untyped] | Array[Symbol]
-  ) -> Module
+class BCDD::Result::Context::Expectations < BCDD::Result::Expectations
+  def self.mixin_module: -> singleton(BCDD::Result::Context::Expectations::Mixin)
 
-  def initialize: (
-    ?subject: untyped,
-    ?success: Hash[Symbol, untyped] | Array[Symbol],
-    ?failure: Hash[Symbol, untyped] | Array[Symbol],
-    ?contract: BCDD::Result::Contract::Evaluator
-  ) -> void
+  def self.result_factory_without_expectations: -> singleton(BCDD::Result)
 
   def Success: (Symbol, **untyped) -> BCDD::Result::Context::Success
   def Failure: (Symbol, **untyped) -> BCDD::Result::Context::Failure
-
-  def with: (subject: untyped) -> BCDD::Result::Context::Expectations
-
-  private
-
-  attr_reader subject: untyped
-  attr_reader contract: BCDD::Result::Contract::Evaluator
 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
     module Continuable
@@ -478,6 +522,88 @@ module BCDD::Result::Context::Expectations::Mixin
 
     OPTIONS: Hash[Symbol, Module]
 
-    def self.options: (Symbol) -> Array[Module]
+    def self.options: (Hash[Symbol, Hash[Symbol, bool]]) -> Hash[Symbol, Module]
   end
 end
+
+class BCDD::Result::Config
+  include Singleton
+
+  ADDON: Hash[Symbol, Hash[Symbol, untyped]]
+  FEATURE: Hash[Symbol, Hash[Symbol, untyped]]
+  PATTERN_MATCHING: Hash[Symbol, Hash[Symbol, untyped]]
+
+  attr_reader addon: BCDD::Result::Config::Switcher
+  attr_reader feature: BCDD::Result::Config::Switcher
+  attr_reader constant_alias: BCDD::Result::Config::Switcher
+  attr_reader pattern_matching: BCDD::Result::Config::Switcher
+
+  def self.instance: -> BCDD::Result::Config
+
+  def initialize: -> void
+
+  def freeze: -> BCDD::Result::Config
+  def options: -> Hash[Symbol, BCDD::Result::Config::Switcher]
+  def to_h: -> Hash[Symbol, Hash[Symbol | String, bool]]
+end
+
+class BCDD::Result::Config::Switcher
+  private attr_reader _affects: Hash[Symbol | String, Array[String]]
+  private attr_reader _options: Hash[Symbol | String, bool]
+  private attr_reader listener: Proc
+
+  def initialize: (
+    options: Hash[Symbol | String, Hash[Symbol, untyped]],
+    ?listener: Proc
+  ) -> void
+
+  def freeze: -> BCDD::Result::Config::Switcher
+
+  def to_h: -> Hash[Symbol | String, bool]
+
+  def options: -> Hash[Symbol | String, Hash[Symbol, untyped]]
+
+  def enabled?: (Symbol | String) -> bool
+
+  def enable!: (*(Symbol | String)) -> Hash[Symbol | String, Hash[Symbol, untyped]]
+
+  def disable!: (*(Symbol | String)) -> Hash[Symbol | String, Hash[Symbol, untyped]]
+
+  private
+
+  def set_many: (Array[Symbol | String], to: bool) -> Hash[Symbol | String, Hash[Symbol, untyped]]
+
+  def set_one: (Symbol | String, bool) -> void
+
+  def require_option!: (Array[Symbol | String]) -> void
+
+  def validate_option!: (Symbol | String) -> void
+
+  def available_options_message: -> String
+end
+
+module BCDD::Result::Config::ConstantAlias
+  MAPPING: Hash[String, Hash[Symbol, untyped]]
+  OPTIONS: Hash[String, Hash[Symbol, untyped]]
+  Listener: Proc
+
+  def self.switcher: -> BCDD::Result::Config::Switcher
+end
+
+module BCDD::Result::Config::Options
+  def self.with_defaults: (
+    Hash[Symbol, Hash[Symbol, bool]],
+    Symbol
+  ) -> Hash[Symbol, bool]
+
+  def self.select: (
+    Hash[Symbol, Hash[Symbol, bool]],
+    config: Symbol,
+    from: Hash[Symbol, untyped]
+  ) -> Hash[Symbol, untyped]
+
+  def self.addon: (
+    map: Hash[Symbol, Hash[Symbol, bool]],
+    from: Hash[Symbol, Module]
+  ) -> Hash[Symbol, Module]
+end

metadata

@@ -1,19 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: bcdd-result
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-27 00:00:00.000000000 Z
+date: 2023-12-12 00:00:00.000000000 Z
 dependencies: []
-description: |-
-  Empower Ruby apps with a pragmatic use of Railway Oriented Programming.
-
-  It's a general-purpose result monad that allows you to create objects representing a success (BCDD::Result::Success) or failure (BCDD::Result::Failure).
+description: Empower Ruby apps with pragmatic use of Result pattern (monad), Railway
+  Oriented Programming, and B/CDD.
 email:
 - rodrigo.serradura@gmail.com
 executables: []
@@ -28,7 +26,12 @@ files:
 - README.md
 - Rakefile
 - Steepfile
+- lib/bcdd-result.rb
 - lib/bcdd/result.rb
+- lib/bcdd/result/config.rb
+- lib/bcdd/result/config/constant_alias.rb
+- lib/bcdd/result/config/options.rb
+- lib/bcdd/result/config/switcher.rb
 - lib/bcdd/result/context.rb
 - lib/bcdd/result/context/expectations.rb
 - lib/bcdd/result/context/expectations/mixin.rb
@@ -55,7 +58,6 @@ files:
 - lib/bcdd/result/success.rb
 - lib/bcdd/result/success/methods.rb
 - lib/bcdd/result/version.rb
-- lib/result.rb
 - sig/bcdd/result.rbs
 homepage: https://github.com/b-cdd/result
 licenses:
@@ -84,5 +86,6 @@ requirements: []
 rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
-summary: A pragmatic result abstraction (monad based) for Ruby.
+summary: Empower Ruby apps with pragmatic use of Result pattern (monad), Railway Oriented
+  Programming, and B/CDD.
 test_files: []

data/lib/result.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'bcdd/result'
-
-Object.const_set(:Result, BCDD::Result)