awesome_print 1.2.0 → 1.9.2

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2013 Michael Dvorkin
+# Copyright (c) 2010-2016 Michael Dvorkin and contributors
 #
 # Awesome Print is freely distributable under the terms of MIT license.
 # See LICENSE file or http://www.opensource.org/licenses/mit-license.php
@@ -14,51 +14,89 @@
 # $ 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'].each do |file|
+  require file
+end
+
+ExtVerifier.require_dependencies!(
+  %w(
+    rails
+    active_record
+    action_view
+    active_support/all
+    mongoid
+    mongo_mapper
+    ripple nobrainer
+  )
+)
+require 'nokogiri'
+require 'ostruct'
 require 'awesome_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(:each) do |_example|
+    stub_dotfile!
+  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!
-  dotfile = File.join(ENV["HOME"], ".aprc")
-  File.should_receive(:readable?).at_least(:once).with(dotfile).and_return(false)
+  allow_any_instance_of(AwesomePrint::Inspector)
+    .to receive(:load_dotfile)
+    .and_return(true)
 end
 
 def capture!
-  standard, $stdout = $stdout, StringIO.new
+  standard = $stdout
+  $stdout = StringIO.new
   yield
 ensure
   $stdout = standard
 end
-
-# The following is needed for the Infinity Test. It runs tests as subprocesses,
-# which sets STDOUT.tty? to false and would otherwise prematurely disallow colors.
-### AwesomePrint.force_colors!
-
-# Ruby 1.8.6 only: define missing String methods that are needed for the specs to pass.
-if RUBY_VERSION < '1.8.7'
-  class String
-    def shellescape # Taken from Ruby 1.9.2 standard library, see lib/shellwords.rb.
-      return "''" if self.empty?
-      str = self.dup
-      str.gsub!(/([^A-Za-z0-9_\-.,:\/@\n])/n, "\\\\\\1")
-      str.gsub!(/\n/, "'\n'")
-      str
-    end
-
-    def start_with?(*prefixes)
-      prefixes.each do |prefix|
-        prefix = prefix.to_s
-        return true if prefix == self[0, prefix.size]
-      end
-      false
-    end
-
-    def end_with?(*suffixes)
-      suffixes.each do |suffix|
-        suffix = suffix.to_s
-        return true if suffix == self[-suffix.size, suffix.size]
-      end
-      false
-    end
-  end
-end

data/spec/support/active_record_data.rb

@@ -0,0 +1,20 @@
+require 'pathname'
+
+class ActiveRecordData
+  class << self
+    data_file_selector = Pathname(File.dirname(__FILE__)).join('active_record_data', '*.txt')
+
+    # Example generated method
+    # data_filename = '/path/to/ap/spec/support/active_record_data/4_2_diana.txt'
+    #
+    # def self.raw_4_2_dana
+    #   File.read(data_filename).strip
+    # end
+    Dir[data_file_selector].each do |data_filename|
+      method_name = Pathname(data_filename).basename('.txt')
+      define_method(:"raw_#{method_name}") do
+        File.read(data_filename).strip
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+#<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

@@ -0,0 +1,24 @@
+#<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

@@ -0,0 +1,50 @@
+[
+    [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
+        }
+    >
+]

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

@@ -0,0 +1,50 @@
+[
+    [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
+    >,
+    [1] #<User:placeholder_id
+        @aggregation_cache = {},
+        @attributes_cache = {},
+        @destroyed = false,
+        @marked_for_destruction = false,
+        @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
+        },
+        attr_reader :mass_assignment_options = nil
+    >
+]

data/spec/support/active_record_data/4_0_diana.txt

