pry 0.8.4pre1 → 0.9.0pre1

data/lib/pry/pry_instance.rb

@@ -2,12 +2,13 @@ require "pry/command_processor.rb"
 
 class Pry
 
-  # The list of configuration options.
-  CONFIG_OPTIONS = [:input, :output, :commands, :print,
-                    :exception_handler, :prompt, :hooks,
-                    :custom_completions]
-
-  attr_accessor *CONFIG_OPTIONS
+  attr_accessor :input
+  attr_accessor :output
+  attr_accessor :commands
+  attr_accessor :print
+  attr_accessor :exception_handler
+  attr_accessor :hooks
+  attr_accessor :custom_completions
 
   # Returns the target binding for the session. Note that altering this
   # attribute will not change the target binding.
@@ -18,22 +19,56 @@ class Pry
   # @param [Hash] options The optional configuration parameters.
   # @option options [#readline] :input The object to use for input.
   # @option options [#puts] :output The object to use for output.
-  # @option options [Pry::CommandBase] :commands The object to use for commands. (see commands.rb)
-  # @option options [Hash] :hooks The defined hook Procs (see hooks.rb)
-  # @option options [Array<Proc>] :default_prompt The array of Procs to use for the prompts. (see prompts.rb)
+  # @option options [Pry::CommandBase] :commands The object to use for commands.
+  # @option options [Hash] :hooks The defined hook Procs
+  # @option options [Array<Proc>] :prompt The array of Procs to use for the prompts.
   # @option options [Proc] :print The Proc to use for the 'print'
   #   component of the REPL. (see print.rb)
   def initialize(options={})
+    refresh(options)
+    @command_processor = CommandProcessor.new(self)
+  end
 
-    default_options = {}
-    CONFIG_OPTIONS.each { |v| default_options[v] = Pry.send(v) }
-    default_options.merge!(options)
+  # Refresh the Pry instance settings from the Pry class.
+  # Allows options to be specified to override settings from Pry class.
+  # @param [Hash] options The options to override Pry class settings
+  #   for this instance.
+  def refresh(options={})
+    defaults   = {}
+    attributes = [
+                   :input, :output, :commands, :print,
+                   :exception_handler, :hooks, :custom_completions,
+                   :prompt
+                 ]
+
+    attributes.each do |attribute|
+      defaults[attribute] = Pry.send attribute
+    end
 
-    CONFIG_OPTIONS.each do |key|
-      send "#{key}=", default_options[key]
+    defaults.merge!(options).each do |key, value|
+      send "#{key}=", value
     end
+    true
+  end
 
-    @command_processor = CommandProcessor.new(self)
+  # The current prompt.
+  # This is the prompt at the top of the prompt stack.
+  #
+  # @example
+  #    self.prompt = Pry::SIMPLE_PROMPT
+  #    self.prompt # => Pry::SIMPLE_PROMPT
+  #
+  # @return [Array<Proc>] Current prompt.
+  def prompt
+    prompt_stack.last
+  end
+
+  def prompt=(new_prompt)
+    if prompt_stack.empty?
+      push_prompt new_prompt
+    else
+      prompt_stack[-1] = new_prompt
+    end
   end
 
   # Get nesting data.
@@ -50,6 +85,11 @@ class Pry
     self.class.nesting = v
   end
 
+  # @return [Boolean] Whether top-level session has ended.
+  def finished_top_level_session?
+    nesting.empty?
+  end
+
   # Return parent of current Pry session.
   # @return [Pry] The parent of the current Pry session.
   def parent
@@ -71,8 +111,8 @@ class Pry
     Pry.active_instance = self
 
     # Make sure special locals exist
-    target.eval("_pry_ = ::Pry.active_instance")
-    target.eval("_ = ::Pry.last_result")
+    set_active_instance(target)
+    set_last_result(Pry.last_result, target)
     self.session_target = target
   end
 
@@ -91,6 +131,8 @@ class Pry
       throw :breakout, break_data
     end
 
+    save_history if Pry.config.history.save && finished_top_level_session?
+
     return_value
   end
 
@@ -151,22 +193,19 @@ class Pry
       Readline.completion_proc = Pry::InputCompleter.build_completion_proc target, instance_eval(&custom_completions)
     end
 
-    # save the pry instance to active_instance
-    Pry.active_instance = self
-    target.eval("_pry_ = ::Pry.active_instance")
-
     @last_result_is_exception = false
