pry 0.10.4 → 0.12.2

data/lib/pry/pager.rb

@@ -3,237 +3,248 @@ require 'pry/terminal'
 # A pager is an `IO`-like object that accepts text and either prints it
 # immediately, prints it one page at a time, or streams it to an external
 # program to print one page at a time.
-class Pry::Pager
-  class StopPaging < StandardError
-  end
-
-  attr_reader :_pry_
-
-  def initialize(_pry_)
-    @_pry_ = _pry_
-  end
-
-  # Send the given text through the best available pager (if `Pry.config.pager` is
-  # enabled).
-  # If you want to send text through in chunks as you generate it, use `open` to
-  # get a writable object instead.
-  # @param [String] text A piece of text to run through a pager.
-  # @param [IO] output (`$stdout`) An object to send output to.
-  def page(text)
-    open do |pager|
-      pager << text
+class Pry
+  class Pager
+    class StopPaging < StandardError
     end
-  end
 
-  # Yields a pager object (`NullPager`, `SimplePager`, or `SystemPager`).  All
-  # pagers accept output with `#puts`, `#print`, `#write`, and `#<<`.
-  # @param [IO] output (`$stdout`) An object to send output to.
-  def open
-    pager = best_available
-    yield pager
-  rescue StopPaging
-  ensure
-    pager.close if pager
-  end
+    attr_reader :_pry_
 
-  private
-
-  def enabled?; !!@enabled; end
-
-  def output; @output; end
-
-  # Return an instance of the "best" available pager class -- `SystemPager` if
-  # possible, `SimplePager` if `SystemPager` isn't available, and `NullPager`
-  # if the user has disabled paging. All pagers accept output with `#puts`,
-  # `#print`, `#write`, and `#<<`. You must call `#close` when you're done
-  # writing output to a pager, and you must rescue `Pry::Pager::StopPaging`.
-  # These requirements can be avoided by using `.open` instead.
-  # @param [#<<] output ($stdout) An object to send output to.
-  def best_available
-    if !_pry_.config.pager
-      NullPager.new(_pry_.output)
-    elsif !SystemPager.available? || Pry::Helpers::BaseHelpers.jruby?
-      SimplePager.new(_pry_.output)
-    else
-      SystemPager.new(_pry_.output)
+    def initialize(_pry_)
+      @_pry_ = _pry_
     end
-  end
 
-  # `NullPager` is a "pager" that actually just prints all output as it comes
-  # in. Used when `Pry.config.pager` is false.
-  class NullPager
-    def initialize(out)
-      @out = out
-    end
-
-    def puts(str)
-      print "#{str.chomp}\n"
+    # Send the given text through the best available pager (if
+    # `Pry.config.pager` is enabled). If you want to send text through in
+    # chunks as you generate it, use `open` to get a writable object
+    # instead.
+    #
+    # @param [String] text
+    #   Text to run through a pager.
+    #
+    def page(text)
+      open do |pager|
+        pager << text
+      end
     end
 
-    def print(str)
-      write str
+    # Yields a pager object (`NullPager`, `SimplePager`, or `SystemPager`).
+    # All pagers accept output with `#puts`, `#print`, `#write`, and `#<<`.
+    def open
+      pager = best_available
+      yield pager
+    rescue StopPaging
+    ensure
+      pager.close if pager
     end
-    alias << print
 
-    def write(str)
-      @out.write str
-    end
+    private
 
-    def close
+    def enabled?; !!@enabled; end
+
+    def output; @output; end
+
+    # Return an instance of the "best" available pager class --
+    # `SystemPager` if possible, `SimplePager` if `SystemPager` isn't
+    # available, and `NullPager` if the user has disabled paging. All
+    # pagers accept output with `#puts`, `#print`, `#write`, and `#<<`. You
+    # must call `#close` when you're done writing output to a pager, and
+    # you must rescue `Pry::Pager::StopPaging`. These requirements can be
+    # avoided by using `.open` instead.
+    def best_available
+      if !_pry_.config.pager
+        NullPager.new(_pry_.output)
+      elsif !SystemPager.available? || Helpers::Platform.jruby?
+        SimplePager.new(_pry_.output)
+      else
+        SystemPager.new(_pry_.output)
+      end
     end
 
