pry 0.9.8pre5-i386-mswin32 → 0.9.8pre6-i386-mswin32

data/lib/pry/default_commands/input.rb

@@ -9,9 +9,10 @@ class Pry
       end
 
       command "show-input", "Show the contents of the input buffer for the current multi-line expression." do
-        render_output(false, 1, colorize_code(eval_string))
+        output.puts Code.new(eval_string).with_line_numbers
       end
 
+      # TODO: refactor to command_class
       command(/amend-line(?: (-?\d+)(?:\.\.(-?\d+))?)?/, "Amend a line of input in multi-line mode. Type `amend-line --help` for more information. Aliases %",
               :interpolate => false, :listing => "amend-line")  do |*args|
         start_line_number, end_line_number, replacement_line = *args
@@ -59,35 +60,54 @@ class Pry
 
       alias_command(/%.?(-?\d+)?(?:\.\.(-?\d+))?/, "amend-line")
 
-      command "play", "Play back a string variable or a method or a file as input. Type `play --help` for more information." do |*args|
-        opts = Slop.parse!(args) do |opt|
-          opt.banner unindent <<-USAGE
-            Usage: play [OPTIONS] [--help]
-            Default action (no options) is to play the provided string variable
-            e.g `play _in_[20] --lines 1..3`
-            e.g `play -m Pry#repl --lines 1..-1`
-            e.g `play -f Rakefile --lines 5`
-          USAGE
+      command_class "play" do
+        description "Play back a string variable or a method or a file as input. Type `play --help` for more information."
+
+        banner <<-BANNER
+          Usage: play [OPTIONS] [--help]
+
+          The play command enables you to replay code from files and methods as
+          if they were entered directly in the Pry REPL. Default action (no
+          options) is to play the provided string variable
 
+          e.g: `play _in_[20] --lines 1..3`
+          e.g: `play -m Pry#repl --lines 1..-1`
+          e.g: `play -f Rakefile --lines 5`
+
+          https://github.com/pry/pry/wiki/User-Input#wiki-Play
+        BANNER
+
+        def options(opt)
           opt.on :l, :lines, 'The line (or range of lines) to replay.', true, :as => Range
           opt.on :m, :method, 'Play a method.', true
           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.help
+        end
+
+        def process
+          if opts.present?(:method)
+            process_method
+          elsif opts.present?(:file)
+            process_file
+          else
+            process_input
           end
+
+          run "show-input" unless _pry_.complete_expression?(eval_string)
         end
 
-        if opts.present?(:method)
+        def process_method
           meth_name = opts[:m]
           meth = get_method_or_raise(meth_name, target, {}, :omit_help)
-          next unless meth.source
+          return unless meth.source
 
           range = opts.present?(:lines) ? one_index_range_or_number(opts[:l]) : (0..-1)
           range = (0..-2) if opts.present?(:open)
 
           eval_string << Array(meth.source.each_line.to_a[range]).join
-        elsif opts.present?(:file)
+        end
+
+        def process_file
           file_name = File.expand_path(opts[:f])
 
           if !File.exists?(file_name)
@@ -98,9 +118,10 @@ class Pry
           range = opts.present?(:lines) ? one_index_range_or_number(opts[:l]) : (0..-1)
           range = (0..-2) if opts.present?(:open)
 
-          _pry_.input_stack << _pry_.input
-          _pry_.input = StringIO.new(Array(text_array[range]).join)
-        else
+          eval_string << Array(text_array[range]).join
+        end
+
+        def process_input
           if !args.first
             raise CommandError, "No input to play command."
           end
@@ -113,177 +134,109 @@ class Pry
           eval_string << Array(code.each_line.to_a[range]).join
         end
 
-        run "show-input" if !_pry_.complete_expression?(eval_string)
       end
 
