pry 0.10.3 → 0.14.2

data/lib/pry/commands/edit/file_and_line_locator.rb

@@ -1,34 +1,45 @@
+# frozen_string_literal: true
+
 class Pry
-  class Command::Edit
-    module FileAndLineLocator
-      class << self
-        def from_binding(target)
-          [target.eval("__FILE__"), target.eval("__LINE__")]
-        end
+  class Command
+    class Edit
+      module FileAndLineLocator
+        class << self
+          def from_binding(target)
+            if target.respond_to?(:source_location)
+              target.source_location
+            else
+              target.eval("[__FILE__, __LINE__]")
+            end
+          end
+
+          def from_code_object(code_object, filename_argument)
+            unless File.exist?(code_object.source_file.to_s)
+              raise CommandError, "Cannot find a file for #{filename_argument}!"
+            end
 
-        def from_code_object(code_object, filename_argument)
-          if File.exists?(code_object.source_file.to_s)
             [code_object.source_file, code_object.source_line]
-          else
-            raise CommandError, "Cannot find a file for #{filename_argument}!"
           end
-        end
 
-        def from_exception(exception, backtrace_level)
-          raise CommandError, "No exception found." if exception.nil?
+          def from_exception(exception, backtrace_level)
+            raise CommandError, "No exception found." if exception.nil?
 
-          file_name, line = exception.bt_source_location_for(backtrace_level)
-          raise CommandError, "Exception has no associated file." if file_name.nil?
-          raise CommandError, "Cannot edit exceptions raised in REPL." if Pry.eval_path == file_name
+            file_name, line = exception.bt_source_location_for(backtrace_level)
+            raise CommandError, "Exception has no associated file." if file_name.nil?
 
-          [file_name, line]
-        end
+            if Pry.eval_path == file_name
+              raise CommandError, "Cannot edit exceptions raised in REPL."
+            end
+
+            [file_name, line]
+          end
 
-        # when file and line are passed as a single arg, e.g my_file.rb:30
-        def from_filename_argument(filename_argument)
-          f = File.expand_path(filename_argument)
-          l = f.sub!(/:(\d+)$/, "") ? $1.to_i : 1
-          [f, l]
+          # when file and line are passed as a single arg, e.g my_file.rb:30
+          def from_filename_argument(filename_argument)
+            f = File.expand_path(filename_argument)
+            l = f.sub!(/:(\d+)$/, "") ? Regexp.last_match(1).to_i : 1
+            [f, l]
+          end
         end
       end
     end

data/lib/pry/commands/edit.rb

@@ -1,195 +1,223 @@
-class Pry
-  class Command::Edit < Pry::ClassCommand
-    require 'pry/commands/edit/exception_patcher'
-    require 'pry/commands/edit/file_and_line_locator'
-
-    match 'edit'
-    group 'Editing'
-    description 'Invoke the default editor on a file.'
-
-    banner <<-'BANNER'
-      Usage: edit [--no-reload|--reload|--patch] [--line LINE] [--temp|--ex|FILE[:LINE]|OBJECT|--in N]
-
-      Open a text editor. When no FILE is given, edits the pry input buffer.
-      When a method/module/command is given, the code is opened in an editor.
-      Ensure `Pry.config.editor` or `_pry_.config.editor` is set to your editor of choice.
-
-      edit sample.rb                edit -p MyClass#my_method
-      edit sample.rb --line 105     edit MyClass
-      edit MyClass#my_method        edit --ex
-      edit --method                 edit --ex -p
-
-      https://github.com/pry/pry/wiki/Editor-integration#wiki-Edit_command
-    BANNER
-
-    def options(opt)
-      opt.on :e, :ex,      "Open the file that raised the most recent exception (_ex_.file)",
-                           :optional_argument => true, :as => Integer
-      opt.on :i, :in,      "Open a temporary file containing the Nth input expression. N may be a range",
-                           :optional_argument => true, :as => Range, :default => -1..-1
-      opt.on :t, :temp,    "Open an empty temporary file"
-      opt.on :l, :line,    "Jump to this line in the opened file",
-                           :argument => true, :as => Integer
-      opt.on :n, :"no-reload", "Don't automatically reload the edited file"
-      opt.on :c, :current, "Open the current __FILE__ and at __LINE__ (as returned by `whereami`)"
-      opt.on :r, :reload,  "Reload the edited code immediately (default for ruby files)"
-      opt.on :p, :patch,   "Instead of editing the object's file, try to edit in a tempfile and apply as a monkey patch"
-      opt.on :m, :method,  "Explicitly edit the _current_ method (when inside a method context)."
-    end
+# frozen_string_literal: true
 
