pry 0.12.0 → 0.14.0

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

@@ -1,42 +1,47 @@
+# frozen_string_literal: true
+
 class Pry
-  class Command::Cat
-    class InputExpressionFormatter < AbstractFormatter
-      attr_accessor :input_expressions
-      attr_accessor :opts
-
-      def initialize(input_expressions, opts)
-        @input_expressions = input_expressions
-        @opts = opts
-      end
+  class Command
+    class Cat
+      class InputExpressionFormatter < AbstractFormatter
+        attr_accessor :input_expressions
+        attr_accessor :opts
+
+        def initialize(input_expressions, opts)
+          @input_expressions = input_expressions
+          @opts = opts
+        end
 
-      def format
-        raise CommandError, "No input expressions!" if numbered_input_items.length < 1
+        def format
+          raise CommandError, "No input expressions!" if numbered_input_items.empty?
 
-        if numbered_input_items.length > 1
-          content = ""
-          numbered_input_items.each do |i, s|
-            content << "#{Helpers::Text.bold(i.to_s)}:\n" << decorate(Pry::Code(s).with_indentation(2)).to_s
-          end
+          if numbered_input_items.length > 1
+            content = ''
+            numbered_input_items.each do |i, s|
+              content += "#{Helpers::Text.bold(i.to_s)}:\n"
+              content += decorate(Pry::Code(s).with_indentation(2)).to_s
+            end
 
-          content
-        else
-          decorate(Pry::Code(selected_input_items.first))
+            content
+          else
+            decorate(Pry::Code(selected_input_items.first))
+          end
         end
-      end
 
-      private
+        private
 
-      def selected_input_items
-        input_expressions[normalized_expression_range] || []
-      end
+        def selected_input_items
+          input_expressions[normalized_expression_range] || []
+        end
 
-      def numbered_input_items
-        @numbered_input_items ||= normalized_expression_range.zip(selected_input_items).
-          reject { |_, s| s.nil? || s == "" }
-      end
+        def numbered_input_items
+          @numbered_input_items ||= normalized_expression_range.zip(selected_input_items)
+            .reject { |_, s| s.nil? || s == "" }
+        end
 
-      def normalized_expression_range
-        absolute_index_range(opts[:i], input_expressions.count)
+        def normalized_expression_range
+          absolute_index_range(opts[:i], input_expressions.count)
+        end
       end
     end
   end

data/lib/pry/commands/cd.rb

@@ -1,41 +1,46 @@
-class Pry
-  class Command::Cd < Pry::ClassCommand
-    match 'cd'
-    group 'Context'
-    description 'Move into a new context (object or scope).'
-
-    banner <<-'BANNER'
-      Usage: cd [OPTIONS] [--help]
-
-      Move into new context (object or scope). As in UNIX shells use `cd ..` to go
-      back, `cd /` to return to Pry top-level and `cd -` to toggle between last two
-      scopes. Complex syntax (e.g `cd ../@x/@y`) also supported.
-
-      cd @x
-      cd ..
-      cd /
-      cd -
-
-      https://github.com/pry/pry/wiki/State-navigation#wiki-Changing_scope
-    BANNER
-
-    def process
-      state.old_stack ||= []
+# frozen_string_literal: true
 
-      if arg_string.strip == "-"
-        unless state.old_stack.empty?
-          _pry_.binding_stack, state.old_stack = state.old_stack, _pry_.binding_stack
-        end
-      else
-        stack = ObjectPath.new(arg_string, _pry_.binding_stack).resolve
-
-        if stack && stack != _pry_.binding_stack
-          state.old_stack = _pry_.binding_stack
-          _pry_.binding_stack = stack
+class Pry
+  class Command
+    class Cd < Pry::ClassCommand
+      match 'cd'
+      group 'Context'
+      description 'Move into a new context (object or scope).'
+
+      banner <<-'BANNER'
+        Usage: cd [OPTIONS] [--help]
+
+        Move into new context (object or scope). As in UNIX shells use `cd ..` to go
+        back, `cd /` to return to Pry top-level and `cd -` to toggle between last two
+        scopes. Complex syntax (e.g `cd ../@x/@y`) also supported.
+
+        cd @x
+        cd ..
+        cd /
+        cd -
+
+        https://github.com/pry/pry/wiki/State-navigation#wiki-Changing_scope
+      BANNER
+
+      def process
+        state.old_stack ||= []
+
+        if arg_string.strip == "-"
+          unless state.old_stack.empty?
+            pry_instance.binding_stack, state.old_stack =
+              state.old_stack, pry_instance.binding_stack
+          end
+        else
+          stack = ObjectPath.new(arg_string, pry_instance.binding_stack).resolve
+
+          if stack && stack != pry_instance.binding_stack
+            state.old_stack = pry_instance.binding_stack
+            pry_instance.binding_stack = stack
+          end
         end
       end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::Cd)
