pry 0.8.0pre7 → 0.8.0pre8

data/README.markdown

@@ -3,9 +3,23 @@ Pry
 
 (C) John Mair (banisterfiend) 2011
 
-_attach an irb-like session to any object at runtime_
-
-Pry is a simple Ruby REPL (Read-Eval-Print-Loop) that specializes in the interactive
+_Ruby voyeurism_
+
+Pry is a powerful alternative to the standard IRB shell for Ruby. It is
+written from scratch to provide a number of advanced features, some of
+these include:
+
+* Runtime invocation
+* Syntax highlighting
+* Command shell integration
+* Source code browsing (including core C source with the pry-doc gem)
+* Documentation browsing 
+* Exotic object support (BasicObject instances, IClasses, ...)
+* A Powerful and flexible command system
+* Gisting ability
+* Many convenience commands
+
+Pry is a Ruby REPL (Read-Eval-Print-Loop) that specializes in the interactive
 manipulation of objects during the running of a program.
 
 In some sense it is the opposite of IRB in that you bring a REPL

data/lib/pry/command_base.rb

@@ -1,9 +1,14 @@
+direc = File.dirname(__FILE__)
+require "#{direc}/command_base_helpers"
+
 class Pry
 
   # Basic command functionality. All user-defined commands must
   # inherit from this class. It provides the `command` method.
   class CommandBase
     class << self
+      include CommandBaseHelpers
+      
       attr_accessor :commands
       attr_accessor :opts, :output, :target
 
@@ -39,17 +44,22 @@ class Pry
       #   # Greet somebody
       def command(names, description="No description.", options={}, &block)
         options = {
-          :keep_retval => false
+          :keep_retval => false,
+          :requires_gem => nil
         }.merge!(options)
         
         @commands ||= {}
 
-        Array(names).each do |name|
-          commands[name] = {
-            :description => description,
-            :action => block,
-            :keep_retval => options[:keep_retval]
-          }
+        if command_dependencies_met?(options)
+          Array(names).each do |name|
+            commands[name] = {
+              :description => description,
+              :action => block,
+              :keep_retval => options[:keep_retval]
+            }
+          end
+        else
+          create_command_stub(names, description, options, block)
         end
       end
 
@@ -133,10 +143,16 @@ class Pry
       command_info = opts[:commands]
 
       if !cmd
-        output.puts "Command list:\n--"
+        output.puts
+        help_text = heading("Command List:") + "\n" 
         command_info.each do |k, data|
-          output.puts "#{k}".ljust(18) + data[:description] if !data[:description].empty?
+          if !data[:stub_info]
+            help_text << ("#{k}".ljust(18) + data[:description] + "\n") if !data[:description].empty?
+          else
+            help_text << (bold("#{k}".ljust(18) + data[:description] + "\n")) if !data[:description].empty?
+          end
         end
+        stagger_output(help_text)
       else
         if command_info[cmd]
           output.puts command_info[cmd][:description]
@@ -146,6 +162,39 @@ class Pry
       end
     end
 
