pry 0.10.0.pre2-universal-mswin32

data/lib/pry/commands/help.rb

@@ -0,0 +1,164 @@
+class Pry
+  class Command::Help < Pry::ClassCommand
+    match 'help'
+    group 'Help'
+    description 'Show a list of commands or information about a specific command.'
+
+    banner <<-'BANNER'
+      Usage: help [COMMAND]
+
+      With no arguments, help lists all the available commands along with their
+      descriptions. When given a command name as an argument, shows the help
+      for that command.
+    BANNER
+
+    # We only want to show commands that have descriptions, so that the
+    # easter eggs don't show up.
+    def visible_commands
+      visible = {}
+      commands.each do |key, command|
+        visible[key] = command if command.description && !command.description.empty?
+      end
+      visible
+    end
+
+    # Get a hash of available commands grouped by the "group" name.
+    def command_groups
+      visible_commands.values.group_by(&:group)
+    end
+
+    def process
+      if args.empty?
+        display_index(command_groups)
+      else
+        display_search(args.first)
+      end
+    end
+
+    # Display the index view, with headings and short descriptions per command.
+    #
+    # @param [Hash<String, Array<Commands>>] groups
+    def display_index(groups)
+      help_text = []
+
+      sorted_group_names(groups).each do |group_name|
+        commands = sorted_commands(groups[group_name])
+
+        if commands.any?
+           help_text << help_text_for_commands(group_name, commands)
+        end
+      end
+
+      _pry_.pager.page help_text.join("\n\n")
+    end
+
+    # Given a group name and an array of commands,
+    # return the help string for those commands.
+    #
+    # @param [String] name The group name.
+    # @param [Array<Pry::Command>] commands
+    # @return [String] The generated help string.
+    def help_text_for_commands(name, commands)
+      "#{text.bold(name.capitalize)}\n" << commands.map do |command|
+        "  #{command.options[:listing].to_s.ljust(18)} #{command.description.capitalize}"
+      end.join("\n")
+    end
+
+    # @param [Hash] groups
+    # @return [Array<String>] An array of sorted group names.
+    def sorted_group_names(groups)
+      groups.keys.sort_by(&method(:group_sort_key))
+    end
+
+    # Sort an array of commands by their `listing` name.
+    #
+    # @param [Array<Pry::Command>] commands The commands to sort
+    # @return [Array<Pry::Command>] commands sorted by listing name.
+    def sorted_commands(commands)
+      commands.sort_by{ |command| command.options[:listing].to_s }
+    end
+
+    # Display help for an individual command or group.
+    #
+    # @param [String] search  The string to search for.
+    def display_search(search)
+      if command = command_set.find_command_for_help(search)
+        display_command(command)
+      else
+        display_filtered_search_results(search)
+      end
+    end
+
+    # Display help for a searched item, filtered first by group
+    # and if that fails, filtered by command name.
+    #
+    # @param [String] search The string to search for.
+    def display_filtered_search_results(search)
+      groups = search_hash(search, command_groups)
+
+      if groups.size > 0
+        display_index(groups)
+      else
+        display_filtered_commands(search)
+      end
+    end
+
+    # Display help for a searched item, filtered by group
+    #
+    # @param [String] search The string to search for.
+    def display_filtered_commands(search)
+      filtered = search_hash(search, visible_commands)
+      raise CommandError, "No help found for '#{args.first}'" if filtered.empty?
+
+      if filtered.size == 1
+        display_command(filtered.values.first)
+      else
+        display_index({"'#{search}' commands" => filtered.values})
+      end
+    end
+
+    # Display help for an individual command.
+    #
+    # @param [Pry::Command] command
+    def display_command(command)
+      _pry_.pager.page command.new.help
+    end
+
+    # Find a subset of a hash that matches the user's search term.
+    #
+    # If there's an exact match a Hash of one element will be returned,
+    # otherwise a sub-Hash with every key that matches the search will
+    # be returned.
+    #
+    # @param [String] search the search term
+    # @param [Hash] hash the hash to search
+    def search_hash(search, hash)
+      matching = {}
+
+      hash.each_pair do |key, value|
+        next unless key.is_a?(String)
+        if normalize(key) == normalize(search)
+          return {key => value}
+        elsif normalize(key).start_with?(normalize(search))
+          matching[key] = value
+        end
+      end
+
+      matching
+    end
+
+    # Clean search terms to make it easier to search group names
+    #
+    # @param [String] key
+    # @return [String]
+    def normalize(key)
+      key.downcase.gsub(/pry\W+/, '')
+    end
+
+    def group_sort_key(group_name)
+      [%w(Help Context Editing Introspection Input_and_output Navigating_pry Gems Basic Commands).index(group_name.gsub(' ', '_')) || 99, group_name]
+    end
+  end
+
+  Pry::Commands.add_command(Pry::Command::Help)
+end