+    Pry::Commands.add_command(Pry::Command::Cd)
+  end
 end

data/lib/pry/commands/change_inspector.rb

@@ -1,27 +1,34 @@
-class Pry::Command::ChangeInspector < Pry::ClassCommand
-  match 'change-inspector'
-  group 'Input and Output'
-  description 'Change the current inspector proc.'
-  command_options argument_required: true
-  banner <<-BANNER
-    Usage: change-inspector NAME
+# frozen_string_literal: true
 
-    Change the proc used to print return values. See list-inspectors for a list
-    of available procs and a short description of what each one does.
-  BANNER
+class Pry
+  class Command
+    class ChangeInspector < Pry::ClassCommand
+      match 'change-inspector'
+      group 'Input and Output'
+      description 'Change the current inspector proc.'
+      command_options argument_required: true
+      banner <<-BANNER
+        Usage: change-inspector NAME
 
-  def process(inspector)
-    if inspector_map.key?(inspector)
-      _pry_.print = inspector_map[inspector][:value]
-      output.puts "Switched to the '#{inspector}' inspector!"
-    else
-      raise Pry::CommandError, "'#{inspector}' isn't a known inspector!"
-    end
-  end
+        Change the proc used to print return values. See list-inspectors for a list
+        of available procs and a short description of what each one does.
+      BANNER
+
+      def process(inspector)
+        unless inspector_map.key?(inspector)
+          raise Pry::CommandError, "'#{inspector}' isn't a known inspector!"
+        end
 
-private
-  def inspector_map
-    Pry::Inspector::MAP
+        pry_instance.print = inspector_map[inspector][:value]
+        output.puts "Switched to the '#{inspector}' inspector!"
+      end
+
+      private
+
+      def inspector_map
+        Pry::Inspector::MAP
+      end
+      Pry::Commands.add_command(self)
+    end
   end
-  Pry::Commands.add_command(self)
 end

data/lib/pry/commands/change_prompt.rb

@@ -1,46 +1,51 @@
-class Pry::Command::ChangePrompt < Pry::ClassCommand
-  match 'change-prompt'
-  group 'Input and Output'
-  description 'Change the current prompt.'
-  command_options argument_required: true
-  banner <<-BANNER
-    Usage: change-prompt [OPTIONS] [NAME]
-
-    Change the current prompt.
-  BANNER
-
-  def options(opt)
-    opt.on(:l, :list, 'List the available prompts')
-  end
+# frozen_string_literal: true
 
-  def process(prompt)
-    if opts.present?(:l)
-      list_prompts
-    else
-      change_prompt(prompt)
-    end
-  end
+class Pry
+  class Command
+    class ChangePrompt < Pry::ClassCommand
+      match 'change-prompt'
+      group 'Input and Output'
+      description 'Change the current prompt.'
+      command_options argument_required: true
+      banner <<-BANNER
+        Usage: change-prompt [OPTIONS] [NAME]
 
-  private
+        Change the current prompt.
+      BANNER
 
-  def list_prompts
-    prompts = Pry::Prompt.all.map do |name, prompt|
-      "#{bold(name)}#{red(' (selected)') if _pry_.prompt == prompt[:value]}\n" +
-        prompt[:description]
-    end
-    output.puts(prompts.join("\n"))
-  end
+      def options(opt)
+        opt.on(:l, :list, 'List the available prompts')
+      end
 
