pry 0.9.12.2 → 0.14.2

data/lib/pry/commands/play.rb

@@ -1,69 +1,113 @@
+# frozen_string_literal: true
+
 class Pry
-  class Command::Play < Pry::ClassCommand
-    match 'play'
-    group 'Editing'
-    description 'Playback a string variable or a method or a file as input.'
+  class Command
+    class Play < Pry::ClassCommand
+      match 'play'
+      group 'Editing'
+      description 'Playback a string variable, method, line, or file as input.'
 
-    banner <<-'BANNER'
-      Usage: play [OPTIONS] [--help]
+      banner <<-'BANNER'
+        Usage: play [OPTIONS] [--help]
 
-      The play command enables you to replay code from files and methods as if they
-      were entered directly in the Pry REPL.
+        The play command enables you to replay code from files and methods as if they
+        were entered directly in the Pry REPL.
 
-      play --lines 149..153
-      play -i 20 --lines 1..3
-      play Pry#repl --lines 1..-1
-      play Rakefile --lines 5
+        play --lines 149..153   # assumes current context
+        play -i 20 --lines 1..3 # assumes lines of the input expression at 20
+        play -o 4               # the output of an expression at 4
+        play Pry#repl -l 1..-1  # play the contents of Pry#repl method
+        play -e 2               # play from specified line until end of valid expression
+        play hello.rb           # play a file
+        play Rakefile -l 5      # play line 5 of a file
+        play -d hi              # play documentation of hi method
+        play hi --open          # play hi method and leave it open
 
-      https://github.com/pry/pry/wiki/User-Input#wiki-Play
-    BANNER
+        https://github.com/pry/pry/wiki/User-Input#wiki-Play
+      BANNER
 
-    def options(opt)
-      CodeCollector.inject_options(opt)
+      def options(opt)
+        CodeCollector.inject_options(opt)
 
-      opt.on :open, 'Plays the select content except except' \
-                    ' the last line. Useful for replaying methods and leaving the method definition "open". `amend-line`' \
-                    ' can then be used to modify the method.'
-    end
+        opt.on :open, 'Plays the selected content except the last line. Useful' \
+                      ' for replaying methods and leaving the method definition' \
+                      ' "open". `amend-line` can then be used to' \
+                      ' modify the method.'
 
-    def process
-      @cc = CodeCollector.new(args, opts, _pry_)
+        opt.on :e, :expression=, 'Executes until end of valid expression', as: Integer
+        opt.on :p, :print, 'Prints executed code'
+      end
 
-      perform_play
-      run "show-input" unless Pry::Code.complete_expression?(eval_string)
-    end
+      def process
+        @cc = CodeCollector.new(args, opts, pry_instance)
 
-    def perform_play
-      eval_string << (opts.present?(:open) ? restrict_to_lines(content, (0..-2)) : content)
-      run "fix-indent"
-    end
+        perform_play
+        show_input
+      end
 
-    def should_use_default_file?
-      !args.first && !opts.present?(:in) && !opts.present?(:out)
-    end
+      def perform_play
+        eval_string << content_after_options
+        run "fix-indent"
+      end
+
+      def show_input
+        return unless opts.present?(:print)
+        return unless Pry::Code.complete_expression?(eval_string)
 
-    def content
-      if should_use_default_file?
-        file_content
-      else
-        @cc.content
+        run 'show-input'
       end
-    end
 
-    # The file to play from when no code object is specified.
-    # e.g `play --lines 4..10`
-    def default_file
-      target.eval("__FILE__") && File.expand_path(target.eval("__FILE__"))
-    end
+      def content_after_options
+        if opts.present?(:open)
+          restrict_to_lines(content, (0..-2))
+        elsif opts.present?(:expression)
+          content_at_expression
+        else
+          content
+        end
+      end
+
+      def content_at_expression
+        code_object.expression_at(opts[:expression])
+      end
+
+      def code_object
+        Pry::Code.new(content)
+      end
+
+      def should_use_default_file?
+        !args.first && !opts.present?(:in) && !opts.present?(:out)
+      end
+
+      def content
+        if should_use_default_file?
+          file_content
+        else
+          @cc.content
+        end
+      end
+
+      # The file to play from when no code object is specified.
+      # e.g `play --lines 4..10`
+      def default_file
+        file =
+          if target.respond_to?(:source_location)
+            target.source_location.first
+          else
+            target.eval("__FILE__")
+          end
+        file && File.expand_path(file)
+      end
+
+      def file_content
+        if !default_file || !File.exist?(default_file)
+          raise CommandError, "File does not exist! File was: #{default_file.inspect}"
+        end
 
