amazing_print 1.6.0 → 1.7.2

data/spec/colors_spec.rb

@@ -1,120 +0,0 @@
-# frozen_string_literal: true
-
-# rubocop:disable Lint/ConstantDefinitionInBlock, Style/OptionalBooleanParameter
-
-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 ] ] ]'
-    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
-        AmazingPrint.force_colors! 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
-        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
-        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
-        stub_tty! false
-        expect(@arr.ai(multiline: false)).to eq(PLAIN)
-      ensure
-        stub_tty!
-      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
-        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
-        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
-        stub_tty! false
-        expect(@arr.ai(multiline: false)).to eq(COLORIZED)
-      ensure
-        stub_tty!
-      end
-    end
-  end
-
-  describe 'AmazingPrint::Colors' do
-    %i[gray red green yellow blue purple cyan white].each_with_index do |color, i|
-      it "has #{color} color" do
-        expect(AmazingPrint::Colors.public_send(color, color.to_s)).to eq("\e[1;#{i + 30}m#{color}\e[0m")
-      end
-
-      it "has #{color}ish color" do
-        expect(AmazingPrint::Colors.public_send(:"#{color}ish", color.to_s)).to eq("\e[0;#{i + 30}m#{color}\e[0m")
-      end
-    end
-  end
-end
-
-# rubocop:enable Lint/ConstantDefinitionInBlock, Style/OptionalBooleanParameter

data/spec/core_ext/logger_spec.rb

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-require 'logger'
-require 'amazing_print/core_ext/logger'
-
-RSpec.describe 'AmazingPrint logging extensions' do
-  subject(:logger) do
-    Logger.new('/dev/null')
-  rescue Errno::ENOENT
-    Logger.new('nul')
-  end
-
-  let(:object) { double }
-  let(:options) { { sort_keys: true } }
-
-  describe 'ap method' do
-    it 'awesome_inspects the given object' do
-      expect(object).to receive(:ai)
-      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
-      before do
-        AmazingPrint.defaults = {}
-      end
-
-      it 'fallbacks to the default :debug log level' do
-        expect(logger).to receive(:debug)
-        logger.ap nil
-      end
-
-      it 'uses the global user default if no level passed' do
-        AmazingPrint.defaults = { log_level: :info }
-        expect(logger).to receive(:info)
-        logger.ap nil
-      end
-
-      it 'uses the passed in level' do
-        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
-end

data/spec/ext/action_controller_spec.rb

