pry 0.11.3 → 0.12.2

data/lib/pry/helpers/base_helpers.rb

@@ -1,8 +1,135 @@
 module Pry::Helpers; end
+
+# rubocop:disable Metrics/ModuleLength
 module Pry::Helpers::BaseHelpers
-  include Pry::Platform
   extend self
 
+  @mac_osx_warn = false
+  # @deprecated Use {Pry::Helpers::Platform.mac_osx?} instead.
+  def mac_osx?
+    unless @mac_osx_warn
+      loc = caller_locations(1..1).first
+      warn(
+        "#{loc.path}:#{loc.lineno}: warning: method BaseHelpers##{__method__} " \
+        "is deprecated. Use Pry:Helpers::Platform.#{__method__} instead"
+      )
+      @mac_osx_warn = true
+    end
+    Pry::Helpers::Platform.mac_osx?
+  end
+
+  @linux_warn = false
+  # @deprecated Use {Pry::Helpers::Platform.mac_osx?} instead.
+  def linux?
+    unless @linux_warn
+      loc = caller_locations(1..1).first
+      warn(
+        "#{loc.path}:#{loc.lineno}: warning: method BaseHelpers##{__method__} " \
+        "is deprecated. Use Pry:Helpers::Platform.#{__method__} instead"
+      )
+      @linux_warn = true
+    end
+    Pry::Helpers::Platform.linux?
+  end
+
+  @windows_warn = false
+  # @deprecated Use {Pry::Helpers::Platform.windows?} instead.
+  def windows?
+    unless @windows_warn
+      loc = caller_locations(1..1).first
+      warn(
+        "#{loc.path}:#{loc.lineno}: warning: method BaseHelpers##{__method__} " \
+        "is deprecated. Use Pry:Helpers::Platform.#{__method__} instead"
+      )
+      @windows_warn = true
+    end
+    Pry::Helpers::Platform.windows?
+  end
+
+  @windows_ansi_warn = false
+  # @deprecated Use {Pry::Helpers::Platform.windows_ansi?} instead.
+  def windows_ansi?
+    unless @windows_ansi_warn
+      loc = caller_locations(1..1).first
+      warn(
+        "#{loc.path}:#{loc.lineno}: warning: method BaseHelpers##{__method__} " \
+        "is deprecated. Use Pry:Helpers::Platform.#{__method__} instead"
+      )
+      @windows_ansi_warn = true
+    end
+    Pry::Helpers::Platform.windows_ansi?
+  end
+
+  @jruby_warn = false
+  # @deprecated Use {Pry::Helpers::Platform.jruby?} instead.
+  def jruby?
+    unless @jruby_warn
+      loc = caller_locations(1..1).first
+      warn(
+        "#{loc.path}:#{loc.lineno}: warning: method BaseHelpers##{__method__} " \
+        "is deprecated. Use Pry:Helpers::Platform.#{__method__} instead"
+      )
+      @jruby_warn = true
+    end
+    Pry::Helpers::Platform.jruby?
+  end
+
+  @jruby19_warn = false
+  # @deprecated Use {Pry::Helpers::Platform.jruby_19?} instead.
+  def jruby_19?
+    unless @jruby19_warn
+      loc = caller_locations(1..1).first
+      warn(
+        "#{loc.path}:#{loc.lineno}: warning: method BaseHelpers##{__method__} " \
+        "is deprecated. Use Pry:Helpers::Platform.#{__method__} instead"
+      )
+      @jruby19_warn = true
+    end
+    Pry::Helpers::Platform.jruby_19?
+  end
+
+  @mri_warn = false
+  # @deprecated Use {Pry::Helpers::Platform.mri?} instead.
+  def mri?
+    unless @mri_warn
+      loc = caller_locations(1..1).first
+      warn(
+        "#{loc.path}:#{loc.lineno}: warning: method BaseHelpers##{__method__} " \
+        "is deprecated. Use Pry:Helpers::Platform.#{__method__} instead"
+      )
+      @mri_warn = true
+    end
+    Pry::Helpers::Platform.mri?
+  end
+
+  @mri19_warn = false
+  # @deprecated Use {Pry::Helpers::Platform.mri_19?} instead.
+  def mri_19?
+    unless @mri19_warn
+      loc = caller_locations(1..1).first
+      warn(
+        "#{loc.path}:#{loc.lineno}: warning: method BaseHelpers##{__method__} " \
+        "is deprecated. Use Pry:Helpers::Platform.#{__method__} instead"
+      )
+      @mri19_warn = true
+    end
+    Pry::Helpers::Platform.mri_19?
+  end
+
+  @mri2_warn = false
+  # @deprecated Use {Pry::Helpers::Platform.mri_2?} instead.
+  def mri_2?
+    unless @mri2_warn
+      loc = caller_locations(1..1).first
+      warn(
+        "#{loc.path}:#{loc.lineno}: warning: method BaseHelpers##{__method__} " \
+        "is deprecated. Use Pry:Helpers::Platform.#{__method__} instead"
+      )
+      @mri2_warn = true
+    end
+    Pry::Helpers::Platform.mri_2?
+  end
+
   def silence_warnings
     old_verbose = $VERBOSE
     $VERBOSE = nil
