awesome_dump 0.0.1

data/CHANGELOG

@@ -0,0 +1,3 @@
+0.0.1
+  - WIP port from the awesome_print project.
+  

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2010 Slippy Douglas
+
+Based on awesome_print, Copyright (c) 2010 Michael Dvorkin
+	%w(mike dvorkin.net) * "@" || %w(mike fatfreecrm.com) * "@"
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,106 @@
+## Awesome Dump ##
+Awesome Dump is Ruby library that dumps Ruby objects as nested hashes/arrays, exposing their internal structure in a form safe for conversion to JSON, YAML, or other data formats.
+
+Notes:
+
+*	Makes sure recursive object graphs are ellipse'd and all relevant data is outputted cleanly (i.e. advantages over just using a plain to_json).
+*	Awesome Dump'ed data looks awesome when converted to_json, then viewed with a JSON viewer (e.g. JSONView (https://addons.mozilla.org/en-US/firefox/addon/10869/), FirePHP/FireConsole (http://www.firephp.org/), or json2html (http://json.bloople.net/)).
+*	This library is very much not-done. It's inconsistent at times and subject to lots of improvement.
+
+### Installation ###
+	# Installing as Rails plugin
+	$ ruby script/plugin install git://github.com/slippyd/awesome_dump.git
+
+	# Installing as a Ruby library
+	$ git clone git://github.com/slippyd/awesome_dump.git lib/awesome_dump
+
+	# Installing as a Ruby library, with Git submodules
+	$ git submodule add git://github.com/slippyd/awesome_dump.git lib/awesome_dump
+	$ git submodule init
+	$ git submodule update
+
+	# Cloning the repository
+	$ git clone git://github.com/slippyd/awesome_dump.git
+
+### Usage ###
+
+	require 'ad'
+	some_object.ad
+
+	require 'ad', 'json'
+	some_object.ad(:escape => :safe).to_json
+
+	require 'ad', 'yaml'
+	some_object.ad(:escape => :quote).to_yaml
+
+Supported options:
+
+*	":escape => :safe": Quotes constructs that probably won't translate well into languages other than Ruby (e.g. symbols, classes). Can result in ambigious or lossy results if naming conflicts occur.
+*	":escape => :quote": Quotes every piece of data that's dumped (i.e. numbers become strings and Strings become strings that start and end with a quote). Theoretically, this conversion should be reversible back into the original data.
+
+### Examples ###
+
+Ruby:
+	
+	require 'rubygems'
+	require 'json'
+	require 'awesome_dump/init'
+	
+	class Cow
+	  def initialize
+	    @moo = true
+	  end
+	end
+	
+	data = [false, 42, %w(forty two), {:how => 'now', 'brown' => Cow.new}]
+	puts "inspect:\n\t" + data.inspect
+	puts "ad.inspect:\n\t" + data.ad.inspect
+	puts "to_json:\n\t" + data.to_json
+	puts "ad(:escape => :safe).to_json:\n\t" + data.ad(:escape => :safe).to_json
+
+Output:
+	
+	inspect:
+		[false, 42, ["forty", "two"], {:how=>"now", "brown"=>#<Cow:0x101069210 @moo=true>}]
+	ad.inspect:
+		[false, 42, ["forty", "two"], {:how=>"now", "brown"=>{:@moo=>true, :class=>Cow, :object_id=>2156087560}}]
+	to_json:
+		[false,42,["forty","two"],{"how":"now","brown":"#<Cow:0x101069210>"}]
+	ad(:escape => :safe).to_json:
+		[false,42,["forty","two"],{":how":"now","brown":{"class":"Cow","@moo":true,"object_id":2156087560}}]
+
+
+### Setting Custom Defaults ###
+You can set your own default options by creating ``.adrc`` file in your home
+directory. Within that file assign your	 defaults to ``AwesomeDump.defaults``.
+For example:
+
+	# ~/.adrc file.
+	AwesomeDump.defaults = {
+	  :escape => :quote
+	}
+
+### Note on Patches/Pull Requests ###
+* Fork the project on Github.
+* Make your feature addition or bug fix.
+* Add specs for it, making sure $ rake spec is all green.
+* Commit, do not mess with rakefile, version, or history.
+* Send me a pull request.
+
+### Contributors ###
+
+awesome_print:
+
+* Michael Dvorkin -- http://github.com/michaeldv
+* Daniel Bretoi -- http://github.com/danielb2
+* eregon -- http://github.com/eregon
+* Tobias Crawley -- http://github.com/tobias
+
+### License ###
+Copyright (c) 2010 Slippy Douglas
+	'awesome_dump' + 64.chr + 'slippyd.com'
+
+Based on awesome_print, Copyright (c) 2010 Michael Dvorkin
+	%w(mike dvorkin.net) * "@" || %w(mike fatfreecrm.com) * "@"
+
+Released under the MIT license. See LICENSE file for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "awesome_dump"
+    gem.rubyforge_project = "awesome_dump"
+    gem.summary = %Q{Pretty print Ruby objects with proper indentation and colors.}
+    gem.description = %Q{Great Ruby dubugging companion: pretty print Ruby objects to visualize their structure. Supports Rails ActiveRecord objects via included mixin.}
+    gem.email = "mike@dvorkin.net"
+    gem.homepage = "http://github.com/slippyd/awesome_dump"
+    gem.authors = ["Michael Dvorkin"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.files = FileList["[A-Z]*", "lib/**/*.rb", "rails/*.rb", "spec/*", "init.rb"]
+    gem.has_rdoc = false
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+ rdoc.rdoc_dir = 'rdoc'
+ rdoc.title = "ad #{version}"
+ rdoc.rdoc_files.include('README*')
+ rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), "lib", "ad")

data/lib/ad.rb

@@ -0,0 +1,14 @@
+# Copyright (c) 2010 Slippy Douglas & Michael Dvorkin
+#
+# Awesome Dump is freely distributable under the terms of MIT license.
+# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+require File.dirname(__FILE__) + "/ad/core_ext/string"
+require File.dirname(__FILE__) + "/ad/core_ext/kernel"
+require File.dirname(__FILE__) + "/ad/awesome_dump"
+
+require File.dirname(__FILE__) + "/ad/core_ext/logger" if defined?(::Logger) or defined?(::ActiveSupport::BufferedLogger)
+
+#require File.dirname(__FILE__) + "/ad/mixin/active_record" if defined?(::ActiveRecord)
+#require File.dirname(__FILE__) + "/ad/mixin/active_support" if defined?(::ActiveSupport)
+

data/lib/ad/awesome_dump.rb

@@ -0,0 +1,225 @@
+# Copyright (c) 2010 Slippy Douglas & Michael Dvorkin
+#
+# Awesome Dump is freely distributable under the terms of MIT license.
+# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+require "shellwords"
+
+class AwesomeDump
+  AD = :__awesome_dump__
+  
+  def initialize(options = {})
+    @options = { 
+      :multiline => true,
+      :plain     => false,
+      :indent    => 4,
+      :color     => { 
+        :array      => :white,
+        :bigdecimal => :blue,
+        :class      => :yellow,
+        :date       => :greenish,
+        :falseclass => :red,
+        :fixnum     => :blue,
+        :float      => :blue,
+        :hash       => :pale,
+        :struct     => :pale,
+        :nilclass   => :red,
+        :string     => :yellowish,
+        :symbol     => :cyanish,
+        :time       => :greenish,
+        :trueclass  => :green
+      }
+    }
+    
+    # Merge custom defaults and let explicit options parameter override them.
+    merge_custom_defaults!
+    merge_options!(options)
+    
+    @indentation = @options[:indent].abs
+    Thread.current[AD] ||= []
+    
+    @formatter = Formatter.new(self.method(:awesome), @options)
+    
+    extend Util
+  end
+  
+  private
+  
+  ## Dispatcher that detects data nesting and invokes object-aware formatter.
+  def awesome(object)
+    if Thread.current[AD].include?(object.object_id)
+      nested(object)
+    else
+      begin
+        Thread.current[AD] << object.object_id
+        return eval(%<@formatter.#{declassify(object)}(object)>)
+      ensure
+        Thread.current[AD].pop
+      end
+    end
+  end
+  
+  class Formatter
+    def initialize(awesome_method, options = {})
+      @awesome = awesome_method
+      @options = options
+    end
+    
+    ## Format an array.
+    def array(a)
+      return [] if a == []
+      
+      return a.inject([]) { |arr, item| arr << @awesome.call(item) }
+    end
+    
+    ## Format a hash. If @options[:indent] if negative left align hash keys.
+    def hash(h)
+      return {} if h == {}
+      return h.keys.inject({}) do |hash, key|
+        hash.store @awesome.call(key), @awesome.call(h[key])
+        hash
+      end
+    end
+    
+    def fixnum(f)
+      return f.to_s if @options[:escape] == :quote
+      return f
+    end
+    
+    def nilclass(n)
+      return 'nil' if @options[:escape] == :quote
+      return nil
+    end
+    
+    def trueclass(n)
+      return 'true' if @options[:escape] == :quote
+      return true
+    end
+    
+    def falseclass(n)
+      return 'false' if @options[:escape] == :quote
+      return false
+    end
+    
+    def symbol(s)
+      return s.to_s.include?(':') ? %{:"#{s}"} : %{:#{s}} if [:quote, :safe].include?(@options[:escape])
+      return s
+    end
+    
+    def string(s)
+      return %{"#{s}"} if @options[:escape] == :quote
+      return s
+    end
+    
+    ## Format a Struct. If @options[:indent] if negative left align hash keys.
+    def struct(s)
+      h = {}
+      s.each_pair do |m, v|
+        m_k = [:quote, :safe].include?(@options[:escape]) ? m.to_s : m.to_sym
+        h[m_k] = @awesome.call(v)
+      end
+      return object(s, h)
+    end
+    
+    ## Format Class object.
+    def class(c)
+      if [:quote, :safe].include?(@options[:escape])
+        sc = c.superclass
+        return %{#{c} < #{sc}} if sc && sc != Object
+        return c.to_s
+      end
+      return c
+    end
+    
+    ## Format File object.
+    def file(f)
+      ls = File.directory?(f) ? `ls -adlF #{f.path.shellescape}` : `ls -alF #{f.path.shellescape}`
+      return object(f) #, :with => ls.empty? ? nil : "\n#{ls.chop}")
+    end
+    
+    ## Format Dir object.
+    def dir(d)
+      ls = `ls -alF #{d.path.shellescape}`
+      return object(d) #, :with => ls.empty? ? nil : "\n#{ls.chop}")
+    end
+    
+    ## Format BigDecimal and Rational objects by convering them to Float.
+    def bigdecimal(n)
+      return object(n.to_f) #, :as => :bigdecimal
+    end
+    alias :rational :bigdecimal
+    
+    ## Format an arbitrary object.
+    def object(o, with=nil)
+      o_hash = case @options[:escape]
+        when :quote then {'class' => o.class.to_s, 'object_id' => o.object_id.to_s}
+        when :safe  then {'class' => o.class.to_s, 'object_id' => o.object_id}
+        else             {:class => o.class, :object_id => o.object_id}
+      end
+      o.instance_variables.sort.each do |iv|
+        iv_k = [:quote, :safe].include?(@options[:escape]) ? iv.to_s : iv.to_sym
+        o_hash[iv_k] = @awesome.call(o.instance_variable_get(iv))
+      end
+      o_hash = with.merge(o_hash) if with
+      return o_hash
+    end
+    
+    ## Catch-all method to format an arbitrary object.
+    def method_missing(method_id, object)
+      return object(object)
+    end
+    
+  end
+  
+  module Util
+    ## Format nested data, for example:
+    ##   arr = [1, 2]; arr << arr
+    ##   => [1,2, [...]]
+    ##   hsh = { :a => 1 }; hsh[:b] = hsh
+    ##   => { :a => 1, :b => {...} }
+    def nested(object)
+      case declassify(object)
+        when :array  then ['...']
+        when :hash   then {'...' => '...'}
+        when :struct then {'...' => '...'}
+        else "...#{object.class}..."
+      end
+    end
+    
+    ## Turn class name into symbol, ex: Hello::World => :hello_world.
+    def declassify(object)
+      if object.is_a?(Struct)
+        :struct
+      else
+        object.class.to_s.gsub(/:+/, "_").downcase.to_sym
+      end
+    end
+  end
+  
+  ## Update @options by first merging the :color hash and then the remaining keys.
+  def merge_options!(options = {})
+    @options[:color].merge!(options.delete(:color) || {})
+    @options.merge!(options)
+  end
+  
+  ## Load ~/.adrc file with custom defaults that override default options.
+  def merge_custom_defaults!
+    dotfile = File.join(ENV["HOME"], ".adrc")
+    if File.readable?(dotfile)
+      load dotfile
+      merge_options!(self.class.defaults)
+    end
+  rescue => e
+    $stderr.puts "Could not load #{dotfile}: #{e}"
+  end
+  
+  ## Class accessors for custom defaults.
+  def self.defaults
+    @@defaults ||= {}
+  end
+  
+  def self.defaults=(args = {})
+    @@defaults = args
+  end
+  
+end

data/lib/ad/core_ext/kernel.rb

@@ -0,0 +1,13 @@
+# Copyright (c) 2010 Slippy Douglas & Michael Dvorkin
+#
+# Awesome Dump is freely distributable under the terms of MIT license.
+# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+module Kernel
+
+  def ad(options = {})
+    ad = AwesomeDump.new(options)
+    ad.send(:awesome, self)
+  end
+  alias :awesome_dump :ad
+end

data/lib/ad/core_ext/logger.rb

@@ -0,0 +1,17 @@
+# Copyright (c) 2010 Slippy Douglas & Michael Dvorkin
+#
+# Awesome Dump is freely distributable under the terms of MIT license.
+# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+module AwesomeDumpLogger
+
+  # Add ad method to logger
+  def ad(object, level = nil)
+    level ||= AwesomeDump.defaults[:log_level] || :debug
+    send level, object.ad
+  end
+
+end
+
+Logger.send(:include, AwesomeDumpLogger) if defined?(Logger)
+ActiveSupport::BufferedLogger.send(:include, AwesomeDumpLogger) if defined?(::ActiveSupport::BufferedLogger)

data/lib/ad/core_ext/string.rb

@@ -0,0 +1,27 @@
+# Copyright (c) 2010 Slippy Douglas & Michael Dvorkin
+#
+# Awesome Dump is freely distributable under the terms of MIT license.
+# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+class String
+
+  # ANSI color codes:
+  # \033 => escape
+  #   30 => color base
+  #    1 => bright
+  #    0 => normal
+
+  [ :gray, :red, :green, :yellow, :blue, :purple, :cyan, :white ].each_with_index do |color, i|
+    if STDOUT.tty? && ENV['TERM'] && ENV['TERM'] != 'dumb'
+      define_method color          do "\033[1;#{30+i}m#{self}\033[0m" end
+      define_method :"#{color}ish" do "\033[0;#{30+i}m#{self}\033[0m" end
+    else
+      define_method color do self end
+      alias_method :"#{color}ish", color 
+    end
+  end
+
+  alias :black :grayish
+  alias :pale  :whiteish
+
+end

data/lib/ad/mixin/active_record.rb

@@ -0,0 +1,32 @@
+# Copyright (c) 2010 Slippy Douglas & Michael Dvorkin
+#
+# Awesome Dump is freely distributable under the terms of MIT license.
+# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+module AwesomeDumpActiveRecord
+
+  # Format ActiveRecord instance object.
+  def awesome_active_record_instance(object)
+    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
+    end
+    "#{object} " + awesome_hash(data)
+  end
+
+  # 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
+    end
+  end
+  
+end
+
+AwesomeDump.send(:include, AwesomeDumpActiveRecord)

data/lib/ad/mixin/active_support.rb

@@ -0,0 +1,23 @@
+# Copyright (c) 2010 Slippy Douglas & Michael Dvorkin
+#
+# Awesome Dump is freely distributable under the terms of MIT license.
+# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+module AwesomeDumpActiveSupport
+
+  # 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
+
+AwesomeDump.send(:include, AwesomeDumpActiveSupport)

data/rails/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), "..", "init")

data/spec/active_record_spec.rb

@@ -0,0 +1,117 @@
+#require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+#
+#require 'active_record'
+#require 'ad/mixin/active_record'
+#
+#
+#if defined?(::ActiveRecord)
+#
+#  # Create tableless ActiveRecord model.
+#  class User < ActiveRecord::Base
+#    def self.columns()
+#      @columns ||= []
+#    end
+#
+#    def self.column(name, sql_type = nil, default = nil, null = true)
+#      columns << ActiveRecord::ConnectionAdapters::Column.new(name.to_s, default, sql_type.to_s, null)
+#    end
+#
+#    column :id, :integer
+#    column :name, :string
+#    column :rank, :integer
+#    column :admin, :boolean
+#    column :created_at, :datetime
+#
+#    def self.table_exists?
+#      true
+#    end
+#  end
+#  
+#  class SubUser < User
+#    def self.columns
+#      User.columns
+#    end
+#  end
+#  
+#  describe "AwesomeDump/ActiveRecord" do
+#    before(:each) do
+#      stub_dotfile!
+#    end
+#
+#    #------------------------------------------------------------------------------
+#    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")
+#        @ad = AwesomeDump.new(:plain => true)
+#      end
+#
+#      it "display single record" do
+#        out = @ad.send(:awesome, @diana)
+#        out.gsub(/0x([a-f\d]+)/, "0x01234567").should == <<-EOS.strip
+##<User:0x01234567> {
+#            :id => nil,
+#          :name => "Diana",
+#          :rank => 1,
+#         :admin => false,
+#    :created_at => Sat Oct 10 12:30:00 UTC 1992
+#}
+#EOS
+#      end
+#
+#      it "display multiple records" do
+#        out = @ad.send(:awesome, [ @diana, @laura ])
+#        out.gsub(/0x([a-f\d]+)/, "0x01234567").should == <<-EOS.strip
+#[
+#    [0] #<User:0x01234567> {
+#                :id => nil,
+#              :name => "Diana",
+#              :rank => 1,
+#             :admin => false,
+#        :created_at => Sat Oct 10 12:30:00 UTC 1992
+#    },
+#    [1] #<User:0x01234567> {
+#                :id => nil,
+#              :name => "Laura",
+#              :rank => 2,
+#             :admin => true,
+#        :created_at => Mon May 26 14:15:00 UTC 2003
+#    }
+#]
+#EOS
+#      end
+#    end
+#
+#    #------------------------------------------------------------------------------
+#    describe "ActiveRecord class" do
+#      it "should print the class" do
+#        @ad = AwesomeDump.new(:plain => true)
+#        @ad.send(:awesome, User).should == <<-EOS.strip
+#class User < ActiveRecord::Base {
+#            :id => :integer,
+#          :name => :string,
+#          :rank => :integer,
+#         :admin => :boolean,
+#    :created_at => :datetime
+#}
+#        EOS
+#  
+#end
+#
+#it "should print the class for non-direct subclasses of AR::Base" do
+#  @ad = AwesomeDump.new(:plain => true)
+#  @ad.send(:awesome, SubUser).should == <<-EOS.strip
+#class SubUser < User {
+#            :id => :integer,
+#          :name => :string,
+#          :rank => :integer,
+#         :admin => :boolean,
+#    :created_at => :datetime
+#}
+#  EOS
+#  
+#      end
+#    end
+#  end
+#end

data/spec/awesome_dump_spec.rb

@@ -0,0 +1,234 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'bigdecimal'
+require 'rational'
+
+describe "AwesomeDump" do
+  before(:each) do
+    stub_dotfile!
+  end
+  
+  describe "Array" do
+    before(:each) do
+      @arr = [ 1, :two, "three", [ nil, [ true, false] ] ]
+    end
+    
+    it "empty array" do
+      [].ad.should == []
+    end
+    
+    it "default" do
+      @arr.ad.should == [ 1, :two, "three", [ nil, [ true, false ] ] ]
+    end
+    
+    it "safe-escaped" do
+      @arr.ad(:escape => :safe).should == [1, ':two', "three", [nil, [true, false]]]
+    end
+    
+    it "quote-escape" do
+      @arr.ad(:escape => :quote).should == ['1', ':two', '"three"', ['nil', ['true', 'false']]]
+    end
+  end
+  
+  describe "Nested Array" do
+    before(:each) do
+      @arr = [ 1, 2 ]
+      @arr << @arr
+    end
+    
+    it "default" do
+      d = [1, 2, ['...']]
+      @arr.ad.should == d
+    end
+    
+    it "safe-escaped" do
+      d = [1, 2, ['...']]
+      @arr.ad(:escape => :safe).should == d
+    end
+    
+    it "quote-escape" do
+      d = ['1', '2', ['...']]
+      @arr.ad(:escape => :quote).should == d
+    end
+  end
+  
+  describe "Hash" do
+    before(:each) do
+      @hash = { 1 => { :sym => { "str" => { [1, 2, 3] => { {:k => :v} => Hash } } } } }
+    end
+    
+    it "empty hash" do
+      {}.ad.should == {}
+    end
+    
+    it "default" do
+      d = { 1 => { :sym => { "str" => { [1, 2, 3] => { {:k => :v} => Hash } } } } }
+      @hash.ad.should == d
+    end
+    
+    it "safe-escaped" do
+      d = { 1 => { ':sym' => { "str" => { [1, 2, 3] => { {':k' => ':v'} => 'Hash' } } } } }
+      @hash.ad(:escape => :safe).should == d
+    end
+    
+    it "quote-escape" do
+      d = { '1' => { ':sym' => { '"str"' => { ['1', '2', '3'] => { {':k' => ':v'} => 'Hash' } } } } }
+      @hash.ad(:escape => :quote).should == d
+    end
+    
+  end
+  
+  describe "Nested Hash" do
+    before(:each) do
+      @hash = {}
+      @hash[:a] = @hash
+    end
+    
+    it "default" do
+      d = { :a => {'...' => '...'} }
+      @hash.ad.should == d
+    end
+    
+    it "safe-escaped" do
+      d = { ':a' => {'...' => '...'} }
+      @hash.ad(:escape => :safe).should == d
+    end
+    
+    it "quote-escape" do
+      d = { ':a' => {'...' => '...'} }
+      @hash.ad(:escape => :quote).should == d
+    end
+  end
+  
+  describe "Class" do
+    it "shoud show superclass (quote-escape)" do
+      Fixnum.ad(:escape => :quote).should == 'Fixnum < Integer'
+      Class.ad(:escape => :quote).should == 'Class < Module'
+    end
+  end
+  
+  describe "File" do
+    it "should display a file (default)" do
+      File.open(__FILE__, 'r') do |f|
+        f.ad.should == "#{f.inspect}\n" << `ls -alF #{f.path}`.chop
+      end
+    end
+  end
+  
+  describe "Dir" do
+    it "should display a directory (default)" do
+      Dir.open(File.dirname(__FILE__)) do |d|
+        d.ad.should == "#{d.inspect}\n" << `ls -alF #{d.path}`.chop
+      end
+    end
+  end
+  
+  describe "BigDecimal and Rational" do
+    it "should present BigDecimal object as Float scalar" do
+      big = BigDecimal("2010.4")
+      big.ad.should == "2010.4"
+    end
+    
+    it "should present Rational object as Float scalar" do
+      rat = Rational(2010, 2)
+      rat.ad.should == "1005.0"
+    end
+  end
+  
+  describe "Utility methods" do
+    it "should merge options" do
+      ad = AwesomeDump.new
+      ad.send(:merge_options!, { :color => { :array => :black }, :indent => 0 })
+      options = ad.instance_variable_get("@options")
+      options[:color][:array].should == :black
+      options[:indent].should == 0
+    end
+  end
+  
+  
+  describe "Struct" do
+    before(:each) do
+      @struct = unless defined?(Struct::SimpleStruct)
+        Struct.new('SimpleStruct', :name, :address).new
+      else
+        Struct::SimpleStruct.new
+      end
+      @struct.name = 'Herman Munster'
+      @struct.address = '1313 Mockingbird Lane'
+    end
+    
+    it "empty struct" do
+      empty_struct = Struct.new('EmptyStruct').new
+      empty_struct.ad.should ==  {:class => Struct::EmptyStruct, :object_id => empty_struct.object_id}
+    end
+    
+    it "default" do
+      d = {:class => Struct::SimpleStruct, :object_id => @struct.object_id, :address => '1313 Mockingbird Lane', :name => 'Herman Munster'}
+      @struct.ad.should == d
+    end
+    
+    it "safe-escaped" do
+      d = {'class' => 'Struct::SimpleStruct', 'object_id' => @struct.object_id, 'address' => '1313 Mockingbird Lane', 'name' => 'Herman Munster'}
+      @struct.ad(:escape => :safe).should == d
+    end
+    
+    it "quote-escaped" do
+      d = {'class' => 'Struct::SimpleStruct', 'object_id' => @struct.object_id.to_s, 'address' => '"1313 Mockingbird Lane"', 'name' => '"Herman Munster"'}
+      @struct.ad(:escape => :quote).should == d
+    end
+  end
+  
+  describe "Some Random Object" do
+    before(:each) do
+      class SomeRandomObject
+        def initialize
+          @str = 'blah'
+          @int = 5
+          @arr = ['a', 3]
+          @hash = {:hi => 5, 'lo' => Object.new}
+        end
+      end
+      @object = SomeRandomObject.new
+    end
+    
+    it "default" do
+      d = { :class => SomeRandomObject, :object_id => @object.object_id,
+        :'@str' => 'blah',
+        :'@int' => 5,
+        :'@arr' => ['a', 3],
+        :'@hash' => {
+          :hi => 5,
+          'lo' => {:class => Object, :object_id => @object.instance_variable_get(:'@hash')['lo'].object_id}
+        }
+      }
+      @object.ad.should == d
+    end
+    
+    it "safe-escaped" do
+      d = { 'class' => 'SomeRandomObject', 'object_id' => @object.object_id,
+        '@str' => 'blah',
+        '@int' => 5,
+        '@arr' => ['a', 3],
+        '@hash' => {
+          ':hi' => 5,
+          'lo' => {'class' => 'Object', 'object_id' => @object.instance_variable_get(:'@hash')['lo'].object_id}
+        }
+      }
+      @object.ad(:escape => :safe).should == d
+    end
+    
+    it "quote-escaped" do
+      d = { 'class' => 'SomeRandomObject', 'object_id' => @object.object_id.to_s,
+        '@str' => '"blah"',
+        '@int' => '5',
+        '@arr' => ['"a"', '3'],
+        '@hash' => {
+          ':hi' => '5',
+          '"lo"' => {'class' => 'Object', 'object_id' => @object.instance_variable_get(:'@hash')['lo'].object_id.to_s}
+        }
+      }
+      @object.ad(:escape => :quote).should == d
+    end
+  end
+  
+  
+end

data/spec/logger_spec.rb

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

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'ad'
+require 'spec'
+require 'spec/autorun'
+require 'rubygems'
+
+Spec::Runner.configure do |config|
+end
+
+def stub_dotfile!
+  dotfile = File.join(ENV["HOME"], ".adrc")
+  File.should_receive(:readable?).at_least(:once).with(dotfile).and_return(false)
+end

data/spec/string_spec.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "String extensions" do
+  [ :gray, :red, :green, :yellow, :blue, :purple, :cyan, :white ].each_with_index do |color, i|
+    it "should have #{color} color" do
+      color.to_s.send(color).should == "\033[1;#{30+i}m#{color}\033[0m"
+    end
+
+    it "should have #{color}ish color" do
+      color.to_s.send(:"#{color}ish").should == "\033[0;#{30+i}m#{color}\033[0m"
+    end
+  end
+
+  it "should have black and pale colors" do
+    "black".send(:black).should == "black".send(:grayish)
+    "pale".send(:pale).should  == "pale".send(:whiteish)
+    "pale".send(:pale).should == "\e[0;37mpale\e[0m"
+    "whiteish".send(:whiteish).should == "\e[0;37mwhiteish\e[0m"
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: awesome_dump
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Michael Dvorkin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-20 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: "Great Ruby dubugging companion: pretty print Ruby objects to visualize their structure. Supports Rails ActiveRecord objects via included mixin."
+email: mike@dvorkin.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- CHANGELOG
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- init.rb
+- lib/ad.rb
+- lib/ad/awesome_dump.rb
+- lib/ad/core_ext/kernel.rb
+- lib/ad/core_ext/logger.rb
+- lib/ad/core_ext/string.rb
+- lib/ad/mixin/active_record.rb
+- lib/ad/mixin/active_support.rb
+- rails/init.rb
+- spec/active_record_spec.rb
+- spec/awesome_dump_spec.rb
+- spec/logger_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/string_spec.rb
+has_rdoc: true
+homepage: http://github.com/slippyd/awesome_dump
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: awesome_dump
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Pretty print Ruby objects with proper indentation and colors.
+test_files: 
+- spec/active_record_spec.rb
+- spec/awesome_dump_spec.rb
+- spec/logger_spec.rb
+- spec/spec_helper.rb
+- spec/string_spec.rb