-      command "hist", "Show and replay Readline history. Type `hist --help` for more info. Aliases: history" do |*args|
-        # exclude the current command from history.
-        history = Pry.history.to_a[0..-2]
-
-        opts = Slop.parse!(args) do |opt|
-          opt.banner "Usage: hist [--replay START..END] [--clear] [--grep PATTERN] [--head N] [--tail N] [--help] [--save [START..END] file.txt]\n"
-
-          opt.on :n, 'no-numbers', 'Omit line numbers.'
-
-          opt.on :g, :grep, 'A pattern to match against the history.', true
-
-          opt.on :head, 'Display the first N items of history.',
-                 :optional => true,
-                 :as       => Integer
-
-          opt.on :t, :tail, 'Display the last N items of history.',
-                 :optional => true,
-                 :as       => Integer
-
-          opt.on :s, :show, 'Show the history corresponding to the history line (or range of lines).',
-                 :optional => true,
-                 :as       => Range
-
-          opt.on :e, :exclude, 'Exclude pry commands from the history.'
-
-          opt.on :r, :replay, 'The line (or range of lines) to replay.', true,
-                 :as => Range
-
-          opt.on "save", "Save history to a file. --save [start..end] output.txt. Pry commands are excluded from saved history.", true,
-                 :as => Range
-
-          opt.on :c, :clear, 'Clear the history.', :unless => :grep
-
-          opt.on :h, :help, 'Show this message.', :tail => true, :unless => :grep do
-            output.puts opt.help
-          end
+      command_class "hist", "Show and replay Readline history. Aliases: history" do
+        banner <<-USAGE
+          Usage: hist
+                 hist --head N
+                 hist --tail N
+                 hist --show START..END
+                 hist --grep PATTERN
+                 hist --clear
+                 hist --replay START..END
+                 hist --save [START..END] FILE
+        USAGE
+
+        def options(opt)
+          opt.on :h, :head, "Display the first N items.", :optional => true, :as => Integer
+          opt.on :t, :tail, "Display the last N items.", :optional => true, :as => Integer
+          opt.on :s, :show, "Show the given range of lines.", :optional => true, :as => Range
+          opt.on :g, :grep, "Show lines matching the given pattern.", true, :as => String
+          opt.on :c, :clear, "Clear the current session's history."
+          opt.on :r, :replay, "Replay a line or range of lines.", true, :as => Range
+          opt.on     :save, "Save history to a file.", true, :as => Range
+
+          opt.on :e, :'exclude-pry', "Exclude Pry commands from the history."
+          opt.on :n, :'no-numbers', "Omit line numbers."
+          opt.on :f, :flood, "Do not use a pager to view text longer than one screen."
         end
-        next if opts.present?(:help)
 
-        if opts.present?(:grep)
-          pattern = Regexp.new(arg_string.strip.split(/ /, 2).last.strip)
-          history.pop
-
-          history.map!.with_index do |element, index|
-            if element =~ pattern
-              if opts.present?(:"no-numbers")
-                element
-              else
-                "#{text.blue index}: #{element}"
-              end
+        def process
+          @history = Pry::Code(Pry.history.to_a)
+
+          @history = case
+            when opts.present?(:head)
+              @history.between(1, opts[:head] || 10)
+            when opts.present?(:tail)
+              @history.between(-(opts[:tail] || 10), -1)
+            when opts.present?(:show)
+              @history.between(opts[:show])
+            else
+              @history
             end
-          end
-
-          stagger_output history.compact.join "\n"
-          next
-        end
 
-        if opts.present?(:head)
-          limit = opts['head'] || 10
-          list  = history.first limit
-          lines = list.join("\n")
-          if opts.present?(:"no-numbers")
-            stagger_output lines
-          else
-            stagger_output text.with_line_numbers(lines, 0)
+          if opts.present?(:grep)
+            @history = @history.grep(opts[:grep])
           end
-          next
-        end
 
-        if opts.present?(:tail)
-          limit = opts['tail'] || 10
-          offset = history.size - limit
-          offset = offset < 0 ? 0 : offset
-
-          list  = history.last limit
-          lines = list.join("\n")
-          if opts.present?(:'no-numbers')
-            stagger_output lines
-          else
-            stagger_output text.with_line_numbers(lines, offset)
+          if opts.present?(:'exclude-pry')
+            @history = @history.select { |l, ln| !command_set.valid_command?(l) }
           end
-          next
-        end
 
-        if opts.present?(:show)
-          range = opts['show']
-          start_line = range.is_a?(Range) ? range.first : range
-          lines = Array(history[range]).join("\n")
-          if opts.present?(:'no-numbers')
-            stagger_output lines
+          if opts.present?(:save)
+            process_save
+          elsif opts.present?(:clear)
+            process_clear
+          elsif opts.present?(:replay)
+            process_replay
           else
