pry 0.1.0

data/CHANGELOG

@@ -0,0 +1,3 @@
+8/12/2010 version 0.1.0
+* release!
+	

data/README.markdown

@@ -0,0 +1,133 @@
+Pry
+=============
+
+(C) John Mair (banisterfiend) 2010
+
+_attach an irb-like session to any object_
+
+Pry is a simple Ruby REPL that specializes in the interactive
+manipulation of objects during the running of a program.
+
+* Install the [gem](https://rubygems.org/gems/pry): `gem install pry`
+* Read the [documentation](http://rdoc.info/github/banister/pry/master/file/README.markdown)
+* See the [source code](http://github.com/banister/pry)
+
+example: prying on an object at runtime 
+---------------------------------------
+
+With the `Pry.into()` 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 program is halted for the duration of the session.
+
+    require 'pry'
+    
+    class Test
+      def self.hello() "hello world" end
+    end
+
+    Pry.into(Test)
+
+    # Pry session begins on stdin
+    Beginning Pry session for Test
+    pry(Test)> self
+    => Test
+    pry(Test)> hello
+    => "hello world"
+    pry(Test)> @y = 20
+    => 20
+    pry(Test)> exit
+    Ending Pry session for Test
+
+    # program resumes here
+
+If we now inspect the `Test` object we can see our changes have had
+effect:
+
+    Test.instance_variable_get(:@y) #=> 20
+    
+
+example: Pry sessions can nest arbitrarily deep so we can pry on objects inside objects:
+----------------------------------------------------------------------------------------
+
+Here we will begin Pry at top-level, then pry on a class and then on
+an instance variable inside that class:
+
+    # Pry.into() without parameters begins a Pry session on top-level (main)
+    Pry.into
+    Beginning Pry session for main
+    pry(main)> class Hello
+    pry(main)*   @x = 20
+    pry(main)* end
+    => 20
+    pry(main)> Pry.into Hello
+    Beginning Pry session for Hello
+    pry(Hello)> instance_variables
+    => [:@x]
+    pry(Hello)> Pry.into @x
+    Beginning Pry session for 20
+    pry(20)> self + 10
+    => 30
+    pry(20)> exit
+    Ending Pry session for 20
+    pry(Hello)> exit
+    Ending Pry session for Hello
+    pry(main)> exit
+    Ending Pry session for main
+
+    # program resumes here
+
+
+example: Spawn a separate thread so you can use `Pry` to manipulate an
+object without halting the program. 
+---------------------------------------------------------------------------------------------------
+
+If we embed our `Pry.into` method inside its own thread we can examine
+and manipulate objects without halting the program.
+
+    # Pry.into() without parameters opens up the top-level (main)
+    Thread.new { Pry.into }
+    
+
+Features and limitations
+------------------------
+
+Pry is an irb-like clone with an emphasis on interactively examining
+and manipulating objects during the running of a program.
+
+Its primary utility is probably in debugging, though it may have other
+uses (such as implementing a quake-like console for games, for example). Here is a
+list of Pry's features along with some of its limitations given at the
+end.
+
+Features:
+
+* 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'
+* Pry has multi-line support built in.
+* Pry implements all the methods in the REPL chain separately: `Pry.r`
+for reading; `Pry.re` for eval; `Pry.rep` for printing; and `Pry.repl`
+for the loop (`Pry.into` is simply an alias for `Pry.repl`). You can
+invoke any of these methods directly depending on exactly what aspect of the functionality you need.
+
+Limitations:
+
+* Pry does not pretend to be a replacement for `irb`,
+  and so does not have an executable. It is designed to be used by
+  other programs, not on its own. For a full-featured `irb` replacement
+  see [ripl](https://github.com/cldwalker/ripl)
+* Although Pry works fine in Ruby 1.9, only Ruby 1.8 syntax is
+  supported. This is because Pry uses the
+  [RubyParser](https://github.com/seattlerb/ruby_parser)
+  gem internally to  validate expressions, and RubyParser, as yet, only parses Ruby 1.8
+  code. In practice this usually just means you cannot use the new
+  hash literal syntax (this: syntax) or the 'stabby lambda' syntax
+  (->).
+ 
+
+Contact
+-------
+
+Problems or questions contact me at [github](http://github.com/banister)
+
+
+

data/Rakefile

@@ -0,0 +1,58 @@
+dlext = Config::CONFIG['DLEXT']
+direc = File.dirname(__FILE__)
+
+require 'rake/clean'
+require 'rake/gempackagetask'
+require "#{direc}/lib/pry/version"
+
+CLOBBER.include("**/*.#{dlext}", "**/*~", "**/*#*", "**/*.log", "**/*.o")
+CLEAN.include("ext/**/*.#{dlext}", "ext/**/*.log", "ext/**/*.o",
+              "ext/**/*~", "ext/**/*#*", "ext/**/*.obj",
+              "ext/**/*.def", "ext/**/*.pdb", "**/*_flymake*.*", "**/*_flymake")
+
+def apply_spec_defaults(s)
+  s.name = "pry"
+  s.summary = "attach an irb-like session to any object"
+  s.version = Pry::VERSION
+  s.date = Time.now.strftime '%Y-%m-%d'
+  s.author = "John Mair (banisterfiend)"
+  s.email = 'jrmair@gmail.com'
+  s.description = s.summary
+  s.require_path = 'lib'
+  s.add_dependency("ruby_parser",">=2.0.5")
+  s.homepage = "http://banisterfiend.wordpress.com"
+  s.has_rdoc = 'yard'
+  s.files = Dir["ext/**/extconf.rb", "ext/**/*.h", "ext/**/*.c", "lib/**/*.rb",
+                     "test/*.rb", "CHANGELOG", "README.markdown", "Rakefile"]
+end
+
+task :test do
+  sh "bacon -k #{direc}/test/test.rb"
+end
+
+namespace :ruby do
+  spec = Gem::Specification.new do |s|
+    apply_spec_defaults(s)        
+    s.platform = Gem::Platform::RUBY
+  end
+  
+  Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.need_zip = false
+    pkg.need_tar = false
+  end
+end
+
+desc "build all platform gems at once"
+task :gems => [:rmgems, "ruby:gem"]
+
+desc "remove all platform gems"
+task :rmgems => ["ruby:clobber_package"]
+
+desc "build and push latest gems"
+task :pushgems => :gems do
+  chdir("#{direc}/pkg") do
+    Dir["*.gem"].each do |gemfile|
+      sh "gem push #{gemfile}"
+    end
+  end
+end

data/lib/pry.rb

@@ -0,0 +1,101 @@
+require 'rubygems'
+require 'readline'
+require 'ruby_parser'
+
+module Pry
+  class << self
+    attr_accessor :default_prompt, :wait_prompt,
+    :session_start_msg, :session_end_msg
+  end
+  
+  @default_prompt = proc { |v| "pry(#{v})> " }
+  @wait_prompt = proc { |v| "pry(#{v})* " }
+  @session_start_msg = proc { |v| "Beginning Pry session for #{v}" }
+  @session_end_msg = proc { |v| "Ending Pry session for #{v}" }
+  
+  # loop
+  def self.repl(target=TOPLEVEL_BINDING)
+    if !target.is_a?(Binding)
+      target = target.instance_eval { binding }
+    end
+    
+    puts session_start_msg.call(target.eval('self'))
+
+    loop do
+      if catch(:pop) { rep(target) } == :return
+        break target.eval('self')
+      end
+    end
+
+    puts session_end_msg.call(target.eval('self'))
+  end
+
+  class << self
+    alias_method :into, :repl
+    alias_method :start, :repl
+  end
+  
+  # print
+  def self.rep(target=TOPLEVEL_BINDING)
+    if !target.is_a?(Binding)
+      target = target.instance_eval { binding }
+    end
+
+    value = re(target)
+    case value
+    when Exception
+      puts "#{value.class}: #{value.message}"
+    else
+      puts "=> #{value.inspect}"
+    end
+  end
+
+  # eval
+  def self.re(target=TOPLEVEL_BINDING)
+    target.eval r(target)
+  rescue StandardError => e
+    e
+  end
+
+  # read
+  def self.r(target=TOPLEVEL_BINDING)
+    eval_string = ""
+    loop do
+      val = Readline.readline(prompt(eval_string, target), true)
+      eval_string += "#{val}\n"
+      process_commands(val, eval_string, target)
+      
+      break eval_string if valid_expression?(eval_string)
+    end
+  end
+  
+  def self.process_commands(val, eval_string, target)
+    case val
+    when "#exit", "#quit"
+      exit
+    when "!"
+      eval_string.replace("")
+      puts "Refreshed REPL."
+    when "exit", "quit"
+      throw(:pop, :return)
+    end
+  end
+
+  def self.prompt(eval_string, target)
+    context = target.eval('self')
+    
+    if eval_string.empty?
+      default_prompt.call(context)
+    else
+      wait_prompt.call(context)
+    end
+  end
+
+  def self.valid_expression?(code)
+    RubyParser.new.parse(code)
+  rescue Racc::ParseError
+    false
+  else
+    true
+  end
+end

data/lib/pry/version.rb

@@ -0,0 +1,3 @@
+module Pry
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: pry
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- John Mair (banisterfiend)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-09 00:00:00 +13:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby_parser
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 5
+        version: 2.0.5
+  type: :runtime
+  version_requirements: *id001
+description: attach an irb-like session to any object
+email: jrmair@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/pry/version.rb
+- lib/pry.rb
+- CHANGELOG
+- README.markdown
+- Rakefile
+has_rdoc: yard
+homepage: http://banisterfiend.wordpress.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: attach an irb-like session to any object
+test_files: []
+