pry 0.9.6.2 → 0.9.7

data/lib/pry/extended_commands/user_command_api.rb

@@ -4,7 +4,9 @@ class Pry
     UserCommandAPI = Pry::CommandSet.new do
 
       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?
+        if arg.nil?
+          raise CommandError, "Provide an arg!"
+        end
 
         prime_string = "command #{arg_string}\n"
         command_string = _pry_.r(target, prime_string)
@@ -18,8 +20,13 @@ class Pry
       end
 
       command "reload-command", "Reload a command. reload-command CMD_NAME CMD_SET" do |command_name, set_name|
-        next output.puts "Must provide command name" if command_name.nil?
-        next output.puts "Must provide command set name" if set_name.nil?
+        if command_name.nil?
+          raise CommandError, "Must provide command name"
+        end
+
+        if set_name.nil?
+          raise CommandError, "Must provide command set name"
+        end
 
         cmd = Pry.config.commands.commands[command_name]
         file_name = cmd.block.source_location.first
@@ -33,8 +40,13 @@ class Pry
       end
 
       command "edit-command", "Edit a command. edit-command CMD_NAME CMD_SET" do |command_name, set_name|
-        next output.puts "Must provide command name" if command_name.nil?
-        next output.puts "Must provide a command set name" if set_name.nil?
+        if command_name.nil?
+          raise CommandError, "Must provide command name"
+        end
+
+        if set_name.nil?
+          raise CommandError, "Must provide command set name"
+        end
 
         cmd = Pry.config.commands.commands[command_name]
         file_name = cmd.block.source_location.first

data/lib/pry/helpers.rb

@@ -1,3 +1,4 @@
 require "pry/helpers/base_helpers"
+require "pry/helpers/options_helpers"
 require "pry/helpers/command_helpers"
 require "pry/helpers/text"

data/lib/pry/helpers/base_helpers.rb

@@ -35,7 +35,7 @@ class Pry
       end
 
       def set_file_and_dir_locals(file_name)
-        return if !target
+        return if !target or !file_name
         _pry_.last_file = File.expand_path(file_name)
         _pry_.inject_local("_file_", _pry_.last_file, target)
 
@@ -65,6 +65,10 @@ class Pry
         end
       end
 
+      def use_ansi_codes?
+        defined?(Win32::Console) || ENV['TERM'] && ENV['TERM'] != "dumb"
+      end
+
       def colorize_code(code)
         if Pry.color
           CodeRay.scan(code, :ruby).term

data/lib/pry/helpers/command_helpers.rb

@@ -2,18 +2,10 @@ class Pry
   module Helpers
 
     module CommandHelpers
+      include OptionsHelpers
 
       module_function
 
-      def meth_name_from_binding(b)
-        meth_name = b.eval('__method__')
-        if [:__script__, nil, :__binding__, :__binding_impl__].include?(meth_name)
-          nil
-        else
-          meth_name
-        end
-      end
-
       # if start_line is not false then add line numbers starting with start_line
       def render_output(should_flood, start_line, text, color=:blue)
         if start_line
@@ -27,18 +19,6 @@ class Pry
         end
       end
 
-      def is_a_dynamically_defined_method?(meth)
-        file, _ = meth.source_location
-        !!(file =~ /(\(.*\))|<.*>/)
-      end
-
-      def check_for_dynamically_defined_method(meth)
-        file, _ = meth.source_location
-        if file =~ /(\(.*\))|<.*>/ && file != Pry.eval_path
-          raise "Cannot retrieve source for dynamically defined method."
-        end
-      end
-
       # Open a temp file and yield it to the block, closing it after
       # @return [String] The path of the temp file
       def temp_file
@@ -48,223 +28,42 @@ class Pry
         file.close
       end
 
