pry 0.12.2 → 0.13.0

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,65 +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)
-      unless spec
-        return output.puts "Please provide a class, module, or method name (e.g: ri Array#push)"
-      end
+      def process(spec)
+        unless spec
+          return output.puts(
+            "Please provide a class, module, or method name (e.g: ri Array#push)"
+          )
+        end
 
-      # Lazily load RI
-      require 'rdoc/ri/driver'
+        # Lazily load RI
+        require 'rdoc/ri/driver'
 
-      unless defined? RDoc::RI::PryDriver
+        unless defined? RDoc::RI::PryDriver
 
-        # Subclass RI so that it formats its output nicely, and uses `lesspipe`.
-        subclass = Class.new(RDoc::RI::Driver) # the hard way.
+          # 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
+          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 page
+              paging_text = StringIO.new
+              yield paging_text
+              @pager.page(paging_text.string)
+            end
 
-          def formatter(_io)
-            if @formatter_klass
-              @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 _pry_.pager, 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

data/lib/pry/commands/save_file.rb

@@ -1,61 +1,63 @@
-require 'pry/commands/code_collector'
+# frozen_string_literal: true
 
 class Pry
-  class Command::SaveFile < Pry::ClassCommand
-    match 'save-file'
-    group 'Input and Output'
-    description 'Export to a file using content from the REPL.'
+  class Command
+    class SaveFile < Pry::ClassCommand
+      match 'save-file'
+      group 'Input and Output'
+      description 'Export to a file using content from the REPL.'
 
-    banner <<-'BANNER'
-      Usage: save-file [OPTIONS] --to [FILE]
+      banner <<-'BANNER'
+        Usage: save-file [OPTIONS] --to [FILE]
 
-      Export to a file using content from the REPL.
+        Export to a file using content from the REPL.
 
-      save-file my_method --to hello.rb
-      save-file -i 1..10 --to hello.rb --append
-      save-file show-method --to my_command.rb
-      save-file sample_file.rb --lines 2..10 --to output_file.rb
-    BANNER
+        save-file my_method --to hello.rb
+        save-file -i 1..10 --to hello.rb --append
+        save-file show-method --to my_command.rb
+        save-file sample_file.rb --lines 2..10 --to output_file.rb
+      BANNER
 
-    def options(opt)
-      CodeCollector.inject_options(opt)
+      def options(opt)
+        CodeCollector.inject_options(opt)
 
-      opt.on :to=,        "Specify the output file path"
-      opt.on :a, :append, "Append output to file"
-    end
+        opt.on :to=,        "Specify the output file path"
+        opt.on :a, :append, "Append output to file"
+      end
 
-    def process
-      @cc = CodeCollector.new(args, opts, _pry_)
-      raise CommandError, "Found no code to save." if @cc.content.empty?
+      def process
+        @cc = CodeCollector.new(args, opts, pry_instance)
+        raise CommandError, "Found no code to save." if @cc.content.empty?
 
-      if !file_name
-        display_content
-      else
-        save_file
+        if !file_name
+          display_content
+        else
+          save_file
+        end
       end
-    end
 
-    def file_name
-      opts[:to] || nil
-    end
+      def file_name
+        opts[:to] || nil
+      end
 
-    def save_file
-      File.open(file_name, mode) do |f|
-        f.puts @cc.content
+      def save_file
+        File.open(file_name, mode) do |f|
+          f.puts @cc.content
+        end
+        output.puts "#{file_name} successfully saved"
       end
-      output.puts "#{file_name} successfully saved"
-    end
 
-    def display_content
-      output.puts @cc.content
-      output.puts "\n\n--\nPlease use `--to FILE` to export to a file."
-      output.puts "No file saved!\n--"
-    end
+      def display_content
+        output.puts @cc.content
+        output.puts "\n\n--\nPlease use `--to FILE` to export to a file."
+        output.puts "No file saved!\n--"
+      end
 
-    def mode
-      opts.present?(:append) ? "a" : "w"
+      def mode
+        opts.present?(:append) ? "a" : "w"
+      end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::SaveFile)
+    Pry::Commands.add_command(Pry::Command::SaveFile)
+  end
 end

data/lib/pry/commands/shell_command.rb

@@ -1,75 +1,75 @@
+# frozen_string_literal: true
+
 class Pry
-  class Command::ShellCommand < Pry::ClassCommand
-    match(/\.(.*)/)
-    group 'Input and Output'
-    description "All text following a '.' is forwarded to the shell."
-    command_options listing: '.<shell command>', use_prefix: false,
-                    takes_block: true
-
-    banner <<-'BANNER'
-      Usage: .COMMAND_NAME
-
-      All text following a "." is forwarded to the shell.
-
-      .ls -aF
-      .uname
-    BANNER
-
-    def process(cmd)
-      if cmd =~ /^cd\s*(.*)/i
-        process_cd parse_destination($1)
-      else
-        pass_block(cmd)
-        if command_block
-          command_block.call `#{cmd}`
+  class Command
+    class ShellCommand < Pry::ClassCommand
+      match(/\.(.*)/)
+      group 'Input and Output'
+      description "All text following a '.' is forwarded to the shell."
+      command_options listing: '.<shell command>', use_prefix: false,
+                      takes_block: true
+
+      banner <<-'BANNER'
+        Usage: .COMMAND_NAME
+
+        All text following a "." is forwarded to the shell.
+
+        .ls -aF
+        .uname
+      BANNER
+
+      def process(cmd)
+        if cmd =~ /^cd\s*(.*)/i
+          process_cd parse_destination(Regexp.last_match(1))
         else
