awesome_print 1.0.2 → 1.7.0

data/lib/awesome_print/core_ext/class.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2011 Michael Dvorkin
+# Copyright (c) 2010-2013 Michael Dvorkin
 #
 # 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/kernel.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2011 Michael Dvorkin
+# Copyright (c) 2010-2013 Michael Dvorkin
 #
 # Awesome Print is freely distributable under the terms of MIT license.
 # See LICENSE file or http://www.opensource.org/licenses/mit-license.php
@@ -7,13 +7,18 @@ module Kernel
 
   def ai(options = {})
     ap = AwesomePrint::Inspector.new(options)
-    ap.awesome self
+    awesome = ap.awesome self
+    if options[:html]
+      awesome = "<pre>#{awesome}</pre>"
+      awesome = awesome.html_safe if defined? ActiveSupport
+    end
+    awesome
   end
   alias :awesome_inspect :ai
 
   def ap(object, options = {})
     puts object.ai(options)
-    object
+    object unless AwesomePrint.console?
   end
   alias :awesome_print :ap
 

data/lib/awesome_print/core_ext/logger.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2011 Michael Dvorkin
+# Copyright (c) 2010-2013 Michael Dvorkin
 #
 # 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-2011 Michael Dvorkin
+# Copyright (c) 2010-2013 Michael Dvorkin
 #
 # 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/object.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2011 Michael Dvorkin
+# Copyright (c) 2010-2013 Michael Dvorkin
 #
 # 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/string.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2011 Michael Dvorkin
+# Copyright (c) 2010-2013 Michael Dvorkin
 #
 # 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/action_view.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2011 Michael Dvorkin
+# Copyright (c) 2010-2013 Michael Dvorkin
 #
 # 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/active_record.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2011 Michael Dvorkin
+# Copyright (c) 2010-2013 Michael Dvorkin
 #
 # Awesome Print is freely distributable under the terms of MIT license.
 # See LICENSE file or http://www.opensource.org/licenses/mit-license.php
@@ -21,6 +21,8 @@ module AwesomePrint
         cast = :active_record_instance
       elsif object.is_a?(Class) && object.ancestors.include?(::ActiveRecord::Base)
         cast = :active_record_class
+      elsif type == :activerecord_relation || object.class.ancestors.include?(::ActiveRecord::Relation)
+        cast = :array
       end
       cast
     end
@@ -41,7 +43,10 @@ module AwesomePrint
       return awesome_object(object) if @options[:raw]
 
       data = object.class.column_names.inject(::ActiveSupport::OrderedHash.new) do |hash, name|
-        hash[name.to_sym] = object.send(name) if object.has_attribute?(name) || object.new_record?
+        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)
@@ -51,6 +56,7 @@ module AwesomePrint
     #------------------------------------------------------------------------------
     def awesome_active_record_class(object)
       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

data/lib/awesome_print/ext/active_support.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2011 Michael Dvorkin
+# Copyright (c) 2010-2013 Michael Dvorkin
 #
 # Awesome Print is freely distributable under the terms of MIT license.
 # See LICENSE file or http://www.opensource.org/licenses/mit-license.php
@@ -14,7 +14,7 @@ module AwesomePrint
     def cast_with_active_support(object, type)
       cast = cast_without_active_support(object, type)
       if defined?(::ActiveSupport) && defined?(::HashWithIndifferentAccess)
-        if object.is_a?(::ActiveSupport::TimeWithZone) || object.is_a?(::Date)
+        if (defined?(::ActiveSupport::TimeWithZone) && object.is_a?(::ActiveSupport::TimeWithZone)) || object.is_a?(::Date)
           cast = :active_support_time
         elsif object.is_a?(::HashWithIndifferentAccess)
           cast = :hash_with_indifferent_access

data/lib/awesome_print/ext/mongo_mapper.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2011 Michael Dvorkin
+# Copyright (c) 2010-2013 Michael Dvorkin
 #
 # Awesome Print is freely distributable under the terms of MIT license.
 # See LICENSE file or http://www.opensource.org/licenses/mit-license.php
@@ -14,10 +14,21 @@ module AwesomePrint
     # Add MongoMapper class names to the dispatcher pipeline.
     #------------------------------------------------------------------------------
     def cast_with_mongo_mapper(object, type)
+      apply_default_mongo_mapper_options
       cast = cast_without_mongo_mapper(object, type)
-      if defined?(::MongoMapper::Document) && object.is_a?(Class) && (object.ancestors & [ ::MongoMapper::Document, ::MongoMapper::EmbeddedDocument ]).size > 0
-        cast = :mongo_mapper_class
+
+      if defined?(::MongoMapper::Document)
+        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
+        elsif object.is_a?(::MongoMapper::Plugins::Associations::Base)
+          cast = :mongo_mapper_association
+        elsif object.is_a?(::BSON::ObjectId)
+          cast = :mongo_mapper_bson_id
+        end
       end
