awesome_print 0.3.1 → 0.3.2

data/CHANGELOG

@@ -1,3 +1,10 @@
+0.3.2
+  - Make sure Rails mixins get loaded in Rails console when required from .irbrc
+  - Fixed an issue with classes that define their own #send method (ex: Socket)
+  - Fixed compatibility issue with Liquid gem that defines Module#liquid_methods
+  - Fixed hash spec for Ruby < 1.9 where order of hash keys is not guaranteed
+  - Added :sorted_hash_keys option to sort hash keys (Ed Ruder)
+
 0.3.1 RubyConf X edition
   - Fixed Ruby 1.8.6 compatibility issues (thanks, Tim!)
   - Fixed stack overflow issue with Rails 2.3.x console

data/LICENSE

@@ -1,4 +1,5 @@
-Copyright (c) 2010 Michael Dvorkin
+Copyright (c) 2010-2011 Michael Dvorkin
+twitter.com/mid
 %w(mike dvorkin.net) * "@" || %w(mike fatfreecrm.com) * "@"
 
 Permission is hereby granted, free of charge, to any person obtaining

data/README.md

@@ -20,9 +20,11 @@ objects and usage within Rails templates are supported via included mixins.
 
 Default options:
 
-    :multiline => true,
-    :plain  => false,
-    :indent => 4,
+    :multiline => true,           # Display in multipe lines.
+    :plain  => false,             # Use colors.
+    :indent => 4,                 # Indent using 4 spaces.
+    :index  => true,              # Display array indices.
+    :sorted_hash_keys => false,   # Do not sort hash keys.
     :color => {
       :array      => :white,
       :bignum     => :blue,
@@ -263,7 +265,7 @@ For example:
 * Tobias Crawley -- http://github.com/tobias
 
 ### License ###
-Copyright (c) 2010 Michael Dvorkin
+Copyright (c) 2010-2011 Michael Dvorkin
 twitter.com/mid
 %w(mike dvorkin.net) * "@" || %w(mike fatfreecrm.com) * "@"
 

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.2

data/lib/ap.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010 Michael Dvorkin
+# Copyright (c) 2010-2011 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
@@ -8,7 +8,10 @@
 end
 
 require File.dirname(__FILE__) + "/ap/awesome_print"
-require File.dirname(__FILE__) + "/ap/core_ext/logger"      if defined?(::Logger)
-require File.dirname(__FILE__) + "/ap/mixin/action_view"    if defined?(::ActionView)
-require File.dirname(__FILE__) + "/ap/mixin/active_record"  if defined?(::ActiveRecord)
-require File.dirname(__FILE__) + "/ap/mixin/active_support" if defined?(::ActiveSupport)
+require File.dirname(__FILE__) + "/ap/core_ext/logger"   if defined?(Logger)
+require File.dirname(__FILE__) + "/ap/mixin/action_view" if defined?(ActionView)
+
+# Load the following under normal circumstatnces as well as in Rails
+# console when required from ~/.irbrc.
+require File.dirname(__FILE__) + "/ap/mixin/active_record"  if defined?(ActiveRecord)  || (defined?(IRB) && ENV['RAILS_ENV'])
+require File.dirname(__FILE__) + "/ap/mixin/active_support" if defined?(ActiveSupport) || (defined?(IRB) && ENV['RAILS_ENV'])

data/lib/ap/awesome_print.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010 Michael Dvorkin
+# Copyright (c) 2010-2011 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
@@ -15,6 +15,7 @@ class AwesomePrint
       :plain     => false,
       :indent    => 4,
       :index     => true,
+      :sorted_hash_keys => false,
       :color     => { 
         :array      => :white,
         :bigdecimal => :blue,
@@ -75,7 +76,8 @@ class AwesomePrint
   def awesome_hash(h)
     return "{}" if h == {}
 
-    data = h.keys.map do |key|
+    keys = @options[:sorted_hash_keys] ? h.keys.sort { |a, b| a.to_s <=> b.to_s } : h.keys
+    data = keys.map do |key|
       plain_single_line do
         [ awesome(key), h[key] ]
       end

data/lib/ap/core_ext/array.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010 Michael Dvorkin
+# Copyright (c) 2010-2011 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
@@ -16,7 +16,7 @@ class Array #:nodoc:
   [ :-, :& ].each do |operator|
     alias :"original_#{operator.object_id}" :"#{operator}"
     define_method operator do |*args|
-      arr = self.send(:"original_#{operator.object_id}", *args)
+      arr = self.__send__(:"original_#{operator.object_id}", *args)
       if self.instance_variable_defined?('@__awesome_methods__')
         arr.instance_variable_set('@__awesome_methods__', self.instance_variable_get('@__awesome_methods__'))
         arr.sort!

data/lib/ap/core_ext/class.rb

@@ -1,13 +1,15 @@
-# Copyright (c) 2010 Michael Dvorkin
+# Copyright (c) 2010-2011 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
 #------------------------------------------------------------------------------
 class Class #:nodoc:
-  methods.grep(/instance_methods$/) do |name|
+  # Remaining public/private etc. '_methods' are handled in core_ext/object.rb.
+  %w(instance_methods private_instance_methods protected_instance_methods public_instance_methods).each do |name|
     alias :"original_#{name}" :"#{name}"
+
     define_method name do |*args|
-      methods = self.send(:"original_#{name}", *args)
+      methods = self.__send__(:"original_#{name}", *args)
       methods.instance_variable_set('@__awesome_methods__', self) # Evil?!
       methods.sort!
     end

data/lib/ap/core_ext/kernel.rb

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

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

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

@@ -1,17 +1,17 @@
-# Copyright (c) 2010 Michael Dvorkin
+# Copyright (c) 2010-2011 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
 #------------------------------------------------------------------------------
 class Object #:nodoc:
-  methods.grep(/methods$/) do |name|
-    next if name.to_s.include? 'instance' # Instance methods are trapped in Class.
-
+  # Remaining instance '_methods' are handled in core_ext/class.rb.
+  %w(methods private_methods protected_methods public_methods singleton_methods).each do |name|
     alias :"original_#{name}" :"#{name}"
+
     define_method name do |*args|
-      methods = self.send(:"original_#{name}", *args)
+      methods = self.__send__(:"original_#{name}", *args)
       methods.instance_variable_set('@__awesome_methods__', self) # Evil?!
       methods.sort!
     end
   end
-end
+end

data/lib/ap/core_ext/string.rb

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

@@ -1,4 +1,4 @@
-# Copyright (c) 2010 Michael Dvorkin
+# Copyright (c) 2010-2011 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
@@ -35,4 +35,4 @@ module AwesomePrintActionView
 
 end
 
-ActionView::Base.send(:include, AwesomePrintActionView) if defined?(::ActionView)
+ActionView::Base.send(:include, AwesomePrintActionView) if defined?(ActionView)

data/lib/ap/mixin/active_record.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010 Michael Dvorkin
+# Copyright (c) 2010-2011 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,6 +14,8 @@ module AwesomePrintActiveRecord
   #------------------------------------------------------------------------------
   def printable_with_active_record(object)
     printable = printable_without_active_record(object)
+    return printable if !defined?(ActiveRecord::Base)
+
     if printable == :self
       if object.is_a?(ActiveRecord::Base)
         printable = :active_record_instance
@@ -27,6 +29,8 @@ module AwesomePrintActiveRecord
   # Format ActiveRecord instance object.
   #------------------------------------------------------------------------------
   def awesome_active_record_instance(object)
+    return object.inspect if !defined?(ActiveSupport::OrderedHash)
+
     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?
       hash
@@ -37,17 +41,14 @@ module AwesomePrintActiveRecord
   # Format ActiveRecord class object.
   #------------------------------------------------------------------------------
   def awesome_active_record_class(object)
-    if object.respond_to?(:columns)
-      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)
-    else
-      object.inspect
+    return object.inspect if !defined?(ActiveSupport::OrderedHash) || !object.respond_to?(:columns)
+
+    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)
   end