+    set_active_instance(target)
+    expr = r(target)
 
-    # eval the expression and save to last_result
-    # Do not want __FILE__, __LINE__ here because we need to distinguish
-    # (eval) methods for show-method and friends.
-    # This also sets the `_` local for the session.
-    set_last_result(target.eval(r(target)), target)
+    Pry.line_buffer.push(*expr.each_line)
+    set_last_result(target.eval(expr, Pry.eval_path, Pry.current_line), target)
   rescue SystemExit => e
     exit
   rescue Exception => e
     @last_result_is_exception = true
     set_last_exception(e, target)
+  ensure
+    Pry.current_line += expr.each_line.count if expr
   end
 
   # Perform a read.
@@ -175,18 +214,19 @@ class Pry
   # Ruby expression is received.
   # Pry commands are also accepted here and operate on the target.
   # @param [Object, Binding] target The receiver of the read.
+  # @param [String] eval_string Optionally Prime `eval_string` with a start value.
   # @return [String] The Ruby expression.
   # @example
   #   Pry.new.r(Object.new)
-  def r(target=TOPLEVEL_BINDING)
+  def r(target=TOPLEVEL_BINDING, eval_string="")
     target = Pry.binding_for(target)
     @suppress_output = false
-    eval_string = ""
 
     val = ""
     loop do
       val = retrieve_line(eval_string, target)
       process_line(val, eval_string, target)
+
       break if valid_expression?(eval_string)
     end
 
@@ -195,7 +235,7 @@ class Pry
     eval_string
   end
 
-  # FIXME should delete this method? it's exposing an implementation detail!
+  # Output the result or pass to an exception handler (if result is an exception).
   def show_result(result)
     if last_result_is_exception?
       exception_handler.call output, result
@@ -264,6 +304,14 @@ class Pry
     target.eval("_ex_ = ::Pry.last_exception")
   end
 
+  # Set the active instance for a session.
+  # This method should not need to be invoked directly.
+  # @param [Binding] target The binding to set `_ex_` on.
+  def set_active_instance(target)
+    Pry.active_instance = self
+    target.eval("_pry_ = ::Pry.active_instance")
+  end
+
   # @return [Boolean] True if the last result is an exception that was raised,
   #   as opposed to simply an instance of Exception (like the result of
   #   Exception.new)
@@ -291,7 +339,7 @@ class Pry
         end
 
       rescue EOFError
-        self.input = Readline
+        self.input = Pry.input
         ""
       end
     end
@@ -305,6 +353,14 @@ class Pry
     !@suppress_output || last_result_is_exception?
   end
 
+  # Save readline history to a file.
+  def save_history
+    history_file = File.expand_path(Pry.config.history.file)
+    File.open(history_file, 'w') do |f|
+      f.write Readline::HISTORY.to_a.join("\n")
+    end
+  end
+
   # Returns the appropriate prompt to use.
   # This method should not need to be invoked directly.
   # @param [Boolean] first_line Whether this is the first line of input
@@ -326,30 +382,6 @@ class Pry
   end
   private :prompt_stack
 
-  # The current prompt, this is the prompt at the top of the prompt stack.
-  # @return [Array<Proc>] Current prompt.
-  # @example
-  #    push_prompt(Pry::SIMPLE_PROMPT)
-  #    prompt # => Pry::SIMPLE_PROMPT
-  def prompt
-    prompt_stack.last
-  end
-
-  # Replaces the current prompt with the new prompt.
-  # Does not change the rest of the prompt stack.
-  # @param [Array<Proc>] new_prompt
-  # @return [Array<Proc>] new_prompt
-  # @example
-  #    pry.prompt = Pry::SIMPLE_PROMPT # => Pry::SIMPLE_PROMPT
-  #    pry.prompt # => Pry::SIMPLE_PROMPT
-  def prompt=(new_prompt)
-    if prompt_stack.empty?
-      push_prompt new_prompt
-    else
-      prompt_stack[-1] = new_prompt
-    end
-  end
-
   # Pushes the current prompt onto a stack that it can be restored from later.
   # Use this if you wish to temporarily change the prompt.
   # @param [Array<Proc>] new_prompt
@@ -374,7 +406,7 @@ class Pry
   #    pry.pop_prompt # => prompt1
   #    pry.pop_prompt # => prompt1
   def pop_prompt
