pry 0.9.12.2 → 0.14.2

data/lib/pry/config.rb

@@ -1,244 +1,314 @@
+# frozen_string_literal: true
+
 require 'ostruct'
 
 class Pry
-  class Config < OpenStruct
-
-    # Get/Set the object to use for input by default by all Pry instances.
-    # Pry.config.input is an option determining the input object - the object from
-    # which Pry retrieves its lines of input. Pry accepts any object that implements the readline method.
-    # This includes IO objects, StringIO, Readline, File and custom objects.
-    # @return [#readline] The object to use for input by default by all
-    #   Pry instances.
-    # @example
-    #   Pry.config.input = StringIO.new("@x = 10\nexit")
-    attr_accessor :input
-
-    # Get/Set the object to use for output by default by all Pry instances.
-    # Pry.config.output is an option determining the output object - the object to which
-    # Pry writes its output. Pry accepts any object that implements the puts method. This
-    # includes IO objects, StringIO, File and custom objects.
-    # @return [#puts] The object to use for output by default by all
-    #   Pry instances.
-    # @example
-    #   Pry.config.output = StringIO.new
-    attr_accessor :output
-
-    # Get/Set the object to use for commands by default by all Pry instances.
-    # @return [Pry::CommandBase] The object to use for commands by default by all
-    #   Pry instances.
-    # @example
-    #   Pry.config.commands = Pry::CommandSet.new do
-    #               import_from Pry::Commands, "ls"
-    #
-    #                 command "greet" do |name|
-    #                 output.puts "hello #{name}"
-    #               end
-    #             end
-    attr_accessor :commands
-
-    # Get/Set the Proc to use for printing by default by all Pry
-    # instances.
-    # Two parameters are passed to the print Proc: these are (1) the
-    # output object for the current session and (2) the expression value to print. It is important
-    # that you write to the output object instead of just stdout so that all Pry output can be redirected if necessary.
-    # This is the 'print' component of the REPL.
-    # @return [Proc] The Proc to use for printing by default by all
-    #   Pry instances.
-    # @example
-    #   Pry.config.print = proc { |output, value| output.puts "=> #{value.inspect}" }
-    attr_accessor :print
-
-    # Pry.config.exception_handler is an option determining the exception handler object - the
-    # Proc responsible for dealing with exceptions raised by user input to the REPL.
-    # Three parameters are passed to the exception handler Proc: these
-    # are (1) the output object for the current session, (2) the
-    # exception object that was raised inside the Pry session, and (3)
-    # a reference to the associated Pry instance.
-    # @return [Proc] The Proc to use for printing exceptions by default by all
-    #   Pry instances.
-    # @example
-    #   Pry.config.exception_handler = proc do |output, exception, _|
-    #     output.puts "#{exception.class}: #{exception.message}"
-    #     output.puts "from #{exception.backtrace.first}"
-    #   end
-    attr_accessor :exception_handler
-
-    # @return [Array] The classes of exception that will not be caught by Pry.
-    # @example
-    #   Pry.config.exception_whitelist = [SystemExit, SignalException]
-    attr_accessor :exception_whitelist
-
-    # @return [Fixnum] The number of lines of context to show before and after
-    #   exceptions, etc.
-    # @example
-    #   Pry.config.default_window_size = 10
-    attr_accessor :default_window_size
-
-    # Get/Set the `Pry::Hooks` instance that defines Pry hooks used by default by all Pry
-    # instances.
-    # @return [Pry::Hooks] The hooks used by default by all Pry instances.
-    # @example
-    #   Pry.config.hooks = Pry::Hooks.new.add_hook(:before_session,
-    #   :default) {  |output, target, _pry_| output.puts "Good morning!" }
-    attr_reader :hooks
-
-    # FIXME:
-    # This is a hack to alert people of the new API.
-    # @param [Pry::Hooks] v Only accept `Pry::Hooks` now!
-    def hooks=(v)
-      if v.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"
-        @hooks = Pry::Hooks.from_hash(v)
-      else
-        @hooks = v
-      end
-    end
+  # @api private
+  class Config
+    extend Attributable
 