-    private
+    # `NullPager` is a "pager" that actually just prints all output as it
+    # comes in. Used when `Pry.config.pager` is false.
+    class NullPager
+      def initialize(out)
+        @out = out
+      end
 
-    def height
-      @height ||= Pry::Terminal.height!
-    end
+      def puts(str)
+        print "#{str.chomp}\n"
+      end
 
-    def width
-      @width ||= Pry::Terminal.width!
-    end
-  end
+      def print(str)
+        write str
+      end
+      alias << print
 
-  # `SimplePager` is a straightforward pure-Ruby pager. We use it on JRuby and
-  # when we can't find a usable external pager.
-  class SimplePager < NullPager
-    def initialize(*)
-      super
-      @tracker = PageTracker.new(height - 3, width)
-    end
+      def write(str)
+        @out.write str
+      end
 
-    def write(str)
-      str.lines.each do |line|
-        @out.print line
-        @tracker.record line
-
-        if @tracker.page?
-          @out.print "\n"
-          @out.print "\e[0m"
-          @out.print "<page break> --- Press enter to continue " \
-                     "( q<enter> to break ) --- <page break>\n"
-          raise StopPaging if Readline.readline("").chomp == "q"
-          @tracker.reset
-        end
+      def close
       end
-    end
-  end
 
-  # `SystemPager` buffers output until we're pretty sure it's at least a page
-  # long, then invokes an external pager and starts streaming output to it. If
-  # `#close` is called before then, it just prints out the buffered content.
-  class SystemPager < NullPager
-    def self.default_pager
-      pager = ENV["PAGER"] || ""
+      private
 
-      # Default to less, and make sure less is being passed the correct options
-      if pager.strip.empty? or pager =~ /^less\b/
-        pager = "less -R -F -X"
+      def height
+        @height ||= Pry::Terminal.height!
       end
 
-      pager
+      def width
+        @width ||= Pry::Terminal.width!
+      end
     end
 
-    @system_pager = nil
+    # `SimplePager` is a straightforward pure-Ruby pager. We use it on
+    # JRuby and when we can't find a usable external pager.
+    class SimplePager < NullPager
+      def initialize(*)
+        super
+        @tracker = PageTracker.new(height - 3, width)
+      end
+
+      def write(str)
+        str.lines.each do |line|
+          @out.print line
+          @tracker.record line
 
-    def self.available?
-      if @system_pager.nil?
-        @system_pager = begin
-          pager_executable = default_pager.split(' ').first
-          `which #{pager_executable}`
-          $?.success?
-        rescue
-          false
+          if @tracker.page?
+            @out.print "\n"
+            @out.print "\e[0m"
+            @out.print "<page break> --- Press enter to continue " \
+                       "( q<enter> to break ) --- <page break>\n"
+            raise StopPaging if Readline.readline("").chomp == "q"
+
+            @tracker.reset
+          end
         end
-      else
-        @system_pager
       end
     end
 
-    def initialize(*)
-      super
-      @tracker = PageTracker.new(height, width)
-      @buffer  = ""
-      @pager   = nil
-    end
+    # `SystemPager` buffers output until we're pretty sure it's at least a
+    # page long, then invokes an external pager and starts streaming output
+    # to it. If `#close` is called before then, it just prints out the
+    # buffered content.
+    class SystemPager < NullPager
+      def self.default_pager
+        pager = ENV["PAGER"] || ""
 
-    def write(str)
-      if invoked_pager?
-        write_to_pager str
-      else
-        @tracker.record str
-        @buffer << str
+        # Default to less, and make sure less is being passed the correct
+        # options
+        if pager.strip.empty? or pager =~ /^less\b/
+          pager = "less -R -F -X"
+        end
+
+        pager
+      end
 
-        if @tracker.page?
-          write_to_pager @buffer
+      @system_pager = nil
+
+      def self.available?
+        if @system_pager.nil?
+          @system_pager = begin
+            pager_executable = default_pager.split(' ').first
+            if Helpers::Platform.windows? || Helpers::Platform.windows_ansi?
+              `where /Q #{pager_executable}`
+            else
+              `which #{pager_executable}`
+            end
+            $?.success?
+          rescue
+            false
+          end
+        else
+          @system_pager
         end
       end
-    rescue Errno::EPIPE
-      raise StopPaging
-    end
 
-    def close
-      if invoked_pager?
-        pager.close
-      else
-        @out.puts @buffer
+      def initialize(*)
+        super
+        @tracker = PageTracker.new(height, width)
+        @buffer  = ""
+        @pager   = nil
       end
-    end
 
-    private
+      def write(str)
+        if invoked_pager?
+          write_to_pager str
+        else
+          @tracker.record str
+          @buffer << str
 
-    def write_to_pager(text)
-      pager.write @out.decolorize_maybe(text)
-    end
+          if @tracker.page?
+            write_to_pager @buffer
+          end
+        end
+      rescue Errno::EPIPE
+        raise StopPaging
+      end
 
-    def invoked_pager?
-      @pager
-    end
+      def close
+        if invoked_pager?
+          pager.close
+        else
+          @out.puts @buffer
+        end
+      end
 
-    def pager
-      @pager ||= IO.popen(self.class.default_pager, 'w')
-    end
-  end
+      private
+
+      def write_to_pager(text)
+        pager.write @out.decolorize_maybe(text)
+      end
+
+      def invoked_pager?
+        @pager
+      end
 
-  # `PageTracker` tracks output to determine whether it's likely to take up a
-  # whole page. This doesn't need to be super precise, but we can use it for
-  # `SimplePager` and to avoid invoking the system pager unnecessarily.
-  #
-  # One simplifying assumption is that we don't need `#page?` to return `true`
-  # on the basis of an incomplete line. Long lines should be counted as
-  # multiple lines, but we don't have to transition from `false` to `true`
-  # until we see a newline.
-  class PageTracker
-    def initialize(rows, cols)
-      @rows, @cols = rows, cols
-      reset
+      def pager
+        @pager ||= IO.popen(self.class.default_pager, 'w')
+      end
     end
 
-    def record(str)
-      str.lines.each do |line|
-        if line.end_with? "\n"
-          @row += ((@col + line_length(line) - 1) / @cols) + 1
-          @col  = 0
-        else
-          @col += line_length(line)
+    # `PageTracker` tracks output to determine whether it's likely to take
+    # up a whole page. This doesn't need to be super precise, but we can
+    # use it for `SimplePager` and to avoid invoking the system pager
+    # unnecessarily.
+    #
+    # One simplifying assumption is that we don't need `#page?` to return
+    # `true` on the basis of an incomplete line. Long lines should be
+    # counted as multiple lines, but we don't have to transition from
+    # `false` to `true` until we see a newline.
+    class PageTracker
+      def initialize(rows, cols)
+        @rows, @cols = rows, cols
+        reset
+      end
+
+      def record(str)
+        str.lines.each do |line|
+          if line.end_with? "\n"
+            @row += ((@col + line_length(line) - 1) / @cols) + 1
+            @col  = 0
+          else
+            @col += line_length(line)
+          end
         end
       end
-    end
 
-    def page?
-      @row >= @rows
-    end
+      def page?
+        @row >= @rows
+      end
 
-    def reset
-      @row = 0
-      @col = 0
-    end
+      def reset
+        @row = 0
+        @col = 0
+      end
 
-    private
+      private
 
