awesome_print 1.6.1 → 1.9.2

data/spec/ext/active_record_spec.rb

@@ -0,0 +1,260 @@
+require 'spec_helper'
+require 'active_record_helper'
+
+RSpec.describe 'AwesomePrint/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 = AwesomePrint::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
+
+			expect(RUBY_VERSION).to be >= '2.5'
+
+      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 = AwesomePrint::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 = AwesomePrint::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_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
+      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_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
+      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 = AwesomePrint::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 = AwesomePrint::Inspector.new(plain: true)
+    end
+
+    it 'should format class methods properly' do
+      # spec 1
+      out = @ap.awesome(User.methods.grep(/first/))
+
+      if RUBY_VERSION >= '3.0.0'
+        expect(out).to match(/\sfirst\(\*\*,\s&&\)/)
+      elsif RUBY_VERSION >= '2.7.0'
+        if ActiveRecord::VERSION::STRING >= '3.2'
+          expect(out).to match(/\sfirst\(\*\*,\s&&\)\s+User/)
+        else
+          expect(out).to match(/\sfirst\(\*\*,\s&&\)\s+User \(ActiveRecord::Base\)/)
+        end
+      else
+        if ActiveRecord::VERSION::STRING >= '3.2'
+          expect(out).to match(/\sfirst\(\*arg.*?\)\s+User/)
+        else
+          expect(out).to match(/\sfirst\(\*arg.*?\)\s+User \(ActiveRecord::Base\)/)
+        end
+      end
+
+      # spec 2
+      out = @ap.awesome(User.methods.grep(/primary_key/))
+      if RUBY_VERSION >= '3.0.0'
+        expect(out).to match(/\sprimary_key\(.*?\)/)
+      else
+        expect(out).to match(/\sprimary_key\(.*?\)\s+User/)
+      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_VERSION >= '3.0.0'
+          expect(out).to match(/\svalidate\(\*arg.*?\)/)
+        else
+          expect(out).to match(/\svalidate\(\*arg.*?\)\s+User/)
+        end
+      end
+
+    end
+  end
+end
+

