pry 0.9.8pre7 → 0.9.8pre8

data/lib/pry/default_commands/input.rb

@@ -59,7 +59,7 @@ class Pry
 
       alias_command(/%.?(-?\d+)?(?:\.\.(-?\d+))?/, "amend-line")
 
-      command_class "play" do
+      create_command "play" do
         description "Play back a string variable or a method or a file as input. Type `play --help` for more information."
 
         banner <<-BANNER
@@ -69,73 +69,78 @@ class Pry
           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 -i 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
 
+        attr_accessor :content
+
+        def setup
+          self.content   = ""
+        end
+
         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 :m, :method, "Play a method's source.", true do |meth_name|
+            meth = get_method_or_raise(meth_name, target, {})
+            self.content << meth.source
+          end
+          opt.on :d, :doc, "Play a method's documentation.", true do |meth_name|
+            meth = get_method_or_raise(meth_name, target, {})
+            text.no_color do
+              self.content << process_comment_markup(meth.doc, :ruby)
+            end
+          end
+          opt.on :c, :command, "Play a command's source.", true do |command_name|
+            command = find_command(command_name)
+            block = Pry::Method.new(find_command(command_name).block)
+            self.content << block.source
+          end
+          opt.on :f, :file, "Play a file.", true do |file|
+            self.content << File.read(File.expand_path(file))
+          end
+          opt.on :l, :lines, "Only play a subset of lines.", :optional => true, :as => Range, :default => 1..-1
+          opt.on :i, :in, "Play entries from Pry's input expression history. Takes an index or range.", :optional => true,
+          :as => Range, :default => -5..-1 do |range|
+            input_expressions = _pry_.input_array[range] || []
+            Array(input_expressions).each { |v| self.content << v }
+          end
           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.'
         end
 
         def process
-          if opts.present?(:method)
-            process_method
-          elsif opts.present?(:file)
-            process_file
-          else
-            process_input
-          end
-
+          perform_play
           run "show-input" unless _pry_.complete_expression?(eval_string)
         end
 
-        def process_method
-          meth_name = opts[:m]
-          meth = get_method_or_raise(meth_name, target, {}, :omit_help)
-          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
+        def process_non_opt
+          args.each do |arg|
+            begin
+              self.content << target.eval(arg)
+            rescue Pry::RescuableException
+              raise CommandError, "Prblem when evaling #{arg}."
+            end
+          end
         end
 
-        def process_file
-          file_name = File.expand_path(opts[:f])
+        def perform_play
+          process_non_opt
 
-          if !File.exists?(file_name)
-            raise CommandError, "No such file: #{opts[:f]}"
+          if opts.present?(:lines)
+            self.content = restrict_to_lines(self.content, opts[:l])
           end
 
-          text_array = File.readlines(file_name)
-          range = opts.present?(:lines) ? one_index_range_or_number(opts[:l]) : (0..-1)
-          range = (0..-2) if opts.present?(:open)
-
-          eval_string << Array(text_array[range]).join
-        end
-
-        def process_input
-          if !args.first
-            raise CommandError, "No input to play command."
+          if opts.present?(:open)
+            self.content = restrict_to_lines(self.content, 1..-2)
           end
 
-          code = target.eval(args.first)
-
-          range = opts.present?(:lines) ? one_index_range_or_number(opts[:l]) : (0..-1)
-          range = (0..-2) if opts.present?(:open)
-
-          eval_string << Array(code.each_line.to_a[range]).join
+          eval_string << self.content
         end
-
       end
 
-      command_class "hist", "Show and replay Readline history. Aliases: history" do
+      create_command "hist", "Show and replay Readline history. Aliases: history" do
         banner <<-USAGE
           Usage: hist
                  hist --head N
@@ -148,10 +153,10 @@ class Pry
         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 :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 :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
@@ -230,8 +235,11 @@ class Pry
 
         def process_replay
           @history = @history.between(opts[:r])
-          _pry_.input_stack << _pry_.input
-          _pry_.input = StringIO.new(@history.to_s)
+
+          _pry_.input_stack.push _pry_.input
+          _pry_.input = StringIO.new(@history.raw)
+          # eval_string << "#{@history.raw}\n"
+          # run "show-input" unless _pry_.complete_expression?(eval_string)
         end
       end
 

data/lib/pry/default_commands/introspection.rb

@@ -5,7 +5,7 @@ class Pry
 
     Introspection = Pry::CommandSet.new do
 
-      command_class "show-method" do
+      create_command "show-method" do
         description "Show the source for METH. Type `show-method --help` for more info. Aliases: $, show-source"
 
         banner <<-BANNER
@@ -33,24 +33,29 @@ class Pry
         end
 
         def process
-          meth = method_object
-          raise CommandError, "Could not find method source" unless meth.source
+          raise CommandError, "Could not find method source" unless method_object.source
 
