pry 0.14.1 → 0.15.0

data/lib/pry/config.rb

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
 
-require 'ostruct'
-
 class Pry
   # @api private
   class Config
     extend Attributable
 
-    # @return [IO, #readline] he object from which Pry retrieves its lines of
+    # @return [IO, #readline] the object from which Pry retrieves its lines of
     #   input
     attribute :input
 
@@ -26,10 +24,6 @@ class Pry
     # @return [Array] Exception that Pry shouldn't rescue
     attribute :unrescued_exceptions
 
-    # @deprecated
-    # @return [Array] Exception that Pry shouldn't rescue
-    attribute :exception_whitelist
-
     # @return [Integer] The number of lines of context to show before and after
     #   exceptions
     attribute :default_window_size
@@ -67,6 +61,9 @@ class Pry
     # @return [Boolean]
     attribute :pager
 
+    # @return [Boolean]
+    attribute :multiline
+
     # @return [Boolean] whether the global ~/.pryrc should be loaded
     attribute :should_load_rc
 
@@ -153,7 +150,7 @@ class Pry
 
     def initialize
       merge!(
-        input: MemoizedValue.new { lazy_readline },
+        input: MemoizedValue.new { choose_input },
         output: $stdout.tap { |out| out.sync = true },
         commands: Pry::Commands,
         prompt_name: 'pry',
@@ -167,17 +164,10 @@ class Pry
           ::SystemExit, ::SignalException, Pry::TooSafeException
         ],
 
-        exception_whitelist: MemoizedValue.new do
-          output.puts(
-            '[warning] Pry.config.exception_whitelist is deprecated, ' \
-            'please use Pry.config.unrescued_exceptions instead.'
-          )
-          unrescued_exceptions
-        end,
-
         hooks: Pry::Hooks.default,
         pager: true,
         system: Pry::SystemCommandHandler.method(:default),
+        multiline: true,
         color: Pry::Helpers::BaseHelpers.use_ansi_codes?,
         default_window_size: 5,
         editor: Pry::Editor.default,
@@ -199,7 +189,7 @@ class Pry
         extra_sticky_locals: {},
         command_completions: proc { commands.keys },
         file_completions: proc { Dir['.'] },
-        ls: OpenStruct.new(Pry::Command::Ls::DEFAULT_OPTIONS),
+        ls: Pry::Command::Ls::Config.default,
         completer: Pry::InputCompleter,
         history_save: true,
         history_load: true,
@@ -286,7 +276,17 @@ class Pry
 
     private
 
-    def lazy_readline
+    def choose_input
+      input = load_readline
+
+      if Pry::Env['TERM'] == 'dumb' && (defined?(Reline) && input == Reline)
+        input = Pry::Input::SimpleStdio
+      end
+
+      input
+    end
+
+    def load_readline
       require 'readline'
       ::Readline
     rescue LoadError
@@ -301,17 +301,14 @@ class Pry
     end
 
     def default_rc_file
-      if (pryrc = Pry::Env['PRYRC'])
-        pryrc
-      elsif (xdg_home = Pry::Env['XDG_CONFIG_HOME'])
-        # See XDG Base Directory Specification at
-        # https://standards.freedesktop.org/basedir-spec/basedir-spec-0.8.html
-        xdg_home + '/pry/pryrc'
-      elsif File.exist?(File.expand_path('~/.pryrc'))
-        '~/.pryrc'
-      else
-        '~/.config/pry/pryrc'
-      end
+      [Pry::Env['PRYRC'],
+       # See XDG Base Directory Specification at
+       # https://specifications.freedesktop.org/basedir-spec/latest/
+       "#{Pry::Env['XDG_CONFIG_HOME']}/pry/pryrc",
+       File.expand_path('~/.pryrc'),
+       File.expand_path('~/.config/pry/pryrc')]
+        .compact
+        .find { |file| File.exist?(file) }
     end
   end
 end

data/lib/pry/control_d_handler.rb

@@ -19,7 +19,7 @@ class Pry
       else
         # Otherwise, saves current binding stack as old stack and pops last
         # binding out of binding stack (the old stack still has that binding).
