pry 0.10.3 → 0.12.2

data/lib/pry/config/default.rb

@@ -1,161 +1,159 @@
-class Pry::Config::Default
-  include Pry::Config::Behavior
+class Pry
+  class Config < Pry::BasicObject
+    class Default
+      include Config::Behavior
+      include Config::Memoization
 
-  default = {
-    input: proc {
-      lazy_readline
-    },
-    output: proc {
-      $stdout
-    },
-    commands: proc {
-      Pry::Commands
-    },
-    prompt_name: proc {
-      Pry::DEFAULT_PROMPT_NAME
-    },
-    prompt: proc {
-      Pry::DEFAULT_PROMPT
-    },
-    prompt_safe_objects: proc {
-      Pry::DEFAULT_PROMPT_SAFE_OBJECTS
-    },
-    print: proc {
-      Pry::DEFAULT_PRINT
-    },
-    quiet: proc {
-      false
-    },
-    exception_handler: proc {
-      Pry::DEFAULT_EXCEPTION_HANDLER
-    },
-    exception_whitelist: proc {
-      Pry::DEFAULT_EXCEPTION_WHITELIST
-    },
-    hooks: proc {
-      Pry::DEFAULT_HOOKS
-    },
-    pager: proc {
-      true
-    },
-    system: proc {
-      Pry::DEFAULT_SYSTEM
-    },
-    color: proc {
-      Pry::Helpers::BaseHelpers.use_ansi_codes?
-    },
-    default_window_size: proc {
-      5
-    },
-    editor: proc {
-      Pry.default_editor_for_platform
-    }, # TODO: Pry::Platform.editor
-    should_load_rc: proc {
-      true
-    },
-    should_load_local_rc: proc {
-      true
-    },
-    should_trap_interrupts: proc {
-      Pry::Helpers::BaseHelpers.jruby?
-    }, # TODO: Pry::Platform.jruby?
-    disable_auto_reload: proc {
-      false
-    },
-    command_prefix: proc {
-      ""
-    },
-    auto_indent: proc {
-      Pry::Helpers::BaseHelpers.use_ansi_codes?
-    },
-    correct_indent: proc {
-      true
-    },
-    collision_warning: proc {
-      false
-    },
-    output_prefix: proc {
-      "=> "
-    },
-    requires: proc {
-      []
-    },
-    should_load_requires: proc {
-      true
-    },
-    should_load_plugins: proc {
-      true
-    },
-    windows_console_warning: proc {
-      true
-    },
-    control_d_handler: proc {
-      Pry::DEFAULT_CONTROL_D_HANDLER
-    },
-    memory_size: proc {
-      100
-    },
-    extra_sticky_locals: proc {
-      {}
-    },
-    command_completions: proc {
-      proc { commands.keys }
-    },
-    file_completions: proc {
-      proc { Dir["."] }
-    },
-    ls: proc {
-      Pry::Config.from_hash(Pry::Command::Ls::DEFAULT_OPTIONS)
-    },
-    completer: proc {
-      require "pry/input_completer"
-      Pry::InputCompleter
-    }
-  }
+      def_memoized({
+        input: proc {
+          lazy_readline
+        },
+        output: proc {
+          $stdout.tap { |out| out.sync = true }
+        },
+        commands: proc {
+          Pry::Commands
+        },
+        prompt_name: proc {
+          Pry::Prompt::DEFAULT_NAME
+        },
+        prompt: proc {
+          Pry::Prompt[:default][:value]
+        },
+        prompt_safe_contexts: proc {
+          Pry::Prompt::SAFE_CONTEXTS
+        },
+        print: proc {
+          Pry::DEFAULT_PRINT
+        },
+        quiet: proc {
+          false
+        },
+        exception_handler: proc {
+          Pry::DEFAULT_EXCEPTION_HANDLER
+        },
+        exception_whitelist: proc {
+          Pry::DEFAULT_EXCEPTION_WHITELIST
+        },
+        hooks: proc {
+          Pry::DEFAULT_HOOKS
+        },
+        pager: proc {
+          true
+        },
+        system: proc {
+          Pry::DEFAULT_SYSTEM
+        },
+        color: proc {
+          Pry::Helpers::BaseHelpers.use_ansi_codes?
+        },
+        default_window_size: proc {
+          5
+        },
+        editor: proc {
+          Pry.default_editor_for_platform
+        },
+        should_load_rc: proc {
+          true
+        },
+        should_load_local_rc: proc {
+          true
+        },
+        should_trap_interrupts: proc {
+          Pry::Helpers::Platform.jruby?
+        },
+        disable_auto_reload: proc {
+          false
+        },
+        command_prefix: proc {
+          ""
+        },
+        auto_indent: proc {
+          Pry::Helpers::BaseHelpers.use_ansi_codes?
+        },
+        correct_indent: proc {
+          true
+        },
+        collision_warning: proc {
+          false
+        },
+        output_prefix: proc {
+          "=> "
+        },
+        requires: proc {
+          []
+        },
+        should_load_requires: proc {
+          true
+        },
+        should_load_plugins: proc {
+          true
+        },
+        windows_console_warning: proc {
+          true
+        },
+        control_d_handler: proc {
+          Pry::DEFAULT_CONTROL_D_HANDLER
+        },
+        memory_size: proc {
+          100
+        },
+        extra_sticky_locals: proc {
+          {}
+        },
+        command_completions: proc {
+          proc { commands.keys }
+        },
+        file_completions: proc {
+          proc { Dir["."] }
+        },
+        ls: proc {
+          Pry::Config.from_hash(Pry::Command::Ls::DEFAULT_OPTIONS)
+        },
+        completer: proc {
+          require "pry/input_completer"
+          Pry::InputCompleter
+        },
+        gist: proc {
+          Pry::Config.from_hash({inspecter: proc(&:pretty_inspect)}, nil)
+        },
+        history: proc {
+          Pry::Config.from_hash({should_save: true, should_load: true}, nil).tap do |history|
+            history_file =
+              if File.exist?(File.expand_path('~/.pry_history'))
+                '~/.pry_history'
+              elsif ENV.key?('XDG_DATA_HOME') && ENV['XDG_DATA_HOME'] != ''
+                # See XDG Base Directory Specification at
+                # https://standards.freedesktop.org/basedir-spec/basedir-spec-0.8.html
+                ENV['XDG_DATA_HOME'] + '/pry/pry_history'
+              else
+                '~/.local/share/pry/pry_history'
+              end
+            history.file = File.expand_path(history_file)
+          end
+        },
+        exec_string: proc {
+          ""
+        }
+      })
 