-    # Approximation of the printable length of a given line, without the
-    # newline and without ANSI color codes.
-    def line_length(line)
-      line.chomp.gsub(/\e\[[\d;]*m/, '').length
+      # Approximation of the printable length of a given line, without the
+      # newline and without ANSI color codes.
+      def line_length(line)
+        line.chomp.gsub(/\e\[[\d;]*m/, '').length
+      end
     end
   end
 end

data/lib/pry/platform.rb

@@ -0,0 +1,91 @@
+class Pry
+  module Platform
+    extend self
+
+    #
+    # @return [Boolean]
+    #  Returns true if Pry is running on Mac OSX.
+    #
+    # @note
+    #   Queries RbConfig::CONFIG['host_os'] with a best guess.
+    #
+    def mac_osx?
+      !!(RbConfig::CONFIG['host_os'] =~ /\Adarwin/i)
+    end
+
+    #
+    # @return [Boolean]
+    #   Returns true if Pry is running on Linux.
+    #
+    # @note
+    #   Queries RbConfig::CONFIG['host_os'] with a best guess.
+    #
+    def linux?
+      !!(RbConfig::CONFIG['host_os'] =~ /linux/i)
+    end
+
+    #
+    # @return [Boolean]
+    #   Returns true if Pry is running on Windows.
+    #
+    # @note
+    #   Queries RbConfig::CONFIG['host_os'] with a best guess.
+    #
+    def windows?
+      !!(RbConfig::CONFIG['host_os'] =~ /mswin|mingw/)
+    end
+
+    #
+    # @return [Boolean]
+    #   Returns true when Pry is running on Windows with ANSI support.
+    #
+    def windows_ansi?
+      return false if not windows?
+
+      !!(defined?(Win32::Console) or ENV['ANSICON'] or mri_2?)
+    end
+
+    #
+    # @return [Boolean]
+    #   Returns true when Pry is being run from JRuby.
+    #
+    def jruby?
+      RbConfig::CONFIG['ruby_install_name'] == 'jruby'
+    end
+
+    #
+    # @return [Boolean]
+    #   Returns true when Pry is being run from JRuby in 1.9 mode.
+    #
+    def jruby_19?
+      jruby? and RbConfig::CONFIG['ruby_version'] == '1.9'
+    end
+
+    #
+    # @return [Boolean]
+    #   Returns true when Pry is being run from MRI (CRuby).
+    #
+    def mri?
+      RbConfig::CONFIG['ruby_install_name'] == 'ruby'
+    end
+
+    #
+    # @return [Boolean]
+    #   Returns true when Pry is being run from MRI v1.9+ (CRuby).
+    #
+    def mri_19?
+      !!(mri? and RUBY_VERSION =~ /\A1\.9/)
+    end
+
+    #
+    # @return [Boolean]
+    #   Returns true when Pry is being run from MRI v2+ (CRuby).
+    #
+    def mri_2?
+      !!(mri? and RUBY_VERSION =~ /\A2/)
+    end
+  end
+
+  # Not supported on MRI 2.2 and lower.
+  deprecate_constant(:Platform) if respond_to?(:deprecate_constant)
+end

data/lib/pry/plugins.rb

@@ -8,7 +8,7 @@ class Pry
         @name = name
       end
 
-      def method_missing(*args)
+      def method_missing(*_args)
         warn "Warning: The plugin '#{@name}' was not found! (no gem found)"
       end
     end
@@ -35,8 +35,12 @@ class Pry
       # Load the Command line options defined by this plugin (if they exist)
       def load_cli_options
         cli_options_file = File.join(spec.full_gem_path, "lib/#{spec.name}/cli.rb")
-        require cli_options_file if File.exist?(cli_options_file)
+        return unless File.exist?(cli_options_file)
+
+        cli_options_file = File.realpath(cli_options_file) if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.4.4")
+        require cli_options_file
       end
+
       # Activate the plugin (require the gem - enables/loads the
       # plugin immediately at point of call, even if plugin is
       # disabled)
@@ -60,6 +64,16 @@ class Pry
 
       alias active? active
       alias enabled? enabled
+
+      def supported?
+        pry_version = Gem::Version.new(VERSION)
+        spec.dependencies.each do |dependency|
+          if dependency.name == "pry"
+            return dependency.requirement.satisfied_by?(pry_version)
+          end
+        end
+        true
+      end
     end
 
     def initialize
@@ -68,11 +82,12 @@ class Pry
 
     # Find all installed Pry plugins and store them in an internal array.
     def locate_plugins
-      Gem.refresh
-      (Gem::Specification.respond_to?(:each) ? Gem::Specification : Gem.source_index.find_name('')).each do |gem|
+      gem_list.each do |gem|
         next if gem.name !~ PRY_PLUGIN_PREFIX
+
         plugin_name = gem.name.split('-', 2).last
-        @plugins << Plugin.new(plugin_name, gem.name, gem, true) if !gem_located?(gem.name)
+        plugin = Plugin.new(plugin_name, gem.name, gem, false)
+        @plugins << plugin.tap(&:enable!) if plugin.supported? && !plugin_located?(plugin)
       end
       @plugins
     end
@@ -95,9 +110,13 @@ class Pry
     end
 
     private
-    def gem_located?(gem_name)
-      @plugins.any? { |plugin| plugin.gem_name == gem_name }
+    def plugin_located?(plugin)
+      @plugins.any? { |existing| existing.gem_name == plugin.gem_name }
     end
-  end
 
+    def gem_list
+      Gem.refresh
+      Gem::Specification.respond_to?(:each) ? Gem::Specification : Gem.source_index.find_name('')
+    end
+  end
 end