amazing_print 1.0.0 → 1.3.0

data/lib/amazing_print/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2010-2016 Michael Dvorkin and contributors
 #
 # AmazingPrint is freely distributable under the terms of MIT license.
@@ -5,6 +7,6 @@
 #------------------------------------------------------------------------------
 module AmazingPrint
   def self.version
-    '1.0.0'
+    '1.3.0'
   end
 end

data/lib/ap.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2010-2016 Michael Dvorkin and contributors
 #
 # AmazingPrint is freely distributable under the terms of MIT license.
@@ -7,4 +9,4 @@
 # Keeping this for backwards compatibility to allow
 # require "ap"
 #
-require File.dirname(__FILE__) + '/amazing_print'
+require_relative 'amazing_print'

data/spec/active_record_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 if ExtVerifier.has_rails?
   # Required to use the column support
   module Rails
@@ -27,4 +29,12 @@ if ExtVerifier.has_rails?
   class User < ActiveRecord::Base; has_many :emails; end
   class SubUser < User; end
   class Email < ActiveRecord::Base; belongs_to :user; end
+  class TableFreeModel
+    include ::ActiveModel::Validations
+    attr_reader(:name)
+
+    def attributes
+      { 'name' => name }
+    end
+  end
 end

data/spec/colors_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe 'AmazingPrint' do
@@ -18,8 +20,8 @@ RSpec.describe 'AmazingPrint' do
   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
+    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'
@@ -38,34 +40,28 @@ RSpec.describe 'AmazingPrint' do
       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
+        stub_tty!
+        term = ENV['ANSICON']
+        ENV['ANSICON'] = '1'
+        expect(@arr.ai(multiline: false)).to eq(COLORIZED)
+      ensure
+        ENV['ANSICON'] = term
       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
+        stub_tty!
+        term = ENV['TERM']
+        ENV['TERM'] = 'dumb'
+        expect(@arr.ai(multiline: false)).to eq(PLAIN)
+      ensure
+        ENV['TERM'] = term
       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
+        stub_tty! false
+        expect(@arr.ai(multiline: false)).to eq(PLAIN)
+      ensure
+        stub_tty!
       end
     end
 
@@ -80,34 +76,35 @@ RSpec.describe 'AmazingPrint' do
       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
+        stub_tty!
+        term = ENV['ANSICON']
+        ENV['ANSICON'] = '1'
+        expect(@arr.ai(multiline: false)).to eq(COLORIZED)
+      ensure
+        ENV['ANSICON'] = term
       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
+        stub_tty!
+        term = ENV['TERM']
+        ENV['TERM'] = 'dumb'
+        expect(@arr.ai(multiline: false)).to eq(COLORIZED)
+      ensure
+        ENV['TERM'] = term
       end
 
       it 'colorizes subprocess' do
-        begin
-          stub_tty! false
-          expect(@arr.ai(multiline: false)).to eq(COLORIZED)
-        ensure
-          stub_tty!
-        end
+        stub_tty! false
+        expect(@arr.ai(multiline: false)).to eq(COLORIZED)
+      ensure
+        stub_tty!
+      end
+    end
+
+    describe 'uncolor' do
+      it 'removes any ANSI color codes' do
+        expect('red'.red + 'blue'.blue).to eq "\e[1;31mred\e[0m\e[1;34mblue\e[0m"
+        expect(('red'.red + 'blue'.blue).uncolor).to eq 'redblue'
       end
     end
   end

data/spec/core_ext/logger_spec.rb

@@ -1,22 +1,29 @@
+# frozen_string_literal: true
+
 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
+  let(:object) { double }
+  let(:options) { { sort_keys: true } }
+
+  subject(:logger) do
+    Logger.new('/dev/null')
+  rescue Errno::ENOENT
+    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
+      logger.ap object
+    end
+
+    it 'passes options to `ai`' do
+      expect(object).to receive(:ai).with(options)
+      logger.ap object, options
     end
 
     describe 'the log level' do
@@ -25,19 +32,38 @@ RSpec.describe 'AmazingPrint logging extensions' do
       end
 
       it 'should fallback to the default :debug log level' do
-        expect(@logger).to receive(:debug)
-        @logger.ap(nil)
+        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)
+        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)
+        expect(logger).to receive(:warn)
+        logger.ap nil, :warn
+      end
+
+      it 'makes no difference if passed as a hash or a part of options' do
+        expect(logger).to receive(:warn)
+        logger.ap nil, { level: :warn }
+      end
+
+      context 'when given options' do
+        it 'uses the default log level with the options' do
+          expect(logger).to receive(:debug)
+          expect(object).to receive(:ai).with(options)
+          logger.ap object, options
+        end
+
+        it 'still uses the passed in level with options' do
+          expect(logger).to receive(:warn)
+          expect(object).to receive(:ai).with(options)
+          logger.ap object, options.merge({ level: :warn })
+        end
       end
     end
   end

