pry 0.12.0 → 0.14.0

data/lib/pry/commands/bang.rb

@@ -1,20 +1,24 @@
+# frozen_string_literal: true
+
 class Pry
-  class Command::Bang < Pry::ClassCommand
-    match(/^\s*!\s*$/)
-    group 'Editing'
-    description 'Clear the input buffer.'
-    command_options use_prefix: false
+  class Command
+    class Bang < Pry::ClassCommand
+      match(/^\s*!\s*$/)
+      group 'Editing'
+      description 'Clear the input buffer.'
+      command_options use_prefix: false, listing: '!'
 
-    banner <<-'BANNER'
-      Clear the input buffer. Useful if the parsing process goes wrong and you get
-      stuck in the read loop.
-    BANNER
+      banner <<-'BANNER'
+        Clear the input buffer. Useful if the parsing process goes wrong and you get
+        stuck in the read loop.
+      BANNER
 
-    def process
-      output.puts 'Input buffer cleared!'
-      eval_string.replace('')
+      def process
+        output.puts 'Input buffer cleared!'
+        eval_string.replace('')
+      end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::Bang)
+    Pry::Commands.add_command(Pry::Command::Bang)
+  end
 end

data/lib/pry/commands/bang_pry.rb

@@ -1,17 +1,21 @@
+# frozen_string_literal: true
+
 class Pry
-  class Command::BangPry < Pry::ClassCommand
-    match '!pry'
-    group 'Navigating Pry'
-    description 'Start a Pry session on current self.'
+  class Command
+    class BangPry < Pry::ClassCommand
+      match '!pry'
+      group 'Navigating Pry'
+      description 'Start a Pry session on current self.'
 
-    banner <<-'BANNER'
-      Start a Pry session on current self. Also works mid multi-line expression.
-    BANNER
+      banner <<-'BANNER'
+        Start a Pry session on current self. Also works mid multi-line expression.
+      BANNER
 
-    def process
-      target.pry
+      def process
+        target.pry
+      end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::BangPry)
+    Pry::Commands.add_command(Pry::Command::BangPry)
+  end
 end

data/lib/pry/commands/cat.rb

@@ -1,63 +1,70 @@
+# frozen_string_literal: true
+
 class Pry
-  class Command::Cat < Pry::ClassCommand
-    require 'pry/commands/cat/abstract_formatter.rb'
-    require 'pry/commands/cat/input_expression_formatter.rb'
-    require 'pry/commands/cat/exception_formatter.rb'
-    require 'pry/commands/cat/file_formatter.rb'
-
-    match 'cat'
-    group 'Input and Output'
-    description "Show code from a file, Pry's input buffer, or the last exception."
-
-    banner <<-'BANNER'
-      Usage: cat FILE
-             cat --ex [STACK_INDEX]
-             cat --in [INPUT_INDEX_OR_RANGE]
-
-      `cat` is capable of showing part or all of a source file, the context of the
-      last exception, or an expression from Pry's input history.
-
-      `cat --ex` defaults to showing the lines surrounding the location of the last
-      exception. Invoking it more than once travels up the exception's backtrace, and
-      providing a number shows the context of the given index of the backtrace.
-    BANNER
-
-    def options(opt)
-      opt.on :ex,        "Show the context of the last exception", optional_argument: true, as: Integer
-      opt.on :i, :in,    "Show one or more entries from Pry's expression history", optional_argument: true, as: Range, default: -5..-1
-      opt.on :s, :start, "Starting line (defaults to the first line)", optional_argument: true, as: Integer
-      opt.on :e, :end,   "Ending line (defaults to the last line)", optional_argument: true, as: Integer
-      opt.on :l, :'line-numbers', "Show line numbers"
-      opt.on :t, :type, "The file type for syntax highlighting (e.g., 'ruby' or 'python')", argument: true, as: Symbol
-    end
+  class Command
+    class Cat < Pry::ClassCommand
+      match 'cat'
+      group 'Input and Output'
+      description "Show code from a file, Pry's input buffer, or the last exception."
 