-  def change_prompt(prompt)
-    if Pry::Prompt.all.key?(prompt)
-      _pry_.prompt = Pry::Prompt.all[prompt][:value]
-    else
-      raise(Pry::CommandError, <<MSG)
-'#{prompt}' isn't a known prompt. Run `change-prompt --list` to see
-the list of known prompts.
-MSG
+      def process(prompt)
+        if opts.present?(:l)
+          list_prompts
+        else
+          change_prompt(prompt)
+        end
+      end
+
+      private
+
+      def list_prompts
+        prompts = Pry::Prompt.all.map do |name, prompt|
+          "#{bold(name)}#{red(' (selected)') if pry_instance.prompt == prompt}\n" +
+            prompt.description
+        end
+        output.puts(prompts.join("\n" * 2))
+      end
+
+      def change_prompt(prompt)
+        if Pry::Prompt[prompt]
+          pry_instance.prompt = Pry::Prompt[prompt]
+        else
+          raise Pry::CommandError,
+                "'#{prompt}' isn't a known prompt. Run `change-prompt --list` " \
+                "to see the list of known prompts."
+        end
+      end
+
+      Pry::Commands.add_command(self)
     end
   end
-
-  Pry::Commands.add_command(self)
 end

data/lib/pry/commands/clear_screen.rb

@@ -1,14 +1,20 @@
-class Pry::Command::ClearScreen < Pry::ClassCommand
-  match 'clear-screen'
-  group 'Input and Output'
-  description 'Clear the contents of the screen/window Pry is running in.'
+# frozen_string_literal: true
 
-  def process
-    if Helpers::Platform.windows?
-      _pry_.config.system.call(_pry_.output, 'cls', _pry_)
-    else
-      _pry_.config.system.call(_pry_.output, 'clear', _pry_)
+class Pry
+  class Command
+    class ClearScreen < Pry::ClassCommand
+      match 'clear-screen'
+      group 'Input and Output'
+      description 'Clear the contents of the screen/window Pry is running in.'
+
+      def process
+        if Pry::Helpers::Platform.windows?
+          pry_instance.config.system.call(pry_instance.output, 'cls', pry_instance)
+        else
+          pry_instance.config.system.call(pry_instance.output, 'clear', pry_instance)
+        end
+      end
+      Pry::Commands.add_command(self)
     end
   end
-  Pry::Commands.add_command(self)
 end

data/lib/pry/commands/code_collector.rb

@@ -1,166 +1,181 @@
-class Pry
-  class Command::CodeCollector
-    include Helpers::CommandHelpers
+# frozen_string_literal: true
 
-    attr_reader :args
-    attr_reader :opts
-    attr_reader :_pry_
+class Pry
+  class Command
+    class CodeCollector
+      include Helpers::CommandHelpers
 
-    # The name of the explicitly given file (if any).
-    attr_accessor :file
+      attr_reader :args
+      attr_reader :opts
+      attr_reader :pry_instance
 
-    class << self
-      attr_accessor :input_expression_ranges
-      attr_accessor :output_result_ranges
-    end
+      # The name of the explicitly given file (if any).
+      attr_accessor :file
 
-    @input_expression_ranges = []
-    @output_result_ranges = []
-
-    def initialize(args, opts, _pry_)
-      @args = args
-      @opts = opts
-      @_pry_ = _pry_
-    end
+      class << self
+        attr_accessor :input_expression_ranges
+        attr_accessor :output_result_ranges
+      end
 
-    # Add the `--lines`, `-o`, `-i`, `-s`, `-d` options.
-    def self.inject_options(opt)
       @input_expression_ranges = []
       @output_result_ranges = []
 
-      opt.on :l, :lines, "Restrict to a subset of lines. Takes a line number or range",
-                         optional_argument: true, as: Range, default: 1..-1
-      opt.on :o, :out,   "Select lines from Pry's output result history. Takes an index or range",
-      optional_argument: true, as: Range, default: -5..-1 do |r|
-        output_result_ranges << (r || (-5..-1))
-      end
-      opt.on :i, :in,    "Select lines from Pry's input expression history. Takes an index or range",
-      optional_argument: true, as: Range, default: -5..-1 do |r|
-        input_expression_ranges << (r || (-5..-1))
+      def initialize(args, opts, pry_instance)
+        @args = args
+        @opts = opts
+        @pry_instance = pry_instance
       end
