pry 0.9.12.6-i386-mingw32 → 0.10.0-i386-mingw32

data/lib/pry/plugins.rb

@@ -43,7 +43,7 @@ class Pry
       # Does not reload plugin if it's already active.
       def activate!
         # Create the configuration object for the plugin.
-        Pry.config.send("#{gem_name.gsub('-', '_')}=", OpenStruct.new)
+        Pry.config.send("#{gem_name.gsub('-', '_')}=", Pry::Config.from_hash({}))
 
         begin
           require gem_name if !active?

data/lib/pry/prompt.rb

@@ -0,0 +1,26 @@
+class Pry::Prompt
+  MAP = {
+    "default" => {
+      value: Pry::DEFAULT_PROMPT,
+      description: "The default Pry prompt. Includes information about the\n" \
+                   "current expression number, evaluation context, and nesting\n" \
+                   "level, plus a reminder that you're using Pry."
+    },
+
+    "simple" => {
+      value: Pry::SIMPLE_PROMPT,
+      description: "A simple '>>'."
+    },
+
+    "nav" => {
+      value: Pry::NAV_PROMPT,
+      description: "A prompt that displays the binding stack as a path and\n" \
+                   "includes information about _in_ and _out_."
+    },
+
+    "none" => {
+      value: Pry::NO_PROMPT,
+      description: "Wave goodbye to the Pry prompt."
+    }
+ }
+end

data/lib/pry/pry_class.rb

@@ -1,93 +1,88 @@
-require 'ostruct'
-require 'forwardable'
 require 'pry/config'
-
 class Pry
 
-  # The RC Files to load.
-  HOME_RC_FILE = "~/.pryrc"
+  HOME_RC_FILE = ENV["PRYRC"] || "~/.pryrc"
   LOCAL_RC_FILE = "./.pryrc"
 
-  # @return [Hash] Pry's `Thread.current` hash
-  def self.current
-    Thread.current[:__pry__] ||= {}
-  end
-
-  # class accessors
   class << self
     extend Forwardable
-
-    # convenience method
-    def self.delegate_accessors(delagatee, *names)
-      def_delegators delagatee, *names
-      def_delegators delagatee, *names.map { |v| "#{v}=" }
-    end
-
-    # Get/Set the Proc that defines extra Readline completions (on top
-    # of the ones defined for IRB).
-    # @return [Proc] The Proc that defines extra Readline completions (on top
-    # @example Add file names to completion list
-    #   Pry.custom_completions = proc { Dir.entries('.') }
     attr_accessor :custom_completions
-
-    # @return [Fixnum] The current input line.
     attr_accessor :current_line
-
-    # @return [Array] The Array of evaluated expressions.
     attr_accessor :line_buffer
-
-    # @return [String] The __FILE__ for the `eval()`. Should be "(pry)"
-    #   by default.
     attr_accessor :eval_path
-
-    # @return [OpenStruct] Return Pry's config object.
+    attr_accessor :cli
+    attr_accessor :quiet
+    attr_accessor :last_internal_error
     attr_accessor :config
+    attr_writer :history
 
-    # @return [History] Return Pry's line history object.
-    attr_accessor :history
+    def_delegators :@plugin_manager, :plugins, :load_plugins, :locate_plugins
 
-    # @return [Boolean] Whether Pry was activated from the command line.
-    attr_accessor :cli
+    extend Pry::Config::Convenience
+    config_shortcut *Pry::Config.shortcuts
 
-    # @return [Boolean] Whether Pry sessions are quiet by default.
-    attr_accessor :quiet
+    def prompt=(value)
+      config.prompt = value
+    end
 
-    # @return [Binding] A top level binding with no local variables
-    attr_accessor :toplevel_binding
+    def prompt
+      config.prompt
+    end
 
-    # @return [Exception, nil] The last pry internal error.
-    #   (a CommandError in most cases)
-    attr_accessor :last_internal_error
+    def history
+      @history ||= History.new
+    end
+  end
 
-    # plugin forwardables
-    def_delegators :@plugin_manager, :plugins, :load_plugins, :locate_plugins
+  #
+  # @return [main]
+  #   returns the special instance of Object, "main".
+  #
+  def self.main
+    @main ||= TOPLEVEL_BINDING.eval "self"
+  end
 