-    def process
-      output = case
-               when opts.present?(:ex)
-                 ExceptionFormatter.new(_pry_.last_exception, _pry_, opts).format
-               when opts.present?(:in)
-                 InputExpressionFormatter.new(_pry_.input_ring, opts).format
-               else
-                 FileFormatter.new(args.first, _pry_, opts).format
-               end
-
-      _pry_.pager.page output
-    end
+      banner <<-'BANNER'
+        Usage: cat FILE
+               cat --ex [STACK_INDEX]
+               cat --in [INPUT_INDEX_OR_RANGE]
 
-    def complete(search)
-      super | load_path_completions
-    end
+        `cat` is capable of showing part or all of a source file, the context of the
+        last exception, or an expression from Pry's input history.
+
+        `cat --ex` defaults to showing the lines surrounding the location of the last
+        exception. Invoking it more than once travels up the exception's backtrace, and
+        providing a number shows the context of the given index of the backtrace.
+      BANNER
+
+      def options(opt)
+        opt.on :ex, "Show the context of the last exception",
+               optional_argument: true, as: Integer
+        opt.on :i, :in, "Show one or more entries from Pry's expression history",
+               optional_argument: true, as: Range, default: -5..-1
+        opt.on :s, :start, "Starting line (defaults to the first line)",
+               optional_argument: true, as: Integer
+        opt.on :e, :end, "Ending line (defaults to the last line)",
+               optional_argument: true, as: Integer
+        opt.on :l, :'line-numbers', "Show line numbers"
+        opt.on :t, :type, "The file type for syntax highlighting " \
+                          "(e.g., 'ruby' or 'python')",
+               argument: true, as: Symbol
+      end
 
-    def load_path_completions
-      $LOAD_PATH.flat_map do |path|
-        Dir[path + '/**/*'].map { |f|
-          next if File.directory?(f)
+      def process
+        output =
+          if opts.present?(:ex)
+            ExceptionFormatter.new(
+              pry_instance.last_exception, pry_instance, opts
+            ).format
+          elsif opts.present?(:in)
+            InputExpressionFormatter.new(pry_instance.input_ring, opts).format
+          else
+            FileFormatter.new(args.first, pry_instance, opts).format
+          end
 
-          f.sub!(path + '/', '')
-        }
+        pry_instance.pager.page output
+      end
+
+      def complete(search)
+        super | load_path_completions
+      end
+
+      def load_path_completions
+        $LOAD_PATH.flat_map do |path|
+          Dir[path + '/**/*'].map do |f|
+            next if File.directory?(f)
+
+            f.sub!(path + '/', '')
+          end
+        end
       end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::Cat)
+    Pry::Commands.add_command(Pry::Command::Cat)
+  end
 end

data/lib/pry/commands/cat/abstract_formatter.rb

@@ -1,26 +1,31 @@
+# frozen_string_literal: true
+
 class Pry
-  class Command::Cat
-    class AbstractFormatter
-      include Pry::Helpers::CommandHelpers
-      include Pry::Helpers::BaseHelpers
+  class Command
+    class Cat
+      class AbstractFormatter
+        include Pry::Helpers::CommandHelpers
+        include Pry::Helpers::BaseHelpers
 
-      private
-      def decorate(content)
-        content.code_type = code_type
-        content.between(*between_lines).
-          with_line_numbers(use_line_numbers?).highlighted
-      end
+        private
 
-      def code_type
-        opts[:type] || :ruby
-      end
+        def decorate(content)
+          content.code_type = code_type
+          content.between(*between_lines)
+            .with_line_numbers(use_line_numbers?).highlighted
+        end
 
-      def use_line_numbers?
-        opts.present?(:'line-numbers') || opts.present?(:ex)
-      end
+        def code_type
+          opts[:type] || :ruby
+        end
+
+        def use_line_numbers?
+          opts.present?(:'line-numbers') || opts.present?(:ex)
+        end
 