@@ -35,20 +162,21 @@ module Pry::Helpers::BaseHelpers
 
   def command_dependencies_met?(options)
     return true if !options[:requires_gem]
+
     Array(options[:requires_gem]).all? do |g|
       Pry::Rubygem.installed?(g)
     end
   end
 
   def use_ansi_codes?
-    windows_ansi? || ENV['TERM'] && ENV['TERM'] != "dumb"
+    Pry::Helpers::Platform.windows_ansi? || ENV['TERM'] && ENV['TERM'] != "dumb"
   end
 
   def colorize_code(code)
     CodeRay.scan(code, :ruby).term
   end
 
-  def highlight(string, regexp, highlight_color=:bright_yellow)
+  def highlight(string, regexp, highlight_color = :bright_yellow)
     string.gsub(regexp) { |match| "<#{highlight_color}>#{match}</#{highlight_color}>" }
   end
 
@@ -61,7 +189,7 @@ module Pry::Helpers::BaseHelpers
   # Send the given text through the best available pager (if Pry.config.pager is
   # enabled). Infers where to send the output if used as a mixin.
   # DEPRECATED.
-  def stagger_output(text, out = nil)
+  def stagger_output(text, _out = nil)
     if defined?(_pry_) && _pry_
       _pry_.pager.page text
     else
@@ -69,3 +197,4 @@ module Pry::Helpers::BaseHelpers
     end
   end
 end
+# rubocop:enable Metrics/ModuleLength

data/lib/pry/helpers/command_helpers.rb

@@ -8,7 +8,7 @@ class Pry
 
       # Open a temp file and yield it to the block, closing it after
       # @return [String] The path of the temp file
-      def temp_file(ext='.rb')
+      def temp_file(ext = '.rb')
         file = Tempfile.new(['pry', ext])
         yield file
       ensure
@@ -21,7 +21,7 @@ class Pry
         ["__binding__", "__pry__", "class_eval"].include?(m)
       end
 
-      def get_method_or_raise(name, target, opts={}, omit_help=false)
+      def get_method_or_raise(name, target, opts = {}, omit_help = false)
         meth = Pry::Method.from_str(name, target, opts)
 
         if name && !meth
@@ -44,7 +44,7 @@ class Pry
         meth
       end
 
-      def command_error(message, omit_help, klass=CommandError)
+      def command_error(message, omit_help, klass = CommandError)
         message += " Type `#{command_name} --help` for help." unless omit_help
         raise klass, message
       end
@@ -142,8 +142,9 @@ class Pry
         Range.new(a, b)
       end
 
-      def set_file_and_dir_locals(file_name, _pry_=_pry_(), target=target())
+      def set_file_and_dir_locals(file_name, _pry_ = _pry_(), target = target())
         return if !target or !file_name
+
         _pry_.last_file = File.expand_path(file_name)
         _pry_.inject_local("_file_", _pry_.last_file, target)
 

data/lib/pry/helpers/documentation_helpers.rb

@@ -13,8 +13,8 @@ class Pry
           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(/<tt>(?:\s*\n)?(.*?)\s*<\/tt>/m) { CodeRay.scan($1, :ruby).term }.
-          gsub(/\B\+(\w+?)\+\B/)  { "\e[32m#{$1}\e[0m" }.
-          gsub(/((?:^[ \t]+.+(?:\n+|\Z))+)/)  { CodeRay.scan($1, :ruby).term }.
+          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
 

data/lib/pry/helpers/options_helpers.rb

