awesome_print 1.1.0 → 1.2.0

data/lib/ap.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2012 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.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2012 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
@@ -29,4 +29,7 @@ unless defined?(AwesomePrint::Inspector)
   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)
 end

data/lib/awesome_print/core_ext/array.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2012 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/class.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2012 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-2012 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,7 +7,12 @@ 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
 

data/lib/awesome_print/core_ext/logger.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2012 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-2012 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-2012 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-2012 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-2012 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-2012 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
@@ -43,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)

data/lib/awesome_print/ext/active_support.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2012 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/mongo_mapper.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2012 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/mongoid.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2012 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
@@ -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/no_brainer.rb

@@ -0,0 +1,58 @@
+# 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_no_brainer, :cast
+      base.send :alias_method, :cast, :cast_with_no_brainer
+    end
+
+    # Add NoBrainer class names to the dispatcher pipeline.
+    #------------------------------------------------------------------------------
+    def cast_with_no_brainer(object, type)
+      cast = cast_without_no_brainer(object, type)
+      if defined?(::NoBrainer::Document)
+        if object.is_a?(Class) && object.ancestors.include?(::NoBrainer::Document)
+          cast = :no_brainer_class
+        elsif object.class.ancestors.include?(::NoBrainer::Document)
+          cast = :no_brainer_document
+        end
+      end
+      cast
+    end
+
+    # Format NoBrainer class object.
+    #------------------------------------------------------------------------------
+    def awesome_no_brainer_class(object)
+      return object.inspect if !defined?(::ActiveSupport::OrderedHash) || !object.respond_to?(:fields)
+
+      # We want id first
+      data = object.fields.sort_by { |key| key[0] == :id ? '_id' : key[0].to_s }.inject(::ActiveSupport::OrderedHash.new) do |hash, c|
+        hash[c[0]] = :object
+        hash
+      end
+      "class #{object} < #{object.superclass} " << awesome_hash(data)
+    end
+
+    # Format NoBrainer Document object.
+    #------------------------------------------------------------------------------
+    def awesome_no_brainer_document(object)
+      return object.inspect if !defined?(::ActiveSupport::OrderedHash)
+
+      data = object.attributes.sort_by { |key| key }.inject(::ActiveSupport::OrderedHash.new) do |hash, c|
+        hash[c[0].to_sym] = c[1]
+        hash
+      end
+      if !object.errors.empty?
+        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-2012 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/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)

data/lib/awesome_print/formatter.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2012 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
@@ -9,7 +9,7 @@ require "shellwords"
 module AwesomePrint
   class Formatter
 
-    CORE = [ :array, :hash, :class, :file, :dir, :bigdecimal, :rational, :struct, :method, :unboundmethod ]
+    CORE = [ :array, :bigdecimal, :class, :dir, :file, :hash, :method, :rational, :set, :struct, :unboundmethod ]
     DEFAULT_LIMIT_SIZE = 7
 
     def initialize(inspector)
@@ -27,7 +27,7 @@ module AwesomePrint
       else
         awesome_self(object, type) # Catch all that falls back to object.inspect.
       end
-      @options[:html] ? "<pre>#{awesome}</pre>" : awesome
+      awesome
     end
 
     # Hook this when adding custom formatters. Check out lib/awesome_print/ext
@@ -63,6 +63,8 @@ module AwesomePrint
     def awesome_self(object, type)
       if @options[:raw] && object.instance_variables.any?
         awesome_object(object)
+      elsif object == ENV
+        awesome_hash(object.to_hash)
       else
         colorize(object.inspect.to_s, type)
       end
@@ -126,7 +128,7 @@ module AwesomePrint
     #------------------------------------------------------------------------------
     def awesome_object(o)
       vars = o.instance_variables.map do |var|
-        property = var[1..-1].to_sym
+        property = var.to_s[1..-1].to_sym # to_s because of some monkey patching done by Puppet.
         accessor = if o.respond_to?(:"#{property}=")
           o.respond_to?(property) ? :accessor : :writer
         else
@@ -162,6 +164,12 @@ module AwesomePrint
       end
     end
 
+    # Format a set.
+    #------------------------------------------------------------------------------
+    def awesome_set(s)
+      awesome_array(s.to_a)
+    end
+
     # Format a Struct.
     #------------------------------------------------------------------------------
     def awesome_struct(s)
@@ -237,9 +245,9 @@ module AwesomePrint
             if the_method && the_method.respond_to?(:arity) # Is this original object#method?
               method_tuple(the_method)                      # Yes, we are good.
             end
-          elsif object.respond_to?(:instance_method)        # Is this an unbound method?
-            method_tuple(object.instance_method(name))
-          end
+          elsif object.respond_to?(:instance_method)              # Is this an unbound method?
+            method_tuple(object.instance_method(name)) rescue nil # Rescue to avoid NameError when the method is not
+          end                                                     # available (ex. File.lchmod on Ubuntu 12).
         end
         tuple || [ name.to_s, '(?)', '?' ]                  # Return WTF default if all the above fails.
       end

data/lib/awesome_print/inspector.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2012 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/version.rb

@@ -1,10 +1,10 @@
-# Copyright (c) 2010-2012 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
 #------------------------------------------------------------------------------
 module AwesomePrint
   def self.version
-    '1.1.0'
+    "1.2.0"
   end
 end

data/spec/formats_spec.rb

@@ -1,6 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 require "bigdecimal"
 require "rational"
+require "set"
 
 describe "AwesomePrint" do
   before do
@@ -511,6 +512,52 @@ EOS
     end
   end
 
+  #------------------------------------------------------------------------------
+  describe "Set" do
+    before do
+      @arr = [1, :two, "three" ]
+      @set = Set.new(@arr)
+    end
+
+    it "empty set" do
+      Set.new.ai.should == [].ai
+    end
+
+    if RUBY_VERSION > "1.9"
+      it "plain multiline" do
+        @set.ai(:plain => true).should == @arr.ai(:plain => true)
+      end
+
+      it "plain multiline indented" do
+        @set.ai(:plain => true, :indent => 1).should == @arr.ai(:plain => true, :indent => 1)
+      end
+
+      it "plain single line" do
+        @set.ai(:plain => true, :multiline => false).should == @arr.ai(:plain => true, :multiline => false)
+      end
+
+      it "colored multiline (default)" do
+        @set.ai.should == @arr.ai
+      end
+    else # Prior to Ruby 1.9 the order of set values is unpredicatble.
+      it "plain multiline" do
+        @set.sort_by{ |x| x.to_s }.ai(:plain => true).should == @arr.sort_by{ |x| x.to_s }.ai(:plain => true)
+      end
+
+      it "plain multiline indented" do
+        @set.sort_by{ |x| x.to_s }.ai(:plain => true, :indent => 1).should == @arr.sort_by{ |x| x.to_s }.ai(:plain => true, :indent => 1)
+      end
+
+      it "plain single line" do
+        @set.sort_by{ |x| x.to_s }.ai(:plain => true, :multiline => false).should == @arr.sort_by{ |x| x.to_s }.ai(:plain => true, :multiline => false)
+      end
+
+      it "colored multiline (default)" do
+        @set.sort_by{ |x| x.to_s }.ai.should == @arr.sort_by{ |x| x.to_s }.ai
+      end
+    end
+  end
+
   #------------------------------------------------------------------------------
   describe "Struct" do
     before do