amazing_print 1.2.0 → 1.4.0

data/lib/amazing_print/ext/nobrainer.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rubocop:disable Style/HashTransformValues
+
 # Copyright (c) 2010-2016 Michael Dvorkin and contributors
 #
 # AmazingPrint is freely distributable under the terms of MIT license.
@@ -30,9 +32,9 @@ module AmazingPrint
     #------------------------------------------------------------------------------
     def awesome_nobrainer_class(object)
       name = "#{awesome_simple(object, :class)} < #{awesome_simple(object.superclass, :class)}"
-      data = Hash[object.fields.map do |field, options|
+      data = object.fields.map do |field, options|
         [field, (options[:type] || Object).to_s.underscore.to_sym]
-      end]
+      end.to_h
 
       name = "class #{awesome_simple(object.to_s, :class)}"
       base = "< #{awesome_simple(object.superclass.to_s, :class)}"
@@ -44,12 +46,12 @@ module AmazingPrint
     #------------------------------------------------------------------------------
     def awesome_nobrainer_document(object)
       data = object.inspectable_attributes.symbolize_keys
-      if object.errors.present?
-        data = { errors: object.errors, attributes: data }
-      end
+      data = { errors: object.errors, attributes: data } if object.errors.present?
       "#{object} #{awesome_hash(data)}"
     end
   end
 end
 
 AmazingPrint::Formatter.include AmazingPrint::NoBrainer
+
+# rubocop:enable Style/HashTransformValues

data/lib/amazing_print/ext/nokogiri.rb

@@ -34,9 +34,7 @@ module AmazingPrint
       xml.gsub!(%r{(<)(/?[A-Za-z1-9]+)}) { |_tag| "#{Regexp.last_match(1)}#{colorize(Regexp.last_match(2), :keyword)}" }
       xml.gsub!(/(id|class)="[^"]+"/i) { |id| colorize(id, :class) }
       xml.gsub!(/>([^<]+)</) do |contents|
-        if contents && !contents.empty?
-          contents = colorize(Regexp.last_match(1), :trueclass)
-        end
+        contents = colorize(Regexp.last_match(1), :trueclass) if contents && !contents.empty?
         ">#{contents}<"
       end
       xml

data/lib/amazing_print/ext/ostruct.rb

@@ -14,9 +14,7 @@ module AmazingPrint
 
     def cast_with_ostruct(object, type)
       cast = cast_without_ostruct(object, type)
-      if defined?(::OpenStruct) && object.is_a?(::OpenStruct)
-        cast = :open_struct_instance
-      end
+      cast = :open_struct_instance if defined?(::OpenStruct) && object.is_a?(::OpenStruct)
       cast
     end
 

data/lib/amazing_print/ext/ripple.rb

@@ -18,9 +18,10 @@ module AmazingPrint
       cast = cast_without_ripple(object, type)
       return cast unless defined?(::Ripple)
 
-      if object.is_a?(::Ripple::AttributeMethods) # Module used to access attributes across documents and embedded documents
+      case object
+      when ::Ripple::AttributeMethods # Module used to access attributes across documents and embedded documents
         cast = :ripple_document_instance
-      elsif object.is_a?(::Ripple::Properties)    # Used to access property metadata on Ripple classes
+      when ::Ripple::Properties # Used to access property metadata on Ripple classes
         cast = :ripple_document_class
       end
       cast
@@ -58,9 +59,7 @@ module AmazingPrint
     # Format Ripple class object.
     #------------------------------------------------------------------------------
     def awesome_ripple_document_class(object)
-      if !defined?(::ActiveSupport::OrderedHash) || !object.respond_to?(:properties)
-        return object.inspect
-      end
+      return object.inspect if !defined?(::ActiveSupport::OrderedHash) || !object.respond_to?(:properties)
 
       name = "class #{awesome_simple(object.to_s, :class)}"
       base = "< #{awesome_simple(object.superclass.to_s, :class)}"

data/lib/amazing_print/formatter.rb

@@ -24,12 +24,11 @@ module AmazingPrint
     #------------------------------------------------------------------------------
     def format(object, type = nil)
       core_class = cast(object, type)
