2004-11-23 20:04:44 -05:00
|
|
|
module ActionView
|
2010-06-16 14:17:49 -04:00
|
|
|
# = Action View Debug Helper
|
2010-08-14 01:13:00 -04:00
|
|
|
#
|
2010-06-16 14:17:49 -04:00
|
|
|
# Provides a set of methods for making it easier to debug Rails objects.
|
2004-11-23 20:04:44 -05:00
|
|
|
module Helpers
|
|
|
|
module DebugHelper
|
2008-07-16 08:00:36 -04:00
|
|
|
# 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.
|
2007-05-06 01:19:02 -04:00
|
|
|
#
|
|
|
|
# ==== Example
|
|
|
|
#
|
2008-07-16 08:00:36 -04:00
|
|
|
# @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:
|
|
|
|
# attributes_cache: {}
|
|
|
|
#
|
|
|
|
# new_record: true
|
|
|
|
# </pre>
|
|
|
|
|
2004-11-23 20:04:44 -05:00
|
|
|
def debug(object)
|
|
|
|
begin
|
|
|
|
Marshal::dump(object)
|
For performance reasons, you can no longer call html_safe! on Strings. Instead, all Strings are always not html_safe?. Instead, you can get a SafeBuffer from a String by calling #html_safe, which will SafeBuffer.new(self).
* Additionally, instead of doing concat("</form>".html_safe), you can do
safe_concat("</form>"), which will skip both the flag set, and the flag
check.
* For the first pass, I converted virtually all #html_safe!s to #html_safe,
and the tests pass. A further optimization would be to try to use
#safe_concat as much as possible, reducing the performance impact if
we know up front that a String is safe.
2010-01-31 22:17:42 -05:00
|
|
|
"<pre class='debug_dump'>#{h(object.to_yaml).gsub(" ", " ")}</pre>".html_safe
|
2011-06-07 20:39:55 -04:00
|
|
|
rescue Exception # errors from Marshal or YAML
|
2004-11-23 20:04:44 -05:00
|
|
|
# Object couldn't be dumped, perhaps because of singleton methods -- this is the fallback
|
For performance reasons, you can no longer call html_safe! on Strings. Instead, all Strings are always not html_safe?. Instead, you can get a SafeBuffer from a String by calling #html_safe, which will SafeBuffer.new(self).
* Additionally, instead of doing concat("</form>".html_safe), you can do
safe_concat("</form>"), which will skip both the flag set, and the flag
check.
* For the first pass, I converted virtually all #html_safe!s to #html_safe,
and the tests pass. A further optimization would be to try to use
#safe_concat as much as possible, reducing the performance impact if
we know up front that a String is safe.
2010-01-31 22:17:42 -05:00
|
|
|
"<code class='debug_dump'>#{h(object.inspect)}</code>".html_safe
|
2004-11-23 20:04:44 -05:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
2008-07-16 08:00:36 -04:00
|
|
|
end
|