awesome_print 1.9.2 → 2.0.0.pre

data/lib/awesome_print/formatters/open_struct.rb

@@ -0,0 +1,19 @@
+require_relative 'base_formatter'
+
+module AwesomePrint
+  module Formatters
+    class OpenStruct < BaseFormatter
+
+      formatter_for :openstruct
+
+      def self.formattable?(object)
+        defined?(::OpenStruct) && object.is_a?(::OpenStruct)
+      end
+
+      def format(object)
+        "#{object.class} #{HashFormatter.new(inspector).format(object.marshal_dump)}"
+      end
+
+    end
+  end
+end

data/lib/awesome_print/formatters/range_formatter.rb

@@ -0,0 +1,11 @@
+require_relative 'simple_formatter'
+
+module AwesomePrint
+  module Formatters
+    class RangeFormatter < SimpleFormatter
+
+      formatter_for :range
+
+    end
+  end
+end

data/lib/awesome_print/formatters/rational_formatter.rb

@@ -0,0 +1,15 @@
+require_relative 'simple_formatter'
+
+module AwesomePrint
+  module Formatters
+    class RationalFormatter < SimpleFormatter
+
+      formatter_for :rational
+
+      def self.formattable?(object)
+        object.is_a?(Rational)
+      end
+
+    end
+  end
+end

data/lib/awesome_print/formatters/set_formatter.rb

@@ -0,0 +1,19 @@
+require_relative 'base_formatter'
+
+module AwesomePrint
+  module Formatters
+    class SetFormatter < BaseFormatter
+
+      formatter_for :set
+
+      def self.formattable?(object)
+        object.kind_of?(Set)
+      end
+
+      def format(object)
+        Formatters::ArrayFormatter.new(@inspector).format(object.to_a)
+      end
+
+    end
+  end
+end

data/lib/awesome_print/formatters/simple_formatter.rb

@@ -4,18 +4,20 @@ module AwesomePrint
   module Formatters
     class SimpleFormatter < BaseFormatter
 
-      attr_reader :string, :type, :inspector, :options
+      formatter_for :simple
 
-      def initialize(string, type, inspector)
-        @string = string
-        @type = type
-        @inspector = inspector
-        @options = inspector.options
+      def self.core?
+        true
       end
 
-      def format
-        colorize(string, type)
+      def self.formattable?(object)
+        object.respond_to?(:to_s)
       end
+
+      def format(object)
+        colorize(object.to_s, self.class.formatted_object_type)
+      end
+
     end
   end
 end

data/lib/awesome_print/formatters/string_formatter.rb

@@ -0,0 +1,14 @@
+require_relative 'simple_formatter'
+
+module AwesomePrint
+  module Formatters
+    class StringFormatter < SimpleFormatter
+
+      formatter_for :string
+
+      def format(object)
+        colorize("\"#{object.to_s}\"", self.class.formatted_object_type)
+      end
+    end
+  end
+end

data/lib/awesome_print/formatters/struct_formatter.rb

@@ -4,16 +4,18 @@ module AwesomePrint
   module Formatters
     class StructFormatter < BaseFormatter
 
-      attr_reader :struct, :variables, :inspector, :options
+      formatter_for :struct
 
-      def initialize(struct, inspector)
+      def self.formattable?(object)
+        object.is_a?(Struct)
+      end
+
+      attr_reader :struct, :variables
+
+      def format(struct)
         @struct = struct
         @variables = struct.members
-        @inspector = inspector
-        @options = inspector.options
-      end
 
-      def format
         vars = variables.map do |var|
           property = var.to_s[1..-1].to_sym # to_s because of some monkey patching done by Puppet.
           accessor = if struct.respond_to?(:"#{property}=")

data/lib/awesome_print/formatters/symbol_formatter.rb

@@ -0,0 +1,18 @@
+require_relative 'simple_formatter'
+
+module AwesomePrint
+  module Formatters
+    class SymbolFormatter < SimpleFormatter
+
+      formatter_for :symbol
+
+      def self.formattable?(object)
+        object.respond_to?(:to_s)
+      end
+
+      def format(object)
+        colorize(":#{object.to_s}", self.class.formatted_object_type)
+      end
+    end
+  end
+end