-      awesome = if core_class != :self
-                  send(:"awesome_#{core_class}", object) # Core formatters.
-                else
-                  awesome_self(object, type) # Catch all that falls back to object.inspect.
-                end
-      awesome
+      if core_class == :self
+        awesome_self(object, type) # Catch all that falls back to object.inspect.
+      else
+        send(:"awesome_#{core_class}", object) # Core formatters.
+      end
     end
 
     # Hook this when adding custom formatters. Check out lib/amazing_print/ext

data/lib/amazing_print/formatters/array_formatter.rb

@@ -8,6 +8,7 @@ module AmazingPrint
       attr_reader :array, :inspector, :options
 
       def initialize(array, inspector)
+        super()
         @array = array
         @inspector = inspector
         @options = inspector.options
@@ -33,7 +34,7 @@ module AmazingPrint
         if options[:multiline]
           multiline_array
         else
-          '[ ' + array.map { |item| inspector.awesome(item) }.join(', ') + ' ]'
+          "[ #{array.map { |item| inspector.awesome(item) }.join(', ')} ]"
         end
       end
 
@@ -114,14 +115,14 @@ module AmazingPrint
 
         meth = begin
           object.method(name)
-               rescue NameError, ArgumentError
-                 nil
+        rescue NameError, ArgumentError
+          nil
         end
 
         meth || begin
           object.instance_method(name)
-                rescue NameError
-                  nil
+        rescue NameError
+          nil
         end
       end
 

data/lib/amazing_print/formatters/base_formatter.rb

@@ -30,7 +30,7 @@ module AmazingPrint
       # ]
       #------------------------------------------------------------------------------
       def should_be_limited?
-        options[:limit] || (options[:limit].is_a?(Integer) && (options[:limit] > 0))
+        options[:limit] || (options[:limit].is_a?(Integer) && options[:limit].positive?)
       end
 
       def get_limit_size
@@ -42,14 +42,14 @@ module AmazingPrint
         end
       end
 
-      def limited(data, width, is_hash = false)
+      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
+          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]
@@ -65,23 +65,18 @@ module AmazingPrint
       end
 
       def method_tuple(method)
-        if method.respond_to?(:parameters) # Ruby 1.9.2+
-          # See http://readruby.chengguangnan.com/methods#method-objects-parameters
-          # (mirror: http://archive.is/XguCA#selection-3381.1-3381.11)
-          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 :keyreq     then "#{name}:"
-                   when :key        then "*#{name}:"
-                   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
+        # See http://readruby.chengguangnan.com/methods#method-objects-parameters
+        # (mirror: http://archive.is/XguCA#selection-3381.1-3381.11)
+        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 :keyreq     then "#{name}:"
+                 when :key        then "*#{name}:"
+                 when :opt, :rest then "*#{name}"
+                 when :block      then "&#{name}"
+                 else '?'
+                 end
         end
 
         # method.to_s formats to handle:
@@ -95,7 +90,7 @@ module AmazingPrint
         # #<UnboundMethod: Hello#world>
         # #<UnboundMethod: Hello#world() /home/hs/code/amazing_print/spec/methods_spec.rb:68>
         #