-    def file_content
-      if default_file && File.exists?(default_file)
         @cc.restrict_to_lines(File.read(default_file), @cc.line_range)
-      else
-        raise CommandError, "File does not exist! File was: #{default_file.inspect}"
       end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::Play)
+    Pry::Commands.add_command(Pry::Command::Play)
+  end
 end

data/lib/pry/commands/pry_backtrace.rb

@@ -1,26 +1,30 @@
+# frozen_string_literal: true
+
 class Pry
-  class Command::PryBacktrace < Pry::ClassCommand
-    match 'pry-backtrace'
-    group 'Context'
-    description 'Show the backtrace for the Pry session.'
+  class Command
+    class PryBacktrace < Pry::ClassCommand
+      match 'pry-backtrace'
+      group 'Context'
+      description 'Show the backtrace for the Pry session.'
 
-    banner <<-BANNER
-      Usage: pry-backtrace [OPTIONS] [--help]
+      banner <<-BANNER
+        Usage: pry-backtrace [OPTIONS] [--help]
 
-      Show the backtrace for the position in the code where Pry was started. This can
-      be used to infer the behavior of the program immediately before it entered Pry,
-      just like the backtrace property of an exception.
+        Show the backtrace for the position in the code where Pry was started. This can
+        be used to infer the behavior of the program immediately before it entered Pry,
+        just like the backtrace property of an exception.
 
-      NOTE: if you are looking for the backtrace of the most recent exception raised,
-      just type: `_ex_.backtrace` instead.
-      See: https://github.com/pry/pry/wiki/Special-Locals
-    BANNER
+        NOTE: if you are looking for the backtrace of the most recent exception raised,
+        just type: `_ex_.backtrace` instead.
+        See: https://github.com/pry/pry/wiki/Special-Locals
+      BANNER
 
-    def process
-      stagger_output text.bold('Backtrace:') +
-        "\n--\n" + _pry_.backtrace.join("\n")
+      def process
+        text = "#{bold('Backtrace:')}\n--\n#{pry_instance.backtrace.join("\n")}"
+        pry_instance.pager.page(text)
+      end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::PryBacktrace)
+    Pry::Commands.add_command(Pry::Command::PryBacktrace)
+  end
 end

data/lib/pry/commands/pry_version.rb

@@ -1,17 +1,21 @@
+# frozen_string_literal: true
+
 class Pry
-  class Command::Version < Pry::ClassCommand
-    match 'pry-version'
-    group 'Misc'
-    description 'Show Pry version.'
+  class Command
+    class Version < Pry::ClassCommand
+      match 'pry-version'
+      group 'Misc'
+      description 'Show Pry version.'
 
-    banner <<-'BANNER'
-      Show Pry version.
-    BANNER
+      banner <<-'BANNER'
+        Show Pry version.
+      BANNER
 
-    def process
-      output.puts "Pry version: #{Pry::VERSION} on Ruby #{RUBY_VERSION}."
+      def process
+        output.puts "Pry version: #{Pry::VERSION} on Ruby #{RUBY_VERSION}."
+      end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::Version)
+    Pry::Commands.add_command(Pry::Command::Version)
+  end
 end

data/lib/pry/commands/raise_up.rb

@@ -1,32 +1,38 @@
+# frozen_string_literal: true
+
 class Pry
   # N.B. using a regular expresion here so that "raise-up 'foo'" does the right thing.
-  class Command::RaiseUp < Pry::ClassCommand
-    match /raise-up(!?\b.*)/
-    group 'Context'
-    description 'Raise an exception out of the current pry instance.'
-    command_options :listing => 'raise-up'
-
-    banner <<-BANNER
-      Raise up, like exit, allows you to quit pry. Instead of returning a value
-      however, it raises an exception. If you don't provide the exception to be
-      raised, it will use the most recent exception (in pry `_ex_`).
-
-      When called as raise-up! (with an exclamation mark), this command raises the
-      exception through any nested prys you have created by "cd"ing into objects.
-
-      raise-up "get-me-out-of-here"
-
-      # This is equivalent to the command above.
-      raise "get-me-out-of-here"
-      raise-up
-    BANNER
-
-    def process
-      return stagger_output help if captures[0] =~ /(-h|--help)\b/
-      # Handle 'raise-up', 'raise-up "foo"', 'raise-up RuntimeError, 'farble' in a rubyesque manner
-      target.eval("_pry_.raise_up#{captures[0]}")
+  class Command
+    class RaiseUp < Pry::ClassCommand
+      match(/raise-up(!?\b.*)/)
+      group 'Context'
+      description 'Raise an exception out of the current pry instance.'
+      command_options listing: 'raise-up'
+
+      banner <<-BANNER
+        Raise up, like exit, allows you to quit pry. Instead of returning a value
+        however, it raises an exception. If you don't provide the exception to be
+        raised, it will use the most recent exception (in pry `_ex_`).
+
+        When called as raise-up! (with an exclamation mark), this command raises the
+        exception through any nested prys you have created by "cd"ing into objects.
+
+        raise-up "get-me-out-of-here"
+
+        # This is equivalent to the command above.
+        raise "get-me-out-of-here"
+        raise-up
+      BANNER
+
+      def process
+        return _pry.pager.page help if captures[0] =~ /(-h|--help)\b/
+
+        # Handle 'raise-up', 'raise-up "foo"', 'raise-up RuntimeError, 'farble'
+        # in a rubyesque manner
+        target.eval("pry_instance.raise_up#{captures[0]}")
+      end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::RaiseUp)
+    Pry::Commands.add_command(Pry::Command::RaiseUp)
+  end
 end