-    delegate_accessors :@config, :input, :output, :commands, :prompt, :print, :exception_handler,
-      :hooks, :color, :pager, :editor, :memory_size, :input_stack, :extra_sticky_locals
+  #
+  # @return [Pry::Config]
+  #  Returns a value store for an instance of Pry running on the current thread.
+  #
+  def self.current
+    Thread.current[:__pry__] ||= Pry::Config.from_hash({}, nil)
   end
 
   # Load the given file in the context of `Pry.toplevel_binding`
-  # @param [String] file_name The unexpanded file path.
-  def self.load_file_at_toplevel(file_name)
-    full_name = File.expand_path(file_name)
-    begin
-      toplevel_binding.eval(File.read(full_name), full_name) if File.exists?(full_name)
-    rescue RescuableException => e
-      puts "Error loading #{file_name}: #{e}\n#{e.backtrace.first}"
-    end
+  # @param [String] file The unexpanded file path.
+  def self.load_file_at_toplevel(file)
+    toplevel_binding.eval(File.read(file), file)
+  rescue RescuableException => e
+    puts "Error loading #{file}: #{e}\n#{e.backtrace.first}"
   end
 
-  # Load the rc files given in the `Pry::RC_FILES` array.
+  # Load HOME_RC_FILE and LOCAL_RC_FILE if appropriate
   # This method can also be used to reload the files if they have changed.
-  def self.load_rc
-    load_file_at_toplevel(HOME_RC_FILE)
+  def self.load_rc_files
+    rc_files_to_load.each do |file|
+      critical_section do
+        load_file_at_toplevel(file)
+      end
+    end
   end
 
   # Load the local RC file (./.pryrc)
-  def self.load_local_rc
-    unless File.expand_path(HOME_RC_FILE) == File.expand_path(LOCAL_RC_FILE)
-      load_file_at_toplevel(LOCAL_RC_FILE)
-    end
+  def self.rc_files_to_load
+    files = []
+    files << HOME_RC_FILE if Pry.config.should_load_rc
+    files << LOCAL_RC_FILE if Pry.config.should_load_local_rc
+    files.map { |file| real_path_to(file) }.compact.uniq
+  end
+
+  # 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
+  rescue Errno::ENOENT
+    nil
   end
 
   # Load any Ruby files specified with the -r flag on the command line.
@@ -103,26 +98,41 @@ class Pry
     trap('INT'){ raise Interrupt }
   end
 
+  def self.load_win32console
+    begin
+      require 'win32console'
+      # The mswin and mingw versions of pry require win32console, so this should
+      # only fail on jruby (where win32console doesn't work).
+      # Instead we'll recommend ansicon, which does.
+    rescue LoadError
+      warn <<-WARNING if Pry.config.windows_console_warning
+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.
+      WARNING
+    end
+  end
+
   # Do basic setup for initial session.
   # Including: loading .pryrc, loading plugins, loading requires, and
   # loading 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
     # we only want them loaded once per entire Pry lifetime.
-    load_rc if Pry.config.should_load_rc
-    load_local_rc if Pry.config.should_load_local_rc
+    load_rc_files
     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
-
-    @initial_session = false
+    load_win32console if Pry::Helpers::BaseHelpers.windows? && !Pry::Helpers::BaseHelpers.windows_ansi?
   end
 
   # Start a Pry REPL.
-  # This method also loads the ~/.pryrc and ./.pryrc as necessary
+  # This method also loads `~/.pryrc` and `./.pryrc` as necessary the
   # first time it is invoked.
   # @param [Object, Binding] target The receiver of the Pry session
   # @param [Hash] options
@@ -131,6 +141,7 @@ class Pry
   #   Pry.start(Object.new, :input => MyInput.new)
   def self.start(target=nil, options={})
     return if ENV['DISABLE_PRY']
+    options = options.to_hash
 
     if in_critical_section?
       output.puts "ERROR: Pry started inside Pry."
@@ -138,35 +149,24 @@ class Pry
       return
     end
 
-    target = Pry.binding_for(target || toplevel_binding)
+    options[:target] = Pry.binding_for(target || toplevel_binding)
+    options[:hooks] = Pry::Hooks.from_hash options.delete(:hooks) if options.key?(:hooks)
     initial_session_setup
 
