pry 0.9.0pre3 → 0.9.0

data/lib/pry/default_commands/introspection.rb

@@ -12,6 +12,8 @@ class Pry
                      "e.g: show-method hello_method"
 
           opt.on :l, "line-numbers", "Show line numbers."
+          opt.on :b, "base-one", "Show line numbers but start numbering at 1 (useful for `amend-line` and `play` commands)."
+
           opt.on :M, "instance-methods", "Operate on instance methods."
           opt.on :m, :methods, "Operate on methods."
           opt.on :f, :flood, "Do not use a pager to view text longer than one screen."
@@ -44,6 +46,9 @@ class Pry
           start_line = meth.source_location ? meth.source_location.last : 1
         end
 
+        start_line = opts.b? ? 1 : start_line
+
+
         render_output(opts.flood?, start_line, code)
         code
       end
@@ -98,6 +103,39 @@ class Pry
         end
       end
 
+      command "edit", "Invoke the default editor on a file. Type `edit --help` for more info" do |*args|
+        opts = Slop.parse!(args) do |opt|
+          opt.banner "Usage: edit [OPTIONS] [FILE]\n" \
+                      "Edit the method FILE in an editor.\n" \
+                      "Ensure #{text.bold("Pry.editor")} is set to your editor of choice.\n" \
+                      "e.g: edit sample.rb"
+
+          opt.on :r, "reload", "Eval file content after editing (using `load`)"
+          opt.on :p, "play", "Use the pry `play` command to eval the file content after editing (instead of the `load` method)."
+          opt.on :l, "line", "Specify line number to jump to in file", true, :as => Integer
+          opt.on :h, :help, "This message." do
+            output.puts opt
+          end
+        end
+        next if opts.h?
+
+        next output.puts("Need to specify a file.") if !args.first
+        file_name = File.expand_path(args.first)
+
+        invoke_editor(file_name, opts[:l].to_i)
+        set_file_and_dir_locals(file_name)
+
+        if opts[:r]
+          silence_warnings do
+            load file_name
+          end
+        elsif opts[:p]
+          silence_warnings do
+            Pry.active_instance.input = StringIO.new(File.readlines(file_name).join)
+          end
+        end
+      end
+
       command "edit-method", "Edit a method. Type `edit-method --help` for more info." do |*args|
         target = target()
 
@@ -139,34 +177,42 @@ class Pry
           file, line = path_line_for(meth)
           set_file_and_dir_locals(file)
 
+          invoke_editor(file, opts["no-jump"] ? 0 : line)
+          silence_warnings do
+            load file if !opts.n?
+          end
+        end
+      end
+
+      helpers do
+
+        def invoke_editor(file, line)
           if Pry.editor.respond_to?(:call)
             editor_invocation = Pry.editor.call(file, line)
           else
-            # only use start line if -n option is not used
-            start_line_syntax = opts["no-jump"] ? "" : start_line_for_editor(line)
-            editor_invocation = "#{Pry.editor} #{start_line_syntax} #{file}"
+            editor_invocation = "#{Pry.editor} #{start_line_syntax_for_editor(file, line)}"
           end
 
           run ".#{editor_invocation}"
-          silence_warnings do
-            load file if !opts.n?
-          end
         end
-      end
 
