pry-byebug-reloaded 3.10.1

data/lib/pry/byebug/breakpoints.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+class Pry
+  module Byebug
+    #
+    # Wrapper for Byebug.breakpoints that respects our Processor and has better
+    # failure behavior. Acts as an Enumerable.
+    #
+    module Breakpoints
+      extend Enumerable
+      extend self
+
+      #
+      # Breakpoint in a file:line location
+      #
+      class FileBreakpoint < SimpleDelegator
+        def source_code
+          Pry::Code.from_file(source).around(pos, 3).with_marker(pos)
+        end
+
+        def to_s
+          "#{source} @ #{pos}"
+        end
+      end
+
+      #
+      # Breakpoint in a Class#method location
+      #
+      class MethodBreakpoint < SimpleDelegator
+        def initialize(byebug_bp, method)
+          __setobj__ byebug_bp
+          @method = method
+        end
+
+        def source_code
+          Pry::Code.from_method(Pry::Method.from_str(@method))
+        end
+
+        def to_s
+          @method
+        end
+      end
+
+      def breakpoints
+        @breakpoints ||= []
+      end
+
+      #
+      # Adds a method breakpoint.
+      #
+      def add_method(method, expression = nil)
+        validate_expression expression
+        owner, name = method.split(/[\.#]/)
+        byebug_bp = ::Byebug::Breakpoint.add(owner, name.to_sym, expression)
+        bp = MethodBreakpoint.new byebug_bp, method
+        breakpoints << bp
+        bp
+      end
+
+      #
+      # Adds a file breakpoint.
+      #
+      def add_file(file, line, expression = nil)
+        real_file = (file != Pry.eval_path)
+        raise(ArgumentError, "Invalid file!") if real_file && !File.exist?(file)
+
+        validate_expression expression
+
+        path = (real_file ? File.expand_path(file) : file)
+        bp = FileBreakpoint.new ::Byebug::Breakpoint.add(path, line, expression)
+        breakpoints << bp
+        bp
+      end
+
+      #
+      # Changes the conditional expression for a breakpoint.
+      #
+      def change(id, expression = nil)
+        validate_expression expression
+
+        breakpoint = find_by_id(id)
+        breakpoint.expr = expression
+        breakpoint
+      end
+
+      #
+      # Deletes an existing breakpoint with the given ID.
+      #
+      def delete(id)
+        deleted =
+          ::Byebug::Breakpoint.remove(id) &&
+          breakpoints.delete(find_by_id(id))
+
+        raise(ArgumentError, "No breakpoint ##{id}") unless deleted
+      end
+
+      #
+      # Deletes all breakpoints.
+      #
+      def delete_all
+        @breakpoints = []
+        ::Byebug.breakpoints.clear
+      end
+
+      #
+      # Enables a disabled breakpoint with the given ID.
+      #
+      def enable(id)
+        change_status id, true
+      end
+
+      #
+      # Disables a breakpoint with the given ID.
+      #
+      def disable(id)
+        change_status id, false
+      end
+
+      #
+      # Disables all breakpoints.
+      #
+      def disable_all
+        each do |breakpoint|
+          breakpoint.enabled = false
+        end
+      end
+
+      def to_a
+        breakpoints
+      end
+
+      def size
+        to_a.size
+      end
+
+      def each(&block)
+        to_a.each(&block)
+      end
+
+      def last
+        to_a.last
+      end
+
+      def find_by_id(id)
+        breakpoint = find { |b| b.id == id }
+        raise(ArgumentError, "No breakpoint ##{id}!") unless breakpoint
+
+        breakpoint
+      end
+
+      private
+
+      def change_status(id, enabled = true)
+        breakpoint = find_by_id(id)
+        breakpoint.enabled = enabled
+        breakpoint
+      end
+
+      def validate_expression(exp)
+        valid = exp && (exp.empty? || !Pry::Code.complete_expression?(exp))
+        return unless valid
+
+        raise("Invalid breakpoint conditional: #{expression}")
+      end
+    end
+  end
+end

data/lib/pry-byebug/base.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "pry-byebug/helpers/location"
+
+#
+# Main container module for Pry-Byebug functionality
+#
+module PryByebug
+  # Reference to currently running pry-remote server. Used by the processor.
+  attr_accessor :current_remote_server
+
+  module_function
+
+  #
+  # Checks that a target binding is in a local file context.
+  #
+  def file_context?(target)
+    file = Helpers::Location.current_file(target)
+    file == Pry.eval_path || !Pry::Helpers::BaseHelpers.not_a_real_file?(file)
+  end
+
+  #
+  # Ensures that a command is executed in a local file context.
+  #
+  def check_file_context(target, msg = nil)
+    msg ||= "Cannot find local context. Did you use `binding.pry`?"
+    raise(Pry::CommandError, msg) unless file_context?(target)
+  end
+end

data/lib/pry-byebug/cli.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "pry-byebug/base"
+require "pry-byebug/pry_ext"
+require "pry-byebug/commands"
+require "pry-byebug/control_d_handler"

data/lib/pry-byebug/commands/backtrace.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "pry-byebug/helpers/navigation"
+
+module PryByebug
+  #
+  # Display the current stack
+  #
+  class BacktraceCommand < Pry::ClassCommand
+    include Helpers::Navigation
+
+    match "backtrace"
+    group "Byebug"
+
+    description "Display the current stack."
+
+    banner <<-BANNER
+      Usage: backtrace
+
+      Display the current stack.
+    BANNER
+
+    def process
+      PryByebug.check_file_context(target)
+
+      breakout_navigation :backtrace
+    end
+  end
+end
+
+Pry::Commands.add_command(PryByebug::BacktraceCommand)

data/lib/pry-byebug/commands/breakpoint.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require "pry/byebug/breakpoints"
+require "pry-byebug/helpers/breakpoints"
+require "pry-byebug/helpers/location"
+require "pry-byebug/helpers/multiline"
+
+module PryByebug
+  #
+  # Add, show and remove breakpoints
+  #
+  class BreakCommand < Pry::ClassCommand
+    include Helpers::Breakpoints
+    include Helpers::Location
+    include Helpers::Multiline
+
+    match "break"
+    group "Byebug"
+    description "Set or edit a breakpoint."
+
+    banner <<-BANNER
+      Usage:   break <METHOD | FILE:LINE | LINE> [if CONDITION]
+               break --condition N [CONDITION]
+               break [--show | --delete | --enable | --disable] N
+               break [--delete-all | --disable-all]
+               break
+
+      Set a breakpoint. Accepts a line number in the current file, a file and
+      line number, or a method, and an optional condition.
+
+      Pass appropriate flags to manipulate existing breakpoints.
+
+      Examples:
+
+        break SomeClass#run         Break at the start of `SomeClass#run`.
+        break Foo#bar if baz?       Break at `Foo#bar` only if `baz?`.
+        break app/models/user.rb:15 Break at line 15 in user.rb.
+        break 14                    Break at line 14 in the current file.
+
+        break --condition 4 x > 2   Add/change condition on breakpoint #4.
+        break --condition 3         Remove the condition on breakpoint #3.
+
+        break --delete 5            Delete breakpoint #5.
+        break --disable-all         Disable all breakpoints.
+
+        break --show 2              Show details about breakpoint #2.
+        break                       List all breakpoints.
+    BANNER
+
+    def options(opt)
+      defaults = { argument: true, as: Integer }
+
+      opt.on :c, :condition, "Change condition of a breakpoint.", defaults
+      opt.on :s, :show, "Show breakpoint details and source.", defaults
+      opt.on :D, :delete, "Delete a breakpoint.", defaults
+      opt.on :d, :disable, "Disable a breakpoint.", defaults
+      opt.on :e, :enable, "Enable a disabled breakpoint.", defaults
+      opt.on :'disable-all', "Disable all breakpoints."
+      opt.on :'delete-all', "Delete all breakpoints."
+    end
+
+    def process
+      return if check_multiline_context
+
+      PryByebug.check_file_context(target)
+
+      option, = opts.to_hash.find { |key, _value| opts.present?(key) }
+      return send(option_to_method(option)) if option
+
+      return new_breakpoint unless args.empty?
+
+      print_all
+    end
+
+    private
+
+    %w[delete disable enable disable_all delete_all].each do |command|
+      define_method(:"process_#{command}") do
+        breakpoints.send(*[command, opts[command]].compact)
+        print_all
+      end
+    end
+
+    def process_show
+      print_full_breakpoint(breakpoints.find_by_id(opts[:show]))
+    end
+
+    def process_condition
+      expr = args.empty? ? nil : args.join(" ")
+      breakpoints.change(opts[:condition], expr)
+    end
+
+    def new_breakpoint
+      place = args.shift
+      condition = args.join(" ") if args.shift == "if"
+
+      bp = add_breakpoint(place, condition)
+
+      print_full_breakpoint(bp)
+    end
+
+    def option_to_method(option)
+      "process_#{option.to_s.tr('-', '_')}"
+    end
+
+    def print_all
+      print_breakpoints_header
+      breakpoints.each { |b| print_short_breakpoint(b) }
+    end
+
+    def add_breakpoint(place, condition)
+      case place
+      when /^(\d+)$/
+        errmsg = "Line number declaration valid only in a file context."
+        PryByebug.check_file_context(target, errmsg)
+
+        lineno = Regexp.last_match[1].to_i
+        breakpoints.add_file(current_file, lineno, condition)
+      when /^(.+):(\d+)$/
+        file = Regexp.last_match[1]
+        lineno = Regexp.last_match[2].to_i
+        breakpoints.add_file(file, lineno, condition)
+      when /^(.*)[.#].+$/ # Method or class name
+        if Regexp.last_match[1].strip.empty?
+          errmsg = "Method name declaration valid only in a file context."
+          PryByebug.check_file_context(target, errmsg)
+          place = target.eval("self.class.to_s") + place
+        end
+        breakpoints.add_method(place, condition)
+      else
+        raise(ArgumentError, "Cannot identify arguments as breakpoint")
+      end
+    end
+  end
+end
+
+Pry::Commands.add_command(PryByebug::BreakCommand)

data/lib/pry-byebug/commands/continue.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "pry-byebug/helpers/navigation"
+require "pry-byebug/helpers/breakpoints"
+require "pry-byebug/helpers/location"
+
+module PryByebug
+  #
+  # Continue program execution until the next breakpoint
+  #
+  class ContinueCommand < Pry::ClassCommand
+    include Helpers::Navigation
+    include Helpers::Breakpoints
+    include Helpers::Location
+
+    match "continue"
+    group "Byebug"
+    description "Continue program execution and end the Pry session."
+
+    banner <<-BANNER
+      Usage: continue [LINE]
+
+      Continue program execution until the next breakpoint, or the program
+      ends. Optionally continue to the specified line number.
+
+      Examples:
+        continue   #=> Continue until the next breakpoint.
+        continue 4 #=> Continue to line number 4.
+    BANNER
+
+    def process
+      PryByebug.check_file_context(target)
+
+      breakpoints.add_file(current_file, args.first.to_i) if args.first
+
+      breakout_navigation :continue
+    ensure
+      Byebug.stop if Byebug.stoppable?
+    end
+  end
+end
+
+Pry::Commands.add_command(PryByebug::ContinueCommand)

data/lib/pry-byebug/commands/down.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "pry-byebug/helpers/navigation"
+
+module PryByebug
+  #
+  # Travel down the frame stack
+  #
+  class DownCommand < Pry::ClassCommand
+    include Helpers::Navigation
+
+    match "down"
+    group "Byebug"
+
+    description "Move current frame down."
+
+    banner <<-BANNER
+      Usage: down [TIMES]
+
+      Move current frame down. By default, moves by 1 frame.
+
+      Examples:
+        down   #=> Move down 1 frame.
+        down 5 #=> Move down 5 frames.
+    BANNER
+
+    def process
+      PryByebug.check_file_context(target)
+
+      breakout_navigation :down, times: args.first
+    end
+  end
+end
+
+Pry::Commands.add_command(PryByebug::DownCommand)

data/lib/pry-byebug/commands/exit_all.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "pry/commands/exit_all"
+
+module PryByebug
+  #
+  # Exit pry REPL with Byebug.stop
+  #
+  class ExitAllCommand < Pry::Command::ExitAll
+    def process
+      super
+    ensure
+      Byebug.stop if Byebug.stoppable?
+    end
+  end
+end
+
+Pry::Commands.add_command(PryByebug::ExitAllCommand)

data/lib/pry-byebug/commands/finish.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "pry-byebug/helpers/navigation"
+
+module PryByebug
+  #
+  # Run until the end of current frame
+  #
+  class FinishCommand < Pry::ClassCommand
+    include PryByebug::Helpers::Navigation
+
+    match "finish"
+    group "Byebug"
+    description "Execute until current stack frame returns."
+
+    banner <<-BANNER
+      Usage: finish
+    BANNER
+
+    def process
+      PryByebug.check_file_context(target)
+
+      breakout_navigation :finish
+    end
+  end
+end
+
+Pry::Commands.add_command(PryByebug::FinishCommand)

data/lib/pry-byebug/commands/frame.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "pry-byebug/helpers/navigation"
+
+module PryByebug
+  #
+  # Move to a specific frame in the callstack
+  #
+  class FrameCommand < Pry::ClassCommand
+    include Helpers::Navigation
+
+    match "frame"
+    group "Byebug"
+
+    description "Move to specified frame #."
+
+    banner <<-BANNER
+        Usage: frame [TIMES]
+
+        Move to specified frame #.
+
+        Examples:
+          frame   #=> Show current frame #.
+          frame 5 #=> Move to frame 5.
+    BANNER
+
+    def process
+      PryByebug.check_file_context(target)
+
+      breakout_navigation :frame, index: args.first
+    end
+  end
+end
+
+Pry::Commands.add_command(PryByebug::FrameCommand)

data/lib/pry-byebug/commands/next.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "pry-byebug/helpers/navigation"
+require "pry-byebug/helpers/multiline"
+
+module PryByebug
+  #
+  # Run a number of lines and then stop again
+  #
+  class NextCommand < Pry::ClassCommand
+    include Helpers::Navigation
+    include Helpers::Multiline
+
+    match "next"
+    group "Byebug"
+    description "Execute the next line within the current stack frame."
+
+    banner <<-BANNER
+      Usage: next [LINES]
+
+      Step over within the same frame. By default, moves forward a single
+      line.
+
+      Examples:
+        next   #=> Move a single line forward.
+        next 4 #=> Execute the next 4 lines.
+    BANNER
+
+    def process
+      return if check_multiline_context
+
+      PryByebug.check_file_context(target)
+
+      breakout_navigation :next, lines: args.first
+    end
+  end
+end
+
+Pry::Commands.add_command(PryByebug::NextCommand)

data/lib/pry-byebug/commands/step.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "pry-byebug/helpers/navigation"
+
+module PryByebug
+  #
+  # Run a number of Ruby statements and then stop again
+  #
+  class StepCommand < Pry::ClassCommand
+    include Helpers::Navigation
+
+    match "step"
+    group "Byebug"
+    description "Step execution into the next line or method."
+
+    banner <<-BANNER
+        Usage: step [TIMES]
+
+        Step execution forward. By default, moves a single step.
+
+        Examples:
+          step   #=> Move a single step forward.
+          step 5 #=> Execute the next 5 steps.
+    BANNER
+
+    def process
+      PryByebug.check_file_context(target)
+
+      breakout_navigation :step, times: args.first
+    end
+  end
+end
+
+Pry::Commands.add_command(PryByebug::StepCommand)

data/lib/pry-byebug/commands/up.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "pry-byebug/helpers/navigation"
+
+module PryByebug
+  #
+  # Travel up the frame stack
+  #
+  class UpCommand < Pry::ClassCommand
+    include Helpers::Navigation
+
+    match "up"
+    group "Byebug"
+
+    description "Move current frame up."
+
+    banner <<-BANNER
+      Usage: up [TIMES]
+
+      Move current frame up. By default, moves by 1 frame.
+
+      Examples:
+        up   #=> Move up 1 frame.
+        up 5 #=> Move up 5 frames.
+    BANNER
+
+    def process
+      PryByebug.check_file_context(target)
+
+      breakout_navigation :up, times: args.first
+    end
+  end
+end
+
+Pry::Commands.add_command(PryByebug::UpCommand)

data/lib/pry-byebug/commands.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "pry-byebug/commands/backtrace"
+require "pry-byebug/commands/next"
+require "pry-byebug/commands/step"
+require "pry-byebug/commands/continue"
+require "pry-byebug/commands/finish"
+require "pry-byebug/commands/up"
+require "pry-byebug/commands/down"
+require "pry-byebug/commands/frame"
+require "pry-byebug/commands/breakpoint"
+require "pry-byebug/commands/exit_all"

data/lib/pry-byebug/control_d_handler.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+original_handler = Pry.config.control_d_handler
+
+Pry.config.control_d_handler = proc do |pry_instance|
+  Byebug.stop if Byebug.stoppable?
+
+  original_handler.call(pry_instance)
+end