byebug-skipper 0.3.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5d165edc95bf8040d55fa09985c47fb3c85b001b3c739855ec30c20c2a9e6eb6
+  data.tar.gz: 1183e8fbae3dd8785b357ed93365eaaaf17a9de521cb52b08e1366a7abee7e94
+SHA512:
+  metadata.gz: 254077cf9ff026ebf763d2b4f5a4fa061e18241f239aaa228b5a641407e5ac86bc91500547725acce8e794a78a21b7d7e67b5de83fb8cb907bfa46f5d6d5a362
+  data.tar.gz: b5ee026c1455bbab9dea30054548c39f13b1c32258a5a2754a5576d2454d4e9761298af5bd9b5b221ac16c8ecadf7f54d6719bf8eb92824350ea4df07309bfe3

data/lib/byebug/skipper.rb

@@ -0,0 +1,46 @@
+module Byebug::Skipper
+  extend self
+
+  DEFAULT_SKIP_MATCHERS = [
+    %r{/ruby/[^/]+(/bundler)?/gems/}, # gems installed globally or via Bundler
+    %r{/ruby-[^/]+/lib/ruby/[^/]+/}, # Ruby built-in files
+  ].freeze
+
+  def skip_matchers
+    @skip_matchers ||= DEFAULT_SKIP_MATCHERS
+  end
+
+  def skip_matchers=(matchers)
+    @skip_matchers = matchers
+  end
+
+  def skip?(location)
+    skip_matchers.any? { |sm| sm === location }
+  end
+end
+
+require 'delegate'
+require 'byebug'
+require 'byebug/command'
+require 'byebug/helpers/frame'
+require_relative 'skipper/ups_command'
+require_relative 'skipper/downs_command'
+require_relative 'skipper/finishs_command'
+require_relative 'skipper/steps_command'
+
+# Command classes need to be in the Byebug module or else they don't get picked
+# up. Cool, bruh.
+[
+  Byebug::Skipper::UpsCommand,
+  Byebug::Skipper::DownsCommand,
+  Byebug::Skipper::FinishsCommand,
+  Byebug::Skipper::StepsCommand,
+].each do |command_class|
+  Byebug.const_set(
+    command_class.name.split('::').last,
+    command_class,
+  )
+end
+
+require_relative 'skipper/pry' if defined?(PryByebug)
+

data/lib/byebug/skipper/downs_command.rb

@@ -0,0 +1,30 @@
+module Byebug::Skipper
+  # this class is partially copy/pasted from Byebug::DownCommand
+  class DownsCommand < Byebug::Command
+    include Byebug::Helpers::FrameHelper
+
+    self.allow_in_post_mortem = true
+
+    def self.regexp
+      /^ \s* downs \s* $/x
+    end
+
+    def self.short_description
+      "Same as `down` but skips garbage frames, e.g. from gems"
+    end
+
+    def self.description
+      short_description
+    end
+
+    def execute
+      loop do
+        break if out_of_bounds?(context.frame.pos - 1)
+        jump_frames(-1)
+        break if not Byebug::Skipper.skip?(context.location)
+      end
+
+      Byebug::ListCommand.new(processor).execute if Byebug::Setting[:autolist]
+    end
+  end
+end

data/lib/byebug/skipper/finishs_command.rb

@@ -0,0 +1,39 @@
+module Byebug::Skipper
+  # this class is partially copy/pasted from Byebug::FinishsCommand
+  class FinishsCommand < Byebug::Command
+    include Byebug::Helpers::FrameHelper
+
+    self.allow_in_post_mortem = false
+
+    def self.regexp
+      /^ \s* fin(?:ish)?s \s* $/x
+    end
+
+    def self.short_description
+      "Same as `finish` but skips garbage frames, e.g. from gems"
+    end
+
+    def self.description
+      <<~TXT
+        finishs | fins
+
+        #{short_description}
+      TXT
+    end
+
+    def execute
+      frame = context.frame
+
+      loop do
+        frame = Byebug::Frame.new(context, frame.pos + 1)
+        next if frame.c_frame?
+        break if out_of_bounds?(frame.pos)
+        break if not Byebug::Skipper.skip?("#{frame.file}:#{frame.line}")
+      end
+
+      context.step_out(frame.pos, false)
+      context.frame = 0
+      processor.proceed!
+    end
+  end
+end

data/lib/byebug/skipper/pry.rb

