pry 0.12.2 → 0.13.0

data/lib/pry/helpers/documentation_helpers.rb

@@ -1,21 +1,29 @@
+# frozen_string_literal: true
+
 class Pry
   module Helpers
-
     # This class contains methods useful for extracting
     # documentation from methods and classes.
     module DocumentationHelpers
+      YARD_TAGS = %w[
+        param return option yield attr attr_reader attr_writer deprecate example
+        raise
+      ].freeze
 
       module_function
 
       def process_rdoc(comment)
         comment = comment.dup
-        comment.gsub(/<code>(?:\s*\n)?(.*?)\s*<\/code>/m) { CodeRay.scan($1, :ruby).term }.
-          gsub(/<em>(?:\s*\n)?(.*?)\s*<\/em>/m) { "\e[1m#{$1}\e[0m" }.
-          gsub(/<i>(?:\s*\n)?(.*?)\s*<\/i>/m) { "\e[1m#{$1}\e[0m" }.
-          gsub(/<tt>(?:\s*\n)?(.*?)\s*<\/tt>/m) { CodeRay.scan($1, :ruby).term }.
-          gsub(/\B\+(\w+?)\+\B/) { "\e[32m#{$1}\e[0m" }.
-          gsub(/((?:^[ \t]+.+(?:\n+|\Z))+)/) { CodeRay.scan($1, :ruby).term }.
-          gsub(/`(?:\s*\n)?([^\e]*?)\s*`/) { "`#{CodeRay.scan($1, :ruby).term}`" }
+        last_match_ruby = proc do
+          SyntaxHighlighter.highlight(Regexp.last_match(1))
+        end
+        comment.gsub(%r{<code>(?:\s*\n)?(.*?)\s*</code>}m, &last_match_ruby)
+          .gsub(%r{<em>(?:\s*\n)?(.*?)\s*</em>}m) { "\e[1m#{Regexp.last_match(1)}\e[0m" }
+          .gsub(%r{<i>(?:\s*\n)?(.*?)\s*</i>}m) { "\e[1m#{Regexp.last_match(1)}\e[0m" }
+          .gsub(%r{<tt>(?:\s*\n)?(.*?)\s*</tt>}m, &last_match_ruby)
+          .gsub(/\B\+(\w+?)\+\B/) { "\e[32m#{Regexp.last_match(1)}\e[0m" }
+          .gsub(/((?:^[ \t]+.+(?:\n+|\Z))+)/, &last_match_ruby)
+          .gsub(/`(?:\s*\n)?([^\e]*?)\s*`/) { "`#{last_match_ruby.call}`" }
       end
 
       def process_yardoc_tag(comment, tag)
@@ -34,10 +42,9 @@ class Pry
       end
 
       def process_yardoc(comment)
