awesome_print 1.1.0 → 1.2.0

data/.gitignore

@@ -17,6 +17,7 @@ tmtags
 coverage
 rdoc
 pkg
+Gemfile.lock
 
 ## PROJECT::SPECIFIC
 .rvmrc

data/CHANGELOG

@@ -1,3 +1,11 @@
+1.2.0 <-- NOTE: This is the *last* release supporting Ruby < v1.9.3 and Rails < v3.
+  - Added Sequel ORM plugin (Jonathan Davies)
+  - Added Ripple plugin (Ruby modeling layer for Riak, Scott Hyndman)
+  - Added NoBrainer plugin (Ruby ORM for RethinkDB, Nicolas Viennot)
+  - Added formatting for Ruby set objects (Richard Hall)
+  - Fixed HTML formatting (Mike McQuaid)
+  - Other minor bugs and enhancements
+
 1.1.0
   - Objects are no longer recursively formatted by default. Reenable by using :raw => true option.
   - ap(object) now returns nil when running under IRB or Pry

data/Gemfile

@@ -1,3 +1,3 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 gemspec
 

data/Gemfile.lock

@@ -1,21 +1,21 @@
 PATH
   remote: .
   specs:
-    awesome_print (1.0.2)
+    awesome_print (1.1.0)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    diff-lcs (1.1.2)
+    diff-lcs (1.1.3)
     fakefs (0.3.2)
-    rspec (2.6.0)
-      rspec-core (~> 2.6.0)
-      rspec-expectations (~> 2.6.0)
-      rspec-mocks (~> 2.6.0)
-    rspec-core (2.6.4)
-    rspec-expectations (2.6.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.6.0)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
 
 PLATFORMS
   ruby

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2012 Michael Dvorkin
+Copyright (c) 2010-2013 Michael Dvorkin
 http://www.dvorkin.net
 %w(mike dvorkin.net) * "@" || %w(mike fatfreecrm.com) * "@"
 

data/README.md

@@ -3,6 +3,10 @@ Awesome Print is a Ruby library that pretty prints Ruby objects in full color
 exposing their internal structure with proper indentation. Rails ActiveRecord
 objects and usage within Rails templates are supported via included mixins.
 
+__NOTE__: awesome_print v1.2.0 is the last release supporting Ruby versions
+prior to v1.9.3 and Rails versions prior to v3.0. The upcoming awesome_print
+v2.0 will *require* Ruby v1.9.3 or later and Rails v3.0 or later.
+
 ### Installation ###
     # Installing as Ruby gem
     $ gem install awesome_print
@@ -12,236 +16,251 @@ objects and usage within Rails templates are supported via included mixins.
 
 ### Usage ###
 
-    require "awesome_print"
-    ap object, options = {}
+```ruby
+require "awesome_print"
+ap object, options = {}
+```
 
 Default options:
 
-    :indent     => 4,      # Indent using 4 spaces.
-    :index      => true,   # Display array indices.
-    :html       => false,  # Use ANSI color codes rather than HTML.
-    :multiline  => true,   # Display in multiple lines.
-    :plain      => false,  # Use colors.
-    :raw        => false,  # Do not recursively format object instance variables.
-    :sort_keys  => false,  # Do not sort hash keys.
-    :limit      => false,  # Limit large output for arrays and hashes. Set to a boolean or integer.
-    :color => {
-      :args       => :pale,
-      :array      => :white,
-      :bigdecimal => :blue,
-      :class      => :yellow,
-      :date       => :greenish,
-      :falseclass => :red,
-      :fixnum     => :blue,
-      :float      => :blue,
-      :hash       => :pale,
-      :keyword    => :cyan,
-      :method     => :purpleish,
-      :nilclass   => :red,
-      :rational   => :blue,
-      :string     => :yellowish,
-      :struct     => :pale,
-      :symbol     => :cyanish,
-      :time       => :greenish,
-      :trueclass  => :green,
-      :variable   => :cyanish
-    }
+```ruby
+:indent     => 4,      # Indent using 4 spaces.
+:index      => true,   # Display array indices.
+:html       => false,  # Use ANSI color codes rather than HTML.
+:multiline  => true,   # Display in multiple lines.
+:plain      => false,  # Use colors.
+:raw        => false,  # Do not recursively format object instance variables.
+:sort_keys  => false,  # Do not sort hash keys.
+:limit      => false,  # Limit large output for arrays and hashes. Set to a boolean or integer.
+:color => {
+  :args       => :pale,
+  :array      => :white,
+  :bigdecimal => :blue,
+  :class      => :yellow,
+  :date       => :greenish,
+  :falseclass => :red,
+  :fixnum     => :blue,
+  :float      => :blue,
+  :hash       => :pale,
+  :keyword    => :cyan,
+  :method     => :purpleish,
+  :nilclass   => :red,
+  :rational   => :blue,
+  :string     => :yellowish,
+  :struct     => :pale,
+  :symbol     => :cyanish,
+  :time       => :greenish,
+  :trueclass  => :green,
+  :variable   => :cyanish
+}
+```
 
 Supported color names:
 