-    # Get/Set the stack of input objects that a Pry instance switches
-    # to when its current input object encounters EOF.
-    # @return [Array] The array of input objects.
-    # @example
-    #   Pry.config.input_stack = [StringIO.new("puts 'hello world'\nexit")]
-    attr_accessor :input_stack
-
-    # Get the array of Procs (or single Proc) to be used for the prompts by default by
-    # all Pry instances.
-    # Three parameters are passed into the prompt procs, (1) the
-    # object that is the target of the session, (2) the current
-    # nesting level, and (3) a reference to the associated Pry instance. These objects can be used in the prompt, if desired.
-    # @return [Array<Proc>, Proc] The array of Procs to be used for the
-    #   prompts by default by all Pry instances.
-    # @example
-    #   Pry.config.prompt = proc { |obj, nest_level, _pry_| "#{obj}:#{nest_level}> " }
-    attr_accessor :prompt
-
-    # The display name that is part of the prompt.  Default is 'pry'. 
-    # You can set your own name so you can identify which project your current pry session
-    # is using.  This is useful if you have a local pryrc file in a Rails project for example.
-    # @return [String]
-    # @example 
-    #   Pry.config.prompt_name = 'my_rails_project'
-    attr_accessor :prompt_name
-    
-    # The default editor to use. Defaults to $VISUAL, $EDITOR, or a sensible fallback
-    # for the platform.
-    # If `editor` is a String then that string is used as the shell
-    # command to invoke the editor. If `editor` is callable (e.g a
-    # Proc) then `file`, `line`, and `reloading` are passed in as parameters and the
-    # return value of that callable invocation is used as the exact
-    # shell command to invoke the editor. `reloading` indicates whether Pry will be
-    # reloading code after the shell command returns. Any or all of these parameters
-    # can be omitted from the callable's signature.
-    # @example String
-    #   Pry.config.editor = "emacsclient"
-    # @example Callable
-    #   Pry.config.editor = proc { |file, line| "emacsclient #{file} +#{line}" }
-    # @example Callable waiting only if reloading
-    #   Pry.config.editor = proc { |file, line, reloading| "subl #{'--wait' if reloading} #{file}:#{line}" }
+    # @return [IO, #readline] he object from which Pry retrieves its lines of
+    #   input
+    attribute :input
+
+    # @return [IO, #puts] where Pry should output results provided by {input}
+    attribute :output
+
+    # @return [Pry::CommandSet]
+    attribute :commands
+
+    # @return [Proc] the printer for Ruby expressions (not commands)
+    attribute :print
+
+    # @return [Proc] the printer for exceptions
+    attribute :exception_handler
+
+    # @return [Array] Exception that Pry shouldn't rescue
+    attribute :unrescued_exceptions
+
+    # @deprecated
+    # @return [Array] Exception that Pry shouldn't rescue
+    attribute :exception_whitelist
+
+    # @return [Integer] The number of lines of context to show before and after
+    #   exceptions
+    attribute :default_window_size
+
+    # @return [Pry::Hooks]
+    attribute :hooks
+
+    # @return [Pry::Prompt]
+    attribute :prompt
+
+    # @return [String] The display name that is part of the prompt
+    attribute :prompt_name
+
+    # @return [Array<Object>] the list of objects that are known to have a
+    #   1-line #inspect output suitable for prompt
+    attribute :prompt_safe_contexts
+
+    # If it is a String, then that String is used as the shell
+    # command to invoke the editor.
+    #
+    # If it responds to #call is callable then `file`, `line`, and `reloading`
+    # are passed to it. `reloading` indicates whether Pry will be reloading code
+    # after the shell command returns. All parameters are optional.
     # @return [String, #call]
-    attr_accessor :editor
+    attribute :editor
 
-    # A string that must precede all Pry commands (e.g., if command_prefix is
+    # A string that must precede all commands. For example, if is is
     # set to "%", the "cd" command must be invoked as "%cd").
     # @return [String]
-    attr_accessor :command_prefix
+    attribute :command_prefix
 