@@ -0,0 +1,98 @@
+#<User:placeholder_id
+    @_start_transaction_state = {},
+    @aggregation_cache = {},
+    @attributes_cache = {},
+    @column_types = {
+             "admin" => #<ActiveRecord::ConnectionAdapters::SQLite3Column:placeholder_id
+            attr_accessor :coder = nil,
+            attr_accessor :primary = false,
+            attr_reader :default = nil,
+            attr_reader :default_function = nil,
+            attr_reader :limit = nil,
+            attr_reader :name = "admin",
+            attr_reader :null = true,
+            attr_reader :precision = nil,
+            attr_reader :scale = nil,
+            attr_reader :sql_type = "boolean",
+            attr_reader :type = :boolean
+        >,
+        "created_at" => #<ActiveRecord::ConnectionAdapters::SQLite3Column:placeholder_id
+            attr_accessor :coder = nil,
+            attr_accessor :primary = false,
+            attr_reader :default = nil,
+            attr_reader :default_function = nil,
+            attr_reader :limit = nil,
+            attr_reader :name = "created_at",
+            attr_reader :null = true,
+            attr_reader :precision = nil,
+            attr_reader :scale = nil,
+            attr_reader :sql_type = "datetime",
+            attr_reader :type = :datetime
+        >,
+                "id" => #<ActiveRecord::ConnectionAdapters::SQLite3Column:placeholder_id
+            attr_accessor :coder = nil,
+            attr_accessor :primary = true,
+            attr_reader :default = nil,
+            attr_reader :default_function = nil,
+            attr_reader :limit = nil,
+            attr_reader :name = "id",
+            attr_reader :null = false,
+            attr_reader :precision = nil,
+            attr_reader :scale = nil,
+            attr_reader :sql_type = "INTEGER",
+            attr_reader :type = :integer
+        >,
+              "name" => #<ActiveRecord::ConnectionAdapters::SQLite3Column:placeholder_id
+            attr_accessor :coder = nil,
+            attr_accessor :primary = false,
+            attr_reader :default = nil,
+            attr_reader :default_function = nil,
+            attr_reader :limit = 255,
+            attr_reader :name = "name",
+            attr_reader :null = true,
+            attr_reader :precision = nil,
+            attr_reader :scale = nil,
+            attr_reader :sql_type = "varchar(255)",
+            attr_reader :type = :string
+        >,
+              "rank" => #<ActiveRecord::ConnectionAdapters::SQLite3Column:placeholder_id
+            attr_accessor :coder = nil,
+            attr_accessor :primary = false,
+            attr_reader :default = nil,
+            attr_reader :default_function = nil,
+            attr_reader :limit = nil,
+            attr_reader :name = "rank",
+            attr_reader :null = true,
+            attr_reader :precision = nil,
+            attr_reader :scale = nil,
+            attr_reader :sql_type = "integer",
+            attr_reader :type = :integer
+        >
+    },
+    @column_types_override = nil,
+    @destroyed = false,
+    @marked_for_destruction = false,
+    @new_record = true,
+    @previously_changed = {},
+    @readonly = false,
+    @reflects_state = [
+        [0] false
+    ],
+    @transaction_state = nil,
+    @txn = nil,
+    attr_accessor :attributes = {
+             "admin" => false,
+        "created_at" => "1992-10-10 12:30:00",
+                "id" => nil,
+              "name" => "Diana",
+              "rank" => 1
+    },
+    attr_accessor :destroyed_by_association = nil,
+    attr_reader :association_cache = {},
+    attr_reader :changed_attributes = {
+             "admin" => nil,
+        "created_at" => nil,
+              "name" => nil,
+              "rank" => nil
+    }
+>

data/spec/support/active_record_data/4_0_multi.txt

