awesome_print 1.6.1 → 1.9.2

data/lib/awesome_print/inspector.rb

@@ -1,87 +1,51 @@
-# Copyright (c) 2010-2013 Michael Dvorkin
+# Copyright (c) 2010-2016 Michael Dvorkin and contributors
 #
 # 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
-
-    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
+require_relative 'indentator'
 
+module AwesomePrint
   class Inspector
-    attr_accessor :options
+    attr_accessor :options, :indentator
 
     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.
-        :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 => { 
-          :args       => :pale,
-          :array      => :white,
-          :bigdecimal => :blue,
-          :class      => :yellow,
-          :date       => :greenish,
-          :falseclass => :red,
-          :fixnum     => :blue,
-          :float      => :blue,
-          :hash       => :pale,
-          :keyword    => :cyan,
-          :method     => :purpleish,
-          :nilclass   => :red,
-          :rational   => :blue,
-          :string     => :yellowish,
-          :struct     => :pale,
-          :symbol     => :cyanish,
-          :time       => :greenish,
-          :trueclass  => :green,
-          :variable   => :cyanish
+      @options = {
+        indent:        4,      # Number of spaces for indenting.
+        index:         true,   # Display array indices.
+        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 instance variables.
+        sort_keys:     false,  # Do not sort hash keys.
+        sort_vars:     true,   # Sort instance variables.
+        limit:         false,  # Limit arrays & hashes. Accepts bool or int.
+        ruby19_syntax: false,  # Use Ruby 1.9 hash syntax in output.
+        class_name:    :class, # Method used to get Instance class name.
+        object_id:     true,   # Show object_id.
+        color: {
+          args:       :pale,
+          array:      :white,
+          bigdecimal: :blue,
+          class:      :yellow,
+          date:       :greenish,
+          falseclass: :red,
+          fixnum:     :blue,
+          integer:    :blue,
+          float:      :blue,
+          hash:       :pale,
+          keyword:    :cyan,
+          method:     :purpleish,
+          nilclass:   :red,
+          rational:   :blue,
+          string:     :yellowish,
+          struct:     :pale,
+          symbol:     :cyanish,
+          time:       :greenish,
+          trueclass:  :green,
+          variable:   :cyanish
         }
       }
 
@@ -90,11 +54,20 @@ 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(&block)
+      indentator.indent(&block)
+    end
+
     # Dispatcher that detects data nesting and invokes object-aware formatter.
-    #------------------------------------------------------------------------------
+    #---------------------------------------------------------------------------
     def awesome(object)
       if Thread.current[AP].include?(object.object_id)
         nested(object)
@@ -109,10 +82,18 @@ module AwesomePrint
     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']))
+      AwesomePrint.force_colors || (
+        STDOUT.tty? && (
+          (
+            ENV['TERM'] &&
+            ENV['TERM'] != 'dumb'
+          ) ||
+          ENV['ANSICON']
+        )
+      )
     end
 
     private
@@ -122,24 +103,25 @@ module AwesomePrint
     #   => [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)
+      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.
-    #------------------------------------------------------------------------------
+    # 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
@@ -147,25 +129,41 @@ module AwesomePrint
       when File   then :file
       when Dir    then :dir
       when Struct then :struct
-      else object.class.to_s.gsub(/:+/, "_").downcase.to_sym
+      else object.class.to_s.gsub(/:+/, '_').downcase.to_sym
       end
     end
 
-    # Update @options by first merging the :color hash and then the remaining keys.
-    #------------------------------------------------------------------------------
+    # 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
 
+    # This method needs to be mocked during testing so that it always loads
+    # predictable values
+    #---------------------------------------------------------------------------
+    def load_dotfile
+      dotfile = File.join(ENV['HOME'], '.aprc')
+      load dotfile if dotfile_readable?(dotfile)
+    end
+
+    def dotfile_readable? dotfile
+      if @@dotfile_readable.nil? || @@dotfile != dotfile
+        @@dotfile_readable = File.readable?(@@dotfile = dotfile)
+      end
+      @@dotfile_readable
+    end
+    @@dotfile_readable = @@dotfile = nil
+
     # Load ~/.aprc file with custom defaults that override default options.
-    #------------------------------------------------------------------------------
+    #---------------------------------------------------------------------------
     def merge_custom_defaults!
-      dotfile = File.join(ENV["HOME"], ".aprc")
-      load dotfile if File.readable?(dotfile)
+      load_dotfile
       merge_options!(AwesomePrint.defaults) if AwesomePrint.defaults.is_a?(Hash)
     rescue => e
-      $stderr.puts "Could not load #{dotfile}: #{e}"
+      $stderr.puts "Could not load '.aprc' from ENV['HOME']: #{e}"
     end
   end
 end

data/lib/awesome_print/version.rb

@@ -1,10 +1,10 @@
-# Copyright (c) 2010-2013 Michael Dvorkin
+# Copyright (c) 2010-2016 Michael Dvorkin and contributors
 #
 # 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.6.1"
+    '1.9.2'
   end
 end

data/lib/awesome_print.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2013 Michael Dvorkin
+# Copyright (c) 2010-2016 Michael Dvorkin and contributors
 #
 # Awesome Print is freely distributable under the terms of MIT license.
 # See LICENSE file or http://www.opensource.org/licenses/mit-license.php
@@ -8,33 +8,34 @@
 # so do nothing for subsequent requires.
 #
 unless defined?(AwesomePrint::Inspector)
-  %w(array string method object class kernel).each do |file|
-    require File.dirname(__FILE__) + "/awesome_print/core_ext/#{file}"
+  %w(awesome_method_array string method object class kernel).each do |file|
+    require "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)
+  require 'awesome_print/custom_defaults'
+  require 'awesome_print/inspector'
+  require 'awesome_print/formatter'
+  require 'awesome_print/version'
+  require '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)  || AwesomePrint.rails_console?
-  require File.dirname(__FILE__) + "/awesome_print/ext/active_support" if defined?(ActiveSupport) || AwesomePrint.rails_console?
+  require 'awesome_print/ext/active_record'  if defined?(ActiveRecord)  || AwesomePrint.rails_console?
+  require 'awesome_print/ext/active_support' if defined?(ActiveSupport) || AwesomePrint.rails_console?
   #
   # Load remaining extensions.
   #
-  if defined?(ActiveSupport)
+  if defined?(ActiveSupport.on_load)
     ActiveSupport.on_load(:action_view) do
-      require File.dirname(__FILE__) + "/awesome_print/ext/action_view"
+      require '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/no_brainer"     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)
+  require 'awesome_print/ext/mongo_mapper'   if defined?(MongoMapper)
+  require 'awesome_print/ext/mongoid'        if defined?(Mongoid)
+  require 'awesome_print/ext/nokogiri'       if defined?(Nokogiri)
+  require 'awesome_print/ext/nobrainer'      if defined?(NoBrainer)
+  require 'awesome_print/ext/ripple'         if defined?(Ripple)
+  require 'awesome_print/ext/sequel'         if defined?(Sequel)
+  require 'awesome_print/ext/ostruct'        if defined?(OpenStruct)
 end

data/spec/active_record_helper.rb

@@ -1,34 +1,30 @@
-require 'active_record'
-
-# Required to use the column support
-module Rails
-  def self.env
-    {}
+if ExtVerifier.has_rails?
+  # Required to use the column support
+  module Rails
+    def self.env
+      {}
+    end
   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
+  # 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
 
-# Helper methods
-# ##############
+  ActiveRecord::Migration.create_table :emails do |t|
+    t.references :user
+    t.string :email_address
+  end
 
-# we only work with ActiveRecord 2+
-def is_usable_activerecord?
-  defined?(ActiveRecord::VERSION::MAJOR) && ActiveRecord::VERSION::MAJOR >= 2
+  # Create models
+  class User < ActiveRecord::Base; has_many :emails; end
+  class SubUser < User; end
+  class Email < ActiveRecord::Base; belongs_to :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 }
@@ -9,94 +9,94 @@ describe "AwesomePrint" do
     end
   end
 
