pry 0.10.pre.1-i386-mingw32 → 0.10.0.pre3-i386-mingw32

data/lib/pry/commands/show_info.rb

@@ -0,0 +1,195 @@
+class Pry
+  class Command::ShowInfo < Pry::ClassCommand
+    extend Pry::Helpers::BaseHelpers
+
+    command_options :shellwords => false, :interpolate => false
+
+    def options(opt)
+      opt.on :s, :super, "Select the 'super' method. Can be repeated to traverse the ancestors", :as => :count
+      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 :a, :all,  "Show all definitions and monkeypatches of the module/class"
+    end
+
+    def process
+      code_object = Pry::CodeObject.lookup(obj_name, _pry_, :super => opts[:super])
+      raise CommandError, no_definition_message if !code_object
+      @original_code_object = code_object
+
+      if show_all_modules?(code_object)
+        # show all monkey patches for a module
+
+        result = content_and_headers_for_all_module_candidates(code_object)
+      else
+        # show a specific code object
+        co = code_object_with_accessible_source(code_object)
+        result = content_and_header_for_code_object(co)
+      end
+
+      set_file_and_dir_locals(code_object.source_file)
+      _pry_.pager.page result
+    end
+
+    # This method checks whether the `code_object` is a WrappedModule,
+    # if it is, then it returns the first candidate (monkeypatch) with
+    # accessible source (or docs). If `code_object` is not a WrappedModule (i.e a
+    # method or a command) then the `code_object` itself is just
+    # returned.
+    #
+    # @return [Pry::WrappedModule, Pry::Method, Pry::Command]
+    def code_object_with_accessible_source(code_object)
+      if code_object.is_a?(WrappedModule)
+        candidate = code_object.candidates.find(&:source)
+        if candidate
+          return candidate
+        else
+          raise CommandError, no_definition_message if !valid_superclass?(code_object)
+
+          @used_super = true
+          code_object_with_accessible_source(code_object.super)
+        end
+      else
+        code_object
+      end
+    end
+
+    def valid_superclass?(code_object)
+      code_object.super && code_object.super.wrapped != Object
+    end
+
+    def content_and_header_for_code_object(code_object)
+      header(code_object) << content_for(code_object)
+    end
+
+    def content_and_headers_for_all_module_candidates(mod)
+      result = "Found #{mod.number_of_candidates} candidates for `#{mod.name}` definition:\n"
+      mod.number_of_candidates.times do |v|
+        candidate = mod.candidate(v)
+        begin
+          result << "\nCandidate #{v+1}/#{mod.number_of_candidates}: #{candidate.source_file} @ line #{candidate.source_line}:\n"
+          content = content_for(candidate)
+
+          result << "Number of lines: #{content.lines.count}\n\n" << content
+        rescue Pry::RescuableException
+          result << "\nNo content found.\n"
+          next
+        end
+      end
+      result
+    end
+
+    def no_definition_message
+      "Couldn't locate a definition for #{obj_name}!"
+    end
+
+    # Generate a header (meta-data information) for all the code
+    # object types: methods, modules, commands, procs...
+    def header(code_object)
+      file_name, line_num = file_and_line_for(code_object)
+      h = "\n#{Pry::Helpers::Text.bold('From:')} #{file_name} "
+      h << code_object_header(code_object, line_num)
+      h << "\n#{Pry::Helpers::Text.bold('Number of lines:')} " <<
+        "#{content_for(code_object).lines.count}\n\n"
+      h << Helpers::Text.bold('** Warning:') << " Cannot find code for #{@original_code_object.nonblank_name}. Showing superclass #{code_object.nonblank_name} instead. **\n\n" if @used_super
+      h
+    end
+
+    def code_object_header(code_object, line_num)
+      if code_object.real_method_object?
+        method_header(code_object, line_num)
+
+        # It sucks we have to test for both Pry::WrappedModule and WrappedModule::Candidate,
+        # probably indicates a deep refactor needs to happen in those classes.
+      elsif code_object.is_a?(Pry::WrappedModule) || code_object.is_a?(Pry::WrappedModule::Candidate)
+        module_header(code_object, line_num)
+      else
+        ""
+      end
+    end
+
+    def method_header(code_object, line_num)
+      h = ""
+      h << (code_object.c_method? ? "(C Method):" : "@ line #{line_num}:")
+      h << method_sections(code_object)[:owner]
+      h << method_sections(code_object)[:visibility]
+      h << method_sections(code_object)[:signature]
+      h
+    end
+
+    def module_header(code_object, line_num)
+      h = ""
+      h << "@ line #{line_num}:\n"
+      h << text.bold(code_object.module? ? "Module" : "Class")
+      h << " #{text.bold('name:')} #{code_object.nonblank_name}"
+
+      if code_object.number_of_candidates > 1
+        h << (text.bold("\nNumber of monkeypatches: ") << code_object.number_of_candidates.to_s)
+        h << ". Use the `-a` option to display all available monkeypatches"
+      end
+      h
+    end
+
+    def method_sections(code_object)
+      {
+        :owner => "\n#{text.bold("Owner:")} #{code_object.owner || "N/A"}\n",
+        :visibility => "#{text.bold("Visibility:")} #{code_object.visibility}",
+        :signature => "\n#{text.bold("Signature:")} #{code_object.signature}"
+      }.merge(header_options) { |key, old, new| (new && old).to_s }
+    end
+
+    def header_options
+      {
+        :owner => true,
+        :visibility => true,
+        :signature => nil
+      }
+    end
+
+    def show_all_modules?(code_object)
+      code_object.is_a?(Pry::WrappedModule) && opts.present?(:all)
+    end
+
+    def obj_name
+      @obj_name ||= args.empty? ? nil : args.join(' ')
+    end
+
+    def use_line_numbers?
+      opts.present?(:b) || opts.present?(:l)
+    end
+
+    def start_line_for(code_object)
+      if opts.present?(:'base-one')
+        1
+      else
+        code_object.source_line || 1
+      end
+    end
+
+    # takes into account possible yard docs, and returns yard_file / yard_line
+    # Also adjusts for start line of comments (using start_line_for), which it has to infer
+    # by subtracting number of lines of comment from start line of code_object
+    def file_and_line_for(code_object)
+      if code_object.module_with_yard_docs?
+        [code_object.yard_file, code_object.yard_line]
+      else
+        [code_object.source_file, start_line_for(code_object)]
+      end
+    end
+
+    def complete(input)
+      if input =~ /([^ ]*)#([a-z0-9_]*)\z/
+        prefix, search = [$1, $2]
+        methods = begin
+                    Pry::Method.all_from_class(binding.eval(prefix))
+                  rescue RescuableException
+                    return super
+                  end
+        methods.map do |method|
+          [prefix, method.name].join('#') if method.name.start_with?(search)
+        end.compact
+      else
+        super
+      end
+    end
+  end
+end