-  def initialize
-    super(nil)
-    configure_gist
-    configure_history
-  end
-
-  default.each do |key, value|
-    define_method(key) do
-      if default[key].equal?(value)
-        default[key] = instance_eval(&value)
+      def initialize
+        super(nil)
       end
-      default[key]
-    end
-  end
 
-private
-  # TODO:
-  # all of this configure_* stuff is a relic of old code.
-  # we should try move this code to being command-local.
-  def configure_gist
-    self["gist"] = Pry::Config.from_hash(inspecter: proc(&:pretty_inspect))
-  end
+      private
 
-  def configure_history
-    self["history"] = Pry::Config.from_hash "should_save" => true,
-      "should_load" => true
-    history.file = File.expand_path("~/.pry_history") rescue nil
-    if history.file.nil?
-      self.should_load_rc = false
-      history.should_save = false
-      history.should_load = false
+      def lazy_readline
+        require 'readline'
+        Readline
+      rescue LoadError
+        warn "Sorry, you can't use Pry without Readline or a compatible library."
+        warn "Possible solutions:"
+        warn " * Rebuild Ruby with Readline support using `--with-readline`"
+        warn " * Use the rb-readline gem, which is a pure-Ruby port of Readline"
+        warn " * Use the pry-coolline gem, a pure-ruby alternative to Readline"
+        raise
+      end
     end
   end
-
-  def lazy_readline
-    require 'readline'
-    Readline
-  rescue LoadError
-    warn "Sorry, you can't use Pry without Readline or a compatible library."
-    warn "Possible solutions:"
-    warn " * Rebuild Ruby with Readline support using `--with-readline`"
-    warn " * Use the rb-readline gem, which is a pure-Ruby port of Readline"
-    warn " * Use the pry-coolline gem, a pure-ruby alternative to Readline"
-    raise
-  end
 end