-    def process
-      if bad_option_combination?
-        raise CommandError, "Only one of --ex, --temp, --in, --method and FILE may be specified."
+class Pry
+  class Command
+    class Edit < Pry::ClassCommand
+      match 'edit'
+      group 'Editing'
+      description 'Invoke the default editor on a file.'
+
+      banner <<-'BANNER'
+        Usage: edit [--no-reload|--reload|--patch] [--line LINE] [--temp|--ex|FILE[:LINE]|OBJECT|--in N]
+
+        Open a text editor. When no FILE is given, edits the pry input buffer.
+        When a method/module/command is given, the code is opened in an editor.
+        Ensure `Pry.config.editor` or `pry_instance.config.editor` is set to your editor of choice.
+
+        edit sample.rb                edit -p MyClass#my_method
+        edit sample.rb --line 105     edit MyClass
+        edit MyClass#my_method        edit --ex
+        edit --method                 edit --ex -p
+
+        https://github.com/pry/pry/wiki/Editor-integration#wiki-Edit_command
+      BANNER
+
+      def options(opt)
+        opt.on :e, :ex, "Open the file that raised the most recent exception " \
+                        "(_ex_.file)",
+               optional_argument: true, as: Integer
+        opt.on :i, :in, "Open a temporary file containing the Nth input " \
+                        "expression. N may be a range",
+               optional_argument: true, as: Range, default: -1..-1
+        opt.on :t, :temp, "Open an empty temporary file"
+        opt.on :l, :line, "Jump to this line in the opened file",
+               argument: true, as: Integer
+        opt.on :n, :"no-reload", "Don't automatically reload the edited file"
+        opt.on :c, :current, "Open the current __FILE__ and at __LINE__ (as " \
+                             "returned by `whereami`)"
+        opt.on :r, :reload, "Reload the edited code immediately (default for " \
+                            "ruby files)"
+        opt.on :p, :patch, "Instead of editing the object's file, try to edit " \
+                           "in a tempfile and apply as a monkey patch"
+        opt.on :m, :method, "Explicitly edit the _current_ method (when " \
+                            "inside a method context)."
       end
 
-      if repl_edit?
-        # code defined in pry, eval'd within pry.
-        repl_edit
-      elsif runtime_patch?
-        # patch code without persisting changes
-        apply_runtime_patch
-      else
-        # code stored in actual files, eval'd at top-level
-        file_edit
+      def process
+        if bad_option_combination?
+          raise CommandError, "Only one of --ex, --temp, --in, --method and " \
+                              "FILE may be specified."
+        end
+
+        if repl_edit?
+          # code defined in pry, eval'd within pry.
+          repl_edit
+        elsif runtime_patch?
+          # patch code without persisting changes, implies future changes are patches
+          apply_runtime_patch
+        else
+          # code stored in actual files, eval'd at top-level
+          file_edit
+        end
       end
-    end
 
-    def repl_edit?
-      !opts.present?(:ex) && !opts.present?(:current) && !opts.present?(:method) &&
-        filename_argument.empty?
-    end
+      def repl_edit?
+        !opts.present?(:ex) && !opts.present?(:current) && !opts.present?(:method) &&
+          filename_argument.empty?
+      end
 
-    def repl_edit
-      content = Pry::Editor.new(_pry_).edit_tempfile_with_content(initial_temp_file_content,
-                                                       initial_temp_file_content.lines.count)
-      silence_warnings do
-        eval_string.replace content
+      def repl_edit
+        content = Pry::Editor.new(pry_instance).edit_tempfile_with_content(
+          initial_temp_file_content,
+          initial_temp_file_content.lines.count
+        )
+        pry_instance.eval_string = content
+        Pry.history.push(content)
       end
-    end
 
-    def file_based_exception?
-      opts.present?(:ex) && !opts.present?(:patch)
-    end
+      def file_based_exception?
+        opts.present?(:ex) && !opts.present?(:patch)
+      end
 
-    def runtime_patch?
-       !file_based_exception? && (opts.present?(:patch) || pry_method?(code_object))
-    end
+      def runtime_patch?
+        !file_based_exception? &&
+          (opts.present?(:patch) ||
+           previously_patched?(code_object) ||
+           pry_method?(code_object))
+      end
 
