amazing_print 1.0.0

data/lib/amazing_print/ext/active_support.rb

@@ -0,0 +1,45 @@
+# Copyright (c) 2010-2016 Michael Dvorkin and contributors
+#
+# AmazingPrint is freely distributable under the terms of MIT license.
+# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+module AmazingPrint
+  module ActiveSupport
+    def self.included(base)
+      base.send :alias_method, :cast_without_active_support, :cast
+      base.send :alias_method, :cast, :cast_with_active_support
+    end
+
+    def cast_with_active_support(object, type)
+      cast = cast_without_active_support(object, type)
+      if defined?(::ActiveSupport) && defined?(::HashWithIndifferentAccess)
+        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
+        end
+      end
+      cast
+    end
+
+    # Format ActiveSupport::TimeWithZone as standard Time.
+    #------------------------------------------------------------------------------
+    def awesome_active_support_time(object)
+      colorize(object.inspect, :time)
+    end
+
+    # Format HashWithIndifferentAccess as standard Hash.
+    #------------------------------------------------------------------------------
+    def awesome_hash_with_indifferent_access(object)
+      awesome_hash(object)
+    end
+  end
+end
+
+AmazingPrint::Formatter.include AmazingPrint::ActiveSupport
+#
+# Colorize Rails logs.
+#
+if defined?(ActiveSupport::LogSubscriber)
+  AmazingPrint.force_colors! ActiveSupport::LogSubscriber.colorize_logging
+end

data/lib/amazing_print/ext/mongo_mapper.rb

@@ -0,0 +1,125 @@
+# Copyright (c) 2010-2016 Michael Dvorkin and contributors
+#
+# AmazingPrint is freely distributable under the terms of MIT license.
+# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+module AmazingPrint
+  module MongoMapper
+    def self.included(base)
+      base.send :alias_method, :cast_without_mongo_mapper, :cast
+      base.send :alias_method, :cast, :cast_with_mongo_mapper
+    end
+
+    # 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)
+        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
+
+    # Format MongoMapper class object.
+    #------------------------------------------------------------------------------
+    def awesome_mongo_mapper_class(object)
+      if !defined?(::ActiveSupport::OrderedHash) || !object.respond_to?(:keys)
+        return object.inspect
+      end
+
+      data = object.keys.sort.each_with_object(::ActiveSupport::OrderedHash.new) do |c, hash|
+        hash[c.first] = (c.last.type || 'undefined').to_s.underscore.intern
+      end
+
+      # Add in associations
+      if @options[:mongo_mapper][:show_associations]
+        object.associations.each do |name, assoc|
+          data[name.to_s] = assoc
+        end
+      end
+
+      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.
+    #
+    # 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 unless defined?(::ActiveSupport::OrderedHash)
+      return awesome_object(object) if @options[:raw]
+
+      data = object.keys.keys.sort.each_with_object(::ActiveSupport::OrderedHash.new) do |name, hash|
+        hash[name] = object[name]
+      end
+
+      # Add in associations
+      if @options[:mongo_mapper][:show_associations]
+        object.associations.each do |name, assoc|
+          data[name.to_s] = if @options[:mongo_mapper][:inline_embedded] && assoc.embeddable?
+                              object.send(name)
+                            else
+                              assoc
+                            end
+        end
+      end
+
+      label = object.to_s
+      if object.is_a?(::MongoMapper::EmbeddedDocument)
+        label = "#{colorize('embedded', :assoc)} #{label}"
+      end
+
+      "#{label} " << awesome_hash(data)
+    end
+
+    # Format MongoMapper association object.
+    #------------------------------------------------------------------------------
+    def awesome_mongo_mapper_association(object)
+      return object.inspect unless 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
+
+AmazingPrint::Formatter.include AmazingPrint::MongoMapper

data/lib/amazing_print/ext/mongoid.rb

@@ -0,0 +1,68 @@
+# Copyright (c) 2010-2016 Michael Dvorkin and contributors
+#
+# AmazingPrint is freely distributable under the terms of MIT license.
+# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+module AmazingPrint
+  module Mongoid
+    def self.included(base)
+      base.send :alias_method, :cast_without_mongoid, :cast
+      base.send :alias_method, :cast, :cast_with_mongoid
+    end
+
+    # Add Mongoid class names to the dispatcher pipeline.
+    #------------------------------------------------------------------------------
+    def cast_with_mongoid(object, type)
+      cast = cast_without_mongoid(object, type)
+      if defined?(::Mongoid::Document)
+        if object.is_a?(Class) && object.ancestors.include?(::Mongoid::Document)
+          cast = :mongoid_class
+        elsif object.class.ancestors.include?(::Mongoid::Document)
+          cast = :mongoid_document
+        elsif (defined?(::BSON) && object.is_a?(::BSON::ObjectId)) || (defined?(::Moped::BSON) && object.is_a?(::Moped::BSON::ObjectId))
+          cast = :mongoid_bson_id
+        end
+      end
+      cast
+    end
+
+    # Format Mongoid class object.
+    #------------------------------------------------------------------------------
+    def awesome_mongoid_class(object)
+      if !defined?(::ActiveSupport::OrderedHash) || !object.respond_to?(:fields)
+        return object.inspect
+      end
+
+      data = object.fields.sort.each_with_object(::ActiveSupport::OrderedHash.new) do |c, hash|
+        hash[c[1].name.to_sym] = (c[1].type || 'undefined').to_s.underscore.intern
+      end
+
+      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.
+    #------------------------------------------------------------------------------
+    def awesome_mongoid_document(object)
+      return object.inspect unless defined?(::ActiveSupport::OrderedHash)
+
+      data = (object.attributes || {}).sort.each_with_object(::ActiveSupport::OrderedHash.new) do |c, hash|
+        hash[c[0].to_sym] = c[1]
+      end
+      unless object.errors.empty?
+        data = { errors: object.errors, attributes: data }
+      end
+      "#{object} #{awesome_hash(data)}"
+    end
+
+    # Format BSON::ObjectId
+    #------------------------------------------------------------------------------
+    def awesome_mongoid_bson_id(object)
+      object.inspect
+    end
+  end
+end
+
+AmazingPrint::Formatter.include AmazingPrint::Mongoid