data/spec/core_ext/string_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe 'String extensions' do
@@ -10,11 +12,4 @@ RSpec.describe 'String extensions' 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_controller_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe 'AmazingPrint::ActionController', skip: -> { !ExtVerifier.has_rails? }.call do
+  let(:inspector) { AmazingPrint::Inspector.new }
+
+  context 'with unpermitted ActionController::Parameters' do
+    let(:parameters) do
+      ActionController::Parameters.new post: { id: 1, content: 'Some' }
+    end
+
+    it 'should format as an object' do
+      expect(inspector.send(:awesome, parameters)).to match(
+        /\A#?<ActionController::Parameters {"post"=>{"id"=>1, "content"=>"Some"}} permitted: false>\z/
+      )
+    end
+  end
+
+  context 'with permitted ActionController::Parameters' do
+    let(:expected_output) do
+      <<~OUTPUT
+        {
+            \"post\"\e[0;37m => \e[0m{
+                     \"id\"\e[0;37m => \e[0m\e[1;34m1\e[0m,
+                \"content\"\e[0;37m => \e[0m\e[0;33m\"Some\"\e[0m
+            }
+        }
+      OUTPUT
+        .chomp
+    end
+    let(:parameters) do
+      ActionController::Parameters.new post: { id: 1, content: 'Some' }
+    end
+
+    it 'should format as a hash' do
+      expect(inspector.send(:awesome, parameters.permit!)).to eq expected_output
+    end
+  end
+end

data/spec/ext/action_view_spec.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-RSpec.describe 'AmazingPrint ActionView extensions', skip: -> { !ExtVerifier.has_rails? }.call do
+RSpec.describe 'AmazingPrint ActionView extensions',
+               skip: -> { !ExtVerifier.has_rails? || ActiveRecord::VERSION::STRING >= '6.1' }.call do
   before do
     @view = ActionView::Base.new
   end
@@ -14,4 +17,8 @@ RSpec.describe 'AmazingPrint ActionView extensions', skip: -> { !ExtVerifier.has
     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
+
+  it 'uses HTML and does set output to HTML safe' do
+    expect(@view.ap('<p>Hello World</p>')).to be_html_safe
+  end
 end

data/spec/ext/active_model_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'active_record_helper'
+
+RSpec.describe 'ActiveModel::Errors formatting', skip: -> { !ExtVerifier.has_rails? }.call do
+  before do
+    @ap = AmazingPrint::Inspector.new(plain: true)
+  end
+
+  it 'should format active_model_errors properly' do
+    model = TableFreeModel.new
+    model.errors.add(:name, "can't be blank")
+
+    out = @ap.awesome(model.errors)
+
+    str = <<~ERRORS.strip
+      #<ActiveModel::Errors:placeholder_id> {
+             "name" => nil,
+           :details => {
+              :name => [
+                  [0] {
+                      :error => "can't be blank"
+                  }
+              ]
+          },
+          :messages => {
+              :name => [
+                  [0] "can't be blank"
+              ]
+          }
+      }
+    ERRORS
+
+    expect(out).to be_similar_to(str)
+  end
+end

data/spec/ext/active_record_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'active_record_helper'
 
@@ -126,7 +128,9 @@ RSpec.describe 'AmazingPrint/ActiveRecord', skip: -> { !ExtVerifier.has_rails? }
       out = @ap.awesome(@diana)
 
       raw_object_string =
-        if activerecord_6_0?
+        if activerecord_6_1?
+          ActiveRecordData.raw_6_1_diana
+        elsif activerecord_6_0?
           ActiveRecordData.raw_6_0_diana
         elsif activerecord_5_2?
           ActiveRecordData.raw_5_2_diana
@@ -152,7 +156,7 @@ RSpec.describe 'AmazingPrint/ActiveRecord', skip: -> { !ExtVerifier.has_rails? }
           end
         end
 
