byebug-skipper 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d165edc95bf8040d55fa09985c47fb3c85b001b3c739855ec30c20c2a9e6eb6
-  data.tar.gz: 1183e8fbae3dd8785b357ed93365eaaaf17a9de521cb52b08e1366a7abee7e94
+  metadata.gz: 25d8edd230ae69ad9219645ecc06700487d398b5aa024e7ee542e5f48a41c056
+  data.tar.gz: b4ff72166a36cab63a0b105f9c3f4ee11aa245d82717a6e19fa69587a93f11a2
 SHA512:
-  metadata.gz: 254077cf9ff026ebf763d2b4f5a4fa061e18241f239aaa228b5a641407e5ac86bc91500547725acce8e794a78a21b7d7e67b5de83fb8cb907bfa46f5d6d5a362
-  data.tar.gz: b5ee026c1455bbab9dea30054548c39f13b1c32258a5a2754a5576d2454d4e9761298af5bd9b5b221ac16c8ecadf7f54d6719bf8eb92824350ea4df07309bfe3
+  metadata.gz: 819cf45b6f634c7c78698c97aa81a5272eef2e17617560dfbe0a26fcd0aee729dcdf5ed2797e5ea50b2aa538ca87be9dd5d18a6387070b60df9a750f54370321
+  data.tar.gz: 107a6cf23cf5a1ec06993a1a6ff6458dd09e1813b4ed3c608aa29b749c071de08531276439166974c682c9cbe30ae7ee1091c721c58924b8cbdaea4da5ecdcce

data/lib/byebug/skipper.rb

@@ -1,8 +1,11 @@
+require 'byebug'
+
 module Byebug::Skipper
   extend self
 
   DEFAULT_SKIP_MATCHERS = [
     %r{/ruby/[^/]+(/bundler)?/gems/}, # gems installed globally or via Bundler
+    %r{/ruby-[^/]+/gems/}, # RVM directory format
     %r{/ruby-[^/]+/lib/ruby/[^/]+/}, # Ruby built-in files
   ].freeze
 
@@ -20,13 +23,18 @@ module Byebug::Skipper
 end
 
 require 'delegate'
-require 'byebug'
-require 'byebug/command'
+require 'tempfile'
+
 require 'byebug/helpers/frame'
+require 'byebug/command'
+require 'byebug/commands/skip'
+
 require_relative 'skipper/ups_command'
 require_relative 'skipper/downs_command'
 require_relative 'skipper/finishs_command'
 require_relative 'skipper/steps_command'
+require_relative 'skipper/comment_line_above'
+require_relative 'skipper/skip_bang_command'
 
 # Command classes need to be in the Byebug module or else they don't get picked
 # up. Cool, bruh.
@@ -35,6 +43,7 @@ require_relative 'skipper/steps_command'
   Byebug::Skipper::DownsCommand,
   Byebug::Skipper::FinishsCommand,
   Byebug::Skipper::StepsCommand,
+  Byebug::Skipper::SkipBangCommand,
 ].each do |command_class|
   Byebug.const_set(
     command_class.name.split('::').last,

data/lib/byebug/skipper/comment_line_above.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Byebug::Skipper
+  module CommentLineAbove
+    extend self
+
+    def call(location)
+      path, _, line_no = location.rpartition(':')
+      lines = File.readlines(path)
+
+      idx = Integer(line_no) - 2
+      while ignore_line?(lines[idx])
+        idx -= 1
+        return if idx < 0 # tried to go above the first line of the file, so abort
+      end
+
+      lines[idx] = comment_out(lines.fetch(idx))
+      File.write(path, lines.join)
+    end
+
+    private
+
+      def comment_out(line)
+        line.sub(/\A\s*/, '\0# ')
+      end
+
+      def ignore_line?(line)
+        line.strip.empty? || line.strip.start_with?('#')
+      end
+  end
+end

data/lib/byebug/skipper/pry.rb

@@ -2,18 +2,39 @@ 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
+  COMMANDS = [
+    {
+      cmd: 'ups',
+      const_name: 'Ups',
+      continues?: false,
+    },
+    {
+      cmd: 'downs',
+      const_name: 'Downs',
+      continues?: false,
+    },
+    {
+      cmd: 'steps',
+      const_name: 'Steps',
+      continues?: true,
+    },
+    {
+      cmd: 'finishs',
+      const_name: 'Finishs',
+      continues?: true,
+    },
+  ].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
+Byebug::Skipper::Pry::COMMANDS.each do |command|
+  byebug_command_class = Byebug::Skipper.const_get("#{command.fetch(:const_name)}Command")
+  pry_command_class = Class.new(Pry::ClassCommand) do
     include ::PryByebug::Helpers::Navigation
 
-    match command_name
+    match command.fetch(:cmd)
     group "Byebug Skipper"
-    description "Same as Byebug's `#{command_name.chomp('s')}` command but skips garbage frames (e.g. from gems)"
+    description byebug_command_class.short_description
 
     def process
       PryByebug.check_file_context(target)
@@ -23,8 +44,8 @@ Byebug::Skipper::Pry::COMMAND_NAMES.each do |command_name|
     end
   end
 
-  Byebug::Skipper::Pry.const_set("#{command_name.capitalize}Command", command_class)
-  Pry::Commands.add_command(command_class)
+  Byebug::Skipper::Pry.const_set("#{command.fetch(:const_name)}Command", pry_command_class)
+  Pry::Commands.add_command(pry_command_class)
 end
 
 # This is a monkey patch for Byebug::PryProcessor in order to add extra Byebug
@@ -34,18 +55,17 @@ 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)
+    command = Byebug::Skipper::Pry::COMMANDS.find { _1.fetch(:cmd) == action.to_s }
+    return super unless command
 
     # 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)
+    Byebug::Skipper.const_get("#{command.fetch(:const_name)}Command")
+      .new(self, action.to_s)
       .execute
 
-    unless Byebug::Skipper::Pry::COMMANDS_THAT_CONTINUE.include?(command_name)
-      # This shows the REPL again, preventing execution from continuing.
-      resume_pry
-    end
+    # This shows the REPL again, preventing execution from continuing.
+    resume_pry unless command.fetch(:continues?)
   end
 end
 

data/lib/byebug/skipper/skip_bang_command.rb

@@ -0,0 +1,23 @@
+module Byebug::Skipper
+  class SkipBangCommand < Byebug::SkipCommand
+    def self.regexp
+      /^ \s* skip! \s* $/x
+    end
+
+    def self.short_description
+      "Same as `skip` but also comments out the line before the current one (where `byebug` or `binding.pry` usually is)"
+    end
+
+    def self.description
+      short_description
+    end
+
+    # This method gets run once when the command starts. After that, `#execute`
+    # gets called repeatedly from different locations, so we can't use it
+    # without adding random commented lines everywhere.
+    def initialize_attributes
+      CommentLineAbove.(context.location)
+      super
+    end
+  end
+end

data/lib/byebug/skipper/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: byebug-skipper
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Tom Dalling
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-07 00:00:00.000000000 Z
+date: 2021-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -73,9 +73,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/byebug/skipper.rb
+- lib/byebug/skipper/comment_line_above.rb
 - lib/byebug/skipper/downs_command.rb
 - lib/byebug/skipper/finishs_command.rb
 - lib/byebug/skipper/pry.rb
+- lib/byebug/skipper/skip_bang_command.rb
 - lib/byebug/skipper/steps_command.rb
 - lib/byebug/skipper/ups_command.rb
 - lib/byebug/skipper/version.rb