pry 0.10.0.pre2-universal-mswin32

data/lib/pry/helpers/documentation_helpers.rb

@@ -0,0 +1,75 @@
+class Pry
+  module Helpers
+
+    # This class contains methods useful for extracting
+    # documentation from methods and classes.
+    module DocumentationHelpers
+
+      module_function
+
+      def process_rdoc(comment)
+        comment = comment.dup
+        comment.gsub(/<code>(?:\s*\n)?(.*?)\s*<\/code>/m) { CodeRay.scan($1, :ruby).term }.
+          gsub(/<em>(?:\s*\n)?(.*?)\s*<\/em>/m) { "\e[1m#{$1}\e[0m" }.
+          gsub(/<i>(?:\s*\n)?(.*?)\s*<\/i>/m) { "\e[1m#{$1}\e[0m" }.
+          gsub(/\B\+(\w+?)\+\B/)  { "\e[32m#{$1}\e[0m" }.
+          gsub(/((?:^[ \t]+.+(?:\n+|\Z))+)/)  { CodeRay.scan($1, :ruby).term }.
+          gsub(/`(?:\s*\n)?([^\e]*?)\s*`/) { "`#{CodeRay.scan($1, :ruby).term}`" }
+      end
+
+      def process_yardoc_tag(comment, tag)
+        in_tag_block = nil
+        comment.lines.map do |v|
+          if in_tag_block && v !~ /^\S/
+            Pry::Helpers::Text.strip_color Pry::Helpers::Text.strip_color(v)
+          elsif in_tag_block
+            in_tag_block = false
+            v
+          else
+            in_tag_block = true if v =~ /^@#{tag}/
+            v
+          end
+        end.join
+      end
+
+      def process_yardoc(comment)
+        yard_tags = ["param", "return", "option", "yield", "attr", "attr_reader", "attr_writer",
+                     "deprecate", "example", "raise"]
+        (yard_tags - ["example"]).inject(comment) { |a, v| process_yardoc_tag(a, v) }.
+          gsub(/^@(#{yard_tags.join("|")})/) { "\e[33m#{$1}\e[0m" }
+      end
+
+      def process_comment_markup(comment)
+        process_yardoc process_rdoc(comment)
+      end
+
+      # @param [String] code
+      # @return [String]
+      def strip_comments_from_c_code(code)
+        code.sub(/\A\s*\/\*.*?\*\/\s*/m, '')
+      end
+
+      # Given a string that makes up a comment in a source-code file parse out the content
+      # that the user is intended to read. (i.e. without leading indentation, #-characters
+      # or shebangs)
+      #
+      # @param [String] comment
+      # @return [String]
+      def get_comment_content(comment)
+        comment = comment.dup
+        # Remove #!/usr/bin/ruby
+        comment.gsub!(/\A\#!.*$/, '')
+        # Remove leading empty comment lines
+        comment.gsub!(/\A\#+?$/, '')
+        comment.gsub!(/^\s*#/, '')
+        strip_leading_whitespace(comment)
+      end
+
+      # @param [String] text
+      # @return [String]
+      def strip_leading_whitespace(text)
+        Pry::Helpers::CommandHelpers.unindent(text)
+      end
+    end
+  end
+end

data/lib/pry/helpers/options_helpers.rb

@@ -0,0 +1,27 @@
+class Pry
+  module Helpers
+    module OptionsHelpers
+      module_function
+
+      # Add method options to the Slop instance
+      def method_options(opt)
+        @method_target = target
+        opt.on :M, "instance-methods", "Operate on instance methods."
+        opt.on :m, :methods, "Operate on methods."
+        opt.on :s, :super, "Select the 'super' method. Can be repeated to traverse the ancestors.", :as => :count
+        opt.on :c, :context, "Select object context to run under.", :argument => true do |context|
+          @method_target = Pry.binding_for(target.eval(context))
+        end
+      end
+
+      # Get the method object parsed by the slop instance
+      def method_object
+        @method_object ||= get_method_or_raise(args.empty? ? nil : args.join(" "), @method_target,
+                            :super => opts[:super],
+                            :instance => opts.present?(:'instance-methods') && !opts.present?(:'methods'),
+                            :methods  => opts.present?(:'methods') && !opts.present?(:'instance-methods')
+                           )
+      end
+    end
+  end
+end

data/lib/pry/helpers/table.rb

@@ -0,0 +1,109 @@
+class Pry
+  module Helpers
+    def self.tablify_or_one_line(heading, things)
+      plain_heading = Pry::Helpers::Text.strip_color(heading)
+      attempt = Table.new(things, :column_count => things.size)
+      if attempt.fits_on_line?(Terminal.width! - plain_heading.size - 2)
+        "#{heading}: #{attempt}\n"
+      else
+        "#{heading}: \n#{tablify_to_screen_width(things, :indent => '  ')}\n"
+      end
+    end
+
+    def self.tablify_to_screen_width(things, options = {})
+      things = things.compact
+      if indent = options[:indent]
+        usable_width = Terminal.width! - indent.size
+        tablify(things, usable_width).to_s.gsub(/^/, indent)
+      else
+        tablify(things, Terminal.width!).to_s
+      end
+    end
+
+    def self.tablify(things, line_length)
+      table = Table.new(things, :column_count => things.size)
+      table.column_count -= 1 until 1 == table.column_count or
+        table.fits_on_line?(line_length)
+      table
+    end
+
+    class Table
+      attr_reader :items, :column_count
+      def initialize items, args = {}
+        @column_count = args[:column_count]
+        self.items = items
+      end
+
+      def to_s
+        rows_to_s.join("\n")
+      end
+
+      def rows_to_s style = :color_on
+        widths = columns.map{|e| _max_width(e)}
+        @rows_without_colors.map do |r|
+          padded = []
+          r.each_with_index do |e,i|
+            next unless e
+            item = e.ljust(widths[i])
+            item.sub! e, _recall_color_for(e) if :color_on == style
+            padded << item
+          end
+          padded.join(Pry.config.ls.separator)
+        end
+      end
+
+      def items= items
+        @items = items
+        _rebuild_colorless_cache
+        _recolumn
+        items
+      end
+
+      def column_count= n
+        @column_count = n
+        _recolumn
+      end
+
+      def fits_on_line? line_length
+        _max_width(rows_to_s :no_color) <= line_length
+      end
+
+      def columns
+        @rows_without_colors.transpose
+      end
+
+      def ==(other); items == other.to_a end
+      def to_a; items.to_a end
+
+      private
+      def _max_width(things)
+        things.compact.map(&:size).max || 0
+      end
+
+      def _rebuild_colorless_cache
+        @colorless_cache = {}
+        @plain_items = []
+        items.map do |e|
+          plain = Pry::Helpers::Text.strip_color(e)
+          @colorless_cache[plain] = e
+          @plain_items << plain
+        end
+      end
+
+      def _recolumn
+        @rows_without_colors = []
+        return if items.size.zero?
+        row_count = (items.size.to_f/column_count).ceil
+        row_count.times do |i|
+          row_indices = (0...column_count).map{|e| row_count*e+i}
+          @rows_without_colors << row_indices.map{|e| @plain_items[e]}
+        end
+      end
+
+      def _recall_color_for thing
+        @colorless_cache[thing]
+      end
+    end
+
+  end
+end

data/lib/pry/helpers/text.rb

@@ -0,0 +1,107 @@
+class Pry
+  module Helpers
+
+    # The methods defined on {Text} are available to custom commands via {Pry::Command#text}.
+    module Text
+
+      COLORS =
+      {
+        "black"   => 0,
+        "red"     => 1,
+        "green"   => 2,
+        "yellow"  => 3,
+        "blue"    => 4,
+        "purple"  => 5,
+        "magenta" => 5,
+        "cyan"    => 6,
+        "white"   => 7
+      }
+
+      class << self
+
+        COLORS.each_pair do |color, value|
+          define_method color do |text|
+            "\033[0;#{30+value}m#{text}\033[0m"
+          end
+
+          define_method "bright_#{color}" do |text|
+            "\033[1;#{30+value}m#{text}\033[0m"
+          end
+        end
+
+        # Remove any color codes from _text_.
+        #
+        # @param  [String, #to_s] text
+        # @return [String] _text_ stripped of any color codes.
+        def strip_color(text)
+          text.to_s.gsub(/\e\[.*?(\d)+m/ , '')
+        end
+
+        # Returns _text_ as bold text for use on a terminal.
+        #
+        # @param [String, #to_s] text
+        # @return [String] _text_
+        def bold(text)
+          "\e[1m#{text}\e[0m"
+        end
+
+        # Returns `text` in the default foreground colour.
+        # Use this instead of "black" or "white" when you mean absence of colour.
+        #
+        # @param [String, #to_s] text
+        # @return [String]
+        def default(text)
+          text.to_s
+        end
+        alias_method :bright_default, :bold
+
+        # Executes the block with `Pry.config.color` set to false.
+        # @yield
+        # @return [void]
+        def no_color(&block)
+          boolean = Pry.config.color
+          Pry.config.color = false
+          yield
+        ensure
+          Pry.config.color = boolean
+        end
+
+        # Executes the block with `Pry.config.pager` set to false.
+        # @yield
+        # @return [void]
+        def no_pager(&block)
+          boolean = Pry.config.pager
+          Pry.config.pager = false
+          yield
+        ensure
+          Pry.config.pager = boolean
+        end
+
+        # Returns _text_ in a numbered list, beginning at _offset_.
+        #
+        # @param  [#each_line] text
+        # @param  [Fixnum] offset
+        # @return [String]
+        def with_line_numbers(text, offset, color=:blue)
+          lines = text.each_line.to_a
+          max_width = (offset + lines.count).to_s.length
+          lines.each_with_index.map do |line, index|
+            adjusted_index = (index + offset).to_s.rjust(max_width)
+            "#{self.send(color, adjusted_index)}: #{line}"
+          end.join
+        end
+
+        # Returns _text_ indented by _chars_ spaces.
+        #
+        # @param [String] text
+        # @param [Fixnum] chars
+        def indent(text, chars)
+          text.lines.map { |l| "#{' ' * chars}#{l}" }.join
+        end
+      end
+
+    end
+
+  end
+end
+

data/lib/pry/history.rb

@@ -0,0 +1,125 @@
+class Pry
+  # The History class is responsible for maintaining the user's input history,
+  # both internally and within Readline.
+  class History
+    attr_accessor :loader, :saver, :pusher, :clearer
+
+    # @return [Fixnum] Number of lines in history when Pry first loaded.
+    attr_reader :original_lines
+
+    def initialize(options={})
+      @history = []
+      @original_lines = 0
+      @file_path = options[:file_path]
+      restore_default_behavior
+    end
+
+    # Assign the default methods for loading, saving, pushing, and clearing.
+    def restore_default_behavior
+      Pry.config.input # force Readline to load if applicable
+
+      @loader = method(:read_from_file)
+      @saver  = method(:save_to_file)
+
+      if defined?(Readline)
+        @pusher  = method(:push_to_readline)
+        @clearer = method(:clear_readline)
+      else
+        @pusher  = proc { }
+        @clearer = proc { }
+      end
+    end
+
+    # Load the input history using `History.loader`.
+    # @return [Integer] The number of lines loaded
+    def load
+      @loader.call do |line|
+        @pusher.call(line.chomp)
+        @history << line.chomp
+        @original_lines += 1
+      end
+    end
+
+    # Add a line to the input history, ignoring blank and duplicate lines.
+    # @param [String] line
+    # @return [String] The same line that was passed in
+    def push(line)
+      unless line.empty? || (@history.last && line == @history.last)
+        @pusher.call(line)
+        @history << line
+        @saver.call(line) if Pry.config.history.should_save
+      end
+      line
+    end
+    alias << push
+
+    # Clear this session's history. This won't affect the contents of the
+    # history file.
+    def clear
+      @clearer.call
+      @history = []
+    end
+
+    # @return [Fixnum] The number of lines in history.
+    def history_line_count
+      @history.count
+    end
+
+    # @return [Fixnum] The number of lines in history from just this session.
+    def session_line_count
+      @history.count - @original_lines
+    end
+
+    # Return an Array containing all stored history.
+    # @return [Array<String>] An Array containing all lines of history loaded
+    #   or entered by the user in the current session.
+    def to_a
+      @history.dup
+    end
+
+    private
+
+    # The default loader. Yields lines from `Pry.history.config.file`.
+    def read_from_file
+      filename = File.expand_path(Pry.config.history.file)
+
+      if File.exists?(filename)
+        File.foreach(filename) { |line| yield(line) }
+      end
+    rescue => error
+      warn "History file not loaded: #{error.message}"
+    end
+
+    # The default pusher. Appends the given line to Readline::HISTORY.
+    # @param [String] line
+    def push_to_readline(line)
+      Readline::HISTORY << line
+    end
+
+    # The default clearer. Clears Readline::HISTORY.
+    def clear_readline
+      Readline::HISTORY.shift until Readline::HISTORY.empty?
+    end
+
+    # The default saver. Appends the given line to `Pry.history.config.file`.
+    def save_to_file(line)
+      history_file.puts line if history_file
+    end
+
+    # The history file, opened for appending.
+    def history_file
+      if defined?(@history_file)
+        @history_file
+      else
+        @history_file = File.open(file_path, 'a', 0600).tap { |f| f.sync = true }
+      end
+    rescue Errno::EACCES
+      warn 'History not saved; unable to open your history file for writing.'
+      @history_file = false
+    end
+
+    def file_path
+      @file_path || Pry.config.history.file
+    end
+  end
+end