-        if method.to_s =~ %r{(Unbound)*Method: ((#<)?[^/#]*)[#\.]}
+        if method.to_s =~ %r{(Unbound)*Method: ((#<)?[^/#]*)[#.]}
           unbound = Regexp.last_match(1) && '(unbound)'
           klass = Regexp.last_match(2)
           if klass && klass =~ /(\(\w+:\s.*?\))/ # Is this ActiveRecord-style class?
@@ -123,21 +118,21 @@ module AmazingPrint
       INDENT_CACHE = (0..100).map { |i| ' ' * i }.map(&:freeze).freeze
 
       def indent(n = indentation)
-        INDENT_CACHE[n] || ' ' * n
+        INDENT_CACHE[n] || (' ' * n)
       end
 
       def outdent
         i = indentation - options[:indent].abs
 
-        INDENT_CACHE[i] || ' ' * i
+        INDENT_CACHE[i] || (' ' * i)
       end
 
       def align(value, width)
         if options[:multiline]
           indent_option = options[:indent]
-          if indent_option > 0
+          if indent_option.positive?
             value.rjust(width)
-          elsif indent_option == 0
+          elsif indent_option.zero?
             "#{indent}#{value.ljust(width)}"
           else
             "#{indent(indentation + indent_option)}#{value.ljust(width)}"

data/lib/amazing_print/formatters/class_formatter.rb

@@ -8,6 +8,7 @@ module AmazingPrint
       attr_reader :klass, :inspector, :options
 
       def initialize(klass, inspector)
+        super()
         @klass = klass
         @inspector = inspector
         @options = inspector.options

data/lib/amazing_print/formatters/dir_formatter.rb

@@ -10,6 +10,7 @@ module AmazingPrint
       attr_reader :dir, :inspector, :options
 
       def initialize(dir, inspector)
+        super()
         @dir = dir
         @inspector = inspector
         @options = inspector.options

data/lib/amazing_print/formatters/file_formatter.rb

@@ -10,6 +10,7 @@ module AmazingPrint
       attr_reader :file, :inspector, :options
 
       def initialize(file, inspector)
+        super()
         @file = file
         @inspector = inspector
         @options = inspector.options

data/lib/amazing_print/formatters/hash_formatter.rb

@@ -8,6 +8,7 @@ module AmazingPrint
       attr_reader :hash, :inspector, :options
 
       def initialize(hash, inspector)
+        super()
         @hash = hash
         @inspector = inspector
         @options = inspector.options
@@ -55,12 +56,12 @@ module AmazingPrint
           end
         end
 
-        should_be_limited? ? limited(data, width, hash: true) : data
+        should_be_limited? ? limited(data, width, is_hash: true) : data
       end
 
       def left_width(keys)
         result = max_key_width(keys)
-        result += indentation if options[:indent] > 0
+        result += indentation if options[:indent].positive?
         result
       end
 
@@ -86,11 +87,11 @@ module AmazingPrint
 
       def ruby19_syntax(key, value, width)
         key[0] = ''
-        align(key, width - 1) << colorize(': ', :hash) << inspector.awesome(value)
+        "#{align(key, width - 1)}#{colorize(': ', :hash)}#{inspector.awesome(value)}"
       end
 
       def pre_ruby19_syntax(key, value, width)
-        align(key, width) + colorize(' => ', :hash) + inspector.awesome(value)
+        "#{align(key, width)}#{colorize(' => ', :hash)}#{inspector.awesome(value)}"
       end
 
       def plain_single_line

data/lib/amazing_print/formatters/method_formatter.rb

@@ -8,6 +8,7 @@ module AmazingPrint
       attr_reader :method, :inspector, :options
 
       def initialize(method, inspector)
+        super()
         @method = method
         @inspector = inspector
         @options = inspector.options

data/lib/amazing_print/formatters/object_formatter.rb

@@ -8,6 +8,7 @@ module AmazingPrint
       attr_reader :object, :variables, :inspector, :options
 
       def initialize(object, inspector)
+        super()
         @object = object
         @variables = object.instance_variables
         @inspector = inspector
@@ -38,7 +39,7 @@ module AmazingPrint
             key = if key =~ /(@\w+)/
                     key.sub(Regexp.last_match(1), colorize(Regexp.last_match(1), :variable))
                   else
-                    key.sub(/(attr_\w+)\s(\:\w+)/, "#{colorize('\\1', :keyword)} #{colorize('\\2', :method)}")
+                    key.sub(/(attr_\w+)\s(:\w+)/, "#{colorize('\\1', :keyword)} #{colorize('\\2', :method)}")
                   end
           end
 

data/lib/amazing_print/formatters/simple_formatter.rb

@@ -8,6 +8,7 @@ module AmazingPrint
       attr_reader :string, :type, :inspector, :options
 
       def initialize(string, type, inspector)
+        super()
         @string = string
         @type = type
         @inspector = inspector

data/lib/amazing_print/formatters/struct_formatter.rb

@@ -8,6 +8,7 @@ module AmazingPrint
       attr_reader :struct, :variables, :inspector, :options
 
       def initialize(struct, inspector)
+        super()
         @struct = struct
         @variables = struct.members
         @inspector = inspector
@@ -38,7 +39,7 @@ module AmazingPrint
             key = if key =~ /(@\w+)/
                     key.sub(Regexp.last_match(1), colorize(Regexp.last_match(1), :variable))
                   else
-                    key.sub(/(attr_\w+)\s(\:\w+)/, "#{colorize('\\1', :keyword)} #{colorize('\\2', :method)}")
+                    key.sub(/(attr_\w+)\s(:\w+)/, "#{colorize('\\1', :keyword)} #{colorize('\\2', :method)}")
                   end
           end
 

data/lib/amazing_print/inspector.rb

@@ -5,6 +5,9 @@
 # AmazingPrint is freely distributable under the terms of MIT license.
 # See LICENSE file or http://www.opensource.org/licenses/mit-license.php
 #------------------------------------------------------------------------------
+
+# rubocop:disable Metrics/ClassLength
+
 require_relative 'indentator'
 
 module AmazingPrint
@@ -13,6 +16,15 @@ module AmazingPrint
 
     AP = :__amazing_print__
 
+    ##
+    # Unload the cached dotfile and load it again.
+    #
+    def self.reload_dotfile
+      @@dotfile = nil
+      new.send :load_dotfile
+      true
+    end
+
     def initialize(options = {})
       @options = {
         indent: 4, # Number of spaces for indenting.
@@ -91,7 +103,7 @@ module AmazingPrint
         if defined? @colorize_stdout
           @colorize_stdout
         else
-          @colorize_stdout = STDOUT.tty? && (
+          @colorize_stdout = $stdout.tty? && (
             (
               ENV['TERM'] &&
               ENV['TERM'] != 'dumb'
@@ -147,18 +159,28 @@ module AmazingPrint
       @options.merge!(options)
     end
 
+    def find_dotfile
+      xdg_config_home = File.expand_path(ENV.fetch('XDG_CONFIG_HOME', '~/.config'))
+      xdg_config_path = File.join(xdg_config_home, 'aprc') # ${XDG_CONFIG_HOME}/aprc
+
+      return xdg_config_path if File.exist?(xdg_config_path)
+
+      # default to ~/.aprc
+      File.join(ENV['HOME'], '.aprc')
+    end
+
     # This method needs to be mocked during testing so that it always loads
     # predictable values
     #---------------------------------------------------------------------------
     def load_dotfile
-      dotfile = File.join(ENV['HOME'], '.aprc')
+      return if @@dotfile # Load the dotfile only once.
+
+      dotfile = find_dotfile
       load dotfile if dotfile_readable?(dotfile)
     end
 
     def dotfile_readable?(dotfile)
-      if @@dotfile_readable.nil? || @@dotfile != dotfile
-        @@dotfile_readable = File.readable?(@@dotfile = dotfile)
-      end
+      @@dotfile_readable = File.readable?(@@dotfile = dotfile) if @@dotfile_readable.nil? || @@dotfile != dotfile
       @@dotfile_readable
     end
     @@dotfile_readable = @@dotfile = nil
@@ -173,3 +195,5 @@ module AmazingPrint
     end
   end
 end
+
+# rubocop:enable Metrics/ClassLength

data/lib/amazing_print/version.rb

@@ -7,6 +7,6 @@
 #------------------------------------------------------------------------------
 module AmazingPrint
   def self.version
-    '1.2.0'
+    '1.4.0'
   end
 end

data/lib/amazing_print.rb

@@ -23,12 +23,8 @@ unless defined?(AmazingPrint::Inspector)
   # Load the following under normal circumstances as well as in Rails
   # console when required from ~/.irbrc or ~/.pryrc.
   #
-  if defined?(ActiveRecord) || AmazingPrint.rails_console?
-    require_relative 'amazing_print/ext/active_record'
-  end
-  if defined?(ActiveSupport) || AmazingPrint.rails_console?
-    require_relative 'amazing_print/ext/active_support'
-  end
+  require_relative 'amazing_print/ext/active_record' if defined?(ActiveRecord) || AmazingPrint.rails_console?
+  require_relative 'amazing_print/ext/active_support' if defined?(ActiveSupport) || AmazingPrint.rails_console?
   #
   # Load remaining extensions.
   #

data/spec/active_record_helper.rb

@@ -27,6 +27,17 @@ if ExtVerifier.has_rails?
 
   # Create models
   class User < ActiveRecord::Base; has_many :emails; end
+
   class SubUser < User; end
+
   class Email < ActiveRecord::Base; belongs_to :user; end
+
+  class TableFreeModel
+    include ::ActiveModel::Validations
+    attr_reader(:name)
+
+    def attributes
+      { 'name' => name }
+    end
+  end
 end

data/spec/colors_spec.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+# rubocop:disable Lint/ConstantDefinitionInBlock, Style/OptionalBooleanParameter
+
 require 'spec_helper'
 
 RSpec.describe 'AmazingPrint' do
-  def stub_tty!(output = true, stream = STDOUT)
+  def stub_tty!(output = true, stream = $stdout)
     if output
       stream.instance_eval do
         def tty?
@@ -31,7 +33,7 @@ RSpec.describe 'AmazingPrint' do
 
     describe 'default settings (no forced colors)' do
       before do
-        AmazingPrint.force_colors! false
+        AmazingPrint.force_colors! colors: false
       end
 
       it 'colorizes tty processes by default' do
@@ -40,34 +42,28 @@ RSpec.describe 'AmazingPrint' do
       end
 
       it "colorizes processes with ENV['ANSICON'] by default" do
-        begin
-          stub_tty!
-          term = ENV['ANSICON']
-          ENV['ANSICON'] = '1'
-          expect(@arr.ai(multiline: false)).to eq(COLORIZED)
-        ensure
-          ENV['ANSICON'] = term
-        end
+        stub_tty!
+        term = ENV['ANSICON']
+        ENV['ANSICON'] = '1'
+        expect(@arr.ai(multiline: false)).to eq(COLORIZED)
+      ensure
+        ENV['ANSICON'] = term
       end
 
       it 'does not colorize tty processes running in dumb terminals by default' do
-        begin
-          stub_tty!
-          term = ENV['TERM']
-          ENV['TERM'] = 'dumb'
-          expect(@arr.ai(multiline: false)).to eq(PLAIN)
-        ensure
-          ENV['TERM'] = term
-        end
+        stub_tty!
+        term = ENV['TERM']
+        ENV['TERM'] = 'dumb'
+        expect(@arr.ai(multiline: false)).to eq(PLAIN)
+      ensure
+        ENV['TERM'] = term
       end
 
       it 'does not colorize subprocesses by default' do
-        begin
-          stub_tty! false
-          expect(@arr.ai(multiline: false)).to eq(PLAIN)
-        ensure
-          stub_tty!
-        end
+        stub_tty! false
+        expect(@arr.ai(multiline: false)).to eq(PLAIN)
+      ensure
+        stub_tty!
       end
     end
 
@@ -82,34 +78,28 @@ RSpec.describe 'AmazingPrint' do
       end
 
       it "colorizes processes with ENV['ANSICON'] set to 0" do
-        begin
-          stub_tty!
-          term = ENV['ANSICON']
-          ENV['ANSICON'] = '1'
-          expect(@arr.ai(multiline: false)).to eq(COLORIZED)
-        ensure
-          ENV['ANSICON'] = term
-        end
+        stub_tty!
+        term = ENV['ANSICON']
+        ENV['ANSICON'] = '1'
+        expect(@arr.ai(multiline: false)).to eq(COLORIZED)
+      ensure
+        ENV['ANSICON'] = term
       end
 
       it 'colorizes dumb terminals' do
-        begin
-          stub_tty!
-          term = ENV['TERM']
-          ENV['TERM'] = 'dumb'
-          expect(@arr.ai(multiline: false)).to eq(COLORIZED)
-        ensure
-          ENV['TERM'] = term
-        end
+        stub_tty!
+        term = ENV['TERM']
+        ENV['TERM'] = 'dumb'
+        expect(@arr.ai(multiline: false)).to eq(COLORIZED)
+      ensure
+        ENV['TERM'] = term
       end
 
       it 'colorizes subprocess' do
-        begin
-          stub_tty! false
-          expect(@arr.ai(multiline: false)).to eq(COLORIZED)
-        ensure
-          stub_tty!
-        end
+        stub_tty! false
+        expect(@arr.ai(multiline: false)).to eq(COLORIZED)
+      ensure
+        stub_tty!
       end
     end
 
@@ -121,3 +111,5 @@ RSpec.describe 'AmazingPrint' do
     end
   end
 end
+
+# rubocop:enable Lint/ConstantDefinitionInBlock, Style/OptionalBooleanParameter