data/lib/pry/commands/hist.rb

@@ -0,0 +1,180 @@
+class Pry
+  class Command::Hist < Pry::ClassCommand
+    match 'hist'
+    group 'Editing'
+    description 'Show and replay Readline history.'
+
+    banner <<-'BANNER'
+      Usage:   hist [--head|--tail]
+               hist --all
+               hist --head N
+               hist --tail N
+               hist --show START..END
+               hist --grep PATTERN
+               hist --clear
+               hist --replay START..END
+               hist --save [START..END] FILE
+      Aliases: history
+
+      Show and replay Readline history.
+    BANNER
+
+    def options(opt)
+      opt.on :a, :all,    "Display all history"
+      opt.on :H, :head,   "Display the first N items", :optional_argument => true, :as => Integer
+      opt.on :T, :tail,   "Display the last N items", :optional_argument => true, :as => Integer
+      opt.on :s, :show,   "Show the given range of lines", :optional_argument => true, :as => Range
+      opt.on :G, :grep,   "Show lines matching the given pattern", :argument => true, :as => String
+      opt.on :c, :clear , "Clear the current session's history"
+      opt.on :r, :replay, "Replay a line or range of lines", :argument => true, :as => Range
+      opt.on     :save,   "Save history to a file", :argument => true, :as => Range
+      opt.on :e, :'exclude-pry', "Exclude Pry commands from the history"
+      opt.on :n, :'no-numbers',  "Omit line numbers"
+    end
+
+    def process
+      @history = find_history
+
+      if opts.present?(:show)
+        @history = @history.between(opts[:show])
+      end
+
+      if opts.present?(:grep)
+        @history = @history.grep(opts[:grep])
+      end
+
+      @history = case
+        when opts.present?(:head)
+          @history.take_lines(1, opts[:head] || 10)
+        when opts.present?(:tail)
+          @history.take_lines(-(opts[:tail] || 10), opts[:tail] || 10)
+        when opts.present?(:show)
+          @history.between(opts[:show])
+        else
+          @history
+        end
+
+      if opts.present?(:'exclude-pry')
+        @history = @history.select do |loc|
+                     !command_set.valid_command?(loc.line)
+                   end
+      end
+
+      if opts.present?(:save)
+        process_save
+      elsif opts.present?(:clear)
+        process_clear
+      elsif opts.present?(:replay)
+        process_replay
+      else
+        process_display
+      end
+    end
+
+    private
+
+    def process_display
+      unless opts.present?(:'no-numbers')
+        @history = @history.with_line_numbers
+      end
+
+      _pry_.pager.open do |pager|
+        @history.print_to_output(pager, true)
+      end
+    end
+
+    def process_save
+      case opts[:save]
+      when Range
+        @history = @history.between(opts[:save])
+
+        unless args.first
+          raise CommandError, "Must provide a file name."
+        end
+
+        file_name = File.expand_path(args.first)
+      when String
+        file_name = File.expand_path(opts[:save])
+      end
+
+      output.puts "Saving history in #{file_name}..."
+
+      File.open(file_name, 'w') { |f| f.write(@history.raw) }
+
+      output.puts "History saved."
+    end
+
+    def process_clear
+      Pry.history.clear
+      output.puts "History cleared."
+    end
+
+    def process_replay
+      @history = @history.between(opts[:r])
+      replay_sequence = @history.raw
+
+      # If we met follow-up "hist" call, check for the "--replay" option
+      # presence. If "hist" command is called with other options, proceed
+      # further.
+      check_for_juxtaposed_replay(replay_sequence)
+
+      replay_sequence.lines.each do |line|
+        _pry_.eval line, :generated => true
+      end
+    end
+
+    # Checks +replay_sequence+ for the presence of neighboring replay calls.
+    # @example
+    #   [1] pry(main)> hist --show 46894
+    #   46894: hist --replay 46675..46677
+    #   [2] pry(main)> hist --show 46675..46677
+    #   46675: 1+1
+    #   46676: a = 100
+    #   46677: hist --tail
+    #   [3] pry(main)> hist --replay 46894
+    #   Error: Replay index 46894 points out to another replay call: `hist -r 46675..46677`
+    #   [4] pry(main)>
+    #
+    # @raise [Pry::CommandError] If +replay_sequence+ contains another
+    #   "hist --replay" call
+    # @param [String] replay_sequence The sequence of commands to be replayed
+    #   (per saltum)
+    # @return [Boolean] `false` if +replay_sequence+ does not contain another
+    #   "hist --replay" call
+    def check_for_juxtaposed_replay(replay_sequence)
+      if replay_sequence =~ /\Ahist(?:ory)?\b/
+        # Create *fresh* instance of Options for parsing of "hist" command.
+        _slop = self.slop
+        _slop.parse replay_sequence.split(' ')[1..-1]
+
+        if _slop.present?(:r)
+          replay_sequence = replay_sequence.split("\n").join('; ')
+          index = opts[:r]
+          index = index.min if index.min == index.max || index.max.nil?
+
+          raise CommandError, "Replay index #{ index } points out to another replay call: `#{ replay_sequence }`"
+        end
+      else
+        false
+      end
+    end
+
+    # Finds history depending on the given switch.
+    #
+    # @return [Pry::Code] if it finds `--all` (or `-a`) switch, returns all
+    #   entries in history. Without the switch returns only the entries from the
+    #   current Pry session.
+    def find_history
+      h = if opts.present?(:all)
+            Pry.history.to_a
+          else
+            Pry.history.to_a.last(Pry.history.session_line_count)
+          end
+      # The last value in history will be the 'hist' command itself.
+      Pry::Code(h[0..-2])
+    end
+  end
+
+  Pry::Commands.add_command(Pry::Command::Hist)
+  Pry::Commands.alias_command 'history', 'hist'
+end

