amazing_print 1.0.0

data/lib/amazing_print/version.rb

@@ -0,0 +1,10 @@
+# Copyright (c) 2010-2016 Michael Dvorkin and contributors
+#
+# AmazingPrint is freely distributable under the terms of MIT license.
+# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+module AmazingPrint
+  def self.version
+    '1.0.0'
+  end
+end

data/lib/ap.rb

@@ -0,0 +1,10 @@
+# Copyright (c) 2010-2016 Michael Dvorkin and contributors
+#
+# AmazingPrint is freely distributable under the terms of MIT license.
+# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+#
+# Keeping this for backwards compatibility to allow
+# require "ap"
+#
+require File.dirname(__FILE__) + '/amazing_print'

data/spec/active_record_helper.rb

@@ -0,0 +1,30 @@
+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
+
+  ActiveRecord::Migration.create_table :emails do |t|
+    t.references :user
+    t.string :email_address
+  end
+
+  # 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

@@ -0,0 +1,114 @@
+require 'spec_helper'
+
+RSpec.describe 'AmazingPrint' do
+  def stub_tty!(output = true, stream = STDOUT)
+    if output
+      stream.instance_eval do
+        def tty?
+          true
+        end
+      end
+    else
+      stream.instance_eval do
+        def tty?
+          false
+        end
+      end
+    end
+  end
+
+  describe 'colorization' do
+    PLAIN = '[ 1, :two, "three", [ nil, [ true, false ] ] ]'.freeze
+    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 ] ] ]".freeze
+
+    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
+        AmazingPrint.force_colors! false
+      end
+
+      it 'colorizes tty processes by default' do
+        stub_tty!
+        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)
+        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'
+          expect(@arr.ai(multiline: false)).to eq(PLAIN)
+        ensure
+          ENV['TERM'] = term
+        end
+      end
+
+      it 'does not colorize subprocesses by default' do
+        begin
+          stub_tty! false
+          expect(@arr.ai(multiline: false)).to eq(PLAIN)
+        ensure
+          stub_tty!
+        end
+      end
+    end
+
+    describe 'forced colors override' do
+      before do
+        AmazingPrint.force_colors!
+      end
+
+      it 'still colorizes tty processes' do
+        stub_tty!
+        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)
+        ensure
+          ENV['ANSICON'] = term
+        end
+      end
+
+      it 'colorizes dumb terminals' do
+        begin
+          stub_tty!
+          term = ENV['TERM']
+          ENV['TERM'] = 'dumb'
+          expect(@arr.ai(multiline: false)).to eq(COLORIZED)
+        ensure
+          ENV['TERM'] = term
+        end
+      end
+
+      it 'colorizes subprocess' do
+        begin
+          stub_tty! false
+          expect(@arr.ai(multiline: false)).to eq(COLORIZED)
+        ensure
+          stub_tty!
+        end
+      end
+    end
+  end
+end

