pry 0.11.3-java → 0.12.0-java

data/lib/pry/pry_class.rb

@@ -1,7 +1,16 @@
-require 'pry/config'
 class Pry
-
-  HOME_RC_FILE = ENV["PRYRC"] || "~/.pryrc"
+  HOME_RC_FILE =
+    if ENV.key?('PRYRC')
+      ENV['PRYRC']
+    elsif File.exist?(File.expand_path('~/.pryrc'))
+      '~/.pryrc'
+    elsif ENV.key?('XDG_CONFIG_HOME') && ENV['XDG_CONFIG_HOME'] != ''
+      # See XDG Base Directory Specification at
+      # https://standards.freedesktop.org/basedir-spec/basedir-spec-0.8.html
+      ENV['XDG_CONFIG_HOME'] + '/pry/pryrc'
+    else
+      '~/.config/pry/pryrc'
+    end
   LOCAL_RC_FILE = "./.pryrc"
 
   class << self
@@ -93,9 +102,7 @@ class Pry
 
   # Expand a file to its canonical name (following symlinks as appropriate)
   def self.real_path_to(file)
-    expanded = Pathname.new(File.expand_path(file)).realpath.to_s
-    # For rbx 1.9 mode [see rubinius issue #2165]
-    File.exist?(expanded) ? expanded : nil
+    Pathname.new(File.expand_path(file)).realpath.to_s
   rescue Errno::ENOENT, Errno::EACCES
     nil
   end
@@ -110,7 +117,7 @@ class Pry
   # Trap interrupts on jruby, and make them behave like MRI so we can
   # catch them.
   def self.load_traps
-    trap('INT'){ raise Interrupt }
+    trap('INT') { raise Interrupt }
   end
 
   def self.load_win32console
@@ -124,16 +131,16 @@ class Pry
 For a better Pry experience on Windows, please use ansicon:
   https://github.com/adoxa/ansicon
 If you use an alternative to ansicon and don't want to see this warning again,
-you can add "Pry.config.windows_console_warning = false" to your .pryrc.
+you can add "Pry.config.windows_console_warning = false" to your pryrc.
       WARNING
     end
   end
 
-  # Do basic setup for initial session.
-  # Including: loading .pryrc, loading plugins, loading requires, and
-  # loading history.
+  # Do basic setup for initial session including: loading pryrc, plugins,
+  # requires, and history.
   def self.initial_session_setup
     return unless initial_session?
+
     @initial_session = false
 
     # note these have to be loaded here rather than in pry_instance as
@@ -143,27 +150,28 @@ you can add "Pry.config.windows_console_warning = false" to your .pryrc.
 
   def self.final_session_setup
     return if @session_finalized
+
     @session_finalized = true
     load_plugins if Pry.config.should_load_plugins
     load_requires if Pry.config.should_load_requires
     load_history if Pry.config.history.should_load
     load_traps if Pry.config.should_trap_interrupts
-    load_win32console if Pry::Helpers::BaseHelpers.windows? && !Pry::Helpers::BaseHelpers.windows_ansi?
+    load_win32console if Helpers::Platform.windows? && !Helpers::Platform.windows_ansi?
   end
 
   # Start a Pry REPL.
-  # This method also loads `~/.pryrc` and `./.pryrc` as necessary the
-  # first time it is invoked.
+  # This method also loads `pryrc` as necessary the first time it is invoked.
   # @param [Object, Binding] target The receiver of the Pry session
   # @param [Hash] options
   # @option options (see Pry#initialize)
   # @example
   #   Pry.start(Object.new, :input => MyInput.new)
-  def self.start(target=nil, options={})
+  def self.start(target = nil, options = {})
     return if ENV['DISABLE_PRY']
     if ENV['FAIL_PRY']
       raise 'You have FAIL_PRY set to true, which results in Pry calls failing'
     end
+
     options = options.to_hash
 
     if in_critical_section?
@@ -231,7 +239,7 @@ you can add "Pry.config.windows_console_warning = false" to your .pryrc.
       # fixed as of https://github.com/jruby/jruby/commit/d365ebd309cf9df3dde28f5eb36ea97056e0c039
       # we can drop in the future.
       obj.to_s
-    elsif Pry.config.prompt_safe_objects.any? { |v| v === obj } && obj.inspect.length <= max
+    elsif Pry.config.prompt_safe_contexts.any? { |v| v === obj } && obj.inspect.length <= max
       obj.inspect
     else
       id == true ? "#<#{obj.class}:0x%x>" % (obj.object_id << 1) : "#<#{obj.class}>"
