gubed 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 208a0c9f02fb1d518500ba12917be9aa63454f8a1f270a25385b22479a70f29f
+  data.tar.gz: 501f3302b575817e1273decf824d6a640974ddbe43a5471256595f5f27138fd5
+SHA512:
+  metadata.gz: 1ec8528a5c4795934aff69083d308eb8e906b9d69009250e26f96c3892092043d4ff5dbee1231040c0085e542b0eca2f2f678bdae8e9ee9e407ce949c239953b
+  data.tar.gz: fbe63215e825481e7471a26353034991a4ca9c78a8b8a83f187dfd1bc479505522124fb50eff71839b0f44b258893afee7480c85d75c7d0297738d80d87f451b

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-08-05
+
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Thomas Countz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Thomas Countz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+# Gubed
+
+A command-line tool for managing debugger breakpoints in Ruby projects. Find, comment, uncomment, and delete debugging statements like `binding.pry`, `debugger`, `binding.irb`, and more.
+
+## Installation
+
+```bash
+gem install gubed
+```
+
+## Usage
+
+Run `gubed` in any Ruby project directory to scan for debugging breakpoints:
+
+```bash
+$ gubed --help
+
+gubed                    # Scan current directory
+gubed /path/to/project   # Scan specific directory
+```
+
+### Interactive Mode
+
+Once Gubed finds breakpoints, you can:
+
+- Navigate with `j` (down) and `k` (up)
+- Press `c` to comment/uncomment breakpoints
+- Press `d` to delete breakpoints
+- Press `v` to view surrounding code context
+- Press `q` to quit
+- Press `h` for help
+
+### Supported Breakpoint Types
+
+These are found based on regex.
+
+- `binding.pry`
+- `binding.irb`
+- `binding.break`
+- `debugger`
+- `byebug`
+
+## Example
+
+```bash
+$ gubed
+Gubed - Ruby Breakpoint Manager
+========================================
+
+>  1. [#] binding.irb /Users/thomas.countz/Code/experiments/gubed/examples/calculator.rb:14
+   2. [ ] binding.break /Users/thomas.countz/Code/experiments/gubed/examples/calculator.rb:19
+   3. [ ] binding.pry /Users/thomas.countz/Code/experiments/gubed/examples/calculator.rb:3
+   4. [#] debugger /Users/thomas.countz/Code/experiments/gubed/examples/calculator.rb:8
+   5. [#] debugger /Users/thomas.countz/Code/experiments/gubed/examples/sample_app.rb:11
+   6. [ ] debugger /Users/thomas.countz/Code/experiments/gubed/examples/sample_app.rb:15
+   7. [#] binding.break /Users/thomas.countz/Code/experiments/gubed/examples/sample_app.rb:17
+   8. [ ] binding.break /Users/thomas.countz/Code/experiments/gubed/examples/sample_app.rb:22
+   9. [ ] byebug /Users/thomas.countz/Code/experiments/gubed/examples/sample_app.rb:25
+  10. [ ] binding.pry /Users/thomas.countz/Code/experiments/gubed/examples/sample_app.rb:4
+  11. [#] binding.irb /Users/thomas.countz/Code/experiments/gubed/examples/sample_app.rb:9
+
+Commands: [j]down [k]up [g]oto [v]iew [t]oggle [d]elete [r]efresh [q]uit [h]elp
+Selected: 1 of 11
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Run `rake test` to run the tests.
+
+## License
+
+MIT License Copyright (c) 2025 Thomas Countz

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/examples/calculator.rb

@@ -0,0 +1,22 @@
+class Calculator
+  def add(a, b)
+    binding.pry
+    a + b
+  end
+
+  def subtract(a, b)
+    # debugger
+    a - b
+  end
+
+  def multiply(a, b)
+    a * b
+    # binding.irb
+  end
+
+  def divide(a, b)
+    return 0 if b == 0
+    binding.break
+    a / b
+  end
+end

data/examples/sample_app.rb

@@ -0,0 +1,28 @@
+class SampleApp
+  def initialize
+    @users = []
+    binding.pry # Debug initialization
+  end
+
+  def add_user(name, email)
+    user = {name: name, email: email}
+    # binding.irb # Commented out debug point
+    @users << user
+    # debugger # Check user addition
+  end
+
+  def find_user(email)
+    debugger
+    @users.find { |user| user[:email] == email }
+    # binding.break if result.nil?
+  end
+
+  def process_users
+    require "debug"
+    binding.break
+    @users.each do |user|
+      puts "Processing #{user[:name]}"
+      byebug # Debug each user processing
+    end
+  end
+end

data/exe/gubed

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "optparse"
+require "gubed"
+
+class GubedCLI
+  def initialize
+    @options = {}
+    @parser = create_option_parser
+  end
+
+  def run(args = ARGV)
+    @parser.parse!(args)
+
+    root_path = args.first || "."
+
+    unless File.directory?(root_path)
+      puts "Error: '#{root_path}' is not a valid directory"
+      exit 1
+    end
+
+    manager = Gubed::BreakpointManager.new(root_path)
+    manager.run
+  rescue Interrupt
+    puts "\n\nExiting..."
+    exit 0
+  rescue => e
+    puts "Error: #{e.message}"
+    exit 1
+  end
+
+  private
+
+  def create_option_parser
+    OptionParser.new do |opts|
+      opts.banner = "Usage: gubed [options] [directory]"
+      opts.separator ""
+      opts.separator "Gubed is a Ruby breakpoint manager that helps you find, manage, and remove"
+      opts.separator "debugging breakpoints (binding.pry, debugger, etc.) in your Ruby projects."
+      opts.separator ""
+      opts.separator "Options:"
+
+      opts.on("-h", "--help", "Show this help message") do
+        puts opts
+        exit
+      end
+
+      opts.on("-v", "--version", "Show version") do
+        puts "Gubed version #{Gubed::VERSION}"
+        exit
+      end
+
+      opts.separator ""
+      opts.separator "Examples:"
+      opts.separator "  gubed                    # Scan current directory"
+      opts.separator "  gubed /path/to/project   # Scan specific directory"
+      opts.separator ""
+      opts.separator "Supported breakpoint types:"
+      opts.separator "  - binding.pry"
+      opts.separator "  - binding.irb"
+      opts.separator "  - binding.break"
+      opts.separator "  - debugger"
+      opts.separator "  - byebug"
+    end
+  end
+end
+
+GubedCLI.new.run if $0 == __FILE__ || File.basename($0) == "gubed"

data/lib/gubed/breakpoint_manager.rb

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+
+require "io/console"
+
+module Gubed
+  class BreakpointManager
+    def initialize(root_path = ".")
+      @scanner = BreakpointScanner.new(root_path)
+      @breakpoints = []
+      @current_index = 0
+      @message = nil
+    end
+
+    def run
+      refresh_breakpoints
+      return puts "No breakpoints found." if @breakpoints.empty?
+
+      loop do
+        show_list
+        puts @message if @message
+        input = get_input
+
+        case input
+        when "q"
+          break if exit_program?(input)
+        when "r"
+          refresh_breakpoints
+          @current_index = 0
+        when "t"
+          toggle_comment
+        when "d"
+          delete_breakpoint
+        when "v"
+          show_context
+        when "g"
+          prompt_for_breakpoint
+        when "j"
+          move_down
+        when "k"
+          move_up
+        when "h", "?"
+          show_help
+        end
+      end
+    end
+
+    private
+
+    def refresh_breakpoints
+      print "Scanning..."
+      @breakpoints = @scanner.scan
+      puts " found #{@breakpoints.length} breakpoints"
+      @current_index = [@current_index, @breakpoints.length - 1].min if @breakpoints.any?
+    end
+
+    def show_list
+      system("clear") || system("cls")
+      puts "Gubed - Ruby Breakpoint Manager"
+      puts "=" * 40
+      puts
+
+      if @breakpoints.empty?
+        puts "No breakpoints found."
+        return
+      end
+
+      width = @breakpoints.length.to_s.length
+      @breakpoints.each_with_index do |bp, index|
+        marker = (index == @current_index) ? ">" : " "
+        status = bp.commented? ? "[#]" : "[ ]"
+        number = (index + 1).to_s.rjust(width)
+
+        puts "#{marker} #{number}. #{status} #{bp.type} #{bp.location}"
+      end
+
+      puts
+      puts "Commands: [j]down [k]up [g]oto [v]iew [t]oggle [d]elete [r]efresh [q]uit [h]elp"
+      puts "Selected: #{@current_index + 1} of #{@breakpoints.length}"
+    end
+
+    def get_input
+      $stdin.getch
+    end
+
+    def prompt_for_breakpoint
+      print "Go to breakpoint: "
+      input = gets.chomp
+      return if input.empty?
+
+      num = input.to_i
+      if num.between?(1, @breakpoints.length)
+        @current_index = num - 1
+      else
+        @message = "Invalid selection: #{num}."
+      end
+    end
+
+    def move_down
+      @current_index = (@current_index + 1) % @breakpoints.length
+    end
+
+    def move_up
+      @current_index = (@current_index - 1) % @breakpoints.length
+    end
+
+    def show_context
+      return if @breakpoints.empty?
+
+      bp = @breakpoints[@current_index]
+      lines = File.readlines(bp.file)
+
+      puts
+      puts "Context for #{bp.location}:"
+      puts "-" * 40
+
+      start_line = [bp.line_number - 6, 1].max
+      end_line = [bp.line_number + 4, lines.length].min
+
+      (start_line..end_line).each do |line_num|
+        line_index = line_num - 1
+        content = lines[line_index].rstrip
+        marker = (line_num == bp.line_number) ? ">>> " : "    "
+        puts "#{marker}#{line_num}: #{content}"
+      end
+
+      puts
+      print "Press Enter to continue..."
+      gets
+    end
+
+    def toggle_comment
+      return if @breakpoints.empty?
+
+      bp = @breakpoints[@current_index]
+
+      modify_line(bp) do |line|
+        if bp.commented?
+          line.sub(/^(\s*)#\s*/, '\1')
+        else
+          line.sub(/^(\s*)/, '\1# ')
+        end
+      end
+
+      refresh_breakpoints
+    end
+
+    def delete_breakpoint
+      return if @breakpoints.empty?
+
+      bp = @breakpoints[@current_index]
+
+      print "Delete breakpoint at #{bp.location}? (y/N): "
+      response = gets.chomp.downcase
+
+      return unless response == "y" || response == "yes"
+
+      lines = File.readlines(bp.file)
+      lines.delete_at(bp.line_number - 1)
+      File.write(bp.file, lines.join)
+
+      refresh_breakpoints
+      @current_index = [@current_index, @breakpoints.length - 1].min if @breakpoints.any?
+    end
+
+    def exit_program?(input)
+      print "Press #{(input == "\e") ? "esc" : input} again to exit or any other key to continue: "
+      response = $stdin.getch
+      true if response == input
+    end
+
+    def modify_line(breakpoint)
+      lines = File.readlines(breakpoint.file)
+      lines[breakpoint.line_number - 1] = yield(lines[breakpoint.line_number - 1])
+      File.write(breakpoint.file, lines.join)
+    end
+
+    def show_help
+      puts
+      puts "Commands:"
+      puts "  j          - Move selection down"
+      puts "  k          - Move selection up"
+      puts "  g          - Go to a specific breakpoint by number"
+      puts "  v          - Show context around breakpoint"
+      puts "  t          - Toggle line comment on selected breakpoint"
+      puts "  d          - Delete selected breakpoint"
+      puts "  r          - Rescan for breakpoints"
+      puts "  q          - Exit program"
+      puts "  h, ?       - Show this help"
+      puts
+      puts "Legend: [ ] = Active, [#] = Commented"
+      puts
+      print "Press Enter to continue..."
+      gets
+    end
+  end
+end

data/lib/gubed/breakpoint_scanner.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "find"
+
+module Gubed
+  Breakpoint = Data.define(:file, :line_number, :content, :type) do
+    def initialize(file:, line_number:, content:, type:)
+      super(file: file, line_number: line_number, content: content.strip, type: type)
+    end
+
+    def commented?
+      content.start_with?("#")
+    end
+
+    def location
+      "#{file}:#{line_number}"
+    end
+  end
+
+  class BreakpointScanner
+    BREAKPOINT_PATTERNS = {
+      "binding.pry" => /^\s*(?:#\s*)?binding\.pry\b/,
+      "binding.irb" => /^\s*(?:#\s*)?binding\.irb\b/,
+      "binding.break" => /^\s*(?:#\s*)?binding\.break\b/,
+      "debugger" => /^\s*(?:#\s*)?debugger\b/,
+      "byebug" => /^\s*(?:#\s*)?byebug\b/,
+      "debug" => /^\s*(?:#\s*)?(?:require\s+['"]debug['"];\s*)?binding\.break\b/
+    }.freeze
+
+    RUBY_FILE_EXTENSIONS = %w[.rb .rake .gemspec].freeze
+    DIR_TO_SKIP = %w[.git vendor node_modules tmp].freeze
+
+    def initialize(root_path = ".")
+      @root_path = File.expand_path(root_path)
+    end
+
+    def scan
+      breakpoints = []
+
+      Find.find(@root_path) do |path|
+        if File.directory?(path)
+          Find.prune if DIR_TO_SKIP.any? { |dir| path.include?(dir) }
+          next
+        end
+
+        next unless ruby_file?(path)
+
+        breakpoints.concat(scan_file(path))
+      end
+
+      breakpoints.sort_by(&:location)
+    end
+
+    private
+
+    def ruby_file?(path)
+      RUBY_FILE_EXTENSIONS.any? { |ext| path.end_with?(ext) } ||
+        (File.executable?(path) && ruby_shebang?(path))
+    end
+
+    def ruby_shebang?(path)
+      first_line = begin
+        File.open(path, &:readline).strip
+      rescue
+        ""
+      end
+      first_line.include?("ruby")
+    end
+
+    def scan_file(file_path)
+      breakpoints = []
+
+      File.foreach(file_path).each_with_index do |line, index|
+        BREAKPOINT_PATTERNS.each do |type, pattern|
+          if line.match(pattern)
+            breakpoints << Breakpoint.new(
+              file: file_path,
+              line_number: index + 1,
+              content: line.chomp,
+              type: type
+            )
+            break
+          end
+        end
+      end
+
+      breakpoints
+    rescue => e
+      puts "Warning: Could not scan #{file_path}: #{e.message}"
+      []
+    end
+  end
+end

data/lib/gubed/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Gubed
+  VERSION = "0.1.0"
+end

data/lib/gubed.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "gubed/version"
+require_relative "gubed/breakpoint_scanner"
+require_relative "gubed/breakpoint_manager"
+
+module Gubed
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: gubed
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thomas Countz
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Gubed is a standalone command-line tool for finding and managing debugger
+  breakpoints (binding.pry, debugger, etc.) in Ruby codebases. Install globally with
+  'gem install gubed' and use in any project.
+email:
+- thomascountz@gmail.com
+executables:
+- gubed
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/calculator.rb
+- examples/sample_app.rb
+- exe/gubed
+- lib/gubed.rb
+- lib/gubed/breakpoint_manager.rb
+- lib/gubed/breakpoint_scanner.rb
+- lib/gubed/version.rb
+homepage: https://github.com/thomascountz/gubed
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/thomascountz/gubed
+  source_code_uri: https://github.com/thomascountz/gubed
+  changelog_uri: https://github.com/thomascountz/gubed/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Ruby CLI for managing and editing debugger breakpoints
+test_files: []