-      opt.on :s, :super, "Select the 'super' method. Can be repeated to traverse the ancestors",
-                         as: :count
-      opt.on :d, :doc,   "Select lines from the code object's documentation"
-    end
 
-    # The content (i.e code/docs) for the selected object.
-    # If the user provided a bare code object, it returns the source.
-    # If the user provided the `-i` or `-o` switches, it returns the
-    # selected input/output lines joined as a string. If the user used
-    # `-d CODE_OBJECT` it returns the docs for that code object.
-    #
-    # @return [String]
-    def content
-      @content ||=
-        begin
-          raise CommandError, "Only one of --out, --in, --doc and CODE_OBJECT may be specified." if bad_option_combination?
-
-          content = case
-                    when opts.present?(:o)
-                      pry_output_content
-                    when opts.present?(:i)
-                      pry_input_content
-                    when opts.present?(:d)
-                      code_object_doc
-                    else
-                      code_object_source_or_file
-                    end
-
-          restrict_to_lines(content, line_range)
+      # Add the `--lines`, `-o`, `-i`, `-s`, `-d` options.
+      def self.inject_options(opt)
+        @input_expression_ranges = []
+        @output_result_ranges = []
+
+        opt.on :l, :lines, "Restrict to a subset of lines. Takes a line number " \
+                           "or range",
+               optional_argument: true, as: Range, default: 1..-1
+        opt.on :o, :out, "Select lines from Pry's output result history. " \
+                         "Takes an index or range",
+               optional_argument: true, as: Range, default: -5..-1 do |r|
+          output_result_ranges << (r || (-5..-1))
         end
-    end
+        opt.on :i, :in, "Select lines from Pry's input expression history. " \
+                        "Takes an index or range",
+               optional_argument: true, as: Range, default: -5..-1 do |r|
+          input_expression_ranges << (r || (-5..-1))
+        end
+        opt.on :s, :super, "Select the 'super' method. Can be repeated to " \
+                           "traverse the ancestors",
+               as: :count
+        opt.on :d, :doc, "Select lines from the code object's documentation"
+      end
 
-    # The code object
-    #
-    # @return [Pry::WrappedModule, Pry::Method, Pry::Command]
-    def code_object
-      Pry::CodeObject.lookup(obj_name, _pry_, super: opts[:super])
-    end
+      # The content (i.e code/docs) for the selected object.
+      # If the user provided a bare code object, it returns the source.
+      # If the user provided the `-i` or `-o` switches, it returns the
+      # selected input/output lines joined as a string. If the user used
+      # `-d CODE_OBJECT` it returns the docs for that code object.
+      #
+      # @return [String]
+      def content
+        @content ||=
+          begin
+            if bad_option_combination?
+              raise CommandError,
+                    "Only one of --out, --in, --doc and CODE_OBJECT may " \
+                    "be specified."
+            end
+
+            content = if opts.present?(:o)
+                        pry_output_content
+                      elsif opts.present?(:i)
+                        pry_input_content
+                      elsif opts.present?(:d)
+                        code_object_doc
+                      else
+                        code_object_source_or_file
+                      end
+
+            restrict_to_lines(content, line_range)
+          end
+      end
 
-    # Given a string and a range, return the `range` lines of that
-    # string.
-    #
-    # @param [String] content
-    # @param [Range, Fixnum] range
-    # @return [String] The string restricted to the given range
-    def restrict_to_lines(content, range)
-      Array(content.lines.to_a[range]).join
-    end
+      # The code object
+      #
+      # @return [Pry::WrappedModule, Pry::Method, Pry::Command]
+      def code_object
+        Pry::CodeObject.lookup(obj_name, pry_instance, super: opts[:super])
+      end
 