-        cd_state = Pry::CommandState.default.state_for('cd')
+        cd_state = Pry::CommandState.default.state_for(Pry::Command::Cd)
         cd_state.old_stack = pry_instance.binding_stack.dup
         pry_instance.binding_stack.pop
       end

data/lib/pry/core_extensions.rb

@@ -78,7 +78,7 @@ class Object
       # Module.new.class_eval("binding") has different behaviour than CRuby,
       # where this is not needed: class_eval("binding") vs class_eval{binding}.
       # Using a block works around the difference of behaviour on JRuby.
-      # The scope is clear of local variabless. Don't add any.
+      # The scope is clear of local variables. Don't add any.
       #
       # This fixes the following two spec failures, at https://travis-ci.org/pry/pry/jobs/274470002
       # 1) ./spec/pry_spec.rb:360:in `block in (root)'

data/lib/pry/editor.rb

@@ -105,7 +105,7 @@ class Pry
         '--nofork' if blocking
       when /^jedit/
         '-wait' if blocking
-      when /^mate/, /^subl/, /^redcar/
+      when /^mate/, /^subl/, /^redcar/, /^code/
         '-w' if blocking
       end
     end
@@ -121,6 +121,8 @@ class Pry
         "+#{line_number} #{file_name}"
       when /^mate/, /^geany/
         "-l #{line_number} #{file_name}"
+      when /^code/
+        "-g #{file_name}:#{line_number}"
       when /^subl/
         "#{file_name}:#{line_number}"
       when /^uedit32/

data/lib/pry/exception_handler.rb

@@ -30,8 +30,13 @@ class Pry
       end
 
       def exception_text(exception)
-        "#{exception.class}: #{exception.message}\n" \
-        "from #{exception.backtrace.first}\n"
+        if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('3.2')
+          "#{exception.class}: #{exception.message}\n" \
+          "from #{exception.backtrace.first}\n"
+        else
+          "#{exception.class}: #{exception.detailed_message}\n" \
+          "from #{exception.backtrace.first}\n"
+        end
       end
 
       def cause_text(cause)

data/lib/pry/helpers/command_helpers.rb

@@ -70,7 +70,7 @@ class Pry
 
         # 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.
+        # as delimiters.
         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)

data/lib/pry/helpers/platform.rb

@@ -28,7 +28,7 @@ class Pry
       def self.windows_ansi?
         return false unless windows?
 
-        !!(defined?(Win32::Console) || Pry::Env['ANSICON'] || mri_2?)
+        !!(defined?(Win32::Console) || Pry::Env['ANSICON'] || mri?)
       end
 
       # @return [Boolean]
@@ -46,11 +46,6 @@ class Pry
         RbConfig::CONFIG['ruby_install_name'] == 'ruby'
       end
 
-      # @return [Boolean]
-      def self.mri_19?
-        mri? && RUBY_VERSION.start_with?('1.9')
-      end
-
       # @return [Boolean]
       def self.mri_2?
         mri? && RUBY_VERSION.start_with?('2')

data/lib/pry/helpers/text.rb

@@ -21,20 +21,20 @@ class Pry
 
       COLORS.each_pair do |color, value|
         define_method color do |text|
-          "\001\033[0;#{30 + value}m\002#{text}\001\033[0m\002"
+          "\033[0;#{30 + value}m#{text}\033[0m"
         end
 
         define_method "bright_#{color}" do |text|
-          "\001\033[1;#{30 + value}m\002#{text}\001\033[0m\002"
+          "\033[1;#{30 + value}m#{text}\033[0m"
         end
 
         COLORS.each_pair do |bg_color, bg_value|
           define_method "#{color}_on_#{bg_color}" do |text|
-            "\001\033[0;#{30 + value};#{40 + bg_value}m\002#{text}\001\033[0m\002"
+            "\033[0;#{30 + value};#{40 + bg_value}m#{text}\033[0m"
           end
 
           define_method "bright_#{color}_on_#{bg_color}" do |text|
-            "\001\033[1;#{30 + value};#{40 + bg_value}m\002#{text}\001\033[0m\002"
+            "\033[1;#{30 + value};#{40 + bg_value}m#{text}\033[0m"
           end
         end
       end
