pry 0.10.1 → 0.14.1

data/lib/pry/commands/ls.rb

@@ -1,114 +1,135 @@
-require 'pry/commands/ls/ls_entity'
+# frozen_string_literal: true
+
 class Pry
-  class Command::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_, _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]
-    }
-
-
-    match 'ls'
-    group 'Context'
-    description 'Show the list of vars and methods in the current scope.'
-    command_options :shellwords => false, :interpolate => false
-
-    banner <<-'BANNER'
-      Usage: ls [-m|-M|-p|-pM] [-q|-v] [-c|-i] [Object]
-             ls [-g] [-l]
-
-      ls shows you which methods, constants and variables are accessible to Pry. By
-      default it shows you the local variables defined in the current shell, and any
-      public methods or instance variables defined on the current object.
-
-      The colours used are configurable using Pry.config.ls.*_color, and the separator
-      is Pry.config.ls.separator.
-
-      Pry.config.ls.ceiling is used to hide methods defined higher up in the
-      inheritance chain, this is by default set to [Object, Module, Class] so that
-      methods defined on all Objects are omitted. The -v flag can be used to ignore
-      this setting and show all methods, while the -q can be used to set the ceiling
-      much lower and show only methods defined on the object or its direct class.
-
-      Also check out `find-method` command (run `help find-method`).
-    BANNER
-
-
-    def options(opt)
-      opt.on :m, :methods,   "Show public methods defined on the Object"
-      opt.on :M, "instance-methods", "Show public methods defined in a Module or Class"
-      opt.on :p, :ppp,       "Show public, protected (in yellow) and private (in green) methods"
-      opt.on :q, :quiet,     "Show only methods defined on object.singleton_class and object.class"
-      opt.on :v, :verbose,   "Show methods and constants on all super-classes (ignores Pry.config.ls.ceiling)"
-      opt.on :g, :globals,   "Show global variables, including those builtin to Ruby (in cyan)"
-      opt.on :l, :locals,    "Show hash of local vars, sorted by descending size"
-      opt.on :c, :constants, "Show constants, highlighting classes (in blue), and exceptions (in purple).\n" <<
-      " " * 32 <<            "Constants that are pending autoload? are also shown (in yellow)"
-      opt.on :i, :ivars,     "Show instance variables (in blue) and class variables (in bright blue)"
-      opt.on :G, :grep,      "Filter output by regular expression", :argument => true
-
-      if jruby?
-        opt.on :J, "all-java", "Show all the aliases for methods from java (default is to show only prettiest)"
+  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.'
+      command_options shellwords: false, interpolate: false
+
+      banner <<-'BANNER'
+        Usage: ls [-m|-M|-p|-pM] [-q|-v] [-c|-i] [Object]
+               ls [-g] [-l]
+
+        ls shows you which methods, constants and variables are accessible to Pry. By
+        default it shows you the local variables defined in the current shell, and any
+        public methods or instance variables defined on the current object.
+
+        The colours used are configurable using Pry.config.ls.*_color, and the separator
+        is Pry.config.ls.separator.
+
+        Pry.config.ls.ceiling is used to hide methods defined higher up in the
+        inheritance chain, this is by default set to [Object, Module, Class] so that
+        methods defined on all Objects are omitted. The -v flag can be used to ignore
+        this setting and show all methods, while the -q can be used to set the ceiling
+        much lower and show only methods defined on the object or its direct class.
+
+        Also check out `find-method` command (run `help find-method`).
+      BANNER
+
+      def options(opt)
+        opt.on :m, :methods, "Show public methods defined on the Object"
+        opt.on :M, "instance-methods", "Show public methods defined in a " \
+                                       "Module or Class"
+        opt.on :p, :ppp, "Show public, protected (in yellow) and private " \
+                         "(in green) methods"
+        opt.on :q, :quiet, "Show only methods defined on object.singleton_class " \
+                           "and object.class"
+        opt.on :v, :verbose, "Show methods and constants on all super-classes " \
+                             "(ignores Pry.config.ls.ceiling)"
+        opt.on :g, :globals, "Show global variables, including those builtin to " \
+                             "Ruby (in cyan)"
+        opt.on :l, :locals, "Show hash of local vars, sorted by descending size"
+        opt.on :c, :constants, "Show constants, highlighting classes (in blue), " \
+                               "and exceptions (in purple).\n" \
+                               "#{' ' * 32}Constants that are pending autoload? " \
+                               "are also shown (in yellow)"
+        opt.on :i, :ivars, "Show instance variables (in blue) and class " \
+                           "variables (in bright blue)"
+        opt.on :G, :grep, "Filter output by regular expression", argument: true
+
+        if Object.respond_to?(:deprecate_constant)
+          opt.on :d, :dconstants, "Show deprecated constants"
+        end
+
+        return unless Helpers::Platform.jruby?
+
+        opt.on :J, "all-java", "Show all the aliases for methods from java " \
+                               "(default is to show only prettiest)"
       end