data/lib/pry/commands/reload_code.rb

@@ -1,65 +1,74 @@
-class Pry
-  class Command::ReloadCode < Pry::ClassCommand
-    match 'reload-code'
-    group 'Misc'
-    description 'Reload the source file that contains the specified code object.'
+# frozen_string_literal: true
 
-    banner <<-'BANNER'
-      Reload the source file that contains the specified code object.
+class Pry
+  class Command
+    class ReloadCode < Pry::ClassCommand
+      match 'reload-code'
+      group 'Misc'
+      description 'Reload the source file that contains the specified code object.'
 
-      e.g reload-code MyClass#my_method    #=> reload a method
-          reload-code MyClass              #=> reload a class
-          reload-code my-command           #=> reload a pry command
-          reload-code self                 #=> reload the 'current' object
-          reload-code                      #=> identical to reload-code self
-    BANNER
+      banner <<-'BANNER'
+        Reload the source file that contains the specified code object.
 
-    def process
+        e.g reload-code MyClass#my_method    #=> reload a method
+            reload-code MyClass              #=> reload a class
+            reload-code my-command           #=> reload a pry command
+            reload-code self                 #=> reload the current object
+            reload-code                      #=> reload the current file or object
+      BANNER
 
-      if obj_name.empty?
-        # if no parameters were provided then try to reload the
-        # current file (i.e target.eval("__FILE__"))
-        reload_current_file
-      else
-        code_object = Pry::CodeObject.lookup(obj_name, _pry_)
-        reload_code_object(code_object)
+      def process
+        if !args.empty?
+          reload_object(args.join(" "))
+        elsif internal_binding?(target)
+          reload_object("self")
+        else
+          reload_current_file
+        end
       end
-    end
 
-    private
+      private
 
-    def current_file
-      File.expand_path target.eval("__FILE__")
-    end
+      def current_file
+        file =
+          if target.respond_to?(:source_location)
+            target.source_location.first
+          else
+            target.eval("__FILE__")
+          end
+        File.expand_path file
+      end
+
+      def reload_current_file
+        unless File.exist?(current_file)
+          raise CommandError, "Current file: #{current_file} cannot be found on disk!"
+        end
 
-    def reload_current_file
-      if !File.exists?(current_file)
-        raise CommandError, "Current file: #{current_file} cannot be found on disk!"
+        load current_file
+        output.puts "The current file: #{current_file} was reloaded!"
       end
 
-      load current_file
-      output.puts "The current file: #{current_file} was reloaded!"
-    end
+      def reload_object(identifier)
+        code_object = Pry::CodeObject.lookup(identifier, pry_instance)
+        check_for_reloadability(code_object, identifier)
+        load code_object.source_file
+        output.puts "#{identifier} was reloaded!"
+      end
 
-    def reload_code_object(code_object)
-      check_for_reloadability(code_object)
-      load code_object.source_file
-      output.puts "#{obj_name} was reloaded!"
-    end
+      def check_for_reloadability(code_object, identifier)
+        if !code_object || !code_object.source_file
+          raise CommandError, "Cannot locate #{identifier}!"
+        end
 
-    def obj_name
-      @obj_name ||= args.join(" ")
-    end
+        return if File.exist?(code_object.source_file)
 
-    def check_for_reloadability(code_object)
-      if !code_object || !code_object.source_file
-        raise CommandError, "Cannot locate #{obj_name}!"
-      elsif !File.exists?(code_object.source_file)
-        raise CommandError, "Cannot reload #{obj_name} as it has no associated file on disk. File found was: #{code_object.source_file}"
+        raise CommandError,
+              "Cannot reload #{identifier} as it has no associated file on disk. " \
+              "File found was: #{code_object.source_file}"
       end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::ReloadCode)
