# Copyright (c) 2010 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 #------------------------------------------------------------------------------ class AwesomePrint AP = :__awesome_print__ CORE = [ :array, :hash, :class, :file, :dir ] def initialize(options = {}) @options = { :multiline => true, :plain => false, :indent => 4, :color => { :array => :white, :bignum => :blue, :class => :yellow, :date => :greenish, :falseclass => :red, :fixnum => :blue, :float => :blue, :hash => :gray, :nilclass => :red, :string => :yellowish, :symbol => :cyanish, :time => :greenish, :trueclass => :green }.merge(options.delete(:color) || {}) }.merge(options) load_custom_defaults @indentation = @options[:indent].abs Thread.current[AP] ||= [] end private # Format an array. #------------------------------------------------------------------------------ def awesome_array(a) return "[]" if a == [] if @options[:multiline] width = (a.size - 1).to_s.size data = a.inject([]) do |arr, item| index = colorize("#{indent}[#{arr.size.to_s.rjust(width)}] ", :array) indented do arr << (index << awesome(item)) end end "[\n" << data.join(",\n") << "\n#{outdent}]" else data = a.inject([]) { |arr, item| arr << awesome(item) } "[ #{data.join(', ')} ]" end end # Format a hash. If @options[:indent] if negative left align hash keys. #------------------------------------------------------------------------------ def awesome_hash(h) return "{}" if h == {} data = h.keys.inject([]) do |arr, key| plain_single_line do arr << [ awesome(key), h[key] ] end end width = data.map { |key, | key.size }.max || 0 width += @indentation if @options[:indent] > 0 data = data.inject([]) do |arr, (key, value)| if @options[:multiline] formatted_key = (@options[:indent] >= 0 ? key.rjust(width) : indent + key.ljust(width)) else formatted_key = key end indented do arr << (formatted_key << colorize(" => ", :hash) << awesome(value)) end end if @options[:multiline] "{\n" << data.join(",\n") << "\n#{outdent}}" else "{ #{data.join(', ')} }" end end # Format Class object. #------------------------------------------------------------------------------ def awesome_class(c) if superclass = c.superclass # <-- Assign and test if nil. awesome_self(c, :with => " < #{superclass}") else awesome_self(c) end end # Format File object. #------------------------------------------------------------------------------ def awesome_file(f) ls = File.directory?(f) ? `ls -adlF #{f.path}` : `ls -alF #{f.path}` awesome_self(f, :with => ls.empty? ? nil : "\n#{ls.chop}") end # Format Dir object. #------------------------------------------------------------------------------ def awesome_dir(d) ls = `ls -alF #{d.path}` awesome_self(d, :with => ls.empty? ? nil : "\n#{ls.chop}") end # Catch all method to format an arbitrary object. #------------------------------------------------------------------------------ def awesome_self(object, appear = {}) colorize(object.inspect << appear[:with].to_s, appear[:as] || declassify(object)) end # Dispatcher that detects data nesting and invokes object-aware formatter. #------------------------------------------------------------------------------ def awesome(object) if Thread.current[AP].include?(object.object_id) nested(object) else begin Thread.current[AP] << object.object_id send(:"awesome_#{printable(object)}", object) ensure Thread.current[AP].pop end end end # Format nested data, for example: # arr = [1, 2]; arr << arr # => [1,2, [...]] # hsh = { :a => 1 }; hsh[:b] = hsh # => { :a => 1, :b => {...} } #------------------------------------------------------------------------------ def nested(object) case printable(object) when :array then colorize("[...]", :array) when :hash then colorize("{...}", :hash) else colorize("...#{object.class}...", :class) end end # Return one of the "core" types that have a formatter of :self otherwise. #------------------------------------------------------------------------------ def printable(object) CORE.grep(declassify(object))[0] || :self end # Turn class name into symbol, ex: Hello::World => :hello_world. #------------------------------------------------------------------------------ def declassify(object) object.class.to_s.gsub(/:+/, "_").downcase.to_sym end # Pick the color and apply it to the given string as necessary. #------------------------------------------------------------------------------ def colorize(s, type) if @options[:plain] || @options[:color][type].nil? s else s.send(@options[:color][type]) end end # Format hash keys as plain string regardless of underlying data type. #------------------------------------------------------------------------------ def plain_single_line plain, multiline = @options[:plain], @options[:multiline] @options[:plain], @options[:multiline] = true, false yield ensure @options[:plain], @options[:multiline] = plain, multiline end #------------------------------------------------------------------------------ def indented @indentation += @options[:indent].abs yield ensure @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 # } # } #------------------------------------------------------------------------------ def load_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) end rescue => e $stderr.puts "Could not load #{dotfile}: #{e}" end # Class accessors for custom defaults. #------------------------------------------------------------------------------ def self.defaults @@defaults ||= {} end def self.defaults=(*args) @@defaults = *args end end