-  
 end
 
 AwesomePrint.send(:include, AwesomePrintActiveRecord)

data/lib/ap/mixin/active_support.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010 Michael Dvorkin
+# Copyright (c) 2010-2011 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,6 +14,8 @@ module AwesomePrintActiveSupport
   #------------------------------------------------------------------------------
   def printable_with_active_support(object)
     printable = printable_without_active_support(object)
+    return printable if !defined?(ActiveSupport::TimeWithZone) || !defined?(HashWithIndifferentAccess)
+
     if printable == :self
       if object.is_a?(ActiveSupport::TimeWithZone)
         printable = :active_support_time

data/lib/awesome_print.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010 Michael Dvorkin
+# Copyright (c) 2010-2011 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
@@ -15,7 +15,10 @@
 end
 
 require File.dirname(__FILE__) + "/ap/awesome_print"
-require File.dirname(__FILE__) + "/ap/core_ext/logger"      if defined?(::Logger)
-require File.dirname(__FILE__) + "/ap/mixin/action_view"    if defined?(::ActionView)
-require File.dirname(__FILE__) + "/ap/mixin/active_record"  if defined?(::ActiveRecord)
-require File.dirname(__FILE__) + "/ap/mixin/active_support" if defined?(::ActiveSupport)
+require File.dirname(__FILE__) + "/ap/core_ext/logger"   if defined?(Logger)
+require File.dirname(__FILE__) + "/ap/mixin/action_view" if defined?(ActionView)
+
+# Load the following under normal circumstatnces as well as in Rails
+# console when required from ~/.irbrc.
+require File.dirname(__FILE__) + "/ap/mixin/active_record"  if defined?(ActiveRecord)  || (defined?(IRB) && ENV['RAILS_ENV'])
+require File.dirname(__FILE__) + "/ap/mixin/active_support" if defined?(ActiveSupport) || (defined?(IRB) && ENV['RAILS_ENV'])

