awesome_print 0.1.4 → 0.2.0

data/CHANGELOG

@@ -1,3 +1,9 @@
+0.2.0
+  - Added support for logger.ap (including Rails logger)
+  - Added support for HashWithIndifferentAccess from ActiveSupport
+  - ap now works with scripts that use ActiveRecord/ActiveSupport outside Rails
+  - ap now correctly shows file and directory names with fancy characters (shell escape)
+
 0.1.4
   - Format BigDecimal and Rational objects as Float scalars
   - Explicit options parameter can override custom defaults

data/README.md

@@ -144,6 +144,32 @@ Supported color names:
     }
     rails>
 
+### IRB integration ###
+To use awesome_print as default formatter in irb and Rails console add the following
+lines into your ~/.irbrc file:
+
+	require "rubygems"
+	require "ap"
+	IRB::Irb.class_eval do
+	  def output_value
+	    ap @context.last_value
+	  end
+	end
+
+### Logger Convenience Method ###
+awesome_print adds an ap method to the Logger and ActiveSupport::BufferedLogger classes,
+allowing you to call:
+
+    logger.ap object
+
+By default, this logs at the :debug level. You can override that globally with
+
+    :log_level => :info
+
+in the custom defaults (see below), or you can override on a per call basis with
+
+    logger.ap object, :warn
+
 ### Setting Custom Defaults ###
 You can set your own default options by creating ``.aprc`` file in your home
 directory. Within that file assign your  defaults to ``AwesomePrint.defaults``.
@@ -165,8 +191,14 @@ For example:
 * Commit, do not mess with rakefile, version, or history.
 * Send me a pull request.
 
+### Contributors ###
+
+* Daniel Bretoi -- http://github.com/danielb2
+* eregon -- http://github.com/eregon
+* Tobias Crawley -- http://github.com/tobias
+
 ### License ###
 Copyright (c) 2010 Michael Dvorkin  
 %w(mike dvorkin.net) * "@" || %w(mike fatfreecrm.com) * "@"
 
-Released under the MIT license. See LICENSE file for details.
+Released under the MIT license. See LICENSE file for details.

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.2.0

data/lib/ap.rb

@@ -7,4 +7,8 @@ require File.dirname(__FILE__) + "/ap/core_ext/string"
 require File.dirname(__FILE__) + "/ap/core_ext/kernel"
 require File.dirname(__FILE__) + "/ap/awesome_print"
 
-require File.dirname(__FILE__) + "/ap/mixin/rails" if defined?(::Rails)
+require File.dirname(__FILE__) + "/ap/core_ext/logger" if defined?(::Logger) or defined?(::ActiveSupport::BufferedLogger)
+
+require File.dirname(__FILE__) + "/ap/mixin/active_record" if defined?(::ActiveRecord)
+require File.dirname(__FILE__) + "/ap/mixin/active_support" if defined?(::ActiveSupport)
+

data/lib/ap/awesome_print.rb

@@ -3,6 +3,8 @@
 # Awesome Print is freely distributable under the terms of MIT license.
 # See LICENSE file or http://www.opensource.org/licenses/mit-license.php
 #------------------------------------------------------------------------------
+require "shellwords"
+
 class AwesomePrint
   AP = :__awesome_print__
   CORE = [ :array, :hash, :class, :file, :dir, :bigdecimal, :rational ]
@@ -20,7 +22,7 @@ class AwesomePrint
         :falseclass => :red,
         :fixnum     => :blue,
         :float      => :blue,
-        :hash       => :gray,
+        :hash       => :pale,
         :nilclass   => :red,
         :string     => :yellowish,
         :symbol     => :cyanish,
@@ -36,8 +38,7 @@ class AwesomePrint
     @indentation = @options[:indent].abs
     Thread.current[AP] ||= []
   end
-
-
+  
   private
 
   # Format an array.
@@ -104,14 +105,14 @@ class AwesomePrint
   # Format File object.
   #------------------------------------------------------------------------------
   def awesome_file(f)
-    ls = File.directory?(f) ? `ls -adlF #{f.path}` : `ls -alF #{f.path}`
+    ls = File.directory?(f) ? `ls -adlF #{f.path.shellescape}` : `ls -alF #{f.path.shellescape}`
     awesome_self(f, :with => ls.empty? ? nil : "\n#{ls.chop}")
   end
 
   # Format Dir object.
   #------------------------------------------------------------------------------
   def awesome_dir(d)
-    ls = `ls -alF #{d.path}`
+    ls = `ls -alF #{d.path.shellescape}`
     awesome_self(d, :with => ls.empty? ? nil : "\n#{ls.chop}")
   end
 

data/lib/ap/core_ext/logger.rb