@@ -1,40 +0,0 @@
-# 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 'formats 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
-        {
-            \e[0;33m"post"\e[0m\e[0;37m => \e[0m{
-                     \e[0;33m"id"\e[0m\e[0;37m => \e[0m\e[1;34m1\e[0m,
-                \e[0;33m"content"\e[0m\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 'formats 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,24 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-RSpec.describe 'AmazingPrint ActionView extensions',
-               skip: -> { !ExtVerifier.has_rails? || ActiveRecord::VERSION::STRING >= '6.1' }.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
-
-  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

@@ -1,37 +0,0 @@
-# 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 'formats 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,302 +0,0 @@
-# frozen_string_literal: true
-
-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
-      str.sub!('?', '1992-10-10 12:30:00 UTC')
-      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
-      str.sub!('??', '1992-10-10 12:30:00 UTC')
-      str.sub!('?!', '2003-05-26 14:15:00 UTC')
-      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
-      str.sub!('??', '1992-10-10 12:30:00 UTC')
-      str.sub!('?!', '2003-05-26 14:15:00 UTC')
-      expect(out).to be_similar_to(str)
-    end
-  end
-
-  describe 'Linked records (joins)' do
-    before do
-      @ap = AmazingPrint::Inspector.new(plain: true)
-    end
-
-    it 'shows 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_7_0?
-          ActiveRecordData.raw_7_0_diana
-        elsif 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
-        elsif activerecord_5_1?
-          ActiveRecordData.raw_5_1_diana
-        elsif activerecord_5_0?
-          ActiveRecordData.raw_5_0_diana
-        elsif activerecord_4_2?
-          ActiveRecordData.raw_4_2_diana
-        elsif activerecord_4_1?
-          ActiveRecordData.raw_4_1_diana
-        elsif activerecord_4_0?
-          ActiveRecordData.raw_4_0_diana
-        elsif activerecord_3_2?
-          ActiveRecordData.raw_3_2_diana
-        end
-
-      if RUBY_PLATFORM == 'java' && !activerecord_6_1?
-        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_7_0?
-          ActiveRecordData.raw_7_0_multi
-        elsif 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
-        elsif activerecord_5_1?
-          ActiveRecordData.raw_5_1_multi
-        elsif activerecord_5_0?
-          ActiveRecordData.raw_5_0_multi
-        elsif activerecord_4_2?
-          ActiveRecordData.raw_4_2_multi
-        elsif activerecord_4_1?
-          ActiveRecordData.raw_4_1_multi
-        elsif activerecord_4_0?
-          ActiveRecordData.raw_4_0_multi
-        elsif activerecord_3_2?
-          ActiveRecordData.raw_3_2_multi
-        end
-
-      if RUBY_PLATFORM == 'java' && !activerecord_6_1?
-        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 'prints 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 'prints 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 'prints ActiveRecord::Base objects (ex. ancestors)' do
-      expect { @ap.awesome(User.ancestors) }.not_to raise_error
-    end
-
-    it 'prints valid HTML for subclasses' do
-      @ap = AmazingPrint::Inspector.new(html: true)
-      expect(@ap.awesome(SubUser)).to match('SubUser &lt; User')
-    end
-  end
-
-  #------------------------------------------------------------------------------
-  describe 'ActiveRecord methods formatting' do
-    before do
-      @ap = AmazingPrint::Inspector.new(plain: true)
-    end
-
-    it 'formats 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 Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.1.0')
-          expect(out).to match(
-            /\s*first\(\*(\*|args),\s+\?,\s+&(&|block)\)\s+#<Class:User> \(ActiveRecord::Querying\)/
-          )
-        elsif Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.0.0')
-          expect(out).to match(
-            /\s*first\(\*(\*|args),\s+&(&|block)\)\s+#<Class:User> \(ActiveRecord::Querying\)/
-          )
-        elsif Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.7.2')
-          expect(out).to match(
-            /\s*first\(\*(\*|args),\s+&(&|block)\)\s+User/
-          )
-        elsif Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.6.7')
-          expect(out).to match(
-            /\s*first\(\*(\*|args),\s+&(&|block)\)\s+#<Class:ActiveRecord::Base> \(ActiveRecord::Querying\)/
-          )
-        elsif Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.4.4')
-          expect(out).to match(/\sfirst\(\*arg.*?\)\s+User/)
-        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 Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.0.0')
-        expect(out).to match(/\sprimary_key\(.*?\)\s+#<Class:User> \(ActiveRecord::AttributeMethods::PrimaryKey::ClassMethods\)/)
-      elsif Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.6.7') && Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.7.0')
-        expect(out).to match(/\sprimary_key\(.*?\)\s+#<Class:ActiveRecord::Base> \(ActiveRecord::AttributeMethods::PrimaryKey::ClassMethods\)/)
-      elsif Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.4.4') || Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.7.2')
-        expect(out).to match(/\sprimary_key\(.*?\)\s+User/)
-      elsif Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.7.0')
-        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\)/)
-      elsif RUBY_PLATFORM == 'java'
-        expect(out).to match(/\svalidate\(\*arg.*?\)\s+#<Class:\w+> \(ActiveModel::Validations::ClassMethods\)/)
-      elsif Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.0.0')
-        expect(out).to match(/\svalidate\(\*arg.*?\)\s+#<Class:User> \(ActiveModel::Validations::ClassMethods\)/)
-      elsif (Gem::Version.new('2.6.7')..Gem::Version.new('2.7.1')).cover? Gem::Version.new(RUBY_VERSION)
-        expect(out).to match(
-          /\svalidate\(\*args.*?\)\s+#<Class:ActiveRecord::Base> \(ActiveModel::Validations::ClassMethods\)/
-        )
-      elsif Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.4.4') || Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.7.2')
-        expect(out).to match(/\svalidate\(\*arg.*?\)\s+User/)
-      end
-    end
-  end
-end

data/spec/ext/active_support_spec.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-RSpec.describe 'AmazingPrint::ActiveSupport', skip: -> { !ExtVerifier.has_rails? }.call do
-  let(:expected_ar_time_str) do
-    if activerecord_6_1? || activerecord_7_0?
-      '15:30:45.000000000'
-    else
-      '15:30:45'
-    end
-  end
-
-  before do
-    @ap = AmazingPrint::Inspector.new
-  end
-
-  it 'formats ActiveSupport::TimeWithZone as regular Time' do
-    Time.zone = 'Eastern Time (US & Canada)'
-    time = Time.utc(2007, 2, 10, 20, 30, 45).in_time_zone
-    expect(@ap.send(:awesome, time))
-      .to eq("\e[0;32mSat, 10 Feb 2007 #{expected_ar_time_str} EST -05:00\e[0m")
-  end
-
-  it 'formats HashWithIndifferentAccess as regular Hash' do
-    hash = HashWithIndifferentAccess.new({ hello: 'world' })
-    expect(@ap.send(:awesome, hash)).to eq("{\n    \e[0;33m\"hello\"\e[0m\e[0;37m => \e[0m\e[0;33m\"world\"\e[0m\n}")
-  end
-
-  # ActiveSupport sticks in instance variables to the date object. Make sure
-  # we ignore that and format Date instance as regular date.
-  it 'formates Date object as date' do
-    date = Date.new(2003, 5, 26)
-    expect(date.ai(plain: true)).to eq('Mon, 26 May 2003')
-    expect(date.ai).to eq("\e[0;32mMon, 26 May 2003\e[0m")
-  end
-end