data/lib/pry/commands/show_input.rb

@@ -0,0 +1,17 @@
+class Pry
+  class Command::ShowInput < Pry::ClassCommand
+    match 'show-input'
+    group 'Editing'
+    description 'Show the contents of the input buffer for the current multi-line expression.'
+
+    banner <<-'BANNER'
+      Show the contents of the input buffer for the current multi-line expression.
+    BANNER
+
+    def process
+      output.puts Code.new(eval_string).with_line_numbers
+    end
+  end
+
+  Pry::Commands.add_command(Pry::Command::ShowInput)
+end

data/lib/pry/commands/show_source.rb

@@ -0,0 +1,50 @@
+require 'pry/commands/show_info'
+
+class Pry
+  class Command::ShowSource < Command::ShowInfo
+    match 'show-source'
+    group 'Introspection'
+    description 'Show the source for a method or class.'
+
+    banner <<-'BANNER'
+      Usage:   show-source [OPTIONS] [METH|CLASS]
+      Aliases: $, show-method
+
+      Show the source for a method or class. Tries instance methods first and then
+      methods by default.
+
+      show-source hi_method
+      show-source hi_method
+      show-source Pry#rep     # source for Pry#rep method
+      show-source Pry         # for Pry class
+      show-source Pry -a      # for all Pry class definitions (all monkey patches)
+      show-source Pry.foo -e  # for class of the return value of expression `Pry.foo`
+      show-source Pry --super # for superclass of Pry (Object class)
+
+      https://github.com/pry/pry/wiki/Source-browsing#wiki-Show_method
+    BANNER
+
+    def options(opt)
+      opt.on :e, :eval, "evaluate the command's argument as a ruby expression and show the class its return value"
+      super(opt)
+    end
+
+    def process
+      if opts.present?(:e)
+        obj = target.eval(args.first)
+        self.args = Array.new(1) { Module === obj ? obj.name : obj.class.name }
+      end
+      super
+    end
+
+    # The source for code_object prepared for display.
+    def content_for(code_object)
+      Code.new(code_object.source, start_line_for(code_object)).
+        with_line_numbers(use_line_numbers?)
+    end
+  end
+
+  Pry::Commands.add_command(Pry::Command::ShowSource)
+  Pry::Commands.alias_command 'show-method', 'show-source'
+  Pry::Commands.alias_command '$', 'show-source'
+end

