ryansch-awesome_print 1.0.2.1

data/lib/awesome_print/inspector.rb

@@ -0,0 +1,140 @@
+# Copyright (c) 2010-2011 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 AwesomePrint
+
+  class << self # Class accessors for custom defaults.
+    attr_accessor :defaults, :force_colors
+
+    # Class accessor to force colorized output (ex. forked subprocess where TERM
+    # might be dumb).
+    #------------------------------------------------------------------------------
+    def force_colors!(value = true)
+      @force_colors = value
+    end
+  end
+
+  class Inspector
+    attr_accessor :options
+
+    AP = :__awesome_print__
+
+    def initialize(options = {})
+      @options = { 
+        :indent     => 4,      # Indent using 4 spaces.
+        :index      => true,   # Display array indices.
+        :html       => false,  # Use ANSI color codes rather than HTML.
+        :multiline  => true,   # Display in multiple lines.
+        :plain      => false,  # Use colors.
+        :sort_keys  => false,  # Do not sort hash keys.
+        :limit      => false,  # Limit large output for arrays and hashes. Set to a boolean or integer.
+        :color => { 
+          :args       => :pale,
+          :array      => :white,
+          :bigdecimal => :blue,
+          :class      => :yellow,
+          :date       => :greenish,
+          :falseclass => :red,
+          :fixnum     => :blue,
+          :float      => :blue,
+          :hash       => :pale,
+          :keyword    => :cyan,
+          :method     => :purpleish,
+          :nilclass   => :red,
+          :string     => :yellowish,
+          :struct     => :pale,
+          :symbol     => :cyanish,
+          :time       => :greenish,
+          :trueclass  => :green,
+          :variable   => :cyanish
+        }
+      }
+
+      # Merge custom defaults and let explicit options parameter override them.
+      merge_custom_defaults!
+      merge_options!(options)
+
+      @formatter = AwesomePrint::Formatter.new(self)
+      Thread.current[AP] ||= []
+    end
+  
+    # Dispatcher that detects data nesting and invokes object-aware formatter.
+    #------------------------------------------------------------------------------
+    def awesome(object)
+      if Thread.current[AP].include?(object.object_id)
+        nested(object)
+      else
+        begin
+          Thread.current[AP] << object.object_id
+          unnested(object)
+        ensure
+          Thread.current[AP].pop
+        end
+      end
+    end
+
+    # Return true if we are to colorize the output.
+    #------------------------------------------------------------------------------
+    def colorize?
+      AwesomePrint.force_colors ||= false
+      AwesomePrint.force_colors || (STDOUT.tty? && ((ENV['TERM'] && ENV['TERM'] != 'dumb') || ENV['ANSICON']))
+    end
+
+    private
+
+    # Format nested data, for example:
+    #   arr = [1, 2]; arr << arr
+    #   => [1,2, [...]]
+    #   hash = { :a => 1 }; hash[:b] = hash
+    #   => { :a => 1, :b => {...} }
+    #------------------------------------------------------------------------------
+    def nested(object)
+      case printable(object)
+        when :array  then @formatter.colorize("[...]", :array)
+        when :hash   then @formatter.colorize("{...}", :hash)
+        when :struct then @formatter.colorize("{...}", :struct)
+        else @formatter.colorize("...#{object.class}...", :class)
+      end
+    end
+
+    #------------------------------------------------------------------------------
+    def unnested(object)
+      @formatter.format(object, printable(object))
+    end
+
+    # Turn class name into symbol, ex: Hello::World => :hello_world. Classes that
+    # inherit from Array, Hash, File, Dir, and Struct are treated as the base class.
+    #------------------------------------------------------------------------------
+    def printable(object)
+      case object
+      when Array  then :array
+      when Hash   then :hash
+      when File   then :file
+      when Dir    then :dir
+      when Struct then :struct
+      else object.class.to_s.gsub(/:+/, "_").downcase.to_sym
+      end
+    end
+
+    # Update @options by first merging the :color hash and then the remaining keys.
+    #------------------------------------------------------------------------------
+    def merge_options!(options = {})
+      @options[:color].merge!(options.delete(:color) || {})
+      @options.merge!(options)
+    end
+
+    # Load ~/.aprc file with custom defaults that override default options.
+    #------------------------------------------------------------------------------
+    def merge_custom_defaults!
+      dotfile = File.join(ENV["HOME"], ".aprc")
+      if File.readable?(dotfile)
+        load dotfile
+        merge_options!(AwesomePrint.defaults)
+      end
+    rescue => e
+      $stderr.puts "Could not load #{dotfile}: #{e}"
+    end
+  end
+end

data/lib/awesome_print/version.rb

@@ -0,0 +1,10 @@
+# Copyright (c) 2010-2011 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 AwesomePrint
+  def self.version
+    '1.0.2.1'
+  end
+end

data/lib/awesome_print.rb

