amazing_print 1.3.0 → 1.5.0

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

@@ -3,6 +3,7 @@
 require 'shellwords'
 
 require_relative 'base_formatter'
+require_relative 'mswin_helper' if RUBY_PLATFORM.include?('mswin')
 
 module AmazingPrint
   module Formatters
@@ -10,15 +11,24 @@ module AmazingPrint
       attr_reader :dir, :inspector, :options
 
       def initialize(dir, inspector)
+        super()
         @dir = dir
         @inspector = inspector
         @options = inspector.options
       end
 
       def format
-        ls = `ls -alF #{dir.path.shellescape}`
+        ls = info
         colorize(ls.empty? ? dir.inspect : "#{dir.inspect}\n#{ls.chop}", :dir)
       end
+
+      def info
+        if RUBY_PLATFORM.include?('mswin')
+          "#{GetChildItem.new(@dir.path)}\n"
+        else
+          `ls -alF #{dir.path.shellescape}`
+        end
+      end
     end
   end
 end

data/lib/amazing_print/formatters/file_formatter.rb

@@ -3,6 +3,7 @@
 require 'shellwords'
 
 require_relative 'base_formatter'
+require_relative 'mswin_helper' if RUBY_PLATFORM.include?('mswin')
 
 module AmazingPrint
   module Formatters
@@ -10,15 +11,24 @@ module AmazingPrint
       attr_reader :file, :inspector, :options
 
       def initialize(file, inspector)
+        super()
         @file = file
         @inspector = inspector
         @options = inspector.options
       end
 
       def format
-        ls = File.directory?(file) ? `ls -adlF #{file.path.shellescape}` : `ls -alF #{file.path.shellescape}`
+        ls = info
         colorize(ls.empty? ? file.inspect : "#{file.inspect}\n#{ls.chop}", :file)
       end
+
+      def info
+        if RUBY_PLATFORM.include?('mswin')
+          "#{GetChildItem.new(@file.path)}\n"
+        else
+          File.directory?(file) ? `ls -adlF #{file.path.shellescape}` : `ls -alF #{file.path.shellescape}`
+        end
+      end
     end
   end
 end

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,7 +87,8 @@ module AmazingPrint
 
       def ruby19_syntax(key, value, width)
         key[0] = ''
-        "#{align(key, width - 1)}#{colorize(': ', :hash)}#{inspector.awesome(value)}"
+        key << ':'
+        "#{align(key, width)} #{inspector.awesome(value)}"
       end
 
       def pre_ruby19_syntax(key, value, width)

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/mswin_helper.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'fiddle'
+require 'fiddle/import'
+
+module AmazingPrint
+  module Formatters
+    module Kernel32
+      extend Fiddle::Importer
+      dlload 'kernel32'
+      extern 'unsigned long GetFileAttributesA(const char*)'
+    end
+
+    class GetChildItem
+      def initialize(fname)
+        @fname = fname
+        @stat = File.send(File.symlink?(@fname) ? :lstat : :stat, @fname)
+        @attrs = Kernel32::GetFileAttributesA @fname
+      end
+
+      # docs.microsoft.com/en-us/windows/win32/fileio/file-attribute-constants
+      FILE_ATTRIBUTE_ARCHIVE  = 0x20
+      FILE_ATTRIBUTE_READONLY = 0x1
+      FILE_ATTRIBUTE_HIDDEN   = 0x2
+      FILE_ATTRIBUTE_SYSTEM   = 0x4
+
+      def mode
+        r = ['-'] * 6
+        r[0] = 'd' if @stat.directory?
+        r[1] = 'a' unless (@attrs & FILE_ATTRIBUTE_ARCHIVE).zero?
+        r[2] = 'r' unless (@attrs & FILE_ATTRIBUTE_READONLY).zero?
+        r[3] = 'h' unless (@attrs & FILE_ATTRIBUTE_HIDDEN).zero?
+        r[4] = 's' unless (@attrs & FILE_ATTRIBUTE_SYSTEM).zero?
+        r[5] = 'l' if File.symlink? @fname
+        r.join
+      end
+
+      def last_write_time
+        @stat.mtime.strftime '%Y-%m-%d     %H:%M'
+      end
+
+      def length
+        @stat.file? ? @stat.size.to_s : ''
+      end
+
+      def name
+        @fname
+      end
+
+      def to_s
+        format '%-12<Mode>s %<LastWriteTime>s %14<Length>s %<Name>s',
+               {
+                 Mode: mode,
+                 LastWriteTime: last_write_time,
+                 Length: length,
+                 Name: name
+               }
+      end
+    end
+  end
+end
+
+puts AmazingPrint::Formatters::GetChildItem.new ARGV[0] if __FILE__ == $PROGRAM_NAME

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(Dir.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.3.0'
+    '1.5.0'
   end
 end

data/lib/amazing_print.rb

@@ -10,7 +10,7 @@
 # so do nothing for subsequent requires.
 #
 unless defined?(AmazingPrint::Inspector)
-  %w[awesome_method_array string object class kernel].each do |file|
+  %w[awesome_method_array object class kernel].each do |file|
     require_relative "amazing_print/core_ext/#{file}"
   end
 
@@ -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,8 +27,11 @@ 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)

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
@@ -100,12 +102,19 @@ RSpec.describe 'AmazingPrint' do
         stub_tty!
       end
     end
