pry 0.12.2 → 0.13.0

data/lib/pry/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "pry/helpers/base_helpers"
 require "pry/helpers/options_helpers"
 require "pry/helpers/command_helpers"

data/lib/pry/helpers/base_helpers.rb

@@ -1,200 +1,71 @@
-module Pry::Helpers; end
-
-# rubocop:disable Metrics/ModuleLength
-module Pry::Helpers::BaseHelpers
-  extend self
-
-  @mac_osx_warn = false
-  # @deprecated Use {Pry::Helpers::Platform.mac_osx?} instead.
-  def mac_osx?
-    unless @mac_osx_warn
-      loc = caller_locations(1..1).first
-      warn(
-        "#{loc.path}:#{loc.lineno}: warning: method BaseHelpers##{__method__} " \
-        "is deprecated. Use Pry:Helpers::Platform.#{__method__} instead"
-      )
-      @mac_osx_warn = true
-    end
-    Pry::Helpers::Platform.mac_osx?
-  end
-
-  @linux_warn = false
-  # @deprecated Use {Pry::Helpers::Platform.mac_osx?} instead.
-  def linux?
-    unless @linux_warn
-      loc = caller_locations(1..1).first
-      warn(
-        "#{loc.path}:#{loc.lineno}: warning: method BaseHelpers##{__method__} " \
-        "is deprecated. Use Pry:Helpers::Platform.#{__method__} instead"
-      )
-      @linux_warn = true
-    end
-    Pry::Helpers::Platform.linux?
-  end
-
-  @windows_warn = false
-  # @deprecated Use {Pry::Helpers::Platform.windows?} instead.
-  def windows?
-    unless @windows_warn
-      loc = caller_locations(1..1).first
-      warn(
-        "#{loc.path}:#{loc.lineno}: warning: method BaseHelpers##{__method__} " \
-        "is deprecated. Use Pry:Helpers::Platform.#{__method__} instead"
-      )
-      @windows_warn = true
-    end
-    Pry::Helpers::Platform.windows?
-  end
-
-  @windows_ansi_warn = false
-  # @deprecated Use {Pry::Helpers::Platform.windows_ansi?} instead.
-  def windows_ansi?
-    unless @windows_ansi_warn
-      loc = caller_locations(1..1).first
-      warn(
-        "#{loc.path}:#{loc.lineno}: warning: method BaseHelpers##{__method__} " \
-        "is deprecated. Use Pry:Helpers::Platform.#{__method__} instead"
-      )
-      @windows_ansi_warn = true
-    end
-    Pry::Helpers::Platform.windows_ansi?
-  end
-
-  @jruby_warn = false
-  # @deprecated Use {Pry::Helpers::Platform.jruby?} instead.
-  def jruby?
-    unless @jruby_warn
-      loc = caller_locations(1..1).first
-      warn(
-        "#{loc.path}:#{loc.lineno}: warning: method BaseHelpers##{__method__} " \
-        "is deprecated. Use Pry:Helpers::Platform.#{__method__} instead"
-      )
-      @jruby_warn = true
-    end
-    Pry::Helpers::Platform.jruby?
-  end
-
-  @jruby19_warn = false
-  # @deprecated Use {Pry::Helpers::Platform.jruby_19?} instead.
-  def jruby_19?
-    unless @jruby19_warn
-      loc = caller_locations(1..1).first
-      warn(
-        "#{loc.path}:#{loc.lineno}: warning: method BaseHelpers##{__method__} " \
-        "is deprecated. Use Pry:Helpers::Platform.#{__method__} instead"
-      )
-      @jruby19_warn = true
-    end
-    Pry::Helpers::Platform.jruby_19?
-  end
-
-  @mri_warn = false
-  # @deprecated Use {Pry::Helpers::Platform.mri?} instead.
-  def mri?
-    unless @mri_warn
-      loc = caller_locations(1..1).first
-      warn(
-        "#{loc.path}:#{loc.lineno}: warning: method BaseHelpers##{__method__} " \
-        "is deprecated. Use Pry:Helpers::Platform.#{__method__} instead"
-      )
-      @mri_warn = true
-    end
-    Pry::Helpers::Platform.mri?
-  end
-
-  @mri19_warn = false
-  # @deprecated Use {Pry::Helpers::Platform.mri_19?} instead.
-  def mri_19?
-    unless @mri19_warn
-      loc = caller_locations(1..1).first
-      warn(
-        "#{loc.path}:#{loc.lineno}: warning: method BaseHelpers##{__method__} " \
-        "is deprecated. Use Pry:Helpers::Platform.#{__method__} instead"
-      )
-      @mri19_warn = true
-    end
-    Pry::Helpers::Platform.mri_19?
-  end
-
-  @mri2_warn = false
-  # @deprecated Use {Pry::Helpers::Platform.mri_2?} instead.
-  def mri_2?
-    unless @mri2_warn
-      loc = caller_locations(1..1).first
-      warn(
-        "#{loc.path}:#{loc.lineno}: warning: method BaseHelpers##{__method__} " \
-        "is deprecated. Use Pry:Helpers::Platform.#{__method__} instead"
-      )
-      @mri2_warn = true
-    end
-    Pry::Helpers::Platform.mri_2?
-  end
-
-  def silence_warnings
-    old_verbose = $VERBOSE
-    $VERBOSE = nil
-    begin
-      yield
-    ensure
-      $VERBOSE = old_verbose
-    end
-  end
-
-  # Acts like send but ignores any methods defined below Object or Class in the
-  # inheritance hierarchy.
-  # This is required to introspect methods on objects like Net::HTTP::Get that
-  # have overridden the `method` method.
-  def safe_send(obj, method, *args, &block)
-    (Module === obj ? Module : Object).instance_method(method).bind(obj).call(*args, &block)
-  end
-  public :safe_send
-
-  def find_command(name, set = Pry::Commands)
-    command_match = set.find do |_, command|
-      (listing = command.options[:listing]) == name && listing != nil
-    end
-    command_match.last if command_match
-  end
-
-  def not_a_real_file?(file)
-    file =~ /^(\(.*\))$|^<.*>$/ || file =~ /__unknown__/ || file == "" || file == "-e"
-  end
-
-  def command_dependencies_met?(options)
-    return true if !options[:requires_gem]
-
-    Array(options[:requires_gem]).all? do |g|
-      Pry::Rubygem.installed?(g)
-    end
-  end
-
-  def use_ansi_codes?
-    Pry::Helpers::Platform.windows_ansi? || ENV['TERM'] && ENV['TERM'] != "dumb"
-  end
-
-  def colorize_code(code)
-    CodeRay.scan(code, :ruby).term
-  end
-
-  def highlight(string, regexp, highlight_color = :bright_yellow)
-    string.gsub(regexp) { |match| "<#{highlight_color}>#{match}</#{highlight_color}>" }
-  end
-
-  # formatting
-  def heading(text)
-    text = "#{text}\n--"
-    "\e[1m#{text}\e[0m"
-  end
-
-  # Send the given text through the best available pager (if Pry.config.pager is
-  # enabled). Infers where to send the output if used as a mixin.
-  # DEPRECATED.
-  def stagger_output(text, _out = nil)
-    if defined?(_pry_) && _pry_
-      _pry_.pager.page text
-    else
-      Pry.new.pager.page text
+# frozen_string_literal: true
+
+class Pry
+  module Helpers
+    module BaseHelpers
+      extend self
+
+      def silence_warnings
+        old_verbose = $VERBOSE
+        $VERBOSE = nil
+        begin
+          yield
+        ensure
+          $VERBOSE = old_verbose
+        end
+      end
+
+      # Acts like send but ignores any methods defined below Object or Class in the
+      # inheritance hierarchy.
+      # This is required to introspect methods on objects like Net::HTTP::Get that
+      # have overridden the `method` method.
+      def safe_send(obj, method, *args, &block)
+        (obj.is_a?(Module) ? Module : Object).instance_method(method)
+          .bind(obj).call(*args, &block)
+      end
+
+      def find_command(name, set = Pry::Commands)
+        command_match = set.find do |_, command|
+          (listing = command.options[:listing]) == name && !listing.nil?
+        end
+        command_match.last if command_match
+      end
+
+      def not_a_real_file?(file)
+        file =~ /^(\(.*\))$|^<.*>$/ || file =~ /__unknown__/ || file == "" || file == "-e"
+      end
+
+      def use_ansi_codes?
+        Pry::Helpers::Platform.windows_ansi? ||
+          ((term = Pry::Env['TERM']) && term != "dumb")
+      end
+
+      def colorize_code(code)
+        SyntaxHighlighter.highlight(code)
+      end
+
+      def highlight(string, regexp, highlight_color = :bright_yellow)
+        string.gsub(regexp) do |match|
+          "<#{highlight_color}>#{match}</#{highlight_color}>"
+        end
+      end
+
+      # formatting
+      def heading(text)
+        text = "#{text}\n--"
+        "\e[1m#{text}\e[0m"
+      end
+
+      # Send the given text through the best available pager (if Pry.config.pager is
+      # enabled). Infers where to send the output if used as a mixin.
+      # DEPRECATED.
+      def stagger_output(text, _out = nil)
+        if defined?(pry_instance) && pry_instance
+          pry_instance.pager.page text
+        else
+          Pry.new.pager.page text
+        end
+      end
     end
   end
 end