-          _pry_.config.system.call(output, cmd, _pry_)
+          pass_block(cmd)
+          if command_block
+            command_block.call `#{cmd}`
+          else
+            pry_instance.config.system.call(output, cmd, pry_instance)
+          end
         end
       end
-    end
 
-    private
+      private
 
-    def parse_destination(dest)
-      return "~" if dest.empty?
-      return dest unless dest == "-"
+      def parse_destination(dest)
+        return "~" if dest.empty?
+        return dest unless dest == "-"
 
-      state.old_pwd || raise(CommandError, "No prior directory available")
-    end
+        state.old_pwd || raise(CommandError, "No prior directory available")
+      end
 
-    def process_cd(dest)
-      begin
+      def process_cd(dest)
         state.old_pwd = Dir.pwd
         Dir.chdir(File.expand_path(path_from_cd_path(dest) || dest))
       rescue Errno::ENOENT
         raise CommandError, "No such directory: #{dest}"
       end
-    end
 
-    def cd_path_env
-      ENV['CDPATH']
-    end
+      def cd_path_env
+        Pry::Env['CDPATH']
+      end
 
-    def cd_path_exists?
-      cd_path_env && cd_path_env.length.nonzero?
-    end
+      def cd_path_exists?
+        cd_path_env && cd_path_env.length.nonzero?
+      end
 
-    def path_from_cd_path(dest)
-      return if !(dest && cd_path_exists?) || special_case_path?(dest)
+      def path_from_cd_path(dest)
+        return if !(dest && cd_path_exists?) || special_case_path?(dest)
 
-      cd_path_env.split(File::PATH_SEPARATOR).each do |path|
-        if File.directory?(path) && path.split(File::SEPARATOR).last == dest
-          return path
+        cd_path_env.split(File::PATH_SEPARATOR).each do |path|
+          return path if File.directory?(path) && path.split(File::SEPARATOR).last == dest
         end
+
+        nil
       end
 