-    end
 
-    # Exclude -q, -v and --grep because they,
-    # don't specify what the user wants to see.
-    def no_user_opts?
-      !(opts[:methods] || opts['instance-methods'] || opts[:ppp] ||
-        opts[:globals] || opts[:locals] || opts[:constants] || opts[:ivars])
-    end
+      # Exclude -q, -v and --grep because they,
+      # don't specify what the user wants to see.
+      def no_user_opts?
+        !(opts[:methods] || opts['instance-methods'] || opts[:ppp] ||
+          opts[:globals] || opts[:locals] || opts[:constants] || opts[:ivars])
+      end
 
-    def process
-      @interrogatee = args.empty? ? target_self : target.eval(args.join(' '))
-      raise_errors_if_arguments_are_weird
-      ls_entity = LsEntity.new({
-        :interrogatee => @interrogatee,
-        :no_user_opts => no_user_opts?,
-        :opts => opts,
-        :args => args,
-        :_pry_ => _pry_
-      })
-
-      _pry_.pager.page ls_entity.entities_table
-    end
+      def process
+        @interrogatee = args.empty? ? target_self : target.eval(args.join(' '))
+        raise_errors_if_arguments_are_weird
+        ls_entity = LsEntity.new(
+          interrogatee: @interrogatee,
+          no_user_opts: no_user_opts?,
+          opts: opts,
+          args: args,
+          pry_instance: pry_instance
+        )
+
+        pry_instance.pager.page ls_entity.entities_table
+      end
 
-    private
-
-    def error_list
-      any_args = args.any?
-      non_mod_interrogatee = !(Module === @interrogatee)
-      [
-        ['-l does not make sense with a specified Object', :locals, any_args],
-        ['-g does not make sense with a specified Object', :globals, any_args],
-        ['-q does not make sense with -v',                 :quiet, opts.present?(:verbose)],
-        ['-M only makes sense with a Module or a Class',   'instance-methods', non_mod_interrogatee],
-        ['-c only makes sense with a Module or a Class',   :constants, any_args && non_mod_interrogatee]
-      ]
-    end
+      private
+
+      def error_list
+        any_args = args.any?
+        # rubocop:disable Style/CaseEquality
+        non_mod_interrogatee = !(Module === @interrogatee)
+        # rubocop:enable Style/CaseEquality
+        [
+          ['-l does not make sense with a specified Object', :locals, any_args],
+          ['-g does not make sense with a specified Object', :globals, any_args],
+          ['-q does not make sense with -v', :quiet, opts.present?(:verbose)],
+          [
+            '-M only makes sense with a Module or a Class', 'instance-methods',
+            non_mod_interrogatee
+          ],
+          [
+            '-c only makes sense with a Module or a Class', :constants,
+            any_args && non_mod_interrogatee
+          ]
+        ]
+      end
 
-    def raise_errors_if_arguments_are_weird
-      error_list.each do |message, option, invalid_expr|
-        raise Pry::CommandError, message if opts.present?(option) && invalid_expr
+      def raise_errors_if_arguments_are_weird
+        error_list.each do |message, option, invalid_expr|
+          raise Pry::CommandError, message if opts.present?(option) && invalid_expr
+        end
       end
     end
 
+    Pry::Commands.add_command(Pry::Command::Ls)
   end
-
-  Pry::Commands.add_command(Pry::Command::Ls)
 end

data/lib/pry/commands/nesting.rb