data/lib/pry/commands/simple_prompt.rb

@@ -0,0 +1,22 @@
+class Pry
+  class Command::SimplePrompt < Pry::ClassCommand
+    match 'simple-prompt'
+    group 'prompts'
+    description 'Toggle the simple prompt.'
+
+    banner <<-'BANNER'
+      Toggle the simple prompt.
+    BANNER
+
+    def process
+      case _pry_.prompt
+      when Pry::SIMPLE_PROMPT
+        _pry_.pop_prompt
+      else
+        _pry_.push_prompt Pry::SIMPLE_PROMPT
+      end
+    end
+  end
+
+  Pry::Commands.add_command(Pry::Command::SimplePrompt)
+end

data/lib/pry/commands/stat.rb

@@ -0,0 +1,40 @@
+class Pry
+  class Command::Stat < Pry::ClassCommand
+    match 'stat'
+    group 'Introspection'
+    description 'View method information and set _file_ and _dir_ locals.'
+    command_options :shellwords => false
+
+    banner <<-'BANNER'
+        Usage: stat [OPTIONS] [METH]
+
+        Show method information for method METH and set _file_ and _dir_ locals.
+
+        stat hello_method
+    BANNER
+
+    def options(opt)
+      method_options(opt)
+    end
+
+    def process
+      meth = method_object
+      aliases = meth.aliases
+
+      output.puts unindent <<-EOS
+        Method Information:
+        --
+        Name: #{meth.name}
+        Alias#{ "es" if aliases.length > 1 }: #{ aliases.any? ? aliases.join(", ") : "None." }
+        Owner: #{meth.owner ? meth.owner : "Unknown"}
+        Visibility: #{meth.visibility}
+        Type: #{meth.is_a?(::Method) ? "Bound" : "Unbound"}
+        Arity: #{meth.arity}
+        Method Signature: #{meth.signature}
+        Source Location: #{meth.source_location ? meth.source_location.join(":") : "Not found."}
+      EOS
+    end
+  end
+
+  Pry::Commands.add_command(Pry::Command::Stat)
+end

data/lib/pry/commands/switch_to.rb

@@ -0,0 +1,23 @@
+class Pry
+  class Command::SwitchTo < Pry::ClassCommand
+    match 'switch-to'
+    group 'Navigating Pry'
+    description 'Start a new subsession on a binding in the current stack.'
+
+    banner <<-'BANNER'
+      Start a new subsession on a binding in the current stack (numbered by nesting).
+    BANNER
+
+    def process(selection)
+      selection = selection.to_i
+
+      if selection < 0 || selection > _pry_.binding_stack.size - 1
+        raise CommandError, "Invalid binding index #{selection} - use `nesting` command to view valid indices."
+      else
+        Pry.start(_pry_.binding_stack[selection])
+      end
+    end
+  end
+
+  Pry::Commands.add_command(Pry::Command::SwitchTo)
+end

