awesome_print 1.6.1 → 1.9.2

data/lib/awesome_print/formatter.rb

@@ -1,21 +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
 #------------------------------------------------------------------------------
-autoload :CGI, "cgi"
-require "shellwords"
+require 'awesome_print/formatters'
 
 module AwesomePrint
   class Formatter
+    include Colorize
 
-    CORE = [ :array, :bigdecimal, :class, :dir, :file, :hash, :method, :rational, :set, :struct, :unboundmethod ]
-    DEFAULT_LIMIT_SIZE = 7
+    attr_reader :inspector, :options
+
+    CORE_FORMATTERS = [:array, :bigdecimal, :class, :dir, :file, :hash, :method, :rational, :set, :struct, :unboundmethod]
 
     def initialize(inspector)
       @inspector   = inspector
       @options     = inspector.options
-      @indentation = @options[:indent].abs
     end
 
     # Main entry point to format an object.
@@ -34,28 +34,9 @@ module AwesomePrint
     # directory for custom formatters that ship with awesome_print.
     #------------------------------------------------------------------------------
     def cast(object, type)
-      CORE.grep(type)[0] || :self
-    end
-
-    # 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
+      CORE_FORMATTERS.include?(type) ? type : :self
     end
 
-
     private
 
     # Catch all method to format an arbitrary object.
@@ -63,345 +44,91 @@ module AwesomePrint
     def awesome_self(object, type)
       if @options[:raw] && object.instance_variables.any?
         awesome_object(object)
-      elsif object.respond_to?(:to_hash)
-        awesome_hash(object.to_hash)
-      else
-        colorize(object.inspect.to_s, type)
-      end
-    end
-
-    # Format an array.
-    #------------------------------------------------------------------------------
-    def awesome_array(a)
-      return "[]" if a == []
-
-      if a.instance_variable_defined?('@__awesome_methods__')
-        methods_array(a)
-      elsif @options[:multiline]
-        width = (a.size - 1).to_s.size 
-
-        data = a.inject([]) do |arr, item|
-          index = indent
-          index << colorize("[#{arr.size.to_s.rjust(width)}] ", :array) if @options[:index]
-          indented do
-            arr << (index << @inspector.awesome(item))
-          end
-        end
-
-        data = limited(data, width) if should_be_limited?
-        "[\n" << data.join(",\n") << "\n#{outdent}]"
-      else
-        "[ " << a.map{ |item| @inspector.awesome(item) }.join(", ") << " ]"
-      end
-    end
-
-    # Format a hash. If @options[:indent] if negative left align hash keys.
-    #------------------------------------------------------------------------------
-    def awesome_hash(h)
-      return "{}" if h == {}
-
-      keys = @options[:sort_keys] ? h.keys.sort { |a, b| a.to_s <=> b.to_s } : h.keys
-      data = keys.map do |key|
-        plain_single_line do
-          [ @inspector.awesome(key), h[key] ]
-        end
-      end
-      
-      width = data.map { |key, | key.size }.max || 0
-      width += @indentation if @options[:indent] > 0
-  
-      data = data.map do |key, value|
-        indented do
-          align(key, width) << colorize(" => ", :hash) << @inspector.awesome(value)
-        end
-      end
-
-      data = limited(data, width, :hash => true) if should_be_limited?
-      if @options[:multiline]
-        "{\n" << data.join(",\n") << "\n#{outdent}}"
+      elsif (hash = convert_to_hash(object))
+        awesome_hash(hash)
       else
-        "{ #{data.join(', ')} }"
+        awesome_simple(object.inspect.to_s, type, @inspector)
       end
     end
 
-    # Format an object.
-    #------------------------------------------------------------------------------
-    def awesome_object(o)
-      vars = o.instance_variables.map do |var|
-        property = var.to_s[1..-1].to_sym # to_s because of some monkey patching done by Puppet.
-        accessor = if o.respond_to?(:"#{property}=")
-          o.respond_to?(property) ? :accessor : :writer
-        else
-          o.respond_to?(property) ? :reader : nil
-        end
-        if accessor
-          [ "attr_#{accessor} :#{property}", var ]
-        else
-          [ var.to_s, var ]
-        end
-      end
-
-      data = vars.sort.map do |declaration, var|
-        key = left_aligned do
-          align(declaration, declaration.size)
-        end
-
-        unless @options[:plain]
-          if key =~ /(@\w+)/
-            key.sub!($1, colorize($1, :variable))
-          else
-            key.sub!(/(attr_\w+)\s(\:\w+)/, "#{colorize('\\1', :keyword)} #{colorize('\\2', :method)}")
-          end
-        end
-        indented do
-          key << colorize(" = ", :hash) + @inspector.awesome(o.instance_variable_get(var))
-        end
-      end
-      if @options[:multiline]
-        "#<#{awesome_instance(o)}\n#{data.join(%Q/,\n/)}\n#{outdent}>"
-      else
-        "#<#{awesome_instance(o)} #{data.join(', ')}>"
-      end
+    def awesome_bigdecimal(n)
+      o = n.to_s('F')
+      type = :bigdecimal
+      awesome_simple(o, type, @inspector)
     end
 
