awesome_print 0.2.0 → 0.2.1

data/CHANGELOG

@@ -1,3 +1,7 @@
+0.2.1
+  - ap can now be used within Rails templates (ex. <%= ap object %>)
+  - Added support for printing Struct
+
 0.2.0
   - Added support for logger.ap (including Rails logger)
   - Added support for HashWithIndifferentAccess from ActiveSupport

data/README.md

@@ -1,7 +1,7 @@
 ## Awesome Print ##
 Awesome Print is Ruby library that pretty prints Ruby objects in full color
 exposing their internal structure with proper indentation. Rails ActiveRecord
-objects are supported via included mixin.
+objects and usage within Rails templates are supported via included mixins.
 
 ### Installation ###
     # Installing as Ruby gem
@@ -170,6 +170,12 @@ in the custom defaults (see below), or you can override on a per call basis with
 
     logger.ap object, :warn
 
+### ActionView Convenience Method ###
+awesome_print adds an ap method to the ActionView::Base class making it available
+within Rails templates. For example:
+
+    <%= ap @accounts.first %>
+
 ### Setting Custom Defaults ###
 You can set your own default options by creating ``.aprc`` file in your home
 directory. Within that file assign your  defaults to ``AwesomePrint.defaults``.

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/lib/ap.rb

@@ -9,6 +9,7 @@ require File.dirname(__FILE__) + "/ap/awesome_print"
 
 require File.dirname(__FILE__) + "/ap/core_ext/logger" if defined?(::Logger) or defined?(::ActiveSupport::BufferedLogger)
 
+require File.dirname(__FILE__) + "/ap/mixin/action_view" if defined?(::ActionView)
 require File.dirname(__FILE__) + "/ap/mixin/active_record" if defined?(::ActiveRecord)
 require File.dirname(__FILE__) + "/ap/mixin/active_support" if defined?(::ActiveSupport)
 

data/lib/ap/awesome_print.rb

@@ -7,7 +7,7 @@ require "shellwords"
 
 class AwesomePrint
   AP = :__awesome_print__
