awesome_print 0.1.3 → 0.1.4

data/CHANGELOG

@@ -1,3 +1,9 @@
+0.1.4
+  - Format BigDecimal and Rational objects as Float scalars
+  - Explicit options parameter can override custom defaults
+  - Custom defaults are not interfering when running specs
+  - Custom defaults now work correctly with Ruby 1.9.x
+
 0.1.3
   - Added support for setting custom defaults in ~/.aprc
   

data/README.md

@@ -23,7 +23,7 @@ Default options:
     :multiline => true,
     :plain  => false,
     :indent => 4,
-    :colors => {
+    :color => {
       :array      => :white,
       :bignum     => :blue,
       :class      => :yellow,
@@ -47,7 +47,7 @@ Supported color names:
 ### Examples ###
     $ cat > 1.rb
     require "ap"
-    data = [ false, 42, %w(fourty two), { :now => Time.now, :class => Time.now.class, :distance => 42e42 } ]
+    data = [ false, 42, %w(forty two), { :now => Time.now, :class => Time.now.class, :distance => 42e42 } ]
     ap data
     ^D
     $ ruby 1.rb
@@ -55,7 +55,7 @@ Supported color names:
         [0] false,
         [1] 42,
         [2] [
-            [0] "fourty",
+            [0] "forty",
             [1] "two"
         ],
         [3] {
@@ -79,12 +79,12 @@ Supported color names:
 
     $ cat > 3.rb
     require "ap"
-    data = [ false, 42, %w(fourty two) ]
+    data = [ false, 42, %w(forty two) ]
     data << data  # <-- Nested array.
     ap data, :multiline => false
     ^D
     $ ruby 3.rb
-    [ false, 42, [ "fourty", "two" ], [...] ]
+    [ false, 42, [ "forty", "two" ], [...] ]
 
 ### Example (Rails console) ###
     $ ruby script/console

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.1.4

data/lib/ap/awesome_print.rb

@@ -5,7 +5,7 @@
 #------------------------------------------------------------------------------
 class AwesomePrint
   AP = :__awesome_print__
-  CORE = [ :array, :hash, :class, :file, :dir ]
+  CORE = [ :array, :hash, :class, :file, :dir, :bigdecimal, :rational ]
 
   def initialize(options = {})
     @options = { 
@@ -14,7 +14,7 @@ class AwesomePrint
       :indent    => 4,
       :color     => { 
         :array      => :white,
-        :bignum     => :blue,
+        :bigdecimal => :blue,
         :class      => :yellow,
         :date       => :greenish,
         :falseclass => :red,
@@ -26,10 +26,12 @@ class AwesomePrint
         :symbol     => :cyanish,
         :time       => :greenish,
         :trueclass  => :green
-      }.merge(options.delete(:color) || {})
-    }.merge(options)
+      }
+    }
 
-    load_custom_defaults
+    # Merge custom defaults and let explicit options parameter override them.
+    merge_custom_defaults!
+    merge_options!(options)
 
     @indentation = @options[:indent].abs
     Thread.current[AP] ||= []
@@ -113,6 +115,13 @@ class AwesomePrint
     awesome_self(d, :with => ls.empty? ? nil : "\n#{ls.chop}")
   end
 
+  # Format BigDecimal and Rational objects by convering them to Float.
+  #------------------------------------------------------------------------------
+  def awesome_bigdecimal(n)
+    awesome_self(n.to_f, :as => :bigdecimal)
+  end
+  alias :awesome_rational :awesome_bigdecimal
+
   # Catch all method to format an arbitrary object.
   #------------------------------------------------------------------------------
   def awesome_self(object, appear = {})
@@ -188,31 +197,28 @@ class AwesomePrint
     @indentation -= @options[:indent].abs
   end
 
-  #------------------------------------------------------------------------------
   def indent
     @indent = ' ' * @indentation
   end
 
-  #------------------------------------------------------------------------------
   def outdent
     @outdent = ' ' * (@indentation - @options[:indent].abs)
   end
 
-  # Load ~/.aprc file that can store custom defaults, for example:
-  #
-  # AwesomePrint.defaults = {
-  #   :indent => -2,
-  #   :color => {
-  #     :trueclass => :red
-  #   }
-  # }
+  # 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 ~/.aprc file with custom defaults that override default options.
   #------------------------------------------------------------------------------
-  def load_custom_defaults
+  def merge_custom_defaults!
     dotfile = File.join(ENV["HOME"], ".aprc")
     if File.readable?(dotfile)
       load dotfile
-      @options[:color].merge!(self.class.defaults.delete(:color) || {})
-      @options.merge!(self.class.defaults)
+      merge_options!(self.class.defaults)
     end
   rescue => e
     $stderr.puts "Could not load #{dotfile}: #{e}"
@@ -224,8 +230,8 @@ class AwesomePrint
     @@defaults ||= {}
   end
 
-  def self.defaults=(*args)
-    @@defaults = *args
+  def self.defaults=(args = {})
+    @@defaults = args
   end
 
 end

data/spec/awesome_print_spec.rb

@@ -1,6 +1,11 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require "bigdecimal"
+require "rational"
 
 describe "AwesomePrint" do
+  before(:each) do
+    stub_dotfile!
+  end
 
   describe "Array" do
     before(:each) do
@@ -259,4 +264,28 @@ EOS
     end
   end
 
+  #------------------------------------------------------------------------------
+  describe "BigDecimal and Rational" do
+    it "should present BigDecimal object as Float scalar" do
+      big = BigDecimal("2010.04")
+      big.ai(:plain => true).should == "2010.4"
+    end
+
+    it "should present Rational object as Float scalar" do
+      rat = Rational(2010, 2)
+      rat.ai(:plain => true).should == "1005.0"
+    end
+  end
+
+  #------------------------------------------------------------------------------
+  describe "Utility methods" do
+    it "should merge options" do
+      ap = AwesomePrint.new
+      ap.send(:merge_options!, { :color => { :array => :black }, :indent => 0 })
+      options = ap.instance_variable_get("@options")
+      options[:color][:array].should == :black
+      options[:indent].should == 0
+    end
+  end
+
 end

data/spec/rails_spec.rb

@@ -20,17 +20,22 @@ if defined?(::Rails)
     column :created_at, :datetime
   end
 
-  #------------------------------------------------------------------------------
-  describe "ActiveRecord instance" do
+  describe "AwesomePrint/Rails" do
     before(:each) do
-      @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)
+      stub_dotfile!
     end
 