+    command "install", "Install a disabled command." do |name|
+      stub_info = commands[name][:stub_info]
+
+      if !stub_info
+        output.puts "Not a command stub. Nothing to do."
+        next
+      end
+
+      output.puts "Attempting to install `#{name}` command..."
+      
+      require 'rubygems/dependency_installer'
+      gems_to_install = Array(stub_info[: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
+      load "#{File.dirname(__FILE__)}/commands.rb"
+      output.puts "Installation of `#{name}` successful! Type `help #{name}` for information"
+    end
+
     # Ensures that commands can be inherited
     def self.inherited(klass)
       klass.commands = commands.dup

data/lib/pry/command_base_helpers.rb

@@ -0,0 +1,110 @@
+class Pry
+  class CommandBase
+    module CommandBaseHelpers
+
+      private
+      
+      def gem_installed?(gem_name)
+        require 'rubygems'
+        !!Gem.source_index.find_name(gem_name).first
+      end
+
+      def command_dependencies_met?(options)
+        return true if !options[:requires_gem]
+        Array(options[:requires_gem]).all? do |g|
+          gem_installed?(g)
+        end
+      end
+
+      def stub_proc(name, options)
+        gems_needed = Array(options[:requires_gem])
+        gems_not_installed = gems_needed.select { |g| !gem_installed?(g) }
+        proc do
+          output.puts "\n`#{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 #{name}` to install the required gems and activate this command."
+        end
+      end
+
+      def create_command_stub(names, description, options, block)
+        Array(names).each do |name|
+          commands[name] = {
+            :description => "Not available. Execute `#{name}` command for more information.",
+            :action => stub_proc(name, options),
+            :stub_info => options
+          }
+        end
+      end
+
+      def bold(text)
+        Pry.color ? "\e[1m#{text}\e[0m" : text
+      end
+
+      # formatting
+      def heading(text)
+        text = "#{text}\n--"
+        Pry.color ? "\e[1m#{text}\e[0m": text
+      end
+
+      def page_size
+        27
+      end
+      
+      # a simple pager for systems without `less`. A la windows.
+      def simple_pager(text)
+        text_array = text.lines.to_a
+        text_array.each_slice(page_size) do |chunk|
+          output.puts chunk.join
+          break if chunk.size < page_size
+          if text_array.size > page_size
+            output.puts "\n<page break> --- Press enter to continue ( q<enter> to break ) --- <page break>" 
+            break if $stdin.gets.chomp == "q"
+          end
+        end
+      end
+      
+      # Try to use `less` for paging, if it fails then use simple_pager
+      def stagger_output(text)
+        if text.lines.count < page_size
+          output.puts text
+          return
+        end
+        lesspipe { |less| less.puts text }
+      rescue Exception
+        simple_pager(text)
+      end
+
+      # thanks to epitron for this method
+      def lesspipe(*args)
+        if args.any? and args.last.is_a?(Hash)
+          options = args.pop
+        else
+          options = {}
+        end
+        
+        output = args.first if args.any?
+        
+        params = []
+        params << "-R" unless options[:color] == false
+        params << "-S" unless options[:wrap] == true
+        params << "-F" unless options[:always] == true
+        if options[:tail] == true
+          params << "+\\>"
+          $stderr.puts "Seeking to end of stream..."
+        end
+        params << "-X"
+        
+        IO.popen("less #{params * ' '}", "w") do |less|
+          if output
+            less.puts output
+          else
+            yield less
+          end
+        end
+      end      
+
+    end
+  end
+end
+
+      

data/lib/pry/command_helpers.rb

@@ -27,30 +27,9 @@ class Pry
         $_file_temp = File.expand_path(file_name)
         $_dir_temp =  File.dirname($_file_temp)
         target.eval("_file_ = $_file_temp")
-        target.eval("_dir_ = $_file_temp")
+        target.eval("_dir_ = $_dir_temp")
       end
-
-      # a simple pager for systems without `less`. A la windows.
-      def simple_pager(text)
-        page_size = 22
-        text_array = text.lines.to_a
-        text_array.each_slice(page_size) do |chunk|
-          output.puts chunk.join
-          break if chunk.size < page_size
-          if text_array.size > page_size
-            output.puts "\n<page break> --- Press enter to continue ( q<enter> to break ) --- <page break>" 
-            break if $stdin.gets.chomp == "q"
-          end
-        end
-      end
-      
-      # Try to use `less` for paging, if it fails then use simple_pager
-      def stagger_output(text)
-        lesspipe { |less| less.puts text }
-      rescue Exception
-        simple_pager(text)
-      end
-      
+   
       def add_line_numbers(lines, start_line)
         line_array = lines.each_line.to_a
         line_array.each_with_index.map do |line, idx|
@@ -64,7 +43,6 @@ class Pry
         end.join
       end
 
-      # only add line numbers if start_line is not false
       # if start_line is not false then add line numbers starting with start_line
       def render_output(should_flood, start_line, doc)
         if start_line
@@ -89,6 +67,45 @@ class Pry
         text.split.drop(1).join(' ')
       end
 
+      # turn off color for duration of block
+      def no_color(&block)
+        old_color_state = Pry.color
+        Pry.color = false
+        yield
+        ensure
+          Pry.color = old_color_state
+      end
+
+      def code_and_code_type_for(meth)
+        case code_type = code_type_for(meth)
+        when nil
+          return nil
+        when :c
+          code = Pry::MethodInfo.info_for(meth).source
+          code = strip_comments_from_c_code(code)
+        when :ruby
+          code = strip_leading_whitespace(meth.source)
+          set_file_and_dir_locals(meth.source_location.first)
+        end
+
+        [code, code_type]
+      end
+
+      def doc_and_code_type_for(meth)
+        case code_type = code_type_for(meth)
+        when nil
+          return nil
+        when :c
+          doc = Pry::MethodInfo.info_for(meth).docstring
+        when :ruby
+          doc = meth.comment
+          doc = strip_leading_hash_and_whitespace_from_ruby_comments(doc)
+          set_file_and_dir_locals(meth.source_location.first)
+        end
+
+        [doc, code_type]
+      end
+
       def get_method_object(meth_name, target, options)
         if !meth_name
           return nil
@@ -113,12 +130,12 @@ class Pry
       
       def make_header(meth, code_type, content)
         file, line = meth.source_location
-        num_lines = "Number of lines: #{content.each_line.count}"
+        num_lines = "Number of lines: #{bold(content.each_line.count.to_s)}"
         case code_type
         when :ruby
-          "\nFrom #{file} @ line #{line}:\n#{num_lines}\n\n"
+          "\n#{bold('From:')} #{file} @ line #{line}:\n#{num_lines}\n\n"
         else
-          "\nFrom Ruby Core (C Method):\n#{num_lines}\n\n"
+          "\n#{bold('From:')} Ruby Core (C Method):\n#{num_lines}\n\n"
         end
       end
 
@@ -156,7 +173,7 @@ class Pry
         {
           [".c", ".h"] => :c,
           [".cpp", ".hpp", ".cc", ".h", "cxx"] => :cpp,
-          [".rb", "Rakefile"] => :ruby,
+          [".rb", "Rakefile", ".irbrc", ".gemspec", ".pryrc"] => :ruby,
           ".py" => :python,
           ".diff" => :diff,
           ".css" => :css,
@@ -257,35 +274,6 @@ class Pry
         code.sub /\A\s*\/\*.*?\*\/\s*/m, ''
       end
 
-      # thanks to epitron for this method
-      def lesspipe(*args)
-        if args.any? and args.last.is_a?(Hash)
-          options = args.pop
-        else
-          options = {}
-        end
-        
-        output = args.first if args.any?
-        
-        params = []
-        params << "-R" unless options[:color] == false
-        params << "-S" unless options[:wrap] == true
-        params << "-F" unless options[:always] == true
-        if options[:tail] == true
-          params << "+\\>"
-          $stderr.puts "Seeking to end of stream..."
-        end
-        params << "-X"
-        
-        IO.popen("less #{params * ' '}", "w") do |less|
-          if output
-            less.puts output
-          else
-            yield less
-          end
-        end
-      end      
-
     end
   end
 end

data/lib/pry/command_processor.rb

@@ -15,24 +15,47 @@ class Pry
 
     def_delegators :@pry_instance, :commands, :nesting, :output
     
+    # Is the string a command valid?
+    # @param [String] val The string passed in from the Pry prompt.
+    # @return [Boolean] Whether the string is a valid command.
     def valid_command?(val)
       system_command?(val) || pry_command?(val)
     end
 
+    # Is the string a valid system command?
+    # @param [String] val The string passed in from the Pry prompt.
+    # @return [Boolean] Whether the string is a valid system command.
     def system_command?(val)
       !!(SYSTEM_COMMAND_REGEX =~ val)
     end
 
+    # Is the string a valid pry command?
+    # A Pry command is a command that is not a system command.
+    # @param [String] val The string passed in from the Pry prompt.
+    # @return [Boolean] Whether the string is a valid Pry command.
     def pry_command?(val)
       !!command_matched(val).first
     end
 
+    # Revaluate the string (str) and perform interpolation.
+    # @param [String] str The string to reevaluate with interpolation.
+    # @param [Binding] target The context where the string should be
+    #   reevaluated in.
+    # @return [String] The reevaluated string with interpolations
+    #   applied (if any).
     def interpolate_string(str, target)
       dumped_str = str.dump
       dumped_str.gsub!(/\\\#\{/, '#{')
       target.eval(dumped_str)
     end
-    
+
+    # Execute a given system command.
+    # The commands first have interpolation applied against the
+    # `target` context.
+    # All system command are forwarded to a shell. Note that the `cd`
+    # command is special-cased and is converted internallly to a `Dir.chdir`
+    # @param [String] val The system command to execute.
+    # @param [Binding] target The context in which to perform string interpolation.
     def execute_system_command(val, target)
       SYSTEM_COMMAND_REGEX  =~ val
       cmd = interpolate_string($1, target)
@@ -47,7 +70,8 @@ class Pry
         system(cmd)
       end
 
-      val.clear
+      # Tick, tock, im getting rid of this shit soon.
+      val.replace("")
     end
     
     # Determine whether a Pry command was matched and return command data
@@ -131,6 +155,7 @@ class Pry
         ret_val = commands.instance_exec(*args_with_corrected_arity, &action)
       end
 
+      # Tick, tock, im getting rid of this shit soon.
       options[:val].clear
       
       ret_val

data/lib/pry/commands.rb

@@ -23,6 +23,9 @@ class Pry
       Pry.start(target)
     end
 
+    command ".<shell command>", "All text following a '.' is forwarded to the shell." do
+    end
+
     command "exit-program", "End the current program. Aliases: quit-program, !!!" do
       exit
     end
@@ -30,6 +33,114 @@ class Pry
     alias_command "quit-program", "exit-program", ""
     alias_command "!!!", "exit-program", ""
 
+    command "ri", "View ri documentation. e.g `ri Array#each`" do |*args|
+      run target, ".ri", *args
+    end
+
+    command "stat", "View method information and set _file_ and _dir_ locals" do |*args|
+      options = {}
+      target = target()
+      meth_name = nil
+      
+      OptionParser.new do |opts|
+        opts.banner = %{Usage: stat [OPTIONS] [METH]
+Show method information for method METH and set _file_ and _dir_ locals. 
+e.g: stat hello_method
+--
+}
+        opts.on("-M", "--instance-methods", "Operate on instance methods.") do 
+          options[:M] = true
+        end
+
+        opts.on("-m", "--methods", "Operate on methods.") do 
+          options[:m] = true
+        end
+
+        opts.on("-c", "--context CONTEXT", "Select object context to run under.") do |context|
+          target = Pry.binding_for(target.eval(context))
+        end
+
+        opts.on_tail("-h", "--help", "This message.") do 
+          output.puts opts
+          options[:h] = true
+        end
+      end.order(args) do |v|
+        meth_name = v
+      end
+
+      next if options[:h]
+
+      meth_name = meth_name_from_binding(target) if !meth_name
+
+      if (meth = get_method_object(meth_name, target, options)).nil?
+        output.puts "Invalid method name: #{meth_name}. Type `stat --help` for help"
+        next
+      end
+
+      code, code_type = code_and_code_type_for(meth)
+      next if !code
+      doc, code_type = doc_and_code_type_for(meth)
+
+      output.puts make_header(meth, code_type, code)
+      output.puts bold("Method Name: ") + meth_name
+      output.puts bold("Method Language: ") + code_type.to_s.capitalize
+      output.puts bold("Method Type: ") + (meth.is_a?(Method) ? "Bound" : "Unbound")
+      output.puts bold("Method Arity: ") + meth.arity.to_s
+      output.puts bold("Comment length: ") + (doc.empty? ? 'No comment.' : (doc.lines.count.to_s + ' lines.'))
+    end
+
+    command "gist-method", "Gist a method to github.", :requires_gem => "gist" do |*args|
+      options = {}
+      meth_name = nil
+      
+      OptionParser.new do |opts|
+        opts.banner = %{Usage: gist-method [OPTIONS] [METH]
+Gist the method (doc or source) to github.
+e.g: gist -m my_method
+e.g: gist -d my_method
+--
+}
+        opts.on("-m", "--method", "Gist a method's source.") do |line|
+          options[:m] = true
+        end
+
+        opts.on("-d", "--doc", "Gist a method's documentation.") do 
+          options[:d] = true
+        end
+
+        opts.on_tail("-h", "--help", "This message.") do 
+          output.puts opts
+          options[:h] = true
+        end
+      end.order(args) do |v|
+        meth_name = v
+      end
+
+      next if options[:h]
+
+      meth_name = meth_name_from_binding(target) if !meth_name
+
+      if (meth = get_method_object(meth_name, target, options)).nil?
+        output.puts "Invalid method name: #{meth_name}. Type `gist-method --help` for help"
+        next
+      end
+
+      type_map = { :ruby => "rb", :c => "c", :plain => "plain" }
+      if !options[:d]
+        content, code_type = code_and_code_type_for(meth)
+      else
+        content, code_type = doc_and_code_type_for(meth)
+        no_color do
+          content = process_comment_markup(content, code_type)
+        end
+        code_type = :plain
+      end
+      
+      IO.popen("gist -p -t #{type_map[code_type]} -", "w") do |gist|
+        gist.puts content
+      end
+    end
+
     command "gem-cd", "Change working directory to specified gem's directory." do |gem_name|
       require 'rubygems'
       gem_spec = Gem.source_index.find_name(gem_name).first
@@ -116,7 +227,7 @@ class Pry
       end
      
       set_file_and_dir_locals(file) 
-      output.puts "\nFrom #{file} @ line #{line_num} in #{klass}##{meth_name}:\n\n"
+      output.puts "\n#{bold('From:')} #{file} @ line #{line_num} in #{klass}##{meth_name}:\n\n"
       
       # This method inspired by http://rubygems.org/gems/ir_b
       File.open(file).each_with_index do |line, index|
@@ -491,16 +602,8 @@ e.g show-doc hello_method
         next
       end
 
-      case code_type = code_type_for(meth)
-      when nil
-        next
-      when :c
-        doc = Pry::MethodInfo.info_for(meth).docstring
-      when :ruby
-        doc = meth.comment
-        doc = strip_leading_hash_and_whitespace_from_ruby_comments(doc)
-        set_file_and_dir_locals(meth.source_location.first)
-      end
+      doc, code_type = doc_and_code_type_for(meth)
+      next if !doc
 
       next output.puts("No documentation found.") if doc.empty?
       
@@ -514,7 +617,7 @@ e.g show-doc hello_method
 
     alias_command "?", "show-doc", ""
 
-    command "show-method", "Show the source for METH. Type `show-method --help` for more info. Aliases: show-source" do |*args|
+    command "show-method", "Show the source for METH. Type `show-method --help` for more info. Aliases: $, show-source" do |*args|
       options = {}
       target = target()
       meth_name = nil
@@ -562,16 +665,8 @@ e.g: show-method hello_method
         next
       end
     
-      case code_type = code_type_for(meth)
-      when nil
-        next
-      when :c
-        code = Pry::MethodInfo.info_for(meth).source
-        code = strip_comments_from_c_code(code)
-      when :ruby
-        code = strip_leading_whitespace(meth.source)
-        set_file_and_dir_locals(meth.source_location.first)
-      end
+      code, code_type = code_and_code_type_for(meth)
+      next if !code
 
       output.puts make_header(meth, code_type, code)
       if Pry.color
@@ -588,6 +683,7 @@ e.g: show-method hello_method
     end
 
     alias_command "show-source", "show-method", ""
+    alias_command "$", "show-method", ""
 
     command "show-command", "Show the source for CMD. Type `show-command --help` for more info." do |*args|
       options = {}

data/lib/pry/version.rb

@@ -1,3 +1,3 @@
 class Pry
-  VERSION = "0.8.0pre7" 
+  VERSION = "0.8.0pre8" 
 end

data/test/test.rb

@@ -434,8 +434,9 @@ describe Pry do
               end
             end
 
-            Command2.commands.keys.size.should == 2
+            Command2.commands.keys.size.should == 3
             Command2.commands.keys.include?("help").should == true
+            Command2.commands.keys.include?("install").should == true
             Command2.commands.keys.include?("h").should == true
 
             Object.remove_const(:Command2)

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: pry
 version: !ruby/object:Gem::Version 
-  hash: -766259880
   prerelease: true
   segments: 
   - 0
   - 8
-  - 0pre7
-  version: 0.8.0pre7
+  - 0pre8
+  version: 0.8.0pre8
 platform: ruby
 authors: 
 - John Mair (banisterfiend)
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-12 00:00:00 +12:00
+date: 2011-04-13 00:00:00 +12:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 5
         segments: 
         - 2
         - 0
@@ -42,7 +40,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 53
         segments: 
         - 0
         - 9
@@ -58,7 +55,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 19
         segments: 
         - 1
         - 1
@@ -74,7 +70,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 15
         segments: 
         - 0
         - 4
@@ -104,6 +99,7 @@ files:
 - lib/pry/completion.rb
 - lib/pry/print.rb
 - lib/pry/pry_class.rb
+- lib/pry/command_base_helpers.rb
 - lib/pry/pry_instance.rb
 - lib/pry.rb
 - examples/example_commands.rb
@@ -139,7 +135,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -148,7 +143,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">"
     - !ruby/object:Gem::Version 
-      hash: 25
       segments: 
       - 1
       - 3