-      ########### RBX HELPERS #############
-      def is_core_rbx_path?(path)
-        rbx? &&
-          path.start_with?("kernel")
-      end
-
-      def rbx_core?(meth)
-          meth.source_location &&
-          is_core_rbx_path?(meth.source_location.first)
-      end
-
-      def rvm_ruby?(path)
-        !!(path =~ /\.rvm/)
-      end
-
-      def rbx_core_code_for(meth)
-        rbx_core_code_or_doc_for(meth, :code)
-      end
-
-      def rbx_core_doc_for(meth)
-        rbx_core_code_or_doc_for(meth, :doc)
-      end
-
-      def rbx_core_code_or_doc_for(meth, code_or_doc)
-        path_line = rbx_core_path_line_for(meth)
+      def get_method_or_raise(name, target, opts={}, omit_help=false)
+        meth = Pry::Method.from_str(name, target, opts)
 
-        case code_or_doc
-        when :code
-          MethodSource.source_helper(path_line)
-        when :doc
-          MethodSource.comment_helper(path_line)
+        if name && !meth
+          command_error("The method '#{name}' could not be found.", omit_help)
+        elsif !meth
+          command_error("No method name given, and context is not a method.", omit_help)
         end
-      end
-
-      def rbx_convert_path_to_full(path)
-        if rvm_ruby?(Rubinius::BIN_PATH)
-          rbx_rvm_convert_path_to_full(path)
-        else
-          rbx_std_convert_path_to_full(path)
-        end
-      end
-
-      def rbx_rvm_convert_path_to_full(path)
-          ruby_name = File.dirname(Rubinius::BIN_PATH).split("/").last
-          source_path = File.join(File.dirname(File.dirname(File.dirname(Rubinius::BIN_PATH))),  "src", ruby_name)
-        file_name = File.join(source_path, path)
-        raise "Cannot find rbx core source" if !File.exists?(file_name)
-        file_name
-      end
-
-      def rbx_std_convert_path_to_full(path)
-        file_name = File.join(Rubinius::BIN_PATH, "..", path)
-        raise "Cannot find rbx core source" if !File.exists?(file_name)
-        file_name
-      end
-
-      def rbx_core_path_line_for(meth)
-        if rvm_ruby?(Rubinius::BIN_PATH)
-          rvm_rbx_core_path_line_for(meth)
-        else
-          std_rbx_core_path_line_for(meth)
-        end
-      end
-
-      def std_rbx_core_path_line_for(meth)
-        file_name  = rbx_std_convert_path_to_full(meth.source_location.first)
-        start_line = meth.source_location.last
-
-        [file_name, start_line]
-      end
-
-      def rvm_rbx_core_path_line_for(meth)
-        file_name  = rbx_rvm_convert_path_to_full(meth.source_location.first)
-        start_line = meth.source_location.last
-
-        [file_name, start_line]
-      end
 
-      ######### END RBX HELPERS ###############
-
-      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
-          if meth.source_location.first == Pry.eval_path
-            start_line = meth.source_location.last
-
-            # FIXME this line below needs to be refactored, WAY too
-            # much of a hack. We pass nothing to prompt because if
-            # prompt uses #inspect (or #pretty_inspect) on the context
-            # it can hang the session if the object being inspected on
-            # is enormous see: https://github.com/pry/pry/issues/245
-            p = Pry.new(:input => StringIO.new(Pry.line_buffer[start_line..-1].join), :prompt => proc {""}, :hooks => {}).r(target)
-            code = strip_leading_whitespace(p)
+        (opts[:super] || 0).times do
+          if meth.super
+            meth = meth.super
           else
-            if rbx_core?(meth)
-              code = strip_leading_whitespace(rbx_core_code_for(meth))
-            else
-              code = strip_leading_whitespace(meth.source)
-            end
+            command_error("The method '#{meth.name}' is not defined in a superclass of '#{class_name(meth.owner)}'.", omit_help)
           end
-          set_file_and_dir_locals(path_line_for(meth).first)
         end
 
-        [code, code_type]
+        set_file_and_dir_locals(meth.source_file)
+        meth
       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
