pry 0.12.2 → 0.13.0

data/lib/pry/commands/import_set.rb

@@ -1,23 +1,27 @@
+# frozen_string_literal: true
+
 class Pry
-  class Command::ImportSet < Pry::ClassCommand
-    match 'import-set'
-    group 'Commands'
-    # TODO: Provide a better description with examples and a general conception
-    # of this command.
-    description 'Import a Pry command set.'
+  class Command
+    class ImportSet < Pry::ClassCommand
+      match 'import-set'
+      group 'Commands'
+      # TODO: Provide a better description with examples and a general conception
+      # of this command.
+      description 'Import a Pry command set.'
 
-    banner <<-'BANNER'
-      Import a Pry command set.
-    BANNER
+      banner <<-'BANNER'
+        Import a Pry command set.
+      BANNER
 
-    # TODO: resolve unused parameter.
-    def process(_command_set_name)
-      raise CommandError, "Provide a command set name" if command_set.nil?
+      # TODO: resolve unused parameter.
+      def process(_command_set_name)
+        raise CommandError, "Provide a command set name" if command_set.nil?
 
-      set = target.eval(arg_string)
-      _pry_.commands.import set
+        set = target.eval(arg_string)
+        pry_instance.commands.import set
+      end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::ImportSet)
+    Pry::Commands.add_command(Pry::Command::ImportSet)
+  end
 end

data/lib/pry/commands/jump_to.rb

@@ -1,29 +1,33 @@
+# frozen_string_literal: true
+
 class Pry
-  class Command::JumpTo < Pry::ClassCommand
-    match 'jump-to'
-    group 'Navigating Pry'
-    description 'Jump to a binding further up the stack.'
+  class Command
+    class JumpTo < Pry::ClassCommand
+      match 'jump-to'
+      group 'Navigating Pry'
+      description 'Jump to a binding further up the stack.'
 
-    banner <<-'BANNER'
-      Jump to a binding further up the stack, popping all bindings below.
-    BANNER
+      banner <<-'BANNER'
+        Jump to a binding further up the stack, popping all bindings below.
+      BANNER
 
-    def process(break_level)
-      break_level    = break_level.to_i
-      nesting_level  = _pry_.binding_stack.size - 1
-      max_nest_level = nesting_level - 1
+      def process(break_level)
+        break_level    = break_level.to_i
+        nesting_level  = pry_instance.binding_stack.size - 1
+        max_nest_level = nesting_level - 1
 
-      case break_level
-      when nesting_level
-        output.puts "Already at nesting level #{nesting_level}"
-      when 0..max_nest_level
-        _pry_.binding_stack = _pry_.binding_stack[0..break_level]
-      else
-        output.puts "Invalid nest level. Must be between 0 and " \
-          "#{max_nest_level}. Got #{break_level}."
+        case break_level
+        when nesting_level
+          output.puts "Already at nesting level #{nesting_level}"
+        when 0..max_nest_level
+          pry_instance.binding_stack = pry_instance.binding_stack[0..break_level]
+        else
+          output.puts "Invalid nest level. Must be between 0 and " \
+            "#{max_nest_level}. Got #{break_level}."
+        end
       end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::JumpTo)
+    Pry::Commands.add_command(Pry::Command::JumpTo)
+  end
 end

data/lib/pry/commands/list_inspectors.rb

@@ -1,35 +1,42 @@
-class Pry::Command::ListInspectors < Pry::ClassCommand
-  match 'list-inspectors'
-  group 'Input and Output'
-  description 'List the inspector procs available for use.'
-  banner <<-BANNER
-    Usage: list-inspectors
+# frozen_string_literal: true
 
-    List the inspector procs available to print return values. You can use
-    change-inspector to switch between them.
-  BANNER
+class Pry
+  class Command
+    class ListInspectors < Pry::ClassCommand
+      match 'list-inspectors'
+      group 'Input and Output'
+      description 'List the inspector procs available for use.'
+      banner <<-BANNER
+        Usage: list-inspectors
 
-  def process
-    output.puts heading("Available inspectors") + "\n"
-    inspector_map.each do |name, inspector|
-      output.write "Name: #{bold(name)}"
-      output.puts selected_inspector?(inspector) ? selected_text : ""
-      output.puts inspector[:description]
-      output.puts
-    end
-  end
+        List the inspector procs available to print return values. You can use
+        change-inspector to switch between them.
+      BANNER
 
-private
-  def inspector_map
-    Pry::Inspector::MAP
-  end
+      def process
+        output.puts heading("Available inspectors") + "\n"
+        inspector_map.each do |name, inspector|
+          output.write "Name: #{bold(name)}"
+          output.puts selected_inspector?(inspector) ? selected_text : ""
+          output.puts inspector[:description]
+          output.puts
+        end
+      end
 
-  def selected_text
-    red " (selected) "
-  end
+      private
 