data/spec/core_ext/logger_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+require 'logger'
+require 'amazing_print/core_ext/logger'
+
+RSpec.describe 'AmazingPrint logging extensions' do
+  before(:all) do
+    @logger = begin
+                Logger.new('/dev/null')
+              rescue Errno::ENOENT
+                Logger.new('nul')
+              end
+  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
+        AmazingPrint.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
+        AmazingPrint.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
+  %i[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,17 @@
+require 'spec_helper'
+
+RSpec.describe 'AmazingPrint ActionView extensions', skip: -> { !ExtVerifier.has_rails? }.call do
+  before do
+    @view = ActionView::Base.new
+  end
+
+  it "uses HTML and adds 'debug_dump' class to plain <pre> tag" do
+    markup = rand
+    expect(@view.ap(markup, plain: true)).to eq(%(<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

data/spec/ext/active_record_spec.rb

@@ -0,0 +1,297 @@
+require 'spec_helper'
+require 'active_record_helper'
+
+RSpec.describe 'AmazingPrint/ActiveRecord', skip: -> { !ExtVerifier.has_rails? }.call do
+  describe 'ActiveRecord instance, attributes only (default)' do
+    before do
+      ActiveRecord::Base.default_timezone = :utc
+      @diana = User.new(name: 'Diana', rank: 1, admin: false, created_at: '1992-10-10 12:30:00')
+      @laura = User.new(name: 'Laura', rank: 2, admin: true,  created_at: '2003-05-26 14:15:00')
+      @ap = AmazingPrint::Inspector.new(plain: true, sort_keys: true)
+    end
+
+    it 'display single record' do
+      out = @ap.awesome(@diana)
+      str = <<~EOS.strip
+        #<User:placeholder_id> {
+                 :admin => false,
+            :created_at => ?,
+                    :id => nil,
+                  :name => "Diana",
+                  :rank => 1
+        }
+      EOS
+      if RUBY_VERSION < '1.9'
+        str.sub!('?', 'Sat Oct 10 12:30:00 UTC 1992')
+      else
+        str.sub!('?', '1992-10-10 12:30:00 UTC')
+      end
+      expect(out).to be_similar_to(str)
+    end
+
+    it 'display multiple records' do
+      out = @ap.awesome([@diana, @laura])
+      str = <<~EOS.strip
+        [
+            [0] #<User:placeholder_id> {
+                     :admin => false,
+                :created_at => ??,
+                        :id => nil,
+                      :name => "Diana",
+                      :rank => 1
+            },
+            [1] #<User:placeholder_id> {
+                     :admin => true,
+                :created_at => ?!,
+                        :id => nil,
+                      :name => "Laura",
+                      :rank => 2
+            }
+        ]
+      EOS
+      if RUBY_VERSION < '1.9'
+        str.sub!('??', 'Sat Oct 10 12:30:00 UTC 1992')
+        str.sub!('?!', 'Mon May 26 14:15:00 UTC 2003')
+      else
+        str.sub!('??', '1992-10-10 12:30:00 UTC')
+        str.sub!('?!', '2003-05-26 14:15:00 UTC')
+      end
+      expect(out).to be_similar_to(str)
+    end
+
+    it 'display multiple records on a relation' do
+      @diana.save
+      @laura.save
+      out = @ap.awesome(User.all)
+      str = <<~EOS.strip
+        [
+            [0] #<User:placeholder_id> {
+                     :admin => false,
+                :created_at => ??,
+                        :id => 1,
+                      :name => "Diana",
+                      :rank => 1
+            },
+            [1] #<User:placeholder_id> {
+                     :admin => true,
+                :created_at => ?!,
+                        :id => 2,
+                      :name => "Laura",
+                      :rank => 2
+            }
+        ]
+      EOS
+      if RUBY_VERSION < '1.9'
+        str.sub!('??', 'Sat Oct 10 12:30:00 UTC 1992')
+        str.sub!('?!', 'Mon May 26 14:15:00 UTC 2003')
+      else
+        str.sub!('??', '1992-10-10 12:30:00 UTC')
+        str.sub!('?!', '2003-05-26 14:15:00 UTC')
+      end
+      expect(out).to be_similar_to(str)
+    end
+  end
+
+  describe 'Linked records (joins)' do
+    before do
+      @ap = AmazingPrint::Inspector.new(plain: true)
+    end
+
+    it 'should show the entire record' do
+      e = Email.create(email_address: 'foo@bar.com')
+      u = User.last
+      u.emails << e
+      email_record = User.joins(:emails).select('users.id, emails.email_address').last
+      out = @ap.awesome(email_record)
+      raw_object_string = <<~EOS.strip
+        #<User:placeholder_id> {
+                       "id" => #{u.id},
+            "email_address" => "#{e.email_address}"
+        }
+      EOS
+      expect(out).to be_similar_to(raw_object_string)
+    end
+  end
+
+  #------------------------------------------------------------------------------
+  describe 'ActiveRecord instance (raw)' do
+    before do
+      ActiveRecord::Base.default_timezone = :utc
+      @diana = User.new(name: 'Diana', rank: 1, admin: false, created_at: '1992-10-10 12:30:00')
+      @laura = User.new(name: 'Laura', rank: 2, admin: true,  created_at: '2003-05-26 14:15:00')
+      @ap = AmazingPrint::Inspector.new(plain: true, sort_keys: true, raw: true)
+    end
+
+    it 'display single record' do
+      out = @ap.awesome(@diana)
+
+      raw_object_string =
+        if activerecord_6_0?
+          ActiveRecordData.raw_6_0_diana
+        elsif activerecord_5_2?
+          ActiveRecordData.raw_5_2_diana
+        elsif activerecord_5_1?
+          ActiveRecordData.raw_5_1_diana
+        elsif activerecord_5_0?
+          ActiveRecordData.raw_5_0_diana
+        elsif activerecord_4_2?
+          if RUBY_VERSION > '1.9.3'
+            ActiveRecordData.raw_4_2_diana
+          else
+            ActiveRecordData.raw_4_2_diana_legacy
+          end
+        elsif activerecord_4_1?
+          ActiveRecordData.raw_4_1_diana
+        elsif activerecord_4_0?
+          ActiveRecordData.raw_4_0_diana
+        elsif activerecord_3_2?
+          if RUBY_VERSION > '1.9.3'
+            ActiveRecordData.raw_3_2_diana
+          else
+            ActiveRecordData.raw_3_2_diana_legacy
+          end
+        end
+
+      if RUBY_PLATFORM == 'java'
+        raw_object_string.gsub!(
+          'ActiveRecord::ConnectionAdapters::SQLite3Adapter::SQLite3Integer',
+          'ArJdbc::SQLite3::SQLite3Integer'
+        )
+      end
+      raw_object_string.sub!('?', '1992-10-10 12:30:00')
+      expect(out).to be_similar_to(raw_object_string)
+    end
+
+    it 'display multiple records' do
+      out = @ap.awesome([@diana, @laura])
+
+      raw_object_string =
+        if activerecord_6_0?
+          ActiveRecordData.raw_6_0_multi
+        elsif activerecord_5_2?
+          ActiveRecordData.raw_5_2_multi
+        elsif activerecord_5_1?
+          ActiveRecordData.raw_5_1_multi
+        elsif activerecord_5_0?
+          ActiveRecordData.raw_5_0_multi
+        elsif activerecord_4_2?
+          if RUBY_VERSION > '1.9.3'
+            ActiveRecordData.raw_4_2_multi
+          else
+            ActiveRecordData.raw_4_2_multi_legacy
+          end
+        elsif activerecord_4_1?
+          ActiveRecordData.raw_4_1_multi
+        elsif activerecord_4_0?
+          ActiveRecordData.raw_4_0_multi
+        elsif activerecord_3_2?
+          if RUBY_VERSION > '1.9.3'
+            ActiveRecordData.raw_3_2_multi
+          else
+            ActiveRecordData.raw_3_2_multi_legacy
+          end
+        end
+
+      if RUBY_PLATFORM == 'java'
+        raw_object_string.gsub!(
+          'ActiveRecord::ConnectionAdapters::SQLite3Adapter::SQLite3Integer',
+          'ArJdbc::SQLite3::SQLite3Integer'
+        )
+      end
+      raw_object_string.sub!('?', '1992-10-10 12:30:00')
+      raw_object_string.sub!('?', '2003-05-26 14:15:00')
+      expect(out).to be_similar_to(raw_object_string)
+    end
+  end
+
+  #------------------------------------------------------------------------------
+  describe 'ActiveRecord class' do
+    before do
+      @ap = AmazingPrint::Inspector.new(plain: true)
+    end
+
+    it 'should print the class' do
+      expect(@ap.awesome(User)).to eq <<~EOS.strip
+        class User < ActiveRecord::Base {
+                    :id => :integer,
+                  :name => :string,
+                  :rank => :integer,
+                 :admin => :boolean,
+            :created_at => :datetime
+        }
+      EOS
+    end
+
+    it 'should print the class for non-direct subclasses of ActiveRecord::Base' do
+      out = @ap.awesome(SubUser)
+      expect(out).to eq <<~EOS.strip
+        class SubUser < User {
+                    :id => :integer,
+                  :name => :string,
+                  :rank => :integer,
+                 :admin => :boolean,
+            :created_at => :datetime
+        }
+      EOS
+    end
+
+    it 'should print ActiveRecord::Base objects (ex. ancestors)' do
+      expect { @ap.awesome(User.ancestors) }.not_to raise_error
+    end
+  end
+
+  #------------------------------------------------------------------------------
+  describe 'ActiveRecord methods formatting' do
+    before do
+      @ap = AmazingPrint::Inspector.new(plain: true)
+    end
+
+    it 'should format class methods properly' do
+      # spec 1
+      out = @ap.awesome(User.methods.grep(/first/))
+
+      if ActiveRecord::VERSION::STRING >= '3.2'
+        if RUBY_PLATFORM == 'java'
+          expect(out).to match(
+            /\s+first\(\*args,\s&block\)\s+#<Class:\w+>\s+\(ActiveRecord::Querying\)/
+          )
+        elsif RUBY_VERSION >= '2.4.4'
+          expect(out).to match(/\sfirst\(\*arg.*?\)\s+User/)
+        elsif RUBY_VERSION >= '1.9'
+          expect(out).to match(/\sfirst\(\*args,\s&block\)\s+Class \(ActiveRecord::Querying\)/)
+        else
+          expect(out).to match(/\sfirst\(\*arg1\)\s+Class \(ActiveRecord::Querying\)/)
+        end
+      else
+        expect(out).to match(/\sfirst\(\*arg.*?\)\s+User \(ActiveRecord::Base\)/)
+      end
+
+      # spec 2
+      out = @ap.awesome(User.methods.grep(/primary_key/))
+      if RUBY_PLATFORM == 'java'
+        expect(out).to match(
+          /\sprimary_key\(.*?\)\s+#<Class:\w+>\s\(ActiveRecord::AttributeMethods::PrimaryKey::ClassMethods\)/
+        )
+      elsif RUBY_VERSION >= '2.4.4'
+        expect(out).to match(/\sprimary_key\(.*?\)\s+User/)
+      else
+        expect(out).to match(/\sprimary_key\(.*?\)\s+Class \(ActiveRecord::AttributeMethods::PrimaryKey::ClassMethods\)/)
+      end
+
+      # spec 3
+      out = @ap.awesome(User.methods.grep(/validate/))
+
+      if ActiveRecord::VERSION::MAJOR < 3
+        expect(out).to match(/\svalidate\(\*arg.*?\)\s+User \(ActiveRecord::Base\)/)
+      else
+        if RUBY_PLATFORM == 'java'
+          expect(out).to match(/\svalidate\(\*arg.*?\)\s+#<Class:\w+> \(ActiveModel::Validations::ClassMethods\)/)
+        elsif RUBY_VERSION >= '2.4.4'
+          expect(out).to match(/\svalidate\(\*arg.*?\)\s+User/)
+        else
+          expect(out).to match(/\svalidate\(\*arg.*?\)\s+Class \(ActiveModel::Validations::ClassMethods\)/)
+        end
+      end
+    end
+  end
+end