pry 0.8.3 → 0.8.4pre1

data/.document

@@ -0,0 +1,2 @@
+-
+wiki/*.md

data/.gitignore

@@ -0,0 +1,8 @@
+Makefile
+*.so
+*.o
+*.def
+doc/
+pkg/
+coverage/
+.yardoc/

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --private

data/README.markdown

@@ -420,11 +420,11 @@ You can use `edit-method Class#method` or `edit-method my_method`
 your favorite editor. Pry has knowledge of a few different editors and
 will attempt to open the file at the line the method is defined.
 
-You can set the editor to use by assigning to the `Pry.editor=`
+You can set the editor to use by assigning to the `Pry.editor`
 accessor. `Pry.editor` will default to `$EDITOR` or failing that will
 use `nano` as the backup default. The file that is edited will be
 automatically reloaded after exiting the editor - reloading can be
-suppressed by passing the --no-reload option to `edit-method`
+suppressed by passing the `--no-reload` option to `edit-method`
 
 In the example below we will set our default editor to "emacsclient"
 and open the `Pry#repl` method for editing:
@@ -432,7 +432,6 @@ and open the `Pry#repl` method for editing:
     pry(main)> Pry.editor = "emacsclient"
     pry(main)> edit-method Pry#repl
 
-
 ### Live Help System
 
 Many other commands are available in Pry; to see the full list type
@@ -442,6 +441,11 @@ help that can be accessed via typing `command_name --help`. A command
 will typically say in its description if the `--help` option is
 avaiable.
 
+### Use Pry as your Rails Console
+
+    pry -r./config/environment
+
+MyArtChannel has kindly provided a hack to replace the `rails console` command in Rails 3: [https://gist.github.com/941174](https://gist.github.com/941174) This is not recommended for code bases with multiple developers, as they may not all want to use Pry.
 
 ### Other Features and limitations
 
@@ -482,13 +486,13 @@ invoke any of these methods directly depending on exactly what aspect of the fun
 
 #### Limitations:
 
-* Some Pry commands (e.g `show-command`) do not work in Ruby 1.8.
+* Some Pry commands (e.g `show-command`) do not work in Ruby 1.8
+  MRI. But many other commands do work in Ruby 1.8 MRI, e.g
+  `show-method`, due to a functional 1.8 source_location implementation.
 * JRuby not officially supported due to currently too many quirks and
  strange behaviour. Nonetheless most functionality should still work
  OK in JRuby. Full JRuby support coming in a future version.
 * `method_source` functionality does not work in JRuby with Ruby 1.8
-* Color support does not work in JRuby with Ruby 1.9 (due to a
-  limitation in JRuby's regex).
 * Tab completion is currently a bit broken/limited this will have a
    major overhaul in a future version.
 

data/Rakefile

@@ -1,42 +1,38 @@
-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", "**/*.rbc")
+$:.unshift 'lib'
+require 'pry/version'
+
+CLOBBER.include("**/*~", "**/*#*", "**/*.log")
+CLEAN.include("**/*#*", "**/*#*.*", "**/*_flymake*.*", "**/*_flymake", "**/*.rbc")
 
 def apply_spec_defaults(s)
   s.name = "pry"
-  s.summary = "attach an irb-like session to any object at runtime"
+  s.summary = "an IRB alternative and runtime developer console"
   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.add_dependency("coderay",">=0.9.7")
-  s.add_dependency("slop",">=1.5.3")
-  s.add_development_dependency("bacon",">=1.1.0")
   s.homepage = "http://banisterfiend.wordpress.com"
   s.has_rdoc = 'yard'
   s.executables = ["pry"]