-    def apply_runtime_patch
-      if patch_exception?
-        ExceptionPatcher.new(_pry_, state, file_and_line_for_current_exception).perform_patch
-      else
-        if code_object.is_a?(Pry::Method)
-          code_object.redefine Pry::Editor.new(_pry_).edit_tempfile_with_content(code_object.source)
+      def apply_runtime_patch
+        if patch_exception?
+          ExceptionPatcher.new(
+            pry_instance, state, file_and_line_for_current_exception
+          ).perform_patch
+        elsif code_object.is_a?(Pry::Method)
+          code_object.redefine(
+            Pry::Editor.new(pry_instance).edit_tempfile_with_content(
+              code_object.source
+            )
+          )
         else
           raise NotImplementedError, "Cannot yet patch #{code_object} objects!"
         end
       end
-    end
 
-    def ensure_file_name_is_valid(file_name)
-      raise CommandError, "Cannot find a valid file for #{filename_argument}" if !file_name
-      raise CommandError, "#{file_name} is not a valid file name, cannot edit!" if not_a_real_file?(file_name)
-    end
+      def ensure_file_name_is_valid(file_name)
+        unless file_name
+          raise CommandError, "Cannot find a valid file for #{filename_argument}"
+        end
 
-    def file_and_line_for_current_exception
-      FileAndLineLocator.from_exception(_pry_.last_exception, opts[:ex].to_i)
-    end
+        return unless not_a_real_file?(file_name)
 
-    def file_and_line
-      file_name, line = if opts.present?(:current)
-                          FileAndLineLocator.from_binding(target)
-                        elsif opts.present?(:ex)
-                          file_and_line_for_current_exception
-                        elsif code_object
-                          FileAndLineLocator.from_code_object(code_object, filename_argument)
-                        else
-                          # when file and line are passed as a single arg, e.g my_file.rb:30
-                          FileAndLineLocator.from_filename_argument(filename_argument)
-                        end
-
-      [file_name, opts.present?(:line) ? opts[:l].to_i : line]
-    end
+        raise CommandError, "#{file_name} is not a valid file name, cannot edit!"
+      end
 
-    def file_edit
-      file_name, line = file_and_line
+      def file_and_line_for_current_exception
+        FileAndLineLocator.from_exception(pry_instance.last_exception, opts[:ex].to_i)
+      end
+
+      def file_and_line
+        file_name, line =
+          if opts.present?(:current)
+            FileAndLineLocator.from_binding(target)
+          elsif opts.present?(:ex)
+            file_and_line_for_current_exception
+          elsif code_object
+            FileAndLineLocator.from_code_object(code_object, filename_argument)
+          else
+            # when file and line are passed as a single arg, e.g my_file.rb:30
+            FileAndLineLocator.from_filename_argument(filename_argument)
+          end
+
+        [file_name, opts.present?(:line) ? opts[:l].to_i : line]
+      end
 
-      ensure_file_name_is_valid(file_name)
+      def file_edit
+        file_name, line = file_and_line
 
-      Pry::Editor.new(_pry_).invoke_editor(file_name, line, reload?(file_name))
-      set_file_and_dir_locals(file_name)
+        ensure_file_name_is_valid(file_name)
 
-      if reload?(file_name)
-        silence_warnings do
-          load file_name
-        end
+        Pry::Editor.new(pry_instance).invoke_editor(file_name, line, reload?(file_name))
+        set_file_and_dir_locals(file_name)
+
+        return unless reload?(file_name)
+
+        silence_warnings { load(file_name) }
       end
-    end
 
-    def filename_argument
-      args.join(' ')
-    end
+      def filename_argument
+        args.join(' ')
+      end
 
-    def code_object
-      @code_object ||= !probably_a_file?(filename_argument) &&
-        Pry::CodeObject.lookup(filename_argument, _pry_)
-    end
+      def code_object
+        @code_object ||=
+          !probably_a_file?(filename_argument) &&
+          Pry::CodeObject.lookup(filename_argument, pry_instance)
+      end
 
-    def pry_method?(code_object)
-      code_object.is_a?(Pry::Method) &&
-        code_object.pry_method?
-    end
+      def pry_method?(code_object)
+        code_object.is_a?(Pry::Method) &&
+          code_object.pry_method?
+      end
 