-      helpers do
+        def start_line_syntax_for_editor(file_name, line_number)
+          file_name.gsub!(/\//, '\\') if RUBY_PLATFORM =~ /mswin|mingw/
 
-        def start_line_for_editor(line_number)
           case Pry.editor
           when /^[gm]?vi/, /^emacs/, /^nano/, /^pico/, /^gedit/, /^kate/
-            "+#{line_number}"
+            "+#{line_number} #{file_name}"
           when /^mate/, /^geany/
-            "-l #{line_number}"
+            "-l #{line_number} #{file_name}"
+          when /^uedit32/
+            "#{file_name}/#{line_number}"
+          when /^jedit/
+            "#{file_name} +#{line_number}"
           else
             if RUBY_PLATFORM =~ /mswin|mingw/
-              ""
+              "#{file_name}"
             else
-              "+#{line_number}"
+              "+#{line_number} #{file_name}"
             end
           end
         end

data/lib/pry/default_commands/ls.rb

@@ -3,6 +3,16 @@ class Pry
 
     Ls = Pry::CommandSet.new do
 
+      helpers do
+        def trim_methods(options, visibility)
+          if options[:e]
+            []
+          else
+            Object.send("#{visibility}_methods")
+          end
+        end
+      end
+
       command "ls", "Show the list of vars and methods in the current scope. Type `ls --help` for more info." do |*args|
         options = {}
         # Set target local to the default -- note that we can set a different target for
@@ -59,10 +69,14 @@ Shows local and instance variables by default.
             options[:j] = true
           end
 
-          opts.on("-s", "--super", "Include superclass entries (relevant to constant and methods options).") do
+          opts.on("-s", "--super", "Include superclass entries excluding Object (relevant to constant and methods options).") do
             options[:s] = true
           end
 
+          opts.on("-e", "--everything", "Include superclass entries including Object (relevant to constant and methods options).") do
+            options[:e] = true
+          end
+
           opts.on("-a", "--all", "Display all types of entries.") do
             options[:a] = true
           end
@@ -126,19 +140,19 @@ Shows local and instance variables by default.
 
                               info["global variables"] = [Array(target.eval("global_variables")).sort, i += 1] if options[:g] || options[:a]
 
-                              info["public methods"] = [Array(target.eval("public_methods(#{options[:s]})")).uniq.sort, i += 1] if (options[:m] && options[:P]) || options[:a]
+                              info["public methods"] = [Array(target.eval("public_methods(#{options[:s]})")).uniq.sort - trim_methods(options, :public), i += 1] if (options[:m] && options[:P]) || options[:a]
 
-                              info["protected methods"] = [Array(target.eval("protected_methods(#{options[:s]})")).sort, i += 1] if (options[:m] && options[:r]) || options[:a]
+                              info["protected methods"] = [Array(target.eval("protected_methods(#{options[:s]})")).sort - trim_methods(options, :protected), i += 1] if (options[:m] && options[:r]) || options[:a]
 
-                              info["private methods"] = [Array(target.eval("private_methods(#{options[:s]})")).sort, i += 1] if (options[:m] && options[:p]) || options[:a]
+                              info["private methods"] = [Array(target.eval("private_methods(#{options[:s]})")).sort - trim_methods(options, :private), i += 1] if (options[:m] && options[:p]) || options[:a]
 
                               info["just singleton methods"] = [Array(target.eval("methods(#{options[:s]})")).sort, i += 1] if (options[:m] && options[:j]) || options[:a]
 
-                              info["public instance methods"] = [Array(target.eval("public_instance_methods(#{options[:s]})")).uniq.sort, i += 1] if target_self.is_a?(Module) && ((options[:M] && options[:P]) || options[:a])
+                              info["public instance methods"] = [Array(target.eval("public_instance_methods(#{options[:s]})")).uniq.sort - trim_methods(options, :public), i += 1] if target_self.is_a?(Module) && ((options[:M] && options[:P]) || options[:a])
 
-                              info["protected instance methods"] = [Array(target.eval("protected_instance_methods(#{options[:s]})")).uniq.sort, i += 1] if target_self.is_a?(Module) && ((options[:M] && options[:r]) || options[:a])
+                              info["protected instance methods"] = [Array(target.eval("protected_instance_methods(#{options[:s]})")).uniq.sort - trim_methods(options, :protected), i += 1] if target_self.is_a?(Module) && ((options[:M] && options[:r]) || options[:a])
 
-                              info["private instance methods"] = [Array(target.eval("private_instance_methods(#{options[:s]})")).uniq.sort, i += 1] if target_self.is_a?(Module) && ((options[:M] && options[:p]) || options[:a])
+                              info["private instance methods"] = [Array(target.eval("private_instance_methods(#{options[:s]})")).uniq.sort - trim_methods(options, :private), i += 1] if target_self.is_a?(Module) && ((options[:M] && options[:p]) || options[:a])
 
                               # dealing with 1.8/1.9 compatibility issues :/
                               csuper = options[:s]

data/lib/pry/extended_commands/experimental.rb

@@ -3,7 +3,6 @@ class Pry
 
     Experimental = Pry::CommandSet.new do
 
-
       command "reload-method", "Reload the source specifically for a method", :requires_gem => "method_reload" do |meth_name|
         if (meth = get_method_object(meth_name, target, {})).nil?
           output.puts "Invalid method name: #{meth_name}."
@@ -13,36 +12,6 @@ class Pry
         meth.reload
       end
 
-      command "play", "Play a string as input" do |*args|
-        Slop.parse!(args) do |opt|
-          opt.banner "Usage: play-method [--replay START..END] [--clear] [--grep PATTERN] [--help]\n"
-
-          opt.on :l, :lines, 'The line (or range of lines) to replay.', true, :as => Range
-          opt.on :m, :method, 'Play a method.', true do |meth_name|
-            if (meth = get_method_object(meth_name, target, {})).nil?
-              output.puts "Invalid method name: #{meth_name}."
-              next
-            end
-            code, code_type = code_and_code_type_for(meth)
-            next if !code
-
-            range = opt.l? ? opt[:l] : (0..-1)
-
-            Pry.active_instance.input = StringIO.new(code[range])
-          end
-
-          opt.on :f, "file", 'The line (or range of lines) to replay.', true do |file_name|
-            text = File.read File.expand_path(file_name)
-            range = opt.l? ? opt[:l] : (0..-1)
-
-            Pry.active_instance.input = StringIO.new(text[range])
-          end
-
-          opt.on :h, :help, "This message." do
-            output.puts opt
-          end
-        end
-      end
     end
   end
 end

data/lib/pry/extended_commands/user_command_api.rb

@@ -3,7 +3,7 @@ class Pry
 
     UserCommandAPI = Pry::CommandSet.new do
 
-      command "define-command", "To honor Mon-Ouie" do |arg|
+      command "define-command", "Define a command in the session, use same syntax as `command` method for command API" do |arg|
         next output.puts("Provide an arg!") if arg.nil?
 
         prime_string = "command #{arg_string}\n"

data/lib/pry/helpers/base_helpers.rb

@@ -63,6 +63,14 @@ class Pry
         end
       end
 
+      def colorize_code(code)
+        if Pry.color
+          CodeRay.scan(code, :ruby).term
+        else
+          code
+        end
+      end
+
       def highlight(string, regexp, highlight_color=:bright_yellow)
         highlighted = string.gsub(regexp) { |match| "<#{highlight_color}>#{match}</#{highlight_color}>" }
       end
@@ -93,7 +101,7 @@ class Pry
       # Try to use `less` for paging, if it fails then use
       # simple_pager. Also do not page if Pry.pager is falsey
       # FIXME! Another JRuby hack
-      def stagger_output(text)
+      def stagger_output(text, output=output())
         if text.lines.count < page_size || !Pry.pager
           output.puts text
           return

data/lib/pry/plugins.rb

@@ -6,10 +6,10 @@ class Pry
     MessageSink = Object.new.tap { |o| def o.method_missing(*args) end }
 
     class Plugin
-      attr_accessor :name, :gem_name, :enabled, :active
+      attr_accessor :name, :gem_name, :enabled, :spec, :active
 
-      def initialize(name, gem_name, enabled)
-        @name, @gem_name, @enabled = name, gem_name, enabled
+      def initialize(name, gem_name, spec, enabled)
+        @name, @gem_name, @enabled, @spec = name, gem_name, enabled, spec
       end
 
       # Disable a plugin.
@@ -47,7 +47,7 @@ class Pry
       (Gem::Specification.respond_to?(:each) ? Gem::Specification : Gem.source_index.find_name('')).each do |gem|
         next if gem.name !~ PRY_PLUGIN_PREFIX
         plugin_name = gem.name.split('-', 2).last
-        @plugins << Plugin.new(plugin_name, gem.name, true) if !gem_located?(gem.name)
+        @plugins << Plugin.new(plugin_name, gem.name, gem, true) if !gem_located?(gem.name)
       end
       @plugins
     end

data/lib/pry/pry_class.rb

@@ -97,7 +97,7 @@ class Pry
       # multiple times per each new session (i.e in debugging)
       load_rc if Pry.config.should_load_rc
       load_plugins if Pry.config.plugins.enabled
-      load_history if Pry.config.history.load
+      load_history if Pry.config.history.should_load
 
       @initial_session = false
     end
@@ -196,11 +196,12 @@ class Pry
     config.plugins.strict_loading = true
 
     config.history ||= OpenStruct.new
-    config.history.save = true
-    config.history.load = true
+    config.history.should_save = true
+    config.history.should_load = true
     config.history.file = File.expand_path("~/.pry_history")
 
     config.memory_size = 100
+    config.results_pager = true
   end
 
   # Set all the configurable options back to their default values

data/lib/pry/pry_instance.rb

@@ -149,7 +149,7 @@ class Pry
       throw :breakout, break_data
     end
 
-    save_history if Pry.config.history.save && finished_top_level_session?
+    save_history if Pry.config.history.should_save && finished_top_level_session?
 
     return_value
   end
@@ -302,15 +302,15 @@ class Pry
   # This method should not need to be invoked directly.
   # @param [String] val The line to process.
   # @param [String] eval_string The cumulative lines of input.
-  # @target [Binding] target The target of the Pry session.
+  # @param [Binding] target The target of the Pry session.
   def process_line(val, eval_string, target)
-    val.rstrip!
     Pry.cmd_ret_value = @command_processor.process_commands(val, eval_string, target)
 
     if Pry.cmd_ret_value
       eval_string << "Pry.cmd_ret_value\n"
     else
-      eval_string << "#{val}\n" if !val.empty?
+      # only commands (with no ret_value) should have an empty `val` so this ignores their result
+      eval_string << "#{val.rstrip}\n" if !val.empty?
     end
   end
 
@@ -329,6 +329,13 @@ class Pry
   # @param [Exception] ex The exception.
   # @param [Binding] target The binding to set `_ex_` on.
   def set_last_exception(ex, target)
+    class << ex
+      attr_accessor :file, :line
+    end
+
+    ex.backtrace.first =~ /(.*):(\d+)/
+    ex.file, ex.line = $1, $2.to_i
+
     Pry.last_exception = ex
     target.eval("_ex_ = ::Pry.last_exception")
   end

data/lib/pry/version.rb

@@ -1,3 +1,3 @@
 class Pry
-  VERSION = "0.9.0pre3"
+  VERSION = "0.9.0"
 end

data/pry.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'pry/version'
+
+Gem::Specification.new do |s|
+  s.name = %q{pry}
+  s.version = Pry::VERSION
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{John Mair (banisterfiend)}]
+  s.description = %q{an IRB alternative and runtime developer console}
+  s.email = %q{jrmair@gmail.com}
+  s.executables = [%q{pry}]
+  s.files = [%q{.document}, %q{.gemtest}, %q{.gitignore}, %q{.yardopts}, %q{CHANGELOG}, %q{LICENSE}, %q{README.markdown}, %q{Rakefile}, %q{TODO}, %q{bin/pry}, %q{examples/example_basic.rb}, %q{examples/example_command_override.rb}, %q{examples/example_commands.rb}, %q{examples/example_hooks.rb}, %q{examples/example_image_edit.rb}, %q{examples/example_input.rb}, %q{examples/example_input2.rb}, %q{examples/example_output.rb}, %q{examples/example_print.rb}, %q{examples/example_prompt.rb}, %q{examples/helper.rb}, %q{lib/pry.rb}, %q{lib/pry/command_context.rb}, %q{lib/pry/command_processor.rb}, %q{lib/pry/command_set.rb}, %q{lib/pry/commands.rb}, %q{lib/pry/completion.rb}, %q{lib/pry/config.rb}, %q{lib/pry/core_extensions.rb}, %q{lib/pry/custom_completions.rb}, %q{lib/pry/default_commands/basic.rb}, %q{lib/pry/default_commands/context.rb}, %q{lib/pry/default_commands/documentation.rb}, %q{lib/pry/default_commands/easter_eggs.rb}, %q{lib/pry/default_commands/gems.rb}, %q{lib/pry/default_commands/input.rb}, %q{lib/pry/default_commands/introspection.rb}, %q{lib/pry/default_commands/ls.rb}, %q{lib/pry/default_commands/shell.rb}, %q{lib/pry/extended_commands/experimental.rb}, %q{lib/pry/extended_commands/user_command_api.rb}, %q{lib/pry/helpers.rb}, %q{lib/pry/helpers/base_helpers.rb}, %q{lib/pry/helpers/command_helpers.rb}, %q{lib/pry/helpers/text.rb}, %q{lib/pry/history_array.rb}, %q{lib/pry/plugins.rb}, %q{lib/pry/pry_class.rb}, %q{lib/pry/pry_instance.rb}, %q{lib/pry/version.rb}, %q{pry.gemspec}, %q{test/helper.rb}, %q{test/test_command_helpers.rb}, %q{test/test_command_processor.rb}, %q{test/test_command_set.rb}, %q{test/test_default_commands.rb}, %q{test/test_default_commands/test_context.rb}, %q{test/test_default_commands/test_documentation.rb}, %q{test/test_default_commands/test_gems.rb}, %q{test/test_default_commands/test_input.rb}, %q{test/test_default_commands/test_introspection.rb}, %q{test/test_history_array.rb}, %q{test/test_pry.rb}, %q{test/testrc}, %q{wiki/Customizing-pry.md}, %q{wiki/Home.md}]
+  s.homepage = %q{http://banisterfiend.wordpress.com}
+  s.summary = %q{an IRB alternative and runtime developer console}
+  s.test_files = [%q{test/helper.rb}, %q{test/test_command_helpers.rb}, %q{test/test_command_processor.rb}, %q{test/test_command_set.rb}, %q{test/test_default_commands.rb}, %q{test/test_default_commands/test_context.rb}, %q{test/test_default_commands/test_documentation.rb}, %q{test/test_default_commands/test_gems.rb}, %q{test/test_default_commands/test_input.rb}, %q{test/test_default_commands/test_introspection.rb}, %q{test/test_history_array.rb}, %q{test/test_pry.rb}, %q{test/testrc}]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ruby_parser>, [">= 2.0.5"])
+      s.add_runtime_dependency(%q<coderay>, [">= 0.9.8"])
+      s.add_runtime_dependency(%q<slop>, ["~> 1.7.0"])
+      s.add_runtime_dependency(%q<method_source>, [">= 0.4.0"])
+      s.add_development_dependency(%q<bacon>, [">= 1.1.0"])
+      s.add_development_dependency(%q<open4>, ["~> 1.0.1"])
+    else
+      s.add_dependency(%q<ruby_parser>, [">= 2.0.5"])
+      s.add_dependency(%q<coderay>, [">= 0.9.8"])
+      s.add_dependency(%q<slop>, ["~> 1.7.0"])
+      s.add_dependency(%q<method_source>, [">= 0.4.0"])
+      s.add_dependency(%q<bacon>, [">= 1.1.0"])
+      s.add_dependency(%q<open4>, ["~> 1.0.1"])
+    end
+  else
+    s.add_dependency(%q<ruby_parser>, [">= 2.0.5"])
+    s.add_dependency(%q<coderay>, [">= 0.9.8"])
+    s.add_dependency(%q<slop>, ["~> 1.7.0"])
+    s.add_dependency(%q<method_source>, [">= 0.4.0"])
+    s.add_dependency(%q<bacon>, [">= 1.1.0"])
+    s.add_dependency(%q<open4>, ["~> 1.0.1"])
+  end
+end