-            stagger_output text.with_line_numbers(lines, start_line)
+            process_display
           end
-          next
         end
 
-        if opts.present?(:exclude)
-          history.map!.with_index do |element, index|
-            unless command_set.valid_command? element
-              if opts.present?(:'no-numbers')
-                element
-              else
-                "#{text.blue index}: #{element}"
-              end
-            end
+        def process_display
+          unless opts.present?(:'no-numbers')
+            @history = @history.with_line_numbers
           end
-          stagger_output history.compact.join "\n"
-          next
-        end
 
-        if opts.present?(:replay)
-          range = opts['replay']
-          actions = Array(history[range]).join("\n") + "\n"
-          _pry_.input_stack << _pry_.input
-          _pry_.input = StringIO.new(actions)
-          next
-        end
-
-        if opts.present?(:clear)
-          Pry.history.clear
-          output.puts 'History cleared.'
-          next
+          render_output(@history, opts)
         end
 
-        # FIXME: hack to save history (this must be refactored)
-        if opts["save"]
-          file_name = nil
-          hist_array = nil
-
-          case opts["save"]
+        def process_save
+          case opts[:save]
           when Range
-            hist_array = Array(history[opts["save"]])
+            @history = @history.between(opts[:save])
 
-            if !args.first
+            unless args.first
               raise CommandError, "Must provide a file name."
             end
 
             file_name = File.expand_path(args.first)
           when String
-            hist_array = history
-            file_name =  File.expand_path(opts["save"])
+            file_name = File.expand_path(opts[:save])
           end
 
-          output.puts "Saving history in #{file_name} ..."
-          # exclude pry commands
-          hist_array.reject! do |element|
-            command_set.valid_command?(element)
-          end
+          output.puts "Saving history in #{file_name}..."
 
-          File.open(file_name, 'w') do |f|
-            f.write hist_array.join("\n")
-          end
+          File.open(file_name, 'w') { |f| f.write(@history.to_s) }
 
-          output.puts "... history saved."
-          next
+          output.puts "History saved."
         end
 
-        lines = history.join("\n")
-        if opts.present?(:'no-numbers')
-          stagger_output lines
-        else
-          stagger_output text.with_line_numbers(lines, 0)
+        def process_clear
+          Pry.history.clear
+          output.puts "History cleared."
+        end
+
+        def process_replay
+          @history = @history.between(opts[:r])
+          _pry_.input_stack << _pry_.input
+          _pry_.input = StringIO.new(@history.to_s)
         end
       end
 
       alias_command "history", "hist"
-
     end
-
   end
 end

data/lib/pry/default_commands/introspection.rb

@@ -5,13 +5,26 @@ class Pry
 
     Introspection = Pry::CommandSet.new do
 
-      command_class "show-method", "Show the source for METH. Type `show-method --help` for more info. Aliases: $, show-source", :shellwords => false do |*args|
+      command_class "show-method" do
+        description "Show the source for METH. Type `show-method --help` for more info. Aliases: $, show-source"
+
         banner <<-BANNER
           Usage: show-method [OPTIONS] [METH]
+          Aliases: $, show-source
+
           Show the source for method METH. Tries instance methods first and then methods by default.
-          e.g: show-method hello_method
+
+          e.g: `show-method hello_method`
+          e.g: `show-method -m hello_method`
+          e.g: `show-method Pry#rep`
+
+          https://github.com/pry/pry/wiki/Source-browsing#wiki-Show_method
         BANNER
 
+        command_options(
+          :shellwords => false
+        )
+
         def options(opt)
           method_options(opt)
           opt.on :l, "line-numbers", "Show line numbers."
@@ -28,20 +41,16 @@ class Pry
           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
-
-          start_line = false
           if opts.present?(:'base-one')
             start_line = 1
-          elsif opts.present?(:'line-numbers')
+          else
             start_line = meth.source_line || 1
           end
 
-          render_output(opts.present?(:flood), start_line, code)
+          code = Code.from_method(meth, start_line).
+                   with_line_numbers(opts.present?(:b) || opts.present?(:l))
+
+          render_output(code, opts)
         end
       end
 