-    # Format a set.
-    #------------------------------------------------------------------------------
-    def awesome_set(s)
-      awesome_array(s.to_a)
+    def awesome_rational(n)
+      o = n.to_s
+      type = :rational
+      awesome_simple(o, type, @inspector)
     end
 
-    # Format a Struct.
-    #------------------------------------------------------------------------------
-    def awesome_struct(s)
-      #
-      # The code is slightly uglier because of Ruby 1.8.6 quirks:
-      # awesome_hash(Hash[s.members.zip(s.values)]) <-- ArgumentError: odd number of arguments for Hash)
-      # awesome_hash(Hash[*s.members.zip(s.values).flatten]) <-- s.members returns strings, not symbols.
-      #
-      hash = {}
-      s.each_pair { |key, value| hash[key] = value }
-      awesome_hash(hash)
+    def awesome_simple(o, type, inspector = @inspector)
+      AwesomePrint::Formatters::SimpleFormatter.new(o, type, inspector).format
     end
 
-    # Format Class object.
-    #------------------------------------------------------------------------------
-    def awesome_class(c)
-      if superclass = c.superclass # <-- Assign and test if nil.
-        colorize("#{c.inspect} < #{superclass}", :class)
-      else
-        colorize(c.inspect, :class)
-      end
+    def awesome_array(a)
+      Formatters::ArrayFormatter.new(a, @inspector).format
     end
 
-    # Format File object.
-    #------------------------------------------------------------------------------
-    def awesome_file(f)
-      ls = File.directory?(f) ? `ls -adlF #{f.path.shellescape}` : `ls -alF #{f.path.shellescape}`
-      colorize(ls.empty? ? f.inspect : "#{f.inspect}\n#{ls.chop}", :file)
+    def awesome_set(s)
+      Formatters::ArrayFormatter.new(s.to_a, @inspector).format
     end
 
-    # Format Dir object.
-    #------------------------------------------------------------------------------
-    def awesome_dir(d)
-      ls = `ls -alF #{d.path.shellescape}`
-      colorize(ls.empty? ? d.inspect : "#{d.inspect}\n#{ls.chop}", :dir)
+    def awesome_hash(h)
+      Formatters::HashFormatter.new(h, @inspector).format
     end
 
-    # Format BigDecimal object.
-    #------------------------------------------------------------------------------
-    def awesome_bigdecimal(n)
-      colorize(n.to_s("F"), :bigdecimal)
+    def awesome_object(o)
+      Formatters::ObjectFormatter.new(o, @inspector).format
     end
 
-    # Format Rational object.
-    #------------------------------------------------------------------------------
-    def awesome_rational(n)
-      colorize(n.to_s, :rational)
+    def awesome_struct(s)
+      Formatters::StructFormatter.new(s, @inspector).format
     end
 
-    # Format a method.
-    #------------------------------------------------------------------------------
     def awesome_method(m)
-      name, args, owner = method_tuple(m)
-      "#{colorize(owner, :class)}##{colorize(name, :method)}#{colorize(args, :args)}"
+      Formatters::MethodFormatter.new(m, @inspector).format
     end
     alias :awesome_unboundmethod :awesome_method
 
-    # Format object instance.
-    #------------------------------------------------------------------------------
-    def awesome_instance(o)
-      "#{o.class}:0x%08x" % (o.__id__ * 2)
-    end
-
-    # Format object.methods array.
-    #------------------------------------------------------------------------------
-    def methods_array(a)
-      a.sort! { |x, y| x.to_s <=> y.to_s }                  # Can't simply a.sort! because of o.methods << [ :blah ]
-      object = a.instance_variable_get('@__awesome_methods__')
-      tuples = a.map do |name|
-        if name.is_a?(Symbol) || name.is_a?(String)         # Ignore garbage, ex. 42.methods << [ :blah ]
-          tuple = if object.respond_to?(name, true)         # Is this a regular method?
-            the_method = object.method(name) rescue nil     # Avoid potential ArgumentError if object#method is overridden.
-            if the_method && the_method.respond_to?(:arity) # Is this original object#method?
-              method_tuple(the_method)                      # Yes, we are good.
-            end
-          elsif object.respond_to?(:instance_method)              # Is this an unbound method?
-            method_tuple(object.instance_method(name)) rescue nil # Rescue to avoid NameError when the method is not
-          end                                                     # available (ex. File.lchmod on Ubuntu 12).
-        end
-        tuple || [ name.to_s, '(?)', '?' ]                  # Return WTF default if all the above fails.
-      end
-
-      width = (tuples.size - 1).to_s.size
-      name_width = tuples.map { |item| item[0].size }.max || 0
-      args_width = tuples.map { |item| item[1].size }.max || 0
-
-      data = tuples.inject([]) do |arr, item|
-        index = indent
-        index << "[#{arr.size.to_s.rjust(width)}]" if @options[:index]
-        indented do
-          arr << "#{index} #{colorize(item[0].rjust(name_width), :method)}#{colorize(item[1].ljust(args_width), :args)} #{colorize(item[2], :class)}"
-        end
-      end
-
-      "[\n" << data.join("\n") << "\n#{outdent}]"
+    def awesome_class(c)
+      Formatters::ClassFormatter.new(c, @inspector).format
     end
 