data/test/helper.rb

@@ -20,8 +20,8 @@ class << Pry
     Pry.pager = false
     Pry.config.should_load_rc = false
     Pry.config.plugins.enabled = false
-    Pry.config.history.load = false
-    Pry.config.history.save = false
+    Pry.config.history.should_load = false
+    Pry.config.history.should_save = false
   end
 end
 

data/test/test_command_processor.rb

@@ -19,8 +19,17 @@ describe "Pry::CommandProcessor" do
     valid = @command_processor.valid_command? "blah"
     valid.should == false
 
+
     a = "test-command"
-    lambda { @command_processor.valid_command? '#{a}' }.should.raise NameError
+
+    # not passing in a binding so 'a' shouldn't exist and no command
+    # will be matched
+    valid = @command_processor.valid_command?('#{a}')
+    valid.should == false
+
+    # passing in the optional binding (against which interpolation is performed)
+    valid = @command_processor.valid_command? '#{a}', binding
+    valid.should == true
   end
 
   it 'should correctly match a simple string command' do
@@ -119,6 +128,59 @@ describe "Pry::CommandProcessor" do
     pos.should == command.name.length
   end
 
+  it 'should correctly match a regex command and interpolation should not break the regex' do
+    regex_command_name = /blah(\d)/
+    @pry.commands.command(regex_command_name) {}
+
+    sample_text = "blah5"
+    a = "5"
+    command, captures, pos = @command_processor.command_matched 'blah#{a}', binding
+
+    command.name.should == regex_command_name
+    captures.should == ["5"]
+    pos.should == sample_text.size
+  end
+
+  it 'should NOT match a regex command that is interpolated when :interpolate => false' do
+    regex_command_name = /blah(\d)/
+    @pry.commands.command(regex_command_name, "", :interpolate => false) {}
+
+    sample_text = "blah5"
+    a = "5"
+    command, captures, pos = @command_processor.command_matched 'blah#{a}', binding
+
+    command.should == nil
+  end
+
+  it 'should correctly match a regex command and interpolation should not break the regex where entire regex command is interpolated' do
+    regex_command_name = /blah(\d)/
+    @pry.commands.command(regex_command_name) {}
+
+    sample_text = "blah5"
+    a = "bl"
+    b = "ah"
+    c = "5"
+
+    command, captures, pos = @command_processor.command_matched '#{a}#{b}#{c}', binding
+
+    command.name.should == regex_command_name
+    captures.should == ["5"]
+    pos.should == sample_text.size
+  end
+
+  it 'should NOT match a regex command where entire regex command is interpolated and :interpolate => false' do
+    regex_command_name = /blah(\d)/
+    @pry.commands.command(regex_command_name, "", :interpolate => false) {}
+
+    sample_text = "blah5"
+    a = "bl"
+    b = "ah"
+    c = "5"
+
+    command, captures, pos = @command_processor.command_matched '#{a}#{b}#{c}', binding
+    command.should == nil
+  end
+
   it 'should NOT match a command whose name is interpolated when :interpolate => false' do
     @pry.commands.command("boast", "", :interpolate => false) {}
     a = "boa"
@@ -130,4 +192,14 @@ describe "Pry::CommandProcessor" do
 
     command.should == nil
   end
+
+
+  it 'commands that have :interpolate => false should not be interpolated (interpolate_string should *not* be called)' do
+    @pry.commands.command("boast", "", :interpolate => false) {}
+
+    # remember to use '' instead of "" when testing interpolation or
+    # you'll cause yourself incredible confusion
+    lambda { @command_processor.command_matched('boast #{c}', binding) }.should.not.raise NameError
+  end
+
 end