@@ -8,8 +8,8 @@ class Pry
         @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|
+        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
@@ -17,9 +17,9 @@ class Pry
       # 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')
+                            super: opts[:super],
+                            instance: opts.present?(:'instance-methods') && !opts.present?(:'methods'),
+                            methods: opts.present?(:'methods') && !opts.present?(:'instance-methods')
                            )
       end
     end

data/lib/pry/helpers/platform.rb

@@ -0,0 +1,58 @@
+class Pry
+  module Helpers
+    # Contains methods for querying the platform that Pry is running on
+    # @api public
+    # @since v0.12.0
+    # rubocop:disable Style/DoubleNegation
+    module Platform
+      # @return [Boolean]
+      def self.mac_osx?
+        !!(RbConfig::CONFIG['host_os'] =~ /\Adarwin/i)
+      end
+
+      # @return [Boolean]
+      def self.linux?
+        !!(RbConfig::CONFIG['host_os'] =~ /linux/i)
+      end
+
+      # @return [Boolean] true when Pry is running on Windows with ANSI support,
+      #   false otherwise
+      def self.windows?
+        !!(RbConfig::CONFIG['host_os'] =~ /mswin|mingw/)
+      end
+
+      # @return [Boolean]
+      def self.windows_ansi?
+        return false unless windows?
+
+        !!(defined?(Win32::Console) || ENV['ANSICON'] || mri_2?)
+      end
+
+      # @return [Boolean]
+      def self.jruby?
+        RbConfig::CONFIG['ruby_install_name'] == 'jruby'
+      end
+
+      # @return [Boolean]
+      def self.jruby_19?
+        jruby? && RbConfig::CONFIG['ruby_version'] == '1.9'
+      end
+
+      # @return [Boolean]
+      def self.mri?
+        RbConfig::CONFIG['ruby_install_name'] == 'ruby'
+      end
+
+      # @return [Boolean]
+      def self.mri_19?
+        !!(mri? && RUBY_VERSION.start_with?('1.9'))
+      end
+
+      # @return [Boolean]
+      def self.mri_2?
+        !!(mri? && RUBY_VERSION.start_with?('2'))
+      end
+    end
+    # rubocop:enable Style/DoubleNegation
+  end
+end

data/lib/pry/helpers/table.rb

@@ -1,27 +1,28 @@
 class Pry
   module Helpers
-    def self.tablify_or_one_line(heading, things)
+    def self.tablify_or_one_line(heading, things, config = Pry.config)
       plain_heading = Pry::Helpers::Text.strip_color(heading)
-      attempt = Table.new(things, :column_count => things.size)
+      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"
+        "#{heading}: \n#{tablify_to_screen_width(things, { indent: '  ' }, config)}\n"
       end
     end
 
-    def self.tablify_to_screen_width(things, options = {})
+    def self.tablify_to_screen_width(things, options, config = Pry.config)
+      options ||= {}
       things = things.compact
-      if indent = options[:indent]
+      if (indent = options[:indent])
         usable_width = Terminal.width! - indent.size
-        tablify(things, usable_width).to_s.gsub(/^/, indent)
+        tablify(things, usable_width, config).to_s.gsub(/^/, indent)
       else
-        tablify(things, Terminal.width!).to_s
+        tablify(things, Terminal.width!, config).to_s
       end
     end
 
-    def self.tablify(things, line_length)
-      table = Table.new(things, :column_count => things.size)
+    def self.tablify(things, line_length, config = Pry.config)
+      table = Table.new(things, { column_count: things.size }, config)
       table.column_count -= 1 until 1 == table.column_count or
         table.fits_on_line?(line_length)
       table
@@ -29,8 +30,9 @@ class Pry
 
     class Table
       attr_reader :items, :column_count
-      def initialize items, args = {}
+      def initialize(items, args, config = Pry.config)
         @column_count = args[:column_count]
+        @config = config
         self.items = items
       end
 
@@ -39,16 +41,17 @@ class Pry
       end
 
       def rows_to_s style = :color_on
-        widths = columns.map{|e| _max_width(e)}
+        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)
+          padded.join(@config.ls.separator)
         end
       end
 
@@ -73,6 +76,7 @@ class Pry
       end
 
       def ==(other); items == other.to_a end
+
       def to_a; items.to_a end
 
       private