@@ -0,0 +1,30 @@
+# Copyright (c) 2010-2011 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
+#------------------------------------------------------------------------------
+#
+# AwesomePrint might be loaded implicitly through ~/.irbrc so do nothing
+# for subsequent requires.
+#
+unless defined?(AwesomePrint)
+  %w(array string method object class kernel).each do |file|
+    require File.dirname(__FILE__) + "/awesome_print/core_ext/#{file}"
+  end
+
+  require File.dirname(__FILE__) + "/awesome_print/inspector"
+  require File.dirname(__FILE__) + "/awesome_print/formatter"
+  require File.dirname(__FILE__) + "/awesome_print/version"
+  require File.dirname(__FILE__) + "/awesome_print/core_ext/logger" if defined?(Logger)
+
+  # Load the following under normal circumstances as well as in Rails
+  # console when required from ~/.irbrc or ~/.pryrc.
+  require File.dirname(__FILE__) + "/awesome_print/ext/active_record"  if defined?(ActiveRecord)  || (defined?(Pry) || (defined?(IRB) && ENV['RAILS_ENV']))
+  require File.dirname(__FILE__) + "/awesome_print/ext/active_support" if defined?(ActiveSupport) || (defined?(Pry) || (defined?(IRB) && ENV['RAILS_ENV']))
+
+  # Load remaining extensions.
+  require File.dirname(__FILE__) + "/awesome_print/ext/action_view"    if defined?(ActionView::Base)
+  require File.dirname(__FILE__) + "/awesome_print/ext/mongo_mapper"   if defined?(MongoMapper)
+  require File.dirname(__FILE__) + "/awesome_print/ext/mongoid"        if defined?(Mongoid)
+  require File.dirname(__FILE__) + "/awesome_print/ext/nokogiri"       if defined?(Nokogiri)
+end

data/spec/colors_spec.rb

@@ -0,0 +1,106 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "AwesomePrint" do
+  def stub_tty!(output = true, stream = STDOUT)
+    if output
+      stream.instance_eval { def tty?;  true; end }
+    else
+      stream.instance_eval { def tty?; false; end }
+    end
+  end
+
+  before do
+    stub_dotfile!
+  end
+
+  describe "colorization" do
+    PLAIN = '[ 1, :two, "three", [ nil, [ true, false ] ] ]'
+    COLORIZED = "[ \e[1;34m1\e[0m, \e[0;36m:two\e[0m, \e[0;33m\"three\"\e[0m, [ \e[1;31mnil\e[0m, [ \e[1;32mtrue\e[0m, \e[1;31mfalse\e[0m ] ] ]"
+
+    before do
+      ENV['TERM'] = "xterm-colors"
+      ENV.delete('ANSICON')
+      @arr = [ 1, :two, "three", [ nil, [ true, false] ] ]
+    end
+
+    describe "default settings (no forced colors)" do
+      before do
+        AwesomePrint.force_colors! false
+      end
+
+      it "colorizes tty processes by default" do
+        stub_tty!
+        @arr.ai(:multiline => false).should == COLORIZED
+      end
+
+      it "colorizes processes with ENV['ANSICON'] by default" do
+        begin
+          stub_tty!
+          term, ENV['ANSICON'] = ENV['ANSICON'], "1"
+          @arr.ai(:multiline => false).should == COLORIZED
+        ensure
+          ENV['ANSICON'] = term
+        end
+      end
+
+      it "does not colorize tty processes running in dumb terminals by default" do
+        begin
+          stub_tty!
+          term, ENV['TERM'] = ENV['TERM'], "dumb"
+          @arr.ai(:multiline => false).should == PLAIN
+        ensure
+          ENV['TERM'] = term
+        end
+      end
+
+      it "does not colorize subprocesses by default" do
+        begin
+          stub_tty! false
+          @arr.ai(:multiline => false).should == PLAIN
+        ensure
+          stub_tty!
+        end
+      end
+    end
+
+    describe "forced colors override" do
+      before do
+        AwesomePrint.force_colors!
+      end
+      
+      it "still colorizes tty processes" do
+        stub_tty!
+        @arr.ai(:multiline => false).should == COLORIZED
+      end
+
+      it "colorizes processes with ENV['ANSICON'] set to 0" do
+        begin
+          stub_tty!
+          term, ENV['ANSICON'] = ENV['ANSICON'], "1"
+          @arr.ai(:multiline => false).should == COLORIZED
+        ensure
+          ENV['ANSICON'] = term
+        end
+      end
+      
+      it "colorizes dumb terminals" do
+        begin
+          stub_tty!
+          term, ENV['TERM'] = ENV['TERM'], "dumb"
+          @arr.ai(:multiline => false).should == COLORIZED
+        ensure
+          ENV['TERM'] = term
+        end
+      end
+
+      it "colorizes subprocess" do
+        begin
+          stub_tty! false
+          @arr.ai(:multiline => false).should == COLORIZED
+        ensure
+          stub_tty!
+        end
+      end
+    end
+  end
+end