ParentSquare/faulty

# frozen_string_literal: true

class Faulty
  # The base error for all Faulty errors
  class FaultyError < StandardError; end

  # Raised if using the global Faulty object without initializing it
  class UninitializedError < FaultyError
    def initialize(message = nil)
      message ||= 'Faulty is not initialized'
      super(message)
    end
  end

  # Raised if {Faulty.init} is called multiple times
  class AlreadyInitializedError < FaultyError
    def initialize(message = nil)
      message ||= 'Faulty is already initialized'
      super(message)
    end
  end

  # Raised if getting the default instance without initializing one
  class MissingDefaultInstanceError < FaultyError
    def initialize(message = nil)
      message ||= 'No default instance. Create one with init or get your instance with Faulty[:name]'
      super(message)
    end
  end

  class DeprecationError < FaultyError
  end

  # Included in faulty circuit errors to provide common features for
  # native and patched errors
  module CircuitErrorBase
    attr_reader :circuit

    # @param message [String]
    # @param circuit [Circuit] The circuit that raised the error
    def initialize(message, circuit)
      full_message = %(circuit error for "#{circuit.name}")
      full_message = %(#{full_message}: #{message}) if message

      @circuit = circuit
      super(full_message)
    end
  end

  # The base error for all errors raised during circuit runs
  #
  class CircuitError < FaultyError
    include CircuitErrorBase
  end

  # Raised when running a circuit that is already open
  class OpenCircuitError < CircuitError; end

  # Raised when an error occurred while running a circuit
  #
  # The `cause` will always be set and will be the internal error
  #
  # @see CircuitTrippedError For when the circuit is tripped
  class CircuitFailureError < CircuitError; end

  # Raised when an error occurred causing a circuit to close
  #
  # The `cause` will always be set and will be the internal error
  class CircuitTrippedError < CircuitError; end

  # Raised if calling get or error on a result without checking it
  class UncheckedResultError < FaultyError; end

  # An error that wraps multiple other errors
  class FaultyMultiError < FaultyError
    def initialize(message, errors)
      message = "#{message}: #{errors.map(&:message).join(', ')}"
      super(message)
    end
  end

  # Raised if getting the wrong result type.
  #
  # For example, calling get on an error result will raise this
  class WrongResultError < FaultyError; end

  # Raised if a FallbackChain partially fails
  class PartialFailureError < FaultyMultiError; end

  # Raised if all FallbackChain backends fail
  class AllFailedError < FaultyMultiError; end
end