pry 0.9.8pre2 → 0.9.8pre3

data/lib/pry/default_commands/easter_eggs.rb

@@ -60,8 +60,32 @@ they are lost for hours.
   text
 end
 
+      command "test-ansi", "" do
+        prev_color = Pry.color
+        Pry.color = true
 
-    end
+        picture = unindent <<-'EOS'.gsub(/[[:alpha:]!]/) { |s| text.red(s) }
+           ____      _______________________
+          /    \    |  A         W     G    |
+         / O  O \   |   N    I    O   N !   |
+        |        |  |    S    S    R I   !  |
+         \ \__/ / __|     I         K     ! |
+          \____/   \________________________|
+        EOS
+
+        if defined?(Win32::Console)
+          move_up = proc { |n| "\e[#{n}F" }
+        else
+          move_up = proc { |n| "\e[#{n}A\e[0G" }
+        end
+
+        output.puts "\n" * 6
+        output.puts picture.lines.map(&:chomp).reverse.join(move_up[1])
+        output.puts "\n" * 6
+        output.puts "** ENV['TERM'] is #{ENV['TERM']} **\n\n"
 
+        Pry.color = prev_color
+      end
+    end
   end
 end

data/lib/pry/default_commands/input.rb

@@ -28,7 +28,7 @@ class Pry
           USAGE
 
           opt.on :h, :help, "This message." do
-            output.puts opt
+            output.puts opt.help
           end
         end
 
@@ -74,7 +74,7 @@ class Pry
           opt.on :f, "file", 'The file to replay in context.', true
           opt.on :o, "open", 'When used with the -m switch, it plays the entire method except the last line, leaving the method definition "open". `amend-line` can then be used to modify the method.'
           opt.on :h, :help, "This message." do
-            output.puts opt
+            output.puts opt.help
           end
         end
 
@@ -214,7 +214,7 @@ class Pry
 
         if opts.present?(:exclude)
           history.map!.with_index do |element, index|
-            unless command_processor.valid_command? element
+            unless command_set.valid_command? element
               if opts.present?(:'no-numbers')
                 element
               else
@@ -262,7 +262,7 @@ class Pry
           output.puts "Saving history in #{file_name} ..."
           # exclude pry commands
           hist_array.reject! do |element|
-            command_processor.valid_command?(element)
+            command_set.valid_command?(element)
           end
 
           File.open(file_name, 'w') do |f|
@@ -283,32 +283,6 @@ class Pry
 
       alias_command "history", "hist"
 
-      helpers do
-        def one_index_number(line_number)
-          if line_number > 0
-            line_number - 1
-          elsif line_number < 0
-            line_number
-          else
-            line_number
-          end
-        end
-
-        def one_index_range(range)
-          Range.new(one_index_number(range.begin), one_index_number(range.end))
-        end
-
-        def one_index_range_or_number(range_or_number)
-          case range_or_number
-          when Range
-            one_index_range(range_or_number)
-          else
-            one_index_number(range_or_number)
-          end
-        end
-
-      end
-
     end
 
   end

data/lib/pry/default_commands/introspection.rb

@@ -5,40 +5,44 @@ class Pry
 
     Introspection = Pry::CommandSet.new do
 
-      command "show-method", "Show the source for METH. Type `show-method --help` for more info. Aliases: $, show-source", :shellwords => false do |*args|
-        opts, meth = parse_options!(args, :method_object) do |opt|
-          opt.banner unindent <<-USAGE
-            Usage: show-method [OPTIONS] [METH]
-            Show the source for method METH. Tries instance methods first and then methods by default.
-            e.g: show-method hello_method
-          USAGE
-
+      command_class "show-method", "Show the source for METH. Type `show-method --help` for more info. Aliases: $, show-source", :shellwords => false do |*args|
+        banner <<-BANNER
+          Usage: show-method [OPTIONS] [METH]
+          Show the source for method METH. Tries instance methods first and then methods by default.
+          e.g: show-method hello_method
+        BANNER
+
+        def options(opt)
+          method_options(opt)
           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 :f, :flood, "Do not use a pager to view text longer than one screen."
         end
 
-        raise CommandError, "Could not find method source" unless meth.source
+        def process
+          meth = method_object
+          raise CommandError, "Could not find method source" unless meth.source
 
