bcdd-result 0.6.0 → 0.7.0

data/lib/bcdd/result/version.rb

@@ -2,6 +2,6 @@
 
 module BCDD
   class Result
-    VERSION = '0.6.0'
+    VERSION = '0.7.0'
   end
 end

data/lib/bcdd/result.rb

@@ -7,7 +7,9 @@ require_relative 'result/handler'
 require_relative 'result/failure'
 require_relative 'result/success'
 require_relative 'result/mixin'
+require_relative 'result/contract'
 require_relative 'result/expectations'
+require_relative 'result/context'
 
 class BCDD::Result
   attr_accessor :unknown
@@ -21,7 +23,7 @@ class BCDD::Result
   def initialize(type:, value:, subject: nil, expectations: nil)
     data = Data.new(name, type, value)
 
-    @type_checker = Expectations.evaluate(data, expectations)
+    @type_checker = Contract.evaluate(data, expectations)
     @subject = subject
     @data = data
 
@@ -69,7 +71,7 @@ class BCDD::Result
   def and_then(method_name = nil, context = nil)
     return self if failure?
 
-    method_name && block_given? and raise ArgumentError, 'method_name and block are mutually exclusive'
+    method_name && block_given? and raise ::ArgumentError, 'method_name and block are mutually exclusive'
 
     return call_subject_method(method_name, context) if method_name
 
@@ -129,7 +131,7 @@ class BCDD::Result
       when 0 then subject.send(method_name)
       when 1 then subject.send(method_name, value)
       when 2 then subject.send(method_name, value, context)
-      else raise Error::WrongSubjectMethodArity.build(subject: subject, method: method)
+      else raise Error::InvalidSubjectMethodArity.build(subject: subject, method: method, max_arity: 2)
       end
 
     ensure_result_object(result, origin: :method)
@@ -140,6 +142,6 @@ class BCDD::Result
 
     return result if result.subject.equal?(subject)
 
-    raise Error::WrongResultSubject.build(given_result: result, expected_subject: subject)
+    raise Error::InvalidResultSubject.build(given_result: result, expected_subject: subject)
   end
 end

data/sig/bcdd/result.rbs

@@ -6,7 +6,7 @@ end
 
 class BCDD::Result
   private attr_accessor unknown: bool
-  private attr_reader type_checker: BCDD::Result::Expectations::TypeChecker
+  private attr_reader type_checker: BCDD::Result::Contract::TypeChecker
 
   attr_reader data: BCDD::Result::Data
   attr_reader subject: untyped
@@ -15,7 +15,7 @@ class BCDD::Result
     type: Symbol,
     value: untyped,
     ?subject: untyped,
-    ?expectations: BCDD::Result::Expectations::Contract::Evaluator
+    ?expectations: BCDD::Result::Contract::Evaluator
   ) -> void
 
   def type: -> Symbol
@@ -31,7 +31,7 @@ class BCDD::Result
   def on_failure: (*Symbol) { (untyped, Symbol) -> void } -> BCDD::Result
   def on_unknown: () { (untyped, Symbol) -> void } -> BCDD::Result
 
-  def and_then: (?Symbol method_name, ?untyped context) ?{ (untyped) -> untyped } -> BCDD::Result
+  def and_then: (?Symbol method_name, ?untyped context) ?{ (untyped) -> untyped } -> untyped
 
   def handle: () { (BCDD::Result::Handler) -> void } -> untyped
 
@@ -54,17 +54,42 @@ class BCDD::Result
 end
 
 class BCDD::Result
-  class Failure < BCDD::Result
+  class Success < BCDD::Result
+    module Methods
+      def success?: (?Symbol type) -> bool
+      def failure?: (?Symbol type) -> bool
+      def value_or: { () -> untyped } -> untyped
+      def value: -> untyped
+
+      private
+      def name: -> Symbol
+      def type_checker: -> BCDD::Result::Contract::TypeChecker
+    end
+
+    include Methods
   end
 
-  def self.Success: (Symbol type, ?untyped value) -> BCDD::Result::Success
+  def self.Failure: (Symbol type, ?untyped value) -> BCDD::Result::Failure
 end
 
+
 class BCDD::Result
-  class Success < BCDD::Result
+  class Failure < BCDD::Result
+    module Methods
+      def success?: (?Symbol type) -> bool
+      def failure?: (?Symbol type) -> bool
+      def value_or: { (untyped) -> untyped } -> untyped
+      def value: -> untyped
+
+      private
+      def name: -> Symbol
+      def type_checker: -> BCDD::Result::Contract::TypeChecker
+    end
+
+    include Methods
   end
 
