bcdd-result 0.3.0 → 0.5.0

data/lib/bcdd/result/data.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+class BCDD::Result
+  class Data
+    attr_reader :name, :type, :value
+
+    def initialize(name, type, value)
+      @name = name
+      @type = type.to_sym
+      @value = value
+    end
+
+    def to_h
+      { name: name, type: type, value: value }
+    end
+
+    def to_a
+      [name, 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
+      )
+    end
+
+    alias to_ary to_a
+    alias to_hash to_h
+  end
+
+  private_constant :Data
+end

data/lib/bcdd/result/error.rb

@@ -1,46 +1,52 @@
 # frozen_string_literal: true
 
-class BCDD::Result
-  class Error < ::StandardError
-    def self.build(**_kargs)
-      new
-    end
+class BCDD::Result::Error < StandardError
+  def self.build(**_kargs)
+    new
+  end
 
-    class NotImplemented < self
-    end
+  class NotImplemented < self
+  end
 
-    class MissingTypeArgument < self
-      def initialize(_arg = nil)
-        super('A type (argument) is required to invoke the #on/#on_type method')
-      end
+  class MissingTypeArgument < self
+    def initialize(_arg = nil)
+      super('A type (argument) is required to invoke the #on/#on_type method')
     end
+  end
 
-    class UnexpectedOutcome < self
-      def self.build(outcome:, origin:)
-        message =
-          "Unexpected outcome: #{outcome.inspect}. The #{origin} must return this object wrapped by " \
-          'BCDD::Result::Success or BCDD::Result::Failure'
+  class UnexpectedOutcome < self
+    def self.build(outcome:, origin:)
+      message =
+        "Unexpected outcome: #{outcome.inspect}. The #{origin} must return this object wrapped by " \
+        'BCDD::Result::Success or BCDD::Result::Failure'
 
-        new(message)
-      end
+      new(message)
     end
+  end
 
-    class WrongResultSubject < self
-      def self.build(given_result:, expected_subject:)
-        message =
-          "You cannot call #and_then and return a result that does not belong to the subject!\n" \
-          "Expected subject: #{expected_subject.inspect}\n" \
-          "Given subject: #{given_result.send(:subject).inspect}\n" \
-          "Given result: #{given_result.inspect}"
+  class WrongResultSubject < self
+    def self.build(given_result:, expected_subject:)
+      message =
+        "You cannot call #and_then and return a result that does not belong to the subject!\n" \
+        "Expected subject: #{expected_subject.inspect}\n" \
+        "Given subject: #{given_result.send(:subject).inspect}\n" \
+        "Given result: #{given_result.inspect}"
 
-        new(message)
-      end
+      new(message)
     end
+  end
+
+  class WrongSubjectMethodArity < self
+    def self.build(subject:, method:)
+      new("#{subject.class}##{method.name} has unsupported arity (#{method.arity}). Expected 0 or 1.")
+    end
+  end
+
+  class UnhandledTypes < self
+    def self.build(types:)
+      subject = types.size == 1 ? 'This was' : 'These were'
 
-    class WrongSubjectMethodArity < self
-      def self.build(subject:, method:)
-        new("#{subject.class}##{method.name} has unsupported arity (#{method.arity}). Expected 0 or 1.")
-      end
+      new("You must handle all cases. #{subject} not handled: #{types.map(&:inspect).join(', ')}")
     end
   end
 end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class BCDD::Result::Expectations