@@ -52,7 +52,7 @@ class Pry
       # @param [String, #to_s] text
       # @return [String] _text_
       def bold(text)
-        "\001\e[1m\002#{text}\001\e[0m\002"
+        "\e[1m#{text}\e[0m"
       end
 
       # Returns `text` in the default foreground colour.

data/lib/pry/indent.rb

@@ -17,6 +17,9 @@ class Pry
     # @return [String] String containing the spaces to be inserted before the next line.
     attr_reader :indent_level
 
+    # @return [String] String containing the spaces for the current line.
+    attr_reader :last_indent_level
+
     # @return [Array<String>] The stack of open tokens.
     attr_reader :stack
 
@@ -57,8 +60,8 @@ class Pry
     #
     # :pre_constant and :preserved_constant are the CodeRay 0.9.8 and 1.0.0
     # classifications of "true", "false", and "nil".
-    IGNORE_TOKENS = [:space, :content, :string, :method, :ident,
-                     :constant, :pre_constant, :predefined_constant].freeze
+    IGNORE_TOKENS = %i[space content string method ident
+                       constant pre_constant predefined_constant].freeze
 
     # Tokens that indicate the end of a statement (i.e. that, if they appear
     # directly before an "if" indicates that that if applies to the same line,
@@ -66,10 +69,10 @@ class Pry
     #
     # :reserved and :keywords are the CodeRay 0.9.8 and 1.0.0 respectively
     # classifications of "super", "next", "return", etc.
-    STATEMENT_END_TOKENS = IGNORE_TOKENS + [:regexp, :integer, :float,
-                                            :keyword, :delimiter, :reserved,
-                                            :instance_variable,
-                                            :class_variable, :global_variable]
+    STATEMENT_END_TOKENS = IGNORE_TOKENS + %i[regexp integer float
+                                              keyword delimiter reserved
+                                              instance_variable
+                                              class_variable global_variable]
 
     # Collection of tokens that should appear dedented even though they
     # don't affect the surrounding code.
@@ -109,7 +112,8 @@ class Pry
     # reset internal state
     def reset
       @stack = []
-      @indent_level = ''
+      @indent_level = String.new # rubocop:disable Style/EmptyLiteral
+      @last_indent_level = @indent_level
       @heredoc_queue = []
       @close_heredocs = {}
       @string_start = nil
@@ -164,11 +168,11 @@ class Pry
 
         output += line
 
+        @last_indent_level = prefix
         prefix = new_prefix
       end
 
       @indent_level = prefix
-
       output
     end
 
@@ -281,9 +285,7 @@ class Pry
     # @param [String] string The Ruby to lex
     # @return [Array] An Array of pairs of [token_value, token_type]
     def tokenize(string)
-      tokens = SyntaxHighlighter.tokenize(string)
-      tokens = tokens.tokens.each_slice(2) if tokens.respond_to?(:tokens) # Coderay 1.0.0
-      tokens.to_a
+      SyntaxHighlighter.tokenize(string).each_slice(2).to_a
     end
 
     # Update the internal state about what kind of strings are open.

data/lib/pry/input/simple_stdio.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class Pry
+  module Input
+    # Readline replacement for low-capability terminals.
+    class SimpleStdio
+      def self.readline(prompt)
+        Pry.config.output.print(prompt)
+        $stdin.gets
+      end
+    end
+  end
+end

data/lib/pry/input_completer.rb

@@ -234,7 +234,7 @@ class Pry
       end.compact
     end
 
-    # build_path seperates the input into two parts: path and input.
+    # build_path separates the input into two parts: path and input.
     # input is the partial string that should be completed
     # path is a proc that takes an input and builds a full path.
     def build_path(input)
@@ -270,7 +270,7 @@ class Pry
       end
 
       # FIXME: Add Pry here as well?
-      [:IRB, :SLex, :RubyLex, :RubyToken].each do |module_name|
+      %i[IRB SLex RubyLex RubyToken].each do |module_name|
         next unless Object.const_defined?(module_name)
 
         scanner.call(Object.const_get(module_name))