-    if prompt_stack.size > 1 then prompt_stack.pop else prompt end
+    prompt_stack.size > 1 ? prompt_stack.pop : prompt
   end
 
   if RUBY_VERSION =~ /1.9/ && RUBY_ENGINE == "ruby"

data/lib/pry/version.rb

@@ -1,3 +1,3 @@
 class Pry
-  VERSION = "0.8.4pre1"
+  VERSION = "0.9.0pre1"
 end

data/test/helper.rb

@@ -7,21 +7,70 @@ require 'bacon'
 
 # Ensure we do not execute any rc files
 Pry::RC_FILES.clear
-Pry.color = false
-Pry.should_load_rc = false
-
-class Module
-  public :remove_const
-end
 
+# in case the tests call reset_defaults, ensure we reset them to
+# amended (test friendly) values
 class << Pry
   alias_method :orig_reset_defaults, :reset_defaults
   def reset_defaults
     orig_reset_defaults
+
     Pry.color = false
+    Pry.pager = false
+    Pry.config.should_load_rc = false
+    Pry.config.plugins.enabled = false
+    Pry.config.history.load = false
+    Pry.config.history.save = false
   end
 end
 
+Pry.reset_defaults
+
+# sample doc
+def sample_method
+  :sample
+end
+
+def redirect_pry_io(new_in, new_out)
+  old_in = Pry.input
+  old_out = Pry.output
+
+  Pry.input = new_in
+  Pry.output = new_out
+  begin
+    yield
+  ensure
+    Pry.input = old_in
+    Pry.output = old_out
+  end
+end
+
+def redirect_global_pry_input(new_io)
+  old_io = Pry.input
+    Pry.input = new_io
+    begin
+      yield
+    ensure
+      Pry.input = old_io
+    end
+end
+
+def redirect_global_pry_output(new_io)
+  old_io = Pry.output
+    Pry.output = new_io
+    begin
+      yield
+    ensure
+      Pry.output = old_io
+    end
+end
+
+class Module
+  public :remove_const
+  public :remove_method
+end
+
+
 class InputTester
   def initialize(*actions)
     @orig_actions = actions.dup
@@ -47,7 +96,7 @@ class Pry
 end
 
 
-CommandTester = Pry::CommandSet.new :test do
+CommandTester = Pry::CommandSet.new do
   command "command1", "command 1 test" do
     output.puts "command1"
   end

data/test/test_command_processor.rb

@@ -0,0 +1,99 @@
+require 'helper'
+
+describe "Pry::CommandProcessor" do
+
+  before do
+    @pry = Pry.new
+    @pry.commands = Pry::CommandSet.new
+    @command_processor = Pry::CommandProcessor.new(@pry)
+  end
+
+  after do
+    @pry.commands = Pry::CommandSet.new
+  end
+
+  it 'should correctly match a simple string command' do
+    @pry.commands.command("test-command") {}
+    command, captures, pos = @command_processor.command_matched "test-command"
+
+    command.name.should == "test-command"
+    captures.should == []
+    pos.should == "test-command".length
+  end
+
+  it 'should correctly match a simple string command with parameters' do
+    @pry.commands.command("test-command") { |arg|}
+    command, captures, pos = @command_processor.command_matched "test-command hello"
+
+    command.name.should == "test-command"
+    captures.should == []
+    pos.should == "test-command".length
+  end
+
+  it 'should not match when the relevant command does not exist' do
+    command, captures, pos = @command_processor.command_matched "test-command"
+
+    command.should == nil
+    captures.should == nil
+  end
+
+  it 'should correctly match a regex command' do
+    @pry.commands.command(/rue(.?)/) { }
+    command, captures, pos = @command_processor.command_matched "rue hello"
+
+    command.name.should == /rue(.?)/
+    captures.should == [""]
+    pos.should == 3
+  end
+
+  it 'should correctly match a regex command and extract the capture groups' do
+    @pry.commands.command(/rue(.?)/) { }
+    command, captures, pos = @command_processor.command_matched "rue5 hello"
+
+    command.name.should == /rue(.?)/
+    captures.should == ["5"]
+    pos.should == 4
+  end
+
+  it 'should correctly match a string command with spaces in its name' do
+    @pry.commands.command("test command") {}
+    command, captures, pos = @command_processor.command_matched "test command"
+
+    command.name.should == "test command"
+    captures.should == []
+    pos.should == command.name.length
+  end
+
+  it 'should correctly match a string command with spaces in its name with parameters' do
+    @pry.commands.command("test command") {}
+    command, captures, pos = @command_processor.command_matched "test command param1 param2"
+
+    command.name.should == "test command"
+    captures.should == []
+    pos.should == command.name.length
+  end
+
+  it 'should correctly match a regex command with spaces in its name' do
+    regex_command_name = /test\s+(.+)\s+command/
+    @pry.commands.command(regex_command_name) {}
+
+    sample_text = "test friendship command"
+    command, captures, pos = @command_processor.command_matched sample_text
+
+    command.name.should == regex_command_name
+    captures.should == ["friendship"]
+    pos.should == sample_text.size
+  end
+
+  it 'should correctly match a complex regex command' do
+    regex_command_name = /\.(.*)/
+    @pry.commands.command(regex_command_name) {}
+
+    sample_text = ".cd ~/pry"
+    command, captures, pos = @command_processor.command_matched sample_text
+
+    command.name.should == regex_command_name
+    captures.should == ["cd ~/pry"]
+    pos.should == sample_text.size
+  end
+end