+
       cast
     end
 
@@ -30,8 +41,80 @@ module AwesomePrint
         hash[c.first] = (c.last.type || "undefined").to_s.underscore.intern
         hash
       end
+
+      # Add in associations
+      if @options[:mongo_mapper][:show_associations]
+        object.associations.each do |name, assoc|
+          data[name.to_s] = assoc
+        end
+      end
+
       "class #{object} < #{object.superclass} " << awesome_hash(data)
     end
+
+    # Format MongoMapper instance object.
+    #
+    # NOTE: by default only instance attributes (i.e. keys) are shown. To format
+    # MongoMapper instance as regular object showing its instance variables and
+    # accessors use :raw => true option:
+    #
+    # ap record, :raw => true
+    #
+    #------------------------------------------------------------------------------
+    def awesome_mongo_mapper_instance(object)
+      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|
+        hash[name] = object[name]
+        hash
+      end
+
+      # 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
+        end
+      end
+
+      label = object.to_s
+      label = "#{colorize('embedded', :assoc)} #{label}" if object.is_a?(::MongoMapper::EmbeddedDocument)
+
+      "#{label} " << awesome_hash(data)
+    end
+
+    # Format MongoMapper association object.
+    #------------------------------------------------------------------------------
+    def awesome_mongo_mapper_association(object)
+      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 = "embeds #{association}" if object.embeddable?
+      class_name = object.class_name
+
+      "#{colorize(association, :assoc)} #{colorize(class_name, :class)}"
+    end
+
+    # Format BSON::ObjectId
+    #------------------------------------------------------------------------------
+    def awesome_mongo_mapper_bson_id(object)
+      object.inspect
+    end
+
+    private
+
+    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.
+      }
+    end
   end
 end
 

data/lib/awesome_print/ext/mongoid.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2011 Michael Dvorkin
+# Copyright (c) 2010-2013 Michael Dvorkin
 #
 # Awesome Print is freely distributable under the terms of MIT license.
 # See LICENSE file or http://www.opensource.org/licenses/mit-license.php
@@ -20,7 +20,7 @@ module AwesomePrint
           cast = :mongoid_class
         elsif object.class.ancestors.include?(::Mongoid::Document)
           cast = :mongoid_document
-        elsif object.is_a?(::BSON::ObjectId)
+        elsif (defined?(::BSON) && object.is_a?(::BSON::ObjectId)) || (defined?(::Moped::BSON) && object.is_a?(::Moped::BSON::ObjectId))
           cast = :mongoid_bson_id
         end
       end
@@ -44,7 +44,7 @@ module AwesomePrint
     def awesome_mongoid_document(object)
       return object.inspect if !defined?(::ActiveSupport::OrderedHash)
 
-      data = object.attributes.sort_by { |key| key }.inject(::ActiveSupport::OrderedHash.new) do |hash, c|
+      data = (object.attributes || {}).sort_by { |key| key }.inject(::ActiveSupport::OrderedHash.new) do |hash, c|
         hash[c[0].to_sym] = c[1]
         hash
       end

data/lib/awesome_print/ext/nobrainer.rb

@@ -0,0 +1,49 @@
+# Copyright (c) 2010-2013 Michael Dvorkin
+#
+# 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 NoBrainer
+
+    def self.included(base)
+      base.send :alias_method, :cast_without_nobrainer, :cast
+      base.send :alias_method, :cast, :cast_with_nobrainer
+    end
+
+    # Add NoBrainer class names to the dispatcher pipeline.
+    #------------------------------------------------------------------------------
+    def cast_with_nobrainer(object, type)
+      cast = cast_without_nobrainer(object, type)
+      if defined?(::NoBrainer::Document)
+        if object.is_a?(Class) && object < ::NoBrainer::Document
+          cast = :nobrainer_class
+        elsif object.is_a?(::NoBrainer::Document)
+          cast = :nobrainer_document
+        end
+      end
+      cast
+    end
+
+    # Format NoBrainer class object.
+    #------------------------------------------------------------------------------
+    def awesome_nobrainer_class(object)
+      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)
+    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
+      "#{object} #{awesome_hash(data)}"
+    end
+  end
+end
+
+AwesomePrint::Formatter.send(:include, AwesomePrint::NoBrainer)

data/lib/awesome_print/ext/nokogiri.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2011 Michael Dvorkin
+# Copyright (c) 2010-2013 Michael Dvorkin
 #
 # 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/ostruct.rb

