awesome_print 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb92d5e2cf0fdfb4adea4dce07a036029b215e53
-  data.tar.gz: 5ff2f87c655f96bdbf5393d18432dd967f3c48ef
+  metadata.gz: 99b8a5036bd1ecee2419c7b8dd40c4d532be0d3b
+  data.tar.gz: 76664afa8dcdc3113e0563dbab551c15eb88fc7d
 SHA512:
-  metadata.gz: e41bf9d0871110552cd501c718276cf610c14dad19732a75670d81b9028c84fe21af86405bca36a3b5d3f35ef1180bb6d3ae0871b26d8bd313091b8298a4a147
-  data.tar.gz: 7980fa638d522e0be24381a8edca2c480f1a3579b4c310bbee2c2228c41c4b9c1a738e23251381e52b8e2744d860e7ab35dcef654af37a003e2366a8a67c3b75
+  metadata.gz: 1c1351608b30f507cd3147eb6ef4a54d328919f46b30c75b5c60561f506db2b6ef5c7faacf62020a21e6a0e8fb7feebeb3c57b246acb25e72452338ecd347d12
+  data.tar.gz: 61497937047523ccd15d81ac8c0059e0a2ddcac9d505832513ed1ac8300fff46fa496da3a4e33f5c2e92b70dd2ba0b8c6c8ed3f45bac393902ce524464235df0

data/Appraisals

@@ -4,28 +4,37 @@ end
 
 appraise 'rails-4.0' do
   gem 'rails', '~> 4.0.0'
+
+  # The last version that doesn't need Ruby 2.0 and works with version 4.0 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-4.1' do
   gem 'rails', '~> 4.1.0'
+
+  # The last version that doesn't need Ruby 2.0 and works with version 4.1 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-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 'mongoid-3.0' do
-  gem 'rails', '~> 3.2.0'
   gem 'mongoid', '~> 3.0.0'
 end
 
 appraise 'mongoid-3.1' do
-  gem 'rails', '~> 3.2.0'
   gem 'mongoid', '~> 3.1.0'
 end
 
 appraise 'mongoid-4.0' do
-  gem 'rails', '~> 4.2.0'
   gem 'mongoid', '~> 4.0.0'
 end
 
@@ -37,3 +46,7 @@ appraise 'ripple' do
   gem 'tzinfo'
   gem 'ripple'
 end
+
+appraise 'nobrainer' do
+  gem 'nobrainer'
+end

data/{CHANGELOG → CHANGELOG.md}

@@ -1,11 +1,25 @@
-1.6.1
+## master (unreleased)
+
+
+## 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
+## 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)
@@ -17,7 +31,8 @@
   - 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.
+## 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)
@@ -25,7 +40,7 @@
   - Fixed HTML formatting (Mike McQuaid)
   - Other minor bugs and enhancements
 
-1.1.0
+## 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)
@@ -36,17 +51,17 @@
   - Fixed conflict with the colorize gem
   - Misc tweaks and bug fixes
 
-1.0.2
+## 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
+## 1.0.1
   - Updated repo tags for Rubygems.org
 
-1.0.0 Thanksgiving edition
+## 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)
@@ -54,7 +69,7 @@
   - Added Nokogiri extension (Adam Doppelt)
   - Removed Jeweler gem dependency
 
-0.4.0
+## 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)
@@ -64,52 +79,74 @@
   - Improved Ruby 1.8.6 and 1.8.7 compatibility
   - Improved Windows compatibility (Viktar Basharymau)
 
-0.3.2
+## 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
+## 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
+## 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
+## 0.2.1
   - ap can now be used within Rails templates (ex. <%= ap object %>)
   - Added support for printing Struct
 
-0.2.0
+## 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
+## 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
+## 0.1.3
   - Added support for setting custom defaults in ~/.aprc
 
-0.1.2
+## 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
+## 0.1.1
   - Added support for tableless ActiveRecord models
   - Left align hash keys if @options[:indent] is negative
 
-0.1.0
+## 0.1.0
   - Initial Release.
 