-          output.puts make_header(meth)
-          output.puts "#{text.bold("Owner:")} #{meth.owner || "N/A"}"
-          output.puts "#{text.bold("Visibility:")} #{meth.visibility}"
+          output.puts make_header(method_object)
+          output.puts "#{text.bold("Owner:")} #{method_object.owner || "N/A"}"
+          output.puts "#{text.bold("Visibility:")} #{method_object.visibility}"
           output.puts
 
+          code = Code.from_method(method_object, start_line).
+                   with_line_numbers(use_line_numbers?)
+
+          render_output(code, opts)
+        end
+
+        def use_line_numbers?
+          opts.present?(:b) || opts.present?(:l)
+        end
+
+        def start_line
           if opts.present?(:'base-one')
-            start_line = 1
+            1
           else
-            start_line = meth.source_line || 1
+            method_object.source_line || 1
           end
-
-          code = Code.from_method(meth, start_line).
-                   with_line_numbers(opts.present?(:b) || opts.present?(:l))
-
-          render_output(code, opts)
         end
       end
 
@@ -98,7 +103,7 @@ class Pry
         end
       end
 
-      command_class "edit" do
+      create_command "edit" do
         description "Invoke the default editor on a file. Type `edit --help` for more info"
 
         banner <<-BANNER
@@ -219,7 +224,7 @@ class Pry
         end
       end
 
-      command_class "edit-method" do
+      create_command "edit-method" do
         description "Edit a method. Type `edit-method --help` for more info."
 
         banner <<-BANNER

data/lib/pry/default_commands/ls.rb

@@ -3,7 +3,7 @@ class Pry
 
     Ls = Pry::CommandSet.new do
 
-      command_class "ls","Show the list of vars and methods in the current scope. Type `ls --help` for more info.",
+      create_command "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)

data/lib/pry/default_commands/shell.rb

@@ -30,7 +30,79 @@ class Pry
       end
       alias_command "file-mode", "shell-mode"
 
-      command_class "cat", "Show code from a file, Pry's input buffer, or the last exception." do
+      create_command "save-file", "Export to a file using content from the REPL."  do
+        banner <<-USAGE
+          Usage: save-file [OPTIONS] [FILE]
+          Save REPL content to a file.
+          e.g: save-file -m my_method -m my_method2 ./hello.rb
+          e.g: save-file -i 1..10 ./hello.rb --append
+          e.g: save-file -c show-method ./my_command.rb
+          e.g: save-file -f sample_file --lines 2..10 ./output_file.rb
+        USAGE
+
+        attr_accessor :content
+        attr_accessor :file_name
+
+        def setup
+          self.content = ""
+        end
+
+        def options(opt)
+          opt.on :m, :method, "Save a method's source.", true do |meth_name|
+            meth = get_method_or_raise(meth_name, target, {})
+            self.content << meth.source
+          end
+          opt.on :c, :command, "Save a command's source.", true do |command_name|
+            command = find_command(command_name)
+            block = Pry::Method.new(find_command(command_name).block)
+            self.content << block.source
+          end
+          opt.on :f, :file, "Save a file.", true do |file|
+            self.content << File.read(File.expand_path(file))
+          end
+          opt.on :l, :lines, "Only save a subset of lines.", :optional => true, :as => Range, :default => 1..-1
+          opt.on :i, :in, "Save entries from Pry's input expression history. Takes an index or range.", :optional => true,
+          :as => Range, :default => -5..-1 do |range|
+            input_expressions = _pry_.input_array[range] || []
+            Array(input_expressions).each { |v| self.content << v }
+          end
+          opt.on :a, :append, "Append to the given file instead of overwriting it."
+        end
+
+        def process
+          if args.empty?
+            raise CommandError, "Must specify a file name."
+          end
+
+          self.file_name = File.expand_path(args.first)
+
+          save_file
+        end
+
+        def save_file
+          if self.content.empty?
+            raise CommandError, "Found no code to save."
+          end
+
+          File.open(file_name, mode) do |f|
+            if opts.present?(:lines)
+              f.puts restrict_to_lines(content, opts[:l])
+            else
+              f.puts content
+            end
+          end
+        end
+
+        def mode
+          if opts.present?(:append)
+            "a"
+          else
+            "w"
+          end
+        end
+      end
+
+      create_command "cat", "Show code from a file, Pry's input buffer, or the last exception." do
         banner <<-USAGE
           Usage: cat FILE
                  cat --ex [STACK_INDEX]
@@ -97,6 +169,8 @@ class Pry
             ex_file = RbxPath.convert_path_to_full(ex_file)
           end
 
+          set_file_and_dir_locals(ex_file)
+
           start_line = ex_line - window_size
           start_line = 1 if start_line < 1
           end_line = ex_line + window_size
