pry 0.6.7 → 0.6.8

data/CHANGELOG

@@ -1,3 +1,8 @@
+6/3/2011 version 0.6.8
+* add whereami command, a la the `ir_b` gem
+* make whereami run at the start of every session
+* make .pryrc be loaded by run-time pry sessions
+
 4/3/2011 version 0.6.7
 * color support
 * --simple-prompt for pry commandline

data/LICENSE

@@ -1,25 +1,25 @@
-License
--------
-
-(The MIT License) 
-
-Copyright (c) 2011 John Mair (banisterfiend)
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+License
+-------
+
+(The MIT License) 
+
+Copyright (c) 2011 John Mair (banisterfiend)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -42,7 +42,7 @@ Example: Interacting with an object at runtime
 
 With the `Object#pry` method we can pry (open an irb-like session) on
 an object. In the example below we open a Pry session for the `Test` class and execute a method and add
-an instance variable. The current thread is halted for the duration of the session.
+an instance variable. The current thread is taken over by the Pry REPL loop for the duration of the session.
 
     require 'pry'
 
@@ -164,7 +164,7 @@ end.
 
 * Pry can be invoked at any time and on any object in the running program.
 * Pry sessions can nest arbitrarily deeply -- to go back one level of nesting type 'exit' or 'quit' or 'back'
-* Pry comes with syntax highlighting just use the `toggle-color` command to use it.
+* Pry comes with syntax highlighting on by default just use the `toggle-color` command to use it.
 * Use `_` to recover last result.
 * Use `_pry_` to reference the Pry instance managing the current session.
 * Pry supports tab completion.
@@ -240,6 +240,7 @@ If you want to access a method of the same name, prefix the invocation by whites
   getting you out of a situation where the parsing process
   goes wrong and you get stuck in an endless read loop.
 * `status` shows status information about the current session.
+* `whereami` shows the code context of the session.
 * `version` Show Pry version information
 * `help` shows the list of session commands with brief explanations.
 * `toggle-color` turns on and off syntax highlighting.
@@ -265,6 +266,14 @@ If you want to access a method of the same name, prefix the invocation by whites
   current one with `obj` as the receiver of the new session. Very useful
   when exploring large or complicated runtime state.
 
+Syntax Highlighting
+--------------------
+
+Syntax highlighting is on by default in Pry. You can toggle it on and
+off in a session by using the `toggle-color` command. Alternatively,
+you can turn it off permanently by putting the line `Pry.color =
+false` in your `~/.pryrc` file.
+
 Bindings and objects
 --------------------
 

data/Rakefile

@@ -26,7 +26,7 @@ def apply_spec_defaults(s)
   s.has_rdoc = 'yard'
   s.executables = ["pry"]
   s.files = Dir["ext/**/extconf.rb", "ext/**/*.h", "ext/**/*.c", "lib/**/*.rb", "examples/**/*.rb",
-                     "test/*.rb", "CHANGELOG", "LICENSE", "README.markdown", "Rakefile", ".gemtest"]
+                     "test/*.rb", "test/testrc", "CHANGELOG", "LICENSE", "README.markdown", "Rakefile", ".gemtest"]
 end
 
 task :test do

data/bin/pry

@@ -35,8 +35,8 @@ See: `https://github.com/banister` for more information.
     options[:loadrc] = false
   end
 
-  opts.on("--color", "Start session with syntax highlighting on.") do 
-    Pry.color = true
+  opts.on("--no-color", "Start session without syntax highlighting.") do 
+    Pry.color = false
   end
 
   opts.on("--simple-prompt", "Simple prompt mode.") do 
@@ -65,10 +65,11 @@ See: `https://github.com/banister` for more information.
   end
 end.parse!
 
-rcpath = File.expand_path("~/.pryrc")
+# invoked via cli
+Pry.cli = true
 
 # load ~/.pryrc, if not suppressed with -f option
-load rcpath if File.exists?(rcpath) && options[:loadrc]
+Pry.should_load_rc = false if !options[:loadrc]
 
 # create the actual context
 context = Pry.binding_for(eval(options[:context_string]))

data/examples/example_basic.rb