@@ -267,19 +275,19 @@ you can add "Pry.config.windows_console_warning = false" to your .pryrc.
   #   Pry.run_command "ls -m", :target => Pry
   # @example Display command output.
   #   Pry.run_command "ls -av", :show_output => true
-  def self.run_command(command_string, options={})
+  def self.run_command(command_string, options = {})
     options = {
-      :target => TOPLEVEL_BINDING,
-      :show_output => true,
-      :output => Pry.config.output,
-      :commands => Pry.config.commands
+      target: TOPLEVEL_BINDING,
+      show_output: true,
+      output: Pry.config.output,
+      commands: Pry.config.commands
     }.merge!(options)
 
     # :context for compatibility with <= 0.9.11.4
     target = options[:context] || options[:target]
     output = options[:show_output] ? options[:output] : StringIO.new
 
-    pry = Pry.new(:output   => output, :target   => target, :commands => options[:commands])
+    pry = Pry.new(output: output, target: target, commands: options[:commands])
     pry.eval command_string
     nil
   end
@@ -287,12 +295,10 @@ you can add "Pry.config.windows_console_warning = false" to your .pryrc.
   def self.default_editor_for_platform
     return ENV['VISUAL'] if ENV['VISUAL'] and not ENV['VISUAL'].empty?
     return ENV['EDITOR'] if ENV['EDITOR'] and not ENV['EDITOR'].empty?
-    if Helpers::BaseHelpers.windows?
-      'notepad'
-    else
-      %w(editor nano vi).detect do |editor|
-        system("which #{editor} > /dev/null 2>&1")
-      end
+    return 'notepad' if Helpers::Platform.windows?
+
+    %w(editor nano vi).detect do |editor|
+      system("which #{editor} > /dev/null 2>&1")
     end
   end
 
@@ -389,13 +395,31 @@ Readline version #{Readline::VERSION} detected - will not auto_resize! correctly
     Thread.current[:pry_critical_section] > 0
   end
 
-  def self.critical_section(&block)
+  def self.critical_section
     Thread.current[:pry_critical_section] ||= 0
     Thread.current[:pry_critical_section] += 1
     yield
   ensure
     Thread.current[:pry_critical_section] -= 1
   end
+
+  # Wraps a block in a named block called `Pry::Config::Lazy`. This is used for
+  # dynamic config values, which are calculated every time
+  # {Pry::Config::Lazy#call} is called.
+  #
+  # @example
+  #   # pryrc
+  #   Pry.config.prompt_name = Pry.lazy { rand(100) }
+  #
+  #   # Session
+  #   [1] 96(main)>
+  #   [2] 19(main)>
+  #   [3] 80(main)>
+  #
+  # @return [#call]
+  def self.lazy(&block)
+    Pry::Config::Lazy.new(&block)
+  end
 end
 
 Pry.init

data/lib/pry/pry_instance.rb

@@ -21,6 +21,7 @@
 # * the IRC channel, which is #pry on the Freenode network
 #
 
+# rubocop:disable Metrics/ClassLength
 class Pry
   attr_accessor :binding_stack
   attr_accessor :custom_completions
@@ -34,8 +35,13 @@ class Pry
   attr_reader :last_exception
   attr_reader :command_state
   attr_reader :exit_value
-  attr_reader :input_array
-  attr_reader :output_array
+
+  # @since v0.12.0
+  attr_reader :input_ring
+
+  # @since v0.12.0
+  attr_reader :output_ring
+
   attr_reader :config
 
   extend Pry::Config::Convenience
@@ -62,7 +68,7 @@ class Pry
   #   The backtrace of the session's `binding.pry` line, if applicable.
   # @option options [Object] :target
   #   The initial context for this session.
-  def initialize(options={})
+  def initialize(options = {})
     @binding_stack = []
     @indent        = Pry::Indent.new
     @command_state = {}
@@ -72,23 +78,47 @@ class Pry
     @config = Pry::Config.new
     config.merge!(options)
     push_prompt(config.prompt)
-    @input_array  = Pry::HistoryArray.new config.memory_size
-    @output_array = Pry::HistoryArray.new config.memory_size
+    @input_ring = Pry::Ring.new(config.memory_size)
+    @output_ring = Pry::Ring.new(config.memory_size)
     @custom_completions = config.command_completions
     set_last_result nil