-    def patch_exception?
-      opts.present?(:ex) && opts.present?(:patch)
-    end
+      def previously_patched?(code_object)
+        code_object.is_a?(Pry::Method) &&
+          Pry::Method::Patcher.code_for(code_object.source_location.first)
+      end
 
-    def bad_option_combination?
-      [opts.present?(:ex), opts.present?(:temp),
-       opts.present?(:in), opts.present?(:method), !filename_argument.empty?].count(true) > 1
-    end
+      def patch_exception?
+        opts.present?(:ex) && opts.present?(:patch)
+      end
 
-    def input_expression
-      case opts[:i]
-      when Range
-        (_pry_.input_array[opts[:i]] || []).join
-      when Fixnum
-        _pry_.input_array[opts[:i]] || ""
-      else
-        raise Pry::CommandError, "Not a valid range: #{opts[:i]}"
+      def bad_option_combination?
+        [
+          opts.present?(:ex), opts.present?(:temp),
+          opts.present?(:in), opts.present?(:method),
+          !filename_argument.empty?
+        ].count(true) > 1
       end
-    end
 
-    def reloadable?
-      opts.present?(:reload) || opts.present?(:ex)
-    end
+      def input_expression
+        case opts[:i]
+        when Range
+          (pry_instance.input_ring[opts[:i]] || []).join
+        when Integer
+          pry_instance.input_ring[opts[:i]] || ""
+        else
+          raise Pry::CommandError, "Not a valid range: #{opts[:i]}"
+        end
+      end
 
-    def never_reload?
-      opts.present?(:'no-reload') || _pry_.config.disable_auto_reload
-    end
+      def reloadable?
+        opts.present?(:reload) || opts.present?(:ex)
+      end
 
-    def reload?(file_name="")
-      (reloadable? || file_name.end_with?(".rb")) && !never_reload?
-    end
+      def never_reload?
+        opts.present?(:'no-reload') || pry_instance.config.disable_auto_reload
+      end
 
-    def initial_temp_file_content
-      case
-      when opts.present?(:temp)
-        ""
-      when opts.present?(:in)
-        input_expression
-      when eval_string.strip != ""
-        eval_string
-      else
-        _pry_.input_array.reverse_each.find { |x| x && x.strip != "" } || ""
+      def reload?(file_name = "")
+        (reloadable? || file_name.end_with?(".rb")) && !never_reload?
       end
-    end
 
-    def probably_a_file?(str)
-      [".rb", ".c", ".py", ".yml", ".gemspec"].include?(File.extname(str)) ||
-        str =~ /\/|\\/
+      def initial_temp_file_content
+        if opts.present?(:temp)
+          ""
+        elsif opts.present?(:in)
+          input_expression
+        elsif eval_string.strip != ""
+          eval_string
+        else
+          pry_instance.input_ring.to_a.reverse_each.find { |x| x && x.strip != "" } || ""
+        end
+      end
+
+      def probably_a_file?(str)
+        [".rb", ".c", ".py", ".yml", ".gemspec"].include?(File.extname(str)) ||
+          str =~ %r{/|\\}
+      end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::Edit)
+    Pry::Commands.add_command(Pry::Command::Edit)
+  end
 end

data/lib/pry/commands/exit.rb

@@ -1,42 +1,47 @@
+# frozen_string_literal: true
+
 class Pry
-  class Command::Exit < Pry::ClassCommand
-    match 'exit'
-    group 'Navigating Pry'
-    description 'Pop the previous binding.'
-    command_options :keep_retval => true
-
-    banner <<-'BANNER'
-      Usage:   exit [OPTIONS] [--help]
-      Aliases: quit
-
-      Pop the previous binding (does NOT exit program). It can be useful to exit a
-      context with a user-provided value. For instance an exit value can be used to
-      determine program flow.
-
-      exit "pry this"
-      exit
-
-      https://github.com/pry/pry/wiki/State-navigation#wiki-Exit_with_value
-    BANNER
-
-    def process
-      if _pry_.binding_stack.one?
-        _pry_.run_command "exit-all #{arg_string}"
-      else
-        # otherwise just pop a binding and return user supplied value
-        process_pop_and_return
+  class Command
+    class Exit < Pry::ClassCommand
+      match 'exit'
+      group 'Navigating Pry'
+      description 'Pop the previous binding.'
+      command_options keep_retval: true
+
+      banner <<-'BANNER'
+        Usage:   exit [OPTIONS] [--help]
+        Aliases: quit
+
+        Pop the previous binding (does NOT exit program). It can be useful to exit a
+        context with a user-provided value. For instance an exit value can be used to
+        determine program flow.
+
+        exit "pry this"
+        exit
+
+        https://github.com/pry/pry/wiki/State-navigation#wiki-Exit_with_value
+      BANNER
+
+      def process
+        if pry_instance.binding_stack.one?
+          pry_instance.run_command "exit-all #{arg_string}"
+        else
+          # otherwise just pop a binding and return user supplied value
+          process_pop_and_return
+        end
       end