-      def between_lines
-        [opts[:start] || 1, opts[:end] || -1]
+        def between_lines
+          [opts[:start] || 1, opts[:end] || -1]
+        end
       end
     end
   end

data/lib/pry/commands/cat/exception_formatter.rb

@@ -1,78 +1,89 @@
+# frozen_string_literal: true
+
 class Pry
-  class Command::Cat
-    class ExceptionFormatter < AbstractFormatter
-      attr_reader :ex
-      attr_reader :opts
-      attr_reader :_pry_
-      include Pry::Helpers::Text
+  class Command
+    class Cat
+      class ExceptionFormatter < AbstractFormatter
+        attr_reader :ex
+        attr_reader :opts
+        attr_reader :pry_instance
+        include Pry::Helpers::Text
 
-      def initialize(exception, _pry_, opts)
-        @ex = exception
-        @opts = opts
-        @_pry_ = _pry_
-      end
+        def initialize(exception, pry_instance, opts)
+          @ex = exception
+          @opts = opts
+          @pry_instance = pry_instance
+        end
 
-      def format
-        check_for_errors
-        set_file_and_dir_locals(backtrace_file, _pry_, _pry_.current_context)
-        code = decorate(Pry::Code.from_file(backtrace_file).
-                                    between(*start_and_end_line_for_code_window).
-                                    with_marker(backtrace_line))
-        "#{header}#{code}"
-      end
+        def format
+          check_for_errors
+          set_file_and_dir_locals(
+            backtrace_file, pry_instance, pry_instance.current_context
+          )
+          code = decorate(
+            Pry::Code.from_file(backtrace_file)
+              .between(*start_and_end_line_for_code_window)
+              .with_marker(backtrace_line)
+          )
+          "#{header}#{code}"
+        end
 
-      private
+        private
 
-      def code_window_size
-        _pry_.config.default_window_size || 5
-      end
+        def code_window_size
+          pry_instance.config.default_window_size || 5
+        end
 
-      def backtrace_level
-        @backtrace_level ||=
-          begin
-            bl =
-              if opts[:ex].nil?
-                ex.bt_index
-              else
-                ex.bt_index = absolute_index_number(opts[:ex], ex.backtrace.size)
-              end
+        def backtrace_level
+          @backtrace_level ||=
+            begin
+              bl =
+                if opts[:ex].nil?
+                  ex.bt_index
+                else
+                  ex.bt_index = absolute_index_number(opts[:ex], ex.backtrace.size)
+                end
 
-            increment_backtrace_level
-            bl
-          end
-      end
+              increment_backtrace_level
+              bl
+            end
+        end
 
-      def increment_backtrace_level
-        ex.inc_bt_index
-      end
+        def increment_backtrace_level
+          ex.inc_bt_index
+        end
 
-      def backtrace_file
-        Array(ex.bt_source_location_for(backtrace_level)).first
-      end
+        def backtrace_file
+          Array(ex.bt_source_location_for(backtrace_level)).first
+        end
 
-      def backtrace_line
-        Array(ex.bt_source_location_for(backtrace_level)).last
-      end
+        def backtrace_line
+          Array(ex.bt_source_location_for(backtrace_level)).last
+        end
 
-      def check_for_errors
-        raise CommandError, "No exception found." unless ex
-        raise CommandError, "The given backtrace level is out of bounds." unless backtrace_file
-      end
+        def check_for_errors
+          raise CommandError, "No exception found." unless ex
+          return if backtrace_file
 
-      def start_and_end_line_for_code_window
-        start_line = backtrace_line - code_window_size
-        start_line = 1 if start_line < 1
+          raise CommandError, "The given backtrace level is out of bounds."
+        end
 
-        [start_line, backtrace_line + code_window_size]
-      end
+        def start_and_end_line_for_code_window
+          start_line = backtrace_line - code_window_size
+          start_line = 1 if start_line < 1
 
