awesome_print 1.0.2 → 1.7.0

data/lib/awesome_print/formatters/file_formatter.rb

@@ -0,0 +1,22 @@
+require_relative 'base_formatter'
+require "shellwords"
+
+module AwesomePrint
+  module Formatters
+    class FileFormatter < BaseFormatter
+
+      attr_reader :file, :inspector, :options
+
+      def initialize(file, inspector)
+        @file = file
+        @inspector = inspector
+        @options = inspector.options
+      end
+
+      def format
+        ls = File.directory?(file) ? `ls -adlF #{file.path.shellescape}` : `ls -alF #{file.path.shellescape}`
+        colorize(ls.empty? ? file.inspect : "#{file.inspect}\n#{ls.chop}", :file)
+      end
+    end
+  end
+end

data/lib/awesome_print/formatters/hash_formatter.rb

@@ -0,0 +1,54 @@
+require_relative 'base_formatter'
+
+module AwesomePrint
+  module Formatters
+    class HashFormatter < BaseFormatter
+
+      attr_reader :hash, :inspector, :options
+
+      def initialize(hash, inspector)
+        @hash = hash
+        @inspector = inspector
+        @options = inspector.options
+      end
+
+      def format
+        return "{}" if hash == {}
+
+        keys = hash.keys
+        keys = keys.sort { |a, b| a.to_s <=> b.to_s } if options[:sort_keys]
+        data = keys.map do |key|
+          plain_single_line do
+            [ inspector.awesome(key), hash[key] ]
+          end
+        end
+
+        width = data.map { |key, | key.size }.max || 0
+        width += indentation if options[:indent] > 0
+
+        data = data.map do |key, value|
+          indented do
+            align(key, width) << colorize(" => ", :hash) << inspector.awesome(value)
+          end
+        end
+
+        data = limited(data, width, :hash => true) if should_be_limited?
+        if options[:multiline]
+          "{\n" << data.join(",\n") << "\n#{outdent}}"
+        else
+          "{ #{data.join(', ')} }"
+        end
+      end
+
+      private
+
+      def plain_single_line
+        plain, multiline = options[:plain], options[:multiline]
+        options[:plain], options[:multiline] = true, false
+        yield
+      ensure
+        options[:plain], options[:multiline] = plain, multiline
+      end
+    end
+  end
+end

data/lib/awesome_print/formatters/method_formatter.rb

@@ -0,0 +1,22 @@
+require_relative 'base_formatter'
+
+module AwesomePrint
+  module Formatters
+    class MethodFormatter < BaseFormatter
+
+      attr_reader :method, :inspector, :options
+
+      def initialize(method, inspector)
+        @method = method
+        @inspector = inspector
+        @options = inspector.options
+      end
+
+      def format
+        name, args, owner = method_tuple(method)
+
+        "#{colorize(owner, :class)}##{colorize(name, :method)}#{colorize(args, :args)}"
+      end
+    end
+  end
+end

data/lib/awesome_print/formatters/object_formatter.rb

@@ -0,0 +1,80 @@
+require_relative 'base_formatter'
+
+module AwesomePrint
+  module Formatters
+    class ObjectFormatter < BaseFormatter
+
+      attr_reader :object, :variables, :inspector, :options
+
+      def initialize(object, variables, inspector)
+        @object = object
+        @variables = variables
+        @inspector = inspector
+        @options = inspector.options
+      end
+
+      def format
+        vars = variables.map do |var|
+          property = var.to_s[1..-1].to_sym # to_s because of some monkey patching done by Puppet.
+          accessor = if object.respond_to?(:"#{property}=")
+            object.respond_to?(property) ? :accessor : :writer
+          else
+            object.respond_to?(property) ? :reader : nil
+          end
+          if accessor
+            [ "attr_#{accessor} :#{property}", var ]
+          else
+            [ var.to_s, var ]
+          end
+        end
+
+        data = vars.sort.map do |declaration, var|
+          key = left_aligned do
+            align(declaration, declaration.size)
+          end
+
+          unless options[:plain]
+            if key =~ /(@\w+)/
+              key.sub!($1, colorize($1, :variable))
+            else
+              key.sub!(/(attr_\w+)\s(\:\w+)/, "#{colorize('\\1', :keyword)} #{colorize('\\2', :method)}")
+            end
+          end
+
+          indented do
+            var_contents = if valid_instance_var?(var)
+              object.instance_variable_get(var)
+            else
+              object.send(var) # Enables handling of Struct attributes
+            end
+
+            key << colorize(" = ", :hash) + inspector.awesome(var_contents)
+          end
+        end
+
+        if options[:multiline]
+          "#<#{awesome_instance}\n#{data.join(%Q/,\n/)}\n#{outdent}>"
+        else
+          "#<#{awesome_instance} #{data.join(', ')}>"
+        end
+      end
+
+      private 
+
+      def valid_instance_var?(variable_name)
+        variable_name.to_s.start_with?('@')
+      end
+
+      def awesome_instance
+        "#{object.class}:0x%08x" % (object.__id__ * 2)
+      end
+
+      def left_aligned
+        current, options[:indent] = options[:indent], 0
+        yield
+      ensure
+        options[:indent] = current
+      end
+    end
+  end
+end