-    end
 
-    def process_pop_and_return
-      popped_object = _pry_.binding_stack.pop.eval('self')
+      def process_pop_and_return
+        popped_object = pry_instance.binding_stack.pop.eval('self')
+
+        # return a user-specified value if given otherwise return the object
+        return target.eval(arg_string) unless arg_string.empty?
 
-      # return a user-specified value if given otherwise return the object
-      return target.eval(arg_string) unless arg_string.empty?
-      popped_object
+        popped_object
+      end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::Exit)
-  Pry::Commands.alias_command 'quit', 'exit'
+    Pry::Commands.add_command(Pry::Command::Exit)
+    Pry::Commands.alias_command 'quit', 'exit'
+  end
 end

data/lib/pry/commands/exit_all.rb

@@ -1,29 +1,33 @@
+# frozen_string_literal: true
+
 class Pry
-  class Command::ExitAll < Pry::ClassCommand
-    match 'exit-all'
-    group 'Navigating Pry'
-    description 'End the current Pry session.'
+  class Command
+    class ExitAll < Pry::ClassCommand
+      match 'exit-all'
+      group 'Navigating Pry'
+      description 'End the current Pry session.'
 
-    banner <<-'BANNER'
-      Usage:   exit-all [--help]
-      Aliases: !!@
+      banner <<-'BANNER'
+        Usage:   exit-all [--help]
+        Aliases: !!@
 
-      End the current Pry session (popping all bindings and returning to caller).
-      Accepts optional return value.
-    BANNER
+        End the current Pry session (popping all bindings and returning to caller).
+        Accepts optional return value.
+      BANNER
 
-    def process
-      # calculate user-given value
-      exit_value = target.eval(arg_string)
+      def process
+        # calculate user-given value
+        exit_value = target.eval(arg_string)
 
-      # clear the binding stack
-      _pry_.binding_stack.clear
+        # clear the binding stack
+        pry_instance.binding_stack.clear
 
-      # break out of the repl loop
-      throw(:breakout, exit_value)
+        # break out of the repl loop
+        throw(:breakout, exit_value)
+      end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::ExitAll)
-  Pry::Commands.alias_command '!!@', 'exit-all'
+    Pry::Commands.add_command(Pry::Command::ExitAll)
+    Pry::Commands.alias_command '!!@', 'exit-all'
+  end
 end

data/lib/pry/commands/exit_program.rb

@@ -1,23 +1,27 @@
+# frozen_string_literal: true
+
 class Pry
-  class Command::ExitProgram < Pry::ClassCommand
-    match 'exit-program'
-    group 'Navigating Pry'
-    description 'End the current program.'
+  class Command
+    class ExitProgram < Pry::ClassCommand
+      match 'exit-program'
+      group 'Navigating Pry'
+      description 'End the current program.'
 
-    banner <<-'BANNER'
-      Usage:   exit-program [--help]
-      Aliases: quit-program
-               !!!
+      banner <<-'BANNER'
+        Usage:   exit-program [--help]
+        Aliases: quit-program
+                 !!!
 
-      End the current program.
-    BANNER
+        End the current program.
+      BANNER
 
-    def process
-      Kernel.exit target.eval(arg_string).to_i
+      def process
+        Kernel.exit target.eval(arg_string).to_i
+      end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::ExitProgram)
-  Pry::Commands.alias_command 'quit-program', 'exit-program'
-  Pry::Commands.alias_command '!!!', 'exit-program'
+    Pry::Commands.add_command(Pry::Command::ExitProgram)
+    Pry::Commands.alias_command 'quit-program', 'exit-program'
+    Pry::Commands.alias_command '!!!', 'exit-program'
+  end
 end