-    @input_array << nil
+    @input_ring << nil
     push_initial_binding(target)
     exec_hook(:when_started, target, options, self)
   end
 
-  # The current prompt.
+  @input_array_warn = false
+  # @deprecated Use {#input_ring} instead.
+  def input_array
+    unless @input_array_warn
+      loc = caller_locations(1..1).first
+      warn(
+        "#{loc.path}:#{loc.lineno}: warning: method #{self.class}##{__method__} " \
+        "is deprecated. Use #{self.class}#input_ring instead"
+      )
+      @input_array_warn = true
+    end
+
+    @input_ring
+  end
+
+  @output_array_warn = false
+  # @deprecated Use {#output_ring} instead.
+  def output_array
+    unless @output_array_warn
+      loc = caller_locations(1..1).first
+      warn(
+        "#{loc.path}:#{loc.lineno}: warning: method #{self.class}##{__method__} " \
+        "is deprecated. Use #{self.class}#output_ring instead"
+      )
+      @output_array_warn = true
+    end
+
+    @output_ring
+  end
+
   # This is the prompt at the top of the prompt stack.
-  #
-  # @example
-  #    self.prompt = Pry::SIMPLE_PROMPT
-  #    self.prompt # => Pry::SIMPLE_PROMPT
-  #
-  # @return [Array<Proc>] Current prompt.
+  # @return [Array<Proc>] the current prompt
   def prompt
     prompt_stack.last
   end
@@ -103,7 +133,7 @@ class Pry
 
   # Initialize this instance by pushing its initial context into the binding
   # stack. If no target is given, start at the top level.
-  def push_initial_binding(target=nil)
+  def push_initial_binding(target = nil)
     push_binding(target || Pry.toplevel_binding)
   end
 
@@ -132,6 +162,7 @@ class Pry
   #
   def complete(str)
     return EMPTY_COMPLETIONS unless config.completer
+
     Pry.critical_section do
       completer = config.completer.new(config.input, self)
       completer.call str, target: current_binding, custom_completions: custom_completions.call.push(*sticky_locals.keys)
@@ -171,13 +202,13 @@ class Pry
   # @return [Integer] The maximum amount of objects remembered by the inp and
   #   out arrays. Defaults to 100.
   def memory_size
-    @output_array.max_size
+    @output_ring.max_size
   end
 
   undef :memory_size= if method_defined? :memory_size=
   def memory_size=(size)
-    @input_array  = Pry::HistoryArray.new(size)
-    @output_array = Pry::HistoryArray.new(size)
+    @input_ring = Pry::Ring.new(size)
+    @output_ring = Pry::Ring.new(size)
   end
 
   # Inject all the sticky locals into the current binding.
@@ -197,14 +228,14 @@ class Pry
   end
 
   def sticky_locals