@@ -0,0 +1,198 @@
+[
+    [0] #<User:placeholder_id
+        @_start_transaction_state = {},
+        @aggregation_cache = {},
+        @attributes_cache = {},
+        @column_types = {
+                 "admin" => #<ActiveRecord::ConnectionAdapters::SQLite3Column:placeholder_id
+                attr_accessor :coder = nil,
+                attr_accessor :primary = false,
+                attr_reader :default = nil,
+                attr_reader :default_function = nil,
+                attr_reader :limit = nil,
+                attr_reader :name = "admin",
+                attr_reader :null = true,
+                attr_reader :precision = nil,
+                attr_reader :scale = nil,
+                attr_reader :sql_type = "boolean",
+                attr_reader :type = :boolean
+            >,
+            "created_at" => #<ActiveRecord::ConnectionAdapters::SQLite3Column:placeholder_id
+                attr_accessor :coder = nil,
+                attr_accessor :primary = false,
+                attr_reader :default = nil,
+                attr_reader :default_function = nil,
+                attr_reader :limit = nil,
+                attr_reader :name = "created_at",
+                attr_reader :null = true,
+                attr_reader :precision = nil,
+                attr_reader :scale = nil,
+                attr_reader :sql_type = "datetime",
+                attr_reader :type = :datetime
+            >,
+                    "id" => #<ActiveRecord::ConnectionAdapters::SQLite3Column:placeholder_id
+                attr_accessor :coder = nil,
+                attr_accessor :primary = true,
+                attr_reader :default = nil,
+                attr_reader :default_function = nil,
+                attr_reader :limit = nil,
+                attr_reader :name = "id",
+                attr_reader :null = false,
+                attr_reader :precision = nil,
+                attr_reader :scale = nil,
+                attr_reader :sql_type = "INTEGER",
+                attr_reader :type = :integer
+            >,
+                  "name" => #<ActiveRecord::ConnectionAdapters::SQLite3Column:placeholder_id
+                attr_accessor :coder = nil,
+                attr_accessor :primary = false,
+                attr_reader :default = nil,
+                attr_reader :default_function = nil,
+                attr_reader :limit = 255,
+                attr_reader :name = "name",
+                attr_reader :null = true,
+                attr_reader :precision = nil,
+                attr_reader :scale = nil,
+                attr_reader :sql_type = "varchar(255)",
+                attr_reader :type = :string
+            >,
+                  "rank" => #<ActiveRecord::ConnectionAdapters::SQLite3Column:placeholder_id
+                attr_accessor :coder = nil,
+                attr_accessor :primary = false,
+                attr_reader :default = nil,
+                attr_reader :default_function = nil,
+                attr_reader :limit = nil,
+                attr_reader :name = "rank",
+                attr_reader :null = true,
+                attr_reader :precision = nil,
+                attr_reader :scale = nil,
+                attr_reader :sql_type = "integer",
+                attr_reader :type = :integer
+            >
+        },
+        @column_types_override = nil,
+        @destroyed = false,
+        @marked_for_destruction = false,
+        @new_record = true,
+        @previously_changed = {},
+        @readonly = false,
+        @reflects_state = [
+            [0] false
+        ],
+        @transaction_state = nil,
+        @txn = nil,
+        attr_accessor :attributes = {
+                 "admin" => false,
+            "created_at" => "1992-10-10 12:30:00",
+                    "id" => nil,
+                  "name" => "Diana",
+                  "rank" => 1
+        },
+        attr_accessor :destroyed_by_association = nil,
+        attr_reader :association_cache = {},
+        attr_reader :changed_attributes = {
+                 "admin" => nil,
+            "created_at" => nil,
+                  "name" => nil,
+                  "rank" => nil
+        }
+    >,
+    [1] #<User:placeholder_id
+        @_start_transaction_state = {},
+        @aggregation_cache = {},
+        @attributes_cache = {},
+        @column_types = {
+                 "admin" => #<ActiveRecord::ConnectionAdapters::SQLite3Column:placeholder_id
+                attr_accessor :coder = nil,
+                attr_accessor :primary = false,
+                attr_reader :default = nil,
+                attr_reader :default_function = nil,
+                attr_reader :limit = nil,
+                attr_reader :name = "admin",
+                attr_reader :null = true,
+                attr_reader :precision = nil,
+                attr_reader :scale = nil,
+                attr_reader :sql_type = "boolean",
+                attr_reader :type = :boolean
+            >,
+            "created_at" => #<ActiveRecord::ConnectionAdapters::SQLite3Column:placeholder_id
+                attr_accessor :coder = nil,
+                attr_accessor :primary = false,
+                attr_reader :default = nil,
+                attr_reader :default_function = nil,
+                attr_reader :limit = nil,
+                attr_reader :name = "created_at",
+                attr_reader :null = true,
+                attr_reader :precision = nil,
+                attr_reader :scale = nil,
+                attr_reader :sql_type = "datetime",
+                attr_reader :type = :datetime
+            >,
+                    "id" => #<ActiveRecord::ConnectionAdapters::SQLite3Column:placeholder_id
+                attr_accessor :coder = nil,
+                attr_accessor :primary = true,
+                attr_reader :default = nil,
+                attr_reader :default_function = nil,
+                attr_reader :limit = nil,
+                attr_reader :name = "id",
+                attr_reader :null = false,
+                attr_reader :precision = nil,
+                attr_reader :scale = nil,
+                attr_reader :sql_type = "INTEGER",
+                attr_reader :type = :integer
+            >,
+                  "name" => #<ActiveRecord::ConnectionAdapters::SQLite3Column:placeholder_id
+                attr_accessor :coder = nil,
+                attr_accessor :primary = false,
+                attr_reader :default = nil,
+                attr_reader :default_function = nil,
+                attr_reader :limit = 255,
+                attr_reader :name = "name",
+                attr_reader :null = true,
+                attr_reader :precision = nil,
+                attr_reader :scale = nil,
+                attr_reader :sql_type = "varchar(255)",
+                attr_reader :type = :string
+            >,
+                  "rank" => #<ActiveRecord::ConnectionAdapters::SQLite3Column:placeholder_id
+                attr_accessor :coder = nil,
+                attr_accessor :primary = false,
+                attr_reader :default = nil,
+                attr_reader :default_function = nil,
+                attr_reader :limit = nil,
+                attr_reader :name = "rank",
+                attr_reader :null = true,
+                attr_reader :precision = nil,
+                attr_reader :scale = nil,
+                attr_reader :sql_type = "integer",
+                attr_reader :type = :integer
+            >
+        },
+        @column_types_override = nil,
+        @destroyed = false,
+        @marked_for_destruction = false,
+        @new_record = true,
+        @previously_changed = {},
+        @readonly = false,
+        @reflects_state = [
+            [0] false
+        ],
+        @transaction_state = nil,
+        @txn = nil,
+        attr_accessor :attributes = {
+                 "admin" => true,
+            "created_at" => "2003-05-26 14:15:00",
+                    "id" => nil,
+                  "name" => "Laura",
+                  "rank" => 2
+        },
+        attr_accessor :destroyed_by_association = nil,
+        attr_reader :association_cache = {},
+        attr_reader :changed_attributes = {
+                 "admin" => nil,
+            "created_at" => nil,
+                  "name" => nil,
+                  "rank" => nil
+        }
+    >
+]