data/spec/ext/active_support_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+RSpec.describe 'AwesomePrint::ActiveSupport', skip: -> { !ExtVerifier.has_rails? }.call do
+  before do
+    @ap = AwesomePrint::Inspector.new
+  end
+
+  it 'should format ActiveSupport::TimeWithZone as regular Time' do
+    Time.zone = 'Eastern Time (US & Canada)'
+    time = Time.utc(2007, 2, 10, 20, 30, 45).in_time_zone
+    if activerecord_6_1?
+      expect(@ap.send(:awesome, time)).to eq("\e[0;32mSat, 10 Feb 2007 15:30:45.000000000 EST -05:00\e[0m")
+    else
+      expect(@ap.send(:awesome, time)).to eq("\e[0;32mSat, 10 Feb 2007 15:30:45 EST -05:00\e[0m")
+    end
+  end
+
+  it 'should format HashWithIndifferentAccess as regular Hash' do
+    hash = HashWithIndifferentAccess.new({ hello: 'world' })
+    expect(@ap.send(:awesome, hash)).to eq("{\n    \"hello\"\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 'should formate 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

data/spec/ext/mongo_mapper_spec.rb

@@ -0,0 +1,261 @@
+require 'spec_helper'
+
+RSpec.describe 'AwesomePrint/MongoMapper', skip: -> { !ExtVerifier.has_mongo_mapper? }.call do
+  if ExtVerifier.has_mongo_mapper?
+    before :all do
+      class MongoUser
+        include MongoMapper::Document
+
+        key :first_name, String
+        key :last_name, String
+      end
+    end
+
+    after :all do
+      Object.instance_eval { remove_const :MongoUser }
+      Object.instance_eval { remove_const :Chamelion }
+    end
+  end
+
+  before do
+    @ap = AwesomePrint::Inspector.new(plain: true, sort_keys: true)
+  end
+
+  describe 'with the raw option set to true' do
+    # before { @ap.options[:raw] = true }
+    before { @ap = AwesomePrint::Inspector.new(plain: true, sort_keys: true, raw: true) }
+
+    it 'should print class instance' do
+      user = MongoUser.new(first_name: 'Al', last_name: 'Capone')
+
+      out = @ap.send(:awesome, user)
+      out.gsub!(/#\<Proc:.+?\>/, 'AWESOME_PRINT_PROC_STUB')
+      out.gsub!(/BSON::ObjectId\('[\da-f]+?'\)/, "BSON::ObjectId('123456789')")
+
+      str = if MongoMapper::Version >= '0.13'
+              <<-EOS.strip
+#<MongoUser:placeholder_id
+    @__mm_default_keys = [
+        [0] #<MongoMapper::Plugins::Keys::Key:placeholder_id
+            @dynamic = false,
+            @embeddable = false,
+            @has_default = true,
+            @is_id = true,
+            @typecast = nil,
+            attr_accessor :accessors = [],
+            attr_accessor :default = AWESOME_PRINT_PROC_STUB,
+            attr_accessor :ivar = :@_id,
+            attr_accessor :name = "_id",
+            attr_accessor :options = {
+                :default => AWESOME_PRINT_PROC_STUB
+            },
+            attr_accessor :type = ObjectId < Object
+        >
+    ],
+    @__mm_keys = {
+               "_id" => #<MongoMapper::Plugins::Keys::Key:placeholder_id
+            @dynamic = false,
+            @embeddable = false,
+            @has_default = true,
+            @is_id = true,
+            @typecast = nil,
+            attr_accessor :accessors = [],
+            attr_accessor :default = AWESOME_PRINT_PROC_STUB,
+            attr_accessor :ivar = :@_id,
+            attr_accessor :name = "_id",
+            attr_accessor :options = {
+                :default => AWESOME_PRINT_PROC_STUB
+            },
+            attr_accessor :type = ObjectId < Object
+        >,
+        "first_name" => #<MongoMapper::Plugins::Keys::Key:placeholder_id
+            @dynamic = false,
+            @embeddable = false,
+            @has_default = false,
+            @is_id = false,
+            @typecast = nil,
+            attr_accessor :accessors = [],
+            attr_accessor :ivar = :@first_name,
+            attr_accessor :name = "first_name",
+            attr_accessor :options = {},
+            attr_accessor :type = String < Object
+        >,
+         "last_name" => #<MongoMapper::Plugins::Keys::Key:placeholder_id
+            @dynamic = false,
+            @embeddable = false,
+            @has_default = false,
+            @is_id = false,
+            @typecast = nil,
+            attr_accessor :accessors = [],
+            attr_accessor :ivar = :@last_name,
+            attr_accessor :name = "last_name",
+            attr_accessor :options = {},
+            attr_accessor :type = String < Object
+        >
+    },
+    @__mm_pre_cast = {
+        "first_name" => "Al",
+         "last_name" => "Capone"
+    },
+    @_dynamic_attributes = {},
+    @_new = true,
+    attr_accessor :_id = BSON::ObjectId('123456789'),
+    attr_accessor :attributes = nil,
+    attr_accessor :first_name = "Al",
+    attr_accessor :last_name = "Capone",
+    attr_reader :changed_attributes = {
+        "first_name" => nil,
+         "last_name" => nil
+    }
+>
+              EOS
+            else
+              <<-EOS.strip
+#<MongoUser:placeholder_id
+    @_new = true,
+    attr_accessor :first_name = "Al",
+    attr_accessor :last_name = "Capone",
+    attr_reader :changed_attributes = {
+        "first_name" => nil,
+         "last_name" => nil
+    },
+    attr_reader :first_name_before_type_cast = "Al",
+    attr_reader :last_name_before_type_cast = "Capone"
+>
+              EOS
+            end
+      expect(out).to be_similar_to(str)
+    end
+
+    it 'should print the class' do
+      expect(@ap.send(:awesome, MongoUser)).to eq <<-EOS.strip
+class MongoUser < Object {
+           "_id" => :object_id,
+    "first_name" => :string,
+     "last_name" => :string
+}
+      EOS
+    end
+
+    it 'should print the class when type is undefined' do
+      class Chamelion
+        include MongoMapper::Document
+        key :last_attribute
+      end
+
+      expect(@ap.send(:awesome, Chamelion)).to eq <<-EOS.strip
+class Chamelion < Object {
+               "_id" => :object_id,
+    "last_attribute" => :undefined
+}
+      EOS
+    end
+  end
+
+  describe 'with associations' do
+
+    if ExtVerifier.has_mongo_mapper?
+      before :all do
+        class Child
+          include MongoMapper::EmbeddedDocument
+          key :data
+        end
+
+        class Sibling
+          include MongoMapper::Document
+          key :title
+        end
+
+        class Parent
+          include MongoMapper::Document
+          key :name
+
+          one :child
+          one :sibling
+        end
+      end
+    end
+
+    describe 'with show associations turned off (default)' do
+      it 'should render the class as normal' do
+        expect(@ap.send(:awesome, Parent)).to eq <<-EOS.strip
+class Parent < Object {
+     "_id" => :object_id,
+    "name" => :undefined
+}
+        EOS
+      end
+
+      it 'should render an instance as normal' do
+        parent = Parent.new(name: 'test')
+        out = @ap.send(:awesome, parent)
+        str = <<-EOS.strip
+#<Parent:placeholder_id> {
+     "_id" => placeholder_bson_id,
+    "name" => "test"
+}
+        EOS
+        expect(out).to be_similar_to(str)
+      end
+    end
+
+    describe 'with show associations turned on and inline embedded turned off' do
+      before :each do
+        @ap = AwesomePrint::Inspector.new(plain: true, mongo_mapper: { show_associations: true })
+      end
+
+      it 'should render the class with associations shown' do
+        expect(@ap.send(:awesome, Parent)).to eq <<-EOS.strip
+class Parent < Object {
+        "_id" => :object_id,
+       "name" => :undefined,
+      "child" => embeds one Child,
+    "sibling" => one Sibling
+}
+        EOS
+      end
+
+      it 'should render an instance with associations shown' do
+        parent = Parent.new(name: 'test')
+        out = @ap.send(:awesome, parent)
+        str = <<-EOS.strip
+#<Parent:placeholder_id> {
+        "_id" => placeholder_bson_id,
+       "name" => "test",
+      "child" => embeds one Child,
+    "sibling" => one Sibling
+}
+        EOS
+        expect(out).to be_similar_to(str)
+      end
+    end
+
+    describe 'with show associations turned on and inline embedded turned on' do
+      before :each do
+        @ap = AwesomePrint::Inspector.new(plain: true,
+                                          mongo_mapper: {
+          show_associations: true,
+          inline_embedded: true
+        }
+                                         )
+      end
+
+      it 'should render an instance with associations shown and embeds there' do
+        parent = Parent.new(name: 'test', child: Child.new(data: 5))
+        out = @ap.send(:awesome, parent)
+        str = <<-EOS.strip
+#<Parent:placeholder_id> {
+        "_id" => placeholder_bson_id,
+       "name" => "test",
+      "child" => embedded #<Child:placeholder_id> {
+         "_id" => placeholder_bson_id,
+        "data" => 5
+    },
+    "sibling" => one Sibling
+}
+        EOS
+        expect(out).to be_similar_to(str)
+      end
+    end
+  end
+end

