pry 0.14.2 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d8bac7565d29bff46039481c17aa6a88fec28084916dd8dad12cd4e83b146c1
-  data.tar.gz: 90b46a979aaac6d01ddf589217baca57bc2d7ce8197c8f27bc22f823eeaffcdd
+  metadata.gz: f45a7ece4b6117e2ecb650b850bbafc729d1575d810ae709dff957979782b030
+  data.tar.gz: f3977bcef3004c4643ea02320dc4f3ca1d2958ea813665559bc2f0db01325efd
 SHA512:
-  metadata.gz: 2e671cca56deb75c1c47ba9108155bec171ebe34d5ba740b3dd7ea3e848fc789291111e40b7c604835b3d90209873a4a3364ec72a5f4c0f062dea98e5b466a30
-  data.tar.gz: f4c80ad6f3187823c18e1fff35306fc1e0a0ee4045a06b190f4742c92099b89d7ef5bafcb1c1dd68c8ae09b251a9a9b64bfd33179c2a7778f3122c90d636afa5
+  metadata.gz: 276887cb72b590db134890f41b44dd6844bc1e5cd8307ca72236028967026c7f24fd07e14ae1d99840330672941740945a502ca965e2d7d00df400095af7a12a
+  data.tar.gz: 52146474624b386e394aaf5a21e371c5e52744a2aeff67468603a25b81bfb4bd83be027b7b2bf9aa9b987b22aa3a0efb3debc86d892536c00ad6a33465a33d85

data/CHANGELOG.md