-    :gray, :red, :green, :yellow, :blue, :purple, :cyan, :white
-    :black, :redish, :greenish, :yellowish, :blueish, :purpleish, :cyanish, :pale
+```ruby
+:gray, :red, :green, :yellow, :blue, :purple, :cyan, :white
+:black, :redish, :greenish, :yellowish, :blueish, :purpleish, :cyanish, :pale
+```
 
 ### Examples ###
-    $ cat > 1.rb
-    require "awesome_print"
-    data = [ false, 42, %w(forty two), { :now => Time.now, :class => Time.now.class, :distance => 42e42 } ]
-    ap data
-    ^D
-    $ ruby 1.rb
-    [
-        [0] false,
-        [1] 42,
-        [2] [
-            [0] "forty",
-            [1] "two"
-        ],
-        [3] {
-               :class => Time < Object,
-                 :now => Fri Apr 02 19:55:53 -0700 2010,
-            :distance => 4.2e+43
-        }
-    ]
-
-    $ cat > 2.rb
-    require "awesome_print"
-    data = { :now => Time.now, :class => Time.now.class, :distance => 42e42 }
-    ap data, :indent => -2  # <-- Left align hash keys.
-    ^D
-    $ ruby 2.rb
-    {
-      :class    => Time < Object,
-      :now      => Fri Apr 02 19:55:53 -0700 2010,
-      :distance => 4.2e+43
-    }
 