-  before do
-    stub_dotfile!
-  end
-
-  describe "colorization" do
+  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['TERM'] = 'xterm-colors'
       ENV.delete('ANSICON')
-      @arr = [ 1, :two, "three", [ nil, [ true, false] ] ]
+      @arr = [1, :two, 'three', [nil, [true, false]]]
     end
 
-    describe "default settings (no forced colors)" do
+    describe 'default settings (no forced colors)' do
       before do
         AwesomePrint.force_colors! false
       end
 
-      it "colorizes tty processes by default" do
+      it 'colorizes tty processes by default' do
         stub_tty!
-        expect(@arr.ai(:multiline => false)).to eq(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"
-          expect(@arr.ai(:multiline => false)).to eq(COLORIZED)
+          term = ENV['ANSICON']
+          ENV['ANSICON'] = '1'
+          expect(@arr.ai(multiline: false)).to eq(COLORIZED)
         ensure
           ENV['ANSICON'] = term
         end
       end
 
-      it "does not colorize tty processes running in dumb terminals by default" do
+      it 'does not colorize tty processes running in dumb terminals by default' do
         begin
           stub_tty!
-          term, ENV['TERM'] = ENV['TERM'], "dumb"
-          expect(@arr.ai(:multiline => false)).to eq(PLAIN)
+          term = ENV['TERM']
+          ENV['TERM'] = 'dumb'
+          expect(@arr.ai(multiline: false)).to eq(PLAIN)
         ensure
           ENV['TERM'] = term
         end
       end
 
-      it "does not colorize subprocesses by default" do
+      it 'does not colorize subprocesses by default' do
         begin
           stub_tty! false
-          expect(@arr.ai(:multiline => false)).to eq(PLAIN)
+          expect(@arr.ai(multiline: false)).to eq(PLAIN)
         ensure
           stub_tty!
         end
       end
     end
 
-    describe "forced colors override" do
+    describe 'forced colors override' do
       before do
         AwesomePrint.force_colors!
       end
-      
-      it "still colorizes tty processes" do
+
+      it 'still colorizes tty processes' do
         stub_tty!
-        expect(@arr.ai(:multiline => false)).to eq(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"
-          expect(@arr.ai(:multiline => false)).to eq(COLORIZED)
+          term = ENV['ANSICON']
+          ENV['ANSICON'] = '1'
+          expect(@arr.ai(multiline: false)).to eq(COLORIZED)
         ensure
           ENV['ANSICON'] = term
         end
       end
-      
-      it "colorizes dumb terminals" do
+
+      it 'colorizes dumb terminals' do
         begin
           stub_tty!
-          term, ENV['TERM'] = ENV['TERM'], "dumb"
-          expect(@arr.ai(:multiline => false)).to eq(COLORIZED)
+          term = ENV['TERM']
+          ENV['TERM'] = 'dumb'
+          expect(@arr.ai(multiline: false)).to eq(COLORIZED)
         ensure
           ENV['TERM'] = term
         end
       end
 
-      it "colorizes subprocess" do
+      it 'colorizes subprocess' do
         begin
           stub_tty! false
-          expect(@arr.ai(:multiline => false)).to eq(COLORIZED)
+          expect(@arr.ai(multiline: false)).to eq(COLORIZED)
         ensure
           stub_tty!
         end

data/spec/core_ext/logger_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+
+require 'logger'
+require 'awesome_print/core_ext/logger'
+
+RSpec.describe 'AwesomePrint logging extensions' do
+  before(:all) do
+    @logger = Logger.new('/dev/null') rescue Logger.new('nul')
+  end
+
+  describe 'ap method' do
+    it 'should awesome_inspect the given object' do
+      object = double
+      expect(object).to receive(:ai)
+      @logger.ap object
+    end
+
+    describe 'the log level' do
+      before do
+        AwesomePrint.defaults = {}
+      end
+
+      it 'should fallback to the default :debug log level' do
+        expect(@logger).to receive(:debug)
+        @logger.ap(nil)
+      end
+
+      it 'should use the global user default if no level passed' do
+        AwesomePrint.defaults = { log_level: :info }
+        expect(@logger).to receive(:info)
+        @logger.ap(nil)
+      end
+
+      it 'should use the passed in level' do
+        expect(@logger).to receive(:warn)
+        @logger.ap(nil, :warn)
+      end
+    end
+  end
+end
+
+

data/spec/core_ext/string_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+RSpec.describe 'String extensions' do
+  [:gray, :red, :green, :yellow, :blue, :purple, :cyan, :white].each_with_index do |color, i|
+    it "should have #{color} color" do
+      expect(color.to_s.send(color)).to eq("\e[1;#{30 + i}m#{color}\e[0m")
+    end
+
+    it "should have #{color}ish color" do
+      expect(color.to_s.send(:"#{color}ish")).to eq("\e[0;#{30 + i}m#{color}\e[0m")
+    end
+  end
+
+  it 'should have black and pale colors' do
+    expect('black'.send(:black)).to eq('black'.send(:grayish))
+    expect('pale'.send(:pale)).to eq('pale'.send(:whiteish))
+    expect('pale'.send(:pale)).to eq("\e[0;37mpale\e[0m")
+    expect('whiteish'.send(:whiteish)).to eq("\e[0;37mwhiteish\e[0m")
+  end
+end

data/spec/ext/action_view_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+RSpec.describe 'AwesomePrint ActionView extensions', skip: -> { !ExtVerifier.has_rails? }.call do
+  before do
+    @view = if rails_6_1?
+              ActionView::Base.new(ActionView::LookupContext.new([]), {}, {})
+            else
+              ActionView::Base.new
+            end
+  end
+
+  it "uses HTML and adds 'debug_dump' class to plain <pre> tag" do
+    markup = rand
+    expect(@view.ap(markup, plain: true)).to eq(%Q|<pre class="debug_dump">#{markup}</pre>|)
+  end
+
+  it "uses HTML and adds 'debug_dump' class to colorized <pre> tag" do
+    markup = ' &<hello>'
+    expect(@view.ap(markup)).to eq('<pre class="debug_dump"><kbd style="color:brown">&quot; &amp;&lt;hello&gt;&quot;</kbd></pre>')
+  end
+end