awesome_print 1.2.0 → 1.9.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bc6d20d854c529b902cfe961bd8271b30f1aa9f82c4db11bfdcaa6ecb6b1f469
+  data.tar.gz: c4f69e0cf2663cb4889b27414bd9f242789fea28790c3252dc5b2788da70bca2
+SHA512:
+  metadata.gz: c34cd0b7347ecf6e98afc4ef0647f940a02a5d125c955748917c821e6bbf231830604fcbe0fb524c6bfdaa049d6f945bad658d30433bf878841b30a6d79ad765
+  data.tar.gz: 9cfae5c9646b5194a52c87b1ea38ba3d711cb616a713e66ce0ab83f255293a4b75f4016f349f047aa43d775d14b9f024fc0edccdf40b9f489e46626908162b00

data/.gitignore

@@ -13,12 +13,24 @@ tmtags
 ## VIM
 *.swp
 
+## RUBYMINE
+.idea
+
 ## PROJECT::GENERAL
 coverage
 rdoc
 pkg
+.ruby-version
+gemfiles/*.gemfile.lock
 Gemfile.lock
+/tmp
+/.bundle
+/gemfiles/.bundle
+/gemfiles/vendor/bundle
 
-## PROJECT::SPECIFIC
+## PROJECT::RVM
 .rvmrc
-.idea
+
+# PROJECT::RBENV
+.ruby-gemset
+.awesome-print/

data/Appraisals

@@ -0,0 +1,62 @@
+# appraise 'rails-4.2' do
+#   gem 'rails', '~> 4.2.0'
+#
+#   # The last version that doesn't need Ruby 2.0 and works with version 4.2 of
+#   # Rails. This addresses a build problem with Travis for version 1.9.3 of Ruby
+#   gem 'mime-types', '2.6.2', :platforms => :ruby_19
+# end
+
+appraise 'rails-5.0' do
+  gem 'rails', '>= 5.0.0', '< 5.1'
+  gem 'sqlite3', '~> 1.3.6'
+end
+
+appraise 'rails-5.1' do
+  gem 'rails', '>= 5.1.0', '< 5.2'
+end
+
+appraise 'rails-5.2' do
+  gem 'rails', '>= 5.2.0', '< 5.3'
+end
+
+appraise 'rails-6.0' do
+  gem 'rails', '>= 6.0.0', '< 6.1'
+end
+
+appraise 'rails-6.1' do
+  gem 'rails', '>= 6.1.0', '< 6.2'
+end
+
+appraise 'mongoid-5.0' do
+  gem 'mongoid', '~> 5.0.0'
+  gem 'bigdecimal', '~> 1.3.5'
+end
+
+appraise 'mongoid-6.0' do
+  gem 'mongoid', '~> 6.0.0'
+end
+
+appraise 'mongoid-7.0' do
+  gem 'mongoid', '~> 7.0.0'
+end
+
+appraise 'mongoid-7.1' do
+  gem 'mongoid', '~> 7.1.0'
+end
+
+# appraise 'mongo_mapper' do
+#   gem 'mongo_mapper'
+# end
+#
+# appraise 'ripple' do
+#   gem 'tzinfo'
+#   gem 'ripple'
+# end
+#
+# appraise 'nobrainer' do
+#   gem 'nobrainer'
+#
+#   # When activesupport 5 was released, it required ruby 2.2.2 as a minimum.
+#   # Locking this down to 4.2.6 allows our Ruby 1.9 tests to keep working.
+#   gem 'activesupport', '4.2.6', :platforms => :ruby_19
+# end

data/CHANGELOG.md

@@ -0,0 +1,180 @@
+## master (unreleased)
+
+
+## 1.9.2
+  - Tests work with Ruby 2.6.6, 2.7.2 and 3.0.0
+  - Update awsome_print.gemspec nokogiri dependency to resolve CVEs [@gvwirth]
+
+## 1.9.1
+  - Updated code so it can be released to rubygems.
+  - Updated nokogiri to resolve vulnerability scan
+
+## 1.9.0
+  - Update method signature after change in IRB [@febeling]
+  - Fixes block and proc definition to work with Ruby 3.0.0 [@csalvato] - [#392]
+  - Removed check for Ruby 2.4 and earlier [@bryanh]
+  - Rails 5.0 builds are failing, because the sqlite3 version being installed is wrong version [#366]
+  - Fixes spec suite to properly work via travis, gets a clean build [@imajes, others]
+  - Adds support for ActiveModel::Errors [@dshinzie] - [#301]
+  - removes use of `strip_heredoc` from specs as it's a rails dep [@kstephens] - [#303]
+  - ArrayFormatter now returns arrays for has_many :through associations [@chadh13] - [#332]
+
+## 1.8.0
+  - stat("$HOME/.aprc") once [@kstephens] - [#304]
+  - ActiveRecord: #joins now show the columns #select'ed [@adrianomitre] - [#211]
+  - Handles NoMethodError for IRB implicit `ai` [@jtnegrotto] - [#212]
+  - Replaced Fixnum reference with Integer
+  - Colorize ORM class names [@ixti]
+
+## 1.7.0
+  - Refactoring by extracting formatters into their own classes [@waldyr] - [#237]
+  - Fixes Travis builds and improves tests [@nviennot], [@waldyr], [@gerrywastaken] - [#225], [#228], [#229], [#230], [#231]
+  - Creates `awesome_object_data` to encapsulate the logic of printing object internals,
+  so Structs and Objects can be printed as one [@waldyr] - [#226]
+  - Fixes development dependencies for environments without rake [@aleandros], [@cyberdelia] - [#222], [#216]
+  - Documents `ai` method usage [@MaxPleaner] - [#217]
+  - Fixes conflict with `mail` and other gems which fake ActiveSupport [@kemmason] - [#200]
+  - Improves spec performance and simplicity [@maurogeorge]
+  - Handle objects that have a custom #to_hash method [@clonezone]
+
+## 1.6.1
+  - Fixes specs on all rails dependencies (Mauro George)
+  - Updates specs for mongoid, mongo_mapper and ripple (James Cox)
+  - Adds appraisals for simpler version/scenario management (Mauro George)
+  - Add Travis (Mauro George)
+  - Update documentation (Mauro George)
+
+## 1.6.0
+  semi-major release since it's been a while, and there are several
+  improvements.
+  - Improves support for new mongoid/moped (Velkitor, Francois Bernier et al)
+  - Converts specs to rspec 3+ (Adam Jonas, James Cox)
+  - Fixes incompatibility with IPAddr (James Cox, Michael Dvorkin)
+  - Fixes incompatibility with the money gem (Michael Dvorkin)
+  - Fixes AR::Relation presentation (Sergey Ponomarov)
+  - Lazy-loads ActionView (Akira Matsuda)
+  - Fixes inspection of abstract classes (Jonathan Priddle)
+  - Gets most specs passing, and fixes suite (Eoin Kelly)
+
+## 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
+  - Added support for Mongoid 3 and Moped (Nikolaj Nikolajsen)
+  - Improved formatting of MongoMapper objects (George .)
+  - ActiveRecord::Relation now renders as array (Dan Lynn)
+  - Formatting BigDecimal no longer looses precision (Evan Senter)
+  - Added AwesomePrint.irb! and AwesomePrint.pry! convenience methods
+  - Fixed conflict with the colorize gem
+  - Misc tweaks and bug fixes
+
+## 1.0.2
+  - Added formatting of Mongoid documents (Adam Doppelt)
+  - ActiveRecord objects display attributes only. Use :raw => true to display the entire object
+  - ActiveSupport::Date objects get formatted as regular Date
+  - Rails.logger.ap colorizes output based on ActiveSupport::LogSubscriber.colorize_logging (default is true)
+  - Improved formatting of methods array
+
+## 1.0.1
+  - Updated repo tags for Rubygems.org
+
+## 1.0.0 Thanksgiving edition
+  - Added ability to format *arbitrary* Ruby object
+  - Added :limit option to limit large output for arrays and hashes (Andrew Horsman)
+  - Improved HTML formatting when :html => true (Daniel Johnson)
+  - Added Mongoid extension (Adam Doppelt)
+  - Added Nokogiri extension (Adam Doppelt)
+  - Removed Jeweler gem dependency
+
+## 0.4.0
+  - 'ap object' now returns the object (Stephan Hagemann)
+  - Added :html => true option to enable HTML colors rather that ANSI (ex. Sinatra templates)
+  - Added AwesomePrint.force_colors! to allow color output on demand (Andrew O'Brien)
+  - Added MongoMapper formatter mixin (Elpizo Choi)
+  - Fixed formatting of methods array when object#method is overridden
+  - Fixed potential stack errors by checking whether AwesomePrint is already loaded
+  - Improved Ruby 1.8.6 and 1.8.7 compatibility
+  - Improved Windows compatibility (Viktar Basharymau)
+
+## 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
+
+## 0.3.0
+  - Display object.methods and family in human readable format
+  - Objects inherited from Array, Hash, File, Dir, and Struct are shown as their base class
+  - Added option to suppress array index in output (Sean Gallagher)
+  - Updated README on how to set up ~/.irbrc for MacRuby (Eloy Duran)
+  - Specs pass 100% with Ruby 1.8.7/RSpec 1.3 and Ruby 1.9.2/RSpec 2.0
+
+## 0.2.1
+  - ap can now be used within Rails templates (ex. <%= ap object %>)
+  - Added support for printing Struct
+
+## 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
+  - 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
+
+## 0.1.2
+  - Correctly handle empty arrays and hashes
+  - Use alias_method instead of alias (fixes non-tty method aliasing)
+  - Added awesome_inspect method
+
+## 0.1.1
+  - Added support for tableless ActiveRecord models
+  - Left align hash keys if @options[:indent] is negative
+
+## 0.1.0
+  - Initial Release.
+
+  [#200]: https://github.com/awesome-print/awesome_print/pull/200
+  [#212]: https://github.com/awesome-print/awesome_print/pull/212
+  [#216]: https://github.com/awesome-print/awesome_print/pull/216
+  [#217]: https://github.com/awesome-print/awesome_print/pull/217
+  [#222]: https://github.com/awesome-print/awesome_print/pull/222
+  [#225]: https://github.com/awesome-print/awesome_print/pull/225
+  [#226]: https://github.com/awesome-print/awesome_print/pull/226
+  [#228]: https://github.com/awesome-print/awesome_print/pull/228
+  [#229]: https://github.com/awesome-print/awesome_print/pull/229
+  [#230]: https://github.com/awesome-print/awesome_print/pull/230
+  [#231]: https://github.com/awesome-print/awesome_print/pull/231
+  [#232]: https://github.com/awesome-print/awesome_print/pull/232
+  [#237]: https://github.com/awesome-print/awesome_print/pull/237
+
+  [@aleandros]: https://github.com/aleandros
+  [@clonezone]: https://github.com/clonezone
+  [@cyberdelia]: https://github.com/cyberdelia
+  [@gerrywastaken]: https://github.com/gerrywastaken
+  [@ixti]: https://github.com/ixti
+  [@jtnegrotto]: https://github.com/jtnegrotto
+  [@kemmason]: https://github.com/kemmason
+  [@maurogeorge]: https://github.com/maurogeorge
+  [@MaxPleaner]: https://github.com/MaxPleaner
+  [@nviennot]: https://github.com/nviennot
+  [@waldyr]: https://github.com/waldyr

data/CONTRIBUTING.md

@@ -0,0 +1,82 @@
+# Contributing
+
+We love pull requests. Here's a quick guide:
+
+1. Fork the repo.
+
+1. Create your feature branch (`git checkout -b my-new-feature`)
+
+1. Update [CHANGELOG.md](https://github.com/awesome-print/awesome_print/blob/master/CHANGELOG.md) with a brief description of your changes under the `unreleased` heading.
+
+1. Add/Update tests were appropriate
+
+1. Commit your changes (`git commit -am 'Added some feature'`)
+
+1. Push to the branch (`git push origin my-new-feature`)
+
+1. Create new Pull Request
+
+At this point you're waiting on us. We are not super fast at responding, but we will do our best to get to your PR as soon as time permits. We may suggest some changes, improvements or alternatives.
+
+Some things that will increase the chance that your pull request is accepted is to follow the practices described on [Ruby style guide](https://github.com/bbatsov/ruby-style-guide), [Rails style guide](https://github.com/bbatsov/rails-style-guide) and [Better Specs](http://betterspecs.org/).
+
+## Specs
+
+To run all the specs in all gemfiles just run:
+
+```
+$ rake
+```
+
+To run specs of a single gemfile run:
+
+```
+$ appraisal rails-3.2 rake
+```
+
+If you want to run a specific spec in a gemfile run:
+
+```
+$ appraisal rails-3.2 rspec spec/colors_spec.rb
+```
+
+## Contributor Rolecall
+
+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
+* Barry Allard -- https://github.com/steakknife
+* Benoit Daloze -- http://github.com/eregon
+* Brandon Zylstra -- https://github.com/brandondrew
+* Bryan Hanks, PMP -- https://github.com/bryanh
+* Dan Lynn -- https://github.com/danlynn
+* Daniel Johnson -- https://github.com/adhd360
+* Daniel Bretoi -- http://github.com/danielb2
+* Eloy Duran -- http://github.com/alloy
+* Elpizo Choi -- https://github.com/fuJiin
+* 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

data/Gemfile

@@ -1,3 +1,4 @@
-source "https://rubygems.org"
-gemspec
+source 'https://rubygems.org'
 
+# Specify your gem's dependencies in awesome_print.gemspec
+gemspec

data/LICENSE

@@ -1,22 +1,19 @@
-Copyright (c) 2010-2013 Michael Dvorkin
-http://www.dvorkin.net
-%w(mike dvorkin.net) * "@" || %w(mike fatfreecrm.com) * "@"
+Copyright (c) 2010-2019 Michael Dvorkin
 
-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:
+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 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.
+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

@@ -1,18 +1,26 @@
 ## Awesome Print ##
+
+[![RubyGems][gem_version_badge]][ruby_gems]
+[![Travis CI][travis_ci_badge]][travis_ci]
+[![Code Climate][code_climate_badge]][code_climate]
+[![Code Climate Coverage][code_climate_coverage_badge]][code_climate]
+[![RubyGems][gem_downloads_badge]][ruby_gems]
+[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/awesome-print/awesome_print?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+
 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.
+__NOTE__: awesome_print v1.9.0 may not work on Ruby versions 2.4 or older or Rails versions 4.2 or older.
+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
 
     # Cloning the repository
-    $ git clone git://github.com/michaeldv/awesome_print.git
+    $ git clone git://github.com/awesome-print/awesome_print.git
 
 ### Usage ###
 
@@ -24,34 +32,38 @@ ap object, options = {}
 Default options:
 
 ```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
+indent:        4,      # Number of spaces for indenting.
+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 instance variables.
+sort_keys:     false,  # Do not sort hash keys.
+sort_vars:     true,   # Sort instance variables.
+limit:         false,  # Limit arrays & hashes. Accepts bool or int.
+ruby19_syntax: false,  # Use Ruby 1.9 hash syntax in output.
+class_name:    :class, # Method called to report the instance class name. (e.g. :to_s)
+object_id:     true,   # Show object id.
+color: {
+  args:       :pale,
+  array:      :white,
+  bigdecimal: :blue,
+  class:      :yellow,
+  date:       :greenish,
+  falseclass: :red,
+  integer:    :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
 }
 ```
 
@@ -62,8 +74,17 @@ Supported color names:
 :black, :redish, :greenish, :yellowish, :blueish, :purpleish, :cyanish, :pale
 ```
 
+Use `Object#ai` to return an ASCII encoded string:
+
+```ruby
+irb> "awesome print".ai
+=> "\e[0;33m\"awesome print\"\e[0m"
+```
+
 ### Examples ###
 
+#### Array
+
 ```ruby
 $ cat > 1.rb
 require "awesome_print"
@@ -84,7 +105,10 @@ $ ruby 1.rb
         :distance => 4.2e+43
     }
 ]
+```
+#### Hash
 
+```ruby
 $ cat > 2.rb
 require "awesome_print"
 data = { :now => Time.now, :class => Time.now.class, :distance => 42e42 }
@@ -96,7 +120,11 @@ $ ruby 2.rb
   :now      => Fri Apr 02 19:55:53 -0700 2010,
   :distance => 4.2e+43
 }
+```
+
+#### Nested array
 
+```ruby
 $ cat > 3.rb
 require "awesome_print"
 data = [ false, 42, %w(forty two) ]
@@ -106,6 +134,11 @@ ap data, :multiline => false
 $ ruby 3.rb
 [ false, 42, [ "forty", "two" ], [...] ]
 
+```
+
+#### Class methods
+
+```ruby
 $ cat > 4.rb
 require "awesome_print"
 class Hello
@@ -119,6 +152,11 @@ $ ruby 4.rb
     [0] world(x, y, *z, &blk) Hello
 ]
 
+```
+
+#### Object methods
+
+```ruby
 $ cat > 5.rb
 require "awesome_print"
 ap (''.methods - Object.methods).grep(/!/)
@@ -147,6 +185,11 @@ $ ruby 5.rb
     [19]     upcase!()           String
 ]
 
+```
+
+#### Compare output to value
+
+```ruby
 $ cat > 6.rb
 require "awesome_print"
 ap 42 == ap(42)
@@ -154,7 +197,13 @@ ap 42 == ap(42)
 $ ruby 6.rb
 42
 true
-$ cat 7.rb
+
+```
+
+#### Array with default output limit
+
+```ruby
+$ cat > 7.rb
 require "awesome_print"
 some_array = (1..1000).to_a
 ap some_array, :limit => true
@@ -169,8 +218,12 @@ $ ruby 7.rb
     [998] 999,
     [999] 1000
 ]
+```
+
+#### Array with specific output limit
 
-$ cat 8.rb
+```ruby
+$ cat > 8.rb
 require "awesome_print"
 some_array = (1..1000).to_a
 ap some_array, :limit => 5
@@ -185,7 +238,7 @@ $ ruby 8.rb
 ]
 ```
 
-### Example (Rails console) ###
+#### Rails console
 ```ruby
 $ rails console
 rails> require "awesome_print"
@@ -288,6 +341,14 @@ formatting:
 
     <%= ap @accounts.first, :html => true %>
 
+### String Convenience Methods ###
+Use methods such as `.red` to set string color:
+
+```ruby
+irb> puts "red text".red
+red text # (it's red)
+```
+
 ### 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``.
@@ -304,63 +365,27 @@ AwesomePrint.defaults = {
 }
 ```
 
-### Running Specs ###
-
-    $ gem install rspec           # RSpec 2.x is the requirement.
-    $ rake spec                   # Run the entire spec suite.
-    $ rspec spec/logger_spec.rb   # Run individual spec file.
-
-### 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 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
-* Barry Allard -- https://github.com/steakknife
-* Benoit Daloze -- http://github.com/eregon
-* Brandon Zylstra -- https://github.com/brandondrew
-* Dan Lynn -- https://github.com/danlynn
-* Daniel Johnson -- https://github.com/adhd360
-* Daniel Bretoi -- http://github.com/danielb2
-* Eloy Duran -- http://github.com/alloy
-* Elpizo Choi -- https://github.com/fuJiin
-* 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
+## Versioning
+
+AwesomePrint follows the [Semantic Versioning](http://semver.org/) standard.
+
+### Contributing ###
+See [CONTRIBUTING.md](CONTRIBUTING.md) for information.
 
 ### License ###
-Copyright (c) 2010-2013 Michael Dvorkin
+Copyright (c) 2010-2016 Michael Dvorkin and contributors
 
 http://www.dvorkin.net
 
 %w(mike dvorkin.net) * "@" || "twitter.com/mid"
 
 Released under the MIT license. See LICENSE file for details.
+
+[gem_version_badge]: https://img.shields.io/gem/v/awesome_print.svg?style=flat
+[gem_downloads_badge]: http://img.shields.io/gem/dt/awesome_print.svg?style=flat
+[ruby_gems]: http://rubygems.org/gems/awesome_print
+[travis_ci]: http://travis-ci.org/awesome-print/awesome_print
+[travis_ci_badge]: https://img.shields.io/travis/awesome-print/awesome_print/master.svg?style=flat
+[code_climate]: https://codeclimate.com/github/awesome-print/awesome_print
+[code_climate_badge]: http://img.shields.io/codeclimate/github/awesome-print/awesome_print.svg?style=flat
+[code_climate_coverage_badge]: https://codeclimate.com/github/awesome-print/awesome_print/badges/coverage.svg