awesome_print 1.7.0 → 1.8.0

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
+          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,7 +15,7 @@ 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
@@ -42,27 +42,35 @@ 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
+      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
   end
 end

data/lib/awesome_print/ext/active_support.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/ext/mongo_mapper.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,7 +18,7 @@ module AwesomePrint
       cast = cast_without_mongo_mapper(object, type)
 
       if defined?(::MongoMapper::Document)
-        if object.is_a?(Class) && (object.ancestors & [ ::MongoMapper::Document, ::MongoMapper::EmbeddedDocument ]).size > 0
+        if object.is_a?(Class) && (object.ancestors & [::MongoMapper::Document, ::MongoMapper::EmbeddedDocument]).size > 0
           cast = :mongo_mapper_class
         elsif object.is_a?(::MongoMapper::Document) || object.is_a?(::MongoMapper::EmbeddedDocument)
           cast = :mongo_mapper_instance
@@ -38,7 +38,7 @@ module AwesomePrint
       return object.inspect if !defined?(::ActiveSupport::OrderedHash) || !object.respond_to?(:keys)
 
       data = object.keys.sort.inject(::ActiveSupport::OrderedHash.new) do |hash, c|
-        hash[c.first] = (c.last.type || "undefined").to_s.underscore.intern
+        hash[c.first] = (c.last.type || 'undefined').to_s.underscore.intern
         hash
       end
 
@@ -49,7 +49,10 @@ module AwesomePrint
         end
       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 MongoMapper instance object.
@@ -65,7 +68,7 @@ module AwesomePrint
       return object.inspect if !defined?(::ActiveSupport::OrderedHash)
       return awesome_object(object) if @options[:raw]
 
-      data = object.keys.keys.sort_by{|k| k}.inject(::ActiveSupport::OrderedHash.new) do |hash, name|
+      data = object.keys.keys.sort_by { |k| k }.inject(::ActiveSupport::OrderedHash.new) do |hash, name|
         hash[name] = object[name]
         hash
       end
@@ -73,11 +76,11 @@ module AwesomePrint
       # Add in associations
       if @options[:mongo_mapper][:show_associations]
         object.associations.each do |name, assoc|
-          if @options[:mongo_mapper][:inline_embedded] and assoc.embeddable?
-            data[name.to_s] = object.send(name)
-          else
-            data[name.to_s] = assoc
-          end
+          data[name.to_s] = if @options[:mongo_mapper][:inline_embedded] and assoc.embeddable?
+                              object.send(name)
+                            else
+                              assoc
+                            end
         end
       end
 
@@ -93,7 +96,7 @@ module AwesomePrint
       return object.inspect if !defined?(::ActiveSupport::OrderedHash)
       return awesome_object(object) if @options[:raw]
 
-      association = object.class.name.split('::').last.titleize.downcase.sub(/ association$/,'')
+      association = object.class.name.split('::').last.titleize.downcase.sub(/ association$/, '')
       association = "embeds #{association}" if object.embeddable?
       class_name = object.class_name
 
@@ -111,8 +114,8 @@ module AwesomePrint
     def apply_default_mongo_mapper_options
       @options[:color][:assoc] ||= :greenish
       @options[:mongo_mapper]  ||= {
-        :show_associations => false, # Display association data for MongoMapper documents and classes.
-        :inline_embedded => false    # Display embedded associations inline with MongoMapper documents.
+        show_associations: false, # Display association data for MongoMapper documents and classes.
+        inline_embedded: false    # Display embedded associations inline with MongoMapper documents.
       }
     end
   end

data/lib/awesome_print/ext/mongoid.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
@@ -33,10 +33,14 @@ module AwesomePrint
       return object.inspect if !defined?(::ActiveSupport::OrderedHash) || !object.respond_to?(:fields)
 
       data = object.fields.sort_by { |key| key }.inject(::ActiveSupport::OrderedHash.new) do |hash, c|
-        hash[c[1].name.to_sym] = (c[1].type || "undefined").to_s.underscore.intern
+        hash[c[1].name.to_sym] = (c[1].type || 'undefined').to_s.underscore.intern
         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 Mongoid Document object.
@@ -48,9 +52,7 @@ module AwesomePrint
         hash[c[0].to_sym] = c[1]
         hash
       end
-      if !object.errors.empty?
-        data = {:errors => object.errors, :attributes => data}
-      end
+      data = { errors: object.errors, attributes: data } if !object.errors.empty?
       "#{object} #{awesome_hash(data)}"
     end
 

data/lib/awesome_print/ext/nobrainer.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
@@ -28,19 +28,22 @@ module AwesomePrint
     # Format NoBrainer class object.
     #------------------------------------------------------------------------------
     def awesome_nobrainer_class(object)
