awesome_print 1.6.1 → 1.9.2

data/README.md

@@ -3,24 +3,24 @@
 [![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)
+[![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 ###
 
@@ -32,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
 }
 ```
 
@@ -70,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"
@@ -92,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 }
@@ -104,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) ]
@@ -114,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
@@ -127,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(/!/)
@@ -155,6 +185,11 @@ $ ruby 5.rb
     [19]     upcase!()           String
 ]
 
+```
+
+#### Compare output to value
+
+```ruby
 $ cat > 6.rb
 require "awesome_print"
 ap 42 == ap(42)
@@ -162,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
@@ -177,8 +218,12 @@ $ ruby 7.rb
     [998] 999,
     [999] 1000
 ]
+```
 
-$ cat 8.rb
+#### Array with specific output limit
+
+```ruby
+$ cat > 8.rb
 require "awesome_print"
 some_array = (1..1000).to_a
 ap some_array, :limit => 5
@@ -193,7 +238,7 @@ $ ruby 8.rb
 ]
 ```
 
-### Example (Rails console) ###
+#### Rails console
 ```ruby
 $ rails console
 rails> require "awesome_print"
@@ -296,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``.
@@ -316,60 +369,11 @@ 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](CONTRIBUTING.md) for information.
 
 ### License ###
-Copyright (c) 2010-2013 Michael Dvorkin
+Copyright (c) 2010-2016 Michael Dvorkin and contributors
 
 http://www.dvorkin.net
 
@@ -380,7 +384,8 @@ 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/michaeldv/awesome_print
-[travis_ci_badge]: https://img.shields.io/travis/michaeldv/awesome_print.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
+[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

data/Rakefile

@@ -1,7 +1,7 @@
-require "rubygems"
-require "bundler/setup"
+require 'rubygems'
+require 'bundler/setup'
 
-require "bundler"
+require 'bundler'
 Bundler::GemHelper.install_tasks
 
 task :default do
@@ -16,9 +16,9 @@ task :appraise do
   exec 'appraisal install && appraisal rake'
 end
 
-desc "Run all awesome_print gem specs"
+desc 'Run all awesome_print gem specs'
 task :spec do
   # Run plain rspec command without RSpec::Core::RakeTask overrides.
-  exec "rspec -c spec"
+  exec 'rspec -c spec'
 end
 

data/awesome_print.gemspec

@@ -0,0 +1,33 @@
+# Copyright (c) 2010-2016 Michael Dvorkin and contributors
+#
+# Awesome Print is freely distributable under the terms of MIT license.
+# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+
+$:.push File.expand_path('../lib', __FILE__)
+require 'awesome_print/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'awesome_print'
+  s.version     = AwesomePrint.version
+  s.authors     = 'Michael Dvorkin'
+  s.date        = Time.now.strftime('%Y-%m-%d')
+  s.email       = 'mike@dvorkin.net'
+  s.homepage    = 'https://github.com/awesome-print/awesome_print'
+  s.summary     = 'Pretty print Ruby objects with proper indentation and colors'
+  s.description = 'Great Ruby debugging companion: pretty print Ruby objects to visualize their structure. Supports custom object formatting via plugins'
+  s.license     = 'MIT'
+
+  s.files         = Dir['[A-Z]*[^~]'] + Dir['lib/**/*.rb'] + Dir['spec/**/*'] + ['.gitignore']
+  s.test_files    = Dir['spec/**/*']
+  s.executables   = []
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'rspec',  '>= 3.0.0'
+  s.add_development_dependency 'appraisal'
+  s.add_development_dependency 'fakefs', '>= 0.2.1'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'nokogiri', '>= 1.11.0'
+  # s.add_development_dependency 'simplecov'
+  # s.add_development_dependency 'codeclimate-test-reporter'
+end

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'lib', 'awesome_print')

data/lib/ap.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2013 Michael Dvorkin
+# Copyright (c) 2010-2016 Michael Dvorkin and contributors
 #
 # Awesome Print is freely distributable under the terms of MIT license.
 # See LICENSE file or http://www.opensource.org/licenses/mit-license.php
@@ -7,4 +7,4 @@
 # Keeping this for backwards compatibility to allow
 # require "ap"
 #
-require File.dirname(__FILE__) + "/awesome_print"
+require File.dirname(__FILE__) + '/awesome_print'

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/core_ext/{array.rb → awesome_method_array.rb}

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2013 Michael Dvorkin
+# Copyright (c) 2010-2016 Michael Dvorkin and contributors
 #
 # Awesome Print is freely distributable under the terms of MIT license.
 # See LICENSE file or http://www.opensource.org/licenses/mit-license.php
@@ -12,24 +12,24 @@
 #
 # If you could think of a better way please let me know :-)
 #
-class Array #:nodoc:
-  [ :-, :& ].each do |operator|
-    original_operator = instance_method(operator)
+module AwesomeMethodArray #:nodoc:
 
-    define_method operator do |*args|
-      arr = original_operator.bind(self).call(*args)
-      if self.instance_variable_defined?('@__awesome_methods__')
-        arr.instance_variable_set('@__awesome_methods__', self.instance_variable_get('@__awesome_methods__'))
-        arr.sort! { |a, b| a.to_s <=> b.to_s }  # Need the block since Ruby 1.8.x can't sort arrays of symbols.
-      end
-      arr
+  def -(_other_ary)
+    super.tap do |arr|
+      arr.instance_variable_set(:@__awesome_methods__, self.instance_variable_get(:@__awesome_methods__))
+    end
+  end
+
+  def &(_other_ary)
+    super.tap do |arr|
+      arr.instance_variable_set(:@__awesome_methods__, self.instance_variable_get(:@__awesome_methods__))
     end
   end
+
   #
   # Intercepting Array#grep needs a special treatment since grep accepts
   # an optional block.
   #
-  alias :original_grep :grep
   def grep(pattern, &blk)
     #
     # The following looks rather insane and I've sent numerous hours trying
@@ -55,9 +55,9 @@ class Array #:nodoc:
     # the comment :-)
     #
     arr = unless blk
-      original_grep(pattern)
+      super(pattern)
     else
-      original_grep(pattern) do |match|
+      super(pattern) do |match|
         #
         # The binding can only be used with Ruby-defined methods, therefore
         # we must rescue potential "ArgumentError: Can't create Binding from
@@ -72,10 +72,8 @@ class Array #:nodoc:
         yield match
       end
     end
-    if self.instance_variable_defined?('@__awesome_methods__')
-      arr.instance_variable_set('@__awesome_methods__', self.instance_variable_get('@__awesome_methods__'))
-      arr.reject! { |item| !(item.is_a?(Symbol) || item.is_a?(String)) } # grep block might return crap.
-    end
+    arr.instance_variable_set(:@__awesome_methods__, self.instance_variable_get(:@__awesome_methods__))
+    arr.reject! { |item| !(item.is_a?(Symbol) || item.is_a?(String)) } # grep block might return crap.
     arr
   end
 end

data/lib/awesome_print/core_ext/class.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2013 Michael Dvorkin
+# Copyright (c) 2010-2016 Michael Dvorkin and contributors
 #
 # Awesome Print is freely distributable under the terms of MIT license.
 # See LICENSE file or http://www.opensource.org/licenses/mit-license.php
@@ -15,7 +15,8 @@ class Class #:nodoc:
 
     define_method name do |*args|
       methods = original_method.bind(self).call(*args)
-      methods.instance_variable_set('@__awesome_methods__', self)
+      methods.instance_variable_set(:@__awesome_methods__, self)
+      methods.extend(AwesomeMethodArray)
       methods
     end
   end

data/lib/awesome_print/core_ext/kernel.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2013 Michael Dvorkin
+# Copyright (c) 2010-2016 Michael Dvorkin and contributors
 #
 # Awesome Print is freely distributable under the terms of MIT license.
 # See LICENSE file or http://www.opensource.org/licenses/mit-license.php

data/lib/awesome_print/core_ext/logger.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2013 Michael Dvorkin
+# Copyright (c) 2010-2016 Michael Dvorkin and contributors
 #
 # Awesome Print is freely distributable under the terms of MIT license.
 # See LICENSE file or http://www.opensource.org/licenses/mit-license.php

data/lib/awesome_print/core_ext/method.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2013 Michael Dvorkin
+# Copyright (c) 2010-2016 Michael Dvorkin and contributors
 #
 # Awesome Print is freely distributable under the terms of MIT license.
 # See LICENSE file or http://www.opensource.org/licenses/mit-license.php
@@ -18,4 +18,4 @@ unless nil.method(:class).respond_to?(:name)
       inspect.split(/[#.>]/)[-1]
     end
   end
-end
+end

data/lib/awesome_print/core_ext/object.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2013 Michael Dvorkin
+# Copyright (c) 2010-2016 Michael Dvorkin and contributors
 #
 # Awesome Print is freely distributable under the terms of MIT license.
 # See LICENSE file or http://www.opensource.org/licenses/mit-license.php
@@ -15,7 +15,8 @@ class Object #:nodoc:
 
     define_method name do |*args|
       methods = original_method.bind(self).call(*args)
-      methods.instance_variable_set('@__awesome_methods__', self)
+      methods.instance_variable_set(:@__awesome_methods__, self)
+      methods.extend(AwesomeMethodArray)
       methods
     end
   end

data/lib/awesome_print/core_ext/string.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2013 Michael Dvorkin
+# Copyright (c) 2010-2016 Michael Dvorkin and contributors
 #
 # Awesome Print is freely distributable under the terms of MIT license.
 # See LICENSE file or http://www.opensource.org/licenses/mit-license.php
@@ -17,11 +17,11 @@ class String
   %w(gray red green yellow blue purple cyan white).zip(
   %w(black darkred darkgreen brown navy darkmagenta darkcyan slategray)).each_with_index do |(color, shade), i|
     define_method color do |*html|
-      html[0] ? %Q|<kbd style="color:#{color}">#{self}</kbd>| : "\e[1;#{30+i}m#{self}\e[0m"
+      html[0] ? %Q|<kbd style="color:#{color}">#{self}</kbd>| : "\e[1;#{30 + i}m#{self}\e[0m"
     end
 
     define_method "#{color}ish" do |*html|
-      html[0] ? %Q|<kbd style="color:#{shade}">#{self}</kbd>| : "\e[0;#{30+i}m#{self}\e[0m"
+      html[0] ? %Q|<kbd style="color:#{shade}">#{self}</kbd>| : "\e[0;#{30 + i}m#{self}\e[0m"
     end
   end
 

data/lib/awesome_print/custom_defaults.rb

@@ -0,0 +1,57 @@
+module AwesomePrint
+  class << self
+    attr_accessor :defaults, :force_colors
+
+    # Class accessor to force colorized output (ex. forked subprocess where TERM
+    # might be dumb).
+    #---------------------------------------------------------------------------
+    def force_colors!(value = true)
+      @force_colors = value
+    end
+
+    def console?
+      boolean(defined?(IRB) || defined?(Pry))
+    end
+
+    def rails_console?
+      console? && boolean(defined?(Rails::Console) || ENV['RAILS_ENV'])
+    end
+
+    def diet_rb
+      IRB.formatter = Class.new(IRB::Formatter) do
+        def inspect_object(object)
+          object.ai
+        end
+      end.new
+    end
+
+    def usual_rb
+      IRB::Irb.class_eval do
+        def output_value(*args)
+          ap @context.last_value
+        rescue NoMethodError
+          puts "(Object doesn't support #ai)"
+        end
+      end
+    end
+
+    def irb!
+      return unless defined?(IRB)
+
+      IRB.version.include?('DietRB') ? diet_rb : usual_rb
+    end
+
+    def pry!
+      Pry.print = proc { |output, value| output.puts value.ai } if defined?(Pry)
+    end
+
+    private
+
+    # Takes a value and returns true unless it is false or nil
+    # This is an alternative to the less readable !!(value)
+    # https://github.com/bbatsov/ruby-style-guide#no-bang-bang
+    def boolean(value)
+      value ? true : false
+    end
+  end
+end

data/lib/awesome_print/ext/action_view.rb

@@ -1,17 +1,21 @@
-# Copyright (c) 2010-2013 Michael Dvorkin
+# Copyright (c) 2010-2016 Michael Dvorkin and contributors
 #
 # 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 ActionView
-
     # Use HTML colors and add default "debug_dump" class to the resulting HTML.
     def ap_debug(object, options = {})
-      object.ai(options.merge(:html => true)).sub(/^<pre([\s>])/, '<pre class="debug_dump"\\1')
+      object.ai(
+        options.merge(html: true)
+      ).sub(
+        /^<pre([\s>])/,
+        '<pre class="debug_dump"\\1'
+      )
     end
 
-    alias_method :ap, :ap_debug
+    alias ap ap_debug
   end
 end