aboutsummaryrefslogtreecommitdiffstats
path: root/actionview/lib/action_view/helpers/debug_helper.rb
diff options
context:
space:
mode:
authorPiotr Sarnacki <drogus@gmail.com>2013-06-20 15:42:49 -0700
committerPiotr Sarnacki <drogus@gmail.com>2013-06-20 15:42:49 -0700
commita29f746398e7b0647885343e7f26d977dd251999 (patch)
tree1e2cd2ee1f8f31812c0acf71350ffe423ca8c5a9 /actionview/lib/action_view/helpers/debug_helper.rb
parent7c69a829a311a31109939cff19b700b36b97d5c4 (diff)
parentd6b1caa8f2011487c08b414605883f1f220d0aaa (diff)
downloadrails-a29f746398e7b0647885343e7f26d977dd251999.tar.gz
rails-a29f746398e7b0647885343e7f26d977dd251999.tar.bz2
rails-a29f746398e7b0647885343e7f26d977dd251999.zip
Merge pull request #11032 from strzalek/extract-actionview
Extract ActionView to separate directory
Diffstat (limited to 'actionview/lib/action_view/helpers/debug_helper.rb')
-rw-r--r--actionview/lib/action_view/helpers/debug_helper.rb39
1 files changed, 39 insertions, 0 deletions
diff --git a/actionview/lib/action_view/helpers/debug_helper.rb b/actionview/lib/action_view/helpers/debug_helper.rb
new file mode 100644
index 0000000000..c29c1b1eea
--- /dev/null
+++ b/actionview/lib/action_view/helpers/debug_helper.rb
@@ -0,0 +1,39 @@
+module ActionView
+ # = Action View Debug Helper
+ #
+ # Provides a set of methods for making it easier to debug Rails objects.
+ module Helpers
+ module DebugHelper
+
+ include TagHelper
+
+ # 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>
+ def debug(object)
+ Marshal::dump(object)
+ object = ERB::Util.html_escape(object.to_yaml).gsub(" ", "&nbsp; ").html_safe
+ 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
+ end
+ end
+end