data/lib/pry/method/patcher.rb

@@ -43,7 +43,7 @@ class Pry
       #
       # When we're redefining aliased methods we will overwrite the method at the
       # unaliased name (so that super continues to work). By wrapping that code in a
-      # transation we make that not happen, which means that alias_method_chains, etc.
+      # translation we make that not happen, which means that alias_method_chains, etc.
       # continue to work.
       #
       def with_method_transaction
@@ -95,7 +95,7 @@ class Pry
       # Update the source code so that when it has the right owner when eval'd.
       #
       # This (combined with definition_for_owner) is backup for the case that
-      # wrap_for_nesting fails, to ensure that the method will stil be defined in
+      # wrap_for_nesting fails, to ensure that the method will still be defined in
       # the correct place.
       #
       # @param [String] source  The source to wrap

data/lib/pry/method/weird_method_locator.rb

@@ -123,7 +123,7 @@ class Pry
       # know which __FILE__ and __LINE__ the binding is at, we can hope to
       # disambiguate these cases.
       #
-      # This obviously won't work if the source is unavaiable for some reason,
+      # This obviously won't work if the source is unavailable for some reason,
       # or if both methods have the same __FILE__ and __LINE__.
       #
       # @return [Pry::Method, nil] The Pry::Method representing the
@@ -158,7 +158,7 @@ class Pry
 
         alias_name = all_methods_for(target_self).find do |v|
           location = target_self.method(v).source_location
-          expanded_source_location(location) == renamed_method_source_location
+          location && expanded_source_location(location) == renamed_method_source_location
         end
 
         alias_name && Pry::Method(target_self.method(alias_name))

data/lib/pry/method.rb

@@ -530,8 +530,9 @@ class Pry
       else
         fail_msg = "Cannot locate this method: #{name}."
         if Helpers::Platform.mri?
-          fail_msg += " Invoke the 'gem-install pry-doc' Pry command to get " \
-                      "access to Ruby Core documentation.\n"
+          fail_msg += " Run `gem install pry-doc` to install" \
+                      " Ruby Core documentation," \
+                      " and `require 'pry-doc'` to load it.\n"
         end
         raise CommandError, fail_msg
       end
@@ -563,8 +564,7 @@ class Pry
     def method_name_from_first_line(first_ln)
       return nil if first_ln.strip !~ /^def /
 
-      tokens = SyntaxHighlighter.tokenize(first_ln)
-      tokens = tokens.tokens.each_slice(2) if tokens.respond_to?(:tokens)
+      tokens = SyntaxHighlighter.tokenize(first_ln).each_slice(2)
       tokens.each_cons(2) do |t1, t2|
         if t2.last == :method || t2.last == :ident && t1 == [".", :operator]
           return t2.first

data/lib/pry/pry_class.rb

@@ -85,7 +85,7 @@ class Pry
   # Load the local RC file (./.pryrc)
   def self.rc_files_to_load
     files = []
-    files << Pry.config.rc_file if Pry.config.should_load_rc
+    files << Pry.config.rc_file if Pry.config.rc_file && Pry.config.should_load_rc
     files << LOCAL_RC_FILE if Pry.config.should_load_local_rc
     files.map { |file| real_path_to(file) }.compact.uniq
   end
@@ -161,6 +161,8 @@ you can add "Pry.config.windows_console_warning = false" to your pryrc.
 
     options = options.to_hash
 
+    options[:color] = false if Pry::Env['NO_COLOR']
+
     if in_critical_section?
       output.puts "ERROR: Pry started inside Pry."
       output.puts "This can happen if you have a binding.pry inside a #to_s " \
@@ -168,6 +170,12 @@ you can add "Pry.config.windows_console_warning = false" to your pryrc.
       return
     end
 
+    unless mutex_available?
+      output.puts "ERROR: Unable to obtain mutex lock."
+      output.puts "This can happen if binding.pry is called from a signal handler"
+      return
+    end
+
     options[:target] = Pry.binding_for(target || toplevel_binding)
     initial_session_setup
     final_session_setup