-    # @return [Boolean] Toggle Pry color on and off.
-    attr_accessor :color
-
-    # @return [Boolean] Toggle paging on and off.
-    attr_accessor :pager
+    # @return [Boolean]
+    attribute :color
 
-    # Determines whether the rc file (~/.pryrc) should be loaded.
     # @return [Boolean]
-    attr_accessor :should_load_rc
+    attribute :pager
+
+    # @return [Boolean] whether the global ~/.pryrc should be loaded
+    attribute :should_load_rc
+
+    # @return [Boolean] whether the local ./.pryrc should be loaded
+    attribute :should_load_local_rc
+
+    # @return [Boolean] whether to load files specified with the -r flag
+    attribute :should_load_requires
 
-    # Determines whether the local rc file (./.pryrc) should be loaded.
+    # @return [Boolean] whether to disable edit-method's auto-reloading behavior
+    attribute :disable_auto_reload
+
+    # Whether Pry should trap SIGINT and cause it to raise an Interrupt
+    # exception. This is only useful on JRuby, MRI does this for us.
     # @return [Boolean]
-    attr_accessor :should_load_local_rc
+    attribute :should_trap_interrupts
+
+    # @return [Pry::History]
+    attribute :history
 
-    # Determines whether plugins should be loaded.
     # @return [Boolean]
-    attr_accessor :should_load_plugins
+    attribute :history_save
 
-    # Determines whether to load files specified with the -r flag.
     # @return [Boolean]
-    attr_accessor :should_load_requires
+    attribute :history_load
+
+    # @return [String]
+    attribute :history_file
+
+    # @return [Array<String,Regexp>]
+    attribute :history_ignorelist
+
+    # @return [Array<String>] Ruby files to be required
+    attribute :requires
+
+    # @return [Integer] how many input/output lines to keep in memory
+    attribute :memory_size
+
+    # @return [Proc] The proc that runs system commands
+    attribute :system
 
-    # Determines whether to disable edit-method's auto-reloading behavior.
     # @return [Boolean]
-    attr_accessor :disable_auto_reload
+    attribute :auto_indent
 
-    # Determines whether Pry should trap SIGINT and cause it to raise an
-    # Interrupt exception. This is only useful on jruby, MRI does this
-    # for us.
     # @return [Boolean]
-    attr_accessor :should_trap_interrupts
-
-    # Config option for history.
-    # sub-options include history.file, history.load, and history.save
-    # history.file is the file to save/load history to, e.g
-    # Pry.config.history.file = "~/.pry_history".
-    # history.should_load is a boolean that determines whether history will be
-    # loaded from history.file at session start.
-    # history.should_save is a boolean that determines whether history will be
-    # saved to history.file at session end.
-    # @return [OpenStruct]
-    attr_accessor :history
-
-    # Config option for plugins:
-    # sub-options include:
-    # `plugins.strict_loading` (Boolean) which toggles whether referring to a non-existent plugin should raise an exception (defaults to `false`)
-    # @return [OpenStruct]
-    attr_accessor :plugins
-
-    # @return [Array<String>] Ruby files to be required after loading any plugins.
-    attr_accessor :requires
-
-    # @return [Integer] Amount of results that will be stored into out
-    attr_accessor :memory_size
-
-    # @return [Proc] The proc that manages ^D presses in the REPL.
-    #   The proc is passed the current eval_string and the current pry instance.
-    attr_accessor :control_d_handler
+    attribute :correct_indent
 