@@ -0,0 +1,52 @@
+require_relative '../skipper'
+require 'pry-byebug'
+
+module Byebug::Skipper::Pry
+  COMMAND_NAMES = %w[ups downs steps finishs].freeze
+  COMMANDS_THAT_CONTINUE = %w[steps finishs].freeze
+end
+
+# All the Pry command classes are implemented the same
+Byebug::Skipper::Pry::COMMAND_NAMES.each do |command_name|
+  command_class = Class.new(Pry::ClassCommand) do
+    include ::PryByebug::Helpers::Navigation
+
+    match command_name
+    group "Byebug Skipper"
+    description "Same as Byebug's `#{command_name.chomp('s')}` command but skips garbage frames (e.g. from gems)"
+
+    def process
+      PryByebug.check_file_context(target)
+      # This comes from pry-byebug, and we need to monkey patch it (see below)
+      # to get these custom command names to work properly.
+      breakout_navigation(command_name)
+    end
+  end
+
+  Byebug::Skipper::Pry.const_set("#{command_name.capitalize}Command", command_class)
+  Pry::Commands.add_command(command_class)
+end
+
+# This is a monkey patch for Byebug::PryProcessor in order to add extra Byebug
+# commands to Pry. This needs to be overriden because there is a hard-coded
+# whitelist of `action` values inside, and I need to add custom actions.
+module Byebug::Skipper::Pry::ProcessorHacks
+  def perform(action, options = {})
+    # If it's not one of our commands, short circuit and use the typical
+    # behaviour.
+    return super unless Byebug::Skipper::Pry::COMMAND_NAMES.include?(action.to_s)
+
+    # Call the Byebug command objects directly. This seems kind of fragile to
+    # me, but I don't see any better options.
+    Byebug::Skipper.const_get("#{command_name.capitalize}Command")
+      .new(self, command_name)
+      .execute
+
+    unless Byebug::Skipper::Pry::COMMANDS_THAT_CONTINUE.include?(command_name)
+      # This shows the REPL again, preventing execution from continuing.
+      resume_pry
+    end
+  end
+end
+
+Byebug::PryProcessor.prepend(Byebug::Skipper::Pry::ProcessorHacks)

data/lib/byebug/skipper/steps_command.rb

@@ -0,0 +1,52 @@
+module Byebug::Skipper
+  # this class is partially copy/pasted from Byebug::StepsCommand
+  class StepsCommand < Byebug::Command
+    def self.regexp
+      /^ \s* s(?:tep)?s \s* $/x
+    end
+
+    def self.short_description
+      "Same as `step` but skips garbage frames, e.g. from gems"
+    end
+
+    def self.description
+      short_description
+    end
+
+    def execute
+      HackyProcessor.hack_into(context)
+    end
+
+    private
+
+      # We need to hijack the #at_line method of the processor, to prevent it
+      # from running the REPL when we want it to skip that frame. Sneakily
+      # replaces the processor with this wrapped/delegated version, and then
+      # unwraps/undelegates when no longer necessary.
+      class HackyProcessor < SimpleDelegator
+        def self.hack_into(context)
+          hack = new(context.send(:processor))
+          context.instance_variable_set(:@processor, hack)
+          hack.skip_this_frame!
+        end
+
+        def unhack!
+          context.instance_variable_set(:@processor, __getobj__)
+        end
+
+        def skip_this_frame!
+          context.step_into(1, context.frame.pos)
+          proceed!
+        end
+
+        def at_line
+          if Byebug::Skipper.skip?(context.location)
+            skip_this_frame! # don't stop, keep running
+          else
+            unhack!
+            super # will stop and show REPL
+          end
+        end
+      end
+  end
+end

data/lib/byebug/skipper/ups_command.rb

@@ -0,0 +1,30 @@
+module Byebug::Skipper
+  # this class is partially copy/pasted from Byebug::UpCommand
+  class UpsCommand < Byebug::Command
+    include Byebug::Helpers::FrameHelper
+
+    self.allow_in_post_mortem = true
+
+    def self.regexp
+      /^ \s* ups \s* $/x
+    end
+
+    def self.short_description
+      "Same as `up` but skips garbage frames, e.g. from gems"
+    end
+
+    def self.description
+      short_description
+    end
+
+    def execute
+      loop do
+        break if out_of_bounds?(context.frame.pos + 1)
+        jump_frames(1)
+        break if not Byebug::Skipper.skip?(context.location)
+      end
+
+      Byebug::ListCommand.new(processor).execute if Byebug::Setting[:autolist]
+    end
+  end
+end

data/lib/byebug/skipper/version.rb

@@ -0,0 +1,5 @@
+module Byebug
+  module Skipper
+    VERSION = '0.3.3'
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: byebug-skipper
+version: !ruby/object:Gem::Version
+  version: 0.3.3
+platform: ruby
+authors:
+- Tom Dalling
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Additional commands for Byebug that skip over garbage frames
+email: tom@tomdalling.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/byebug/skipper.rb
+- lib/byebug/skipper/downs_command.rb
+- lib/byebug/skipper/finishs_command.rb
+- lib/byebug/skipper/pry.rb
+- lib/byebug/skipper/steps_command.rb
+- lib/byebug/skipper/ups_command.rb
+- lib/byebug/skipper/version.rb
+homepage: https://github.com/tomdalling/byebug-skipper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Additional commands for Byebug that skip over garbage frames
+test_files: []