pry 0.4.3 → 0.4.4

data/CHANGELOG

@@ -1,3 +1,9 @@
+27/1/2010 version 0.4.4
+* oops, added examples/ directory
+26/1/2010 version 0.4.3
+* added alias_command and desc methods to Pry::CommandBase
+* changed behaviour of ls_methods and ls_imethods to return sorted lists
+	of methods
 23/1/2010 version 0.4.1
 * made it so a 'def meth;end' in an object Pry session defines singleton
 	methods, not methods on the class (except in the case of
@@ -6,7 +12,7 @@
 * storing wiki in a nested git repo, as github wiki pages have their own
 	repo
 * added more tests for new method definition behaviour
-21/1/2010 version 0.4.0
+x21/1/2010 version 0.4.0
 * added command API
 * added many new commands, i.e ls_methods and friends
 * modified other commands

data/Rakefile

@@ -24,7 +24,7 @@ def apply_spec_defaults(s)
   s.add_development_dependency("bacon",">=1.1.0")
   s.homepage = "http://banisterfiend.wordpress.com"
   s.has_rdoc = 'yard'
-  s.files = Dir["ext/**/extconf.rb", "ext/**/*.h", "ext/**/*.c", "lib/**/*.rb",
+  s.files = Dir["ext/**/extconf.rb", "ext/**/*.h", "ext/**/*.c", "lib/**/*.rb", "examples/**/*.rb",
                      "test/*.rb", "CHANGELOG", "LICENSE", "README.markdown", "Rakefile", ".gemtest"]
 end
 

data/examples/example_command_override.rb

@@ -0,0 +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"
+
+  # analagy 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

@@ -0,0 +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)

data/examples/example_hooks.rb

@@ -0,0 +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)

data/examples/example_image_edit.rb

@@ -0,0 +1,70 @@
+# 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", "ls_methods", "!"
+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 = @img.__binding__
+    
+    @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\")"
+
+WinClass.new.show
+

data/examples/example_input.rb

@@ -0,0 +1,10 @@
+direc = File.dirname(__FILE__)
+
+require 'rubygems'
+require "#{direc}/../lib/pry"
+
+# Create a StringIO that contains the input data
+str_input = StringIO.new("puts 'hello world!'\nputs \"I am in \#{self}\"\nexit")
+
+# Start a Pry session on the Fixnum 5 using the input data in str_input
+Pry.start(5, :input => str_input)

data/examples/example_input2.rb

@@ -0,0 +1,32 @@
+direc = File.dirname(__FILE__)
+
+require 'rubygems'
+require "#{direc}/../lib/pry"
+
+# Create a StringIO that contains the input data for all the Pry objects
+cmds = <<-CMDS
+cd 1
+status
+puts 'hello from 1!!'
+cd 2
+nesting
+puts 'hello from 2!!'
+_pry_.parent.input = Readline
+back
+exit_all
+CMDS
+
+# create our StringIO object
+str_input = StringIO.new(cmds)
+
+# set global input to str_input, this means that all pry sessions
+# adopt this object as their input object.
+Pry.input = str_input
+
+# Start the session reading from str_input.
+# Note that because `Pry.input` is set to `str_input` all nested pry
+# sessions will read from `str_input` too. All pry sessions are there
+# for non-interactive, except for `pry(1)` which starts off
+# non-interactive but is set to be interactive by pry(2) (using
+# _pry_.parent.input = Readline)
+0.pry

data/examples/example_output.rb

@@ -0,0 +1,14 @@
+direc = File.dirname(__FILE__)
+
+require 'rubygems'
+require "#{direc}/../lib/pry"
+
+# Create a StringIO to contain the output data
+str_output = StringIO.new
+
+# Start a Pry session on the Fixnum 5 using str_output to store the
+# output (not writing to $stdout)
+Pry.start(5, :output => str_output)
+
+# Display all the output accumulated during the session
+puts str_output.string

data/examples/example_print.rb

@@ -0,0 +1,9 @@
+direc = File.dirname(__FILE__)
+
+require 'rubygems'
+require "#{direc}/../lib/pry"
+
+my_print = proc { |out, value| out.puts "Output is: #{value.inspect}" }
+           
+# Start a Pry session using the print object defined in my_print
+Pry.start(TOPLEVEL_BINDING, :print => my_print)

data/examples/example_prompt.rb

@@ -0,0 +1,12 @@
+direc = File.dirname(__FILE__)
+
+require 'rubygems'
+require "#{direc}/../lib/pry"
+
+# Remember, first prompt in array is the main prompt, second is the wait
+# prompt (used for multiline input when more input is required)
+my_prompt = [ proc { |obj, *| "inside #{obj}> " },
+           proc { |obj, *| "inside #{obj}* "} ]
+           
+# Start a Pry session using the prompt defined in my_prompt
+Pry.start(TOPLEVEL_BINDING, :prompt => my_prompt)

data/lib/pry/version.rb

@@ -1,3 +1,3 @@
 class Pry
-  VERSION = "0.4.3"
+  VERSION = "0.4.4"
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 4
-  - 3
-  version: 0.4.3
+  - 4
+  version: 0.4.4
 platform: ruby
 authors: 
 - John Mair (banisterfiend)
@@ -82,6 +82,15 @@ files:
 - lib/pry/pry_instance.rb
 - lib/pry/version.rb
 - lib/pry.rb
+- examples/example_commands.rb
+- examples/example_command_override.rb
+- examples/example_hooks.rb
+- examples/example_image_edit.rb
+- examples/example_input.rb
+- examples/example_input2.rb
+- examples/example_output.rb
+- examples/example_print.rb
+- examples/example_prompt.rb
 - test/test.rb
 - test/test_helper.rb
 - CHANGELOG