data/lib/awesome_print/formatters/simple_formatter.rb

@@ -0,0 +1,21 @@
+require_relative 'base_formatter'
+
+module AwesomePrint
+  module Formatters
+    class SimpleFormatter < BaseFormatter
+
+      attr_reader :string, :type, :inspector, :options
+
+      def initialize(string, type, inspector)
+        @string = string
+        @type = type
+        @inspector = inspector
+        @options = inspector.options
+      end
+
+      def format
+        colorize(string, type)
+      end
+    end
+  end
+end

data/lib/awesome_print/indentator.rb

@@ -0,0 +1,18 @@
+module AwesomePrint
+  class Indentator
+
+    attr_reader :shift_width, :indentation
+
+    def initialize(indentation)
+      @indentation = indentation
+      @shift_width = indentation.freeze
+    end
+
+    def indent
+      @indentation += shift_width
+      yield
+    ensure
+      @indentation -= shift_width
+    end
+  end
+end

data/lib/awesome_print/inspector.rb

@@ -1,8 +1,10 @@
-# Copyright (c) 2010-2011 Michael Dvorkin
+# Copyright (c) 2010-2013 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
 #------------------------------------------------------------------------------
+require_relative "indentator"
+
 module AwesomePrint
 
   class << self # Class accessors for custom defaults.
@@ -14,10 +16,41 @@ module AwesomePrint
     def force_colors!(value = true)
       @force_colors = value
     end
+
+    def console?
+      !!(defined?(IRB) || defined?(Pry))
+    end
+
+    def rails_console?
+      console? && !!(defined?(Rails::Console) || ENV["RAILS_ENV"])
+    end
+
+    def irb!
+      return unless defined?(IRB)
+      unless IRB.version.include?("DietRB")
+        IRB::Irb.class_eval do
+          def output_value
+            ap @context.last_value
+          end
+        end
+      else # MacRuby
+        IRB.formatter = Class.new(IRB::Formatter) do
+          def inspect_object(object)
+            object.ai
+          end
+        end.new
+      end
+    end
+
+    def pry!
+      if defined?(Pry)
+        Pry.print = proc { |output, value| output.puts value.ai }
+      end
+    end
   end
 
   class Inspector
-    attr_accessor :options
+    attr_accessor :options, :indentator
 
     AP = :__awesome_print__
 
@@ -28,6 +61,7 @@ module AwesomePrint
         :html       => false,  # Use ANSI color codes rather than HTML.
         :multiline  => true,   # Display in multiple lines.
         :plain      => false,  # Use colors.
+        :raw        => false,  # Do not recursively format object instance variables.
         :sort_keys  => false,  # Do not sort hash keys.
         :limit      => false,  # Limit large output for arrays and hashes. Set to a boolean or integer.
         :color => { 
@@ -43,6 +77,7 @@ module AwesomePrint
           :keyword    => :cyan,
           :method     => :purpleish,
           :nilclass   => :red,
+          :rational   => :blue,
           :string     => :yellowish,
           :struct     => :pale,
           :symbol     => :cyanish,
@@ -57,8 +92,17 @@ module AwesomePrint
       merge_options!(options)
 
       @formatter = AwesomePrint::Formatter.new(self)
+      @indentator = AwesomePrint::Indentator.new(@options[:indent].abs)
       Thread.current[AP] ||= []
     end
+
+    def current_indentation
+      indentator.indentation
+    end
+
+    def increase_indentation
+      indentator.indent(&Proc.new)
+    end
   
     # Dispatcher that detects data nesting and invokes object-aware formatter.
     #------------------------------------------------------------------------------
@@ -129,10 +173,8 @@ module AwesomePrint
     #------------------------------------------------------------------------------
     def merge_custom_defaults!
       dotfile = File.join(ENV["HOME"], ".aprc")
-      if File.readable?(dotfile)
-        load dotfile
-        merge_options!(AwesomePrint.defaults)
-      end
+      load dotfile if File.readable?(dotfile)
+      merge_options!(AwesomePrint.defaults) if AwesomePrint.defaults.is_a?(Hash)
     rescue => e
       $stderr.puts "Could not load #{dotfile}: #{e}"
     end

data/lib/awesome_print/version.rb

@@ -1,10 +1,10 @@
-# Copyright (c) 2010-2011 Michael Dvorkin
+# Copyright (c) 2010-2013 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.7.0'
   end
 end

data/lib/awesome_print.rb

@@ -1,13 +1,13 @@
-# Copyright (c) 2010-2011 Michael Dvorkin
+# Copyright (c) 2010-2013 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.
+# AwesomePrint might be loaded implicitly through ~/.irbrc or ~/.pryrc
+# so do nothing for subsequent requires.
 #
-unless defined?(AwesomePrint)
+unless defined?(AwesomePrint::Inspector)
   %w(array string method object class kernel).each do |file|
     require File.dirname(__FILE__) + "/awesome_print/core_ext/#{file}"
   end
@@ -16,15 +16,25 @@ unless defined?(AwesomePrint)
   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.
-  require File.dirname(__FILE__) + "/awesome_print/ext/active_record"  if defined?(ActiveRecord)  || (defined?(IRB) && ENV['RAILS_ENV'])
-  require File.dirname(__FILE__) + "/awesome_print/ext/active_support" if defined?(ActiveSupport) || (defined?(IRB) && ENV['RAILS_ENV'])
-
+  # console when required from ~/.irbrc or ~/.pryrc.
+  #
+  require File.dirname(__FILE__) + "/awesome_print/ext/active_record"  if defined?(ActiveRecord)  || AwesomePrint.rails_console?
+  require File.dirname(__FILE__) + "/awesome_print/ext/active_support" if defined?(ActiveSupport) || AwesomePrint.rails_console?
+  #
   # Load remaining extensions.
-  require File.dirname(__FILE__) + "/awesome_print/ext/action_view"    if defined?(ActionView::Base)
+  #
+  if defined?(ActiveSupport.on_load)
+    ActiveSupport.on_load(:action_view) do
+      require File.dirname(__FILE__) + "/awesome_print/ext/action_view"
+    end
+  end
   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)