-  def self.Failure: (Symbol type, ?untyped value) -> BCDD::Result::Failure
+  def self.Success: (Symbol type, ?untyped value) -> BCDD::Result::Success
 end
 
 class BCDD::Result
@@ -79,13 +104,17 @@ class BCDD::Result
       module Continuable
         include BCDD::Result::Mixin::Methods
 
-        private def Continue: (untyped) -> BCDD::Result::Success
+        private
+
+        def Continue: (untyped) -> BCDD::Result::Success
       end
 
       OPTIONS: Hash[Symbol, Module]
 
       def self.options: (Array[Symbol]) -> Array[Module]
     end
+
+    def self.module!: -> Module
   end
 
   def self.mixin: (?with: Array[Symbol]) -> Module
@@ -109,7 +138,7 @@ class BCDD::Result
 end
 
 class BCDD::Result
-  class Error < ::StandardError
+  class Error < StandardError
     def self.build: (**untyped) -> BCDD::Result::Error
 
     class NotImplemented < BCDD::Result::Error
@@ -119,18 +148,18 @@ class BCDD::Result
     end
 
     class UnexpectedOutcome < BCDD::Result::Error
-      def self.build: (outcome: untyped, origin: Symbol)
+      def self.build: (outcome: untyped, origin: Symbol, ?expected: String)
           -> BCDD::Result::Error::UnexpectedOutcome
     end
 
-    class WrongResultSubject < BCDD::Result::Error
+    class InvalidResultSubject < BCDD::Result::Error
       def self.build: (given_result: BCDD::Result, expected_subject: untyped)
-          -> BCDD::Result::Error::WrongResultSubject
+          -> BCDD::Result::Error::InvalidResultSubject
     end
 
-    class WrongSubjectMethodArity < BCDD::Result::Error
-      def self.build: (subject: untyped, method: ::Method)
-        -> BCDD::Result::Error::WrongSubjectMethodArity
+    class InvalidSubjectMethodArity < BCDD::Result::Error
+      def self.build: (subject: untyped, method: Method, max_arity: Integer)
+        -> BCDD::Result::Error::InvalidSubjectMethodArity
     end
 
     class UnhandledTypes < BCDD::Result::Error
@@ -146,7 +175,7 @@ class BCDD::Result
 
     def initialize: (
       BCDD::Result,
-      type_checker: BCDD::Result::Expectations::TypeChecker
+      type_checker: BCDD::Result::Contract::TypeChecker
     ) -> void
 
     def []: (*Symbol) { (untyped, Symbol) -> void } -> untyped
@@ -170,10 +199,10 @@ end
 class BCDD::Result::Handler
   class AllowedTypes
     attr_reader unchecked: Set[Symbol]
-    attr_reader type_checker: BCDD::Result::Expectations::TypeChecker
+    attr_reader type_checker: BCDD::Result::Contract::TypeChecker
 
     def initialize: (
-      BCDD::Result::Expectations::TypeChecker
+      BCDD::Result::Contract::TypeChecker
     ) -> void
 
     def allow?: (Array[Symbol]) -> bool
@@ -188,69 +217,34 @@ class BCDD::Result::Handler
   end
 end
 
-class BCDD::Result::Expectations
-  MIXIN_METHODS: String
-
-  def self.mixin: (
-    ?success: Hash[Symbol, untyped] | Array[Symbol],
-    ?failure: Hash[Symbol, untyped] | Array[Symbol]
-  ) -> Module
+module BCDD::Result::Contract
+  NONE: BCDD::Result::Contract::Evaluator
 
   def self.evaluate: (
     BCDD::Result::Data,
-    BCDD::Result::Expectations::Contract::Evaluator
-  ) -> BCDD::Result::Expectations::TypeChecker
-
-  def initialize: (
-    ?subject: untyped,
-    ?success: Hash[Symbol, untyped] | Array[Symbol],
-    ?failure: Hash[Symbol, untyped] | Array[Symbol],
-    ?contract: BCDD::Result::Expectations::Contract::Evaluator
-  ) -> void
-
-  def Success: (Symbol, ?untyped) -> BCDD::Result::Success
-  def Failure: (Symbol, ?untyped) -> BCDD::Result::Failure
-
-  private
-
-  attr_reader subject: untyped
-  attr_reader contract: BCDD::Result::Expectations::Contract::Evaluator
-end
-
-module BCDD::Result::Expectations::Mixin
-  METHODS: String
-
-  module Addons
-    module Continuable
-      private def Continue: (untyped) -> BCDD::Result::Success
-    end
-
-    OPTIONS: Hash[Symbol, Module]
-
-    def self.options: (Array[Symbol]) -> Array[Module]
-  end
-end
-
-module BCDD::Result::Expectations::Contract
-  NONE: BCDD::Result::Expectations::Contract::Evaluator
+    BCDD::Result::Contract::Evaluator
+  ) -> BCDD::Result::Contract::TypeChecker
 
   ToEnsure: ^(Hash[Symbol, untyped] | Array[Symbol])