@@ -0,0 +1,27 @@
+# Copyright (c) 2010-2013 Michael Dvorkin
+#
+# 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 OpenStruct
+    def self.included(base)
+      base.send :alias_method, :cast_without_ostruct, :cast
+      base.send :alias_method, :cast, :cast_with_ostruct
+    end
+
+    def cast_with_ostruct(object, type)
+      cast = cast_without_ostruct(object, type)
+      if (defined?(::OpenStruct)) && (object.is_a?(::OpenStruct))
+        cast = :open_struct_instance
+      end
+      cast
+    end
+
+    def awesome_open_struct_instance(object)
+      "#{object.class} #{awesome_hash(object.marshal_dump)}"
+    end
+  end
+end
+
+AwesomePrint::Formatter.send(:include, AwesomePrint::OpenStruct)

data/lib/awesome_print/ext/ripple.rb

@@ -0,0 +1,72 @@
+# Copyright (c) 2010-2013 Michael Dvorkin
+#
+# 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 Ripple
+
+    def self.included(base)
+      base.send :alias_method, :cast_without_ripple, :cast
+      base.send :alias_method, :cast, :cast_with_ripple
+    end
+
+    # Add Ripple class names to the dispatcher pipeline.
+    #------------------------------------------------------------------------------
+    def cast_with_ripple(object, type)
+      cast = cast_without_ripple(object, type)
+      return cast if !defined?(::Ripple)
+
+      if object.is_a?(::Ripple::AttributeMethods) # Module used to access attributes across documents and embedded documents
+        cast = :ripple_document_instance
+      elsif object.is_a?(::Ripple::Properties)    # Used to access property metadata on Ripple classes
+        cast = :ripple_document_class
+      end
+      cast
+    end
+
+    private
+
+    # Format Ripple instance object.
+    #
+    # NOTE: by default only instance attributes are shown. To format a Ripple document instance
+    # as a regular object showing its instance variables and accessors use :raw => true option:
+    #
+    # ap document, :raw => true
+    #
+    #------------------------------------------------------------------------------
+    def awesome_ripple_document_instance(object)
+      return object.inspect if !defined?(::ActiveSupport::OrderedHash)
+      return awesome_object(object) if @options[:raw]
+      exclude_assoc = @options[:exclude_assoc] or @options[:exclude_associations]
+
+      data = object.attributes.inject(::ActiveSupport::OrderedHash.new) do |hash, (name, value)|
+        hash[name.to_sym] = object.send(name)
+        hash
+      end
+
+      unless exclude_assoc
+        data = object.class.embedded_associations.inject(data) do |hash, assoc|
+          hash[assoc.name] = object.get_proxy(assoc) # Should always be array or Ripple::EmbeddedDocument for embedded associations
+          hash
+        end
+      end
+
+      "#{object} " << awesome_hash(data)
+    end
+
+    # Format Ripple class object.
+    #------------------------------------------------------------------------------
+    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)
+    end
+  end
+end
+
+AwesomePrint::Formatter.send(:include, AwesomePrint::Ripple)

data/lib/awesome_print/ext/sequel.rb

@@ -0,0 +1,57 @@
+# Copyright (c) 2010-2013 Michael Dvorkin
+#
+# 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 Sequel
+
+    def self.included(base)
+      base.send :alias_method, :cast_without_sequel, :cast
+      base.send :alias_method, :cast, :cast_with_sequel
+    end
+
+    # Add Sequel class names to the dispatcher pipeline.
+    #------------------------------------------------------------------------------
+    def cast_with_sequel(object, type)
+      cast = cast_without_sequel(object, type)
+      if defined?(::Sequel::Model) && object.is_a?(::Sequel::Model)
+        cast = :sequel_document
+      elsif defined?(::Sequel::Model) && object.is_a?(Class) && object.ancestors.include?(::Sequel::Model)
+        cast = :sequel_model_class
+      elsif defined?(::Sequel::Mysql2::Dataset) && object.class.ancestors.include?(::Sequel::Mysql2::Dataset)
+        cast = :sequel_dataset
+      end
+      cast
+    end
+
+    # Format Sequel Document object.
+    #------------------------------------------------------------------------------
+    def awesome_sequel_document(object)
+      data = object.values.sort_by { |key| key.to_s }.inject({}) do |hash, c|
+        hash[c[0].to_sym] = c[1]
+        hash
+      end
+      if !object.errors.empty?
+        data = {:errors => object.errors, :values => data}
+      end
+      "#{object} #{awesome_hash(data)}"
+    end
+
+    # Format Sequel Dataset object.
+    #------------------------------------------------------------------------------
+    def awesome_sequel_dataset(dataset)
+      [awesome_array(dataset.to_a), awesome_print(dataset.sql)].join("\n")
+    end
+
+    # 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)
+    end
+  end
+
+end
+
+AwesomePrint::Formatter.send(:include, AwesomePrint::Sequel)