+  require File.dirname(__FILE__) + "/awesome_print/ext/nobrainer"      if defined?(NoBrainer)
+  require File.dirname(__FILE__) + "/awesome_print/ext/ripple"         if defined?(Ripple)
+  require File.dirname(__FILE__) + "/awesome_print/ext/sequel"         if defined?(Sequel)
+  require File.dirname(__FILE__) + "/awesome_print/ext/ostruct"        if defined?(OpenStruct)
 end

data/spec/active_record_helper.rb

@@ -0,0 +1,24 @@
+if ExtVerifier.has_rails?
+  # Required to use the column support
+  module Rails
+    def self.env
+      {}
+    end
+  end
+
+  # Establish connection to in-memory SQLite DB
+  ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+  # Create the users table
+  ActiveRecord::Migration.verbose = false
+  ActiveRecord::Migration.create_table :users do |t|
+    t.string :name
+    t.integer :rank
+    t.boolean :admin
+    t.datetime :created_at
+  end
+
+  # Create models
+  class User < ActiveRecord::Base; end
+  class SubUser < User; end
+end

data/spec/colors_spec.rb

@@ -1,6 +1,6 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
-describe "AwesomePrint" do
+RSpec.describe "AwesomePrint" do
   def stub_tty!(output = true, stream = STDOUT)
     if output
       stream.instance_eval { def tty?;  true; end }
@@ -30,14 +30,14 @@ describe "AwesomePrint" do
 
       it "colorizes tty processes by default" do
         stub_tty!
-        @arr.ai(:multiline => false).should == COLORIZED
+        expect(@arr.ai(:multiline => false)).to eq(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
+          expect(@arr.ai(:multiline => false)).to eq(COLORIZED)
         ensure
           ENV['ANSICON'] = term
         end
@@ -47,7 +47,7 @@ describe "AwesomePrint" do
         begin
           stub_tty!
           term, ENV['TERM'] = ENV['TERM'], "dumb"
-          @arr.ai(:multiline => false).should == PLAIN
+          expect(@arr.ai(:multiline => false)).to eq(PLAIN)
         ensure
           ENV['TERM'] = term
         end
@@ -56,7 +56,7 @@ describe "AwesomePrint" do
       it "does not colorize subprocesses by default" do
         begin
           stub_tty! false
-          @arr.ai(:multiline => false).should == PLAIN
+          expect(@arr.ai(:multiline => false)).to eq(PLAIN)
         ensure
           stub_tty!
         end
@@ -70,14 +70,14 @@ describe "AwesomePrint" do
       
       it "still colorizes tty processes" do
         stub_tty!
-        @arr.ai(:multiline => false).should == COLORIZED
+        expect(@arr.ai(:multiline => false)).to eq(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
+          expect(@arr.ai(:multiline => false)).to eq(COLORIZED)
         ensure
           ENV['ANSICON'] = term
         end
@@ -87,7 +87,7 @@ describe "AwesomePrint" do
         begin
           stub_tty!
           term, ENV['TERM'] = ENV['TERM'], "dumb"
-          @arr.ai(:multiline => false).should == COLORIZED
+          expect(@arr.ai(:multiline => false)).to eq(COLORIZED)
         ensure
           ENV['TERM'] = term
         end
@@ -96,7 +96,7 @@ describe "AwesomePrint" do
       it "colorizes subprocess" do
         begin
           stub_tty! false
-          @arr.ai(:multiline => false).should == COLORIZED
+          expect(@arr.ai(:multiline => false)).to eq(COLORIZED)
         ensure
           stub_tty!
         end