-    $ cat > 3.rb
-    require "awesome_print"
-    data = [ false, 42, %w(forty two) ]
-    data << data  # <-- Nested array.
-    ap data, :multiline => false
-    ^D
-    $ ruby 3.rb
-    [ false, 42, [ "forty", "two" ], [...] ]
-
-    $ cat > 4.rb
-    require "awesome_print"
-    class Hello
-      def self.world(x, y, z = nil, &blk)
-      end
-    end
-    ap Hello.methods - Class.methods
-    ^D
-    $ ruby 4.rb
-    [
-        [0] world(x, y, *z, &blk) Hello
-    ]
-
-    $ cat > 5.rb
-    require "awesome_print"
-    ap (''.methods - Object.methods).grep(/!/)
-    ^D
-    $ ruby 5.rb
-    [
-        [ 0] capitalize!()           String
-        [ 1]      chomp!(*arg1)      String
-        [ 2]       chop!()           String
-        [ 3]     delete!(*arg1)      String
-        [ 4]   downcase!()           String
-        [ 5]     encode!(*arg1)      String
-        [ 6]       gsub!(*arg1)      String
-        [ 7]     lstrip!()           String
-        [ 8]       next!()           String
-        [ 9]    reverse!()           String
-        [10]     rstrip!()           String
-        [11]      slice!(*arg1)      String
-        [12]    squeeze!(*arg1)      String
-        [13]      strip!()           String
-        [14]        sub!(*arg1)      String
-        [15]       succ!()           String
-        [16]   swapcase!()           String
-        [17]         tr!(arg1, arg2) String
-        [18]       tr_s!(arg1, arg2) String
-        [19]     upcase!()           String
-    ]
-
-    $ cat > 6.rb
-    require "awesome_print"
-    ap 42 == ap(42)
-    ^D
-    $ ruby 6.rb
-    42
-    true
-    $ cat 7.rb
-    require "awesome_print"
-    some_array = (1..1000).to_a
-    ap some_array, :limit => true
-    ^D
-    $ ruby 7.rb
-    [
-        [  0] 1,
-        [  1] 2,
-        [  2] 3,
-        [  3] .. [996],
-        [997] 998,
-        [998] 999,
-        [999] 1000
-    ]
-
-    $ cat 8.rb
-    require "awesome_print"
-    some_array = (1..1000).to_a
-    ap some_array, :limit => 5
-    ^D
-    $ ruby 8.rb
-    [
-        [  0] 1,
-        [  1] 2,
-        [  2] .. [997],
-        [998] 999,
-        [999] 1000
-    ]
+```ruby
+$ cat > 1.rb
+require "awesome_print"
+data = [ false, 42, %w(forty two), { :now => Time.now, :class => Time.now.class, :distance => 42e42 } ]
+ap data
+^D
+$ ruby 1.rb
+[
+    [0] false,
+    [1] 42,
+    [2] [
+        [0] "forty",
+        [1] "two"
+    ],
+    [3] {
+           :class => Time < Object,
+             :now => Fri Apr 02 19:55:53 -0700 2010,
+        :distance => 4.2e+43
+    }
+]
+
+$ cat > 2.rb
+require "awesome_print"
+data = { :now => Time.now, :class => Time.now.class, :distance => 42e42 }
+ap data, :indent => -2  # <-- Left align hash keys.
+^D
+$ ruby 2.rb
+{
+  :class    => Time < Object,
+  :now      => Fri Apr 02 19:55:53 -0700 2010,
+  :distance => 4.2e+43
+}
+
+$ cat > 3.rb
+require "awesome_print"
+data = [ false, 42, %w(forty two) ]
+data << data  # <-- Nested array.
+ap data, :multiline => false
+^D
+$ ruby 3.rb
+[ false, 42, [ "forty", "two" ], [...] ]
+
+$ cat > 4.rb
+require "awesome_print"
+class Hello
+  def self.world(x, y, z = nil, &blk)
+  end
+end
+ap Hello.methods - Class.methods
+^D
+$ ruby 4.rb
+[
+    [0] world(x, y, *z, &blk) Hello
+]
+
+$ cat > 5.rb
+require "awesome_print"
+ap (''.methods - Object.methods).grep(/!/)
+^D
+$ ruby 5.rb
+[
+    [ 0] capitalize!()           String
+    [ 1]      chomp!(*arg1)      String
+    [ 2]       chop!()           String
+    [ 3]     delete!(*arg1)      String
+    [ 4]   downcase!()           String
+    [ 5]     encode!(*arg1)      String
+    [ 6]       gsub!(*arg1)      String
+    [ 7]     lstrip!()           String
+    [ 8]       next!()           String
+    [ 9]    reverse!()           String
+    [10]     rstrip!()           String
+    [11]      slice!(*arg1)      String
+    [12]    squeeze!(*arg1)      String
+    [13]      strip!()           String
+    [14]        sub!(*arg1)      String
+    [15]       succ!()           String
+    [16]   swapcase!()           String
+    [17]         tr!(arg1, arg2) String
+    [18]       tr_s!(arg1, arg2) String
+    [19]     upcase!()           String
+]
+
+$ cat > 6.rb
+require "awesome_print"
+ap 42 == ap(42)
+^D
+$ ruby 6.rb
+42
+true
+$ cat 7.rb
+require "awesome_print"
+some_array = (1..1000).to_a
+ap some_array, :limit => true
+^D
+$ ruby 7.rb
+[
+    [  0] 1,
+    [  1] 2,
+    [  2] 3,
+    [  3] .. [996],
+    [997] 998,
+    [998] 999,
+    [999] 1000
+]
+
+$ cat 8.rb
+require "awesome_print"
+some_array = (1..1000).to_a
+ap some_array, :limit => 5
+^D
+$ ruby 8.rb
+[
+    [  0] 1,
+    [  1] 2,
+    [  2] .. [997],
+    [998] 999,
+    [999] 1000
+]
+```
 
 ### Example (Rails console) ###