+  module Contract::Disabled
+    extend Contract::Interface
+
+    EMPTY_SET = Set.new.freeze
+
+    def self.allowed_types
+      EMPTY_SET
+    end
+
+    def self.type?(_type)
+      true
+    end
+
+    def self.type!(type)
+      type
+    end
+
+    def self.type_and_value!(_data); end
+
+    private_constant :EMPTY_SET
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+class BCDD::Result::Expectations
+  class Contract::Evaluator
+    include Contract::Interface
+
+    attr_reader :allowed_types, :success, :failure
+
+    def initialize(success, failure)
+      @success = success
+      @failure = failure
+
+      @allowed_types = (success.allowed_types | failure.allowed_types).freeze
+    end
+
+    def type?(type)
+      success_disabled = success == Contract::Disabled
+      failure_disabled = failure == Contract::Disabled
+
+      return Contract::Disabled.type?(type) if success_disabled && failure_disabled
+
+      (!success_disabled && success.type?(type)) || (!failure_disabled && failure.type?(type))
+    end
+
+    def type!(type)
+      return type if type?(type)
+
+      raise Error::UnexpectedType.build(type: type, allowed_types: allowed_types)
+    end
+
+    def type_and_value!(data)
+      self.for(data).type_and_value!(data)
+    end
+
+    private
+
+    def for(data)
+      case data.name
+      when :unknown then Contract::Disabled
+      when :success then success
+      else failure
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class BCDD::Result::Expectations
+  class Contract::ForTypes
+    include Contract::Interface
+
+    attr_reader :allowed_types
+
+    def initialize(types)
+      @allowed_types = Array(types).map(&:to_sym).to_set.freeze
+    end
+
+    def type?(type)
+      allowed_types.member?(type)
+    end
+
+    def type!(type)
+      return type if type?(type)
+
+      raise Error::UnexpectedType.build(type: type, allowed_types: allowed_types)
+    end
+
+    def type_and_value!(data)
+      type!(data.type)
+
+      nil
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+class BCDD::Result::Expectations
+  class Contract::ForTypesAndValues
+    include Contract::Interface
+
+    def initialize(types_and_values)
+      @types_and_values = types_and_values.transform_keys(&:to_sym)
+
+      @types_contract = Contract::ForTypes.new(@types_and_values.keys)
+    end
+
+    def allowed_types
+      @types_contract.allowed_types
+    end
+
+    def type?(type)
+      @types_contract.type?(type)
+    end
+
+    def type!(type)
+      @types_contract.type!(type)
+    end
+
+    def type_and_value!(data)
+      type = data.type
+      value = data.value
+      allowed_value = @types_and_values[type!(type)]
+
+      return value if allowed_value === value
+
+      raise Error::UnexpectedValue.build(type: type, value: value)
+    rescue NoMatchingPatternError
+      raise Error::UnexpectedValue.build(type: data.type, value: data.value)
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# 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

@@ -0,0 +1,25 @@
+# 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

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class BCDD::Result::Expectations::Error < BCDD::Result::Error
+  class UnexpectedType < self
+    def self.build(type:, allowed_types:)
+      new("type :#{type} is not allowed. Allowed types: #{allowed_types.map(&:inspect).join(', ')}")
+    end
+  end
+
+  class UnexpectedValue < self
+    def self.build(type:, value:)
+      new("value #{value.inspect} is not allowed for :#{type} type")
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+class BCDD::Result::Expectations
+  class TypeChecker
+    attr_reader :result_type, :expectations
+
+    def initialize(result_type, expectations:)
+      @result_type = result_type
+
+      @expectations = expectations
+    end
+
+    def allow?(types)
+      validate(types, expected: expectations, allow_empty: false)
+    end
+
+    def allow_success?(types)
+      validate(types, expected: expectations.success, allow_empty: true)
+    end
+
+    def allow_failure?(types)
+      validate(types, expected: expectations.failure, allow_empty: true)
+    end
+
+    private
+
+    def validate(types, expected:, allow_empty:)
+      (allow_empty && types.empty?) || types.any? { |type| expected.type!(type) == result_type }
+    end
+  end
+
+  private_constant :TypeChecker
+end

data/lib/bcdd/result/expectations.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+class BCDD::Result::Expectations
+  require_relative 'expectations/error'
+  require_relative 'expectations/contract'
+  require_relative 'expectations/type_checker'
+
+  MIXIN_METHODS = <<~RUBY
+    def Success(...)
+      _expected_result::Success(...)
+    end
+
+    def Failure(...)
+      _expected_result::Failure(...)
+    end
+
+    private
+
+    def _expected_result
+      @_expected_result ||= Expected.with(subject: self)
+    end
+  RUBY
+
+  def self.mixin(success: nil, failure: nil)
+    mod = Module.new
+    mod.const_set(:Expected, new(success: success, failure: failure).freeze)
+    mod.module_eval(MIXIN_METHODS)
+    mod
+  end
+
+  def self.evaluate(data, expectations)
+    expectations ||= Contract::NONE
+
+    expectations.type_and_value!(data)
+
+    TypeChecker.new(data.type, expectations: expectations)
+  end
+
+  def initialize(subject: nil, success: nil, failure: nil, contract: nil)
+    @subject = subject
+
+    @contract = contract if contract.is_a?(Contract::Evaluator)
+
+    @contract ||= Contract.new(success: success, failure: failure).freeze
+  end
+
+  def Success(type, value = nil)
+    ::BCDD::Result::Success.new(type: type, value: value, subject: subject, expectations: contract)
+  end
+
+  def Failure(type, value = nil)
+    ::BCDD::Result::Failure.new(type: type, value: value, subject: subject, expectations: contract)
+  end
+
+  def with(subject:)
+    self.class.new(subject: subject, contract: contract)
+  end
+
+  private
+
+  attr_reader :subject, :contract
+end