-  def selected_inspector?(inspector)
-    _pry_.print == inspector[:value]
+      def inspector_map
+        Pry::Inspector::MAP
+      end
+
+      def selected_text
+        red " (selected) "
+      end
+
+      def selected_inspector?(inspector)
+        pry_instance.print == inspector[:value]
+      end
+      Pry::Commands.add_command(self)
+    end
   end
-  Pry::Commands.add_command(self)
 end

data/lib/pry/commands/ls.rb

@@ -1,113 +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 Object.respond_to?(:deprecate_constant)
-        opt.on :d, :dconstants, "Show deprecated constants"
+  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
-      if Helpers::Platform.jruby?
-        opt.on :J, "all-java", "Show all the aliases for methods from java (default is to show only prettiest)"
+
+      # 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
-    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_instance: pry_instance
+        )
 
-    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
+        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
-  end
 
-  Pry::Commands.add_command(Pry::Command::Ls)
+    Pry::Commands.add_command(Pry::Command::Ls)
+  end
 end

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

@@ -1,55 +1,72 @@
-require 'pry/commands/ls/interrogatable'
+# frozen_string_literal: true
 
 class Pry
-  class Command::Ls < Pry::ClassCommand
-    class Constants < Pry::Command::Ls::Formatter
-      DEPRECATED_CONSTANTS = [:Data, :Fixnum, :Bignum, :TimeoutError, :NIL, :FALSE, :TRUE]
-      DEPRECATED_CONSTANTS << :JavaPackageModuleTemplate if Helpers::Platform.jruby?
-      include Pry::Command::Ls::Interrogatable
-
-      def initialize(interrogatee, no_user_opts, opts, _pry_)
-        super(_pry_)
-        @interrogatee = interrogatee
-        @no_user_opts = no_user_opts
-        @default_switch = opts[:constants]
-        @verbose_switch = opts[:verbose]
-        @dconstants = opts.dconstants?
-      end
+  class Command
+    class Ls < Pry::ClassCommand
+      class Constants < Pry::Command::Ls::Formatter
+        DEPRECATED_CONSTANTS = [
+          :Data, :Fixnum, :Bignum, :TimeoutError, :NIL, :FALSE, :TRUE
+        ].tap do |constants|
+          constants << :JavaPackageModuleTemplate if Helpers::Platform.jruby?
+        end
+        include Pry::Command::Ls::Interrogatable
 
-      def correct_opts?
-        super || (@no_user_opts && interrogating_a_module?)
-      end
+        def initialize(interrogatee, no_user_opts, opts, pry_instance)
+          super(pry_instance)
+          @interrogatee = interrogatee
+          @no_user_opts = no_user_opts
+          @default_switch = opts[:constants]
+          @verbose_switch = opts[:verbose]
+          @dconstants = opts.dconstants?
+        end
 
-      def output_self
-        mod = interrogatee_mod
-        constants = WrappedModule.new(mod).constants(@verbose_switch)
-        output_section('constants', grep.regexp[format(mod, constants)])
-      end
+        def correct_opts?
+          super || (@no_user_opts && interrogating_a_module?)
+        end
 
-      private
+        def output_self
+          mod = interrogatee_mod
+          constants = WrappedModule.new(mod).constants(@verbose_switch)
+          output_section('constants', grep.regexp[format(mod, constants)])
+        end
 
-      def show_deprecated_constants?
-        @dconstants == true
-      end
+        private
 
-      def format(mod, constants)
-        constants.sort_by(&:downcase).map do |name|
-          if Object.respond_to?(:deprecate_constant) and
-            DEPRECATED_CONSTANTS.include?(name)      and
-            !show_deprecated_constants?
-            next
-          end
+        def show_deprecated_constants?
+          @dconstants == true
+        end
+
+        def format(mod, constants)
+          constants.sort_by(&:downcase).map do |name|
+            if Object.respond_to?(:deprecate_constant) &&
+               DEPRECATED_CONSTANTS.include?(name) &&
+               !show_deprecated_constants?
+              next
+            end
 
-          if (const = (!mod.autoload?(name) && (mod.const_get(name) || true) rescue nil))
-            if (const < Exception rescue false)
-              color(:exception_constant, name)
-            elsif (Module === mod.const_get(name) rescue false)
-              color(:class_constant, name)
+            if (const = (begin
+                           !mod.autoload?(name) && (mod.const_get(name) || true)
+                         rescue StandardError
+                           nil
+                         end))
+              if begin
+                   const < Exception
+                 rescue StandardError
+                   false
+                 end
+                color(:exception_constant, name)
+              elsif begin
+                      mod.const_get(name).is_a?(Module)
+                    rescue StandardError
+                      false
+                    end
+                color(:class_constant, name)
+              else
+                color(:constant, name)
+              end
             else
-              color(:constant, name)
+              color(:unloaded_constant, name)
             end
-          else
-            color(:unloaded_constant, name)
           end
         end
       end