@@ -81,68 +90,75 @@ class Pry
           output.puts make_header(block)
           output.puts
 
-          if Pry.color
-            code = CodeRay.scan(block.source, :ruby).term
-          else
-            code = block.source
-          end
+          code = Code.from_method(block).with_line_numbers(opts.present?(:'line-numbers'))
 
-          start_line = false
-          if opts.present?(:'line-numbers')
-            start_line = block.source_line || 1
-          end
-
-          render_output(opts.present?(:flood), opts.present?(:'line-numbers') ? block.source_line : false, code)
-          code
+          render_output(code, opts)
         else
           raise CommandError, "No such command: #{command_name}."
         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 unindent <<-USAGE
-            Usage: edit [--no-reload|--reload] [--line LINE] [--temp|--ex|FILE[:LINE]|--in N]
-            Open a text editor. When no FILE is given, edits the pry input buffer.
-            Ensure #{text.bold("Pry.config.editor")} is set to your editor of choice.
-            e.g: edit sample.rb
-          USAGE
+      command_class "edit" do
+        description "Invoke the default editor on a file. Type `edit --help` for more info"
+
+        banner <<-BANNER
+          Usage: edit [--no-reload|--reload] [--line LINE] [--temp|--ex|FILE[:LINE]|--in N]
 
+          Open a text editor. When no FILE is given, edits the pry input buffer.
+          Ensure Pry.config.editor is set to your editor of choice.
+
+          e.g: `edit sample.rb`
+          e.g: `edit sample.rb --line 105`
+          e.g: `edit --ex`
+
+          https://github.com/pry/pry/wiki/Editor-integration#wiki-Edit_command
+        BANNER
+
+        def options(opt)
           opt.on :e, :ex, "Open the file that raised the most recent exception (_ex_.file)", :optional => true, :as => Integer
           opt.on :i, :in, "Open a temporary file containing the Nth line of _in_. N may be a range.", :optional => true, :as => Range, :default => -1..-1
           opt.on :t, :temp, "Open an empty temporary file"
           opt.on :l, :line, "Jump to this line in the opened file", true, :as => Integer
           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.help
+        end
+
+        def process
+          if [opts.present?(:ex), opts.present?(:temp), opts.present?(:in), !args.empty?].count(true) > 1
+            raise CommandError, "Only one of --ex, --temp, --in and FILE may be specified."
+          end
+
+          if !opts.present?(:ex) && args.empty?
+            # edit of local code, eval'd within pry.
+            process_local_edit
+          else
+            # edit of remote code, eval'd at top-level
+            process_remote_edit
           end
         end
-        next if opts.present?(:help)
 
-        if [opts.present?(:ex), opts.present?(:temp), opts.present?(:in), !args.empty?].count(true) > 1
-          raise CommandError, "Only one of --ex, --temp, --in and FILE may be specified."
+        def process_i
+          case opts[:i]
+          when Range
+            (_pry_.input_array[opts[:i]] || []).join
+          when Fixnum
+            _pry_.input_array[opts[:i]] || ""
+          else
+            return output.puts "Not a valid range: #{opts[:i]}"
+          end
         end
 
-        # edit of local code, eval'd within pry.
-        if !opts.present?(:ex) && args.empty?
-
-          content = if opts.present?(:temp)
-                      ""
-                    elsif opts.present?(:in)
-                      case opts[:i]
-                      when Range
-                        (_pry_.input_array[opts[:i]] || []).join
-                      when Fixnum
-                        _pry_.input_array[opts[:i]] || ""
-                      else
-                        next output.puts "Not a valid range: #{opts[:i]}"
-                      end
-                    elsif eval_string.strip != ""
-                      eval_string
-                    else
-                      _pry_.input_array.reverse_each.find{ |x| x && x.strip != "" } || ""
-                    end
+        def process_local_edit
+          content = case
+            when opts.present?(:temp)
+              ""
+            when opts.present?(:in)
+              process_i
+            when eval_string.strip != ""
+              eval_string
+            else
+              _pry_.input_array.reverse_each.find{ |x| x && x.strip != "" } || ""
+          end
 
           line = content.lines.count
 
@@ -156,9 +172,9 @@ class Pry
               end
             end
           end
+        end
 