-          if rbx_core?(meth)
-            doc = strip_leading_hash_and_whitespace_from_ruby_comments(rbx_core_doc_for(meth))
-          else
-            doc = strip_leading_hash_and_whitespace_from_ruby_comments(meth.comment)
-          end
-          set_file_and_dir_locals(path_line_for(meth).first)
-        end
-
-        [doc, code_type]
+      def command_error(message, omit_help)
+        message += " Type `#{command_name} --help` for help." unless omit_help
+        raise CommandError, message
       end
 
-      def get_method_object(meth_name, target=nil, options={})
-        get_method_object_from_target(*get_method_attributes(meth_name, target, options)) rescue nil
-      end
+      def make_header(meth, content=meth.source)
+        header = "\n#{Pry::Helpers::Text.bold('From:')} #{meth.source_file} "
 
-      def get_method_attributes(meth_name, target=nil, options={})
-        if meth_name
-          if meth_name =~ /(\S+)\#(\S+)\Z/
-            context, meth_name = $1, $2
-            target = Pry.binding_for(target.eval(context))
-            type = :instance
-          elsif meth_name =~ /(\S+)\.(\S+)\Z/
-            context, meth_name = $1, $2
-            target = Pry.binding_for(target.eval(context))
-            type = :singleton
-          elsif options["instance_methods"]
-            type = :instance
-          elsif options[:methods]
-            type = :singleton
-          else
-            type = nil
-          end
+        if meth.source_type == :c
+          header << "in Ruby Core (C Method):\n"
         else
-          meth_name = meth_name_from_binding(target)
-          type = nil
+          header << "@ line #{meth.source_line}:\n"
         end
-        [meth_name, target, type]
-      end
 
-      def get_method_object_from_target(meth_name, target, type=nil)
-        case type
-        when :instance
-          target.eval("instance_method(:#{meth_name})") rescue nil
-        when :singleton
-          target.eval("method(:#{meth_name})") rescue nil
-        else
-          get_method_object_from_target(meth_name, target, :instance) ||
-            get_method_object_from_target(meth_name, target, :singleton)
-        end
-      end
-
-      def path_line_for(meth)
-        if rbx_core?(meth)
-          rbx_core_path_line_for(meth)
-        else
-          meth.source_location
-        end
-      end
-
-      def make_header(meth, code_type, content)
-        num_lines = "Number of lines: #{Pry::Helpers::Text.bold(content.each_line.count.to_s)}"
-        case code_type
-        when :ruby
-          file, line = path_line_for(meth)
-          "\n#{Pry::Helpers::Text.bold('From:')} #{file} @ line #{line}:\n#{num_lines}\n\n"
-        else
-          file = Pry::MethodInfo.info_for(meth).file
-          "\n#{Pry::Helpers::Text.bold('From:')} #{file} in Ruby Core (C Method):\n#{num_lines}\n\n"
-        end
-      end
-
-      def is_a_c_method?(meth)
-        meth.source_location.nil?
-      end
-
-      def should_use_pry_doc?(meth)
-        Pry.config.has_pry_doc && is_a_c_method?(meth)
-      end
-
-      def code_type_for(meth)
-        # only C methods
-        if should_use_pry_doc?(meth)
-          info = Pry::MethodInfo.info_for(meth)
-          if info && info.source
-            code_type = :c
-          else
-            output.puts "Cannot find C method: #{meth.name}"
-            code_type = nil
-          end
-        else
-          if is_a_c_method?(meth)
-            output.puts "Cannot locate this method: #{meth.name}. Try `gem install pry-doc` to get access to Ruby Core documentation."
-            code_type = nil
-          else
-            check_for_dynamically_defined_method(meth)
-            code_type = :ruby
-          end
-        end
-        code_type
+        header << "#{Pry::Helpers::Text.bold("Number of lines:")} #{content.each_line.count.to_s}\n"
       end
 
       def file_map