-    -> BCDD::Result::Expectations::Contract::Evaluator
+    -> BCDD::Result::Contract::Evaluator
 
   def self.new: (
     success: Hash[Symbol, untyped] | Array[Symbol],
     failure: Hash[Symbol, untyped] | Array[Symbol]
-  ) -> BCDD::Result::Expectations::Contract::Evaluator
+  ) -> BCDD::Result::Contract::Evaluator
+
+  def self.nil_as_valid_value_checking!: (?enabled: bool) -> void
+  def self.nil_as_valid_value_checking?: -> bool
 end
 
-class BCDD::Result::Expectations
+module BCDD::Result::Contract
   class TypeChecker
     attr_reader result_type: Symbol
-    attr_reader expectations: BCDD::Result::Expectations::Contract::Evaluator
+    attr_reader expectations: BCDD::Result::Contract::Evaluator
 
     def initialize: (
       Symbol,
-      expectations: BCDD::Result::Expectations::Contract::Evaluator
+      expectations: BCDD::Result::Contract::Evaluator
     ) -> void
 
     def allow?: (Array[Symbol]) -> bool
@@ -261,27 +255,27 @@ class BCDD::Result::Expectations
 
     def validate: (
       Array[Symbol],
-      expected: BCDD::Result::Expectations::Contract::Interface,
+      expected: BCDD::Result::Contract::Interface,
       allow_empty: bool
     ) -> bool
   end
 end
 
-class BCDD::Result::Expectations::Error < BCDD::Result::Error
-  class UnexpectedType < BCDD::Result::Expectations::Error
+class BCDD::Result::Contract::Error < BCDD::Result::Error
+  class UnexpectedType < BCDD::Result::Contract::Error
     def self.build: (type: Symbol, allowed_types: Set[Symbol])
-        -> BCDD::Result::Expectations::Error::UnexpectedType
+        -> BCDD::Result::Contract::Error::UnexpectedType
   end
 
-  class UnexpectedValue < BCDD::Result::Expectations::Error
-    def self.build: (type: Symbol, value: untyped)
-      -> BCDD::Result::Expectations::Error::UnexpectedValue
+  class UnexpectedValue < BCDD::Result::Contract::Error
+    def self.build: (type: Symbol, value: untyped, ?cause: Exception)
+      -> BCDD::Result::Contract::Error::UnexpectedValue
   end
 end
 
-module BCDD::Result::Expectations::Contract
+module BCDD::Result::Contract
   module Interface
-    def ==: (BCDD::Result::Expectations::Contract::Interface) -> bool
+    def ==: (BCDD::Result::Contract::Interface) -> bool
 
     def allowed_types: -> Set[Symbol]
 
@@ -295,7 +289,7 @@ module BCDD::Result::Expectations::Contract
   end
 end
 
-module BCDD::Result::Expectations::Contract
+module BCDD::Result::Contract
   module Disabled
     extend Interface
 
@@ -303,7 +297,7 @@ module BCDD::Result::Expectations::Contract
   end
 end
 
-module BCDD::Result::Expectations::Contract
+module BCDD::Result::Contract
   class ForTypes
     include Interface
 
@@ -311,7 +305,7 @@ module BCDD::Result::Expectations::Contract
   end
 end
 
-module BCDD::Result::Expectations::Contract
+module BCDD::Result::Contract
   class ForTypesAndValues
     include Interface
 
@@ -319,21 +313,171 @@ module BCDD::Result::Expectations::Contract
   end
 end
 
-module BCDD::Result::Expectations::Contract
+module BCDD::Result::Contract
   class Evaluator
     include Interface
 
     attr_reader allowed_types: Set[Symbol]