+  [#200]: https://github.com/awesome-print/awesome_print/pull/200
+  [#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
+  [@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

@@ -8,15 +8,15 @@ We love pull requests. Here's a quick guide:
 
 1. Update [CHANGELOG.md](https://github.com/michaeldv/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 like to at least comment on, if not
-accept, pull requests within three business days (and, typically, one business
-day). We may suggest some changes or improvements or alternatives.
+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/).
 
@@ -39,3 +39,43 @@ 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
+* 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/README.md

@@ -3,6 +3,7 @@
 [![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/michaeldv/awesome_print?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
@@ -70,6 +71,13 @@ 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 ###
 
 ```ruby
@@ -316,57 +324,9 @@ AwesomePrint.defaults = {
 
 AwesomePrint follows the [Semantic Versioning](http://semver.org/) standard.
 
-### 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
+### Contributing ###
+See [Contributing.md](https://github.com/michaeldv/awesome_print/blob/master/CONTRIBUTING.md)
+ for information.
 
 ### License ###
 Copyright (c) 2010-2013 Michael Dvorkin
@@ -381,6 +341,7 @@ Released under the MIT license. See LICENSE file for details.
 [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/michaeldv/awesome_print
-[travis_ci_badge]: https://img.shields.io/travis/michaeldv/awesome_print.svg?style=flat
+[travis_ci_badge]: https://img.shields.io/travis/michaeldv/awesome_print/master.svg?style=flat
 [code_climate]: https://codeclimate.com/github/michaeldv/awesome_print
 [code_climate_badge]: http://img.shields.io/codeclimate/github/michaeldv/awesome_print.svg?style=flat
+[code_climate_coverage_badge]: https://codeclimate.com/github/michaeldv/awesome_print/badges/coverage.svg

data/lib/awesome_print.rb

@@ -25,7 +25,7 @@ unless defined?(AwesomePrint::Inspector)
   #
   # Load remaining extensions.
   #
-  if defined?(ActiveSupport)
+  if defined?(ActiveSupport.on_load)
     ActiveSupport.on_load(:action_view) do
       require File.dirname(__FILE__) + "/awesome_print/ext/action_view"
     end
@@ -33,7 +33,7 @@ unless defined?(AwesomePrint::Inspector)
   require File.dirname(__FILE__) + "/awesome_print/ext/mongo_mapper"   if defined?(MongoMapper)
   require File.dirname(__FILE__) + "/awesome_print/ext/mongoid"        if defined?(Mongoid)
   require File.dirname(__FILE__) + "/awesome_print/ext/nokogiri"       if defined?(Nokogiri)
-  require File.dirname(__FILE__) + "/awesome_print/ext/no_brainer"     if defined?(NoBrainer)
+  require File.dirname(__FILE__) + "/awesome_print/ext/nobrainer"      if defined?(NoBrainer)
   require File.dirname(__FILE__) + "/awesome_print/ext/ripple"         if defined?(Ripple)
   require File.dirname(__FILE__) + "/awesome_print/ext/sequel"         if defined?(Sequel)
   require File.dirname(__FILE__) + "/awesome_print/ext/ostruct"        if defined?(OpenStruct)

data/lib/awesome_print/colorize.rb

@@ -0,0 +1,24 @@
+autoload :CGI, "cgi"
+
+module AwesomePrint
+  module Colorize
+
+    # Pick the color and apply it to the given string as necessary.
+    #------------------------------------------------------------------------------
+    def colorize(str, type)
+      str = CGI.escapeHTML(str) if options[:html]
+      if options[:plain] || !options[:color][type] || !inspector.colorize?
+        str
+      #
+      # Check if the string color method is defined by awesome_print and accepts
+      # html parameter or it has been overriden by some gem such as colorize.
+      #
+      elsif str.method(options[:color][type]).arity == -1 # Accepts html parameter.
+        str.send(options[:color][type], options[:html])
+      else
+        str = %Q|<kbd style="color:#{options[:color][type]}">#{str}</kbd>| if options[:html]
+        str.send(options[:color][type])
+      end
+    end
+  end
+end

data/lib/awesome_print/ext/nobrainer.rb

@@ -0,0 +1,49 @@
+# Copyright (c) 2010-2013 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 AwesomePrint
+  module NoBrainer
+
+    def self.included(base)
+      base.send :alias_method, :cast_without_nobrainer, :cast
+      base.send :alias_method, :cast, :cast_with_nobrainer
+    end
+
+    # Add NoBrainer class names to the dispatcher pipeline.
+    #------------------------------------------------------------------------------
+    def cast_with_nobrainer(object, type)
+      cast = cast_without_nobrainer(object, type)
+      if defined?(::NoBrainer::Document)
+        if object.is_a?(Class) && object < ::NoBrainer::Document
+          cast = :nobrainer_class
+        elsif object.is_a?(::NoBrainer::Document)
+          cast = :nobrainer_document
+        end
+      end
+      cast
+    end
+
+    # Format NoBrainer class object.
+    #------------------------------------------------------------------------------
+    def awesome_nobrainer_class(object)
+      data = Hash[object.fields.map do |field, options|
+        [field, (options[:type] || Object).to_s.underscore.to_sym]
+      end]
+      "class #{object} < #{object.superclass} " << awesome_hash(data)
+    end
+
+    # Format NoBrainer Document object.
+    #------------------------------------------------------------------------------
+    def awesome_nobrainer_document(object)
+      data = object.inspectable_attributes.symbolize_keys
+      if object.errors.present?
+        data = {:errors => object.errors, :attributes => data}
+      end
+      "#{object} #{awesome_hash(data)}"
+    end
+  end
+end
+
+AwesomePrint::Formatter.send(:include, AwesomePrint::NoBrainer)