-        # edit of remote code, eval'd at top-level
-        else
+        def process_remote_edit
           if opts.present?(:ex)
             if _pry_.last_exception.nil?
               raise CommandError, "No exception found."
@@ -203,15 +219,25 @@ class Pry
         end
       end
 
-      command_class "edit-method", "Edit a method. Type `edit-method --help` for more info.", :shellwords => false do |*args|
+      command_class "edit-method" do
+        description "Edit a method. Type `edit-method --help` for more info."
+
+        banner <<-BANNER
+          Usage: edit-method [OPTIONS] [METH]
+
+          Edit the method METH in an editor.
+          Ensure Pry.config.editor is set to your editor of choice.
+
+          e.g: `edit-method hello_method`
+          e.g: `edit-method Pry#rep`
+          e.g: `edit-method`
+
+          https://github.com/pry/pry/wiki/Editor-integration#wiki-Edit_method
+        BANNER
+
+        command_options :shellwords => false
 
         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
-          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."
@@ -219,62 +245,88 @@ class Pry
         end
 
         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
 
-          if opts.present?(:patch) || meth.dynamically_defined?
-            lines = meth.source.lines.to_a
+          begin
+            @method = method_object
+          rescue NonMethodContextError => err
+          end
 
-            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."
+          if opts.present?(:patch) || (@method && @method.dynamically_defined?)
+            if err
+              raise err # can't patch a non-method
             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)
-              end
+            process_patch
+          else
+            if err && !File.exist?(target.eval('__FILE__'))
+              raise err # can't edit a non-file
             end
-            return
+
+            process_file
           end
+        end
+
+        def process_patch
+          lines = @method.source.lines.to_a
 
-          if meth.source_type == :c
-            raise CommandError, "Can't edit a C method."
+          if ((original_name = @method.original_name) &&
+              lines[0] =~ /^def (?:.*?\.)?#{original_name}(?=[\(\s;]|$)/)
+            lines[0] = "def #{original_name}#{$'}"
           else
-            file, line = meth.source_file, meth.source_line
+            raise CommandError, "Pry can only patch methods created with the `def` keyword."
+          end
 
-            invoke_editor(file, opts["no-jump"] ? 0 : line)
-            silence_warnings do
-              load file if !opts.present?(:'no-jump') && !Pry.config.disable_auto_reload
+          temp_file do |f|
+            f.puts lines.join
+            f.flush
+            invoke_editor(f.path, 0)
+
+            if @method.alias?
+              with_method_transaction(original_name, @method.owner) do
+                Pry.new(:input => StringIO.new(File.read(f.path))).rep(@method.owner)
+                Pry.binding_for(@method.owner).eval("alias #{@method.name} #{original_name}")
+              end
+            else
+              Pry.new(:input => StringIO.new(File.read(f.path))).rep(@method.owner)
             end
           end
         end
-      end
 
-      helpers do
-        def with_method_transaction(meth_name, target=TOPLEVEL_BINDING)
-          target = Pry.binding_for(target)
-          temp_name = "__pry_#{meth_name}__"
+        def process_file
+          file, line = extract_file_and_line
 
-          target.eval("alias #{temp_name} #{meth_name}")
-          yield
-          target.eval("alias #{meth_name} #{temp_name}")
-        ensure
-          target.eval("undef #{temp_name}") rescue nil
+          invoke_editor(file, opts["no-jump"] ? 0 : line)
+          silence_warnings do
+            load file unless opts.present?(:'no-jump') || Pry.config.disable_auto_reload
+          end
         end
+
+        protected
+          def extract_file_and_line
+            if @method
+              if @method.source_type == :c
+                raise CommandError, "Can't edit a C method."
+              else
+                [@method.source_file, @method.source_line]
+              end
+            else
+              [target.eval('__FILE__'), target.eval('__LINE__')]
+            end
+          end
+
+          def with_method_transaction(meth_name, target=TOPLEVEL_BINDING)
+            target = Pry.binding_for(target)
+            temp_name = "__pry_#{meth_name}__"
+
+            target.eval("alias #{temp_name} #{meth_name}")
+            yield
+            target.eval("alias #{meth_name} #{temp_name}")
+          ensure
+            target.eval("undef #{temp_name}") rescue nil
+          end
       end
     end
   end