awesome_print 1.2.0 → 1.9.2

data/Rakefile

@@ -1,11 +1,24 @@
-require "bundler"
+require 'rubygems'
+require 'bundler/setup'
+
+require 'bundler'
 Bundler::GemHelper.install_tasks
 
-task :default => :spec
+task :default do
+  if ENV['BUNDLE_GEMFILE'] =~ /gemfiles/
+    Rake::Task['spec'].invoke
+  else
+    Rake::Task['appraise'].invoke
+  end
+end
+
+task :appraise do
+  exec 'appraisal install && appraisal rake'
+end
 
-desc "Run all awesome_print gem specs"
+desc 'Run all awesome_print gem specs'
 task :spec do
   # Run plain rspec command without RSpec::Core::RakeTask overrides.
-  exec "rspec -c spec"
+  exec 'rspec -c spec'
 end
 

data/awesome_print.gemspec

@@ -0,0 +1,33 @@
+# 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
+#------------------------------------------------------------------------------
+
+$:.push File.expand_path('../lib', __FILE__)
+require 'awesome_print/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'awesome_print'
+  s.version     = AwesomePrint.version
+  s.authors     = 'Michael Dvorkin'
+  s.date        = Time.now.strftime('%Y-%m-%d')
+  s.email       = 'mike@dvorkin.net'
+  s.homepage    = 'https://github.com/awesome-print/awesome_print'
+  s.summary     = 'Pretty print Ruby objects with proper indentation and colors'
+  s.description = 'Great Ruby debugging companion: pretty print Ruby objects to visualize their structure. Supports custom object formatting via plugins'
+  s.license     = 'MIT'
+
+  s.files         = Dir['[A-Z]*[^~]'] + Dir['lib/**/*.rb'] + Dir['spec/**/*'] + ['.gitignore']
+  s.test_files    = Dir['spec/**/*']
+  s.executables   = []
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'rspec',  '>= 3.0.0'
+  s.add_development_dependency 'appraisal'
+  s.add_development_dependency 'fakefs', '>= 0.2.1'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'nokogiri', '>= 1.11.0'
+  # s.add_development_dependency 'simplecov'
+  # s.add_development_dependency 'codeclimate-test-reporter'
+end

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'lib', 'awesome_print')

data/lib/ap.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
@@ -7,4 +7,4 @@
 # Keeping this for backwards compatibility to allow
 # require "ap"
 #
-require File.dirname(__FILE__) + "/awesome_print"
+require File.dirname(__FILE__) + '/awesome_print'

data/lib/awesome_print.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
@@ -8,28 +8,34 @@
 # so do nothing for subsequent requires.
 #
 unless defined?(AwesomePrint::Inspector)
-  %w(array string method object class kernel).each do |file|
-    require File.dirname(__FILE__) + "/awesome_print/core_ext/#{file}"
+  %w(awesome_method_array string method object class kernel).each do |file|
+    require "awesome_print/core_ext/#{file}"
   end
 
-  require File.dirname(__FILE__) + "/awesome_print/inspector"
-  require File.dirname(__FILE__) + "/awesome_print/formatter"
-  require File.dirname(__FILE__) + "/awesome_print/version"
-  require File.dirname(__FILE__) + "/awesome_print/core_ext/logger" if defined?(Logger)
+  require 'awesome_print/custom_defaults'
+  require 'awesome_print/inspector'
+  require 'awesome_print/formatter'
+  require 'awesome_print/version'
+  require 'awesome_print/core_ext/logger' if defined?(Logger)
   #
   # Load the following under normal circumstances as well as in Rails
   # console when required from ~/.irbrc or ~/.pryrc.
   #
-  require File.dirname(__FILE__) + "/awesome_print/ext/active_record"  if defined?(ActiveRecord)  || AwesomePrint.rails_console?
-  require File.dirname(__FILE__) + "/awesome_print/ext/active_support" if defined?(ActiveSupport) || AwesomePrint.rails_console?
+  require 'awesome_print/ext/active_record'  if defined?(ActiveRecord)  || AwesomePrint.rails_console?
+  require 'awesome_print/ext/active_support' if defined?(ActiveSupport) || AwesomePrint.rails_console?
   #
   # Load remaining extensions.
   #