@@ -0,0 +1,18 @@
+# Copyright (c) 2010 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 AwesomePrintLogger
+
+  # Add ap method to logger
+  #------------------------------------------------------------------------------
+  def ap(object, level = nil)
+    level ||= AwesomePrint.defaults[:log_level] || :debug
+    send level, object.ai
+  end
+
+end
+
+Logger.send(:include, AwesomePrintLogger) if defined?(Logger)
+ActiveSupport::BufferedLogger.send(:include, AwesomePrintLogger) if defined?(::ActiveSupport::BufferedLogger)

data/lib/ap/mixin/{rails.rb → active_record.rb}

@@ -3,23 +3,22 @@
 # Awesome Print is freely distributable under the terms of MIT license.
 # See LICENSE file or http://www.opensource.org/licenses/mit-license.php
 #------------------------------------------------------------------------------
-module AwesomePrintRails
+module AwesomePrintActiveRecord
 
   def self.included(base)
-    base.alias_method_chain :printable, :rails
+    base.send :alias_method, :printable_without_active_record, :printable
+    base.send :alias_method, :printable, :printable_with_active_record
   end
 
   # Add ActiveRecord class names to the dispatcher pipeline.
   #------------------------------------------------------------------------------
-  def printable_with_rails(object)
-    printable = printable_without_rails(object)
+  def printable_with_active_record(object)
+    printable = printable_without_active_record(object)
     if printable == :self
       if object.is_a?(ActiveRecord::Base)
         printable = :active_record_instance
-      elsif object.is_a?(ActiveSupport::TimeWithZone)
-        printable = :active_support_time
       end
-    elsif printable == :class && object.class.is_a?(ActiveRecord::Base.class)
+    elsif printable == :class and object.ancestors.include?(ActiveRecord::Base)
       printable = :active_record_class
     end
     printable
@@ -48,13 +47,7 @@ module AwesomePrintRails
       object.inspect
     end
   end
-
-  # Format ActiveSupport::TimeWithZone as standard Time.
-  #------------------------------------------------------------------------------
-  def awesome_active_support_time(object)
-    awesome_self(object, :as => :time)
-  end
-
+  
 end
 
-AwesomePrint.send(:include, AwesomePrintRails)
+AwesomePrint.send(:include, AwesomePrintActiveRecord)

data/lib/ap/mixin/active_support.rb

@@ -0,0 +1,44 @@
+# Copyright (c) 2010 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 AwesomePrintActiveSupport
+
+  def self.included(base)
+    base.send :alias_method, :printable_without_active_support, :printable
+    base.send :alias_method, :printable, :printable_with_active_support
+  end
+
+  # Add ActiveSupport class names to the dispatcher pipeline.
+  #------------------------------------------------------------------------------
+  def printable_with_active_support(object)
+    printable = printable_without_active_support(object)
+    if printable == :self
+      if object.is_a?(ActiveSupport::TimeWithZone)
+        printable = :active_support_time
+      elsif object.is_a?(HashWithIndifferentAccess)
+        printable = :hash_with_indifferent_access
+      end
+    end
+    printable
+  end
+
+  # Format ActiveSupport::TimeWithZone as standard Time.
+  #------------------------------------------------------------------------------
+  def awesome_active_support_time(object)
+    awesome_self(object, :as => :time)
+  end
+
+  # Format HashWithIndifferentAccess as standard Hash.
+  #
+  # NOTE: can't use awesome_self(object, :as => :hash) since awesome_self uses
+  # object.inspect internally, i.e. it would convert hash to string.
+  #------------------------------------------------------------------------------
+  def awesome_hash_with_indifferent_access(object)
+    awesome_hash(object)
+  end
+
+end
+
+AwesomePrint.send(:include, AwesomePrintActiveSupport)

data/spec/{rails_spec.rb → active_record_spec.rb}

@@ -1,6 +1,10 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-if defined?(::Rails)
+require 'active_record'
+require 'ap/mixin/active_record'
+
+
+if defined?(::ActiveRecord)
 
   # Create tableless ActiveRecord model.
   #------------------------------------------------------------------------------
@@ -18,9 +22,19 @@ if defined?(::Rails)
     column :rank, :integer
     column :admin, :boolean
     column :created_at, :datetime
-  end
 
-  describe "AwesomePrint/Rails" do
+    def self.table_exists?
+      true
+    end
+  end
+  
+  class SubUser < User
+    def self.columns
+      User.columns
+    end
+  end
+  
+  describe "AwesomePrint/ActiveRecord" do
     before(:each) do
       stub_dotfile!
     end
@@ -28,6 +42,7 @@ if defined?(::Rails)
     #------------------------------------------------------------------------------
     describe "ActiveRecord instance" do
       before(:each) do