data/lib/amazing_print/ext/nobrainer.rb

@@ -0,0 +1,53 @@
+# Copyright (c) 2010-2016 Michael Dvorkin and contributors
+#
+# AmazingPrint is freely distributable under the terms of MIT license.
+# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+module AmazingPrint
+  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)
+      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]
+
+      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
+      "#{object} #{awesome_hash(data)}"
+    end
+  end
+end
+
+AmazingPrint::Formatter.include AmazingPrint::NoBrainer

data/lib/amazing_print/ext/nokogiri.rb

@@ -0,0 +1,45 @@
+# Copyright (c) 2010-2016 Michael Dvorkin and contributors
+#
+# AmazingPrint is freely distributable under the terms of MIT license.
+# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+module AmazingPrint
+  module Nokogiri
+    def self.included(base)
+      base.send :alias_method, :cast_without_nokogiri, :cast
+      base.send :alias_method, :cast, :cast_with_nokogiri
+    end
+
+    # Add Nokogiri XML Node and NodeSet names to the dispatcher pipeline.
+    #------------------------------------------------------------------------------
+    def cast_with_nokogiri(object, type)
+      cast = cast_without_nokogiri(object, type)
+      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
+      cast
+    end
+
+    #------------------------------------------------------------------------------
+    def awesome_nokogiri_xml_node(object)
+      return '[]' if object.is_a?(::Nokogiri::XML::NodeSet) && object.empty?
+
+      xml = object.to_xml(indent: 2)
+      #
+      # Colorize tag, id/class name, and contents.
+      #
+      xml.gsub!(%r{(<)(/?[A-Za-z1-9]+)}) { |_tag| "#{Regexp.last_match(1)}#{colorize(Regexp.last_match(2), :keyword)}" }
+      xml.gsub!(/(id|class)="[^"]+"/i) { |id| colorize(id, :class) }
+      xml.gsub!(/>([^<]+)</) do |contents|
+        if contents && !contents.empty?
+          contents = colorize(Regexp.last_match(1), :trueclass)
+        end
+        ">#{contents}<"
+      end
+      xml
+    end
+  end
+end
+
+AmazingPrint::Formatter.include AmazingPrint::Nokogiri

data/lib/amazing_print/ext/ostruct.rb

@@ -0,0 +1,27 @@
+# Copyright (c) 2010-2016 Michael Dvorkin and contributors
+#
+# AmazingPrint is freely distributable under the terms of MIT license.
+# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+module AmazingPrint
+  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
+
+AmazingPrint::Formatter.include AmazingPrint::OpenStruct

data/lib/amazing_print/ext/ripple.rb

@@ -0,0 +1,71 @@
+# Copyright (c) 2010-2016 Michael Dvorkin and contributors
+#
+# AmazingPrint is freely distributable under the terms of MIT license.
+# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+module AmazingPrint
+  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 unless 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 unless defined?(::ActiveSupport::OrderedHash)
+      return awesome_object(object) if @options[:raw]
+
+      (exclude_assoc = @options[:exclude_assoc]) || @options[:exclude_associations]
+
+      data = object.attributes.each_with_object(::ActiveSupport::OrderedHash.new) do |(name, _value), hash|
+        hash[name.to_sym] = object.send(name)
+      end
+
+      unless exclude_assoc
+        data = object.class.embedded_associations.each_with_object(data) do |assoc, hash|
+          hash[assoc.name] = object.get_proxy(assoc) # Should always be array or Ripple::EmbeddedDocument for embedded associations
+        end
+      end
+
+      "#{object} " << awesome_hash(data)
+    end
+
+    # Format Ripple class object.
+    #------------------------------------------------------------------------------
+    def awesome_ripple_document_class(object)
+      if !defined?(::ActiveSupport::OrderedHash) || !object.respond_to?(:properties)
+        return object.inspect
+      end
+
+      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
+
+AmazingPrint::Formatter.include AmazingPrint::Ripple

data/lib/amazing_print/ext/sequel.rb

@@ -0,0 +1,55 @@
+# Copyright (c) 2010-2016 Michael Dvorkin and contributors
+#
+# AmazingPrint is freely distributable under the terms of MIT license.
+# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+module AmazingPrint
+  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 }.each_with_object({}) do |c, hash|
+        hash[c[0].to_sym] = c[1]
+      end
+      data = { errors: object.errors, values: data } unless object.errors.empty?
+      "#{object} #{awesome_hash(data)}"
+    end
+
+    # Format Sequel Dataset object.
+    #------------------------------------------------------------------------------
+    def awesome_sequel_dataset(dataset)
+      [awesome_array(dataset.to_a), amazing_print(dataset.sql)].join("\n")
+    end
+
+    # Format Sequel Model class.
+    #------------------------------------------------------------------------------
+    def awesome_sequel_model_class(object)
+      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
+end
+
+AmazingPrint::Formatter.include AmazingPrint::Sequel