-    { _in_: input_array,
-      _out_: output_array,
+    { _in_: input_ring,
+      _out_: output_ring,
       _pry_: self,
       _ex_: last_exception && last_exception.wrapped_exception,
       _file_: last_file,
       _dir_: last_dir,
       _: proc { last_result },
-      __: proc { output_array[-2] }
+      __: proc { output_ring[-2] }
     }.merge(config.extra_sticky_locals)
   end
 
@@ -234,7 +265,7 @@ class Pry
   # @return [Boolean] Is Pry ready to accept more input?
   # @raise [Exception] If the user uses the `raise-up` command, this method
   #   will raise that exception.
-  def eval(line, options={})
+  def eval(line, options = {})
     return false if @stopped
 
     exit_value = nil
@@ -254,6 +285,7 @@ class Pry
 
     # TODO: make this configurable?
     raise exception if exception
+
     return false
   end
 
@@ -310,7 +342,7 @@ class Pry
       # This workaround has a side effect: java exceptions specified
       # in `Pry.config.exception_whitelist` are ignored.
       jruby_exceptions = []
-      if Pry::Helpers::BaseHelpers.jruby?
+      if Helpers::Platform.jruby?
         jruby_exceptions << Java::JavaLang::Exception
       end
 
@@ -325,7 +357,7 @@ class Pry
         # Eliminate following warning:
         # warning: singleton on non-persistent Java type X
         # (http://wiki.jruby.org/Persistence)
-        if Pry::Helpers::BaseHelpers.jruby? && e.class.respond_to?('__persistent__')
+        if Helpers::Platform.jruby? && e.class.respond_to?('__persistent__')
           e.class.__persistent__ = true
         end
         self.last_exception = e
@@ -345,7 +377,7 @@ class Pry
   # (If nested sessions are going to exist, this method is fine, but a goal is
   # to come up with an alternative to nested sessions altogether.)
   def repl(target = nil)
-    Pry::REPL.new(self, :target => target).start
+    Pry::REPL.new(self, target: target).start
   end
 
   def evaluate_ruby(code)
@@ -403,11 +435,11 @@ class Pry
     val = val.lstrip if /^\s\S/ !~ val
     val = val.chomp
     result = commands.process_line(val,
-      :target => current_binding,
-      :output => output,
-      :eval_string => @eval_string,
-      :pry_instance => self,
-      :hooks => hooks
+      target: current_binding,
+      output: output,
+      eval_string: @eval_string,
+      pry_instance: self,
+      hooks: hooks
     )
 
     # set a temporary (just so we can inject the value we want into eval_string)
@@ -448,10 +480,10 @@ class Pry
   #   pry_instance.run_command("ls -m")
   def run_command(val)
     commands.process_line(val,
-      :eval_string => @eval_string,
-      :target => current_binding,
-      :pry_instance => self,
-      :output => output
+      eval_string: @eval_string,
+      target: current_binding,
+      pry_instance: self,
+      output: output
     )
     Pry::Command::VOID_VALUE
   end
@@ -479,9 +511,9 @@ class Pry
   # This method should not need to be invoked directly.
   # @param [Object] result The result.
   # @param [String] code The code that was run.
-  def set_last_result(result, code="")
+  def set_last_result(result, code = "")
     @last_result_is_exception = false
-    @output_array << result
+    @output_ring << result
 
     self.last_result = result unless code =~ /\A\s*\z/
   end
@@ -495,7 +527,7 @@ class Pry
   def last_exception=(e)
     last_exception = Pry::LastException.new(e)
     @last_result_is_exception = true
-    @output_array << last_exception
+    @output_ring << last_exception
     @last_exception = last_exception
   end
 
@@ -503,8 +535,8 @@ class Pry
   # This method should not need to be invoked directly.
   # @param [String] code The code we just eval'd
   def update_input_history(code)
-    # Always push to the @input_array as the @output_array is always pushed to.
-    @input_array << code
+    # Always push to the @input_ring as the @output_ring is always pushed to.
+    @input_ring << code
     if code
       Pry.line_buffer.push(*code.each_line)
       Pry.current_line += code.lines.count
@@ -529,28 +561,26 @@ class Pry
   # @return [String] The prompt.
   def select_prompt
     object = current_binding.eval('self')
-
-    open_token = @indent.open_delimiters.any? ? @indent.open_delimiters.last :
-      @indent.stack.last
-
-    c = Pry::Config.from_hash({
-                       :object         => object,
-                       :nesting_level  => binding_stack.size - 1,
-                       :open_token     => open_token,
-                       :session_line   => Pry.history.session_line_count + 1,
-                       :history_line   => Pry.history.history_line_count + 1,
-                       :expr_number    => input_array.count,
-                       :_pry_          => self,
-                       :binding_stack  => binding_stack,
-                       :input_array    => input_array,
-                       :eval_string    => @eval_string,
-                       :cont           => !@eval_string.empty?})
+    open_token = @indent.open_delimiters.last || @indent.stack.last
+
+    c = Pry::Config.assign({
+        object: object,
+        nesting_level: binding_stack.size - 1,
+        open_token: open_token,
+        session_line: Pry.history.session_line_count + 1,
+        history_line: Pry.history.history_line_count + 1,
+        expr_number: input_ring.count,
+        _pry_: self,
+        binding_stack: binding_stack,
+        input_ring: input_ring,
+        eval_string: @eval_string,
+        cont: !@eval_string.empty?
+      })
 
     Pry.critical_section do
       # If input buffer is empty then use normal prompt
       if eval_string.empty?
         generate_prompt(Array(prompt).first, c)
-
       # Otherwise use the wait prompt (indicating multi-line expression)
       else
         generate_prompt(Array(prompt).last, c)
@@ -655,7 +685,9 @@ class Pry
       raise exception
     end
   end
+
   def raise_up(*args); raise_up_common(false, *args); end
+
   def raise_up!(*args); raise_up_common(true, *args); end
 
   # Convenience accessor for the `quiet` config key.
@@ -664,3 +696,4 @@ class Pry
     config.quiet
   end
 end
+# rubocop:enable Metrics/ClassLength