-  CORE = [ :array, :hash, :class, :file, :dir, :bigdecimal, :rational ]
+  CORE = [ :array, :hash, :class, :file, :dir, :bigdecimal, :rational, :struct ]
 
   def initialize(options = {})
     @options = { 
@@ -23,6 +23,7 @@ class AwesomePrint
         :fixnum     => :blue,
         :float      => :blue,
         :hash       => :pale,
+        :struct     => :pale,
         :nilclass   => :red,
         :string     => :yellowish,
         :symbol     => :cyanish,
@@ -92,6 +93,14 @@ class AwesomePrint
     end
   end
 
+  # Format a Struct. If @options[:indent] if negative left align hash keys.
+  #------------------------------------------------------------------------------
+  def awesome_struct(s)
+    h = {}
+    s.each_pair { |k,v| h[k] = v }
+    awesome_hash(h)
+  end
+
   # Format Class object.
   #------------------------------------------------------------------------------
   def awesome_class(c)
@@ -152,8 +161,9 @@ class AwesomePrint
   #------------------------------------------------------------------------------
   def nested(object)
     case printable(object)
-      when :array then colorize("[...]", :array)
-      when :hash  then colorize("{...}", :hash)
+      when :array  then colorize("[...]", :array)
+      when :hash   then colorize("{...}", :hash)
+      when :struct then colorize("{...}", :struct)
       else colorize("...#{object.class}...", :class)
     end
   end
@@ -167,7 +177,11 @@ class AwesomePrint
   # Turn class name into symbol, ex: Hello::World => :hello_world.
   #------------------------------------------------------------------------------
   def declassify(object)
-    object.class.to_s.gsub(/:+/, "_").downcase.to_sym
+    if object.is_a?(Struct)
+      :struct
+    else
+      object.class.to_s.gsub(/:+/, "_").downcase.to_sym
+    end
   end
 
   # Pick the color and apply it to the given string as necessary.

data/lib/ap/core_ext/string.rb

@@ -5,6 +5,12 @@
 #------------------------------------------------------------------------------
 class String
 
+  # ANSI color codes:
+  # \033 => escape
+  #   30 => color base
+  #    1 => bright
+  #    0 => normal
+
   [ :gray, :red, :green, :yellow, :blue, :purple, :cyan, :white ].each_with_index do |color, i|
     if STDOUT.tty? && ENV['TERM'] && ENV['TERM'] != 'dumb'
       define_method color          do "\033[1;#{30+i}m#{self}\033[0m" end

data/lib/ap/mixin/action_view.rb

@@ -0,0 +1,38 @@
+# Copyright (c) 2010 Michael Dvorkin
+#
+# Awesome Print is freely distributable under the terms of MIT license.
+# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+module AwesomePrintActionView
+
+  def self.included(base)
+    unless base.const_defined?(:AP_ANSI_TO_HTML)
+      hash = {} # Build ANSI => HTML color map.
+      [ :gray, :red, :green, :yellow, :blue, :purple, :cyan, :white ].each_with_index do |color, i|
+        hash["\033[1;#{30+i}m"] = color
+      end
+      [ :black, :darkred, :darkgreen, :brown, :navy, :darkmagenta, :darkcyan, :slategray ].each_with_index do |color, i|
+        hash["\033[0;#{30+i}m"] = color
+      end
+      base.const_set(:AP_ANSI_TO_HTML, hash.freeze)
+    end
+  end
+
+  def ap_debug(object, options = {})
+    formatted = h(object.ai(options))
+
+    unless options[:plain]
+      self.class::AP_ANSI_TO_HTML.each do |key, value|
+        formatted.gsub!(key, %Q|<font color="#{value}">|)
+      end
+      formatted.gsub!("\033[0m", "</font>")
+    end
+
+    content_tag(:pre, formatted, :class => "debug_dump")
+  end
+
+  alias_method :ap, :ap_debug
+
+end
+
+ActionView::Base.send(:include, AwesomePrintActionView) if defined?(::ActionView)

data/spec/action_view_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'action_view'
+require 'ap/mixin/action_view'
+
+describe "AwesomePrint ActionView extensions" do
+  before(:each) do
+    @view = ActionView::Base.new
+  end
+    
+  it "should wrap ap output with <pre> tag" do
+    obj = 42
+    @view.ap(obj, :plain => true).should == '<pre class="debug_dump">42</pre>'
+  end
+
+  it "should encode HTML entities" do
+    obj = "  &<hello>"
+    @view.ap(obj, :plain => true).should == '<pre class="debug_dump">&quot;  &amp;&lt;hello&gt;&quot;</pre>'
+  end
+
+  it "should convert primary ANSI colors to HTML" do
+    obj = 42
+    [ :gray, :red, :green, :yellow, :blue, :purple, :cyan, :white ].each do |color|
+      @view.ap(obj, :color => { :fixnum => color }).should == %Q|<pre class="debug_dump"><font color="#{color}">42</font></pre>|
+    end
+  end
+
+  it "should convert mixed ANSI colors to HTML" do
+    obj = 42
+    [ :grayish, :redish, :greenish, :yellowish, :blueish, :purpleish, :cyanish, :whiteish, :black, :pale ].zip(
+    [ :black, :darkred, :darkgreen, :brown, :navy, :darkmagenta, :darkcyan, :slategray, :black, :slategray ]) do |ansi, html|
+      @view.ap(obj, :color => { :fixnum => ansi }).should == %Q|<pre class="debug_dump"><font color="#{html}">42</font></pre>|
+    end
+  end
+end

data/spec/awesome_print_spec.rb

@@ -164,11 +164,11 @@ EOS
     it "colored multiline (default)" do
       @hash.ai.should == <<-EOS.strip
 {
-    1\e[1;30m => \e[0m{
-        :sym\e[1;30m => \e[0m{
-            \"str\"\e[1;30m => \e[0m{
-                [ 1, 2, 3 ]\e[1;30m => \e[0m{
-                    { :k => :v }\e[1;30m => \e[0m\e[1;33mHash < Object\e[0m
+    1\e[0;37m => \e[0m{
+        :sym\e[0;37m => \e[0m{
+            \"str\"\e[0;37m => \e[0m{
+                [ 1, 2, 3 ]\e[0;37m => \e[0m{
+                    { :k => :v }\e[0;37m => \e[0m\e[1;33mHash < Object\e[0m
                 }
             }
         }
@@ -180,11 +180,11 @@ EOS
     it "colored multiline indented" do
       @hash.ai(:indent => 2).should == <<-EOS.strip
 {
-  1\e[1;30m => \e[0m{
-    :sym\e[1;30m => \e[0m{
-      \"str\"\e[1;30m => \e[0m{
-        [ 1, 2, 3 ]\e[1;30m => \e[0m{
-          { :k => :v }\e[1;30m => \e[0m\e[1;33mHash < Object\e[0m
+  1\e[0;37m => \e[0m{
+    :sym\e[0;37m => \e[0m{
+      \"str\"\e[0;37m => \e[0m{
+        [ 1, 2, 3 ]\e[0;37m => \e[0m{
+          { :k => :v }\e[0;37m => \e[0m\e[1;33mHash < Object\e[0m
         }
       }
     }
@@ -194,7 +194,7 @@ EOS
     end
 
     it "colored single line" do
-      @hash.ai(:multiline => false).should == "{ 1\e[1;30m => \e[0m{ :sym\e[1;30m => \e[0m{ \"str\"\e[1;30m => \e[0m{ [ 1, 2, 3 ]\e[1;30m => \e[0m{ { :k => :v }\e[1;30m => \e[0m\e[1;33mHash < Object\e[0m } } } } }"
+      @hash.ai(:multiline => false).should == "{ 1\e[0;37m => \e[0m{ :sym\e[0;37m => \e[0m{ \"str\"\e[0;37m => \e[0m{ [ 1, 2, 3 ]\e[0;37m => \e[0m{ { :k => :v }\e[0;37m => \e[0m\e[1;33mHash < Object\e[0m } } } } }"
     end
 
   end
@@ -288,4 +288,77 @@ EOS
     end
   end
 
+
+  #------------------------------------------------------------------------------
+  describe "Struct" do
+    before(:each) do
+      @struct = unless defined?(Struct::SimpleStruct)
+        Struct.new("SimpleStruct", :name, :address).new
+      else
+        Struct::SimpleStruct.new
+      end
+      @struct.name = "Herman Munster"
+      @struct.address = "1313 Mockingbird Lane"
+    end
+    
+    it "empty struct" do
+      Struct.new("EmptyStruct").ai.should ==  "\e[1;33mStruct::EmptyStruct < Struct\e[0m"
+    end
+    
+    it "plain multiline" do
+      s1 = <<-EOS.strip
+{
+    :address => "1313 Mockingbird Lane",
+       :name => "Herman Munster"
+}
+EOS
+      s2 = <<-EOS.strip
+{
+       :name => "Herman Munster",
+    :address => "1313 Mockingbird Lane"
+}
+EOS
+      @struct.ai(:plain => true).should satisfy { |match| match == s1 || match == s2 }
+    end
+
+    it "plain multiline indented" do
+      s1 = <<-EOS.strip
+{
+ :address => "1313 Mockingbird Lane",
+    :name => "Herman Munster"
+}
+EOS
+      s2 = <<-EOS.strip
+{
+    :name => "Herman Munster",
+ :address => "1313 Mockingbird Lane"
+}
+EOS
+      @struct.ai(:plain => true, :indent => 1).should satisfy { |match| match == s1 || match == s2 }
+    end
+
+    it "plain single line" do
+      s1 = "{ :address => \"1313 Mockingbird Lane\", :name => \"Herman Munster\" }"
+      s2 = "{ :name => \"Herman Munster\", :address => \"1313 Mockingbird Lane\" }"
+      @struct.ai(:plain => true, :multiline => false).should satisfy { |match| match == s1 || match == s2 }
+    end
+
+    it "colored multiline (default)" do
+      s1 = <<-EOS.strip
+{
+    :address\e[0;37m => \e[0m\e[0;33m\"1313 Mockingbird Lane\"\e[0m,
+       :name\e[0;37m => \e[0m\e[0;33m\"Herman Munster\"\e[0m
+}
+EOS
+      s2 = <<-EOS.strip
+{
+       :name\e[0;37m => \e[0m\e[0;33m\"Herman Munster\"\e[0m,
+    :address\e[0;37m => \e[0m\e[0;33m\"1313 Mockingbird Lane\"\e[0m
+}
+EOS
+      @struct.ai.should satisfy { |match| match == s1 || match == s2 }
+    end
+  end
+
+
 end

data/spec/string_spec.rb

@@ -14,5 +14,7 @@ describe "String extensions" do
   it "should have black and pale colors" do
     "black".send(:black).should == "black".send(:grayish)
     "pale".send(:pale).should  == "pale".send(:whiteish)
+    "pale".send(:pale).should == "\e[0;37mpale\e[0m"
+    "whiteish".send(:whiteish).should == "\e[0;37mwhiteish\e[0m"
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Michael Dvorkin
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-05 00:00:00 -07:00
+date: 2010-06-03 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,9 +52,11 @@ files:
 - lib/ap/core_ext/kernel.rb
 - lib/ap/core_ext/logger.rb
 - lib/ap/core_ext/string.rb
+- lib/ap/mixin/action_view.rb
 - lib/ap/mixin/active_record.rb
 - lib/ap/mixin/active_support.rb
 - rails/init.rb
+- spec/action_view_spec.rb
 - spec/active_record_spec.rb
 - spec/awesome_print_spec.rb
 - spec/logger_spec.rb
@@ -92,6 +94,7 @@ signing_key:
 specification_version: 3
 summary: Pretty print Ruby objects with proper indentation and colors.
 test_files: 
+- spec/action_view_spec.rb
 - spec/active_record_spec.rb
 - spec/awesome_print_spec.rb
 - spec/logger_spec.rb