-    it "display single record" do
-      out = @ap.send(:awesome, @diana)
-      out.gsub(/0x([a-f\d]+)/, "0x01234567").should == <<-EOS.strip
+    #------------------------------------------------------------------------------
+    describe "ActiveRecord instance" do
+      before(:each) do
+        @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)
+      end
+
+      it "display single record" do
+        out = @ap.send(:awesome, @diana)
+        out.gsub(/0x([a-f\d]+)/, "0x01234567").should == <<-EOS.strip
 #<User:0x01234567> {
             :id => nil,
           :name => "Diana",
@@ -39,11 +44,11 @@ if defined?(::Rails)
     :created_at => Sat, 10 Oct 1992 12:30:00 UTC +00:00
 }
 EOS
-    end
+      end
 
-    it "display multiple records" do
-      out = @ap.send(:awesome, [ @diana, @laura ])
-      out.gsub(/0x([a-f\d]+)/, "0x01234567").should == <<-EOS.strip
+      it "display multiple records" do
+        out = @ap.send(:awesome, [ @diana, @laura ])
+        out.gsub(/0x([a-f\d]+)/, "0x01234567").should == <<-EOS.strip
 [
     [0] #<User:0x01234567> {
                 :id => nil,
@@ -61,14 +66,14 @@ EOS
     }
 ]
 EOS
+      end
     end
-  end
 
-  #------------------------------------------------------------------------------
-  describe "ActiveRecord class" do
-    it "should" do
-      @ap = AwesomePrint.new(:plain => true)
-      @ap.send(:awesome, User).should == <<-EOS.strip
+    #------------------------------------------------------------------------------
+    describe "ActiveRecord class" do
+      it "should" do
+        @ap = AwesomePrint.new(:plain => true)
+        @ap.send(:awesome, User).should == <<-EOS.strip
 class User < ActiveRecord::Base {
             :id => :integer,
           :name => :string,
@@ -77,7 +82,7 @@ class User < ActiveRecord::Base {
     :created_at => :datetime
 }
 EOS
+      end
     end
   end
-
 end

data/spec/spec_helper.rb

@@ -5,5 +5,9 @@ require 'spec'
 require 'spec/autorun'
 
 Spec::Runner.configure do |config|
-  
+end
+
+def stub_dotfile!
+  dotfile = File.join(ENV["HOME"], ".aprc")
+  File.should_receive(:readable?).at_least(:once).with(dotfile).and_return(false)
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Michael Dvorkin
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-07 00:00:00 -07:00
+date: 2010-04-08 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency