pry 0.10.pre.1-java → 0.10.0.pre2-java

data/lib/pry/helpers/documentation_helpers.rb

@@ -4,14 +4,17 @@ class Pry
     # This class contains methods useful for extracting
     # documentation from methods and classes.
     module DocumentationHelpers
-      def process_rdoc(comment, code_type)
+
+      module_function
+
+      def process_rdoc(comment)
         comment = comment.dup
-        comment.gsub(/<code>(?:\s*\n)?(.*?)\s*<\/code>/m) { Pry.color ? CodeRay.scan($1, code_type).term : $1 }.
-          gsub(/<em>(?:\s*\n)?(.*?)\s*<\/em>/m) { Pry.color ? "\e[1m#{$1}\e[0m": $1 }.
-          gsub(/<i>(?:\s*\n)?(.*?)\s*<\/i>/m) { Pry.color ? "\e[1m#{$1}\e[0m" : $1 }.
-          gsub(/\B\+(\w*?)\+\B/)  { Pry.color ? "\e[32m#{$1}\e[0m": $1 }.
-          gsub(/((?:^[ \t]+.+(?:\n+|\Z))+)/)  { Pry.color ? CodeRay.scan($1, code_type).term : $1 }.
-          gsub(/`(?:\s*\n)?([^\e]*?)\s*`/) { "`#{Pry.color ? CodeRay.scan($1, code_type).term : $1}`" }
+        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)
@@ -33,11 +36,11 @@ class Pry
         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("|")})/) { Pry.color ? "\e[33m#{$1}\e[0m": $1 }
