pry 0.9.10pre1-i386-mswin32 → 0.9.11-i386-mswin32

data/lib/pry/commands/nesting.rb

@@ -0,0 +1,25 @@
+class Pry
+  class Command::Nesting < Pry::ClassCommand
+    match 'nesting'
+    group 'Navigating Pry'
+    description 'Show nesting information.'
+
+    banner <<-'BANNER'
+      Show nesting information.
+    BANNER
+
+    def process
+      output.puts 'Nesting status:'
+      output.puts '--'
+      _pry_.binding_stack.each_with_index do |obj, level|
+        if level == 0
+          output.puts "#{level}. #{Pry.view_clip(obj.eval('self'))} (Pry top level)"
+        else
+          output.puts "#{level}. #{Pry.view_clip(obj.eval('self'))}"
+        end
+      end
+    end
+  end
+
+  Pry::Commands.add_command(Pry::Command::Nesting)
+end

data/lib/pry/commands/play.rb

@@ -0,0 +1,69 @@
+class Pry
+  class Command::Play < Pry::ClassCommand
+    match 'play'
+    group 'Editing'
+    description 'Playback a string variable or a method or a file as input.'
+
+    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.
+
+      play --lines 149..153
+      play -i 20 --lines 1..3
+      play Pry#repl --lines 1..-1
+      play Rakefile --lines 5
+
+      https://github.com/pry/pry/wiki/User-Input#wiki-Play
+    BANNER
+
+    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
+
+    def process
+      @cc = CodeCollector.new(args, opts, _pry_)
+
+      perform_play
+      run "show-input" unless Pry::Code.complete_expression?(eval_string)
+    end
+
+    def perform_play
+      eval_string << (opts.present?(:open) ? restrict_to_lines(content, (0..-2)) : content)
+      run "fix-indent"
+    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
+      target.eval("__FILE__") && File.expand_path(target.eval("__FILE__"))
+    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)
+end

data/lib/pry/commands/pry_backtrace.rb

@@ -0,0 +1,26 @@
+class Pry
+  class Command::PryBacktrace < Pry::ClassCommand
+    match 'pry-backtrace'
+    group 'Context'
+    description 'Show the backtrace for the Pry session.'
+
+    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.
+
+      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")
+    end
+  end
+
+  Pry::Commands.add_command(Pry::Command::PryBacktrace)
+end

data/lib/pry/commands/pry_version.rb

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

data/lib/pry/commands/raise_up.rb

@@ -0,0 +1,32 @@
+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]}")
+    end
+  end
+
+  Pry::Commands.add_command(Pry::Command::RaiseUp)
+end

data/lib/pry/commands/reload_code.rb

@@ -0,0 +1,39 @@
+class Pry
+  class Command::ReloadCode < Pry::ClassCommand
+    match 'reload-code'
+    group 'Misc'
+    description 'Reload the source file that contains the specified code object.'
+
+    banner <<-'BANNER'
+      Reload the source file that contains the specified code object.
+    BANNER
+
+    def process
+      code_object = Pry::CodeObject.lookup(obj_name, _pry_)
+
+      check_for_reloadability(code_object)
+      reload_code_object(code_object)
+    end
+
+    private
+
+    def reload_code_object(code_object)
+      load code_object.source_file
+      output.puts "#{obj_name} was reloaded!"
+    end
+
+    def obj_name
+      @obj_name ||= args.empty? ? "self" : args.join(" ")
+    end
+
+    def check_for_reloadability(code_object)
+      if !code_object
+        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}"
+      end
+    end
+  end
+
+  Pry::Commands.add_command(Pry::Command::ReloadCode)
+end

data/lib/pry/commands/reset.rb

@@ -0,0 +1,18 @@
+class Pry
+  class Command::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
+
+    def process
+      output.puts 'Pry reset.'
+      exec 'pry'
+    end
+  end
+
+  Pry::Commands.add_command(Pry::Command::Reset)
+end

data/lib/pry/commands/ri.rb

@@ -0,0 +1,56 @@
+class Pry
+  class Command::Ri < Pry::ClassCommand
+    match 'ri'
+    group 'Introspection'
+    description 'View ri documentation.'
+
+    banner <<-'BANNER'
+      Usage: ri [spec]
+
+      View ri documentation. Relies on the "rdoc" gem being installed.
+      See also "show-doc" command.
+
+      ri Array#each
+    BANNER
+
+    def process(spec)
+      # Lazily load RI
+      require 'rdoc/ri/driver'
+
+      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.class_eval do
+          def page
+            paging_text = StringIO.new
+            yield paging_text
+            Pry::Pager.page(paging_text.string)
+          end
+
+          def formatter(io)
+            if @formatter_klass then
+              @formatter_klass.new
+            else
+              RDoc::Markup::ToAnsi.new
+            end
+          end
+        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
+
+      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
+
+  Pry::Commands.add_command(Pry::Command::Ri)
+end

data/lib/pry/commands/save_file.rb

@@ -0,0 +1,61 @@
+require 'pry/commands/code_collector'
+
+class Pry
+  class Command::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]
+
+      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
+
+    def options(opt)
+      CodeCollector.inject_options(opt)
+
+      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?
+
+      if !file_name
+        display_content
+      else
+        save_file
+      end
+    end
+
+    def file_name
+      opts[:to] || nil
+    end
+
+    def save_file
+      File.open(file_name, mode) do |f|
+        f.puts @cc.content
+      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 mode
+      opts.present?(:append) ? "a" : "w"
+    end
+  end
+
+  Pry::Commands.add_command(Pry::Command::SaveFile)
+end

data/lib/pry/commands/shell_command.rb

@@ -0,0 +1,43 @@
+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
+        dest = $1
+        begin
+          Dir.chdir File.expand_path(dest)
+        rescue Errno::ENOENT
+          raise CommandError, "No such directory: #{dest}"
+        end
+      else
+        pass_block(cmd)
+
+        if command_block
+          command_block.call `#{cmd}`
+        else
+          Pry.config.system.call(output, cmd, _pry_)
+        end
+      end
+    end
+
+    def complete(search)
+      super + Bond::Rc.files(search.split(" ").last || '')
+    end
+  end
+
+  Pry::Commands.add_command(Pry::Command::ShellCommand)
+end

data/lib/pry/commands/shell_mode.rb

@@ -0,0 +1,27 @@
+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.'
+
+    banner <<-'BANNER'
+      Toggle shell mode. Bring in pwd prompt and file completion.
+    BANNER
+
+    def process
+      case _pry_.prompt
+      when Pry::SHELL_PROMPT
+        _pry_.pop_prompt
+        _pry_.custom_completions = Pry::DEFAULT_CUSTOM_COMPLETIONS
+      else
+        _pry_.push_prompt Pry::SHELL_PROMPT
+        _pry_.custom_completions = Pry::FILE_COMPLETIONS
+        Readline.completion_proc = Pry::InputCompleter.build_completion_proc target,
+        _pry_.instance_eval(&Pry::FILE_COMPLETIONS)
+      end
+    end
+  end
+
+  Pry::Commands.add_command(Pry::Command::ShellMode)
+  Pry::Commands.alias_command 'file-mode', 'shell-mode'
+end

data/lib/pry/commands/show_doc.rb

@@ -0,0 +1,78 @@
+require 'pry/commands/show_info'
+
+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
+
+    # 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
+        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
+      end
+    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)
+      if code_object.command? || opts.present?(:'base-one')
+         1
+      else
+        code_object.source_line.nil? ? 1 :
+          (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'
+end