-      return nil
+      def special_case_path?(dest)
+        ['.', '..', '-'].include?(dest) || dest =~ /\A[#{File::PATH_SEPARATOR}~]/
+      end
     end
 
-    def special_case_path?(dest)
-      ['.', '..', '-'].include?(dest) || dest =~ /\A[#{File::PATH_SEPARATOR}~]/
-    end
+    Pry::Commands.add_command(Pry::Command::ShellCommand)
   end
-
-  Pry::Commands.add_command(Pry::Command::ShellCommand)
 end

data/lib/pry/commands/shell_mode.rb

@@ -1,25 +1,29 @@
+# frozen_string_literal: true
+
 class Pry
-  class Command::ShellMode < Pry::ClassCommand
-    match 'shell-mode'
-    group 'Input and Output'
-    description 'Toggle shell mode. Bring in pwd prompt and file completion.'
+  class Command
+    class ShellMode < Pry::ClassCommand
+      match 'shell-mode'
+      group 'Input and Output'
+      description 'Toggle shell mode. Bring in pwd prompt and file completion.'
 
-    banner <<-'BANNER'
-      Toggle shell mode. Bring in pwd prompt and file completion.
-    BANNER
+      banner <<-'BANNER'
+        Toggle shell mode. Bring in pwd prompt and file completion.
+      BANNER
 
-    def process
-      state.disabled ^= true
+      def process
+        state.disabled ^= true
 
-      if state.disabled
-        state.prev_prompt = _pry_.prompt
-        _pry_.prompt = Pry::Prompt[:shell][:value]
-      else
-        _pry_.prompt = state.prev_prompt
+        if state.disabled
+          state.prev_prompt = pry_instance.prompt
+          pry_instance.prompt = Pry::Prompt[:shell]
+        else
+          pry_instance.prompt = state.prev_prompt
+        end
       end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::ShellMode)
-  Pry::Commands.alias_command 'file-mode', 'shell-mode'
+    Pry::Commands.add_command(Pry::Command::ShellMode)
+    Pry::Commands.alias_command 'file-mode', 'shell-mode'
+  end
 end

data/lib/pry/commands/show_doc.rb

@@ -1,81 +1,94 @@
-require 'pry/commands/show_info'
+# frozen_string_literal: true
 
 class Pry
-  class Command::ShowDoc < Command::ShowInfo
-    include Pry::Helpers::DocumentationHelpers
-
-    match 'show-doc'
-    group 'Introspection'
-    description 'Show the documentation for a method or class.'
-
-    banner <<-BANNER
-      Usage:   show-doc [OPTIONS] [METH]
-      Aliases: ?
-
-      Show the documentation for a method or class. Tries instance methods first and
-      then methods by default.
-
-      show-doc hi_method # docs for hi_method
-      show-doc Pry       # for Pry class
-      show-doc Pry -a    # for all definitions of Pry class (all monkey patches)
-    BANNER
-
-    # The docs for code_object prepared for display.
-    def content_for(code_object)
-      Code.new(render_doc_markup_for(code_object),
-               start_line_for(code_object), :text).
-        with_line_numbers(use_line_numbers?).to_s
-    end
+  class Command
+    class ShowDoc < Command::ShowInfo
+      include Pry::Helpers::DocumentationHelpers
+
+      match 'show-doc'
+      group 'Introspection'
+      description 'Show the documentation for a method or class.'
+
+      banner <<-BANNER
+        Usage:   show-doc [OPTIONS] [METH]
+        Aliases: ?
+
+        Show the documentation for a method or class. Tries instance methods first and
+        then methods by default.
+
+        show-doc hi_method # docs for hi_method
+        show-doc Pry       # for Pry class
+        show-doc Pry -a    # for all definitions of Pry class (all monkey patches)
+      BANNER
+
+      def process
+        super
+
+        output.puts(
+          "\nWARNING: the show-doc command is deprecated. It will be removed " \
+          "from future Pry versions.\nPlease use 'show-source' with the -d " \
+          "(or --doc) switch instead\nExample: show-source #{obj_name} -d"
+        )
+      end
+
+      # The docs for code_object prepared for display.
+      def content_for(code_object)
+        Code.new(
+          render_doc_markup_for(code_object),
+          start_line_for(code_object),
+          :text
+        ).with_line_numbers(use_line_numbers?).to_s
+      end
 
-    # process the markup (if necessary) and apply colors
-    def render_doc_markup_for(code_object)
-      docs = docs_for(code_object)
-
-      if code_object.command?
-        # command '--help' shouldn't use markup highlighting
-        docs
-      else
-        if docs.empty?
-          raise CommandError, "No docs found for: #{
-            obj_name ? obj_name : 'current context'
-          }"
+      # process the markup (if necessary) and apply colors
+      def render_doc_markup_for(code_object)
+        docs = docs_for(code_object)
+
+        if code_object.command?
+          # command '--help' shouldn't use markup highlighting
+          docs
+        else
+          if docs.empty?
+            raise CommandError, "No docs found for: #{obj_name || 'current context'}"
+          end
+
+          process_comment_markup(docs)
         end
-        process_comment_markup(docs)
       end
-    end
 
-    # Return docs for the code_object, adjusting for whether the code_object
-    # has yard docs available, in which case it returns those.
-    # (note we only have to check yard docs for modules since they can
-    # have multiple docs, but methods can only be doc'd once so we
-    # dont need to check them)
-    def docs_for(code_object)
-      if code_object.module_with_yard_docs?
-        # yard docs
-        code_object.yard_doc
-      else
-        # normal docs (i.e comments above method/module/command)
-        code_object.doc
+      # Return docs for the code_object, adjusting for whether the code_object
+      # has yard docs available, in which case it returns those.
+      # (note we only have to check yard docs for modules since they can
+      # have multiple docs, but methods can only be doc'd once so we
+      # dont need to check them)
+      def docs_for(code_object)
+        if code_object.module_with_yard_docs?
+          # yard docs
+          code_object.yard_doc
+        else
+          # normal docs (i.e comments above method/module/command)
+          code_object.doc
+        end
       end
-    end
 
-    # Which sections to include in the 'header', can toggle: :owner,
-    # :signature and visibility.
-    def header_options
-      super.merge signature: true
-    end
+      # Which sections to include in the 'header', can toggle: :owner,
+      # :signature and visibility.
+      def header_options
+        super.merge signature: true
+      end
 
-    # figure out start line of docs by back-calculating based on
-    # number of lines in the comment and the start line of the code_object
-    # @return [Fixnum] start line of docs
-    def start_line_for(code_object)
-      return 1 if code_object.command? || opts.present?(:'base-one')
-      return 1 unless code_object.source_line
+      # figure out start line of docs by back-calculating based on
+      # number of lines in the comment and the start line of the code_object
+      # @return [Fixnum] start line of docs
+      def start_line_for(code_object)
+        return 1 if code_object.command? || opts.present?(:'base-one')
+        return 1 unless code_object.source_line
 
-      code_object.source_line - code_object.doc.lines.count
+        code_object.source_line - code_object.doc.lines.count
+      end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::ShowDoc)
-  Pry::Commands.alias_command '?', 'show-doc'
+    Pry::Commands.add_command(Pry::Command::ShowDoc)
+    Pry::Commands.alias_command '?', 'show-doc'
+  end
 end