@@ -1,17 +1,17 @@
-direc = File.dirname(__FILE__)
-
-require 'rubygems'
-require "#{direc}/../lib/pry"
-
-# define a local.
-a = "a local variable"
-
-# defing a top-level method.
-def hello
-  puts "hello world!"
-end
-
-# Start pry session at top-level.
-# The local variable `a` and the `hello` method will
-# be accessible.
-pry
+direc = File.dirname(__FILE__)
+
+require 'rubygems'
+require "#{direc}/../lib/pry"
+
+# define a local.
+a = "a local variable"
+
+# defing a top-level method.
+def hello
+  puts "hello world!"
+end
+
+# Start pry session at top-level.
+# The local variable `a` and the `hello` method will
+# be accessible.
+pry

data/examples/example_command_override.rb

@@ -1,35 +1,35 @@
-direc = File.dirname(__FILE__)
-
-require 'rubygems'
-require "#{direc}/../lib/pry"
-
-# Inherit standard command set, but tweak them by importing some and
-# overriding others.
-# Illustrates use of `command`, `run`, and `import_from` commands.
-class MyCommands < Pry::CommandBase
-
-  # Override ls command
-  command "ls", "An unhelpful ls" do
-    output.puts "No, i refuse to display any useful information."
-  end
-
-  # bring in just the status command from Pry::Commands
-  import_from Pry::Commands, "status"
-
-  # analogy to Ruby's native alias_method idiom for decorating a method
-  alias_command "old_status", "status", ""
-  
-  # Invoke one command from within another using `run`
-  command "status", "Modified status."  do |x|
-    output.puts "About to show status, are you ready?"
-    run "old_status", x
-    output.puts "Finished showing status."
-  end
-
-  # bring in a few other commands
-  import_from Pry::Commands, "quit", "show-method"
-end
-
-# Start a Pry session using the commands defined in MyCommands
-# Type 'help' in Pry to get a list of the commands and their descriptions
-Pry.start(TOPLEVEL_BINDING, :commands => MyCommands)
+direc = File.dirname(__FILE__)
+
+require 'rubygems'
+require "#{direc}/../lib/pry"
+
+# Inherit standard command set, but tweak them by importing some and
+# overriding others.
+# Illustrates use of `command`, `run`, and `import_from` commands.
+class MyCommands < Pry::CommandBase
+
+  # Override ls command
+  command "ls", "An unhelpful ls" do
+    output.puts "No, i refuse to display any useful information."
+  end
+
+  # bring in just the status command from Pry::Commands
+  import_from Pry::Commands, "status"
+
+  # analogy to Ruby's native alias_method idiom for decorating a method
+  alias_command "old_status", "status", ""
+  
+  # Invoke one command from within another using `run`
+  command "status", "Modified status."  do |x|
+    output.puts "About to show status, are you ready?"
+    run "old_status", x
+    output.puts "Finished showing status."
+  end
+
+  # bring in a few other commands
+  import_from Pry::Commands, "quit", "show-method"
+end
+
+# Start a Pry session using the commands defined in MyCommands
+# Type 'help' in Pry to get a list of the commands and their descriptions
+Pry.start(TOPLEVEL_BINDING, :commands => MyCommands)

data/examples/example_commands.rb