data/lib/bcdd/result/failure.rb

@@ -7,14 +7,18 @@ class BCDD::Result
     end
 
     def failure?(type = nil)
-      type.nil? || type == self.type
+      type.nil? || type_checker.allow_failure?([type])
     end
 
     def value_or
       yield
     end
 
-    alias data_or value_or
+    private
+
+    def name
+      :failure
+    end
   end
 
   def self.Failure(type, value = nil)

data/lib/bcdd/result/handler/allowed_types.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+class BCDD::Result
+  class Handler
+    class AllowedTypes
+      attr_reader :unchecked, :type_checker
+
+      def initialize(type_checker)
+        @type_checker = type_checker
+
+        @expectations = type_checker.expectations
+
+        @unchecked = @expectations.allowed_types.dup
+      end
+
+      def allow?(types)
+        check!(types, type_checker.allow?(types))
+      end
+
+      def allow_success?(types)
+        unchecked.subtract(@expectations.success.allowed_types) if types.empty?
+
+        check!(types, type_checker.allow_success?(types))
+      end
+
+      def allow_failure?(types)
+        unchecked.subtract(@expectations.failure.allowed_types) if types.empty?
+
+        check!(types, type_checker.allow_failure?(types))
+      end
+
+      def all_checked?
+        unchecked.empty?
+      end
+
+      private
+
+      def check!(types, checked)
+        unchecked.subtract(types) unless all_checked?
+
+        checked
+      end
+    end
+  end
+end

data/lib/bcdd/result/handler.rb

@@ -2,46 +2,55 @@
 
 class BCDD::Result
   class Handler
+    require_relative 'handler/allowed_types'
+
     UNDEFINED = ::Object.new
 
-    def initialize(result)
+    def initialize(result, type_checker:)
+      @allowed_types = AllowedTypes.new(type_checker)
+
       @outcome = UNDEFINED
 
-      @_type = result._type
       @result = result
     end
 
     def [](*types, &block)
       raise Error::MissingTypeArgument if types.empty?
 
-      self.outcome = block if _type.in?(types, allow_empty: false)
+      self.outcome = block if allowed_types.allow?(types)
+    end
+
+    def success(*types, &block)
+      self.outcome = block if allowed_types.allow_success?(types) && result.success?
     end
 
     def failure(*types, &block)
-      self.outcome = block if result.failure? && _type.in?(types, allow_empty: true)
+      self.outcome = block if allowed_types.allow_failure?(types) && result.failure?
     end
 
-    def success(*types, &block)
-      self.outcome = block if result.success? && _type.in?(types, allow_empty: true)
+    def unknown(&block)
+      self.outcome = block unless outcome?
     end
 
     alias type []
 
     private
 
-    attr_reader :_type, :result
+    attr_reader :result, :allowed_types
 
     def outcome?
       @outcome != UNDEFINED
     end
 
-    def outcome
-      @outcome if outcome?
-    end
-
     def outcome=(block)
       @outcome = block.call(result.value, result.type) unless outcome?
     end
+
+    def outcome
+      allowed_types.all_checked? or raise Error::UnhandledTypes.build(types: allowed_types.unchecked)
+
+      @outcome if outcome?
+    end
   end
 
   private_constant :Handler

data/lib/bcdd/result/mixin.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class BCDD::Result
+  module Mixin
+    def Success(type, value = nil)
+      Success.new(type: type, value: value, subject: self)
+    end
+
+    def Failure(type, value = nil)
+      Failure.new(type: type, value: value, subject: self)
+    end
+  end
+end

data/lib/bcdd/result/success.rb

@@ -3,7 +3,7 @@
 class BCDD::Result
   class Success < self
     def success?(type = nil)
-      type.nil? || type == self.type
+      type.nil? || type_checker.allow_success?([type])
     end
 
     def failure?(_type = nil)
@@ -14,7 +14,11 @@ class BCDD::Result
       value
     end
 
-    alias data_or value_or
+    private
+
+    def name
+      :success
+    end
   end
 
   def self.Success(type, value = nil)

data/lib/bcdd/result/version.rb

@@ -2,6 +2,6 @@
 
 module BCDD
   class Result
-    VERSION = '0.3.0'
+    VERSION = '0.5.0'
   end
 end