+        ActiveRecord::Base.default_timezone = :utc
         @diana = User.new(:name => "Diana", :rank => 1, :admin => false, :created_at => "1992-10-10 12:30:00")
         @laura = User.new(:name => "Laura", :rank => 2, :admin => true,  :created_at => "2003-05-26 14:15:00")
         @ap = AwesomePrint.new(:plain => true)
@@ -41,7 +56,7 @@ if defined?(::Rails)
           :name => "Diana",
           :rank => 1,
          :admin => false,
-    :created_at => Sat, 10 Oct 1992 12:30:00 UTC +00:00
+    :created_at => Sat Oct 10 12:30:00 UTC 1992
 }
 EOS
       end
@@ -55,14 +70,14 @@ EOS
               :name => "Diana",
               :rank => 1,
              :admin => false,
-        :created_at => Sat, 10 Oct 1992 12:30:00 UTC +00:00
+        :created_at => Sat Oct 10 12:30:00 UTC 1992
     },
     [1] #<User:0x01234567> {
                 :id => nil,
               :name => "Laura",
               :rank => 2,
              :admin => true,
-        :created_at => Mon, 26 May 2003 14:15:00 UTC +00:00
+        :created_at => Mon May 26 14:15:00 UTC 2003
     }
 ]
 EOS
@@ -71,7 +86,7 @@ EOS
 
     #------------------------------------------------------------------------------
     describe "ActiveRecord class" do
-      it "should" do
+      it "should print the class" do
         @ap = AwesomePrint.new(:plain => true)
         @ap.send(:awesome, User).should == <<-EOS.strip
 class User < ActiveRecord::Base {
@@ -81,7 +96,22 @@ class User < ActiveRecord::Base {
          :admin => :boolean,
     :created_at => :datetime
 }
-EOS
+        EOS
+  
+end
+
+it "should print the class for non-direct subclasses of AR::Base" do
+  @ap = AwesomePrint.new(:plain => true)
+  @ap.send(:awesome, SubUser).should == <<-EOS.strip
+class SubUser < User {
+            :id => :integer,
+          :name => :string,
+          :rank => :integer,
+         :admin => :boolean,
+    :created_at => :datetime
+}
+  EOS
+  
       end
     end
   end

data/spec/awesome_print_spec.rb

@@ -267,7 +267,7 @@ EOS
   #------------------------------------------------------------------------------
   describe "BigDecimal and Rational" do
     it "should present BigDecimal object as Float scalar" do
-      big = BigDecimal("2010.04")
+      big = BigDecimal("2010.4")
       big.ai(:plain => true).should == "2010.4"
     end
 

data/spec/logger_spec.rb

@@ -0,0 +1,43 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+
+require 'logger'
+require 'ap/core_ext/logger'
+
+describe "AwesomePrint logging extensions" do
+  before(:all) do
+    @logger = Logger.new('/dev/null')
+  end
+
+  describe "ap method" do
+    it "should awesome_inspect the given object" do
+      object = mock
+      object.should_receive(:ai)
+      @logger.ap object
+    end
+    
+    describe "the log level" do
+      before(:each) do
+        AwesomePrint.defaults = { }
+      end
+      
+      it "should fallback to the default :debug log level" do
+        @logger.should_receive(:debug)
+        @logger.ap(nil)
+      end
+
+      it "should use the global user default if no level passed" do
+        AwesomePrint.defaults = { :log_level => :info }
+        @logger.should_receive(:info)
+        @logger.ap(nil)
+      end
+
+      it "should use the passed in level" do
+        @logger.should_receive(:warn)
+        @logger.ap(nil, :warn)
+      end
+    end
+  end
+end
+
+

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'ap'
 require 'spec'
 require 'spec/autorun'
+require 'rubygems'
 
 Spec::Runner.configure do |config|
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 4
-  version: 0.1.4
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Michael Dvorkin
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-08 00:00:00 -07:00
+date: 2010-05-05 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,11 +50,14 @@ files:
 - lib/ap.rb
 - lib/ap/awesome_print.rb
 - lib/ap/core_ext/kernel.rb
+- lib/ap/core_ext/logger.rb
 - lib/ap/core_ext/string.rb
-- lib/ap/mixin/rails.rb
+- lib/ap/mixin/active_record.rb
+- lib/ap/mixin/active_support.rb
 - rails/init.rb
+- spec/active_record_spec.rb
 - spec/awesome_print_spec.rb
-- spec/rails_spec.rb
+- spec/logger_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/string_spec.rb
@@ -89,7 +92,8 @@ signing_key:
 specification_version: 3
 summary: Pretty print Ruby objects with proper indentation and colors.
 test_files: 
+- spec/active_record_spec.rb
 - spec/awesome_print_spec.rb
-- spec/rails_spec.rb
+- spec/logger_spec.rb
 - spec/spec_helper.rb
 - spec/string_spec.rb