-  Pry::Commands.alias_command 'reload-method', 'reload-code'
+    Pry::Commands.add_command(Pry::Command::ReloadCode)
+    Pry::Commands.alias_command 'reload-method', 'reload-code'
+  end
 end

data/lib/pry/commands/reset.rb

@@ -1,18 +1,22 @@
+# frozen_string_literal: true
+
 class Pry
-  class Command::Reset < Pry::ClassCommand
-    match 'reset'
-    group 'Context'
-    description 'Reset the REPL to a clean state.'
+  class Command
+    class Reset < Pry::ClassCommand
+      match 'reset'
+      group 'Context'
+      description 'Reset the REPL to a clean state.'
 
-    banner <<-'BANNER'
-      Reset the REPL to a clean state.
-    BANNER
+      banner <<-'BANNER'
+        Reset the REPL to a clean state.
+      BANNER
 
-    def process
-      output.puts 'Pry reset.'
-      exec 'pry'
+      def process
+        output.puts 'Pry reset.'
+        exec 'pry'
+      end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::Reset)
+    Pry::Commands.add_command(Pry::Command::Reset)
+  end
 end

data/lib/pry/commands/ri.rb

@@ -1,56 +1,75 @@
+# frozen_string_literal: true
+
+require 'stringio'
+
 class Pry
-  class Command::Ri < Pry::ClassCommand
-    match 'ri'
-    group 'Introspection'
-    description 'View ri documentation.'
+  class Command
+    class Ri < Pry::ClassCommand
+      match 'ri'
+      group 'Introspection'
+      description 'View ri documentation.'
 
-    banner <<-'BANNER'
-      Usage: ri [spec]
+      banner <<-'BANNER'
+        Usage: ri [spec]
 
-      View ri documentation. Relies on the "rdoc" gem being installed.
-      See also "show-doc" command.
+        View ri documentation. Relies on the "rdoc" gem being installed.
+        See also "show-doc" command.
 
-      ri Array#each
-    BANNER
+        ri Array#each
+      BANNER
 
-    def process(spec)
-      # Lazily load RI
-      require 'rdoc/ri/driver'
+      def process(spec)
+        unless spec
+          return output.puts(
+            "Please provide a class, module, or method name (e.g: ri Array#push)"
+          )
+        end
 
-      unless defined? RDoc::RI::PryDriver
+        # Lazily load RI
+        require 'rdoc/ri/driver'
 
-        # Subclass RI so that it formats its output nicely, and uses `lesspipe`.
-        subclass = Class.new(RDoc::RI::Driver) # the hard way.
+        unless defined? RDoc::RI::PryDriver
 
-        subclass.class_eval do
-          def page
-            paging_text = StringIO.new
-            yield paging_text
-            Pry::Pager.page(paging_text.string)
-          end
+          # Subclass RI so that it formats its output nicely, and uses `lesspipe`.
+          subclass = Class.new(RDoc::RI::Driver) # the hard way.
+
+          subclass.class_eval do
+            def initialize(pager, opts)
+              @pager = pager
+              super opts
+            end
+
+            def page
+              paging_text = StringIO.new
+              yield paging_text
+              @pager.page(paging_text.string)
+            end
 
-          def formatter(io)
-            if @formatter_klass then
-              @formatter_klass.new
-            else
-              RDoc::Markup::ToAnsi.new
+            def formatter(_io)
+              if @formatter_klass
+                @formatter_klass.new
+              else
+                RDoc::Markup::ToAnsi.new
+              end
             end
           end
-        end
 
-        RDoc::RI.const_set :PryDriver, subclass   # hook it up!
-      end
+          RDoc::RI.const_set :PryDriver, subclass # hook it up!
+        end
 
-      # Spin-up an RI insance.
-      ri = RDoc::RI::PryDriver.new :use_stdout => true, :interactive => false
+        # Spin-up an RI insance.
+        ri = RDoc::RI::PryDriver.new(
+          pry_instance.pager, use_stdout: true, interactive: false
+        )
 
-      begin
-        ri.display_names [spec]  # Get the documentation (finally!)
-      rescue RDoc::RI::Driver::NotFoundError => e
-        output.puts "error: '#{e.name}' not found"
+        begin
+          ri.display_names [spec] # Get the documentation (finally!)
+        rescue RDoc::RI::Driver::NotFoundError => e
+          output.puts "error: '#{e.name}' not found"
+        end
       end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::Ri)
+    Pry::Commands.add_command(Pry::Command::Ri)
+  end
 end