pry 0.10.3 → 0.12.2

data/lib/pry/helpers/base_helpers.rb

@@ -1,113 +1,200 @@
-class Pry
-  module Helpers
-
-    module BaseHelpers
-
-      module_function
-
-      def silence_warnings
-        old_verbose = $VERBOSE
-        $VERBOSE = nil
-        begin
-          yield
-        ensure
-          $VERBOSE = old_verbose
-        end
-      end
-
-      # Acts like send but ignores any methods defined below Object or Class in the
-      # inheritance hierarchy.
-      # This is required to introspect methods on objects like Net::HTTP::Get that
-      # have overridden the `method` method.
-      def safe_send(obj, method, *args, &block)
-        (Module === obj ? Module : Object).instance_method(method).bind(obj).call(*args, &block)
-      end
-      public :safe_send
-
-      def find_command(name, set = Pry::Commands)
-        command_match = set.find do |_, command|
-          (listing = command.options[:listing]) == name && listing != nil
-        end
-        command_match.last if command_match
-      end
-
-      def not_a_real_file?(file)
-        file =~ /(\(.*\))|<.*>/ || file =~ /__unknown__/ || file == "" || file == "-e"
-      end
-
-      def command_dependencies_met?(options)
-        return true if !options[:requires_gem]
-        Array(options[:requires_gem]).all? do |g|
-          Rubygem.installed?(g)
-        end
-      end
-
-      def use_ansi_codes?
-        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)
-        string.gsub(regexp) { |match| "<#{highlight_color}>#{match}</#{highlight_color}>" }
-      end
-
-      # formatting
-      def heading(text)
-        text = "#{text}\n--"
-        "\e[1m#{text}\e[0m"
-      end
-
-      # have fun on the Windows platform.
-      def windows?
-        RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
-      end
-
-      # are we able to use ansi on windows?
-      def windows_ansi?
-        defined?(Win32::Console) || ENV['ANSICON'] || (windows? && mri_2?)
-      end
-
-      def jruby?
-        RbConfig::CONFIG['ruby_install_name'] == 'jruby'
-      end
-
-      def jruby_19?
-        jruby? && RbConfig::CONFIG['ruby_version'] == '1.9'
-      end
-
-      def rbx?
-        RbConfig::CONFIG['ruby_install_name'] == 'rbx'
-      end
-
-      def mri?
-        RbConfig::CONFIG['ruby_install_name'] == 'ruby'
-      end
-
-      def mri_19?
-        mri? && RUBY_VERSION =~ /^1\.9/
-      end
-
-      def mri_2?
-        mri? && RUBY_VERSION =~ /^2/
-      end
-
-      def mri_20?
-        mri? && RUBY_VERSION =~ /^2\.0/
-      end
-
-      def mri_21?
-        mri? && RUBY_VERSION =~ /^2\.1/
-      end
-
-      # 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)
-        Pry.new.pager.page text
-      end
+module Pry::Helpers; end
+
+# rubocop:disable Metrics/ModuleLength
+module Pry::Helpers::BaseHelpers
+  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
+    begin
+      yield
+    ensure
+      $VERBOSE = old_verbose
+    end
+  end
+
+  # Acts like send but ignores any methods defined below Object or Class in the
+  # inheritance hierarchy.
+  # This is required to introspect methods on objects like Net::HTTP::Get that
+  # have overridden the `method` method.
+  def safe_send(obj, method, *args, &block)
+    (Module === obj ? Module : Object).instance_method(method).bind(obj).call(*args, &block)
+  end
+  public :safe_send
+
+  def find_command(name, set = Pry::Commands)
+    command_match = set.find do |_, command|
+      (listing = command.options[:listing]) == name && listing != nil
+    end
+    command_match.last if command_match
+  end
+
+  def not_a_real_file?(file)
+    file =~ /^(\(.*\))$|^<.*>$/ || file =~ /__unknown__/ || file == "" || file == "-e"
+  end
+
+  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?
+    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)
+    string.gsub(regexp) { |match| "<#{highlight_color}>#{match}</#{highlight_color}>" }
+  end
+
+  # formatting
+  def heading(text)
+    text = "#{text}\n--"
+    "\e[1m#{text}\e[0m"
+  end
+
+  # 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)
+    if defined?(_pry_) && _pry_
+      _pry_.pager.page text
+    else
+      Pry.new.pager.page text
     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

@@ -12,8 +12,9 @@ class Pry
         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(/<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(/`(?:\s*\n)?([^\e]*?)\s*`/) { "`#{CodeRay.scan($1, :ruby).term}`" }
       end
 

data/lib/pry/helpers/options_helpers.rb

@@ -3,13 +3,13 @@ class Pry
     module OptionsHelpers
       module_function
 
-      # Add method options to the Slop instance
+      # Add method options to the Pry::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|
+        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