+          gsub(/^@(#{yard_tags.join("|")})/) { "\e[33m#{$1}\e[0m" }
       end
 
-      def process_comment_markup(comment, code_type)
-        process_yardoc process_rdoc(comment, code_type)
+      def process_comment_markup(comment)
+        process_yardoc process_rdoc(comment)
       end
 
       # @param [String] code
@@ -46,10 +49,17 @@ class Pry
         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 strip_leading_hash_and_whitespace_from_ruby_comments(comment)
+      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)

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

@@ -21,11 +21,11 @@ class Pry
 
         COLORS.each_pair do |color, value|
           define_method color do |text|
-            Pry.color ? "\033[0;#{30+value}m#{text}\033[0m" : text.to_s
+            "\033[0;#{30+value}m#{text}\033[0m"
           end
 
           define_method "bright_#{color}" do |text|
-            Pry.color ? "\033[1;#{30+value}m#{text}\033[0m" : text.to_s
+            "\033[1;#{30+value}m#{text}\033[0m"
           end
         end
 
@@ -33,17 +33,16 @@ class Pry
         #
         # @param  [String, #to_s] text
         # @return [String] _text_ stripped of any color codes.
-        def strip_color text
+        def strip_color(text)
           text.to_s.gsub(/\e\[.*?(\d)+m/ , '')
         end
 
         # Returns _text_ as bold text for use on a terminal.
-        # _Pry.color_ must be true for this method to perform any transformations.
         #
         # @param [String, #to_s] text
         # @return [String] _text_
-        def bold text
-          Pry.color ? "\e[1m#{text}\e[0m" : text.to_s
+        def bold(text)
+          "\e[1m#{text}\e[0m"
         end
 
         # Returns `text` in the default foreground colour.
@@ -56,10 +55,10 @@ class Pry
         end
         alias_method :bright_default, :bold
 
-        # Executes the block with `Pry.color` set to false.
+        # Executes the block with `Pry.config.color` set to false.
         # @yield
         # @return [void]
-        def no_color &block
+        def no_color(&block)
           boolean = Pry.config.color
           Pry.config.color = false
           yield
@@ -70,7 +69,7 @@ class Pry
         # Executes the block with `Pry.config.pager` set to false.
         # @yield
         # @return [void]
-        def no_pager &block
+        def no_pager(&block)
           boolean = Pry.config.pager
           Pry.config.pager = false
           yield

data/lib/pry/history.rb

@@ -1,21 +1,33 @@
 class Pry
-  # The History class is responsible for maintaining the user's input history, both
-  # internally and within Readline.
+  # 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
 
-    def initialize
+    # @return [Fixnum] Number of lines in history when Pry first loaded.
+    attr_reader :original_lines
+
+    def initialize(options={})
       @history = []
-      @saved_lines = 0
+      @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
-      @loader  = method(:read_from_file)
-      @saver   = method(:write_to_file)
-      @pusher  = method(:push_to_readline)
-      @clearer = method(:clear_readline)
+      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`.
@@ -24,17 +36,8 @@ class Pry
       @loader.call do |line|
         @pusher.call(line.chomp)
         @history << line.chomp
+        @original_lines += 1
       end
-      @saved_lines = @history.length
-    end
-
-    # Write this session's history using `History.saver`.
-    # @return [Integer] The number of lines saved
-    def save
-      history_to_save = @history[@saved_lines..-1]
-      @saver.call(history_to_save)
-      @saved_lines = @history.length
-      history_to_save.length
     end
 
     # Add a line to the input history, ignoring blank and duplicate lines.
@@ -44,18 +47,27 @@ class Pry
       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 all history. Anything the user entered before this point won't be
-    # saved, but anything they put in afterwards will still be appended to the
-    # history file on exit.
+    # Clear this session's history. This won't affect the contents of the
+    # history file.
     def clear
       @clearer.call
       @history = []
-      @saved_lines = 0
+    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.
@@ -66,33 +78,16 @@ class Pry
     end
 
     private
+
     # The default loader. Yields lines from `Pry.history.config.file`.
     def read_from_file
-      begin
-        history_file = File.expand_path(Pry.config.history.file)
-        if File.exists?(history_file)
-          File.foreach(history_file) { |line| yield(line) }
-        end
-      rescue => error
-        unless error.message.empty?
-          warn "History file not loaded, received an error: #{error.message}"
-        end
-      end
-    end
+      filename = File.expand_path(Pry.config.history.file)
 
-    # The default saver. Appends the given lines to `Pry.history.config.file`.
-    # @param [Array<String>] lines
-    def write_to_file(lines)
-      history_file = File.expand_path(Pry.config.history.file)
-
-      begin
-        File.open(history_file, 'a') do |f|
-          lines.each { |ln| f.puts ln }
-        end
-      rescue Errno::EACCES
-        # We should probably create an option Pry.show_warnings?!?!?!
-        warn 'Unable to write to your history file, history not saved'
+      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.
@@ -105,5 +100,26 @@ class Pry
     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

data/lib/pry/history_array.rb

@@ -1,6 +1,6 @@
 class Pry
   # A history array is an array to which you can only add elements. Older
-  # entries are removed progressively, so that the aray never contains more than
+  # entries are removed progressively, so that the array never contains more than
   # N elements.
   #
   # History arrays are used by Pry to store the output of the last commands.
@@ -89,6 +89,16 @@ class Pry
       ((@count - size)...@count).map { |n| @hash[n] }
     end
 
+    # Returns [Hash] copy of the internal @hash history
+    def to_h
+      @hash.dup
+    end
+
+    def pop!
+      @hash.delete @count - 1
+      @count -= 1
+    end
+
     def inspect
       "#<#{self.class} size=#{size} first=#{@count - size} max_size=#{max_size}>"
     end

data/lib/pry/hooks.rb

@@ -18,11 +18,11 @@ class Pry
     # @param [Hash] hash The hash to convert to `Pry::Hooks`.
     # @return [Pry::Hooks] The resulting `Pry::Hooks` instance.
     def self.from_hash(hash)
+      return hash if hash.instance_of?(self)
       instance = new
       hash.each do |k, v|
         instance.add_hook(k, nil, v)
       end
-
       instance
     end
 
@@ -49,22 +49,6 @@ class Pry
       @errors ||= []
     end
 
-    # 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"
-
-      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.
@@ -146,18 +130,14 @@ class Pry
     def exec_hook(event_name, *args, &block)
       @hooks[event_name] ||= []
 
-      # silence warnings to get rid of 1.8's "warning: multiple values
-      # for a block parameter" warnings
-      Pry::Helpers::BaseHelpers.silence_warnings do
-        @hooks[event_name].map do |hook_name, callable|
-          begin
-            callable.call(*args, &block)
-          rescue RescuableException => e
-            errors << e
-            e
-          end
-        end.last
-      end
+      @hooks[event_name].map do |hook_name, callable|
+        begin
+          callable.call(*args, &block)
+        rescue RescuableException => e
+          errors << e
+          e
+        end
+      end.last
     end
 
     # Return the number of hook functions registered for the `event_name` event.
@@ -244,9 +224,7 @@ class Pry
     # @param [Symbol] hook_name Name of the hook.
     # @return [Boolean] Whether the hook by the name `hook_name`
     def hook_exists?(event_name, hook_name)
-      !!@hooks[event_name].find { |name, _| name == hook_name }
+      !!(@hooks[event_name] && @hooks[event_name].find { |name, _| name == hook_name })
     end
-    private :hook_exists?
-
   end
 end