-    $ rails console
-    rails> require "awesome_print"
-    rails> ap Account.all(:limit => 2)
-    [
-        [0] #<Account:0x1033220b8> {
-                         :id => 1,
-                    :user_id => 5,
-                :assigned_to => 7,
-                       :name => "Hayes-DuBuque",
-                     :access => "Public",
-                    :website => "http://www.hayesdubuque.com",
-            :toll_free_phone => "1-800-932-6571",
-                      :phone => "(111)549-5002",
-                        :fax => "(349)415-2266",
-                 :deleted_at => nil,
-                 :created_at => Sat, 06 Mar 2010 09:46:10 UTC +00:00,
-                 :updated_at => Sat, 06 Mar 2010 16:33:10 UTC +00:00,
-                      :email => "info@hayesdubuque.com",
-            :background_info => nil
-        },
-        [1] #<Account:0x103321ff0> {
-                         :id => 2,
-                    :user_id => 4,
-                :assigned_to => 4,
-                       :name => "Ziemann-Streich",
-                     :access => "Public",
-                    :website => "http://www.ziemannstreich.com",
-            :toll_free_phone => "1-800-871-0619",
-                      :phone => "(042)056-1534",
-                        :fax => "(106)017-8792",
-                 :deleted_at => nil,
-                 :created_at => Tue, 09 Feb 2010 13:32:10 UTC +00:00,
-                 :updated_at => Tue, 09 Feb 2010 20:05:01 UTC +00:00,
-                      :email => "info@ziemannstreich.com",
-            :background_info => nil
-        }
-    ]
-    rails> ap Account
-    class Account < ActiveRecord::Base {
-                     :id => :integer,
-                :user_id => :integer,
-            :assigned_to => :integer,
-                   :name => :string,
-                 :access => :string,
-                :website => :string,
-        :toll_free_phone => :string,
-                  :phone => :string,
-                    :fax => :string,
-             :deleted_at => :datetime,
-             :created_at => :datetime,
-             :updated_at => :datetime,
-                  :email => :string,
-        :background_info => :string
+```ruby
+$ rails console
+rails> require "awesome_print"
+rails> ap Account.limit(2).all
+[
+    [0] #<Account:0x1033220b8> {
+                     :id => 1,
+                :user_id => 5,
+            :assigned_to => 7,
+                   :name => "Hayes-DuBuque",
+                 :access => "Public",
+                :website => "http://www.hayesdubuque.com",
+        :toll_free_phone => "1-800-932-6571",
+                  :phone => "(111)549-5002",
+                    :fax => "(349)415-2266",
+             :deleted_at => nil,
+             :created_at => Sat, 06 Mar 2010 09:46:10 UTC +00:00,
+             :updated_at => Sat, 06 Mar 2010 16:33:10 UTC +00:00,
+                  :email => "info@hayesdubuque.com",
+        :background_info => nil
+    },
+    [1] #<Account:0x103321ff0> {
+                     :id => 2,
+                :user_id => 4,
+            :assigned_to => 4,
+                   :name => "Ziemann-Streich",
+                 :access => "Public",
+                :website => "http://www.ziemannstreich.com",
+        :toll_free_phone => "1-800-871-0619",
+                  :phone => "(042)056-1534",
+                    :fax => "(106)017-8792",
+             :deleted_at => nil,
+             :created_at => Tue, 09 Feb 2010 13:32:10 UTC +00:00,
+             :updated_at => Tue, 09 Feb 2010 20:05:01 UTC +00:00,
+                  :email => "info@ziemannstreich.com",
+        :background_info => nil
     }
-    rails>
+]
+rails> ap Account
+class Account < ActiveRecord::Base {
+                 :id => :integer,
+            :user_id => :integer,
+        :assigned_to => :integer,
+               :name => :string,
+             :access => :string,
+            :website => :string,
+    :toll_free_phone => :string,
+              :phone => :string,
+                :fax => :string,
+         :deleted_at => :datetime,
+         :created_at => :datetime,
+         :updated_at => :datetime,
+              :email => :string,
+    :background_info => :string
+}
+rails>
+```
 
 ### IRB integration ###
 To use awesome_print as default formatter in irb and Rails console add the following
 code to your ~/.irbrc file:
 
-	require "awesome_print"
-  AwesomePrint.irb!
+```ruby
+require "awesome_print"
+AwesomePrint.irb!
+```
 
 ### PRY integration ###
 If you miss awesome_print's way of formatting output, here's how you can use it in place
 of the formatting which comes with pry. Add the following code to your ~/.pryrc:
 
-	require "awesome_print"
-  AwesomePrint.pry!
+```ruby
+require "awesome_print"
+AwesomePrint.pry!
+```
 
 ### Logger Convenience Method ###
 awesome_print adds the 'ap' method to the Logger and ActiveSupport::BufferedLogger classes
@@ -274,14 +293,16 @@ You can set your own default options by creating ``.aprc`` file in your home
 directory. Within that file assign your  defaults to ``AwesomePrint.defaults``.
 For example:
 
-    # ~/.aprc file.
-    AwesomePrint.defaults = {
-      :indent => -2,
-      :color => {
-        :hash  => :pale,
-        :class => :white
-      }
-    }
+```ruby
+# ~/.aprc file.
+AwesomePrint.defaults = {
+  :indent => -2,
+  :color => {
+    :hash  => :pale,
+    :class => :white
+  }
+}
+```
 
 ### Running Specs ###
 
@@ -294,10 +315,12 @@ For example:
 * 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 commit URL (*do not* send me pull requests).
+* Send commit URL (*do not* send pull requests).
 
 ### Contributors ###
+Special thanks goes to awesome team of contributors, namely:
 
+* 6fusion.com -- https://github.com/6fusion
 * Adam Doppelt -- https://github.com/gurgeous
 * Andrew O'Brien -- https://github.com/AndrewO
 * Andrew Horsman -- https://github.com/basicxman
@@ -312,21 +335,32 @@ For example:
 * Evan Senter -- https://github.com/evansenter
 * George . -- https://github.com/gardelea
 * Greg Weber -- https://github.com/gregwebs
+* Jan Vansteenkiste -- https://github.com/vStone
 * Jeff Felchner -- https://github.com/jfelchner
+* Jonathan Davies -- send your Github URL ;-)
+* Kevin Olbrich -- https://github.com/olbrich
+* Matthew Schulkind -- https://github.com/mschulkind
+* Mike McQuaid -- https://github.com/mikemcquaid
+* Nami-Doc -- https://github.com/Nami-Doc
+* Nicolas Viennot -- https://github.com/nviennot
 * Nikolaj Nikolajsen -- https://github.com/nikolajsen
+* Richard Hall -- https://github.com/richardardrichard
 * Ryan Schlesinger -- https://github.com/ryansch
+* Scott Hyndman -- https://github.com/shyndman
 * Sean Gallagher -- http://github.com/torandu
 * Stephan Hagemann -- https://github.com/shageman
 * Tim Harper -- http://github.com/timcharper
 * Tobias Crawley -- http://github.com/tobias
 * Thibaut Barrère -- https://github.com/thbar
+* Trevor Wennblom -- https://github.com/trevor
+* vfrride -- https://github.com/vfrride
 * Viktar Basharymau -- https://github.com/DNNX
 
 ### License ###
-Copyright (c) 2010-2012 Michael Dvorkin
+Copyright (c) 2010-2013 Michael Dvorkin
 
 http://www.dvorkin.net
 
-%w(mike dvorkin.net) * "@" || %w(mike fatfreecrm.com) * "@"
+%w(mike dvorkin.net) * "@" || "twitter.com/mid"
 
 Released under the MIT license. See LICENSE file for details.