Module: Gaffe

Defined in:
lib/gaffe.rb,
lib/gaffe/errors.rb,
lib/gaffe/version.rb,
lib/gaffe/errors_controller.rb

Defined Under Namespace

Modules: Errors Classes: ErrorsController

Constant Summary collapse

VERSION =
'0.1.2'

Class Method Summary collapse

Class Method Details

.builtin_errors_controllerObject

Return our default controller



21
22
23
24
# File 'lib/gaffe.rb', line 21

def self.builtin_errors_controller
  require 'gaffe/errors_controller'
  Gaffe::ErrorsController
end

.configurationObject

Return the configuration settings



11
12
13
# File 'lib/gaffe.rb', line 11

def self.configuration
  @configuration ||= OpenStruct.new
end

.configure {|configuration| ... } ⇒ Object

Yield a block to populate @configuration

Yields:



6
7
8
# File 'lib/gaffe.rb', line 6

def self.configure
  yield configuration
end

.enable!Object

Configure Rails to use our code when encountering exceptions



27
28
29
30
31
# File 'lib/gaffe.rb', line 27

def self.enable!
  Rails.application.config.exceptions_app = lambda do |env|
    Gaffe.errors_controller.action(:show).call(env)
  end
end

.errors_controllerObject

Return either the user-defined controller or our default controller



16
17
18
# File 'lib/gaffe.rb', line 16

def self.errors_controller
  @errors_controller ||= (configuration.errors_controller || builtin_errors_controller)
end

.rootObject

Return the root path of the gem



34
35
36
# File 'lib/gaffe.rb', line 34

def self.root
  File.expand_path('../../', __FILE__)
end