-# rubocop:enable Metrics/ModuleLength

data/lib/pry/helpers/command_helpers.rb

@@ -1,90 +1,84 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+
 class Pry
   module Helpers
-
     module CommandHelpers
       include OptionsHelpers
 
-      module_function
+      extend self
 
       # Open a temp file and yield it to the block, closing it after
       # @return [String] The path of the temp file
       def temp_file(ext = '.rb')
         file = Tempfile.new(['pry', ext])
-        yield file
+        yield(file)
       ensure
-        file.close(true) if file
+        file.close(true)
       end
 
-      def internal_binding?(target)
-        m = target.eval("::Kernel.__method__").to_s
+      def internal_binding?(context)
+        method_name = context.eval("::Kernel.__method__").to_s
         # class_eval is here because of http://jira.codehaus.org/browse/JRUBY-6753
-        ["__binding__", "__pry__", "class_eval"].include?(m)
+        %w[__binding__ __pry__ class_eval].include?(method_name)
+        # TODO: codehaus is dead, there was no test for this and the
+        # description for the commit doesn't exist. Probably a candidate for
+        # removal so we have a chance to introduce a regression and document it
+        # properly.
       end
 
-      def get_method_or_raise(name, target, opts = {}, omit_help = false)
-        meth = Pry::Method.from_str(name, target, opts)
-
-        if name && !meth
-          command_error("The method '#{name}' could not be found.", omit_help, MethodNotFound)
+      def get_method_or_raise(method_name, context, opts = {})
+        method = Pry::Method.from_str(method_name, context, opts)
+        if !method && method_name
+          raise Pry::MethodNotFound, "method '#{method_name}' could not be found."
         end
 
         (opts[:super] || 0).times do