@@ -1,39 +1,39 @@
-direc = File.dirname(__FILE__)
-
-require 'rubygems'
-require "#{direc}/../lib/pry"
-
-class MathCommands < Pry::CommandBase
-  command "greet", "Greet a person, e.g: greet john" do |name|
-    output.puts "Good afternoon #{name.capitalize}! Do you like Math?"
-  end
-
-  command "add", "Add a list of numbers together, e.g: add 1 2 3 4" do |*args|
-    output.puts "Total: #{args.map(&:to_f).inject(&:+)}"
-  end
-
-  command "multiply", "Multiply a list of numbers together, e.g: multiply 1 2 3 4" do |*args|
-    output.puts "Total: #{args.map(&:to_f).inject(&:*)}"
-  end
-
-  # Explicitly giving a description of "" to prevent command being
-  # displayed in 'help'
-  command "exit", "" do
-    throw :breakout, 0
-  end
-
-  # Bring in the "!" method from Pry::Commands
-  import_from Pry::Commands, "!"
-end
-
-# Since we provide math commands, let's have mathematical
-# before_session and after_session hooks, and a mathematical prompt
-math_prompt = [proc { "math> " }, proc { "math* " }]
-math_hooks = {
-  :before_session => proc { |output, *| output.puts "Welcome! Let's do some math! Type 'help' for a list of commands." },
-  :after_session => proc { |output, *| output.puts "Goodbye!" }
-}
-
-# Start a Pry session using the commands defined in MyCommands
-# Type 'help' in Pry to get a list of the commands and their descriptions
-Pry.start(TOPLEVEL_BINDING, :commands => MathCommands, :prompt => math_prompt, :hooks => math_hooks)
+direc = File.dirname(__FILE__)
+
+require 'rubygems'
+require "#{direc}/../lib/pry"
+
+class MathCommands < Pry::CommandBase
+  command "greet", "Greet a person, e.g: greet john" do |name|
+    output.puts "Good afternoon #{name.capitalize}! Do you like Math?"
+  end
+
+  command "add", "Add a list of numbers together, e.g: add 1 2 3 4" do |*args|
+    output.puts "Total: #{args.map(&:to_f).inject(&:+)}"
+  end
+
+  command "multiply", "Multiply a list of numbers together, e.g: multiply 1 2 3 4" do |*args|
+    output.puts "Total: #{args.map(&:to_f).inject(&:*)}"
+  end
+
+  # Explicitly giving a description of "" to prevent command being
+  # displayed in 'help'
+  command "exit", "" do
+    throw :breakout, 0
+  end
+
+  # Bring in the "!" method from Pry::Commands
+  import_from Pry::Commands, "!"
+end
+
+# Since we provide math commands, let's have mathematical
+# before_session and after_session hooks, and a mathematical prompt
+math_prompt = [proc { "math> " }, proc { "math* " }]
+math_hooks = {
+  :before_session => proc { |output, *| output.puts "Welcome! Let's do some math! Type 'help' for a list of commands." },
+  :after_session => proc { |output, *| output.puts "Goodbye!" }
+}
+
+# Start a Pry session using the commands defined in MyCommands
+# Type 'help' in Pry to get a list of the commands and their descriptions
+Pry.start(TOPLEVEL_BINDING, :commands => MathCommands, :prompt => math_prompt, :hooks => math_hooks)

data/examples/example_hooks.rb

@@ -1,12 +1,12 @@
-direc = File.dirname(__FILE__)
-
-require 'rubygems'
-require "#{direc}/../lib/pry"
-
-my_hooks = {
-  :before_session => proc { |out, obj| out.puts "Opening #{obj}." },
-  :after_session => proc { |out, obj| out.puts "Closing #{obj}." }
-}
-           
-# Start a Pry session using the hooks hash defined in my_hooks
-Pry.start(TOPLEVEL_BINDING, :hooks => my_hooks)
+direc = File.dirname(__FILE__)
+
+require 'rubygems'
+require "#{direc}/../lib/pry"
+
+my_hooks = {
+  :before_session => proc { |out, target| out.puts "Opening #{target.eval('self')}." },
+  :after_session => proc { |out, target| out.puts "Closing #{target.eval('self')}." }
+}
+           
+# Start a Pry session using the hooks hash defined in my_hooks
+Pry.start(TOPLEVEL_BINDING, :hooks => my_hooks)

data/examples/example_image_edit.rb

