mhenrixon/stub_requests

# frozen_string_literal: true

#
# Abstraction over WebMock to reduce duplication
#
# @author Mikael Henriksson <mikael@zoolutions.se>
# @since 0.1.0
#
module StubRequests
  #
  # Error is a base class for all gem errors
  #
  class Error < StandardError; end

  #
  # EndpointNotFound is raised when an endpoint cannot be found
  #
  class EndpointNotFound < Error
    attr_reader :id

    def initialize(id:, suggestions: [])
      @id           = id
      @suggestions  = Array(suggestions).compact
      error_message = [base_message, suggestions_message].join(".")
      super(error_message)
    end

    def base_message
      @base_message ||= "Couldn't find an endpoint with id=:#{id}"
    end

    def suggestions_message
      return if suggestions.none?

      @suggestions_message ||= " Did you mean one of the following? (#{suggestions_string})"
    end

    def suggestions
      @suggestions.map { |sym| ":#{sym}" }
    end

    def suggestions_string
      suggestions.join(", ")
    end
  end

  #
  # Class InvalidCallback is raised when a callback argument doesn't have the correct number of arguments
  #
  class InvalidCallback < Error; end

  #
  # InvalidArgumentType is raised when an argument is not of the expected type
  #
  class InvalidArgumentType < Error
    #
    # @param [Symbol] name the name of the argument
    # @param [Object] actual the actual value of the argument
    # @param [Array<Class>, Array<Module>] expected the types the argument is expected to be
    #
    def initialize(name:, actual:, expected:)
      super("The argument `:#{name}` was `#{actual}`, expected any of [#{expected.join(', ')}]")
    end
  end

  #
  # InvalidUri is raised when a URI is invalid
  #
  class InvalidUri < Error
    def initialize(uri)
      super("'#{uri}' is not a valid URI.")
    end
  end

  #
  # PropertyDefined is raised when trying to add the same property twice
  #
  class PropertyDefined < Error
    def initialize(name:, type:, default:)
      default = "nil" if default.is_a?(NilClass)
      super("Property ##{name} was already defined as `{ type: #{type}, default: #{default} }")
    end
  end

  #
  # ServiceNotFound is raised when a service cannot be found
  #
  class ServiceNotFound < Error
    def initialize(service_id)
      super("Couldn't find a service with id=:#{service_id}")
    end
  end

  #
  # UriSegmentMismatch is raised when a segment cannot be replaced
  #
  class UriSegmentMismatch < Error
    attr_reader :uri, :expected_keys, :received_keys
    def initialize(uri:, expected_keys:, received_keys:)
      @uri           = uri
      @expected_keys = expected_keys
      @received_keys = received_keys

      super(message_parts.join("\n  "))
    end

    private

    def message_parts
      [].tap do |arr|
        arr << default_part
        arr << expected_keys_part
        arr << received_keys_part
        arr << missing_keys_part if missing_keys.any?
        arr << invalid_keys_part if invalid_keys.any?
      end
    end

    def default_part
      "The URI (#{uri}) received unexpected route parameters"
    end

    def expected_keys_part
      "Expected: [#{expected_keys.join(',')}]"
    end

    def received_keys_part
      "Received: [#{received_keys.join(',')}]"
    end

    def missing_keys_part
      "Missing: [#{missing_keys.join(',')}]"
    end

    def invalid_keys_part
      "Invalid: [#{invalid_keys.join(',')}]"
    end

    def missing_keys
      @missing_keys ||= expected_keys - received_keys
    end

    def invalid_keys
      @invalid_keys ||= received_keys - expected_keys
    end
  end
end