-    # Return [ name, arguments, owner ] tuple for a given method.
-    #------------------------------------------------------------------------------
-    def method_tuple(method)
-      if method.respond_to?(:parameters) # Ruby 1.9.2+
-        # See http://ruby.runpaint.org/methods#method-objects-parameters
-        args = method.parameters.inject([]) do |arr, (type, name)|
-          name ||= (type == :block ? 'block' : "arg#{arr.size + 1}")
-          arr << case type
-            when :req        then name.to_s
-            when :opt, :rest then "*#{name}"
-            when :block      then "&#{name}"
-            else '?'
-          end
-        end
-      else # See http://ruby-doc.org/core/classes/Method.html#M001902
-        args = (1..method.arity.abs).map { |i| "arg#{i}" }
-        args[-1] = "*#{args[-1]}" if method.arity < 0
-      end
-
-      # method.to_s formats to handle:
-      #
-      # #<Method: Fixnum#zero?>
-      # #<Method: Fixnum(Integer)#years>
-      # #<Method: User(#<Module:0x00000103207c00>)#_username>
-      # #<Method: User(id: integer, username: string).table_name>
-      # #<Method: User(id: integer, username: string)(ActiveRecord::Base).current>
-      # #<UnboundMethod: Hello#world>
-      #
-      if method.to_s =~ /(Unbound)*Method: (.*)[#\.]/
-        unbound, klass = $1 && '(unbound)', $2
-        if klass && klass =~ /(\(\w+:\s.*?\))/  # Is this ActiveRecord-style class?
-          klass.sub!($1, '')                    # Yes, strip the fields leaving class name only.
-        end
-        owner = "#{klass}#{unbound}".gsub('(', ' (')
-      end
-
-      [ method.name.to_s, "(#{args.join(', ')})", owner.to_s ]
+    def awesome_file(f)
+      Formatters::FileFormatter.new(f, @inspector).format
     end
 
-    # Format hash keys as plain strings 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
+    def awesome_dir(d)
+      Formatters::DirFormatter.new(d, @inspector).format
     end
 
     # Utility methods.
     #------------------------------------------------------------------------------
-    def align(value, width)
-      if @options[:multiline]
-        if @options[:indent] > 0
-          value.rjust(width)
-        elsif @options[:indent] == 0
-          indent + value.ljust(width)
-        else
-          indent[0, @indentation + @options[:indent]] + value.ljust(width)
-        end
-      else
-        value
-      end
-    end
 
-    def indented
-      @indentation += @options[:indent].abs
-      yield
-    ensure
-      @indentation -= @options[:indent].abs
+    # A class (ex. `Net::HTTP.Get`) might have `attr_reader :method` accessor
+    # which causes `object.method(:to_hash)` throw `ArgumentError (wrong number
+    # of arguments (given 1, expected 0))`. The following tries to avoid that.
+    def has_method_accessor?(object)
+      !object.method(:method)
+    rescue ArgumentError
+      true
     end
 
-    def left_aligned
-      current, @options[:indent] = @options[:indent], 0
-      yield
-    ensure
-      @options[:indent] = current
-    end
+    def convert_to_hash(object)
+      return nil if has_method_accessor?(object)
+      return nil if !object.respond_to?(:to_hash) || object.method(:to_hash).arity != 0
 
-    def indent
-      ' ' * @indentation
-    end
+      # ActionController::Parameters will raise if they are not yet permitted
+      # and we try to convert to hash.
+      # https://api.rubyonrails.org/classes/ActionController/Parameters.html
+      return nil if object.respond_to?(:permitted?) && !object.permitted?
 
-    def outdent
-      ' ' * (@indentation - @options[:indent].abs)
-    end
-
-    # To support limited output, for example:
-    #
-    # ap ('a'..'z').to_a, :limit => 3
-    # [
-    #     [ 0] "a",
-    #     [ 1] .. [24],
-    #     [25] "z"
-    # ]
-    #
-    # ap (1..100).to_a, :limit => true # Default limit is 7.
-    # [
-    #     [ 0] 1,
-    #     [ 1] 2,
-    #     [ 2] 3,
-    #     [ 3] .. [96],
-    #     [97] 98,
-    #     [98] 99,
-    #     [99] 100
-    # ]
-    #------------------------------------------------------------------------------
-    def should_be_limited?
-      @options[:limit] == true or (@options[:limit].is_a?(Fixnum) and @options[:limit] > 0)
-    end
-
-    def get_limit_size
-      @options[:limit] == true ? DEFAULT_LIMIT_SIZE : @options[:limit]
-    end
+      hash = object.to_hash
+      return nil if !hash.respond_to?(:keys) || !hash.respond_to?(:[])
 
-    def limited(data, width, is_hash = false)
-      limit = get_limit_size
-      if data.length <= limit
-        data
-      else
-        # Calculate how many elements to be displayed above and below the separator.
-        head = limit / 2
-        tail = head - (limit - 1) % 2
-
-        # Add the proper elements to the temp array and format the separator.
-        temp = data[0, head] + [ nil ] + data[-tail, tail]
-
-        if is_hash
-          temp[head] = "#{indent}#{data[head].strip} .. #{data[data.length - tail - 1].strip}"
-        else
-          temp[head] = "#{indent}[#{head.to_s.rjust(width)}] .. [#{data.length - tail - 1}]"
-        end
-
-        temp
-      end
+      hash
     end
   end
 end

data/lib/awesome_print/formatters/array_formatter.rb

@@ -0,0 +1,139 @@
+require_relative 'base_formatter'
+
+module AwesomePrint
+  module Formatters
+    class ArrayFormatter < BaseFormatter
+      attr_reader :array, :inspector, :options
+
+      def initialize(array, inspector)
+        @array = array
+        @inspector = inspector
+        @options = inspector.options
+      end
+
+      def format
+        if array.length.zero?
+          '[]'
+        elsif methods_array?
+          methods_array
+        else
+          simple_array
+        end
+      end
+
+      private
+
+      def methods_array?
+        array.instance_variable_defined?('@__awesome_methods__')
+      end
+
+      def simple_array
+        if options[:multiline]
+          multiline_array
+        else
+          "[ #{array.map { |item| inspector.awesome(item) }.join(', ')} ]"
+        end
+      end
+
+      def multiline_array
+        data = unless should_be_limited?
+                 generate_printable_array
+               else
+                 limited(generate_printable_array, width(array))
+               end
+
+        %Q([\n#{data.join(",\n")}\n#{outdent}])
+      end
+
+      def generate_printable_array
+        array.map.with_index do |item, index|
+          array_prefix(index, width(array)).tap do |temp|
+            indented { temp << inspector.awesome(item) }
+          end
+        end
+      end
+
+      def array_prefix(iteration, width)
+        generic_prefix(iteration, width)
+      end
+
+      def methods_array
+        array.map!(&:to_s).sort!
+
+        data = generate_printable_tuples.join("\n")
+
+        "[\n#{data}\n#{outdent}]"
+      end
+
+      def generate_printable_tuples
+        tuples.map.with_index do |item, index|
+          tuple_prefix(index, width(tuples)).tap do |temp|
+            indented { temp << tuple_template(item) }
+          end
+        end
+      end
+
+      def tuple_template(item)
+        name_width, args_width = name_and_args_width
+
+        [
+          colorize(item[0].rjust(name_width), :method),
+          colorize(item[1].ljust(args_width), :args),
+          ' ',
+          colorize(item[2], :class)
+        ].join
+      end
+
+      def tuples
+        @tuples ||= array.map { |name| generate_tuple(name) }
+      end
+
+      def name_and_args_width
+        name_and_args = tuples.transpose
+
+        return name_and_args[0].map(&:size).max, name_and_args[1].map(&:size).max
+      end
+
+      def tuple_prefix(iteration, width)
+        generic_prefix(iteration, width, ' ')
+      end
+
+      def generate_tuple(name)
+        meth = case name
+               when Symbol, String
+                 find_method(name)
+               end
+
+        meth ? method_tuple(meth) : [name.to_s, '(?)', '?']
+      end
+
+      def find_method(name)
+        object = array.instance_variable_get('@__awesome_methods__')
+
+        meth = begin
+          object.method(name)
+        rescue NameError, ArgumentError
+          nil
+        end
+
+        meth || begin
+          object.instance_method(name)
+        rescue NameError
+          nil
+        end
+      end
+
+      def generic_prefix(iteration, width, padding='')
+        if options[:index]
+          indent + colorize("[#{iteration.to_s.rjust(width)}] ", :array)
+        else
+          indent + padding
+        end
+      end
+
+      def width(items)
+        (items.size - 1).to_s.size
+      end
+    end
+  end
+end