jacoblockard99/middlegem

View on GitHub
lib/middlegem.rb

Summary

Maintainability
A
0 mins
Test Coverage
# frozen_string_literal: true

require_relative 'middlegem/version'
require_relative 'middlegem/middleware'
require_relative 'middlegem/definition'
require_relative 'middlegem/stack'
require_relative 'middlegem/array_definition'

# {Middlegem} is a namespace that contains all modules in the +middlegem+ gem.
#
# @author Jacob Lockard
# @since 0.1.0
module Middlegem
  # {Error} is a subclass of {https://ruby-doc.org/core-2.5.0/StandardError.html StandardError}
  # from which all custom errors in +middlegem+ are derived. One potential use for this class is
  # to rescue all custom errors produced by +middlegem+. For example:
  #
  #   begin
  #     # Do something risky with middlegem here...
  #   rescue Middlegem::Error
  #     # Catch any middlegem-specific error here...
  #   end
  #
  # @see https://ruby-doc.org/core-2.0.0/Exception.html
  class Error < StandardError; end
end

require_relative 'middlegem/invalid_middleware_error'
require_relative 'middlegem/unpermitted_middleware_error'
require_relative 'middlegem/invalid_definition_error'
require_relative 'middlegem/invalid_middleware_output_error'