@@ -1,25 +1,29 @@
+# frozen_string_literal: true
+
 class Pry
-  class Command::Nesting < Pry::ClassCommand
-    match 'nesting'
-    group 'Navigating Pry'
-    description 'Show nesting information.'
+  class Command
+    class Nesting < Pry::ClassCommand
+      match 'nesting'
+      group 'Navigating Pry'
+      description 'Show nesting information.'
 
-    banner <<-'BANNER'
-      Show nesting information.
-    BANNER
+      banner <<-'BANNER'
+        Show nesting information.
+      BANNER
 
-    def process
-      output.puts 'Nesting status:'
-      output.puts '--'
-      _pry_.binding_stack.each_with_index do |obj, level|
-        if level == 0
-          output.puts "#{level}. #{Pry.view_clip(obj.eval('self'))} (Pry top level)"
-        else
-          output.puts "#{level}. #{Pry.view_clip(obj.eval('self'))}"
+      def process
+        output.puts 'Nesting status:'
+        output.puts '--'
+        pry_instance.binding_stack.each_with_index do |obj, level|
+          if level == 0
+            output.puts "#{level}. #{Pry.view_clip(obj.eval('self'))} (Pry top level)"
+          else
+            output.puts "#{level}. #{Pry.view_clip(obj.eval('self'))}"
+          end
         end
       end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::Nesting)
+    Pry::Commands.add_command(Pry::Command::Nesting)
+  end
 end

data/lib/pry/commands/play.rb

@@ -1,103 +1,113 @@
+# frozen_string_literal: true
+
 class Pry
-  class Command::Play < Pry::ClassCommand
-    match 'play'
-    group 'Editing'
-    description 'Playback a string variable, method, line, or file as input.'
-
-    banner <<-'BANNER'
-      Usage: play [OPTIONS] [--help]
-
-      The play command enables you to replay code from files and methods as if they
-      were entered directly in the Pry REPL.
-
-      play --lines 149..153   # assumes current context
-      play -i 20 --lines 1..3 # assumes lines of the input expression at 20
-      play -o 4               # the output of of an expression at 4
-      play Pry#repl -l 1..-1  # play the contents of Pry#repl method
-      play -e 2               # play from specified line until end of valid expression
-      play hello.rb           # play a file
-      play Rakefile -l 5      # play line 5 of a file
-      play -d hi              # play documentation of hi method
-      play hi --open          # play hi method and leave it open
-
-      https://github.com/pry/pry/wiki/User-Input#wiki-Play
-    BANNER
-
-    def options(opt)
-      CodeCollector.inject_options(opt)
-
-      opt.on :open, 'Plays the selected content except the last line. Useful' \
-                    ' for replaying methods and leaving the method definition' \
-                    ' "open". `amend-line` can then be used to' \
-                    ' modify the method.'
-
-      opt.on :e, :expression=, 'Executes until end of valid expression', :as => Integer
-      opt.on :p, :print, 'Prints executed code'
-    end
+  class Command
+    class Play < Pry::ClassCommand
+      match 'play'
+      group 'Editing'
+      description 'Playback a string variable, method, line, or file as input.'
+
+      banner <<-'BANNER'
+        Usage: play [OPTIONS] [--help]
+
+        The play command enables you to replay code from files and methods as if they
+        were entered directly in the Pry REPL.
+
+        play --lines 149..153   # assumes current context
+        play -i 20 --lines 1..3 # assumes lines of the input expression at 20
+        play -o 4               # the output of an expression at 4
+        play Pry#repl -l 1..-1  # play the contents of Pry#repl method
+        play -e 2               # play from specified line until end of valid expression
+        play hello.rb           # play a file
+        play Rakefile -l 5      # play line 5 of a file
+        play -d hi              # play documentation of hi method
+        play hi --open          # play hi method and leave it open
+
+        https://github.com/pry/pry/wiki/User-Input#wiki-Play
+      BANNER
+
+      def options(opt)
+        CodeCollector.inject_options(opt)
+
+        opt.on :open, 'Plays the selected content except the last line. Useful' \
+                      ' for replaying methods and leaving the method definition' \
+                      ' "open". `amend-line` can then be used to' \
+                      ' modify the method.'
+
+        opt.on :e, :expression=, 'Executes until end of valid expression', as: Integer
+        opt.on :p, :print, 'Prints executed code'
+      end
 