data/lib/pry/commands/import_set.rb

@@ -0,0 +1,22 @@
+class Pry
+  class Command::ImportSet < Pry::ClassCommand
+    match 'import-set'
+    group 'Commands'
+    # TODO: Provide a better description with examples and a general conception
+    # of this command.
+    description 'Import a Pry command set.'
+
+    banner <<-'BANNER'
+      Import a Pry command set.
+    BANNER
+
+    def process(command_set_name)
+      raise CommandError, "Provide a command set name" if command_set.nil?
+
+      set = target.eval(arg_string)
+      _pry_.commands.import set
+    end
+  end
+
+  Pry::Commands.add_command(Pry::Command::ImportSet)
+end

data/lib/pry/commands/install_command.rb

@@ -0,0 +1,53 @@
+class Pry
+  class Command::InstallCommand < Pry::ClassCommand
+    match 'install-command'
+    group 'Commands'
+    description 'Install a disabled command.'
+
+    banner <<-'BANNER'
+      Usage: install-command COMMAND
+
+      Installs the gems necessary to run the given COMMAND. You will generally not
+      need to run this unless told to by an error message.
+    BANNER
+
+    def process(name)
+      require 'rubygems/dependency_installer' unless defined? Gem::DependencyInstaller
+      command = find_command(name)
+
+      unless command
+        output.puts "Command #{ text.green(name) } is not found"
+        return
+      end
+
+      if command_dependencies_met?(command.options)
+        output.puts "Dependencies for #{ text.green(name) } are met. Nothing to do"
+        return
+      end
+
+      output.puts "Attempting to install #{ text.green(name) } command..."
+      gems_to_install = Array(command.options[:requires_gem])
+
+      gems_to_install.each do |g|
+        next if Rubygem.installed?(g)
+        output.puts "Installing #{ text.green(g) } gem..."
+        Rubygem.install(g)
+      end
+
+      gems_to_install.each do |g|
+        begin
+          require g
+        rescue LoadError
+          fail_msg = "Required gem #{ text.green(g) } installed but not found."
+          fail_msg += " Aborting command installation\n"
+          fail_msg += 'Tips: 1. Check your PATH; 2. Run `bundle update`'
+          raise CommandError, fail_msg
+        end
+      end
+
+      output.puts "Installation of #{ text.green(name) } successful! Type `help #{name}` for information"
+    end
+  end
+
+  Pry::Commands.add_command(Pry::Command::InstallCommand)
+end

data/lib/pry/commands/jump_to.rb

@@ -0,0 +1,29 @@
+class Pry
+  class Command::JumpTo < Pry::ClassCommand
+    match 'jump-to'
+    group 'Navigating Pry'
+    description 'Jump to a binding further up the stack.'
+
+    banner <<-'BANNER'
+      Jump to a binding further up the stack, popping all bindings below.
+    BANNER
+
+    def process(break_level)
+      break_level = break_level.to_i
+      nesting_level = _pry_.binding_stack.size - 1
+
+      case break_level
+      when nesting_level
+        output.puts "Already at nesting level #{nesting_level}"
+      when (0...nesting_level)
+        _pry_.binding_stack.slice!(break_level + 1, _pry_.binding_stack.size)
+
+      else
+        max_nest_level = nesting_level - 1
+        output.puts "Invalid nest level. Must be between 0 and #{max_nest_level}. Got #{break_level}."
+      end
+    end
+  end
+
+  Pry::Commands.add_command(Pry::Command::JumpTo)
+end