@@ -93,10 +97,11 @@ class Pry
       def _recolumn
         @rows_without_colors = []
         return if items.size.zero?
-        row_count = (items.size.to_f/column_count).ceil
+
+        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]}
+          row_indices = (0...column_count).map { |e| row_count * e + i }
+          @rows_without_colors << row_indices.map { |e| @plain_items[e] }
         end
       end
 

data/lib/pry/helpers/text.rb

@@ -18,11 +18,11 @@ class Pry
 
       COLORS.each_pair do |color, value|
         define_method color do |text|
-          "\033[0;#{30+value}m#{text}\033[0m"
+          "\033[0;#{30 + value}m#{text}\033[0m"
         end
 
         define_method "bright_#{color}" do |text|
-          "\033[1;#{30+value}m#{text}\033[0m"
+          "\033[1;#{30 + value}m#{text}\033[0m"
         end
 
         COLORS.each_pair do |bg_color, bg_value|
@@ -60,7 +60,6 @@ class Pry
       def default(text)
         text.to_s
       end
-      alias_method :bright_default, :bold
 
       #
       # @yield
@@ -95,7 +94,7 @@ class Pry
       # @param  [#each_line] text
       # @param  [Fixnum] offset
       # @return [String]
-      def with_line_numbers(text, offset, color=:blue)
+      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|

data/lib/pry/helpers.rb

@@ -3,3 +3,4 @@ require "pry/helpers/options_helpers"
 require "pry/helpers/command_helpers"
 require "pry/helpers/text"
 require "pry/helpers/table"
+require "pry/helpers/platform"

data/lib/pry/history.rb

@@ -7,7 +7,7 @@ class Pry
     # @return [Fixnum] Number of lines in history when Pry first loaded.
     attr_reader :original_lines
 
-    def initialize(options={})
+    def initialize(options = {})
       @history = []
       @original_lines = 0
       @file_path = options[:file_path]
@@ -25,8 +25,8 @@ class Pry
         @pusher  = method(:push_to_readline)
         @clearer = method(:clear_readline)
       else
-        @pusher  = proc { }
-        @clearer = proc { }
+        @pusher  = proc {}
+        @clearer = proc {}
       end
     end
 
@@ -34,6 +34,8 @@ class Pry
     # @return [Integer] The number of lines loaded
     def load
       @loader.call do |line|
+        next if invalid_readline_line?(line)
+
         @pusher.call(line.chomp)
         @history << line.chomp
         @original_lines += 1
@@ -44,7 +46,9 @@ class Pry
     # @param [String] line
     # @return [String] The same line that was passed in
     def push(line)
-      unless line.empty? || (@history.last && line == @history.last)
+      empty_or_invalid_line = line.empty? || invalid_readline_line?(line)
+
+      unless empty_or_invalid_line || (@history.last && line == @history.last)
         @pusher.call(line)
         @history << line
         if !should_ignore?(line) && Pry.config.history.should_save
@@ -107,8 +111,8 @@ class Pry
       if File.exist?(path)
         File.foreach(path) { |line| yield(line) }
       end
-    rescue => error
-      warn "History file not loaded: #{error.message}"
+    rescue SystemCallError => error
+      warn "Unable to read history file: #{error.message}"
     end
 
     # The default pusher. Appends the given line to Readline::HISTORY.
@@ -132,17 +136,26 @@ class Pry
       if defined?(@history_file)
         @history_file
       else
+        unless File.exist?(history_file_path)
+          FileUtils.mkdir_p(File.dirname(history_file_path))
+        end
         @history_file = File.open(history_file_path, 'a', 0600).tap do |file|
           file.sync = true
         end
       end
-    rescue Errno::EACCES
-      warn 'History not saved; unable to open your history file for writing.'
+    rescue SystemCallError => error
+      warn "Unable to write history file: #{error.message}"
       @history_file = false
     end
 
     def history_file_path
       File.expand_path(@file_path || Pry.config.history.file)
     end
+
+    def invalid_readline_line?(line)
+      # `Readline::HISTORY << line` raises an `ArgumentError` if `line`
+      # includes a null byte
+      line.include?("\0")
+    end
   end
 end

data/lib/pry/hooks.rb

@@ -15,7 +15,7 @@ class Pry
     end
 
     # Ensure that duplicates have their @hooks object.