-  s.files = Dir["ext/**/extconf.rb", "ext/**/*.h", "ext/**/*.c", "lib/**/*", "examples/**/*.rb",
-                "test/*.rb", "test/testrc", "CHANGELOG", "LICENSE", "README.markdown", "Rakefile", ".gemtest"]
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- test/*`.split("\n")
+  s.add_dependency("ruby_parser",">=2.0.5")
+  s.add_dependency("coderay",">=0.9.8")
+  s.add_dependency("slop",">=1.5.3")
+  s.add_dependency("method_source",">=0.4.0")
+  s.add_development_dependency("bacon",">=1.1.0")
 end
 
 task :test do
-  sh "bacon #{direc}/test/test.rb"
+  sh "bacon -Itest -rubygems -a"
 end
 
 desc "run pry"
 task :pry do
-  $LOAD_PATH.unshift "#{direc}/lib"
   require 'pry'
   binding.pry
 end
@@ -49,7 +45,6 @@ end
 namespace :ruby do
   spec = Gem::Specification.new do |s|
     apply_spec_defaults(s)
-    s.add_dependency("method_source",">=0.4.0")
     s.platform = Gem::Platform::RUBY
   end
 
@@ -63,7 +58,6 @@ end
   namespace v do
     spec = Gem::Specification.new do |s|
       apply_spec_defaults(s)
-      s.add_dependency("method_source",">=0.4.0")
       s.add_dependency("win32console", ">=1.3.0")
       s.platform = "i386-#{v}"
     end
@@ -78,7 +72,6 @@ end
 namespace :jruby do
   spec = Gem::Specification.new do |s|
     apply_spec_defaults(s)
-    s.add_dependency("method_source",">=0.4.0")
     s.platform = "java"
   end
 
@@ -88,7 +81,6 @@ namespace :jruby do
   end
 end
 
-
 desc "build all platform gems at once"
 task :gems => [:clean, :rmgems, "ruby:gem", "jruby:gem", "mswin32:gem", "mingw32:gem"]
 
@@ -97,7 +89,7 @@ task :rmgems => ["ruby:clobber_package"]
 
 desc "build and push latest gems"
 task :pushgems => :gems do
-  chdir("#{direc}/pkg") do
+  chdir("#{File.dirname(__FILE__)}/pkg") do
     Dir["*.gem"].each do |gemfile|
       sh "gem push #{gemfile}"
     end

data/TODO

@@ -0,0 +1,62 @@
+
+FUTURE
+* allows pipes (|) for commands
+
+0.8.0
+* allow #{} interpolation of all commands
+* update documentation! new commands and features and change in behaviour of `run`
+* add ; at end of line to suppress return value output
+* Remove message spam (before/after hooks)
+* stop commands returning a value 
+* use `redo` in the r() method when encounter a command
+* shell functionality should just use system(), but redirect in and
+   out to Pry.input and Pry.output by reassining $stdin and $stdout
+   for duration of block.
+* basicobject and no to_s/inspect support
+* fix documentation, support rdoc and yard properly
+* only load Ripper if 1.9 AND MRI (support jruby 1.9, using
+   RubyParser)
+* shell commands invokable file .<command>
+* supercharge cat-file so it can syntax highlight sourcecode files
+
+
+0.7.0
+* add pry-doc support with syntax highlighting for docs
+* add 'mj' option to ls (restrict to singleton methods)
+* add _ex_ local to hold last exception raised in an exception
+
+0.6.8
+* add whereami command, a la the `ir_b` gem
+* make .pryrc be loaded by run-time pry sessions
+
+0.6.7
+* color support
+* --simple-prompt for pry commandline
+* -I mode for pry commandline
+* --color mode for pry commandline
+* clean up requires (put them all in one place)
+* simple-prompt command and toggle-color commandd.
+
+0.6.1
+* !@ command alias for exit_all
+* `cd /` for breaking out to pry top level (jump-to 0)
+* made `-e` option work in a more effective way for `pry` command line invocation
+* exit and exit-all commands now accept a parameter, this parameter becomes the return value of repl()
+* `command` method from CommandBase now accepts a :keep_retval arg that determines if command value is returned to pry session or just `nil` (`nil` was old behaviour)
+* tests for new :keep_retval and exit-all/exit behaviour; :keep_retval will remain undocumented.
+
+0.5.0 release:
+* !!!! UPDATE DOCUMENTATION !!!!
+* Use clipped version of Pry.view() for large objects
+* Exit Pry session on ^d
+* Use Shellwords for breaking up parameters to pry commands
+* Use OptionParser to parse options for default pry commands
+* Add version command
+* Refactor 'status' command: add current method info
+* Add meth_name_from_binding utility lambda to commands.rb
+* Add -M, -m, -v(erbose), -a(ll), -s(uper), -l(ocals), -i(ivars), -k(klass vars) options to ls
+* add -i(nstance) option to show-method
+* add --help option to most commands
+* Get rid of ls_method and ls_imethods (subsumed by more powerful ls)
+* Get rid of show_idoc and show_imethod
+* Add special eval-file command that evals target file in current context

data/bin/pry

@@ -3,6 +3,8 @@
 # (C) John Mair (banisterfiend)
 # MIT license
 
+$0 = 'pry'
+
 begin
   require 'pry'
 rescue LoadError
@@ -48,7 +50,7 @@ end
 # invoked via cli
 Pry.cli = true
 
-class Pry::Commands
+Pry::Commands.instance_eval do
   command "reset", "Reset the REPL to a clean state." do
     output.puts "Pry reset."
     exec("pry")

data/lib/pry.rb

@@ -6,6 +6,9 @@ require 'shellwords'
 require "readline"
 require "stringio"
 require "coderay"
+require "optparse"
+require "slop"
+require "rubygems/dependency_installer"
 
 if RUBY_PLATFORM =~ /mswin/ || RUBY_PLATFORM =~ /mingw/
   begin
@@ -19,17 +22,13 @@ end
 require "pry/version"
 require "pry/hooks"
 require "pry/print"
-require "pry/command_base"
+require "pry/helpers"
+require "pry/command_set"
 require "pry/commands"
+require "pry/command_context"
 require "pry/prompts"
 require "pry/custom_completions"
 require "pry/completion"
 require "pry/core_extensions"
 require "pry/pry_class"
 require "pry/pry_instance"
-
-
-# TEMPORARY HACK FOR BUG IN JRUBY 1.9 REGEX (which kills CodeRay)
-if RUBY_VERSION =~ /1.9/ && RUBY_ENGINE =~ /jruby/
-  Pry.color = false
-end

data/lib/pry/command_context.rb

@@ -0,0 +1,29 @@
+class Pry
+  # Command contexts are the objects runing each command.
+  # Helper modules can be mixed into this class.
+  class CommandContext
+    attr_accessor :output
+    attr_accessor :target
+    attr_accessor :opts
+    attr_accessor :command_set
+    attr_accessor :command_processor
+
+    def run(name, *args)
+      if name.start_with? "."
+        cmd = name[1..-1]
+        command_processor.
+          execute_system_command([name, Shellwords.join(args)].join(' '),
+                                 target)
+      else
+        command_set.run_command(self, name, *args)
+      end
+    end
+
+    def commands
+      command_set.commands
+    end
+
+    include Pry::Helpers::BaseHelpers
+    include Pry::Helpers::CommandHelpers
+  end
+end

data/lib/pry/command_processor.rb

@@ -68,7 +68,7 @@ class Pry
           else
             dest = File.expand_path($1)
           end
-          
+
           @@cd_history << Dir.pwd
           Dir.chdir(dest)
         rescue Errno::ENOENT
@@ -119,11 +119,9 @@ class Pry
       return if !pry_command?(val)
 
       val.replace interpolate_string(val, target)
-      cmd_data, args_string = command_matched(val)
+      command, args_string = command_matched(val)
 
       args = args_string ? Shellwords.shellwords(args_string) : []
-      action = cmd_data[:action]
-      keep_retval = cmd_data[:keep_retval]
 
       options = {
         :val => val,
@@ -132,43 +130,32 @@ class Pry
         :commands => commands.commands
       }
 
-      ret_value = execute_command(target, action, options, *args)
-
-      # return value of block only if :keep_retval is true
-      ret_value if keep_retval
+      execute_command(target, command.name, options, *args)
     end
 
     # Execute a Pry command.
     # This method should not need to be invoked directly.
     # @param [Binding] target The target of the Pry session.
-    # @param [Proc] action The proc that implements the command.
+    # @param [String] command The name of the command to be run.
     # @param [Hash] options The options to set on the Commands object.
     # @param [Array] args The command arguments.
-    def execute_command(target, action, options, *args)
+    def execute_command(target, command, options, *args)
+      context = CommandContext.new
 
       # set some useful methods to be used by the action blocks
-      commands.opts = options
-      commands.target = target
-      commands.output = output
-
-      case action.arity <=> 0
-      when -1
-
-        # Use instance_exec() to make the `opts` method, etc available
-        ret_val = commands.instance_exec(*args, &action)
-      when 1, 0
-
-        # ensure that we get the right number of parameters
-        # since 1.8.7 complains about incorrect arity (1.9.2
-        # doesn't care)
-        args_with_corrected_arity = args.values_at *0..(action.arity - 1)
-        ret_val = commands.instance_exec(*args_with_corrected_arity, &action)
-      end
+      context.opts        = options
+      context.target      = target
+      context.output      = output
+      context.command_set = commands
+
+      context.command_processor = self
+
+      ret = commands.run_command(context, command, *args)
 
       # Tick, tock, im getting rid of this shit soon.
       options[:val].clear
 
-      ret_val
+      ret
     end
   end
 end

data/lib/pry/command_set.rb

@@ -0,0 +1,234 @@
+class Pry
+  class NoCommandError < StandardError
+    def initialize(name, owner)
+      super "Command '#{name}' not found in command set #{owner}"
+    end
+  end
+
+  # This class used to create sets of commands. Commands can be impoted from
+  # different sets, aliased, removed, etc.
+  class CommandSet
+    class Command < Struct.new(:name, :description, :options, :block)
+
+      def call(context, *args)
+        if stub_block = options[:stub_info]
+          context.instance_eval(&stub_block)
+        else
+          ret = context.instance_exec(*correct_arg_arity(block.arity, args), &block)
+          ret if options[:keep_retval]
+        end
+      end
+
+      private
+      def correct_arg_arity(arity, args)
+        case arity <=> 0
+        when -1
+          args
+        when 1, 0
+          # Keep 1.8 happy
+          args.values_at *0..(arity - 1)
+        end
+      end
+    end
+
+    include Pry::Helpers::BaseHelpers
+
+    attr_reader :commands
+    attr_reader :name
+    attr_reader :helper_module
+
+    # @param [Symbol] name Name of the command set
+    # @param [Array<CommandSet>] imported_sets Sets which will be imported
+    #   automatically
+    # @yield Optional block run to define commands
+    def initialize(name, *imported_sets, &block)
+      @name          = name
+      @commands      = {}
+      @helper_module = Module.new
+
+      define_default_commands
+      import(*imported_sets)
+
+      instance_eval(&block) if block
+    end
+
+    # Defines a new Pry command.
+    # @param [String, Array] names The name of the command (or array of
+    #   command name aliases).
+    # @param [String] description A description of the command.
+    # @param [Hash] options The optional configuration parameters.
+    # @option options [Boolean] :keep_retval Whether or not to use return value
+    #   of the block for return of `command` or just to return `nil`
+    #   (the default).
+    # @yield The action to perform. The parameters in the block
+    #   determines the parameters the command will receive. All
+    #   parameters passed into the block will be strings. Successive
+    #   command parameters are separated by whitespace at the Pry prompt.
+    # @example
+    #   MyCommands = Pry::CommandSet.new :mine do
+    #     command "greet", "Greet somebody" do |name|
+    #       puts "Good afternoon #{name.capitalize}!"
+    #     end
+    #   end
+    #
+    #   # From pry:
+    #   # pry(main)> _pry_.commands = MyCommands
+    #   # pry(main)> greet john
+    #   # Good afternoon John!
+    #   # pry(main)> help greet
+    #   # Greet somebody
+    def command(names, description="No description.", options={}, &block)
+      first_name = Array(names).first
+
+      options = {:requires_gem => []}.merge(options)
+
+      unless command_dependencies_met? options
+        gems_needed = Array(options[:requires_gem])
+        gems_not_installed = gems_needed.select { |g| !gem_installed?(g) }
+
+        options[:stub_info] = proc do
+          output.puts "\n#{first_name} requires the following gems to be installed: #{(gems_needed.join(", "))}"
+          output.puts "Command not available due to dependency on gems: `#{gems_not_installed.join(", ")}` not being met."
+          output.puts "Type `install #{first_name}` to install the required gems and activate this command."
+        end
+      end
+
+      Array(names).each do |name|
+        commands[name] = Command.new(name, description, options, block)
+      end
+    end
+
+    # Removes some commands from the set
+    # @param [Array<String>] names name of the commands to remove
+    def delete(*names)
+      names.each { |name| commands.delete name }
+    end
+
+    # Imports all the commands from one or more sets.
+    # @param [Array<CommandSet>] sets Command sets, all of the commands of which
+    #   will be imported.
+    def import(*sets)
+      sets.each do |set|
+        commands.merge! set.commands
+        helper_module.send :include, set.helper_module
+      end
+    end
+
+    # Imports some commands from a set
+    # @param [CommandSet] set Set to import commands from
+    # @param [Array<String>] names Commands to import
+    def import_from(set, *names)
+      helper_module.send :include, set.helper_module
+      names.each { |name| commands[name] = set.commands[name] }
+    end
+
+    # Aliases a command
+    # @param [String] new_name New name of the command.
+    # @param [String] old_name Old name of the command.
+    # @pasam [String, nil] desc New description of the command.
+    def alias_command(new_name, old_name, desc = nil)
+      commands[new_name] = commands[old_name].dup
+      commands[new_name].name = new_name
+      commands[new_name].description = desc if desc
+    end
+
+    # Runs a command.
+    # @param [Object] context Object which will be used as self during the
+    #   command.
+    # @param [String] name Name of the command to be run
+    # @param [Array<Object>] args Arguments passed to the command
+    # @raise [NoCommandError] If the command is not defined in this set
+    def run_command(context, name, *args)
+      context.extend helper_module
+
+      if command = commands[name]
+        command.call(context, *args)
+      else
+        raise NoCommandError.new(name, self)
+      end
+    end
+
+    # Sets the description for a command (replacing the old
+    # description.)
+    # @param [String] name The command name.
+    # @param [String] description The command description.
+    # @example
+    #   MyCommands = Pry::CommandSet.new :test do
+    #     desc "help", "help description"
+    #   end
+    def desc(name, description)
+      commands[name].description = description
+    end
+
+    # Defines helpers methods for this command sets.
+    # Those helpers are only defined in this command set.
+    #
+    # @yield A block defining helper methods
+    # @example
+    #   helpers do
+    #     def hello
+    #       puts "Hello!"
+    #     end
+    #
+    #     include OtherModule
+    #   end
+    def helpers(&block)
+      helper_module.class_eval(&block)
+    end
+
+    private
+    def define_default_commands
+      command "help", "This menu." do |cmd|
+        if !cmd
+          output.puts
+          help_text = heading("Command List: ") + "\n"
+
+          commands.each do |key, command|
+            if command.description && !command.description.empty?
+              help_text << "#{key}".ljust(18) + command.description + "\n"
+            end
+          end
+
+          stagger_output(help_text)
+        else
+          if command = commands[cmd]
+            output.puts command.description
+          else
+            output.puts "No info for command: #{cmd}"
+          end
+        end
+      end
+
+      command "install", "Install a disabled command." do |name|
+        stub_info = commands[name].options[:stub_info]
+
+        if !stub_info
+          output.puts "Not a command stub. Nothing to do."
+          next
+        end
+
+        output.puts "Attempting to install `#{name}` command..."
+        gems_to_install = Array(commands[name].options[:requires_gem])
+
+        gem_install_failed = false
+        gems_to_install.each do |g|
+          next if gem_installed?(g)
+          output.puts "Installing `#{g}` gem..."
+
+          begin
+            Gem::DependencyInstaller.new.install(g)
+          rescue Gem::GemNotFoundException
+            output.puts "Required Gem: `#{g}` not found. Aborting command installation."
+            gem_install_failed = true
+            next
+          end
+        end
+        next if gem_install_failed
+
+        Gem.refresh
+        commands[name].options.delete :stub_info
+        output.puts "Installation of `#{name}` successful! Type `help #{name}` for information"
+      end
+    end
+  end
+end