-    # @return [Proc] The proc that runs system commands
-    #   The proc is passed the pry output object, the command string
-    #   to eval, and a reference to the pry instance
-    attr_accessor :system
-
-    # @return [Boolean] Whether or not code should be indented
-    #  using Pry::Indent.
-    attr_accessor :auto_indent
-
-    # @return [Boolean] Whether or not indentation should be corrected
-    #   after hitting enter. This feature is not supported by all terminals.
-    attr_accessor :correct_indent
-
-    # @return [Boolean] Whether or not a warning will be displayed when
-    #   a command name collides with a method/local in the current context.
-    attr_accessor :collision_warning
-
-
-    # Config option for gist.
-    # sub-options include `gist.inspecter`,
-    # `gist.inspecter` is a callable that defines how the expression output
-    # will be displayed when using the `gist -i` command.
-    # @example Pretty inspect output
-    #   Pry.config.gist.inspecter = proc { |v| v.pretty_inspect }
-    # @example Regular inspect
-    #   Pry.config.gist.inspecter = proc &:inspect
-    # @return [OpenStruct]
-    attr_accessor :gist
-
-    # @return [Hash] Additional sticky locals (to the standard ones) to use in Pry sessions.
-    # @example Inject `random_number` sticky local into Pry session
-    #   Pry.config.extra_sticky_locals = { :random_number => proc {
-    #   rand(10) } }
-    attr_accessor :extra_sticky_locals
-
-    # @return [#build_completion_proc] A completer to use.
-    attr_accessor :completer
+    # @return [Boolean] whether or not display a warning when a command name
+    #   collides with a method/local in the current context.
+    attribute :collision_warning
+
+    # @return [Hash{Symbol=>Proc}]
+    attribute :extra_sticky_locals
+
+    # @return [#build_completion_proc] a completer to use
+    attribute :completer
+
+    # @return [Boolean] suppresses whereami output on `binding.pry`
+    attribute :quiet
+
+    # @return [Boolean] displays a warning about experience improvement on
+    #   Windows
+    attribute :windows_console_warning
+
+    # @return [Proc]
+    attribute :command_completions
+
+    # @return [Proc]
+    attribute :file_completions
+
+    # @return [Hash]
+    attribute :ls
+
+    # @return [String] a line of code to execute in context before the session
+    #   starts
+    attribute :exec_string
+
+    # @return [String]
+    attribute :output_prefix
+
+    # @return [String]
+    # @since v0.13.0
+    attribute :rc_file
+
+    def initialize
+      merge!(
+        input: MemoizedValue.new { lazy_readline },
+        output: $stdout.tap { |out| out.sync = true },
+        commands: Pry::Commands,
+        prompt_name: 'pry',
+        prompt: Pry::Prompt[:default],
+        prompt_safe_contexts: [String, Numeric, Symbol, nil, true, false],
+        print: Pry::ColorPrinter.method(:default),
+        quiet: false,
+        exception_handler: Pry::ExceptionHandler.method(:handle_exception),
+
+        unrescued_exceptions: [
+          ::SystemExit, ::SignalException, Pry::TooSafeException
+        ],
+
+        exception_whitelist: MemoizedValue.new do
+          output.puts(
+            '[warning] Pry.config.exception_whitelist is deprecated, ' \
+            'please use Pry.config.unrescued_exceptions instead.'
+          )
+          unrescued_exceptions
+        end,
+
+        hooks: Pry::Hooks.default,
+        pager: true,
+        system: Pry::SystemCommandHandler.method(:default),
+        color: Pry::Helpers::BaseHelpers.use_ansi_codes?,
+        default_window_size: 5,
+        editor: Pry::Editor.default,
+        rc_file: default_rc_file,
+        should_load_rc: true,
+        should_load_local_rc: true,
+        should_trap_interrupts: Pry::Helpers::Platform.jruby?,
+        disable_auto_reload: false,
+        command_prefix: '',
+        auto_indent: Pry::Helpers::BaseHelpers.use_ansi_codes?,
+        correct_indent: true,
+        collision_warning: false,
+        output_prefix: '=> ',
+        requires: [],
+        should_load_requires: true,
+        windows_console_warning: true,
+        control_d_handler: Pry::ControlDHandler.method(:default),
+        memory_size: 100,
+        extra_sticky_locals: {},
+        command_completions: proc { commands.keys },
+        file_completions: proc { Dir['.'] },
+        ls: OpenStruct.new(Pry::Command::Ls::DEFAULT_OPTIONS),
+        completer: Pry::InputCompleter,
+        history_save: true,
+        history_load: true,
+        history_file: Pry::History.default_file,
+        history_ignorelist: [],
+        history: MemoizedValue.new do
+          if defined?(input::HISTORY)
+            Pry::History.new(history: input::HISTORY)
+          else
+            Pry::History.new
+          end
+        end,
+        exec_string: ''
+      )
+
+      @custom_attrs = {}
+    end
+
+    def merge!(config_hash)
+      config_hash.each_pair { |attr, value| __send__("#{attr}=", value) }
+      self
+    end
+
+    def merge(config_hash)
+      dup.merge!(config_hash)
+    end
+
+    def []=(attr, value)
+      @custom_attrs[attr.to_s] = Config::Value.new(value)
+    end
+
+    def [](attr)
+      @custom_attrs[attr.to_s].call
+    end
+
+    # rubocop:disable Style/MethodMissingSuper
+    def method_missing(method_name, *args, &_block)
+      name = method_name.to_s
+
+      if name.end_with?('=')
+        self[name[0..-2]] = args.first
+      elsif @custom_attrs.key?(name)
+        self[name]
+      end
+    end
+    # rubocop:enable Style/MethodMissingSuper
+
+    def respond_to_missing?(method_name, include_all = false)
+      @custom_attrs.key?(method_name.to_s.tr('=', '')) || super
+    end
+
+    def initialize_dup(other)
+      super
+      @custom_attrs = @custom_attrs.dup
+    end
+
+    attr_reader :control_d_handler
+    def control_d_handler=(value)
+      proxy_proc =
+        if value.arity == 2
+          Pry::Warning.warn(
+            "control_d_handler's arity of 2 parameters was deprecated " \
+            '(eval_string, pry_instance). Now it gets passed just 1 ' \
+            'parameter (pry_instance)'
+          )
+          proc do |*args|
+            if args.size == 2
+              value.call(args.first, args[1])
+            else
+              value.call(args.first.eval_string, args.first)
+            end
+          end
+        else
+          proc do |*args|
+            if args.size == 2
+              value.call(args[1])
+            else
+              value.call(args.first)
+            end
+          end
+        end
+      @control_d_handler = proxy_proc
+    end
+
+    private
+
+    def lazy_readline
+      require 'readline'
+      ::Readline
+    rescue LoadError
+      output.puts(
+        "Sorry, you can't use Pry without Readline or a compatible library. \n" \
+        "Possible solutions: \n" \
+        " * Rebuild Ruby with Readline support using `--with-readline` \n" \
+        " * Use the rb-readline gem, which is a pure-Ruby port of Readline \n" \
+        " * Use the pry-coolline gem, a pure-ruby alternative to Readline"
+      )
+      raise
+    end
+
+    def default_rc_file
+      [Pry::Env['PRYRC'],
+       # See XDG Base Directory Specification at
+       # https://specifications.freedesktop.org/basedir-spec/latest/
+       "#{Pry::Env['XDG_CONFIG_HOME']}/pry/pryrc",
+       File.expand_path('~/.pryrc'),
+       File.expand_path('~/.config/pry/pryrc')]
+        .compact
+        .find { |file| File.exist?(file) }
+    end
   end
 end
-

data/lib/pry/control_d_handler.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class Pry
+  # @api private
+  # @since v0.13.0
+  module ControlDHandler
+    # Deal with the ^D key being pressed. Different behaviour in different
+    # cases:
+    #   1. In an expression behave like `!` command.
+    #   2. At top-level session behave like `exit` command.
+    #   3. In a nested session behave like `cd ..`.
+    def self.default(pry_instance)
+      if !pry_instance.eval_string.empty?
+        # Clear input buffer.
+        pry_instance.eval_string = ''
+      elsif pry_instance.binding_stack.one?
+        pry_instance.binding_stack.clear
+        throw(:breakout)
+      else
+        # Otherwise, saves current binding stack as old stack and pops last
+        # binding out of binding stack (the old stack still has that binding).
+        cd_state = Pry::CommandState.default.state_for('cd')
+        cd_state.old_stack = pry_instance.binding_stack.dup
+        pry_instance.binding_stack.pop
+      end
+    end
+  end
+end