-      if RUBY_PLATFORM == 'java'
+      if RUBY_PLATFORM == 'java' && !activerecord_6_1?
         raw_object_string.gsub!(
           'ActiveRecord::ConnectionAdapters::SQLite3Adapter::SQLite3Integer',
           'ArJdbc::SQLite3::SQLite3Integer'
@@ -166,7 +170,9 @@ RSpec.describe 'AmazingPrint/ActiveRecord', skip: -> { !ExtVerifier.has_rails? }
       out = @ap.awesome([@diana, @laura])
 
       raw_object_string =
-        if activerecord_6_0?
+        if activerecord_6_1?
+          ActiveRecordData.raw_6_1_multi
+        elsif activerecord_6_0?
           ActiveRecordData.raw_6_0_multi
         elsif activerecord_5_2?
           ActiveRecordData.raw_5_2_multi
@@ -192,7 +198,7 @@ RSpec.describe 'AmazingPrint/ActiveRecord', skip: -> { !ExtVerifier.has_rails? }
           end
         end
 
-      if RUBY_PLATFORM == 'java'
+      if RUBY_PLATFORM == 'java' && !activerecord_6_1?
         raw_object_string.gsub!(
           'ActiveRecord::ConnectionAdapters::SQLite3Adapter::SQLite3Integer',
           'ArJdbc::SQLite3::SQLite3Integer'
@@ -238,6 +244,11 @@ RSpec.describe 'AmazingPrint/ActiveRecord', skip: -> { !ExtVerifier.has_rails? }
     it 'should print ActiveRecord::Base objects (ex. ancestors)' do
       expect { @ap.awesome(User.ancestors) }.not_to raise_error
     end
+
+    it 'should print valid HTML for subclasses' do
+      @ap = AmazingPrint::Inspector.new(html: true)
+      expect(@ap.awesome(SubUser)).to match('SubUser < User')
+    end
   end
 
   #------------------------------------------------------------------------------
@@ -255,7 +266,19 @@ RSpec.describe 'AmazingPrint/ActiveRecord', skip: -> { !ExtVerifier.has_rails? }
           expect(out).to match(
             /\s+first\(\*args,\s&block\)\s+#<Class:\w+>\s+\(ActiveRecord::Querying\)/
           )
-        elsif RUBY_VERSION >= '2.4.4'
+        elsif RUBY_VERSION >= '3.0.0'
+          expect(out).to match(
+            /\s*first\(\*(\*|args),\s+&(&|block)\)\s+#<Class:User> \(ActiveRecord::Querying\)/
+          )
+        elsif RUBY_VERSION >= '2.7.2'
+          expect(out).to match(
+            /\s*first\(\*(\*|args),\s+&(&|block)\)\s+User/
+          )
+        elsif RUBY_VERSION >= '2.7.0'
+          expect(out).to match(
+            /\s*first\(\*(\*|args),\s+&(&|block)\)\s+#<Class:ActiveRecord::Base> \(ActiveRecord::Querying\)/
+          )
+        elsif RUBY_VERSION =~ /^2\.4\.([4-9]|[1-9][0-9])|^2\.[56]\./
           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\)/)
@@ -272,7 +295,13 @@ RSpec.describe 'AmazingPrint/ActiveRecord', skip: -> { !ExtVerifier.has_rails? }
         expect(out).to match(
           /\sprimary_key\(.*?\)\s+#<Class:\w+>\s\(ActiveRecord::AttributeMethods::PrimaryKey::ClassMethods\)/
         )
-      elsif RUBY_VERSION >= '2.4.4'
+      elsif RUBY_VERSION >= '3.0.0'
+        expect(out).to match(/\sprimary_key\(.*?\)\s+#<Class:User> \(ActiveRecord::AttributeMethods::PrimaryKey::ClassMethods\)/)
+      elsif RUBY_VERSION =~ /^2\.7\.(0|1)/
+        expect(out).to match(
+          /\sprimary_key\(.*?\)\s+.+Class.+\(ActiveRecord::AttributeMethods::PrimaryKey::ClassMethods\)/
+        )
+      elsif RUBY_VERSION =~ /^2\.4\.([4-9]|[1-9][0-9])|^2\.[56]\./ || RUBY_VERSION >= '2.7.2'
         expect(out).to match(/\sprimary_key\(.*?\)\s+User/)
       else
         expect(out).to match(/\sprimary_key\(.*?\)\s+Class \(ActiveRecord::AttributeMethods::PrimaryKey::ClassMethods\)/)
@@ -286,7 +315,13 @@ RSpec.describe 'AmazingPrint/ActiveRecord', skip: -> { !ExtVerifier.has_rails? }
       else
         if RUBY_PLATFORM == 'java'
           expect(out).to match(/\svalidate\(\*arg.*?\)\s+#<Class:\w+> \(ActiveModel::Validations::ClassMethods\)/)
-        elsif RUBY_VERSION >= '2.4.4'
+        elsif RUBY_VERSION >= '3.0.0'
+          expect(out).to match(/\svalidate\(\*arg.*?\)\s+#<Class:User> \(ActiveModel::Validations::ClassMethods\)/)
+        elsif RUBY_VERSION =~ /2\.7\.(0|1)/
+          expect(out).to match(
+            /\svalidate\(\*args.*?\)\s+#<Class:ActiveRecord::Base> \(ActiveModel::Validations::ClassMethods\)/
+          )
+        elsif RUBY_VERSION =~ /^2\.4\.([4-9]|[1-9][0-9])|^2\.[56]\./ || RUBY_VERSION >= '2.7.2'
           expect(out).to match(/\svalidate\(\*arg.*?\)\s+User/)
         else
           expect(out).to match(/\svalidate\(\*arg.*?\)\s+Class \(ActiveModel::Validations::ClassMethods\)/)