@@ -209,7 +217,7 @@ you can add "Pry.config.windows_console_warning = false" to your pryrc.
   #   The maximum number of chars before clipping occurs.
   #
   # @option options [Boolean] :id (false)
-  #   Boolean to indicate whether or not a hex reprsentation of the object ID
+  #   Boolean to indicate whether or not a hex representation of the object ID
   #   is attached to the return value when the length of inspect is greater than
   #   value of `:max_length`.
   #
@@ -378,6 +386,13 @@ Readline version #{Readline::VERSION} detected - will not auto_resize! correctly
   ensure
     Thread.current[:pry_critical_section] -= 1
   end
+
+  def self.mutex_available?
+    Mutex.new.synchronize { true }
+  rescue ThreadError
+    false
+  end
+  private_class_method :mutex_available?
 end
 
 Pry.init

data/lib/pry/pry_instance.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'method_source'
-require 'ostruct'
 
 ##
 # Pry is a powerful alternative to the standard IRB shell for Ruby. It
@@ -20,7 +19,7 @@ require 'ostruct'
 # This will show a list of available commands and their usage. For more
 # information about Pry you can refer to the following resources:
 #
-# * http://pryrepl.org/
+# * https://pry.github.io
 # * https://github.com/pry/pry
 # * the IRC channel, which is #pry on the Freenode network
 #
@@ -93,7 +92,6 @@ class Pry
     @input_ring << nil
     push_initial_binding(target)
     exec_hook(:when_started, target, options, self)
-    @prompt_warn = false
   end
 
   # This is the prompt at the top of the prompt stack.
@@ -388,7 +386,7 @@ class Pry
   # @param [*Object] args The arguments to pass to the hook
   # @return [Object, Exception] The return value of the hook or the exception raised
   #
-  # If executing a hook raises an exception, we log that and then continue sucessfully.
+  # If executing a hook raises an exception, we log that and then continue successfully.
   # To debug such errors, use the global variable $pry_hook_error, which is set as a
   # result.
   def exec_hook(name, *args, &block)
@@ -452,45 +450,17 @@ class Pry
   # @return [String] The prompt.
   def select_prompt
     object = current_binding.eval('self')
-    open_token = @indent.open_delimiters.last || @indent.stack.last
-
-    c = OpenStruct.new(
-      object: object,
-      nesting_level: binding_stack.size - 1,
-      open_token: open_token,
-      session_line: Pry.history.session_line_count + 1,
-      history_line: Pry.history.history_line_count + 1,
-      expr_number: input_ring.count,
-      pry_instance: self,
-      binding_stack: binding_stack,
-      input_ring: input_ring,
-      eval_string: @eval_string,
-      cont: !@eval_string.empty?
-    )
+    nesting_level = binding_stack.size - 1
+    pry_instance = self
 
     Pry.critical_section do
       # If input buffer is empty, then use normal prompt. Otherwise use the wait
       # prompt (indicating multi-line expression).
       if prompt.is_a?(Pry::Prompt)
         prompt_proc = eval_string.empty? ? prompt.wait_proc : prompt.incomplete_proc
-        return prompt_proc.call(c.object, c.nesting_level, c.pry_instance)
-      end
-
-      unless @prompt_warn
-        @prompt_warn = true
-        Kernel.warn(
-          "warning: setting prompt with help of " \
-          "`Pry.config.prompt = [proc {}, proc {}]` is deprecated. " \
-          "Use Pry::Prompt API instead"
-        )
-      end
-
-      # If input buffer is empty then use normal prompt
-      if eval_string.empty?
-        generate_prompt(Array(prompt).first, c)
-      # Otherwise use the wait prompt (indicating multi-line expression)
+        return prompt_proc.call(object, nesting_level, pry_instance)
       else
-        generate_prompt(Array(prompt).last, c)
+        output.puts "ERROR: Use Pry::Prompt API."
       end
     end
   end
@@ -549,7 +519,7 @@ class Pry
   # and a mistake in specifying that exception.
   #
   # (i.e. raise-up RunThymeError.new should not be the same as
