Module: ActionView::Helpers::DebugHelper

Includes:
TagHelper
Included in:
ActionView::Helpers
Defined in:
lib/action_view/helpers/debug_helper.rb

Overview

Action View Debug Helpers

Provides a set of methods for making it easier to debug Rails objects.

Constant Summary

Constants included from TagHelper

TagHelper::ARIA_PREFIXES, TagHelper::BOOLEAN_ATTRIBUTES, TagHelper::DATA_PREFIXES, TagHelper::PRE_CONTENT_STRINGS, TagHelper::TAG_TYPES

Instance Method Summary collapse

Methods included from TagHelper

build_tag_values, #cdata_section, #content_tag, ensure_valid_html5_tag_name, #escape_once, #tag, #token_list

Methods included from OutputSafetyHelper

#raw, #safe_join, #to_sentence

Methods included from CaptureHelper

#capture, #content_for, #content_for?, #provide, #with_output_buffer

Instance Method Details

#debug(object) ⇒ Object

Returns a YAML representation of object wrapped with <pre> and </pre>. If the object cannot be converted to YAML using to_yaml, inspect will be called instead. Useful for inspecting an object at the time of rendering.

@user = User.new({ username: 'testing', password: 'xyz', age: 42})
debug(@user)
# =>
<pre class='debug_dump'>--- !ruby/object:User
attributes:
  updated_at:
  username: testing
  age: 42
  password: xyz
  created_at:
</pre>



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

def debug(object)
  Marshal.dump(object)
  object = ERB::Util.html_escape(object.to_yaml)
  content_tag(:pre, object, class: "debug_dump")
rescue # errors from Marshal or YAML
  # Object couldn't be dumped, perhaps because of singleton methods -- this is the fallback
  content_tag(:code, object.inspect, class: "debug_dump")
end