-        yard_tags = ["param", "return", "option", "yield", "attr", "attr_reader", "attr_writer",
-                     "deprecate", "example", "raise"]
-        (yard_tags - ["example"]).inject(comment) { |a, v| process_yardoc_tag(a, v) }.
-          gsub(/^@(#{yard_tags.join("|")})/) { "\e[33m#{$1}\e[0m" }
+        (YARD_TAGS - %w[example])
+          .inject(comment) { |a, v| process_yardoc_tag(a, v) }
+          .gsub(/^@(#{YARD_TAGS.join("|")})/) { "\e[33m#{Regexp.last_match(1)}\e[0m" }
       end
 
       def process_comment_markup(comment)
@@ -47,7 +54,7 @@ class Pry
       # @param [String] code
       # @return [String]
       def strip_comments_from_c_code(code)
-        code.sub(/\A\s*\/\*.*?\*\/\s*/m, '')
+        code.sub(%r{\A\s*/\*.*?\*/\s*}m, '')
       end
 
       # Given a string that makes up a comment in a source-code file parse out the content

data/lib/pry/helpers/options_helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Pry
   module Helpers
     module OptionsHelpers
@@ -8,19 +10,24 @@ class Pry
         @method_target = target
         opt.on :M, "instance-methods", "Operate on instance methods."
         opt.on :m, :methods, "Operate on methods."
-        opt.on :s, :super, "Select the 'super' method. Can be repeated to traverse the ancestors.", as: :count
-        opt.on :c, :context, "Select object context to run under.", argument: true do |context|
+        opt.on :s, :super, "Select the 'super' method. Can be repeated to " \
+                           "traverse the ancestors.", as: :count
+        opt.on(
+          :c, :context, "Select object context to run under.", argument: true
+        ) do |context|
           @method_target = Pry.binding_for(target.eval(context))
         end
       end
 
       # Get the method object parsed by the slop instance
       def method_object
-        @method_object ||= get_method_or_raise(args.empty? ? nil : args.join(" "), @method_target,
-                            super: opts[:super],
-                            instance: opts.present?(:'instance-methods') && !opts.present?(:'methods'),
-                            methods: opts.present?(:'methods') && !opts.present?(:'instance-methods')
-                           )
+        @method_object ||= get_method_or_raise(
+          args.empty? ? nil : args.join(" "),
+          @method_target,
+          super: opts[:super],
+          instance: opts.present?(:'instance-methods') && !opts.present?(:methods),
+          methods: opts.present?(:methods) && !opts.present?(:'instance-methods')
+        )
       end
     end
   end

data/lib/pry/helpers/platform.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
+require 'rbconfig'
+
 class Pry
   module Helpers
     # Contains methods for querying the platform that Pry is running on
     # @api public
     # @since v0.12.0
-    # rubocop:disable Style/DoubleNegation
     module Platform
       # @return [Boolean]
       def self.mac_osx?
@@ -25,7 +28,7 @@ class Pry
       def self.windows_ansi?
         return false unless windows?
 
-        !!(defined?(Win32::Console) || ENV['ANSICON'] || mri_2?)
+        !!(defined?(Win32::Console) || Pry::Env['ANSICON'] || mri_2?)
       end
 
       # @return [Boolean]
@@ -45,14 +48,13 @@ class Pry
 
       # @return [Boolean]
       def self.mri_19?
-        !!(mri? && RUBY_VERSION.start_with?('1.9'))
+        mri? && RUBY_VERSION.start_with?('1.9')
       end
 
       # @return [Boolean]
       def self.mri_2?
-        !!(mri? && RUBY_VERSION.start_with?('2'))
+        mri? && RUBY_VERSION.start_with?('2')
       end
     end
-    # rubocop:enable Style/DoubleNegation
   end
 end

data/lib/pry/helpers/table.rb

@@ -1,38 +1,42 @@
+# frozen_string_literal: true
+
 class Pry
   module Helpers
-    def self.tablify_or_one_line(heading, things, config = Pry.config)
+    def self.tablify_or_one_line(heading, things, pry_instance = Pry.new)
       plain_heading = Pry::Helpers::Text.strip_color(heading)
       attempt = Table.new(things, column_count: things.size)
-      if attempt.fits_on_line?(Terminal.width! - plain_heading.size - 2)
+      if attempt.fits_on_line?(pry_instance.output.width - plain_heading.size - 2)
         "#{heading}: #{attempt}\n"
       else
-        "#{heading}: \n#{tablify_to_screen_width(things, { indent: '  ' }, config)}\n"
+        content = tablify_to_screen_width(things, { indent: '  ' }, pry_instance)
+        "#{heading}: \n#{content}\n"
       end
     end
 
-    def self.tablify_to_screen_width(things, options, config = Pry.config)
+    def self.tablify_to_screen_width(things, options, pry_instance = Pry.new)
       options ||= {}
       things = things.compact
       if (indent = options[:indent])
-        usable_width = Terminal.width! - indent.size
-        tablify(things, usable_width, config).to_s.gsub(/^/, indent)
+        usable_width = pry_instance.output.width - indent.size
+        tablify(things, usable_width, pry_instance).to_s.gsub(/^/, indent)
       else
-        tablify(things, Terminal.width!, config).to_s
+        tablify(things, pry_instance.output.width, pry_instance).to_s
       end
     end
 
-    def self.tablify(things, line_length, config = Pry.config)
-      table = Table.new(things, { column_count: things.size }, config)
-      table.column_count -= 1 until 1 == table.column_count or
-        table.fits_on_line?(line_length)
+    def self.tablify(things, line_length, pry_instance = Pry.new)
+      table = Table.new(things, { column_count: things.size }, pry_instance)
+      until (table.column_count == 1) || table.fits_on_line?(line_length)
+        table.column_count -= 1
+      end
       table
     end
 
     class Table
       attr_reader :items, :column_count
-      def initialize(items, args, config = Pry.config)
+      def initialize(items, args, pry_instance = Pry.new)
         @column_count = args[:column_count]
-        @config = config
+        @config = pry_instance.config
         self.items = items
       end
 
@@ -40,46 +44,50 @@ class Pry
         rows_to_s.join("\n")
       end
 
-      def rows_to_s style = :color_on
+      def rows_to_s(style = :color_on)
         widths = columns.map { |e| _max_width(e) }
         @rows_without_colors.map do |r|
           padded = []
-          r.each_with_index do |e,i|
+          r.each_with_index do |e, i|
             next unless e
 
             item = e.ljust(widths[i])
-            item.sub! e, _recall_color_for(e) if :color_on == style
+            item.sub! e, _recall_color_for(e) if style == :color_on
             padded << item
           end
           padded.join(@config.ls.separator)
         end
       end
 
-      def items= items
+      def items=(items)
         @items = items
         _rebuild_colorless_cache
         _recolumn
-        items
       end
 
-      def column_count= n
-        @column_count = n
+      def column_count=(count)
+        @column_count = count
         _recolumn
       end
 
-      def fits_on_line? line_length
-        _max_width(rows_to_s :no_color) <= line_length
+      def fits_on_line?(line_length)
+        _max_width(rows_to_s(:no_color)) <= line_length
       end
 
       def columns
         @rows_without_colors.transpose
       end
 
-      def ==(other); items == other.to_a end
+      def ==(other)
+        items == other.to_a
+      end
 
-      def to_a; items.to_a end
+      def to_a
+        items.to_a
+      end
 
       private
+
       def _max_width(things)
         things.compact.map(&:size).max || 0
       end
@@ -105,10 +113,9 @@ class Pry
         end
       end
 
-      def _recall_color_for thing
+      def _recall_color_for(thing)
         @colorless_cache[thing]
       end
     end
-
   end
 end

data/lib/pry/helpers/text.rb

@@ -1,20 +1,23 @@
+# frozen_string_literal: true
+
 class Pry
   module Helpers
-    # The methods defined on {Text} are available to custom commands via {Pry::Command#text}.
+    # The methods defined on {Text} are available to custom commands via
+    # {Pry::Command#text}.
     module Text
       extend self
-      COLORS =
-      {
-        "black"   => 0,
-        "red"     => 1,
-        "green"   => 2,
-        "yellow"  => 3,
-        "blue"    => 4,
-        "purple"  => 5,
+
+      COLORS = {
+        "black" => 0,
+        "red" => 1,
+        "green" => 2,
+        "yellow" => 3,
+        "blue" => 4,
+        "purple" => 5,
         "magenta" => 5,
-        "cyan"    => 6,
-        "white"   => 7
-      }
+        "cyan" => 6,
+        "white" => 7
+      }.freeze
 
       COLORS.each_pair do |color, value|
         define_method color do |text|
@@ -41,7 +44,7 @@ class Pry
       # @param  [String, #to_s] text
       # @return [String] _text_ stripped of any color codes.
       def strip_color(text)
-        text.to_s.gsub(/(\001)?\e\[.*?(\d)+m(\002)?/ , '')
+        text.to_s.gsub(/(\001)?\e\[.*?(\d)+m(\002)?/, '')
       end
 
       # Returns _text_ as bold text for use on a terminal.
@@ -99,7 +102,7 @@ class Pry
         max_width = (offset + lines.count).to_s.length
         lines.each_with_index.map do |line, index|
           adjusted_index = (index + offset).to_s.rjust(max_width)
-          "#{self.send(color, adjusted_index)}: #{line}"
+          "#{send(color, adjusted_index)}: #{line}"
         end.join
       end
 

data/lib/pry/history.rb

@@ -1,33 +1,38 @@
+# frozen_string_literal: true
+
 class Pry
   # The History class is responsible for maintaining the user's input history,
   # both internally and within Readline.
   class History
-    attr_accessor :loader, :saver, :pusher, :clearer
+    def self.default_file
+      history_file =
+        if (xdg_home = Pry::Env['XDG_DATA_HOME'])
+          # See XDG Base Directory Specification at
+          # https://standards.freedesktop.org/basedir-spec/basedir-spec-0.8.html
+          xdg_home + '/pry/pry_history'
+        elsif File.exist?(File.expand_path('~/.pry_history'))
+          '~/.pry_history'
+        else
+          '~/.local/share/pry/pry_history'
+        end
+      File.expand_path(history_file)
+    end
+
+    attr_accessor :loader, :saver
 
     # @return [Fixnum] Number of lines in history when Pry first loaded.
     attr_reader :original_lines
 
+    # @return [Integer] total number of lines, including original lines
+    attr_reader :history_line_count
+
     def initialize(options = {})
-      @history = []
-      @original_lines = 0
+      @history = options[:history] || []
+      @history_line_count = @history.count
       @file_path = options[:file_path]
-      restore_default_behavior
-    end
-
-    # Assign the default methods for loading, saving, pushing, and clearing.
-    def restore_default_behavior
-      Pry.config.input # force Readline to load if applicable
-
+      @original_lines = 0
       @loader = method(:read_from_file)
-      @saver  = method(:save_to_file)
-
-      if defined?(Readline)
-        @pusher  = method(:push_to_readline)
-        @clearer = method(:clear_readline)
-      else
-        @pusher  = proc {}
-        @clearer = proc {}
-      end
+      @saver = method(:save_to_file)
     end
 
     # Load the input history using `History.loader`.
@@ -36,9 +41,9 @@ class Pry
       @loader.call do |line|
         next if invalid_readline_line?(line)
 
-        @pusher.call(line.chomp)
         @history << line.chomp
         @original_lines += 1
+        @history_line_count += 1
       end
     end
 
@@ -46,15 +51,20 @@ class Pry
     # @param [String] line
     # @return [String] The same line that was passed in
     def push(line)
-      empty_or_invalid_line = line.empty? || invalid_readline_line?(line)
+      return line if line.empty? || invalid_readline_line?(line)
 
-      unless empty_or_invalid_line || (@history.last && line == @history.last)
-        @pusher.call(line)
-        @history << line
-        if !should_ignore?(line) && Pry.config.history.should_save
-          @saver.call(line)
-        end
+      begin
+        last_line = @history[-1]
+      rescue IndexError
+        last_line = nil
       end
+
+      return line if line == last_line
+
+      @history << line
+      @history_line_count += 1
+      @saver.call(line) if !should_ignore?(line) && Pry.config.history_save
+
       line
     end
     alias << push
@@ -62,26 +72,21 @@ class Pry
     # Clear this session's history. This won't affect the contents of the
     # history file.
     def clear
-      @clearer.call
+      @history.clear
+      @history_line_count = 0
       @original_lines = 0
-      @history = []
-    end
-
-    # @return [Fixnum] The number of lines in history.
-    def history_line_count
-      @history.count
     end
 
     # @return [Fixnum] The number of lines in history from just this session.
     def session_line_count
-      @history.count - @original_lines
+      @history_line_count - @original_lines
     end
 
     # Return an Array containing all stored history.
     # @return [Array<String>] An Array containing all lines of history loaded
     #   or entered by the user in the current session.
     def to_a
-      @history.dup
+      @history.to_a
     end
 
     # Filter the history with the histignore options
@@ -94,39 +99,26 @@ class Pry
     private
 
     # Check if the line match any option in the histignore
-    # [Pry.config.history.histignore]
+    # [Pry.config.history_ignorelist]
     # @return [Boolean] a boolean that notifies if the line was found in the
     #   histignore array.
     def should_ignore?(line)
-      hist_ignore = Pry.config.history.histignore
+      hist_ignore = Pry.config.history_ignorelist
       return false if hist_ignore.nil? || hist_ignore.empty?
 
       hist_ignore.any? { |p| line.to_s.match(p) }
     end
 
-    # The default loader. Yields lines from `Pry.history.config.file`.
+    # The default loader. Yields lines from `Pry.config.history_file`.
     def read_from_file
       path = history_file_path
 
-      if File.exist?(path)
-        File.foreach(path) { |line| yield(line) }
-      end
+      File.foreach(path) { |line| yield(line) } if File.exist?(path)
     rescue SystemCallError => error
       warn "Unable to read history file: #{error.message}"
     end
 
-    # The default pusher. Appends the given line to Readline::HISTORY.
-    # @param [String] line
-    def push_to_readline(line)
-      Readline::HISTORY << line
-    end
-
-    # The default clearer. Clears Readline::HISTORY.
-    def clear_readline
-      Readline::HISTORY.shift until Readline::HISTORY.empty?
-    end
-
-    # The default saver. Appends the given line to `Pry.history.config.file`.
+    # The default saver. Appends the given line to `Pry.config.history_file`.
     def save_to_file(line)
       history_file.puts line if history_file
     end
@@ -139,7 +131,7 @@ class Pry
         unless File.exist?(history_file_path)
           FileUtils.mkdir_p(File.dirname(history_file_path))
         end
-        @history_file = File.open(history_file_path, 'a', 0600).tap do |file|
+        @history_file = File.open(history_file_path, 'a', 0o600).tap do |file|
           file.sync = true
         end
       end
@@ -149,7 +141,7 @@ class Pry
     end
 
     def history_file_path
-      File.expand_path(@file_path || Pry.config.history.file)
+      File.expand_path(@file_path || Pry.config.history_file)
     end
 
     def invalid_readline_line?(line)