Module: ActionView::Helpers::DebugHelper

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

Constant Summary

Constant Summary

Constants included from TagHelper

TagHelper::BOOLEAN_ATTRIBUTES, TagHelper::PRE_CONTENT_STRINGS

Instance Method Summary (collapse)

Methods included from TagHelper

#cdata_section, #content_tag, #escape_once, #tag

Methods included from ActiveSupport::Concern

#append_features, #class_methods, extended, #included

Methods included from CaptureHelper

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

Instance Method Details

- (Object) 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:
&nbsp; updated_at:
&nbsp; username: testing

&nbsp; age: 42
&nbsp; password: xyz
&nbsp; created_at:
attributes_cache: {}

new_record: true
</pre>


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

def debug(object)
  Marshal::dump(object)
  object = ERB::Util.html_escape(object.to_yaml).gsub("  ", "&nbsp; ").html_safe
  (: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
  (:code, object.inspect, :class => "debug_dump")
end