data/lib/pry/config/memoization.rb

@@ -0,0 +1,48 @@
+class Pry
+  class Config < Pry::BasicObject
+    module Memoization
+      MEMOIZED_METHODS = Hash.new { |h,k| h[k] = [] }
+
+      module ClassMethods
+        #
+        # Defines one or more methods who return a constant value after being
+        # called once.
+        #
+        # @example
+        #   class Foo
+        #     include Pry::Config::Memoization
+        #     def_memoized({
+        #       foo: proc {1+10},
+        #       bar: proc{"aaa"<<"a"}
+        #     })
+        #   end
+        #
+        # @param [{String => Proc}] method_table
+        #
+        # @return [void]
+        #
+        def def_memoized(method_table)
+          method_table.each do |method_name, method|
+            define_method(method_name) do
+              method_table[method_name] = instance_eval(&method) if method_table[method_name].equal? method
+              method_table[method_name]
+            end
+          end
+          MEMOIZED_METHODS[self] |= method_table.keys
+        end
+      end
+
+      def self.included(mod)
+        mod.extend(ClassMethods)
+      end
+
+      #
+      # @return [Array<Symbol>]
+      #   Returns the names of methods that have been defined by {ClassMethods#def_memoized}.
+      #
+      def memoized_methods
+        MEMOIZED_METHODS[self.class]
+      end
+    end
+  end
+end

data/lib/pry/config.rb

@@ -1,24 +1,35 @@
-class Pry::Config
-  require_relative 'config/behavior'
-  require_relative 'config/default'
-  require_relative 'config/convenience'
-  include Pry::Config::Behavior
+class Pry
+  # The Pry config.
+  # @api public
+  class Config < Pry::BasicObject
+    # Wraps a block so it can have a name.
+    #
+    # @example
+    #   proc1 = proc {}
+    #   proc2 = Pry::Config::Lazy.new(&proc {})
+    #
+    #   proc1.is_a?(Pry::Config::Lazy)
+    #   #=> false
+    #   proc2.is_a?(Pry::Config::Lazy)
+    #   #=> true
+    #
+    # @api private
+    # @since v0.12.0
+    class Lazy
+      def initialize(&block)
+        @block = block
+      end
 
-  def self.shortcuts
-    Convenience::SHORTCUTS
-  end
+      # @return [Object]
+      def call
+        @block.call
+      end
+    end
+
+    include Behavior
 
-  #
-  # FIXME
-  # @param [Pry::Hooks] hooks
-  #
-  def hooks=(hooks)
-    if hooks.is_a?(Hash)
-      warn "Hash-based hooks are now deprecated! Use a `Pry::Hooks` object " \
-           "instead! http://rubydoc.info/github/pry/pry/master/Pry/Hooks"
-      self["hooks"] = Pry::Hooks.from_hash(hooks)
-    else
-      self["hooks"] = hooks
+    def self.shortcuts
+      Convenience::SHORTCUTS
     end
   end
 end

data/lib/pry/core_extensions.rb

@@ -38,7 +38,7 @@ class Object
   #   end
   #   my_method()
   # @see Pry.start
-  def pry(object=nil, hash={})
+  def pry(object = nil, hash = {})
     if object.nil? || Hash === object
       Pry.start(self, object || {})
     else
@@ -68,15 +68,26 @@ class Object
   def __binding__
     # If you ever feel like changing this method, be careful about variables
     # that you use. They shouldn't be inserted into the binding that will
-    # eventually be returning.
+    # eventually be returned.
 
     # When you're cd'd into a class, methods you define should be added to it.
     if is_a?(Module)
+      # A special case, for JRuby.
+      # Module.new.class_eval("binding") has different behaviour than CRuby,
+      # where this is not needed: class_eval("binding") vs class_eval{binding}.
+      # Using a block works around the difference of behaviour on JRuby.
+      # The scope is clear of local variabless. Don't add any.
+      #
+      # This fixes the following two spec failures, at https://travis-ci.org/pry/pry/jobs/274470002
+      # 1) ./spec/pry_spec.rb:360:in `block in (root)'
+      # 2) ./spec/pry_spec.rb:366:in `block in (root)'
+      return class_eval { binding } if Pry::Helpers::Platform.jruby? and self.name == nil
+
       # class_eval sets both self and the default definee to this class.