+  end
 
-    describe 'uncolor' do
-      it 'removes any ANSI color codes' do
-        expect('red'.red + 'blue'.blue).to eq "\e[1;31mred\e[0m\e[1;34mblue\e[0m"
-        expect(('red'.red + 'blue'.blue).uncolor).to eq 'redblue'
+  describe 'AmazingPrint::Colors' do
+    %i[gray red green yellow blue purple cyan white].each_with_index do |color, i|
+      it "has #{color} color" do
+        expect(AmazingPrint::Colors.public_send(color, color.to_s)).to eq("\e[1;#{i + 30}m#{color}\e[0m")
+      end
+
+      it "has #{color}ish color" do
+        expect(AmazingPrint::Colors.public_send(:"#{color}ish", color.to_s)).to eq("\e[0;#{i + 30}m#{color}\e[0m")
       end
     end
   end
 end
+
+# rubocop:enable Lint/ConstantDefinitionInBlock, Style/OptionalBooleanParameter

data/spec/core_ext/logger_spec.rb

@@ -6,17 +6,17 @@ require 'logger'
 require 'amazing_print/core_ext/logger'
 
 RSpec.describe 'AmazingPrint logging extensions' do
-  let(:object) { double }
-  let(:options) { { sort_keys: true } }
-
   subject(:logger) do
     Logger.new('/dev/null')
   rescue Errno::ENOENT
     Logger.new('nul')
   end
 
+  let(:object) { double }
+  let(:options) { { sort_keys: true } }
+
   describe 'ap method' do
-    it 'should awesome_inspect the given object' do
+    it 'awesome_inspects the given object' do
       expect(object).to receive(:ai)
       logger.ap object
     end
@@ -31,18 +31,18 @@ RSpec.describe 'AmazingPrint logging extensions' do
         AmazingPrint.defaults = {}
       end
 
-      it 'should fallback to the default :debug log level' do
+      it 'fallbacks to the default :debug log level' do
         expect(logger).to receive(:debug)
         logger.ap nil
       end
 
-      it 'should use the global user default if no level passed' do
+      it 'uses the global user default if no level passed' do
         AmazingPrint.defaults = { log_level: :info }
         expect(logger).to receive(:info)
         logger.ap nil
       end
 
-      it 'should use the passed in level' do
+      it 'uses the passed in level' do
         expect(logger).to receive(:warn)
         logger.ap nil, :warn
       end

data/spec/ext/action_controller_spec.rb

@@ -10,7 +10,7 @@ RSpec.describe 'AmazingPrint::ActionController', skip: -> { !ExtVerifier.has_rai
       ActionController::Parameters.new post: { id: 1, content: 'Some' }
     end
 
-    it 'should format as an object' do
+    it 'formats as an object' do
       expect(inspector.send(:awesome, parameters)).to match(
         /\A#?<ActionController::Parameters {"post"=>{"id"=>1, "content"=>"Some"}} permitted: false>\z/
       )
@@ -21,9 +21,9 @@ RSpec.describe 'AmazingPrint::ActionController', skip: -> { !ExtVerifier.has_rai
     let(:expected_output) do
       <<~OUTPUT
         {
-            \"post\"\e[0;37m => \e[0m{
-                     \"id\"\e[0;37m => \e[0m\e[1;34m1\e[0m,
-                \"content\"\e[0;37m => \e[0m\e[0;33m\"Some\"\e[0m
+            "post"\e[0;37m => \e[0m{
+                     "id"\e[0;37m => \e[0m\e[1;34m1\e[0m,
+                "content"\e[0;37m => \e[0m\e[0;33m"Some"\e[0m
             }
         }
       OUTPUT
@@ -33,7 +33,7 @@ RSpec.describe 'AmazingPrint::ActionController', skip: -> { !ExtVerifier.has_rai
       ActionController::Parameters.new post: { id: 1, content: 'Some' }
     end
 
-    it 'should format as a hash' do
+    it 'formats as a hash' do
       expect(inspector.send(:awesome, parameters.permit!)).to eq expected_output
     end
   end

data/spec/ext/active_model_spec.rb

@@ -8,7 +8,7 @@ RSpec.describe 'ActiveModel::Errors formatting', skip: -> { !ExtVerifier.has_rai
     @ap = AmazingPrint::Inspector.new(plain: true)
   end
 
-  it 'should format active_model_errors properly' do
+  it 'formats active_model_errors properly' do
     model = TableFreeModel.new
     model.errors.add(:name, "can't be blank")