data/lib/awesome_print/formatters/true_class_formatter.rb

@@ -0,0 +1,15 @@
+require_relative 'simple_formatter'
+
+module AwesomePrint
+  module Formatters
+    class TrueClassFormatter < SimpleFormatter
+
+      formatter_for :trueclass
+
+      def self.formattable?(object)
+        object == true
+      end
+
+    end
+  end
+end

data/lib/awesome_print/formatters/unbound_method_formatter.rb

@@ -0,0 +1,15 @@
+require_relative 'method_formatter'
+
+module AwesomePrint
+  module Formatters
+    class UnboundMethodFormatter < MethodFormatter
+
+      formatter_for :unboundmethod
+
+      def self.formattable?(object)
+        object.is_a?(UnboundMethod)
+      end
+
+    end
+  end
+end

data/lib/awesome_print/inspector.rb

@@ -1,8 +1,3 @@
-# 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
-#------------------------------------------------------------------------------
 require_relative 'indentator'
 
 module AwesomePrint
@@ -30,10 +25,13 @@ module AwesomePrint
           array:      :white,
           bigdecimal: :blue,
           class:      :yellow,
+          module:     :green,
           date:       :greenish,
           falseclass: :red,
+          simple:     :blue,
           fixnum:     :blue,
           integer:    :blue,
+          range:      :blue,
           float:      :blue,
           hash:       :pale,
           keyword:    :cyan,
@@ -42,6 +40,7 @@ module AwesomePrint
           rational:   :blue,
           string:     :yellowish,
           struct:     :pale,
+          openstruct: :pale,
           symbol:     :cyanish,
           time:       :greenish,
           trueclass:  :green,
@@ -62,8 +61,8 @@ module AwesomePrint
       indentator.indentation
     end
 
-    def increase_indentation(&block)
-      indentator.indent(&block)
+    def increase_indentation
+      indentator.indent(&Proc.new)
     end
 
     # Dispatcher that detects data nesting and invokes object-aware formatter.
@@ -106,9 +105,10 @@ module AwesomePrint
     #---------------------------------------------------------------------------
     def nested(object)
       case printable(object)
-      when :array  then @formatter.colorize('[...]', :array)
-      when :hash   then @formatter.colorize('{...}', :hash)
-      when :struct then @formatter.colorize('{...}', :struct)
+      when :array   then @formatter.colorize('[...]', :array)
+      when :hash    then @formatter.colorize('{...}', :hash)
+      when :struct  then @formatter.colorize('{...}', :struct)
+      when :openstruct then @formatter.colorize('{...}', :openstruct)
       else @formatter.colorize("...#{object.class}...", :class)
       end
     end
@@ -123,13 +123,14 @@ module AwesomePrint
     # base class.
     #---------------------------------------------------------------------------
     def printable(object)
-      case object
-      when Array  then :array
-      when Hash   then :hash
-      when File   then :file
-      when Dir    then :dir
-      when Struct then :struct
-      else object.class.to_s.gsub(/:+/, '_').downcase.to_sym
+      # FIXME: rails specific hack. this needs to be extracted into a
+      # awesome_print-rails binding lib or something.
+      if defined?(::ActiveRecord) && object.respond_to?(:ancestors) && object.ancestors.to_a.include?(::ActiveRecord::Base)
+        :activerecord_base_class
+      elsif defined?(::Mongoid) && object.respond_to?(:ancestors) && object.ancestors.to_a.include?(::Mongoid::Document)
+        :mongoid_document
+      else
+        object.class.to_s.gsub(/:+/, '_').downcase.to_sym
       end
     end
 

data/lib/awesome_print/limiter.rb