-    def process
-      @cc = CodeCollector.new(args, opts, _pry_)
+      def process
+        @cc = CodeCollector.new(args, opts, pry_instance)
 
-      perform_play
-      show_input
-    end
+        perform_play
+        show_input
+      end
 
-    def perform_play
-      eval_string << content_after_options
-      run "fix-indent"
-    end
+      def perform_play
+        eval_string << content_after_options
+        run "fix-indent"
+      end
+
+      def show_input
+        return unless opts.present?(:print)
+        return unless Pry::Code.complete_expression?(eval_string)
 
-    def show_input
-      if opts.present?(:print) or !Pry::Code.complete_expression?(eval_string)
-        run "show-input"
+        run 'show-input'
       end
-    end
 
+      def content_after_options
+        if opts.present?(:open)
+          restrict_to_lines(content, (0..-2))
+        elsif opts.present?(:expression)
+          content_at_expression
+        else
+          content
+        end
+      end
 
-    def content_after_options
-      if opts.present?(:open)
-        restrict_to_lines(content, (0..-2))
-      elsif opts.present?(:expression)
-        content_at_expression
-      else
-        content
+      def content_at_expression
+        code_object.expression_at(opts[:expression])
       end
-    end
 
-    def content_at_expression
-      code_object.expression_at(opts[:expression])
-    end
+      def code_object
+        Pry::Code.new(content)
+      end
 
-    def code_object
-      Pry::Code.new(content)
-    end
+      def should_use_default_file?
+        !args.first && !opts.present?(:in) && !opts.present?(:out)
+      end
 
-    def should_use_default_file?
-      !args.first && !opts.present?(:in) && !opts.present?(:out)
-    end
+      def content
+        if should_use_default_file?
+          file_content
+        else
+          @cc.content
+        end
+      end
 
-    def content
-      if should_use_default_file?
-        file_content
-      else
-        @cc.content
+      # The file to play from when no code object is specified.
+      # e.g `play --lines 4..10`
+      def default_file
+        file =
+          if target.respond_to?(:source_location)
+            target.source_location.first
+          else
+            target.eval("__FILE__")
+          end
+        file && File.expand_path(file)
       end
-    end
 
-    # The file to play from when no code object is specified.
-    # e.g `play --lines 4..10`
-    def default_file
-      target.eval("__FILE__") && File.expand_path(target.eval("__FILE__"))
-    end
+      def file_content
+        if !default_file || !File.exist?(default_file)
+          raise CommandError, "File does not exist! File was: #{default_file.inspect}"
+        end
 
-    def file_content
-      if default_file && File.exists?(default_file)
         @cc.restrict_to_lines(File.read(default_file), @cc.line_range)
-      else
-        raise CommandError, "File does not exist! File was: #{default_file.inspect}"
       end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::Play)
+    Pry::Commands.add_command(Pry::Command::Play)
+  end
 end

data/lib/pry/commands/pry_backtrace.rb

@@ -1,25 +1,30 @@
+# frozen_string_literal: true
+
 class Pry
-  class Command::PryBacktrace < Pry::ClassCommand
-    match 'pry-backtrace'
-    group 'Context'
-    description 'Show the backtrace for the Pry session.'
+  class Command
+    class PryBacktrace < Pry::ClassCommand
+      match 'pry-backtrace'
+      group 'Context'
+      description 'Show the backtrace for the Pry session.'
 
-    banner <<-BANNER
-      Usage: pry-backtrace [OPTIONS] [--help]
+      banner <<-BANNER
+        Usage: pry-backtrace [OPTIONS] [--help]
 
-      Show the backtrace for the position in the code where Pry was started. This can
-      be used to infer the behavior of the program immediately before it entered Pry,
-      just like the backtrace property of an exception.
+        Show the backtrace for the position in the code where Pry was started. This can
+        be used to infer the behavior of the program immediately before it entered Pry,
+        just like the backtrace property of an exception.
 