-          if meth.super
-            meth = meth.super
+          if method.super
+            method = method.super
           else
-            command_error("'#{meth.name_with_owner}' has no super method.", omit_help, MethodNotFound)
+            raise Pry::MethodNotFound,
+                  "'#{method.name_with_owner}' has no super method"
           end
         end
 
-        if !meth || (!name && internal_binding?(target))
-          command_error("No method name given, and context is not a method.", omit_help, MethodNotFound)
+        if !method || (!method_name && internal_binding?(context))
+          raise Pry::MethodNotFound,
+                'no method name given, and context is not a method'
         end
 
-        set_file_and_dir_locals(meth.source_file)
-        meth
+        set_file_and_dir_locals(method.source_file)
+        method
       end
 
-      def command_error(message, omit_help, klass = CommandError)
-        message += " Type `#{command_name} --help` for help." unless omit_help
-        raise klass, message
-      end
-
-      # Remove any common leading whitespace from every line in `text`.
-      #
-      # This can be used to make a HEREDOC line up with the left margin, without
+      # Remove any common leading whitespace from every line in `text`. This
+      # can be used to make a HEREDOC line up with the left margin, without
       # sacrificing the indentation level of the source code.
       #
-      # e.g.
-      #   opt.banner unindent <<-USAGE
+      # @example
+      #   opt.banner(unindent(<<-USAGE))
       #     Lorem ipsum dolor sit amet, consectetur adipisicing elit,
       #     sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
       #       "Ut enim ad minim veniam."
       #   USAGE
       #