@@ -0,0 +1,63 @@
+module AwesomePrint
+  module Limiter
+
+      DEFAULT_LIMIT_SIZE = 7
+
+      # 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] or (options[:limit].is_a?(Integer) and options[:limit] > 0)
+      end
+
+      def get_limit_size
+        case options[:limit]
+        when true
+          DEFAULT_LIMIT_SIZE
+        else
+          options[:limit]
+        end
+      end
+
+      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]
+
+          temp[head] = if is_hash
+                         "#{indent}#{data[head].strip} .. #{data[data.length - tail - 1].strip}"
+                       else
+                         "#{indent}[#{head.to_s.rjust(width)}] .. [#{data.length - tail - 1}]"
+                       end
+
+          temp
+        end
+      end
+
+
+  end
+end

data/lib/awesome_print/registrar.rb

@@ -0,0 +1,20 @@
+module AwesomePrint
+  module Registrar
+
+    def self.included(base)
+      base.send(:extend, ClassMethods)
+    end
+
+    module ClassMethods
+
+      attr_accessor :formatted_object_type
+
+      def formatter_for(type)
+        self.formatted_object_type = type
+
+        AwesomePrint::Formatter.register(self)
+      end
+    end
+
+  end
+end

data/lib/awesome_print/version.rb

@@ -1,10 +1,10 @@
-# 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
+
+  def self.debug
+    false #true
+  end
+
   def self.version
-    '1.9.2'
+    '2.0.0.pre'
   end
 end

data/spec/formatters/array_spec.rb