-  require File.dirname(__FILE__) + "/awesome_print/ext/action_view"    if defined?(ActionView::Base)
-  require File.dirname(__FILE__) + "/awesome_print/ext/mongo_mapper"   if defined?(MongoMapper)
-  require File.dirname(__FILE__) + "/awesome_print/ext/mongoid"        if defined?(Mongoid)
-  require File.dirname(__FILE__) + "/awesome_print/ext/nokogiri"       if defined?(Nokogiri)
-  require File.dirname(__FILE__) + "/awesome_print/ext/no_brainer"     if defined?(NoBrainer)
-  require File.dirname(__FILE__) + "/awesome_print/ext/ripple"         if defined?(Ripple)
-  require File.dirname(__FILE__) + "/awesome_print/ext/sequel"         if defined?(Sequel)
+  if defined?(ActiveSupport.on_load)
+    ActiveSupport.on_load(:action_view) do
+      require 'awesome_print/ext/action_view'
+    end
+  end
+  require 'awesome_print/ext/mongo_mapper'   if defined?(MongoMapper)
+  require 'awesome_print/ext/mongoid'        if defined?(Mongoid)
+  require 'awesome_print/ext/nokogiri'       if defined?(Nokogiri)
+  require 'awesome_print/ext/nobrainer'      if defined?(NoBrainer)
+  require 'awesome_print/ext/ripple'         if defined?(Ripple)
+  require 'awesome_print/ext/sequel'         if defined?(Sequel)
+  require 'awesome_print/ext/ostruct'        if defined?(OpenStruct)
 end

data/lib/awesome_print/colorize.rb

@@ -0,0 +1,24 @@
+autoload :CGI, 'cgi'
+
+module AwesomePrint
+  module Colorize
+
+    # Pick the color and apply it to the given string as necessary.
+    #------------------------------------------------------------------------------
+    def colorize(str, type)
+      str = CGI.escapeHTML(str) if options[:html]
+      if options[:plain] || !options[:color][type] || !inspector.colorize?
+        str
+      #
+      # Check if the string color method is defined by awesome_print and accepts
+      # html parameter or it has been overriden by some gem such as colorize.
+      #
+      elsif str.method(options[:color][type]).arity == -1 # Accepts html parameter.
+        str.send(options[:color][type], options[:html])
+      else
+        str = %Q|<kbd style="color:#{options[:color][type]}">#{str}</kbd>| if options[:html]
+        str.send(options[:color][type])
+      end
+    end
+  end
+end