-    def initialize_copy(orig)
+    def initialize_copy(_orig)
       hooks_dup = @hooks.dup
       @hooks.each do |k, v|
         hooks_dup[k] = v.dup
@@ -32,7 +32,7 @@ class Pry
     #
     # @param [Pry::Hooks] other The `Pry::Hooks` instance to merge
     # @return [Pry:Hooks] The receiver.
-    # @see {#merge}
+    # @see #merge
     def merge!(other)
       @hooks.merge!(other.dup.hooks) do |key, array, other_array|
         temp_hash, output = {}, []
@@ -65,7 +65,7 @@ class Pry
     # @param [#call] callable The callable.
     # @yield The block to use as the callable (if no `callable` provided).
     # @return [Pry:Hooks] The receiver.
-    def add_hook(event_name, hook_name, callable=nil, &block)
+    def add_hook(event_name, hook_name, callable = nil, &block)
       event_name = event_name.to_s
 
       # do not allow duplicates, but allow multiple `nil` hooks

data/lib/pry/indent.rb

@@ -143,10 +143,9 @@ class Pry
       prefix = indent_level
 
       input.lines.each do |line|
-
         if in_string?
           tokens = tokenize("#{open_delimiters_line}\n#{line}")
-          tokens = tokens.drop_while{ |token, type| !(String === token && token.include?("\n")) }
+          tokens = tokens.drop_while { |token, type| !(String === token && token.include?("\n")) }
           previously_in_string = true
         else
           tokens = tokenize(line)
@@ -155,7 +154,7 @@ class Pry
 
         before, after = indentation_delta(tokens)
 
-        before.times{ prefix.sub! SPACES, '' }
+        before.times { prefix.sub! SPACES, '' }
         new_prefix = prefix + SPACES * after
 
         line = prefix + line.lstrip unless previously_in_string
@@ -215,7 +214,7 @@ class Pry
       # If the list of tokens contains a matching closing token the line should
       # not be indented (and thus we should return true).
       tokens.each do |token, kind|
-        is_singleline_if  = (SINGLELINE_TOKENS.include?(token)) && end_of_statement?(last_token, last_kind)
+        is_singleline_if = (SINGLELINE_TOKENS.include?(token)) && end_of_statement?(last_token, last_kind)
         is_optional_do = (token == "do" && seen_for_at.include?(add_after - 1))
 
         last_token, last_kind = token, kind unless kind == :space
@@ -358,7 +357,7 @@ class Pry
     #
     # @param [String] token  a token from Coderay
     # @param [Symbol] kind  the kind of that token
-    def track_module_nesting_end(token, kind=:keyword)
+    def track_module_nesting_end(token, kind = :keyword)
       if kind == :keyword && (token == "class" || token == "module")
         @module_nesting.pop
       end
@@ -382,25 +381,24 @@ class Pry
     # the correct indentation. Mostly useful for fixing 'end'.
     #
     # @param [String] prompt The user's prompt
-    # @param [String] code   The code the user just typed in.
-    # @param [Fixnum] overhang (0) The number of chars to erase afterwards (i.e.,
-    #   the difference in length between the old line and the new one).
-    # @return [String]
-    def correct_indentation(prompt, code, overhang=0)
+    # @param [String] code The code the user just typed in
+    # @param [Integer] overhang The number of characters to erase afterwards (the
+    #   the difference in length between the old line and the new one)
+    #
+    # @return [String] correctly indented line
+    def correct_indentation(prompt, code, overhang = 0)
       prompt = prompt.delete("\001\002")
       line_to_measure = Pry::Helpers::Text.strip_color(prompt) << code
       whitespace = ' ' * overhang
 
-      _, cols = Terminal.screen_size
-
-      cols = cols.to_i
-      lines = (cols != 0 ? (line_to_measure.length / cols + 1) : 1).to_i
+      cols = Terminal.width!
+      lines = cols == 0 ? 1 : (line_to_measure.length / cols + 1).to_i
 
-      if Pry::Helpers::BaseHelpers.windows_ansi?
-        move_up   = "\e[#{lines}F"
+      if Helpers::Platform.windows_ansi?
+        move_up = "\e[#{lines}F"
         move_down = "\e[#{lines}E"
       else
-        move_up   = "\e[#{lines}A\e[0G"
+        move_up = "\e[#{lines}A\e[0G"
         move_down = "\e[#{lines}B\e[0G"
       end