-      # Heavily based on textwrap.dedent from Python, which is:
-      #   Copyright (C) 1999-2001 Gregory P. Ward.
-      #   Copyright (C) 2002, 2003 Python Software Foundation.
-      #   Written by Greg Ward <gward@python.net>
-      #
-      #   Licensed under <http://docs.python.org/license.html>
-      #   From <http://hg.python.org/cpython/file/6b9f0a6efaeb/Lib/textwrap.py>
-      #
-      # @param [String] text The text from which to remove indentation
-      # @return [String] The text with indentation stripped.
-      def unindent(text, left_padding = 0)
-        # Empty blank lines
-        text = text.sub(/^[ \t]+$/, '')
-
-        # Find the longest common whitespace to all indented lines
-        # Ignore lines containing just -- or ++ as these seem to be used by
-        # comment authors as delimeters.
-        margin = text.scan(/^[ \t]*(?!--\n|\+\+\n)(?=[^ \t\n])/).inject do |current_margin, next_indent|
+      # @param [String] dirty_text The text from which to remove indentation
+      # @return [String] the text with indentation stripped
+      def unindent(dirty_text, left_padding = 0)
+        text = dirty_text.sub(/\A[ \t]+\z/, '') # Empty blank lines.
+
+        # Find the longest common whitespace to all indented lines. Ignore lines
+        # containing just -- or ++ as these seem to be used by comment authors
+        # as delimeters.
+        scanned_text = text.scan(/^[ \t]*(?!--\n|\+\+\n)(?=[^ \t\n])/)
+        margin = scanned_text.inject do |current_margin, next_indent|
           if next_indent.start_with?(current_margin)
             current_margin
           elsif current_margin.start_with?(next_indent)
             next_indent
           else
-            ""
+            ''
           end
         end
 
@@ -93,7 +87,7 @@ class Pry
 
       # Restrict a string to the given range of lines (1-indexed)
       # @param [String] content The string.
-      # @param [Range, Fixnum] lines The line(s) to restrict it to.
+      # @param [Range, Integer] lines The line(s) to restrict it to.
       # @return [String] The resulting string.
       def restrict_to_lines(content, lines)
         line_range = one_index_range_or_number(lines)
@@ -101,11 +95,7 @@ class Pry
       end
 
       def one_index_number(line_number)
-        if line_number > 0
-          line_number - 1
-        else
-          line_number
-        end
+        line_number > 0 ? line_number - 1 : line_number
       end
 
       # convert a 1-index range to a 0-indexed one
@@ -142,16 +132,15 @@ class Pry
         Range.new(a, b)
       end
 
-      def set_file_and_dir_locals(file_name, _pry_ = _pry_(), target = target())
-        return if !target or !file_name
+      def set_file_and_dir_locals(file_name, pry = pry_instance, ctx = target)
+        return if !ctx || !file_name
 
-        _pry_.last_file = File.expand_path(file_name)
-        _pry_.inject_local("_file_", _pry_.last_file, target)
+        pry.last_file = File.expand_path(file_name)
+        pry.inject_local("_file_", pry.last_file, ctx)
 
-        _pry_.last_dir = File.dirname(_pry_.last_file)
-        _pry_.inject_local("_dir_", _pry_.last_dir, target)
+        pry.last_dir = File.dirname(pry.last_file)
+        pry.inject_local("_dir_", pry.last_dir, ctx)
       end
     end
-
   end
 end