@@ -146,6 +220,7 @@ class Pry
           end
 
           file_name, line_num = file_name.split(':')
+          file_name = File.expand_path(file_name)
           set_file_and_dir_locals(file_name)
 
           code = yield(Pry::Code.from_file(file_name))

data/lib/pry/helpers/command_helpers.rb

@@ -191,6 +191,15 @@ class Pry
         text.gsub(/^#{margin}/, '')
       end
 
+      # Restrict a string to the given range of lines (1-indexed)
+      # @param [String] content The string.
+      # @param [Range, Fixnum] lines The line(s) to restrict it to.
+      # @return [String] The resulting string.
+      def restrict_to_lines(content, lines)
+        line_range = one_index_range_or_number(lines)
+        Array(content.lines.to_a[line_range]).join
+      end
+
       def one_index_number(line_number)
         if line_number > 0
           line_number - 1

data/lib/pry/hooks.rb

@@ -1,6 +1,31 @@
 class Pry
+
+  # Implements a hooks system for Pry. A hook is a callable that is
+  # associated with an event. A number of events are currently
+  # provided by Pry, these include: `:when_started`, `:before_session`, `:after_session`.
+  # A hook must have a name, and is connected with an event by the
+  # `Pry::Hooks#add_hook` method.
+  # @example Adding a hook for the `:before_session` event.
+  #   Pry.config.hooks.add_hook(:before_session, :say_hi) do
+  #     puts "hello"
+  #   end
   class Hooks
 
+    # Converts a hash to a `Pry::Hooks` instance. All hooks defined
+    # this way are anonymous. This functionality is primarily to
+    # provide backwards-compatibility with the old hash-based hook
+    # system in Pry versions < 0.9.8
+    # @param [Hash] hash The hash to convert to `Pry::Hooks`.
+    # @return [Pry::Hooks] The resulting `Pry::Hooks` instance.
+    def self.from_hash(hash)
+      instance = new
+      hash.each do |k, v|
+        instance.add_hook(k, nil, v)
+      end
+
+      instance
+    end
+
     def initialize
       @hooks = {}
     end
@@ -24,14 +49,28 @@ class Pry
       @errors ||= []
     end
 
-    # Destructively merge the contents of two `Pry:Hooks` instances.
-    # @param [Pry::Hooks] other The `Pry::Hooks` instance to merge
+    # FIXME:
+    # This is a hack to alert people of the new API.
+    def [](event_name)
+      warn "`Pry.hooks[]` is deprecated! Please use the new `Pry::Hooks` API! http://rubydoc.info/github/pry/pry/master/Pry/Hooks"
 
+      get_hook(event_name, nil)
+    end
 
+    # FIXME:
+    # This is a hack to alert people of the new API.
+    def []=(event_name, callable)
+      warn "`Pry.hooks[]=` is deprecated! Please use the new `Pry::Hooks` API! http://rubydoc.info/github/pry/pry/master/Pry/Hooks"
 
-    # TODO: implement by iterating over parameter and only overwriting
-    # elements in receiver if they exist in parameter, and adding
-    # other paramater elements to the end of the original's array
+      add_hook(event_name, nil, callable)
+    end
+
+    # Destructively merge the contents of two `Pry:Hooks` instances.
+    # @param [Pry::Hooks] other The `Pry::Hooks` instance to merge
+    # @return [Pry:Hooks] Returns the receiver.
+    # @example
+    #   hooks = Pry::Hooks.new.add_hook(:before_session, :say_hi) { puts "hi!" }
+    #   Pry::Hooks.new.merge!(hooks)
     def merge!(other)
       @hooks.merge!(other.dup.hooks) do |key, v1, v2|
         merge_arrays(v1, v2)
@@ -55,6 +94,9 @@ class Pry
     # Return a new `Pry::Hooks` instance containing a merge of the contents of two `Pry:Hooks` instances,
     # @param [Pry::Hooks] other The `Pry::Hooks` instance to merge
     # @return [Pry::Hooks] The new hash.
+    # @example
+    #   hooks = Pry::Hooks.new.add_hook(:before_session, :say_hi) { puts "hi!" }
+    #   Pry::Hooks.new.merge(hooks)
     def merge(other)
       self.dup.tap do |v|
         v.merge!(other)
@@ -66,18 +108,29 @@ class Pry
     # @param [Symbol] hook_name The name of the hook.
     # @param [#call] callable The callable.
     # @yield The block to use as the callable (if `callable` parameter not provided)
+    # @return [Pry:Hooks] Returns the receiver.
+    # @example
+    #   Pry::Hooks.new.add_hook(:before_session, :say_hi) { puts "hi!" }
     def add_hook(event_name, hook_name, callable=nil, &block)
       @hooks[event_name] ||= []
 
-      # do not allow duplicates
-      raise ArgumentError, "Hook with name '#{hook_name}' already defined!" if hook_exists?(event_name, hook_name)
+      # do not allow duplicates, but allow multiple `nil` hooks
+      # (anonymous hooks)
+      if hook_exists?(event_name, hook_name) && !hook_name.nil?
+        raise ArgumentError, "Hook with name '#{hook_name}' already defined!"
+      end
+
+      if !block && !callable
+        raise ArgumentError, "Must provide a block or callable."
+      end
+
+      # ensure we only have one anonymous hook
+      @hooks[event_name].delete_if { |h, k| h.nil? } if hook_name.nil?
 
       if block
         @hooks[event_name] << [hook_name, block]
       elsif callable
         @hooks[event_name] << [hook_name, callable]
-      else
-        raise ArgumentError, "Must provide a block or callable."
       end
 
       self
@@ -87,6 +140,9 @@ class Pry
     # @param [Symbol] event_name The name of the event.
     # @param [Array] args The arguments to pass to each hook function.
     # @return [Object] The return value of the last executed hook.
+    # @example
+    #   my_hooks = Pry::Hooks.new.add_hook(:before_session, :say_hi) { puts "hi!" }
+    #   my_hooks.exec_hook(:before_session) #=> OUTPUT: "hi!"
     def exec_hook(event_name, *args, &block)
       @hooks[event_name] ||= []
 
@@ -107,6 +163,9 @@ class Pry
     # Return the number of hook functions registered for the `event_name` event.
     # @param [Symbol] event_name The name of the event.
     # @return [Fixnum] The number of hook functions for `event_name`.
+    # @example
+    #   my_hooks = Pry::Hooks.new.add_hook(:before_session, :say_hi) { puts "hi!" }
+    #   my_hooks.count(:before_session) #=> 1
     def hook_count(event_name)
       @hooks[event_name] ||= []
       @hooks[event_name].size
@@ -116,6 +175,9 @@ class Pry
     # @param [Symbol] event_name The name of the event.
     # @param [Symbol[ hook_name The name of the hook
     # @return [#call] The requested hook.
+    # @example
+    #   my_hooks = Pry::Hooks.new.add_hook(:before_session, :say_hi) { puts "hi!" }
+    #   my_hooks.get_hook(:before_session, :say_hi).call #=> "hi!"
     def get_hook(event_name, hook_name)
       @hooks[event_name] ||= []
       hook = @hooks[event_name].find { |current_hook_name, callable| current_hook_name == hook_name }
@@ -127,6 +189,9 @@ class Pry
     # alter the hooks, use add_hook/delete_hook for that).
     # @param [Symbol] event_name The name of the event.
     # @return [Hash] The hash of hook names / hook functions.
+    # @example
+    #   my_hooks = Pry::Hooks.new.add_hook(:before_session, :say_hi) { puts "hi!" }
+    #   my_hooks.get_hooks(:before_session) #=> {:say_hi=>#<Proc:0x00000101645e18@(pry):9>}
     def get_hooks(event_name)
       @hooks[event_name] ||= []
       Hash[@hooks[event_name]]
@@ -137,6 +202,9 @@ class Pry
     # @param [Symbol] hook_name The name of the hook.
     #   to delete.
     # @return [#call] The deleted hook.
+    # @example
+    #   my_hooks = Pry::Hooks.new.add_hook(:before_session, :say_hi) { puts "hi!" }
+    #   my_hooks.delete_hook(:before_session, :say_hi)
     def delete_hook(event_name, hook_name)
       @hooks[event_name] ||= []
       deleted_callable = nil
@@ -154,16 +222,27 @@ class Pry
 
     # Clear all hooks functions for a given event.
     # @param [String] event_name The name of the event.
+    # @example
+    #   my_hooks = Pry::Hooks.new.add_hook(:before_session, :say_hi) { puts "hi!" }
+    #   my_hooks.delete_hook(:before_session)
     def delete_hooks(event_name)
       @hooks[event_name] = []
     end
 
     alias_method :clear, :delete_hooks
 
+    # Remove all events and hooks, clearing out the Pry::Hooks
+    # instance completely.
+    # @example
+    #   my_hooks = Pry::Hooks.new.add_hook(:before_session, :say_hi) { puts "hi!" }
+    #   my_hooks.clear_all
+    def clear_all
+      @hooks = {}
+    end
+
     # @param [Symbol] event_name Name of the event.
     # @param [Symbol] hook_name Name of the hook.
     # @return [Boolean] Whether the hook by the name `hook_name`
-    #   is defined for the event.
     def hook_exists?(event_name, hook_name)
       !!@hooks[event_name].find { |name, _| name == hook_name }
     end