-    attr_reader success: BCDD::Result::Expectations::Contract::Interface
-    attr_reader failure: BCDD::Result::Expectations::Contract::Interface
+    attr_reader success: BCDD::Result::Contract::Interface
+    attr_reader failure: BCDD::Result::Contract::Interface
 
     def initialize: (
-      BCDD::Result::Expectations::Contract::Interface,
-      BCDD::Result::Expectations::Contract::Interface
+      BCDD::Result::Contract::Interface,
+      BCDD::Result::Contract::Interface
     ) -> void
 
     private
 
-    def for: (BCDD::Result::Data) -> BCDD::Result::Expectations::Contract::Interface
+    def for: (BCDD::Result::Data) -> BCDD::Result::Contract::Interface
+  end
+end
+
+class BCDD::Result::Expectations
+  def self.mixin: (
+    ?with: Symbol,
+    ?success: Hash[Symbol, untyped] | Array[Symbol],
+    ?failure: Hash[Symbol, untyped] | Array[Symbol]
+  ) -> Module
+
+  def initialize: (
+    ?subject: untyped,
+    ?success: Hash[Symbol, untyped] | Array[Symbol],
+    ?failure: Hash[Symbol, untyped] | Array[Symbol],
+    ?contract: BCDD::Result::Contract::Evaluator
+  ) -> void
+
+  def Success: (Symbol, ?untyped) -> BCDD::Result::Success
+  def Failure: (Symbol, ?untyped) -> BCDD::Result::Failure
+
+  def with: (subject: untyped) -> BCDD::Result::Expectations
+
+  private
+
+  attr_reader subject: untyped
+  attr_reader contract: BCDD::Result::Contract::Evaluator
+end
+
+module BCDD::Result::Expectations::Mixin
+  METHODS: String
+
+  module Addons
+    module Continuable
+      private def Continue: (untyped) -> BCDD::Result::Success
+    end
+
+    OPTIONS: Hash[Symbol, Module]
+
+    def self.options: (Symbol) -> Array[Module]
+  end
+
+  def self.module!: -> Module
+end
+
+class BCDD::Result::Context < BCDD::Result
+  EXPECTED_OUTCOME: String
+
+  SubjectMethodArity: ^(Method) -> Integer
+
+  attr_reader acc: Hash[Symbol, untyped]
+
+  def initialize: (
+    type: Symbol,
+    value: untyped,
+    ?subject: untyped,
+    ?expectations: BCDD::Result::Contract::Evaluator
+  ) -> void
+
+  def and_then: (?Symbol, **untyped) ?{ (Hash[Symbol, untyped]) -> untyped } -> BCDD::Result::Context
+
+  private
+
+  def call_subject_method: (Symbol, Hash[Symbol, untyped]) -> BCDD::Result::Context
+  def ensure_result_object: (untyped, origin: Symbol) -> BCDD::Result::Context
+
+  def raise_unexpected_outcome_error: (BCDD::Result::Context | untyped, Symbol) -> void
+end
+
+class BCDD::Result::Context
+  class Success < BCDD::Result::Context
+    include BCDD::Result::Success::Methods
+
+    def and_expose: (Symbol, Array[Symbol]) -> BCDD::Result::Context::Success
+  end
+
+  def self.Success: (Symbol, **untyped) -> BCDD::Result::Context::Success
+end
+
+class BCDD::Result::Context
+  class Failure < BCDD::Result::Context
+    include BCDD::Result::Failure::Methods
+
+    def and_expose: (Symbol, Array[Symbol]) -> BCDD::Result::Context::Failure
+  end
+
+  def self.Failure: (Symbol, **untyped) -> BCDD::Result::Context::Failure
+end
+
+class BCDD::Result::Context
+  module Mixin
+    module Methods
+      def Success: (Symbol, **untyped) -> BCDD::Result::Context::Success
+
+      def Failure: (Symbol, **untyped) -> BCDD::Result::Context::Failure
+    end
+
+    module Addons
+      module Continuable
+        include BCDD::Result::Context::Mixin::Methods
+
+        private
+
+        def Continue: (**untyped) -> BCDD::Result::Context::Success
+      end
+
+      OPTIONS: Hash[Symbol, Module]
+
+      def self.options: (Array[Symbol]) -> Array[Module]
+    end
+  end
+
+  def self.mixin: (?with: Array[Symbol]) -> Module
+end
+
+class BCDD::Result::Context::Expectations
+  def self.mixin: (
+    ?with: Symbol,
+    ?success: Hash[Symbol, untyped] | Array[Symbol],
+    ?failure: Hash[Symbol, untyped] | Array[Symbol]
+  ) -> Module
+
+  def initialize: (
+    ?subject: untyped,
+    ?success: Hash[Symbol, untyped] | Array[Symbol],
+    ?failure: Hash[Symbol, untyped] | Array[Symbol],
+    ?contract: BCDD::Result::Contract::Evaluator
+  ) -> void
+
+  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
+
+  module Addons
+    module Continuable
+      private def Continue: (**untyped) -> BCDD::Result::Context::Success
+    end
+
+    OPTIONS: Hash[Symbol, Module]
+
+    def self.options: (Symbol) -> Array[Module]
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bcdd-result
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-11 00:00:00.000000000 Z
+date: 2023-10-27 00:00:00.000000000 Z
 dependencies: []
 description: |-
   Empower Ruby apps with a pragmatic use of Railway Oriented Programming.