-        output.puts make_header(meth)
-        output.puts "#{text.bold("Owner:")} #{meth.owner || "N/A"}"
-        output.puts "#{text.bold("Visibility:")} #{meth.visibility}"
-        output.puts
+          output.puts make_header(meth)
+          output.puts "#{text.bold("Owner:")} #{meth.owner || "N/A"}"
+          output.puts "#{text.bold("Visibility:")} #{meth.visibility}"
+          output.puts
 
-        if Pry.color
-          code = CodeRay.scan(meth.source, meth.source_type).term
-        else
-          code = meth.source
-        end
+          if Pry.color
+            code = CodeRay.scan(meth.source, meth.source_type).term
+          else
+            code = meth.source
+          end
 
-        start_line = false
-        if opts.present?(:'base-one')
-          start_line = 1
-        elsif opts.present?(:'line-numbers')
-          start_line = meth.source_line || 1
-        end
+          start_line = false
+          if opts.present?(:'base-one')
+            start_line = 1
+          elsif opts.present?(:'line-numbers')
+            start_line = meth.source_line || 1
+          end
 
-        render_output(opts.present?(:flood), start_line, code)
+          render_output(opts.present?(:flood), start_line, code)
+        end
       end
 
       alias_command "show-source", "show-method"
@@ -57,7 +61,7 @@ class Pry
           opt.on :l, "line-numbers", "Show line numbers."
           opt.on :f, :flood, "Do not use a pager to view text longer than one screen."
           opt.on :h, :help, "This message." do
-            output.puts opt
+            output.puts opt.help
           end
         end
 
@@ -111,7 +115,7 @@ class Pry
           opt.on :n, :"no-reload", "Don't automatically reload the edited code"
           opt.on :r, :reload, "Reload the edited code immediately (default for ruby files)"
           opt.on :h, :help, "This message." do
-            output.puts opt
+            output.puts opt.help
           end
         end
         next if opts.present?(:help)
@@ -199,64 +203,63 @@ class Pry
         end
       end
 
-      command "edit-method", "Edit a method. Type `edit-method --help` for more info.", :shellwords => false do |*args|
-        target = target()
+      command_class "edit-method", "Edit a method. Type `edit-method --help` for more info.", :shellwords => false do |*args|
 
-        opts, meth = parse_options!(args, :method_object) do |opt|
-          opt.banner unindent <<-USAGE
+        def options(opt)
+          opt.banner unindent <<-BANNER
             Usage: edit-method [OPTIONS] [METH]
             Edit the method METH in an editor.
             Ensure #{text.bold("Pry.config.editor")} is set to your editor of choice.
             e.g: edit-method hello_method
-          USAGE
-
+          BANNER
+          method_options(opt)
           opt.on :n, "no-reload", "Do not automatically reload the method's file after editing."
           opt.on "no-jump", "Do not fast forward editor to first line of method."
           opt.on :p, :patch, "Instead of editing the method's file, try to edit in a tempfile and apply as a monkey patch."
-          opt.on :h, :help, "This message." do
-            output.puts opt
-          end
         end
 