-      return class_eval "binding"
+      return class_eval("binding")
     end
 
-    unless respond_to?(:__pry__)
+    unless self.class.method_defined?(:__pry__)
       # The easiest way to check whether an object has a working singleton class
       # is to try and define a method on it. (just checking for the presence of
       # the singleton class gives false positives for `true` and `false`).

data/lib/pry/editor.rb

@@ -1,6 +1,5 @@
 class Pry
   class Editor
-    include Pry::Helpers::BaseHelpers
     include Pry::Helpers::CommandHelpers
 
     attr_reader :_pry_
@@ -9,7 +8,7 @@ class Pry
       @_pry_ = _pry_
     end
 
-    def edit_tempfile_with_content(initial_content, line=1)
+    def edit_tempfile_with_content(initial_content, line = 1)
       temp_file do |f|
         f.puts(initial_content)
         f.flush
@@ -19,13 +18,13 @@ class Pry
       end
     end
 
-    def invoke_editor(file, line, blocking=true)
+    def invoke_editor(file, line, blocking = true)
       raise CommandError, "Please set Pry.config.editor or export $VISUAL or $EDITOR" unless _pry_.config.editor
 
       editor_invocation = build_editor_invocation_string(file, line, blocking)
       return nil unless editor_invocation
 
-      if jruby?
+      if Helpers::Platform.jruby?
         open_editor_on_jruby(editor_invocation)
       else
         open_editor(editor_invocation)
@@ -43,12 +42,7 @@ class Pry
         args = [file, line, blocking][0...(_pry_.config.editor.arity)]
         _pry_.config.editor.call(*args)
       else
-        sanitized_file = if windows?
-                            file.gsub(/\//, '\\')
-                          else
-                            Shellwords.escape(file)
-                          end
-
+        sanitized_file = Helpers::Platform.windows? ? file : Shellwords.escape(file)
         "#{_pry_.config.editor} #{blocking_flag_for_editor(blocking)} #{start_line_syntax_for_editor(sanitized_file, line)}"
       end
     end
@@ -109,7 +103,7 @@ class Pry
       when /^redcar/
         "-l#{line_number} #{file_name}"
       else
-        if windows?
+        if Helpers::Platform.windows?
           "#{file_name}"
         else
           "+#{line_number} #{file_name}"
@@ -130,6 +124,5 @@ class Pry
     def editor_name
       File.basename(_pry_.config.editor).split(" ").first
     end
-
   end
 end

data/lib/pry/exceptions.rb

@@ -1,5 +1,4 @@
 class Pry
-
   # As a REPL, we often want to catch any unexpected exceptions that may have
   # been raised; however we don't want to go overboard and prevent the user
   # from exiting Pry when they want to.
@@ -52,7 +51,7 @@ class Pry
     def self.===(exception)
       ["can't modify frozen class/module",
        "can't modify frozen Class",
-       "can't modify frozen object"
+       "can't modify frozen object",
       ].include?(exception.message)
     end
   end
@@ -74,5 +73,4 @@ class Pry
   # IRB = Pry thing.
   module ExtendCommandBundle
   end
-
 end

data/lib/pry/forwardable.rb

@@ -0,0 +1,23 @@
+class Pry
+  module Forwardable
+    require 'forwardable'
+    include ::Forwardable
+
+    #
+    # Since Ruby 2.4, Forwardable will print a warning when
+    # calling a method that is private on a delegate, and
+    # in the future it could be an error: https://bugs.ruby-lang.org/issues/12782#note-3
+    #
+    # That's why we revert to a custom implementation for delegating one
+    # private method to another.
+    #
+    def def_private_delegators(target, *private_delegates)
+      private_delegates.each do |private_delegate|
+        define_method(private_delegate) do |*a, &b|
+          instance_variable_get(target).__send__(private_delegate, *a, &b)
+        end
+      end
+      class_eval { private(*private_delegates) }
+    end
+  end
+end