Module: ActionView::Helpers::DebugHelper

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In: ::ActionView::Base, ::ActionView::Helpers, ::ActionView::TestCase, ::ActionView::TestCase::Behavior
Super Chains via Extension / Inclusion / Inheritance
Instance Chain: self, TagHelper, CaptureHelper
Defined in:	actionview/lib/action_view/helpers/debug_helper.rb

Constant Summary

TagHelper - Included

BOOLEAN_ATTRIBUTES, PRE_CONTENT_STRINGS, TAG_PREFIXES

Instance Method Summary

#debug(object)

Returns a YAML representation of object wrapped with <pre> and </pre>.

TagHelper - Included

#cdata_section	Returns a CDATA section with the given `content`.
#content_tag	Returns an HTML block tag of type `name` surrounding the `content`.
#escape_once	Returns an escaped version of `html` without affecting existing escaped entities.
#tag	Returns an empty HTML tag of type `name` which by default is XHTML compliant.

CaptureHelper - Included

#capture	The capture method allows you to extract part of a template into a variable.
#content_for	Calling content_for stores a block of markup in an identifier for later use.
#content_for?	content_for? checks whether any content has been captured yet using `content_for`.
#provide	The same as `content_for` but when used with streaming flushes straight back to the layout.

Instance Method Details

#debug(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>

[ GitHub ]

# File 'actionview/lib/action_view/helpers/debug_helper.rb', line 25


def debug(object)
  Marshal::dump(object)
  object = ERB::Util.html_escape(object.to_yaml)
  content_tag(:pre, object, :class => "debug_dump")
rescue Exception  # 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