-    # create the Pry instance to manage the session
-    pry_instance = new(options)
-
-    # save backtrace
-    pry_instance.backtrace = caller
+    # Unless we were given a backtrace, save the current one
+    if options[:backtrace].nil?
+      options[:backtrace] = caller
 
-    # if Pry was started via binding.pry, elide that from the backtrace.
-    pry_instance.backtrace.shift if pry_instance.backtrace.first =~ /pry.*core_extensions.*pry/
-
-    # yield the binding_stack to the hook for modification
-    pry_instance.exec_hook(:when_started, target, options, pry_instance)
-
-    if !pry_instance.binding_stack.empty?
-      head = pry_instance.binding_stack.pop
-    else
-      head = target
+      # If Pry was started via `binding.pry`, elide that from the backtrace
+      if options[:backtrace].first =~ /pry.*core_extensions.*pry/
+        options[:backtrace].shift
+      end
     end
 
-    # Clear the line before starting Pry. This fixes the issue discussed here:
-    # https://github.com/pry/pry/issues/566
-    if Pry.config.auto_indent
-      Kernel.print Pry::Helpers::BaseHelpers.windows_ansi? ? "\e[0F" : "\e[0G"
-    end
+    driver = options[:driver] || Pry::REPL
 
     # Enter the matrix
-    pry_instance.repl(head)
+    driver.start(options)
   rescue Pry::TooSafeException
     puts "ERROR: Pry cannot work with $SAFE > 0"
     raise
@@ -179,23 +179,40 @@ class Pry
     REPLFileLoader.new(file_name).load
   end
 
+  #
   # An inspector that clips the output to `max_length` chars.
   # In case of > `max_length` chars the `#<Object...> notation is used.
-  # @param obj The object to view.
-  # @param max_length The maximum number of chars before clipping occurs.
-  # @return [String] The string representation of `obj`.
-  def self.view_clip(obj, max_length = 60)
-    if obj.kind_of?(Module) && obj.name.to_s != "" && obj.name.to_s.length <= max_length
+  #
+  # @param [Object] obj
+  #   The object to view.
+  #
+  # @param [Hash] options
+  # @option options [Integer] :max_length (60)
+  #   The maximum number of chars before clipping occurs.
+  #
+  # @option options [Boolean] :id (false)
+  #   Boolean to indicate whether or not a hex reprsentation of the object ID
+  #   is attached to the return value when the length of inspect is greater than
+  #   value of `:max_length`.
+  #
+  # @return [String]
+  #   The string representation of `obj`.
+  #
+  def self.view_clip(obj, options = {})
+    max = options.fetch :max_length, 60
+    id = options.fetch :id, false
+    if obj.kind_of?(Module) && obj.name.to_s != "" && obj.name.to_s.length <= max
       obj.name.to_s
-    elsif TOPLEVEL_BINDING.eval('self') == obj
-      # special case for 'main' object :)
+    elsif Pry.main == obj
+      # special-case to support jruby.
+      # fixed as of https://github.com/jruby/jruby/commit/d365ebd309cf9df3dde28f5eb36ea97056e0c039
+      # we can drop in the future.
       obj.to_s
-    elsif [String, Numeric, Symbol, nil, true, false].any? { |v| v === obj } && obj.inspect.length <= max_length
+    elsif Pry.config.prompt_safe_objects.any? { |v| v === obj } && obj.inspect.length <= max
       obj.inspect
     else
-      "#<#{obj.class}>"#:%x>"# % (obj.object_id << 1)
+      id == true ? "#<#{obj.class}:0x%x>" % (obj.object_id << 1) : "#<#{obj.class}>"
     end
-
   rescue RescuableException
     "unknown"
   end
@@ -205,11 +222,6 @@ class Pry
     Pry.history.load
   end
 
-  # Save new lines of Readline history if required.
-  def self.save_history
-    Pry.history.save
-  end
-
   # @return [Boolean] Whether this is the first time a Pry session has
   #   been started since loading the Pry class.
   def self.initial_session?
@@ -217,40 +229,40 @@ class Pry
   end
 
   # Run a Pry command from outside a session. The commands available are