-  #  raise-up NameError, "unititialized constant RunThymeError")
+  #  raise-up NameError, "uninitialized constant RunThymeError")
   #
   def raise_up_common(force, *args)
     exception = if args == []
@@ -685,14 +655,6 @@ class Pry
     end
   end
 
-  def generate_prompt(prompt_proc, conf)
-    if prompt_proc.arity == 1
-      prompt_proc.call(conf)
-    else
-      prompt_proc.call(conf.object, conf.nesting_level, conf.pry_instance)
-    end
-  end
-
   # the array that the prompt stack is stored in
   def prompt_stack
     @prompt_stack ||= []

data/lib/pry/repl.rb

@@ -100,7 +100,7 @@ class Pry
       # Return nil for EOF, :no_more_input for error, or :control_c for <Ctrl-C>
       return val unless val.is_a?(String)
 
-      if pry.config.auto_indent
+      if pry.config.auto_indent && !input_multiline?
         original_val = "#{indentation}#{val}"
         indented_val = @indent.indent(val)
 
@@ -141,8 +141,7 @@ class Pry
         retry
 
       # Handle <Ctrl+C> like Bash: empty the current input buffer, but don't
-      # quit.  This is only for MRI 1.9; other versions of Ruby don't let you
-      # send Interrupt from within Readline.
+      # quit.
       rescue Interrupt
         return :control_c
 
@@ -180,7 +179,31 @@ class Pry
           end
         end
 
-        if readline_available?
+        if reline_available?
+          Reline.output_modifier_proc = lambda do |text, _|
+            if pry.color
+              SyntaxHighlighter.highlight(text)
+            else
+              text
+            end
+          end
+
+          if pry.config.auto_indent
+            Reline.auto_indent_proc = lambda do |lines, line_index, _byte_ptr, _newline|
+              if line_index == 0
+                0
+              else
+                pry_indentation = Pry::Indent.new
+                pry_indentation.indent(lines.join("\n"))
+                pry_indentation.last_indent_level.length
+              end
+            end
+          end
+        end
+
+        if input_multiline?
+          input_readmultiline(current_prompt, false)
+        elsif readline_available?
           set_readline_output
           input_readline(current_prompt, false) # false since we'll add it manually
         elsif coolline_available?
@@ -193,12 +216,29 @@ class Pry
       end
     end
 
+    def input_readmultiline(*args)
+      Pry::InputLock.for(:all).interruptible_region do
+        input.readmultiline(*args) do |multiline_input|
+          Pry.commands.find_command(multiline_input) ||
+            (complete_expression?(multiline_input) && !Reline::IOGate.in_pasting?)
+        end
+      end
+    end
+
     def input_readline(*args)
       Pry::InputLock.for(:all).interruptible_region do
         input.readline(*args)
       end
     end
 
+    def input_multiline?
+      !!pry.config.multiline && reline_available?
+    end
+
+    def reline_available?
+      defined?(Reline) && input == Reline
+    end
+
     def readline_available?
       defined?(Readline) && input == Readline
     end
@@ -207,6 +247,13 @@ class Pry
       defined?(Coolline) && input.is_a?(Coolline)
     end
 
+    def prism_available?
+      require 'prism'
+
+      @prism_available ||= defined?(Prism) &&
+                           Gem::Version.new(Prism::VERSION) >= Gem::Version.new('0.25.0')
+    end
+
     # If `$stdout` is not a tty, it's probably a pipe.
     # @example
     #   # `piping?` returns `false`
@@ -228,6 +275,21 @@ class Pry
       @readline_output = (Readline.output = Pry.config.output) if piping?
     end
 
+    UNEXPECTED_TOKENS = %i[unexpected_token_ignore lambda_open].freeze
+
+    def complete_expression?(multiline_input)
+      if prism_available?
+        lex = Prism.lex(multiline_input)
+
+        errors = lex.errors
+        return true if errors.empty?
+
+        errors.any? { |error| UNEXPECTED_TOKENS.include?(error.type) }
+      else
+        Pry::Code.complete_expression?(multiline_input)
+      end
+    end
+
     # Calculates correct overhang for current line. Supports vi Readline
     # mode and its indicators such as "(ins)" or "(cmd)".
     #