data/rails/init.rb

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

@@ -263,6 +263,45 @@ EOS
     end
   end
 
+  #------------------------------------------------------------------------------
+  describe "Hash with several keys" do
+    before(:each) do
+      @hash = {"b" => "b", :a => "a", :z => "z", "alpha" => "alpha"}
+    end
+
+    it "plain multiline" do
+      out = @hash.ai(:plain => true)
+      if RUBY_VERSION.to_f < 1.9 # Order of @hash keys is not guaranteed.
+        out.should =~ /^\{[^\}]+\}/m
+        out.should =~ /        "b" => "b",?/
+        out.should =~ /         :a => "a",?/
+        out.should =~ /         :z => "z",?/
+        out.should =~ /    "alpha" => "alpha",?$/
+      else
+        out.should == <<-EOS.strip
+{
+        "b" => "b",
+         :a => "a",
+         :z => "z",
+    "alpha" => "alpha"
+}
+EOS
+      end
+    end
+    
+    it "plain multiline with sorted keys" do
+      @hash.ai(:plain => true, :sorted_hash_keys => true).should == <<-EOS.strip
+{
+         :a => "a",
+    "alpha" => "alpha",
+        "b" => "b",
+         :z => "z"
+}
+EOS
+    end
+
+  end
+
   #------------------------------------------------------------------------------
   describe "Negative options[:indent]" do
     before(:each) do
@@ -475,5 +514,14 @@ EOS
       my = My.new('/tmp')
       my.ai(:plain => true).should == "#{my.inspect}\n" << `ls -alF #{my.path}`.chop
     end
+
+    it "should handle a class that defines its own #send method" do
+      class My
+        def send(arg1, arg2, arg3); end
+      end
+
+      my = My.new
+      my.methods.ai(:plain => true).should_not raise_error(ArgumentError)
+    end
   end
 end

data/spec/spec_helper.rb

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

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - Michael Dvorkin
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-13 00:00:00 -08:00
+date: 2011-02-02 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency