amazing_print 1.6.0 → 1.7.2

data/spec/misc_spec.rb

@@ -1,206 +0,0 @@
-# frozen_string_literal: true
-
-# rubocop:disable Lint/ConstantDefinitionInBlock, Lint/EmptyClass
-
-require 'spec_helper'
-
-RSpec.describe 'AmazingPrint' do
-  describe 'Misc' do
-    it 'handle weird objects that return nil on inspect' do
-      weird = Class.new do
-        def inspect
-          nil
-        end
-      end
-      expect(weird.new.ai(plain: true)).to eq('')
-    end
-
-    it 'handle frozen object.inspect' do
-      weird = Class.new do
-        def inspect
-          'ice'
-        end
-      end
-      expect(weird.new.ai(plain: false)).to eq('ice')
-    end
-
-    # See https://github.com/awesome-print/awesome_print/issues/35
-    it 'handle array grep when pattern contains / chapacter' do
-      hash = { '1/x' => 1, '2//x' => :'2' }
-      grepped = hash.keys.sort.grep(%r{^(\d+)/}) { Regexp.last_match(1) }
-      expect(grepped.ai(plain: true, multiline: false)).to eq('[ "1", "2" ]')
-    end
-
-    # See https://github.com/awesome-print/awesome_print/issues/85
-    it "handle array grep when a method is defined in C and thus doesn't have a binding" do
-      arr = (0..6).to_a
-      grepped = arr.grep(1..4, &:succ)
-      expect(grepped.ai(plain: true, multiline: false)).to eq('[ 2, 3, 4, 5 ]')
-    end
-
-    it 'returns value passed as a parameter' do
-      object = rand
-      allow(self).to receive(:puts)
-      expect(ap(object)).to eq(object)
-    end
-
-    # Require different file name this time (lib/ap.rb vs. lib/amazing_print).
-    it "several require 'amazing_print' should do no harm" do
-      require File.expand_path("#{File.dirname(__FILE__)}/../lib/ap")
-      expect { rand.ai }.not_to raise_error
-    end
-
-    it 'format ENV as hash' do
-      expect(ENV.ai(plain: true)).to eq(ENV.to_hash.ai(plain: true))
-      expect(ENV.ai).to eq(ENV.to_hash.ai)
-    end
-
-    # See https://github.com/awesome-print/awesome_print/issues/134
-    it 'IPAddr workaround' do
-      require 'ipaddr'
-      ipaddr = IPAddr.new('3ffe:505:2::1')
-      expect(ipaddr.ai).to eq('#<IPAddr: IPv6:3ffe:0505:0002:0000:0000:0000:0000:0001/ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff>')
-    end
-
-    # See https://github.com/awesome-print/awesome_print/issues/139
-    it 'Object that overrides == and expects the :id method' do
-      weird = Class.new do
-        # Raises NoMethodError: undefined method `id' when "other" is nil or ENV.
-        def ==(other)
-          id == other.id
-        end
-        alias_method :eql?, :==
-      end
-      expect { weird.new.ai }.not_to raise_error
-    end
-  end
-
-  #------------------------------------------------------------------------------
-  describe 'HTML output' do
-    it 'wraps ap output with plain <pre> tag' do
-      markup = rand
-      expect(markup.ai(html: true, plain: true)).to eq("<pre>#{markup}</pre>")
-    end
-
-    it 'wraps ap output with <pre> tag with colorized <kbd>' do
-      markup = rand
-      expect(markup.ai(html: true)).to eq(%(<pre><kbd style="color:blue">#{markup}</kbd></pre>))
-    end
-
-    it 'wraps multiline ap output with <pre> tag with colorized <kbd>' do
-      markup = [1, :two, 'three']
-      expect(markup.ai(html: true)).to eq <<~EOS.strip
-        <pre>[
-            <kbd style="color:white">[0] </kbd><kbd style="color:blue">1</kbd>,
-            <kbd style="color:white">[1] </kbd><kbd style="color:darkcyan">:two</kbd>,
-            <kbd style="color:white">[2] </kbd><kbd style="color:brown">&quot;three&quot;</kbd>
-        ]</pre>
-      EOS
-    end
-
-    it 'wraps hash ap output with only an outer <pre> tag' do
-      markup = [{ 'hello' => 'world' }]
-      expect(markup.ai(html: true)).to eq <<~EOS.strip
-        <pre>[
-            <kbd style="color:white">[0] </kbd>{
-                <kbd style="color:brown">&quot;hello&quot;</kbd><kbd style="color:slategray"> =&gt; </kbd><kbd style="color:brown">&quot;world&quot;</kbd>
-            }
-        ]</pre>
-      EOS
-    end
-
-    it 'encodes HTML entities (plain)' do
-      markup = ' &<hello>'
-      expect(markup.ai(html: true, plain: true)).to eq('<pre>&quot; &amp;&lt;hello&gt;&quot;</pre>')
-    end
-
-    it 'encodes HTML entities (color)' do
-      markup = ' &<hello>'
-      expect(markup.ai(html: true)).to eq('<pre><kbd style="color:brown">&quot; &amp;&lt;hello&gt;&quot;</kbd></pre>')
-    end
-  end
-
-  #------------------------------------------------------------------------------
-  describe 'AmazingPrint.defaults' do
-    after do
-      AmazingPrint.defaults = nil
-    end
-
-    # See https://github.com/awesome-print/awesome_print/issues/98
-    it 'properlies merge the defaults' do
-      AmazingPrint.defaults = { indent: -2, sort_keys: true }
-      hash = { [0, 0, 255] => :yellow, :red => 'rgb(255, 0, 0)', 'magenta' => 'rgb(255, 0, 255)' }
-      out = hash.ai(plain: true)
-      expect(out).to eq <<~EOS.strip
-        {
-          [ 0, 0, 255 ] => :yellow,
-          "magenta"     => "rgb(255, 0, 255)",
-          :red          => "rgb(255, 0, 0)"
-        }
-      EOS
-    end
-  end
-
-  #------------------------------------------------------------------------------
-  describe 'Console' do
-    it 'detects IRB' do
-      class IRB; end
-      ENV.delete('RAILS_ENV')
-      expect(AmazingPrint.console?).to be(true)
-      expect(AmazingPrint.rails_console?).to be(false)
-      Object.instance_eval { remove_const :IRB }
-    end
-
-    it 'detects Pry' do
-      class Pry; end
-      ENV.delete('RAILS_ENV')
-      expect(AmazingPrint.console?).to be(true)
-      expect(AmazingPrint.rails_console?).to be(false)
-      Object.instance_eval { remove_const :Pry }
-    end
-
-    it 'detects Rails::Console' do
-      class IRB; end
-
-      module Rails; class Console; end; end
-      expect(AmazingPrint.console?).to be(true)
-      expect(AmazingPrint.rails_console?).to be(true)
-      Object.instance_eval { remove_const :IRB }
-      Object.instance_eval { remove_const :Rails }
-    end
-
-    it "detects ENV['RAILS_ENV']" do
-      class Pry; end
-      ENV['RAILS_ENV'] = 'development'
-      expect(AmazingPrint.console?).to be(true)
-      expect(AmazingPrint.rails_console?).to be(true)
-      Object.instance_eval { remove_const :Pry }
-    end
-
-    it 'returns the actual object when *not* running under console' do
-      expect(capture! { ap([1, 2, 3]) }).to eq([1, 2, 3])
-      expect(capture! { ap({ a: 1 }) }).to eq({ a: 1 })
-    end
-
-    it 'returns nil when running under console' do
-      class IRB; end
-      expect(capture! { ap([1, 2, 3]) }).to be_nil
-      expect(capture! { ap({ a: 1 }) }).to be_nil
-      Object.instance_eval { remove_const :IRB }
-    end
-
-    it 'handles NoMethodError on IRB implicit #ai' do
-      module IRB; class Irb; end; end
-      irb_context = double('irb_context', last_value: BasicObject.new)
-      IRB.define_singleton_method :version, -> { 'test_version' }
-      irb = IRB::Irb.new
-      irb.instance_eval { @context = irb_context }
-      AmazingPrint.irb!
-      expect(irb).to receive(:puts).with("(Object doesn't support #ai)")
-      expect { irb.output_value }.not_to raise_error
-      Object.instance_eval { remove_const :IRB }
-    end
-  end
-end
-
-# rubocop:enable Lint/ConstantDefinitionInBlock, Lint/EmptyClass

data/spec/objects_spec.rb

@@ -1,225 +0,0 @@
-# frozen_string_literal: true
-
-# rubocop:disable Lint/ConstantDefinitionInBlock
-
-require 'spec_helper'
-
-RSpec.describe 'Objects' do
-  after do
-    Object.instance_eval { remove_const :Hello } if defined?(Hello)
-  end
-
-  describe 'Formatting an object' do
-    it 'attributes' do
-      class Hello
-        attr_reader   :abra
-        attr_writer   :ca
-        attr_accessor :dabra
-
-        def initialize
-          @abra = 1
-          @ca = 2
-          @dabra = 3
-        end
-      end
-
-      hello = Hello.new
-      out = hello.ai(plain: true, raw: true)
-      str = <<~EOS.strip
-        #<Hello:placeholder_id
-            attr_accessor :dabra = 3,
-            attr_reader :abra = 1,
-            attr_writer :ca = 2
-        >
-      EOS
-      expect(out).to be_similar_to(str)
-      expect(hello.ai(plain: true, raw: false)).to eq(hello.inspect)
-    end
-
-    it 'instance variables' do
-      class Hello
-        def initialize
-          @abra = 1
-          @ca = 2
-          @dabra = 3
-        end
-      end
-
-      hello = Hello.new
-      out = hello.ai(plain: true, raw: true)
-      str = <<~EOS.strip
-        #<Hello:placeholder_id
-            @abra = 1,
-            @ca = 2,
-            @dabra = 3
-        >
-      EOS
-      expect(out).to be_similar_to(str)
-      expect(hello.ai(plain: true, raw: false)).to eq(hello.inspect)
-    end
-
-    it 'attributes and instance variables' do
-      class Hello
-        attr_reader   :abra
-        attr_writer   :ca
-        attr_accessor :dabra
-
-        def initialize
-          @abra = 1
-          @ca = 2
-          @dabra = 3
-          @scooby = 3
-          @dooby = 2
-          @doo = 1
-        end
-      end
-
-      hello = Hello.new
-      out = hello.ai(plain: true, raw: true)
-      str = <<~EOS.strip
-        #<Hello:placeholder_id
-            @doo = 1,
-            @dooby = 2,
-            @scooby = 3,
-            attr_accessor :dabra = 3,
-            attr_reader :abra = 1,
-            attr_writer :ca = 2
-        >
-      EOS
-      expect(out).to be_similar_to(str)
-      expect(hello.ai(plain: true, raw: false)).to eq(hello.inspect)
-    end
-
-    it 'without the plain options print the colorized values' do
-      class Hello
-        attr_reader   :abra
-        attr_writer   :ca
-
-        def initialize
-          @abra = 1
-          @ca = 2
-          @dabra = 3
-        end
-      end
-
-      hello = Hello.new
-      out = hello.ai(raw: true)
-      str = <<~EOS.strip
-        #<Hello:placeholder_id
-            \e[0;36m@dabra\e[0m\e[0;37m = \e[0m\e[1;34m3\e[0m,
-            \e[1;36mattr_reader\e[0m \e[0;35m:abra\e[0m\e[0;37m = \e[0m\e[1;34m1\e[0m,
-            \e[1;36mattr_writer\e[0m \e[0;35m:ca\e[0m\e[0;37m = \e[0m\e[1;34m2\e[0m
-        >
-      EOS
-      expect(out).to be_similar_to(str)
-      expect(hello.ai(plain: true, raw: false)).to eq(hello.inspect)
-    end
-
-    it 'with multine as false show inline values' do
-      class Hello
-        attr_reader   :abra
-        attr_writer   :ca
-
-        def initialize
-          @abra = 1
-          @ca = 2
-          @dabra = 3
-        end
-      end
-
-      hello = Hello.new
-      out = hello.ai(multiline: false, plain: true, raw: true)
-      str = <<~EOS.strip
-        #<Hello:placeholder_id @dabra = 3, attr_reader :abra = 1, attr_writer :ca = 2>
-      EOS
-      expect(out).to be_similar_to(str)
-      expect(hello.ai(plain: true, raw: false)).to eq(hello.inspect)
-    end
-
-    it 'without the sort_vars option does not sort instance variables' do
-      class Hello
-        attr_reader   :abra
-        attr_writer   :ca
-        attr_accessor :dabra
-
-        def initialize
-          @abra = 1
-          @ca = 2
-          @dabra = 3
-          @scooby = 3
-          @dooby = 2
-          @doo = 1
-        end
-
-        def instance_variables
-          %i[@scooby @dooby @doo @abra @ca @dabra]
-        end
-      end
-
-      hello = Hello.new
-      out = hello.ai(plain: true, raw: true, sort_vars: false)
-      str = <<~EOS.strip
-        #<Hello:placeholder_id
-            @scooby = 3,
-            @dooby = 2,
-            @doo = 1,
-            attr_reader :abra = 1,
-            attr_writer :ca = 2,
-            attr_accessor :dabra = 3
-        >
-      EOS
-      expect(out).to be_similar_to(str)
-      expect(hello.ai(plain: true, raw: false)).to eq(hello.inspect)
-    end
-
-    it 'object_id' do
-      class Hello
-        def initialize
-          @abra = 1
-          @ca = 2
-          @dabra = 3
-        end
-      end
-
-      hello = Hello.new
-      out = hello.ai(plain: true, raw: true, object_id: false)
-      str = <<~EOS.strip
-        #<Hello
-            @abra = 1,
-            @ca = 2,
-            @dabra = 3
-        >
-      EOS
-      expect(out).to be_similar_to(str)
-      expect(hello.ai(plain: true, raw: false)).to eq(hello.inspect)
-    end
-
-    it 'class_name' do
-      class Hello
-        def initialize
-          @abra = 1
-          @ca = 2
-          @dabra = 3
-        end
-
-        def to_s
-          'CustomizedHello'
-        end
-      end
-
-      hello = Hello.new
-      out = hello.ai(plain: true, raw: true, class_name: :to_s)
-      str = <<~EOS.strip
-        #<CustomizedHello:placeholder_id
-            @abra = 1,
-            @ca = 2,
-            @dabra = 3
-        >
-      EOS
-      expect(out).to be_similar_to(str)
-      expect(hello.ai(plain: true, raw: false)).to eq(hello.inspect)
-    end
-  end
-end
-
-# rubocop:enable Lint/ConstantDefinitionInBlock

data/spec/sequel_helper.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-if ExtVerifier.has_sequel?
-  # Establish connection to in-memory SQLite DB
-  DB = RUBY_PLATFORM == 'java' ? Sequel.connect('jdbc:sqlite::memory:') : Sequel.sqlite
-
-  # Create the users table
-  DB.create_table :sequel_users do
-    primary_key :id
-    String :first_name
-    String :last_name
-    TrueClass :admin
-    DateTime :created_at
-  end
-
-  # Create models
-  class SequelUser < Sequel::Model; end
-end

data/spec/spec_helper.rb

@@ -1,112 +0,0 @@
-# frozen_string_literal: true
-
-# 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
-#------------------------------------------------------------------------------
-#
-# Running specs from the command line:
-#   $ rake spec                   # Entire spec suite.
-#   $ rspec spec/objects_spec.rb  # Individual spec file.
-#
-# NOTE: To successfully run specs with Ruby 1.8.6 the older versions of
-# Bundler and RSpec gems are required:
-#
-# $ gem install bundler -v=1.0.2
-# $ gem install rspec -v=2.6.0
-#
-
-# require 'simplecov'
-# SimpleCov.start
-
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].sort.each do |file|
-  require file
-end
-
-ExtVerifier.require_dependencies!(
-  %w[
-    rails
-    active_record
-    action_controller
-    action_view
-    active_support/all
-    mongoid
-    mongo_mapper
-    ripple nobrainer
-    ostruct
-    sequel
-  ]
-)
-require 'nokogiri' unless RUBY_PLATFORM.include?('mswin')
-require 'amazing_print'
-
-RSpec.configure do |config|
-  config.disable_monkey_patching!
-  # TODO: Make specs not order dependent
-  # config.order = :random
-  Kernel.srand config.seed
-  config.filter_run focus: true
-  config.run_all_when_everything_filtered = true
-  config.expect_with :rspec do |expectations|
-    expectations.syntax = :expect
-  end
-  config.mock_with :rspec do |mocks|
-    mocks.syntax = :expect
-    mocks.verify_partial_doubles = true
-  end
-
-  config.default_formatter = 'doc' if config.files_to_run.one?
-
-  # Run before all examples. Using suite or all will not work as stubs are
-  # killed after each example ends.
-  config.before do |_example|
-    stub_dotfile!
-  end
-
-  if RUBY_PLATFORM.include?('mswin')
-    config.filter_run_excluding unix: true
-  else
-    config.filter_run_excluding mswin: true
-  end
-end
-
-# This matcher handles the normalization of objects to replace non deterministic
-# parts (such as object IDs) with simple placeholder strings before doing a
-# comparison with a given string. It's important that this method only matches
-# a string which strictly conforms to the expected object ID format.
-RSpec::Matchers.define :be_similar_to do |expected, options|
-  match do |actual|
-    options ||= {}
-    @actual = normalize_object_id_strings(actual, options)
-    values_match? expected, @actual
-  end
-
-  diffable
-end
-
-# Override the Object IDs with a placeholder so that we are only checking
-# that an ID is present and not that it matches a certain value. This is
-# necessary as the Object IDs are not deterministic.
-def normalize_object_id_strings(str, options)
-  str = str.gsub(/#<(.*?):0x[a-f\d]+/, '#<\1:placeholder_id') unless options[:skip_standard]
-  str = str.gsub(/BSON::ObjectId\('[a-f\d]{24}'\)/, 'placeholder_bson_id') unless options[:skip_bson]
-  str
-end
-
-def stub_dotfile!
-  allow_any_instance_of(AmazingPrint::Inspector)
-    .to receive(:load_dotfile)
-    .and_return(true)
-end
-
-def capture!
-  standard = $stdout
-  $stdout = StringIO.new
-  yield
-ensure
-  $stdout = standard
-end

data/spec/support/active_record_data/3_2_diana.txt

@@ -1,24 +0,0 @@
-#<User:placeholder_id
-    @aggregation_cache = {},
-    @attributes_cache = {},
-    @destroyed = false,
-    @marked_for_destruction = false,
-    @mass_assignment_options = nil,
-    @new_record = true,
-    @previously_changed = {},
-    @readonly = false,
-    attr_accessor :attributes = {
-             "admin" => false,
-        "created_at" => "1992-10-10 12:30:00",
-                "id" => nil,
-              "name" => "Diana",
-              "rank" => 1
-    },
-    attr_reader :association_cache = {},
-    attr_reader :changed_attributes = {
-             "admin" => nil,
-        "created_at" => nil,
-              "name" => nil,
-              "rank" => nil
-    }
->

data/spec/support/active_record_data/3_2_diana_legacy.txt

@@ -1,24 +0,0 @@
-#<User:placeholder_id
-    @aggregation_cache = {},
-    @attributes_cache = {},
-    @destroyed = false,
-    @marked_for_destruction = false,
-    @new_record = true,
-    @previously_changed = {},
-    @readonly = false,
-    attr_accessor :attributes = {
-             "admin" => false,
-        "created_at" => "1992-10-10 12:30:00",
-                "id" => nil,
-              "name" => "Diana",
-              "rank" => 1
-    },
-    attr_reader :association_cache = {},
-    attr_reader :changed_attributes = {
-             "admin" => nil,
-        "created_at" => nil,
-              "name" => nil,
-              "rank" => nil
-    },
-    attr_reader :mass_assignment_options = nil
->

data/spec/support/active_record_data/3_2_multi.txt

@@ -1,50 +0,0 @@
-[
-    [0] #<User:placeholder_id
-        @aggregation_cache = {},
-        @attributes_cache = {},
-        @destroyed = false,
-        @marked_for_destruction = false,
-        @mass_assignment_options = nil,
-        @new_record = true,
-        @previously_changed = {},
-        @readonly = false,
-        attr_accessor :attributes = {
-                 "admin" => false,
-            "created_at" => "1992-10-10 12:30:00",
-                    "id" => nil,
-                  "name" => "Diana",
-                  "rank" => 1
-        },
-        attr_reader :association_cache = {},
-        attr_reader :changed_attributes = {
-                 "admin" => nil,
-            "created_at" => nil,
-                  "name" => nil,
-                  "rank" => nil
-        }
-    >,
-    [1] #<User:placeholder_id
-        @aggregation_cache = {},
-        @attributes_cache = {},
-        @destroyed = false,
-        @marked_for_destruction = false,
-        @mass_assignment_options = nil,
-        @new_record = true,
-        @previously_changed = {},
-        @readonly = false,
-        attr_accessor :attributes = {
-                 "admin" => true,
-            "created_at" => "2003-05-26 14:15:00",
-                    "id" => nil,
-                  "name" => "Laura",
-                  "rank" => 2
-        },
-        attr_reader :association_cache = {},
-        attr_reader :changed_attributes = {
-                 "admin" => nil,
-            "created_at" => nil,
-                  "name" => nil,
-                  "rank" => nil
-        }
-    >
-]