data/lib/pry/commands/toggle_color.rb

@@ -0,0 +1,24 @@
+class Pry
+  class Command::ToggleColor < Pry::ClassCommand
+    match 'toggle-color'
+    group 'Misc'
+    description 'Toggle syntax highlighting.'
+
+    banner <<-'BANNER'
+      Usage: toggle-color
+
+      Toggle syntax highlighting.
+    BANNER
+
+    def process
+      _pry_.color = color_toggle
+      output.puts "Syntax highlighting #{_pry_.color ? "on" : "off"}"
+    end
+
+    def color_toggle
+      !_pry_.color
+    end
+
+    Pry::Commands.add_command(self)
+  end
+end

data/lib/pry/commands/watch_expression.rb

@@ -0,0 +1,105 @@
+class Pry
+  class Command::WatchExpression < Pry::ClassCommand
+    require 'pry/commands/watch_expression/expression.rb'
+
+    match 'watch'
+    group 'Context'
+    description 'Watch the value of an expression and print a notification whenever it changes.'
+    command_options :use_prefix => false
+
+    banner <<-'BANNER'
+      Usage: watch [EXPRESSION]
+             watch
+             watch --delete [INDEX]
+
+      watch [EXPRESSION] adds an expression to the list of those being watched.
+      It will be re-evaluated every time you hit enter in pry. If its value has
+      changed, the new value will be printed to the console.
+
+      This is useful if you are step-through debugging and want to see how
+      something changes over time.  It's also useful if you're trying to write
+      a method inside pry and want to check that it gives the right answers
+      every time you redefine it.
+
+      watch on its own displays all the currently watched expressions and their
+      values, and watch --delete [INDEX] allows you to delete expressions from
+      the list being watched.
+    BANNER
+
+    def options(opt)
+      opt.on :d, :delete,
+        "Delete the watch expression with the given index. If no index is given; clear all watch expressions.",
+        :optional_argument => true, :as => Integer
+      opt.on :l, :list,
+        "Show all current watch expressions and their values.  Calling watch with no expressions or options will also show the watch expressions."
+    end
+
+    def process
+      case
+      when opts.present?(:delete)
+        delete opts[:delete]
+      when opts.present?(:list) || args.empty?
+        list
+      else
+        add_hook
+        add_expression(args)
+      end
+    end
+
+    private
+
+    def expressions
+      _pry_.config.watch_expressions ||= []
+    end
+
+    def delete(index)
+      if index
+        output.puts "Deleting watch expression ##{index}: #{expressions[index-1]}"
+        expressions.delete_at(index-1)
+      else
+        output.puts "Deleting all watched expressions"
+        expressions.clear
+      end
+    end
+
+    def list
+      if expressions.empty?
+        output.puts "No watched expressions"
+      else
+        _pry_.pager.open do |pager|
+          pager.puts "Listing all watched expressions:"
+          pager.puts ""
+          expressions.each_with_index do |expr, index|
+            pager.print text.with_line_numbers(expr.to_s, index+1)
+          end
+          pager.puts ""
+        end
+      end
+    end
+
+    def eval_and_print_changed(output)
+      expressions.each do |expr|
+        expr.eval!
+        if expr.changed?
+          output.puts "#{text.blue "watch"}: #{expr.to_s}"
+        end
+      end
+    end
+
+    def add_expression(arguments)
+      expressions << Expression.new(_pry_, target, arg_string)
+      output.puts "Watching #{Code.new(arg_string)}"
+    end
+
+    def add_hook
+      hook = [:after_eval, :watch_expression]
+      unless _pry_.hooks.hook_exists?(*hook)
+        _pry_.hooks.add_hook(*hook) do |_, _pry_|
+          eval_and_print_changed _pry_.output
+        end
+      end
+    end
+  end
+
+  Pry::Commands.add_command(Pry::Command::WatchExpression)
+end