-        if !Pry.config.editor
-          raise CommandError, "No editor set!\nEnsure that #{text.bold("Pry.config.editor")} is set to your editor of choice."
-        end
-
-        if opts.present?(:patch) || meth.dynamically_defined?
-          lines = meth.source.lines.to_a
-
-          if ((original_name = meth.original_name) &&
-              lines[0] =~ /^def (?:.*?\.)?#{original_name}(?=[\(\s;]|$)/)
-            lines[0] = "def #{original_name}#{$'}"
-          else
-            raise CommandError, "Pry can only patch methods created with the `def` keyword."
+        def process
+          meth = method_object
+          if !Pry.config.editor
+            raise CommandError, "No editor set!\nEnsure that #{text.bold("Pry.config.editor")} is set to your editor of choice."
           end
 
-          temp_file do |f|
-            f.puts lines.join
-            f.flush
-            invoke_editor(f.path, 0)
+          if opts.present?(:patch) || meth.dynamically_defined?
+            lines = meth.source.lines.to_a
 
-            if meth.alias?
-              with_method_transaction(original_name, meth.owner) do
+            if ((original_name = meth.original_name) &&
+                lines[0] =~ /^def (?:.*?\.)?#{original_name}(?=[\(\s;]|$)/)
+              lines[0] = "def #{original_name}#{$'}"
+            else
+              raise CommandError, "Pry can only patch methods created with the `def` keyword."
+            end
+
+            temp_file do |f|
+              f.puts lines.join
+              f.flush
+              invoke_editor(f.path, 0)
+
+              if meth.alias?
+                with_method_transaction(original_name, meth.owner) do
+                  Pry.new(:input => StringIO.new(File.read(f.path))).rep(meth.owner)
+                  Pry.binding_for(meth.owner).eval("alias #{meth.name} #{original_name}")
+                end
+              else
                 Pry.new(:input => StringIO.new(File.read(f.path))).rep(meth.owner)
-                Pry.binding_for(meth.owner).eval("alias #{meth.name} #{original_name}")
               end
-            else
-              Pry.new(:input => StringIO.new(File.read(f.path))).rep(meth.owner)
             end
+            return
           end
-          next
-        end
 
-        if meth.source_type == :c
-          raise CommandError, "Can't edit a C method."
-        else
-          file, line = meth.source_file, meth.source_line
+          if meth.source_type == :c
+            raise CommandError, "Can't edit a C method."
+          else
+            file, line = meth.source_file, meth.source_line
 
-          invoke_editor(file, opts["no-jump"] ? 0 : line)
-          silence_warnings do
-            load file if !opts.present?(:'no-jump') && !Pry.config.disable_auto_reload
+            invoke_editor(file, opts["no-jump"] ? 0 : line)
+            silence_warnings do
+              load file if !opts.present?(:'no-jump') && !Pry.config.disable_auto_reload
+            end
           end
         end
       end

data/lib/pry/default_commands/ls.rb

@@ -3,7 +3,94 @@ class Pry
 
     Ls = Pry::CommandSet.new do
 
-      helpers do
+      command_class "ls","Show the list of vars and methods in the current scope. Type `ls --help` for more info.",
+              :shellwords => false, :interpolate => false do
+
+        def options(opt)
+          opt.banner unindent <<-USAGE
+            Usage: ls [-m|-M|-p|-pM] [-q|-v] [-c|-i] [Object]
+                   ls [-g] [-l]
+
+            ls shows you which methods, constants and variables are accessible to Pry. By default it shows you the local variables defined in the current shell, and any public methods or instance variables defined on the current object.
+
+            The colours used are configurable using Pry.config.ls.*_color, and the separator is Pry.config.ls.separator.
+
+            Pry.config.ls.ceiling is used to hide methods defined higher up in the inheritance chain, this is by default set to [Object, Module, Class] so that methods defined on all Objects are omitted. The -v flag can be used to ignore this setting and show all methods, while the -q can be used to set the ceiling much lower and show only methods defined on the object or its direct class.
+          USAGE
+
+          opt.on :m, "methods", "Show public methods defined on the Object (default)"
+          opt.on :M, "instance-methods", "Show methods defined in a Module or Class"
+
+          opt.on :p, "ppp", "Show public, protected (in yellow) and private (in green) methods"
+          opt.on :q, "quiet", "Show only methods defined on object.singleton_class and object.class"
+          opt.on :v, "verbose", "Show methods and constants on all super-classes (ignores Pry.config.ls.ceiling)"
+
+          opt.on :g, "globals", "Show global variables, including those builtin to Ruby (in cyan)"
+          opt.on :l, "locals", "Show locals, including those provided by Pry (in red)"
+
+          opt.on :c, "constants", "Show constants, highlighting classes (in blue), and exceptions (in purple)"
+
+          opt.on :i, "ivars", "Show instance variables (in blue) and class variables (in bright blue)"
+
+          opt.on :G, "grep", "Filter output by regular expression", :optional => false
+        end
+
+        def process
+          obj = args.empty? ? target_self : target.eval(args.join(" "))
+
+          # exclude -q, -v and --grep because they don't specify what the user wants to see.
+          has_opts = (opts.present?(:methods) || opts.present?(:'instance-methods') || opts.present?(:ppp) ||
+                      opts.present?(:globals) || opts.present?(:locals) || opts.present?(:constants) ||
+                      opts.present?(:ivars))
+
+          show_methods   = opts.present?(:methods) || opts.present?(:'instance-methods') || opts.present?(:ppp) || !has_opts
+          show_constants = opts.present?(:constants) || (!has_opts && Module === obj)
+          show_ivars     = opts.present?(:ivars) || !has_opts
+          show_locals    = opts.present?(:locals) || (!has_opts && args.empty?)
+
+          grep_regex, grep = [Regexp.new(opts[:G] || "."), lambda{ |x| x.grep(grep_regex) }]
+
+          raise Pry::CommandError, "-l does not make sense with a specified Object" if opts.present?(:locals) && !args.empty?
+          raise Pry::CommandError, "-g does not make sense with a specified Object" if opts.present?(:globals) && !args.empty?
+          raise Pry::CommandError, "-q does not make sense with -v" if opts.present?(:quiet) && opts.present?(:verbose)
+          raise Pry::CommandError, "-M only makes sense with a Module or a Class" if opts.present?(:'instance-methods') && !(Module === obj)
+          raise Pry::CommandError, "-c only makes sense with a Module or a Class" if opts.present?(:constants) && !args.empty? && !(Module === obj)
+
+
+          if opts.present?(:globals)
+            output_section("global variables", grep[format_globals(target.eval("global_variables"))])
+          end
+
+          if show_constants
+            mod = Module === obj ? obj : Object
+            constants = mod.constants
+            constants -= (mod.ancestors - [mod]).map(&:constants).flatten unless opts.present?(:verbose)
+            output_section("constants", grep[format_constants(mod, constants)])
+          end
+
+          if show_methods
+            # methods is a hash {Module/Class => [Pry::Methods]}
+            methods = all_methods(obj).select{ |method| opts.present?(:ppp) || method.visibility == :public }.group_by(&:owner)
+
+            # reverse the resolution order so that the most useful information appears right by the prompt
+            resolution_order(obj).take_while(&below_ceiling(obj)).reverse.each do |klass|
+              methods_here = format_methods((methods[klass] || []).select{ |m| m.name =~ grep_regex })
+              output_section "#{Pry::WrappedModule.new(klass).method_prefix}methods", methods_here
+            end
+          end
+
+          if show_ivars
+            klass = (Module === obj ? obj : obj.class)
+            output_section("instance variables", format_variables(:instance_var, grep[obj.__send__(:instance_variables)]))
+            output_section("class variables", format_variables(:class_var, grep[klass.__send__(:class_variables)]))
+          end
+
+          if show_locals
+            output_section("locals", format_locals(grep[target.eval("local_variables")]))
+          end
+        end
+
+        private
 
         # http://ruby.runpaint.org/globals, and running "puts global_variables.inspect".
         BUILTIN_GLOBALS = %w($" $$ $* $, $-0 $-F $-I $-K $-W $-a $-d $-i $-l $-p $-v $-w $. $/ $\\
@@ -20,17 +107,17 @@ class Pry
                            $LAST_PAREN_MATCH $LAST_READ_LINE $MATCH $POSTMATCH $PREMATCH)
 
         # Get all the methods that we'll want to output
-        def all_methods(obj, opts)
+        def all_methods(obj)
           opts.present?(:'instance-methods') ? Pry::Method.all_from_class(obj) : Pry::Method.all_from_obj(obj)
         end
 
-        def resolution_order(obj, opts)
+        def resolution_order(obj)
           opts.present?(:'instance-methods') ? Pry::Method.instance_resolution_order(obj) : Pry::Method.resolution_order(obj)
         end
 
         # Get a lambda that can be used with .take_while to prevent over-eager
         # traversal of the Object's ancestry graph.
-        def below_ceiling(obj, opts)
+        def below_ceiling(obj)
           ceiling = if opts.present?(:quiet)
                        [opts.present?(:'instance-methods') ? obj.ancestors[1] : obj.class.ancestors[1]] + Pry.config.ls.ceiling
                      elsif opts.present?(:verbose)
@@ -108,96 +195,6 @@ class Pry
           text.send(Pry.config.ls.send(:"#{type}_color"), str)
         end
       end
-
-      command "ls", "Show the list of vars and methods in the current scope. Type `ls --help` for more info.",
-              :shellwords => false, :interpolate => false do |*args|
-
-        opts = Slop.parse!(args, :strict => true) do |opt|
-          opt.banner unindent <<-USAGE
-            Usage: ls [-m|-M|-p|-pM] [-q|-v] [-c|-i] [Object]
-                   ls [-g] [-l]
-
-            ls shows you which methods, constants and variables are accessible to Pry. By default it shows you the local variables defined in the current shell, and any public methods or instance variables defined on the current object.
-
-            The colours used are configurable using Pry.config.ls.*_color, and the separator is Pry.config.ls.separator.
-
-            Pry.config.ls.ceiling is used to hide methods defined higher up in the inheritance chain, this is by default set to [Object, Module, Class] so that methods defined on all Objects are omitted. The -v flag can be used to ignore this setting and show all methods, while the -q can be used to set the ceiling much lower and show only methods defined on the object or its direct class.
-          USAGE
-
-          opt.on :m, "methods", "Show public methods defined on the Object (default)"
-          opt.on :M, "instance-methods", "Show methods defined in a Module or Class"
-
-          opt.on :p, "ppp", "Show public, protected (in yellow) and private (in green) methods"
-          opt.on :q, "quiet", "Show only methods defined on object.singleton_class and object.class"
-          opt.on :v, "verbose", "Show methods and constants on all super-classes (ignores Pry.config.ls.ceiling)"
-
-          opt.on :g, "globals", "Show global variables, including those builtin to Ruby (in cyan)"
-          opt.on :l, "locals", "Show locals, including those provided by Pry (in red)"
-
-          opt.on :c, "constants", "Show constants, highlighting classes (in blue), and exceptions (in purple)"
-
-          opt.on :i, "ivars", "Show instance variables (in blue) and class variables (in bright blue)"
-
-          opt.on :G, "grep", "Filter output by regular expression", :optional => false
-
-          opt.on :h, "help", "Show help"
-        end
-
-        next output.puts(opts.to_s) if opts.present?(:help)
-
-        obj = args.empty? ? target_self : target.eval(args.join(" "))
-
-        # exclude -q, -v and --grep because they don't specify what the user wants to see.
-        has_opts = (opts.present?(:methods) || opts.present?(:'instance-methods') || opts.present?(:ppp) ||
-                    opts.present?(:globals) || opts.present?(:locals) || opts.present?(:constants) ||
-                    opts.present?(:ivars))
-
-        show_methods   = opts.present?(:methods) || opts.present?(:'instance-methods') || opts.present?(:ppp) || !has_opts
-        show_constants = opts.present?(:constants) || (!has_opts && Module === obj)
-        show_ivars     = opts.present?(:ivars) || !has_opts
-        show_locals    = opts.present?(:locals) || (!has_opts && args.empty?)
-
-        grep_regex, grep = [Regexp.new(opts[:G] || "."), lambda{ |x| x.grep(grep_regex) }]
-
-        raise Pry::CommandError, "-l does not make sense with a specified Object" if opts.present?(:locals) && !args.empty?
-        raise Pry::CommandError, "-g does not make sense with a specified Object" if opts.present?(:globals) && !args.empty?
-        raise Pry::CommandError, "-q does not make sense with -v" if opts.present?(:quiet) && opts.present?(:verbose)
-        raise Pry::CommandError, "-M only makes sense with a Module or a Class" if opts.present?(:'instance-methods') && !(Module === obj)
-        raise Pry::CommandError, "-c only makes sense with a Module or a Class" if opts.present?(:constants) && !args.empty? && !(Module === obj)
-
-
-        if opts.present?(:globals)
-          output_section("global variables", grep[format_globals(target.eval("global_variables"))])
-        end
-
-        if show_constants
-          mod = Module === obj ? obj : Object
-          constants = mod.constants
-          constants -= (mod.ancestors - [mod]).map(&:constants).flatten unless opts.present?(:verbose)
-          output_section("constants", grep[format_constants(mod, constants)])
-        end
-
-        if show_methods
-          # methods is a hash {Module/Class => [Pry::Methods]}
-          methods = all_methods(obj, opts).select{ |method| opts.present?(:ppp) || method.visibility == :public }.group_by(&:owner)
-
-          # reverse the resolution order so that the most useful information appears right by the prompt
-          resolution_order(obj, opts).take_while(&below_ceiling(obj, opts)).reverse.each do |klass|
-            methods_here = format_methods((methods[klass] || []).select{ |m| m.name =~ grep_regex })
-            output_section "#{Pry::WrappedModule.new(klass).method_prefix}methods", methods_here
-          end
-        end
-
-        if show_ivars
-          klass = (Module === obj ? obj : obj.class)
-          output_section("instance variables", format_variables(:instance_var, grep[obj.__send__(:instance_variables)]))
-          output_section("class variables", format_variables(:class_var, grep[klass.__send__(:class_variables)]))
-        end
-
-        if show_locals
-          output_section("locals", format_locals(grep[target.eval("local_variables")]))
-        end
-      end
     end
   end
 end