-      def header
-        unindent %{
-        #{bold 'Exception:'} #{ex.class}: #{ex.message}
-        --
-        #{bold('From:')} #{backtrace_file} @ line #{backtrace_line} @ #{bold("level: #{backtrace_level}")} of backtrace (of #{ex.backtrace.size - 1}).
+          [start_line, backtrace_line + code_window_size]
+        end
 
-      }
+        def header
+          unindent(
+            "#{bold 'Exception:'} #{ex.class}: #{ex.message}\n" \
+            "--\n" \
+            "#{bold('From:')} #{backtrace_file}:#{backtrace_line} @ " \
+            "#{bold("level: #{backtrace_level}")} of backtrace " \
+            "(of #{ex.backtrace.size - 1}).\n\n"
+          )
+        end
       end
     end
   end

data/lib/pry/commands/cat/file_formatter.rb

@@ -1,69 +1,75 @@
+# frozen_string_literal: true
+
 class Pry
-  class Command::Cat
-    class FileFormatter < AbstractFormatter
-      attr_reader :file_with_embedded_line
-      attr_reader :opts
-      attr_reader :_pry_
+  class Command
+    class Cat
+      class FileFormatter < AbstractFormatter
+        attr_reader :file_with_embedded_line
+        attr_reader :opts
+        attr_reader :pry_instance
 
-      def initialize(file_with_embedded_line, _pry_, opts)
-        raise CommandError, "Must provide a filename, --in, or --ex." if !file_with_embedded_line
+        def initialize(file_with_embedded_line, pry_instance, opts)
+          unless file_with_embedded_line
+            raise CommandError, "Must provide a filename, --in, or --ex."
+          end
 
-        @file_with_embedded_line = file_with_embedded_line
-        @opts = opts
-        @_pry_ = _pry_
-        @code_from_file = Pry::Code.from_file(file_name)
-      end
+          @file_with_embedded_line = file_with_embedded_line
+          @opts = opts
+          @pry_instance = pry_instance
+          @code_from_file = Pry::Code.from_file(file_name)
+        end
 
-      def format
-        set_file_and_dir_locals(file_name, _pry_, _pry_.current_context)
-        decorate(@code_from_file)
-      end
+        def format
+          set_file_and_dir_locals(file_name, pry_instance, pry_instance.current_context)
+          decorate(@code_from_file)
+        end
 
-      def file_and_line
-        file_name, line_num = file_with_embedded_line.split(/:(?!\/|\\)/)
+        def file_and_line
+          file_name, line_num = file_with_embedded_line.split(%r{:(?!/|\\)})
 
-        [file_name, line_num ? line_num.to_i : nil]
-      end
+          [file_name, line_num ? line_num.to_i : nil]
+        end
 
-      private
+        private
 
-      def file_name
-        file_and_line.first
-      end
+        def file_name
+          file_and_line.first
+        end
 
-      def line_number
-        file_and_line.last
-      end
+        def line_number
+          file_and_line.last
+        end
 
-      def code_window_size
-        _pry_.config.default_window_size || 7
-      end
+        def code_window_size
+          pry_instance.config.default_window_size || 7
+        end
 
-      def decorate(content)
-        if line_number
-          super(content.around(line_number, code_window_size))
-        else
-          super
+        def decorate(content)
+          if line_number
+            super(content.around(line_number, code_window_size))
+          else
+            super
+          end
         end
-      end
 
-      def code_type
-        opts[:type] || detect_code_type_from_file(file_name)
-      end
+        def code_type
+          opts[:type] || detect_code_type_from_file(file_name)
+        end
 
-      def detect_code_type_from_file(file_name)
-        code_type = @code_from_file.code_type
+        def detect_code_type_from_file(file_name)
+          code_type = @code_from_file.code_type
 
-        if code_type == :unknown
-          name = File.basename(file_name).split('.', 2).first
-          case name
-          when "Rakefile", "Gemfile"
-            :ruby
+          if code_type == :unknown
+            name = File.basename(file_name).split('.', 2).first
+            case name
+            when "Rakefile", "Gemfile"
+              :ruby
+            else
+              :text
+            end
           else
-            :text
+            code_type
           end
-        else
-          code_type
         end
       end
     end