@@ -357,24 +156,6 @@ class Pry
         process_yardoc process_rdoc(comment, code_type)
       end
 
-      # strip leading whitespace but preserve indentation
-      def strip_leading_whitespace(text)
-        return text if text.empty?
-        leading_spaces = text.lines.first[/^(\s+)/, 1]
-        text.gsub(/^#{leading_spaces}/, '')
-      end
-
-      def strip_leading_hash_and_whitespace_from_ruby_comments(comment)
-        comment = comment.dup
-        comment.gsub!(/\A\#+?$/, '')
-        comment.gsub!(/^\s*#/, '')
-        strip_leading_whitespace(comment)
-      end
-
-      def strip_comments_from_c_code(code)
-        code.sub(/\A\s*\/\*.*?\*\/\s*/m, '')
-      end
-
       def invoke_editor(file, line)
         if Pry.config.editor.respond_to?(:call)
           editor_invocation = Pry.config.editor.call(file, line)

data/lib/pry/helpers/options_helpers.rb

@@ -0,0 +1,58 @@
+class Pry
+  module Helpers
+    module OptionsHelpers
+      module_function
+
+      # Use Slop to parse the arguments given.
+      #
+      # @param [Array] args  The options are stripped out by Slop.
+      # @param [*Symbol] extras  Extra features you want returned.
+      # @param [&Block]  used to add custom arguments to Slop.
+      #
+      # @option [Extra] :method_object Returns a method object.
+      #
+      # @return Slop::Options iff you don't pass any extras.
+      # @return [Array]  If you do pass extras, an array is returned where the first argument is the
+      # Slop::Options object, and the remainder are the extras you requested in order.
+      #
+      def parse_options!(args, *extras, &block)
+        opts = Slop.parse!(args) do |opt|
+          extras.each{ |extra| send(:"add_#{extra}_options", opt) }
+
+          yield opt
+
+          opt.on :h, :help, "This message" do
+            output.puts opt
+            throw :command_done
+          end
+        end
+
+        if extras.empty?
+          opts
+        else
+          [opts] + extras.map{ |extra| send(:"process_#{extra}_options", args, opts) }
+        end
+      end
+
+      # Add the method object options to an unused Slop instance.
+      def add_method_object_options(opt)
+        @method_target = target
+        opt.on :M, "instance-methods", "Operate on instance methods."
+        opt.on :m, :methods, "Operate on methods."
+        opt.on :s, :super, "Select the 'super' method. Can be repeated to traverse the ancestors."
+        opt.on :c, :context, "Select object context to run under.", true do |context|
+          @method_target = Pry.binding_for(target.eval(context))
+        end
+      end
+
+      # Add the derived :method_object option to a used Slop instance.
+      def process_method_object_options(args, opts)
+        opts[:instance] = opts['instance-methods'] if opts.m?
+        # TODO: de-hack when we upgrade Slop: https://github.com/injekt/slop/pull/30
+        opts.options[:super].force_argument_value opts.options[:super].count if opts.super?
+
+        get_method_or_raise(args.empty? ? nil : args.join(" "), @method_target, opts.to_hash(true))
+      end
+    end
+  end
+end

data/lib/pry/helpers/text.rb

@@ -29,10 +29,6 @@ class Pry
           end
         end
 
-        alias_method :grey, :bright_black
-        alias_method :gray, :bright_black
-
-
         # Remove any color codes from _text_.
         #
         # @param  [String, #to_s] text
@@ -50,6 +46,16 @@ class Pry
           Pry.color ? "\e[1m#{text}\e[0m" : text.to_s
         end
 
+        # Returns _text_ in the default foreground colour.
+        # Use this instead of "black" or "white" when you mean absence of colour.
+        #
+        # @param [String, #to_s]
+        # @return [String] _text_
+        def default(text)
+          text.to_s
+        end
+        alias_method :bright_default, :bold
+
         # Executes _block_ with _Pry.color_ set to false.
         #
         # @param [Proc]