+      name = "#{awesome_simple(object, :class)} < #{awesome_simple(object.superclass, :class)}"
       data = Hash[object.fields.map do |field, options|
         [field, (options[:type] || Object).to_s.underscore.to_sym]
       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 NoBrainer Document object.
     #------------------------------------------------------------------------------
     def awesome_nobrainer_document(object)
       data = object.inspectable_attributes.symbolize_keys
-      if object.errors.present?
-        data = {:errors => object.errors, :attributes => data}
-      end
+      data = { errors: object.errors, attributes: data } if object.errors.present?
       "#{object} #{awesome_hash(data)}"
     end
   end

data/lib/awesome_print/ext/nokogiri.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,7 @@ module AwesomePrint
     #------------------------------------------------------------------------------
     def cast_with_nokogiri(object, type)
       cast = cast_without_nokogiri(object, type)
-      if (defined?(::Nokogiri::XML::Node) && object.is_a?(::Nokogiri::XML::Node)) || 
+      if (defined?(::Nokogiri::XML::Node) && object.is_a?(::Nokogiri::XML::Node)) ||
          (defined?(::Nokogiri::XML::NodeSet) && object.is_a?(::Nokogiri::XML::NodeSet))
         cast = :nokogiri_xml_node
       end
@@ -25,9 +25,9 @@ module AwesomePrint
     #------------------------------------------------------------------------------
     def awesome_nokogiri_xml_node(object)
       if object.is_a?(::Nokogiri::XML::NodeSet) && object.empty?
-        return "[]"
+        return '[]'
       end
-      xml = object.to_xml(:indent => 2)
+      xml = object.to_xml(indent: 2)
       #
       # Colorize tag, id/class name, and contents.
       #

data/lib/awesome_print/ext/ostruct.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/ext/ripple.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
@@ -60,11 +60,10 @@ module AwesomePrint
     def awesome_ripple_document_class(object)
       return object.inspect if !defined?(::ActiveSupport::OrderedHash) || !object.respond_to?(:properties)
 
-      data = object.properties.inject(::ActiveSupport::OrderedHash.new) do |hash, (name, defn)|
-        hash[name.to_sym] = defn.type.to_s.downcase.to_sym
-        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
   end
 end

data/lib/awesome_print/ext/sequel.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
@@ -32,9 +32,7 @@ module AwesomePrint
         hash[c[0].to_sym] = c[1]
         hash
       end
-      if !object.errors.empty?
-        data = {:errors => object.errors, :values => data}
-      end
+      data = { errors: object.errors, values: data } if !object.errors.empty?
       "#{object} #{awesome_hash(data)}"
     end
 
@@ -47,8 +45,11 @@ module AwesomePrint
     # Format Sequel Model class.
     #------------------------------------------------------------------------------
     def awesome_sequel_model_class(object)
-      data = object.db_schema.inject({}) {|h, (name,data)| h.merge(name => data[:db_type])}
-      "class #{object} < #{object.superclass} " << awesome_hash(data)
+      data = object.db_schema.inject({}) { |h, (prop, defn)| h.merge(prop => defn[:db_type]) }
+      name = "class #{awesome_simple(object.to_s, :class)}"
+      base = "< #{awesome_simple(object.superclass.to_s, :class)}"
+
+      [name, base, awesome_hash(data)].join(' ')
     end
   end
 

data/lib/awesome_print/formatter.rb

@@ -1,17 +1,9 @@
-# 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
 #------------------------------------------------------------------------------
-require_relative "formatters/object_formatter"
-require_relative "formatters/hash_formatter"
-require_relative "formatters/array_formatter"
-require_relative "formatters/simple_formatter"
-require_relative "formatters/method_formatter"
-require_relative "formatters/class_formatter"
-require_relative "formatters/dir_formatter"
-require_relative "formatters/file_formatter"
-require_relative "colorize"
+require 'awesome_print/formatters'
 
 module AwesomePrint
   class Formatter
@@ -19,7 +11,7 @@ module AwesomePrint
 
     attr_reader :inspector, :options
 
-    CORE = [ :array, :bigdecimal, :class, :dir, :file, :hash, :method, :rational, :set, :struct, :unboundmethod ]
+    CORE = [:array, :bigdecimal, :class, :dir, :file, :hash, :method, :rational, :set, :struct, :unboundmethod]
 
     def initialize(inspector)
       @inspector   = inspector
@@ -52,7 +44,7 @@ module AwesomePrint
     def awesome_self(object, type)
       if @options[:raw] && object.instance_variables.any?
         awesome_object(object)
-      elsif hash = convert_to_hash(object)
+      elsif (hash = convert_to_hash(object))
         awesome_hash(hash)
       else
         awesome_simple(object.inspect.to_s, type, @inspector)
@@ -60,7 +52,7 @@ module AwesomePrint
     end
 
     def awesome_bigdecimal(n)
-      o = n.to_s("F")
+      o = n.to_s('F')
       type = :bigdecimal
       awesome_simple(o, type, @inspector)
     end
@@ -71,7 +63,7 @@ module AwesomePrint
       awesome_simple(o, type, @inspector)
     end
 
-    def awesome_simple(o, type, inspector)
+    def awesome_simple(o, type, inspector = @inspector)
       AwesomePrint::Formatters::SimpleFormatter.new(o, type, inspector).format
     end
 
@@ -88,15 +80,15 @@ module AwesomePrint
     end
 
     def awesome_object(o)
-      Formatters::ObjectFormatter.new(o, o.instance_variables, @inspector).format
+      Formatters::ObjectFormatter.new(o, @inspector).format
     end
 
     def awesome_struct(s)
-      Formatters::ObjectFormatter.new(s, s.members, @inspector).format
+      Formatters::StructFormatter.new(s, @inspector).format
     end
 
     def awesome_method(m)
-      Formatters::MethodFormatter.new(m, @inspector).format  
+      Formatters::MethodFormatter.new(m, @inspector).format
     end
     alias :awesome_unboundmethod :awesome_method
 
@@ -115,7 +107,7 @@ module AwesomePrint
     # Utility methods.
     #------------------------------------------------------------------------------
     def convert_to_hash(object)
-      if ! object.respond_to?(:to_hash)
+      if !object.respond_to?(:to_hash)
         return nil
       end
 
@@ -124,7 +116,7 @@ module AwesomePrint
       end
 
       hash = object.to_hash
-      if ! hash.respond_to?(:keys) || ! hash.respond_to?('[]')
+      if !hash.respond_to?(:keys) || !hash.respond_to?('[]')
         return nil
       end