Module: ExceptionNotifierHelper

Defined in:
lib/exception_notifier_helper.rb

Overview

Copyright © 2005 Jamis Buck

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Constant Summary collapse

VIEW_PATH = 
"views/exception_notifier"
APP_PATH = 
"#{RAILS_ROOT}/app/#{VIEW_PATH}"
PARAM_FILTER_REPLACEMENT = 
"[FILTERED]"

Instance Method Summary collapse

Instance Method Details

#exclude_raw_post_parameters? ⇒ Boolean

Returns:

  • (Boolean) 


65
66
67
 
# File 'lib/exception_notifier_helper.rb', line 65

def exclude_raw_post_parameters?
  @controller && @controller.respond_to?(:filter_parameters)
end

#filter_sensitive_post_data_from_env(env_key, env_value) ⇒ Object 



73
74
75
76
77
 
# File 'lib/exception_notifier_helper.rb', line 73

def filter_sensitive_post_data_from_env(env_key, env_value)
  return env_value unless exclude_raw_post_parameters?
  return PARAM_FILTER_REPLACEMENT if (env_key =~ /RAW_POST_DATA/i)
  return @controller.send!(:filter_parameters, {env_key => env_value}).values[0]
end

#filter_sensitive_post_data_parameters(parameters) ⇒ Object 



69
70
71
 
# File 'lib/exception_notifier_helper.rb', line 69

def filter_sensitive_post_data_parameters(parameters)
  exclude_raw_post_parameters? ? @controller.send!(:filter_parameters, parameters) : parameters
end

#inspect_model_object(model, locals = {}) ⇒ Object 



47
48
49
50
51
52
 
# File 'lib/exception_notifier_helper.rb', line 47

def inspect_model_object(model, locals={})
  render_overridable(:inspect_model,
    :locals => { :inspect_model => model,
                 :show_instance_variables => true,
                 :show_attributes => true }.merge(locals))
end

#inspect_value(value) ⇒ Object 



54
55
56
57
58
59
 
# File 'lib/exception_notifier_helper.rb', line 54

def inspect_value(value)
  len = 512
  result = object_to_yaml(value).gsub(/\n/, "\n  ").strip
  result = result[0,len] + "... (#{result.length-len} bytes more)" if result.length > len+20
  result
end

#object_to_yaml(object) ⇒ Object 



61
62
63
 
# File 'lib/exception_notifier_helper.rb', line 61

def object_to_yaml(object)
  object.to_yaml.sub(/^---\s*/m, "")
end

#render_overridable(partial, options = {}) ⇒ Object 



37
38
39
40
41
42
43
44
45
 
# File 'lib/exception_notifier_helper.rb', line 37

def render_overridable(partial, options={})
  if File.exist?(path = "#{APP_PATH}/_#{partial}.rhtml")
    render(options.merge(:file => path, :use_full_path => false))
  elsif File.exist?(path = "#{File.dirname(__FILE__)}/../#{VIEW_PATH}/_#{partial}.rhtml")
    render(options.merge(:file => path, :use_full_path => false))
  else
    ""
  end
end

#render_section(section) ⇒ Object 



28
29
30
31
32
33
34
35
 
# File 'lib/exception_notifier_helper.rb', line 28

def render_section(section)
  RAILS_DEFAULT_LOGGER.info("rendering section #{section.inspect}")
  summary = render_overridable(section).strip
  unless summary.blank?
    title = render_overridable(:title, :locals => { :title => section }).strip
    "#{title}\n\n#{summary.gsub(/^/, "  ")}\n\n"
  end
end