data/spec/ext/mongoid_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+RSpec.describe 'AwesomePrint/Mongoid', skip: -> { !ExtVerifier.has_mongoid? }.call do
+
+  if ExtVerifier.has_mongoid?
+    before :all do
+      class MongoUser
+        include Mongoid::Document
+
+        field :first_name, type: String
+        field :last_name,  type: String
+      end
+    end
+
+    after :all do
+      Object.instance_eval { remove_const :MongoUser }
+      Object.instance_eval { remove_const :Chamelion }
+    end
+  end
+
+  before do
+    @ap = AwesomePrint::Inspector.new plain: true, sort_keys: true
+  end
+
+  it 'should print class instance' do
+    user = MongoUser.new first_name: 'Al', last_name: 'Capone'
+    out = @ap.send :awesome, user
+
+    object_id = user.id.inspect
+    str = <<-EOS.strip
+#<MongoUser:placeholder_id> {
+           :_id => #{object_id},
+    :first_name => "Al",
+     :last_name => "Capone"
+}
+    EOS
+    expect(out).to be_similar_to(str, { skip_bson: true })
+  end
+
+  it 'should print the class' do
+    class_spec = <<-EOS.strip
+class MongoUser < Object {
+           :_id => :"bson/object_id",
+    :first_name => :string,
+     :last_name => :string
+}
+                   EOS
+
+    expect(@ap.send(:awesome, MongoUser)).to eq class_spec
+  end
+
+  it 'should print the class when type is undefined' do
+    class Chamelion
+      include Mongoid::Document
+      field :last_attribute
+    end
+
+    class_spec = <<-EOS.strip
+class Chamelion < Object {
+               :_id => :"bson/object_id",
+    :last_attribute => :object
+}
+                   EOS
+
+    expect(@ap.send(:awesome, Chamelion)).to eq class_spec
+  end
+end

data/spec/ext/nobrainer_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+RSpec.describe 'AwesomePrint/NoBrainer', skip: -> { !ExtVerifier.has_nobrainer? }.call do
+
+  if ExtVerifier.has_nobrainer?
+    before :all do
+      NoBrainer.configure do |config|
+        config.app_name = 'ap_test'
+        config.environment = :test
+      end
+    end
+
+    before :all do
+      class SomeModel
+        include NoBrainer::Document
+
+        field :first_name, type: String
+        field :last_name,  type: String
+        field :some_field
+      end
+    end
+
+    after :all do
+      Object.instance_eval { remove_const :SomeModel }
+    end
+  end
+
+  before do
+    @ap = AwesomePrint::Inspector.new plain: true
+  end
+
+  it 'should print class instance' do
+    user = SomeModel.new first_name: 'Al', last_name: 'Capone'
+    out = @ap.send :awesome, user
+
+    object_id = user.id.inspect
+    str = <<-EOS.strip
+#<SomeModel id: #{object_id}> {
+            :id => #{object_id},
+    :first_name => "Al",
+     :last_name => "Capone"
+}
+    EOS
+    expect(out).to eq(str)
+  end
+
+  it 'should print the class' do
+    class_spec = <<-EOS.strip
+class SomeModel < Object {
+            :id => :string,
+    :first_name => :string,
+     :last_name => :string,
+    :some_field => :object
+}
+                   EOS
+
+    expect(@ap.send(:awesome, SomeModel)).to eq class_spec
+  end
+end