data/test/{test_commandset.rb → test_command_set.rb}

@@ -2,11 +2,7 @@ require 'helper'
 
 describe Pry::CommandSet do
   before do
-    @set = Pry::CommandSet.new(:some_name)
-  end
-
-  it 'should use the name specified at creation' do
-    @set.name.should == :some_name
+    @set = Pry::CommandSet.new
   end
 
   it 'should call the block used for the command when it is called' do
@@ -35,7 +31,7 @@ describe Pry::CommandSet do
     @set.run_command true, 'foo'
   end
 
-  it 'should raise an error when calling an undefined comand' do
+  it 'should raise an error when calling an undefined command' do
     @set.command('foo') {}
     lambda {
       @set.run_command nil, 'bar'
@@ -54,7 +50,7 @@ describe Pry::CommandSet do
   it 'should be able to import some commands from other sets' do
     run = false
 
-    other_set = Pry::CommandSet.new :foo do
+    other_set = Pry::CommandSet.new do
       command('foo') { run = true }
       command('bar') {}
     end
@@ -72,7 +68,7 @@ describe Pry::CommandSet do
   it 'should be able to import a whole set' do
     run = []
 
-    other_set = Pry::CommandSet.new :foo do
+    other_set = Pry::CommandSet.new do
       command('foo') { run << true }
       command('bar') { run << true }
     end
@@ -88,7 +84,7 @@ describe Pry::CommandSet do
     run = false
     @set.command('foo') { run = true }
 
-    Pry::CommandSet.new(:other, @set).run_command nil, 'foo'
+    Pry::CommandSet.new(@set).run_command nil, 'foo'
     run.should == true
   end
 
@@ -139,7 +135,7 @@ describe Pry::CommandSet do
     Pry::CommandContext.new.should.not.respond_to :my_helper
   end
 
-  it 'should not recreate a new heler module when helpers is called' do
+  it 'should not recreate a new helper module when helpers is called' do
     @set.command('foo') do
       should.respond_to :my_helper
       should.respond_to :my_other_helper
@@ -157,7 +153,7 @@ describe Pry::CommandSet do
   end
 
   it 'should import helpers from imported sets' do
-    imported_set = Pry::CommandSet.new :test do
+    imported_set = Pry::CommandSet.new do
       helpers do
         def imported_helper_method; end
       end
@@ -169,7 +165,7 @@ describe Pry::CommandSet do
   end
 
   it 'should import helpers even if only some commands are imported' do
-    imported_set = Pry::CommandSet.new :test do
+    imported_set = Pry::CommandSet.new do
       helpers do
         def imported_helper_method; end
       end
@@ -181,4 +177,14 @@ describe Pry::CommandSet do
     @set.command('foo') { should.respond_to :imported_helper_method }
     @set.run_command(Pry::CommandContext.new, 'foo')
   end
+
+  it 'should provide a :listing for a command that defaults to its name' do
+    @set.command 'foo', "" do;end
+    @set.commands['foo'].options[:listing].should == 'foo'
+  end
+
+  it 'should provide a :listing for a command that differs from its name' do
+    @set.command 'foo', "", :listing => 'bar' do;end
+    @set.commands['foo'].options[:listing].should == 'bar'
+  end
 end