@@ -1,4 +1,74 @@
-### master
+### [v0.16.0](v0.16.0) (December 26, 2025)
+
+#### Features
+
+* Ruby 4.0 Support.
+  Pry will now require and default to Reline for newer Rubies.
+  ([#2357](https://github.com/pry/pry/pull/2357))
+  ([#2349](https://github.com/pry/pry/pull/2349))
+* Revert 'Unify show-doc with show-source'.
+  ([#2346](https://github.com/pry/pry/pull/2346))
+
+#### Breaking Changes
+
+* Remove experimental `Pry.auto_resize!`
+  Returns a warning. The code will be removed later.
+  ([#2359](https://github.com/pry/pry/pull/2359))
+* Drop support for Ruby < 2.6
+  ([#2349](https://github.com/pry/pry/pull/2349))
+
+### [v0.15.2](v0.15.2) (December 24, 2024)
+
+#### Bug Fixes
+
+* Avoid breaking reading input if Prism version is undetectable
+  ([#2340](https://github.com/pry/pry/pull/2340))
+
+### [v0.15.1](v0.15.1) (December 24, 2024)
+
+#### Bug Fixes
+
+* Restore Pry.config.ls compatibility
+  ([#2335](https://github.com/pry/pry/pull/2335))
+* Avoid breaking reading inputs if Prism is not available
+  ([#2338](https://github.com/pry/pry/pull/2338))
+
+### [v0.15.0][v0.15.0] (November 15, 2024)
+
+#### Features
+
+* Added support for Reline
+  ([#2298](https://github.com/pry/pry/pull/2298))
+* Added support for Ruby 3.3
+  ([#2295](https://github.com/pry/pry/pull/2295))
+* Added Pry::Input::SimpleStdio for dumb terminals when Reline is in use
+  ([#2304](https://github.com/pry/pry/pull/2304))
+* Remove OpenStruct usage
+  ([#2307](https://github.com/pry/pry/pull/2307))
+  ([#2309](https://github.com/pry/pry/pull/2309))
+* Disable coloring of output when NO_COLOR is set.
+  ([#2323])(https://github.com/pry/pry/pull/2323))
+* Add `pry --no-multiline` flag to keep single line prompt.
+  ([#2327](https://github.com/pry/pry/pull/2327))
+
+#### Bug Fixes
+
+* Fix typos on docs and and comments
+  ([#2300](https://github.com/pry/pry/pull/2300))
+  ([#2301](https://github.com/pry/pry/pull/2301))
+* Fix 'calling clear method' on user code when defined in pry context.
+  ([#2291](https://github.com/pry/pry/pull/2291))
+* Fix arguments WatchExpression#add_expression
+  ([#2278](https://github.com/pry/pry/pull/2278))
+
+### Breaking changes
+
+* Remove support for deprecated `Pry.config.prompt = [proc {}, proc {}]`
+  Use Pry::Prompt API instead
+  ([#2308](https://github.com/pry/pry/pull/2308))
+* Remove deprecated `Pry.config.exception_whitelist`.
+  Use `Pry.config.unrescued_exceptions` instead.
+  ([#2326](https://github.com/pry/pry/pull/2326))
 
 ### [v0.14.2][v0.14.2] (January 9, 2023)
 
@@ -977,7 +1047,7 @@ complete CHANGELOG:
 * _pry_ now passed as 3rd parameter to :before_session hook
 * ls colors now configurable via Pry.config.ls.local_var_color = :bright_red etc
 * ls separator configurable via, e.g Pry.config.ls.separator = "  "
-* Pry.view_clip() now only calls inspect on a few immediates, otherwise uses the #<> syntax, which has been truncated further to exclude teh mem address, again related to #245
+* Pry.view_clip() now only calls inspect on a few immediates, otherwise uses the #<> syntax, which has been truncated further to exclude the mem address, again related to #245
 
 ### 0.9.3 (2011/7/27)
 * cat --ex (cats 5 lines above and below line in file where exception was raised)

data/LICENSE

@@ -3,7 +3,7 @@ License
 
 (The MIT License)
 
-Copyright (c) 2018 John Mair (banisterfiend)
+Copyright (c) 2010 John Mair (banisterfiend)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -9,9 +9,9 @@ Pry
 
 ![Pry logo](https://www.dropbox.com/s/zp8o63kquby2rln/pry_logo_350.png?raw=1)
 
-© John Mair ([banisterfiend](https://twitter.com/banisterfiend)) 2018<br> (Creator)
+© John Mair ([banisterfiend](https://twitter.com/banisterfiend)) 2010<br> (Creator)
 
-© Kyrylo Silin ([kyrylosilin](https://twitter.com/kyrylosilin)) 2018<br> (Maintainer)
+© Kyrylo Silin ([kyrylosilin](https://twitter.com/kyrylosilin)) 2010<br> (Maintainer)
 
 **Alumni:**
 
@@ -81,7 +81,7 @@ Installation
 ### Bundler
 
 ```ruby
-gem 'pry', '~> 0.13.1'
+gem 'pry', '~> 0.15.0'
 ```
 
 ### Manual
@@ -413,18 +413,21 @@ description if the `--help` option is available.
 
 ### Use Pry as your Rails Console
 
-The recommended way to use Pry as your Rails console is to add [the `pry-rails`
-gem](https://github.com/rweng/pry-rails) to your Gemfile. This replaces the
-default console with Pry, in addition to loading the Rails console helpers and
-adding some useful Rails-specific commands.
-
-If you don't want to change your Gemfile, you can still run a Pry console in
-your app's environment using Pry's `-r` flag:
+You can run a Pry console in your app's environment using Pry's `-r` flag:
 
 ```sh
 pry -r ./config/environment
 ```
 
+Or start the rails console (`bin/rails console`) and then type `pry`.
+
+It's also possible to use Pry as your Rails console by adding [the pry-rails
+gem](https://github.com/pry/pry-rails) to your Gemfile. This replaces the
+default console with Pry, in addition to loading the Rails console helpers and
+adding some useful Rails-specific commands.
+
+**Note that `pry-rails` is not currently maintained.**
+
 Also check out the
 [wiki](https://github.com/pry/pry/wiki/Setting-up-Rails-or-Heroku-to-use-Pry)
 for more information about integrating Pry with Rails.

data/lib/pry/class_command.rb

@@ -137,7 +137,7 @@ class Pry
     #     end
     #   end
     #
-    # @example Define the invokation block anywhere you want
+    # @example Define the invocation block anywhere you want
     #   def subcommands(cmd)
     #     cmd.command :download do |opt|
     #       description 'Downloads a content from a server'
@@ -172,7 +172,7 @@ class Pry
 
     # The actual body of your command should go here.
     #
-    # The `opts` mehod can be called to get the options that Pry::Slop has passed,
+    # The `opts` method can be called to get the options that Pry::Slop has passed,
     # and `args` gives the remaining, unparsed arguments.
     #
     # The return value of this method is discarded unless the command was

data/lib/pry/cli.rb

@@ -123,7 +123,7 @@ Pry::CLI.add_options do
     "Usage: pry [OPTIONS]\n" \
     "Start a Pry session.\n" \
     "See http://pry.github.io/ for more information.\n" \
-    "Copyright (c) 2016 John Mair (banisterfiend)" \
+    "Copyright (c) 2010 John Mair (banisterfiend)" \
   )
 
   on(
@@ -145,6 +145,10 @@ Pry::CLI.add_options do
     Pry.config.color = false
   end
 
+  on "no-multiline", "Disables multiline (defaults to true with Reline)" do
+    Pry.config.multiline = false
+  end
+
   on :f, "Suppress loading of pryrc" do
     Pry.config.should_load_rc = false
     Pry.config.should_load_local_rc = false

data/lib/pry/code_object.rb

@@ -11,7 +11,7 @@ class Pry
   # object the user wants (applying precedence rules in doing so -- i.e methods
   # get precedence over commands with the same name) and 2. Returning
   # the appropriate object. If the user fails to provide a string
-  # identifer for the object (i.e they pass in `nil` or "") then the
+  # identifier for the object (i.e they pass in `nil` or "") then the
   # object looked up will be the 'current method' or 'current class'
   # associated with the Binding.
   #
@@ -97,7 +97,7 @@ class Pry
       nil
     end
 
-    # when no paramter is given (i.e CodeObject.lookup(nil)), then we
+    # when no parameter is given (i.e CodeObject.lookup(nil)), then we
     # lookup the 'current object' from the binding.
     def empty_lookup
       return nil if str && !str.empty?

data/lib/pry/command.rb

@@ -200,7 +200,7 @@ class Pry
       end
 
       def state
-        Pry::CommandState.default.state_for(match)
+        Pry::CommandState.default.state_for(self)
       end
     end
 

data/lib/pry/command_set.rb

@@ -145,7 +145,7 @@ class Pry
     # Imports all the commands from one or more sets.
     # @param [Array<CommandSet>] sets Command sets, all of the commands of which
     #   will be imported.
-    # @return [Pry::CommandSet] Returns the reciever (a command set).
+    # @return [Pry::CommandSet] Returns the receiver (a command set).
     def import(*sets)
       sets.each do |set|
         @commands.merge! set.to_hash
@@ -157,7 +157,7 @@ class Pry
     # Imports some commands from a set
     # @param [CommandSet] set Set to import commands from
     # @param [Array<String>] matches Commands to import
-    # @return [Pry::CommandSet] Returns the reciever (a command set).
+    # @return [Pry::CommandSet] Returns the receiver (a command set).
     def import_from(set, *matches)
       helper_module.send :include, set.helper_module
       matches.each do |match|

data/lib/pry/command_state.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'ostruct'
-
 class Pry
   # CommandState is a data structure to hold per-command state.
   #
@@ -20,12 +18,19 @@ class Pry
       @command_state = {}
     end
 
-    def state_for(command_name)
-      @command_state[command_name] ||= OpenStruct.new
+    def state_for(command_class)
+      @command_state[command_class] ||= command_struct(command_class)
+    end
+
+    def reset(command_class)
+      @command_state[command_class] = command_struct(command_class)
     end
 
-    def reset(command_name)
-      @command_state[command_name] = OpenStruct.new
+    private
+
+    def command_struct(command_class)
+      Struct.new(:command, *command_class.command_options[:state])
+        .new(command: command_class)
     end
   end
 end

data/lib/pry/commands/amend_line.rb

@@ -76,7 +76,7 @@ class Pry
 
       # Takes two numbers that are 1-indexed, and returns a range (or
       # number) that is 0-indexed. 1-indexed means the first element is
-      # indentified by 1 rather than by 0 (as is the case for Ruby arrays).
+      # identified by 1 rather than by 0 (as is the case for Ruby arrays).
       # @param [Fixnum] start_line_number One-indexed number.
       # @param [Fixnum] end_line_number One-indexed number.
       # @return [Range] The zero-indexed range.

data/lib/pry/commands/cd.rb

@@ -22,6 +22,8 @@ class Pry
         https://github.com/pry/pry/wiki/State-navigation#wiki-Changing_scope
       BANNER
 
+      command_options state: %i[old_stack]
+
       def process
         state.old_stack ||= []
 

data/lib/pry/commands/edit.rb

@@ -22,6 +22,8 @@ class Pry
         https://github.com/pry/pry/wiki/Editor-integration#wiki-Edit_command
       BANNER
 
+      command_options state: %i[dynamical_ex_file]
+
       def options(opt)
         opt.on :e, :ex, "Open the file that raised the most recent exception " \
                         "(_ex_.file)",

data/lib/pry/commands/find_method.rb

@@ -128,7 +128,7 @@ class Pry
           next if klass.autoload?(name)
 
           begin
-            const = klass.const_get(name)
+            const = Pry::Method.singleton_class_of(klass.const_get(name))
           rescue RescuableException # rubocop:disable Lint/HandleExceptions
             # constant loading is an inexact science at the best of times,
             # this often happens when a constant was .autoload? but someone

data/lib/pry/commands/ls/config.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+class Pry
+  class Command
+    class Ls < Pry::ClassCommand
+      class Config
+        extend Forwardable
+
+        DEFAULT_OPTIONS = {
+          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_instance, _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,   # Constant still in .autoload? state
+          separator: "  ",
+          ceiling: [Object, Module, Class]
+        }.freeze
+
+        DEFAULT_OPTIONS.each_key do |key|
+          define_method key do
+            @config[key]
+          end
+
+          define_method "#{key}=" do |value|
+            @config[key] = value
+          end
+        end
+
+        def_delegators :@config, :[], :[]=, :each, :each_pair, :values, :keys, :to_a
+
+        def initialize(config)
+          @config = config
+        end
+
+        def self.default
+          new(DEFAULT_OPTIONS.dup)
+        end
+      end
+    end
+  end
+end

data/lib/pry/commands/ls.rb

@@ -3,27 +3,6 @@
 class Pry
   class Command
     class Ls < Pry::ClassCommand
-      DEFAULT_OPTIONS = {
-        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_instance, _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
-        separator: "  ",
-        ceiling: [Object, Module, Class]
-      }.freeze
-
       match 'ls'
       group 'Context'
       description 'Show the list of vars and methods in the current scope.'

data/lib/pry/commands/raise_up.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Pry
-  # N.B. using a regular expresion here so that "raise-up 'foo'" does the right thing.
+  # N.B. using a regular expression here so that "raise-up 'foo'" does the right thing.
   class Command
     class RaiseUp < Pry::ClassCommand
       match(/raise-up(!?\b.*)/)

data/lib/pry/commands/ri.rb

@@ -57,7 +57,7 @@ class Pry
           RDoc::RI.const_set :PryDriver, subclass # hook it up!
         end
 
-        # Spin-up an RI insance.
+        # Spin-up an RI instance.
         ri = RDoc::RI::PryDriver.new(
           pry_instance.pager, use_stdout: true, interactive: false
         )

data/lib/pry/commands/shell_command.rb

@@ -7,7 +7,7 @@ class Pry
       group 'Input and Output'
       description "All text following a '.' is forwarded to the shell."
       command_options listing: '.<shell command>', use_prefix: false,
-                      takes_block: true
+                      takes_block: true, state: %i[old_pwd]
 
       banner <<-'BANNER'
         Usage: .COMMAND_NAME

data/lib/pry/commands/shell_mode.rb

@@ -6,6 +6,7 @@ class Pry
       match 'shell-mode'
       group 'Input and Output'
       description 'Toggle shell mode. Bring in pwd prompt and file completion.'
+      command_options state: %i[disabled prev_prompt]
 
       banner <<-'BANNER'
         Toggle shell mode. Bring in pwd prompt and file completion.

data/lib/pry/commands/show_doc.rb

@@ -21,16 +21,6 @@ class Pry
         show-doc Pry -a    # for all definitions of Pry class (all monkey patches)
       BANNER
 
-      def process
-        super
-
-        output.puts(
-          "\nWARNING: the show-doc command is deprecated. It will be removed " \
-          "from future Pry versions.\nPlease use 'show-source' with the -d " \
-          "(or --doc) switch instead\nExample: show-source #{obj_name} -d"
-        )
-      end
-
       # The docs for code_object prepared for display.
       def content_for(code_object)
         Code.new(
@@ -89,5 +79,6 @@ class Pry
     end
 
     Pry::Commands.add_command(Pry::Command::ShowDoc)
+    Pry::Commands.alias_command '?', 'show-doc'
   end
 end

data/lib/pry/commands/show_source.rb

@@ -3,8 +3,6 @@
 class Pry
   class Command
     class ShowSource < Command::ShowInfo
-      include Pry::Helpers::DocumentationHelpers
-
       match 'show-source'
       group 'Introspection'
       description 'Show the source for a method or class.'
@@ -23,7 +21,6 @@ class Pry
         show-source Pry -a      # for all Pry class definitions (all monkey patches)
         show-source Pry.foo -e  # for class of the return value of expression `Pry.foo`
         show-source Pry --super # for superclass of Pry (Object class)
-        show-source Pry -d      # include documentation
 
         https://github.com/pry/pry/wiki/Source-browsing#wiki-Show_method
       BANNER
@@ -31,7 +28,6 @@ class Pry
       def options(opt)
         opt.on :e, :eval, "evaluate the command's argument as a ruby " \
                           "expression and show the class its return value"
-        opt.on :d, :doc, 'include documentation in the output'
         super(opt)
       end
 
@@ -46,73 +42,16 @@ class Pry
 
       # The source for code_object prepared for display.
       def content_for(code_object)
-        content = ''
-        if opts.present?(:d)
-          code = Code.new(
-            render_doc_markup_for(code_object), start_line_for(code_object), :text
-          )
-          content += code.with_line_numbers(use_line_numbers?).to_s
-          content += "\n"
-        end
-
         code = Code.new(
-          code_object.source || [], start_line_for(code_object)
+          code_object.source || [],
+          start_line_for(code_object)
         )
-        content += code.with_line_numbers(use_line_numbers?).highlighted
-        content
-      end
-
-      # process the markup (if necessary) and apply colors
-      def render_doc_markup_for(code_object)
-        docs = docs_for(code_object)
-
-        if code_object.command?
-          # command '--help' shouldn't use markup highlighting
-          docs
-        else
-          if docs.empty?
-            raise CommandError, "No docs found for: #{obj_name || 'current context'}"
-          end
-
-          process_comment_markup(docs)
-        end
-      end
-
-      # Return docs for the code_object, adjusting for whether the code_object
-      # has yard docs available, in which case it returns those.
-      # (note we only have to check yard docs for modules since they can
-      # have multiple docs, but methods can only be doc'd once so we
-      # dont need to check them)
-      def docs_for(code_object)
-        if code_object.module_with_yard_docs?
-          # yard docs
-          code_object.yard_doc
-        else
-          # normal docs (i.e comments above method/module/command)
-          code_object.doc
-        end
-      end
-
-      # Which sections to include in the 'header', can toggle: :owner,
-      # :signature and visibility.
-      def header_options
-        super.merge signature: true
-      end
-
-      # figure out start line of docs by back-calculating based on
-      # number of lines in the comment and the start line of the code_object
-      # @return [Fixnum] start line of docs
-      def start_line_for(code_object)
-        return 1 if code_object.command? || opts.present?(:'base-one')
-        return 1 unless code_object.source_line
-
-        code_object.source_line - code_object.doc.lines.count
+        code.with_line_numbers(use_line_numbers?).highlighted
       end
     end
 
     Pry::Commands.add_command(Pry::Command::ShowSource)
     Pry::Commands.alias_command 'show-method', 'show-source'
     Pry::Commands.alias_command '$', 'show-source'
-    Pry::Commands.alias_command '?', 'show-source -d'
   end
 end

data/lib/pry/commands/watch_expression/expression.rb

@@ -23,7 +23,7 @@ class Pry
 
         # Has the value of the expression changed?
         #
-        # We use the pretty-printed string represenation to detect differences
+        # We use the pretty-printed string representation to detect differences
         # as this avoids problems with dup (causes too many differences) and ==
         # (causes too few)
         def changed?

data/lib/pry/commands/watch_expression.rb

@@ -7,7 +7,7 @@ class Pry
       group 'Context'
       description 'Watch the value of an expression and print a notification ' \
                   'whenever it changes.'
-      command_options use_prefix: false
+      command_options use_prefix: false, state: %i[watch_expressions]
 
       banner <<-'BANNER'
         Usage: watch [EXPRESSION]
@@ -46,7 +46,7 @@ class Pry
           list
         else
           add_hook
-          add_expression(args)
+          add_expression
         end
       end
 
@@ -88,9 +88,7 @@ class Pry
         end
       end
 
-      # TODO: fix arguments.
-      # https://github.com/pry/pry/commit/b031df2f2f5850ee6e9018f33d35f3485a9b0423
-      def add_expression(_arguments)
+      def add_expression
         expressions << Expression.new(pry_instance, target, arg_string)
         output.puts "Watching #{Code.new(arg_string).highlighted}"
       end