@@ -29,23 +29,31 @@ files:
 - Rakefile
 - Steepfile
 - lib/bcdd/result.rb
+- lib/bcdd/result/context.rb
+- lib/bcdd/result/context/expectations.rb
+- lib/bcdd/result/context/expectations/mixin.rb
+- lib/bcdd/result/context/failure.rb
+- lib/bcdd/result/context/mixin.rb
+- lib/bcdd/result/context/success.rb
+- lib/bcdd/result/contract.rb
+- lib/bcdd/result/contract/disabled.rb
+- lib/bcdd/result/contract/error.rb
+- lib/bcdd/result/contract/evaluator.rb
+- lib/bcdd/result/contract/for_types.rb
+- lib/bcdd/result/contract/for_types_and_values.rb
+- lib/bcdd/result/contract/interface.rb
+- lib/bcdd/result/contract/type_checker.rb
 - lib/bcdd/result/data.rb
 - lib/bcdd/result/error.rb
 - lib/bcdd/result/expectations.rb
-- lib/bcdd/result/expectations/contract.rb
-- lib/bcdd/result/expectations/contract/disabled.rb
-- lib/bcdd/result/expectations/contract/evaluator.rb
-- lib/bcdd/result/expectations/contract/for_types.rb
-- lib/bcdd/result/expectations/contract/for_types_and_values.rb
-- lib/bcdd/result/expectations/contract/interface.rb
-- lib/bcdd/result/expectations/error.rb
 - lib/bcdd/result/expectations/mixin.rb
-- lib/bcdd/result/expectations/type_checker.rb
 - lib/bcdd/result/failure.rb
+- lib/bcdd/result/failure/methods.rb
 - lib/bcdd/result/handler.rb
 - lib/bcdd/result/handler/allowed_types.rb
 - lib/bcdd/result/mixin.rb
 - lib/bcdd/result/success.rb
+- lib/bcdd/result/success/methods.rb
 - lib/bcdd/result/version.rb
 - lib/result.rb
 - sig/bcdd/result.rbs

data/lib/bcdd/result/expectations/contract/interface.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-class BCDD::Result::Expectations
-  module Contract::Interface
-    def allowed_types
-      raise ::BCDD::Result::Error::NotImplemented
-    end
-
-    def type?(_type)
-      raise ::BCDD::Result::Error::NotImplemented
-    end
-
-    def type!(_type)
-      raise ::BCDD::Result::Error::NotImplemented
-    end
-
-    def type_and_value!(_data)
-      raise ::BCDD::Result::Error::NotImplemented
-    end
-  end
-end

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

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-class BCDD::Result::Expectations
-  module Contract
-    require_relative 'contract/interface'
-    require_relative 'contract/evaluator'
-    require_relative 'contract/disabled'
-    require_relative 'contract/for_types'
-    require_relative 'contract/for_types_and_values'
-
-    NONE = Contract::Evaluator.new(Contract::Disabled, Contract::Disabled).freeze
-
-    ToEnsure = ->(spec) do
-      return Contract::Disabled if spec.nil?
-
-      spec.is_a?(Hash) ? Contract::ForTypesAndValues.new(spec) : Contract::ForTypes.new(Array(spec))
-    end
-
-    def self.new(success:, failure:)
-      Contract::Evaluator.new(ToEnsure[success], ToEnsure[failure])
-    end
-
-    private_constant :ToEnsure
-  end
-end