-    # The selected `_pry_.output_ring` as a string, as specified by
-    # the `-o` switch.
-    #
-    # @return [String]
-    def pry_output_content
-      pry_array_content_as_string(_pry_.output_ring, self.class.output_result_ranges) do |v|
-        _pry_.config.gist.inspecter.call(v)
+      # Given a string and a range, return the `range` lines of that
+      # string.
+      #
+      # @param [String] content
+      # @param [Range, Fixnum] range
+      # @return [String] The string restricted to the given range
+      def restrict_to_lines(content, range)
+        Array(content.lines.to_a[range]).join
       end
-    end
 
-    # The selected `_pry_.input_ring` as a string, as specified by
-    # the `-i` switch.
-    #
-    # @return [String]
-    def pry_input_content
-      pry_array_content_as_string(_pry_.input_ring, self.class.input_expression_ranges) { |v| v }
-    end
+      # The selected `pry_instance.output_ring` as a string, as specified by
+      # the `-o` switch.
+      #
+      # @return [String]
+      def pry_output_content
+        pry_array_content_as_string(
+          pry_instance.output_ring,
+          self.class.output_result_ranges,
+          &:pretty_inspect
+        )
+      end
 
-    # The line range passed to `--lines`, converted to a 0-indexed range.
-    def line_range
-      opts.present?(:lines) ? one_index_range_or_number(opts[:lines]) : 0..-1
-    end
+      # The selected `pry_instance.input_ring` as a string, as specified by
+      # the `-i` switch.
+      #
+      # @return [String]
+      def pry_input_content
+        pry_array_content_as_string(
+          pry_instance.input_ring, self.class.input_expression_ranges
+        ) { |v| v }
+      end
 
-    # Name of the object argument
-    def obj_name
-      @obj_name ||= args.empty? ? "" : args.join(" ")
-    end
+      # The line range passed to `--lines`, converted to a 0-indexed range.
+      def line_range
+        opts.present?(:lines) ? one_index_range_or_number(opts[:lines]) : 0..-1
+      end
 
-    private
+      # Name of the object argument
+      def obj_name
+        @obj_name ||= args.empty? ? "" : args.join(" ")
+      end
 
-    def bad_option_combination?
-      [opts.present?(:in), opts.present?(:out),
-       !args.empty?].count(true) > 1
-    end
+      private
 
-    def pry_array_content_as_string(array, ranges, &block)
-      all = ''
-      ranges.each do |range|
-        raise CommandError, "Minimum value for range is 1, not 0." if convert_to_range(range).first == 0
+      def bad_option_combination?
+        [opts.present?(:in), opts.present?(:out),
+         !args.empty?].count(true) > 1
+      end
+
+      def pry_array_content_as_string(array, ranges)
+        all = ''
+        ranges.each do |range|
+          if convert_to_range(range).first == 0
+            raise CommandError, "Minimum value for range is 1, not 0."
+          end
+
+          ranged_array = Array(array[range]) || []
+          ranged_array.compact.each { |v| all += yield(v) }
+        end
 
-        ranged_array = Array(array[range]) || []
-        ranged_array.compact.each { |v| all << block.call(v) }
+        all
       end
 
-      all
-    end
+      def code_object_doc
+        (code_object && code_object.doc) || could_not_locate(obj_name)
+      end
 
-    def code_object_doc
-      (code_object && code_object.doc) or could_not_locate(obj_name)
-    end
+      def code_object_source_or_file
+        (code_object && code_object.source) || file_content
+      end
 
-    def code_object_source_or_file
-      (code_object && code_object.source) || file_content
-    end
+      def file_content
+        if File.exist?(obj_name)
+          # Set the file accessor.
+          self.file = obj_name
+          File.read(obj_name)
+        else
+          could_not_locate(obj_name)
+        end
+      end
 
-    def file_content
-      if File.exist?(obj_name)
-        # Set the file accessor.
-        self.file = obj_name
-        File.read(obj_name)
-      else
-        could_not_locate(obj_name)
+      def could_not_locate(name)
+        raise CommandError, "Cannot locate: #{name}!"
       end
-    end
 
-    def could_not_locate(name)
-      raise CommandError, "Cannot locate: #{name}!"
-    end
+      def convert_to_range(range)
+        return range if range.is_a?(Range)
 
-    def convert_to_range(n)
-      if !n.is_a?(Range)
-        (n..n)
-      else
-        n
+        (range..range)
       end
     end
   end