-      NOTE: if you are looking for the backtrace of the most recent exception raised,
-      just type: `_ex_.backtrace` instead.
-      See: https://github.com/pry/pry/wiki/Special-Locals
-    BANNER
+        NOTE: if you are looking for the backtrace of the most recent exception raised,
+        just type: `_ex_.backtrace` instead.
+        See: https://github.com/pry/pry/wiki/Special-Locals
+      BANNER
 
-    def process
-      _pry_.pager.page text.bold('Backtrace:') << "\n--\n" << _pry_.backtrace.join("\n")
+      def process
+        text = "#{bold('Backtrace:')}\n--\n#{pry_instance.backtrace.join("\n")}"
+        pry_instance.pager.page(text)
+      end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::PryBacktrace)
+    Pry::Commands.add_command(Pry::Command::PryBacktrace)
+  end
 end

data/lib/pry/commands/pry_version.rb

@@ -1,17 +1,21 @@
+# frozen_string_literal: true
+
 class Pry
-  class Command::Version < Pry::ClassCommand
-    match 'pry-version'
-    group 'Misc'
-    description 'Show Pry version.'
+  class Command
+    class Version < Pry::ClassCommand
+      match 'pry-version'
+      group 'Misc'
+      description 'Show Pry version.'
 
-    banner <<-'BANNER'
-      Show Pry version.
-    BANNER
+      banner <<-'BANNER'
+        Show Pry version.
+      BANNER
 
-    def process
-      output.puts "Pry version: #{Pry::VERSION} on Ruby #{RUBY_VERSION}."
+      def process
+        output.puts "Pry version: #{Pry::VERSION} on Ruby #{RUBY_VERSION}."
+      end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::Version)
+    Pry::Commands.add_command(Pry::Command::Version)
+  end
 end

data/lib/pry/commands/raise_up.rb

@@ -1,32 +1,38 @@
+# frozen_string_literal: true
+
 class Pry
   # N.B. using a regular expresion here so that "raise-up 'foo'" does the right thing.
-  class Command::RaiseUp < Pry::ClassCommand
-    match(/raise-up(!?\b.*)/)
-    group 'Context'
-    description 'Raise an exception out of the current pry instance.'
-    command_options :listing => 'raise-up'
-
-    banner <<-BANNER
-      Raise up, like exit, allows you to quit pry. Instead of returning a value
-      however, it raises an exception. If you don't provide the exception to be
-      raised, it will use the most recent exception (in pry `_ex_`).
-
-      When called as raise-up! (with an exclamation mark), this command raises the
-      exception through any nested prys you have created by "cd"ing into objects.
-
-      raise-up "get-me-out-of-here"
-
-      # This is equivalent to the command above.
-      raise "get-me-out-of-here"
-      raise-up
-    BANNER
-
-    def process
-      return _pry.pager.page help if captures[0] =~ /(-h|--help)\b/
-      # Handle 'raise-up', 'raise-up "foo"', 'raise-up RuntimeError, 'farble' in a rubyesque manner
-      target.eval("_pry_.raise_up#{captures[0]}")
+  class Command
+    class RaiseUp < Pry::ClassCommand
+      match(/raise-up(!?\b.*)/)
+      group 'Context'
+      description 'Raise an exception out of the current pry instance.'
+      command_options listing: 'raise-up'
+
+      banner <<-BANNER
+        Raise up, like exit, allows you to quit pry. Instead of returning a value
+        however, it raises an exception. If you don't provide the exception to be
+        raised, it will use the most recent exception (in pry `_ex_`).
+
+        When called as raise-up! (with an exclamation mark), this command raises the
+        exception through any nested prys you have created by "cd"ing into objects.
+
+        raise-up "get-me-out-of-here"
+
+        # This is equivalent to the command above.
+        raise "get-me-out-of-here"
+        raise-up
+      BANNER
+
+      def process
+        return _pry.pager.page help if captures[0] =~ /(-h|--help)\b/
+
+        # Handle 'raise-up', 'raise-up "foo"', 'raise-up RuntimeError, 'farble'
+        # in a rubyesque manner
+        target.eval("pry_instance.raise_up#{captures[0]}")
+      end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::RaiseUp)
+    Pry::Commands.add_command(Pry::Command::RaiseUp)
+  end
 end