@@ -0,0 +1,251 @@
+require_relative '../spec_helper'
+
+RSpec.describe 'AwesomePrint' do
+  describe 'Array' do
+    before do
+      @arr = [1, :two, 'three', [nil, [true, false]]]
+    end
+
+    it 'empty array' do
+      expect([].ai).to eq('[]')
+    end
+
+    it 'plain multiline' do
+      expect(@arr.ai(plain: true)).to eq <<-EOS.strip
+[
+    [0] 1,
+    [1] :two,
+    [2] "three",
+    [3] [
+        [0] nil,
+        [1] [
+            [0] true,
+            [1] false
+        ]
+    ]
+]
+EOS
+      end
+
+    it 'plain multiline without index' do
+      expect(@arr.ai(plain: true, index: false)).to eq <<-EOS.strip
+[
+    1,
+    :two,
+    "three",
+    [
+        nil,
+        [
+            true,
+            false
+        ]
+    ]
+]
+EOS
+      end
+
+    it 'plain multiline indented' do
+      expect(@arr.ai(plain: true, indent: 2)).to eq <<-EOS.strip
+[
+  [0] 1,
+  [1] :two,
+  [2] "three",
+  [3] [
+    [0] nil,
+    [1] [
+      [0] true,
+      [1] false
+    ]
+  ]
+]
+EOS
+    end
+
+    it 'plain multiline indented without index' do
+      expect(@arr.ai(plain: true, indent: 2, index: false)).to eq <<-EOS.strip
+[
+  1,
+  :two,
+  "three",
+  [
+    nil,
+    [
+      true,
+      false
+    ]
+  ]
+]
+EOS
+    end
+
+    it 'plain single line' do
+      expect(@arr.ai(plain: true, multiline: false)).to eq('[ 1, :two, "three", [ nil, [ true, false ] ] ]')
+    end
+
+    it 'colored multiline (default)' do
+      expect(@arr.ai).to eq <<-EOS.strip
+[
+    \e[1;37m[0] \e[0m\e[1;34m1\e[0m,
+    \e[1;37m[1] \e[0m\e[0;36m:two\e[0m,
+    \e[1;37m[2] \e[0m\e[0;33m\"three\"\e[0m,
+    \e[1;37m[3] \e[0m[
+        \e[1;37m[0] \e[0m\e[1;31mnil\e[0m,
+        \e[1;37m[1] \e[0m[
+            \e[1;37m[0] \e[0m\e[1;32mtrue\e[0m,
+            \e[1;37m[1] \e[0m\e[1;31mfalse\e[0m
+        ]
+    ]
+]
+EOS
+      end
+
+    it 'colored multiline indented' do
+      expect(@arr.ai(indent: 8)).to eq <<-EOS.strip
+[
+        \e[1;37m[0] \e[0m\e[1;34m1\e[0m,
+        \e[1;37m[1] \e[0m\e[0;36m:two\e[0m,
+        \e[1;37m[2] \e[0m\e[0;33m\"three\"\e[0m,
+        \e[1;37m[3] \e[0m[
+                \e[1;37m[0] \e[0m\e[1;31mnil\e[0m,
+                \e[1;37m[1] \e[0m[
+                        \e[1;37m[0] \e[0m\e[1;32mtrue\e[0m,
+                        \e[1;37m[1] \e[0m\e[1;31mfalse\e[0m
+                ]
+        ]
+]
+EOS
+    end
+
+    it 'colored single line' do
+      expect(@arr.ai(multiline: false)).to eq("[ \e[1;34m1\e[0m, \e[0;36m:two\e[0m, \e[0;33m\"three\"\e[0m, [ \e[1;31mnil\e[0m, [ \e[1;32mtrue\e[0m, \e[1;31mfalse\e[0m ] ] ]")
+    end
+  end
+
+  #------------------------------------------------------------------------------
+  describe 'Nested Array' do
+    before do
+      @arr = [1, 2]
+      @arr << @arr
+    end
+
+    it 'plain multiline' do
+      expect(@arr.ai(plain: true)).to eq <<-EOS.strip
+[
+    [0] 1,
+    [1] 2,
+    [2] [...]
+]
+EOS
+    end
+
+    it 'plain multiline without index' do
+      expect(@arr.ai(plain: true, index: false)).to eq <<-EOS.strip
+[
+    1,
+    2,
+    [...]
+]
+EOS
+    end
+
+    it 'plain single line' do
+      expect(@arr.ai(plain: true, multiline: false)).to eq('[ 1, 2, [...] ]')
+    end
+  end
+
+  #------------------------------------------------------------------------------
+  describe 'Limited Output Array' do
+    before(:each) do
+      @arr = (1..1000).to_a
+    end
+
+    it 'plain limited output large' do
+      expect(@arr.ai(plain: true, limit: true)).to eq <<-EOS.strip
+[
+    [  0] 1,
+    [  1] 2,
+    [  2] 3,
+    [  3] .. [996],
+    [997] 998,
+    [998] 999,
+    [999] 1000
+]
+EOS
+    end
+
+    it 'plain limited output small' do
+      @arr = @arr[0..3]
+      expect(@arr.ai(plain: true, limit: true)).to eq <<-EOS.strip
+[
+    [0] 1,
+    [1] 2,
+    [2] 3,
+    [3] 4
+]
+EOS
+    end
+
+    it 'plain limited output with 10 lines' do
+      expect(@arr.ai(plain: true, limit: 10)).to eq <<-EOS.strip
+[
+    [  0] 1,
+    [  1] 2,
+    [  2] 3,
+    [  3] 4,
+    [  4] 5,
+    [  5] .. [995],
+    [996] 997,
+    [997] 998,
+    [998] 999,
+    [999] 1000
+]
+EOS
+    end
+
+    it 'plain limited output with 11 lines' do
+      expect(@arr.ai(plain: true, limit: 11)).to eq <<-EOS.strip
+[
+    [  0] 1,
+    [  1] 2,
+    [  2] 3,
+    [  3] 4,
+    [  4] 5,
+    [  5] .. [994],
+    [995] 996,
+    [996] 997,
+    [997] 998,
+    [998] 999,
+    [999] 1000
+]
+EOS
+    end
+  end
+
+  #------------------------------------------------------------------------------
+  describe 'Inherited from standard Ruby classes' do
+    after do
+      Object.instance_eval { remove_const :My } if defined?(My)
+    end
+
+    it 'inherited from Array should be displayed as Array' do
+      class My < Array; end
+
+      my = My.new([1, :two, 'three', [nil, [true, false]]])
+      expect(my.ai(plain: true)).to eq <<-EOS.strip
+[
+    [0] 1,
+    [1] :two,
+    [2] "three",
+    [3] [
+        [0] nil,
+        [1] [
+            [0] true,
+            [1] false
+        ]
+    ]
+]
+EOS
+    end
+
+  end
+end