@@ -1,71 +1,71 @@
-# Note: this requires you to have Gosu and TexPlay installed.
-# `gem install gosu`
-# `gem install texplay`
-# 
-# Extra instructions for installing Gosu on Linux can be found here:
-# http://code.google.com/p/gosu/wiki/GettingStartedOnLinux
-#
-# Instructions for using TexPlay can be found here:
-# http://banisterfiend.wordpress.com/2008/08/23/texplay-an-image-manipulation-tool-for-ruby-and-gosu/
-#
-# Have fun! :)
-
-direc = File.dirname(__FILE__)
-
-require 'rubygems'
-require "texplay"
-require "#{direc}/../lib/pry"
-
-WIDTH = 640
-HEIGHT = 480
-
-IMAGE_PROMPT = [ proc { "(image edit)> " }, proc { "(image edit)* " } ]
-
-class ImageCommands < Pry::CommandBase
-  command "drawing_methods", "Show a list of TexPlay methods" do
-    output.puts "#{Pry.view(TexPlay.public_instance_methods)}"
-  end
-
-  command "exit", "Exit the program." do
-    output.puts "Thanks for dropping by!"
-    exit
-  end
-
-  import_from Pry::Commands, "ls", "!"
-end
-
-class WinClass < Gosu::Window
-
-  def initialize
-    super(WIDTH, HEIGHT, false)
-    @img = TexPlay.create_image(self, 200, 200).clear :color => :black
-    @img.rect 0, 0, @img.width - 1, @img.height - 1
-
-    @binding = Pry.binding_for(@img)
-    
-    @pry_instance = Pry.new(:commands => ImageCommands, :prompt => IMAGE_PROMPT)
-  end
-
-  def draw
-    @img.draw_rot(WIDTH / 2, HEIGHT / 2, 1, 0, 0.5, 0.5) 
-  end
-
-  def update
-    exit if button_down?(Gosu::KbEscape)
-
-    # We do not want a REPL session as the loop prevents the image
-    # being updated; instead we do a REP session, and let the image
-    # update each time the user presses enter. We maintain the same
-    # binding object to keep locals between calls to `Pry#rep()`
-    @pry_instance.rep(@binding)
-  end
-end
-
-puts "Welcome to ImageEdit; type `help` for a list of commands and `drawing_methods` for a list of drawing methods available."
-puts "--"
-puts "Example: Try typing 'circle width/2, height/2, 95, :color => :blue, :fill => true'"
-puts "If you want to save your image, type: save(\"img.png\")"
-
-w = WinClass.new
-w.show
-
+# Note: this requires you to have Gosu and TexPlay installed.
+# `gem install gosu`
+# `gem install texplay`
+# 
+# Extra instructions for installing Gosu on Linux can be found here:
+# http://code.google.com/p/gosu/wiki/GettingStartedOnLinux
+#
+# Instructions for using TexPlay can be found here:
+# http://banisterfiend.wordpress.com/2008/08/23/texplay-an-image-manipulation-tool-for-ruby-and-gosu/
+#
+# Have fun! :)
+
+direc = File.dirname(__FILE__)
+
+require 'rubygems'
+require "texplay"
+require "#{direc}/../lib/pry"
+
+WIDTH = 640
+HEIGHT = 480
+
+IMAGE_PROMPT = [ proc { "(image edit)> " }, proc { "(image edit)* " } ]
+
+class ImageCommands < Pry::CommandBase
+  command "drawing_methods", "Show a list of TexPlay methods" do
+    output.puts "#{Pry.view(TexPlay.public_instance_methods)}"
+  end
+
+  command "exit", "Exit the program." do
+    output.puts "Thanks for dropping by!"
+    exit
+  end
+
+  import_from Pry::Commands, "ls", "!"
+end
+
+class WinClass < Gosu::Window
+
+  def initialize
+    super(WIDTH, HEIGHT, false)
+    @img = TexPlay.create_image(self, 200, 200).clear :color => :black
+    @img.rect 0, 0, @img.width - 1, @img.height - 1
+
+    @binding = Pry.binding_for(@img)
+    
+    @pry_instance = Pry.new(:commands => ImageCommands, :prompt => IMAGE_PROMPT)
+  end
+
+  def draw
+    @img.draw_rot(WIDTH / 2, HEIGHT / 2, 1, 0, 0.5, 0.5) 
+  end
+
+  def update
+    exit if button_down?(Gosu::KbEscape)
+
+    # We do not want a REPL session as the loop prevents the image
+    # being updated; instead we do a REP session, and let the image
+    # update each time the user presses enter. We maintain the same
+    # binding object to keep locals between calls to `Pry#rep()`
+    @pry_instance.rep(@binding)
+  end
+end
+
+puts "Welcome to ImageEdit; type `help` for a list of commands and `drawing_methods` for a list of drawing methods available."
+puts "--"
+puts "Example: Try typing 'circle width/2, height/2, 95, :color => :blue, :fill => true'"
+puts "If you want to save your image, type: save(\"img.png\")"
+
+w = WinClass.new
+w.show
+