data/lib/awesome_print/core_ext/{array.rb → awesome_method_array.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
@@ -12,24 +12,24 @@
 #
 # If you could think of a better way please let me know :-)
 #
-class Array #:nodoc:
-  [ :-, :& ].each do |operator|
-    original_operator = instance_method(operator)
+module AwesomeMethodArray #:nodoc:
 
-    define_method operator do |*args|
-      arr = original_operator.bind(self).call(*args)
-      if self.instance_variable_defined?('@__awesome_methods__')
-        arr.instance_variable_set('@__awesome_methods__', self.instance_variable_get('@__awesome_methods__'))
-        arr.sort! { |a, b| a.to_s <=> b.to_s }  # Need the block since Ruby 1.8.x can't sort arrays of symbols.
-      end
-      arr
+  def -(_other_ary)
+    super.tap do |arr|
+      arr.instance_variable_set(:@__awesome_methods__, self.instance_variable_get(:@__awesome_methods__))
+    end
+  end
+
+  def &(_other_ary)
+    super.tap do |arr|
+      arr.instance_variable_set(:@__awesome_methods__, self.instance_variable_get(:@__awesome_methods__))
     end
   end
+
   #
   # Intercepting Array#grep needs a special treatment since grep accepts
   # an optional block.
   #
-  alias :original_grep :grep
   def grep(pattern, &blk)
     #
     # The following looks rather insane and I've sent numerous hours trying
@@ -55,9 +55,9 @@ class Array #:nodoc:
     # the comment :-)
     #
     arr = unless blk
-      original_grep(pattern)
+      super(pattern)
     else
-      original_grep(pattern) do |match|
+      super(pattern) do |match|
         #
         # The binding can only be used with Ruby-defined methods, therefore
         # we must rescue potential "ArgumentError: Can't create Binding from
@@ -72,10 +72,8 @@ class Array #:nodoc:
         yield match
       end
     end
-    if self.instance_variable_defined?('@__awesome_methods__')
-      arr.instance_variable_set('@__awesome_methods__', self.instance_variable_get('@__awesome_methods__'))
-      arr.reject! { |item| !(item.is_a?(Symbol) || item.is_a?(String)) } # grep block might return crap.
-    end
+    arr.instance_variable_set(:@__awesome_methods__, self.instance_variable_get(:@__awesome_methods__))
+    arr.reject! { |item| !(item.is_a?(Symbol) || item.is_a?(String)) } # grep block might return crap.
     arr
   end
 end

data/lib/awesome_print/core_ext/class.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
@@ -15,7 +15,8 @@ class Class #:nodoc:
 
     define_method name do |*args|
       methods = original_method.bind(self).call(*args)
-      methods.instance_variable_set('@__awesome_methods__', self)
+      methods.instance_variable_set(:@__awesome_methods__, self)
+      methods.extend(AwesomeMethodArray)
       methods
     end
   end

data/lib/awesome_print/core_ext/kernel.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

data/lib/awesome_print/core_ext/logger.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

data/lib/awesome_print/core_ext/method.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
@@ -18,4 +18,4 @@ unless nil.method(:class).respond_to?(:name)
       inspect.split(/[#.>]/)[-1]
     end
   end
-end
+end

data/lib/awesome_print/core_ext/object.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
@@ -15,7 +15,8 @@ class Object #:nodoc:
 
     define_method name do |*args|
       methods = original_method.bind(self).call(*args)
-      methods.instance_variable_set('@__awesome_methods__', self)
+      methods.instance_variable_set(:@__awesome_methods__, self)
+      methods.extend(AwesomeMethodArray)
       methods
     end
   end

data/lib/awesome_print/core_ext/string.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
@@ -17,11 +17,11 @@ class String
   %w(gray red green yellow blue purple cyan white).zip(
   %w(black darkred darkgreen brown navy darkmagenta darkcyan slategray)).each_with_index do |(color, shade), i|
     define_method color do |*html|
-      html[0] ? %Q|<kbd style="color:#{color}">#{self}</kbd>| : "\e[1;#{30+i}m#{self}\e[0m"
+      html[0] ? %Q|<kbd style="color:#{color}">#{self}</kbd>| : "\e[1;#{30 + i}m#{self}\e[0m"
     end
 
     define_method "#{color}ish" do |*html|
-      html[0] ? %Q|<kbd style="color:#{shade}">#{self}</kbd>| : "\e[0;#{30+i}m#{self}\e[0m"
+      html[0] ? %Q|<kbd style="color:#{shade}">#{self}</kbd>| : "\e[0;#{30 + i}m#{self}\e[0m"
     end
   end
 

data/lib/awesome_print/custom_defaults.rb

@@ -0,0 +1,57 @@
+module AwesomePrint
+  class << self
+    attr_accessor :defaults, :force_colors
+
+    # Class accessor to force colorized output (ex. forked subprocess where TERM
+    # might be dumb).
+    #---------------------------------------------------------------------------
+    def force_colors!(value = true)
+      @force_colors = value
+    end
+
+    def console?
+      boolean(defined?(IRB) || defined?(Pry))
+    end
+
+    def rails_console?
+      console? && boolean(defined?(Rails::Console) || ENV['RAILS_ENV'])
+    end
+
+    def diet_rb
+      IRB.formatter = Class.new(IRB::Formatter) do
+        def inspect_object(object)
+          object.ai
+        end
+      end.new
+    end
+
+    def usual_rb
+      IRB::Irb.class_eval do
+        def output_value(*args)
+          ap @context.last_value
+        rescue NoMethodError
+          puts "(Object doesn't support #ai)"
+        end
+      end
+    end
+
+    def irb!
+      return unless defined?(IRB)
+
+      IRB.version.include?('DietRB') ? diet_rb : usual_rb
+    end
+
+    def pry!
+      Pry.print = proc { |output, value| output.puts value.ai } if defined?(Pry)
+    end
+
+    private
+
+    # Takes a value and returns true unless it is false or nil
+    # This is an alternative to the less readable !!(value)
+    # https://github.com/bbatsov/ruby-style-guide#no-bang-bang
+    def boolean(value)
+      value ? true : false
+    end
+  end
+end

data/lib/awesome_print/ext/action_view.rb

@@ -1,17 +1,21 @@
-# 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
 #------------------------------------------------------------------------------
 module AwesomePrint
   module ActionView
-
     # Use HTML colors and add default "debug_dump" class to the resulting HTML.
     def ap_debug(object, options = {})
-      object.ai(options.merge(:html => true)).sub(/^<pre([\s>])/, '<pre class="debug_dump"\\1')
+      object.ai(
+        options.merge(html: true)
+      ).sub(
+        /^<pre([\s>])/,
+        '<pre class="debug_dump"\\1'
+      )
     end
 
-    alias_method :ap, :ap_debug
+    alias ap ap_debug
   end
 end
 

data/lib/awesome_print/ext/active_record.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
@@ -15,13 +15,15 @@ module AwesomePrint
     #------------------------------------------------------------------------------
     def cast_with_active_record(object, type)
       cast = cast_without_active_record(object, type)
-      return cast if !defined?(::ActiveRecord)
+      return cast if !defined?(::ActiveRecord::Base)
 
       if object.is_a?(::ActiveRecord::Base)
         cast = :active_record_instance
+      elsif object.is_a?(::ActiveModel::Errors)
+        cast = :active_model_error
       elsif object.is_a?(Class) && object.ancestors.include?(::ActiveRecord::Base)
         cast = :active_record_class
-      elsif type == :activerecord_relation
+      elsif type == :activerecord_relation || object.class.ancestors.include?(::ActiveRecord::Relation)
         cast = :array
       end
       cast
@@ -42,26 +44,58 @@ module AwesomePrint
       return object.inspect if !defined?(::ActiveSupport::OrderedHash)
       return awesome_object(object) if @options[:raw]
 
-      data = object.class.column_names.inject(::ActiveSupport::OrderedHash.new) do |hash, name|
-        if object.has_attribute?(name) || object.new_record?
-          value = object.respond_to?(name) ? object.send(name) : object.read_attribute(name)
-          hash[name.to_sym] = value
-        end
-        hash
-      end
-      "#{object} " << awesome_hash(data)
+      data = if object.class.column_names != object.attributes.keys
+               object.attributes
+             else
+               object.class.column_names.inject(::ActiveSupport::OrderedHash.new) do |hash, name|
+                 if object.has_attribute?(name) || object.new_record?
+                   value = object.respond_to?(name) ? object.send(name) : object.read_attribute(name)
+                   hash[name.to_sym] = value
+                 end
+                 hash
+               end
+             end
+      "#{object} #{awesome_hash(data)}"
     end
 
     # Format ActiveRecord class object.
     #------------------------------------------------------------------------------
     def awesome_active_record_class(object)
-      return object.inspect if !defined?(::ActiveSupport::OrderedHash) || !object.respond_to?(:columns) || object.to_s == "ActiveRecord::Base"
+      return object.inspect if !defined?(::ActiveSupport::OrderedHash) || !object.respond_to?(:columns) || object.to_s == 'ActiveRecord::Base'
+      return awesome_class(object) if object.respond_to?(:abstract_class?) && object.abstract_class?
 
       data = object.columns.inject(::ActiveSupport::OrderedHash.new) do |hash, c|
         hash[c.name.to_sym] = c.type
         hash
       end
-      "class #{object} < #{object.superclass} " << awesome_hash(data)
+
+      name = "class #{awesome_simple(object.to_s, :class)}"
+      base = "< #{awesome_simple(object.superclass.to_s, :class)}"
+
+      [name, base, awesome_hash(data)].join(' ')
+    end
+
+    # Format ActiveModel error object.
+    #------------------------------------------------------------------------------
+    def awesome_active_model_error(object)
+      return object.inspect if !defined?(::ActiveSupport::OrderedHash)
+      return awesome_object(object) if @options[:raw]
+
+      object_dump = object.marshal_dump.first
+      data = if object_dump.class.column_names != object_dump.attributes.keys
+               object_dump.attributes
+             else
+               object_dump.class.column_names.inject(::ActiveSupport::OrderedHash.new) do |hash, name|
+                 if object_dump.has_attribute?(name) || object_dump.new_record?
+                   value = object_dump.respond_to?(name) ? object_dump.send(name) : object_dump.read_attribute(name)
+                   hash[name.to_sym] = value
+                 end
+                 hash
+               end
+             end
+
+      data.merge!({details: object.details, messages: object.messages})
+      "#{object} #{awesome_hash(data)}"
     end
   end
 end