-  # those referenced by `Pry.commands` (the default command set).
+  # those referenced by `Pry.config.commands` (the default command set).
   # @param [String] command_string The Pry command (including arguments,
   #   if any).
   # @param [Hash] options Optional named parameters.
   # @return [Object] The return value of the Pry command.
-  # @option options [Object, Binding] :context The object context to run the
+  # @option options [Object, Binding] :target The object to run the
   #   command under. Defaults to `TOPLEVEL_BINDING` (main).
   # @option options [Boolean] :show_output Whether to show command
   #   output. Defaults to true.
   # @example Run at top-level with no output.
   #   Pry.run_command "ls"
   # @example Run under Pry class, returning only public methods.
-  #   Pry.run_command "ls -m", :context => Pry
+  #   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={})
     options = {
-      :context => TOPLEVEL_BINDING,
+      :target => TOPLEVEL_BINDING,
       :show_output => true,
-      :output => Pry.output,
-      :commands => Pry.commands
+      :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.new(:output => output, :input => StringIO.new("#{command_string}\nexit-all\n"),
-            :commands => options[:commands],
-            :prompt => proc {""}, :hooks => Pry::Hooks.new).repl(options[:context])
+    pry = Pry.new(:output   => output, :target   => target, :commands => options[:commands])
+    pry.eval command_string
   end
 
   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
@@ -261,19 +273,25 @@ class Pry
   end
 
   def self.auto_resize!
-    Pry.require_readline
-    ver = Readline::VERSION
-    if ver[/edit/i]
+    Pry.config.input # by default, load Readline
+
+    if !defined?(Readline) || Pry.config.input != Readline
+      warn "Sorry, you must be using Readline for Pry.auto_resize! to work."
+      return
+    end
+
+    if Readline::VERSION =~ /edit/i
       warn <<-EOT
-Readline version #{ver} detected - will not auto_resize! correctly.
+Readline version #{Readline::VERSION} detected - will not auto_resize! correctly.
   For the fix, use GNU Readline instead:
   https://github.com/guard/guard/wiki/Add-proper-Readline-support-to-Ruby-on-Mac-OS-X
       EOT
       return
     end
+
     trap :WINCH do
       begin
-        Readline.set_screen_size *Terminal.size!
+        Readline.set_screen_size(*Terminal.size!)
       rescue => e
         warn "\nPry.auto_resize!'s Readline.set_screen_size failed: #{e}"
       end
@@ -285,124 +303,19 @@ Readline version #{ver} detected - will not auto_resize! correctly.
     end
   end
 
-  def self.set_config_defaults
-    config.input = proc { Pry.require_readline; Readline }
-    config.output = $stdout
-    config.commands = Pry::Commands
-    config.prompt_name = DEFAULT_PROMPT_NAME
-    config.prompt = DEFAULT_PROMPT
-    config.print = DEFAULT_PRINT
-    config.exception_handler = DEFAULT_EXCEPTION_HANDLER
-    config.exception_whitelist = DEFAULT_EXCEPTION_WHITELIST
-    config.default_window_size = 5
-    config.hooks = DEFAULT_HOOKS
-    config.input_stack = []
-    config.color = Helpers::BaseHelpers.use_ansi_codes?
-    config.pager = true
-    config.system = DEFAULT_SYSTEM
-    config.editor = default_editor_for_platform
-    config.should_load_rc = true
-    config.should_load_local_rc = true
-    config.should_trap_interrupts = Helpers::BaseHelpers.jruby?
-    config.disable_auto_reload = false
-    config.command_prefix = ""
-    config.auto_indent = Helpers::BaseHelpers.use_ansi_codes?
-    config.correct_indent = true
-    config.collision_warning = false
-    config.output_prefix = "=> "
-    config.completer = Pry::BondCompleter
-
-    config.gist ||= OpenStruct.new
-    config.gist.inspecter = proc(&:pretty_inspect)
-
-    config.should_load_plugins = true
-
-    config.requires ||= []
-    config.should_load_requires = true
-
-    config.history ||= OpenStruct.new
-    config.history.should_save = true
-    config.history.should_load = true
-    config.history.file = File.expand_path("~/.pry_history") rescue nil
-
-    if config.history.file.nil?
-      config.should_load_rc = false
-      config.history.should_save = false
-      config.history.should_load = false
-    end
-
-    config.control_d_handler = DEFAULT_CONTROL_D_HANDLER
-
-    config.memory_size = 100
-
-    config.extra_sticky_locals = {}
-
-    config.ls ||= OpenStruct.new({
-      :heading_color            => :bright_blue,
-
-      :public_method_color      => :default,
-      :private_method_color     => :blue,
-      :protected_method_color   => :blue,
-      :method_missing_color     => :bright_red,
-
-      :local_var_color          => :yellow,
-      :pry_var_color            => :default,         # e.g. _, _pry_, _file_
-
-      :instance_var_color       => :blue,        # e.g. @foo
-      :class_var_color          => :bright_blue, # e.g. @@foo
-
-      :global_var_color         => :default,     # e.g. $CODERAY_DEBUG, $eventmachine_library
-      :builtin_global_color     => :cyan,        # e.g. $stdin, $-w, $PID
-      :pseudo_global_color      => :cyan,        # e.g. $~, $1..$9, $LAST_MATCH_INFO
-
-      :constant_color           => :default,     # e.g. VERSION, ARGF
-      :class_constant_color     => :blue,        # e.g. Object, Kernel
-      :exception_constant_color => :magenta,     # e.g. Exception, RuntimeError
-      :unloaded_constant_color  => :yellow,      # Any constant that is still in .autoload? state
-
-      # What should separate items listed by ls? (TODO: we should allow a columnar layout)
-      :separator                => "  ",
-
-      # Any methods defined on these classes, or modules included into these classes, will not
-      # be shown by ls unless the -v flag is used.
-      # A user of Rails may wih to add ActiveRecord::Base to the list.
-      # add the following to your .pryrc:
-      # Pry.config.ls.ceiling << ActiveRecord::Base if defined? ActiveRecordBase
-      :ceiling                  => [Object, Module, Class]
-    })
-  end
-
   # Set all the configurable options back to their default values
   def self.reset_defaults
-    set_config_defaults
-
     @initial_session = true
-
-    self.custom_completions = DEFAULT_CUSTOM_COMPLETIONS
+    self.config = Pry::Config.new Pry::Config::Default.new
     self.cli = false
     self.current_line = 1
     self.line_buffer = [""]
     self.eval_path = "(pry)"
-
-    fix_coderay_colors
-  end
-
-  # To avoid mass-confusion, we change the default colour of "white" to
-  # "blue" enabling global legibility
-  def self.fix_coderay_colors
-    colors = CodeRay::Encoders::Terminal::TOKEN_COLORS
-
-    if colors[:comment].is_a?(String)
-      colors[:comment] = "0;34"
-    end
   end
 
   # Basic initialization.
   def self.init
     @plugin_manager ||= PluginManager.new
-    self.config ||= Config.new
-    self.history ||= History.new
-
     reset_defaults
     locate_plugins
   end
@@ -416,7 +329,7 @@ Readline version #{ver} detected - will not auto_resize! correctly.
     if Binding === target
       target
     else
-      if TOPLEVEL_BINDING.eval('self') == target
+      if Pry.main == target
         TOPLEVEL_BINDING
       else
         target.__binding__
@@ -425,7 +338,7 @@ Readline version #{ver} detected - will not auto_resize! correctly.
   end
 
   def self.toplevel_binding
-    unless @toplevel_binding
+    unless defined?(@toplevel_binding) && @toplevel_binding
       # Grab a copy of the TOPLEVEL_BINDING without any local variables.
       # This binding has a default definee of Object, and new methods are
       # private (just as in TOPLEVEL_BINDING).
@@ -441,15 +354,21 @@ Readline version #{ver} detected - will not auto_resize! correctly.
     @toplevel_binding
   end
 
+  def self.toplevel_binding=(binding)
+    @toplevel_binding = binding
+  end
+
   def self.in_critical_section?
-    @critical_section.to_i > 0
+    Thread.current[:pry_critical_section] ||= 0
+    Thread.current[:pry_critical_section] > 0
   end
 
   def self.critical_section(&block)
-    @critical_section = @critical_section.to_i + 1
+    Thread.current[:pry_critical_section] ||= 0
+    Thread.current[:pry_critical_section] += 1
     yield
   ensure
-    @critical_section -= 1
+    Thread.current[:pry_critical_section] -= 1
   end
 end