git-jump 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 880531bf60be8fc8c6ec01873f77a37681d077384f7f7ad1f161a26b3644298c
+  data.tar.gz: 427e6a3ca62fcf5f073dc14fc74cf9fb6bb2e6e066888d491ac5643c7a44d2c7
+SHA512:
+  metadata.gz: bb3594881a0ec21a4e449ae69f4ce7650fc0938ee076aabfedf8b09ad9bbd6d20ee4db34582cf9c4db853a7e97d85a8ce9f3d2c663ab4d3ea81d1f28687115c2
+  data.tar.gz: cd11e8e1ca1d54787e7ecc394ea6f4c8aaf409f0e135d68443e36816ce6bcd5e37a6c67a070c277ec6305582ece96954fbc2e4b626f5be4bc99979582b3aed4e

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-11-03
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 David Sáenz
+
+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,355 @@
+# Git::Jump
+
+[![Gem Version](https://badge.fury.io/rb/git-jump.svg)](https://rubygems.org/gems/git-jump)
+[![CI](https://github.com/dsaenztagarro/git-jump/actions/workflows/main.yml/badge.svg)](https://github.com/dsaenztagarro/git-jump/actions)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Ruby Version](https://img.shields.io/badge/ruby-%3E%3D%203.2-blue)](https://www.ruby-lang.org/)
+
+A CLI tool for tracking and quickly switching between git branches across projects. Git::Jump automatically tracks your branch history and lets you jump between recently visited branches with ease.
+
+## Features
+
+- **Automatic Branch Tracking**: Install a git hook to automatically track branches when you check them out
+- **Manual Branch Management**: Add, list, and clear tracked branches
+- **Quick Branch Switching**: Jump to the next branch or a specific branch by index
+- **Smart Branch Ordering**: Branches are ordered by most recently visited
+- **Project-Specific Tracking**: Separate branch history for each git repository
+- **Configurable Keep Patterns**: Define which branches to keep when clearing (e.g., main, master, develop)
+- **XDG Base Directory Support**: Configuration and data files follow XDG standards
+- **Beautiful Terminal Output**: Colored output and formatted tables for easy reading
+
+## Installation
+
+Install the gem by executing:
+
+```bash
+gem install git-jump
+```
+
+Or add it to your application's Gemfile:
+
+```bash
+bundle add git-jump
+```
+
+## Quick Start
+
+1. Initialize the configuration file:
+```bash
+git-jump setup
+```
+
+2. Navigate to a git repository and install the post-checkout hook:
+```bash
+cd /path/to/your/repo
+git-jump install
+```
+
+3. Now branches will be automatically tracked when you check them out! Or add branches manually:
+```bash
+git-jump add feature/my-branch
+```
+
+4. List tracked branches:
+```bash
+git-jump list
+```
+
+5. Jump to the next branch in the list:
+```bash
+git-jump jump
+```
+
+6. Or jump to a specific branch by index:
+```bash
+git-jump jump 3
+```
+
+## Usage
+
+### Commands
+
+#### `git-jump setup`
+Initialize the configuration file at `~/.config/git-jump/config.toml` (or `$XDG_CONFIG_HOME/git-jump/config.toml`).
+
+```bash
+git-jump setup
+```
+
+#### `git-jump install`
+Install the post-checkout git hook in the current repository. This enables automatic branch tracking whenever you checkout a branch.
+
+```bash
+cd /path/to/your/repo
+git-jump install
+```
+
+#### `git-jump add BRANCH`
+Manually add a branch to tracking for the current project.
+
+```bash
+git-jump add feature/my-branch
+```
+
+#### `git-jump list`
+List all tracked branches for the current project. Branches are displayed with an index number and sorted by most recently visited.
+
+```bash
+git-jump list
+```
+
+Output example:
+```
+Tracked Branches
+────────────────
+┌─────┬────────────────┬──────────────┐
+│ #   │ Branch         │ Last Visited │
+├─────┼────────────────┼──────────────┤
+│ → 1 │ feature/auth   │ just now     │
+│   2 │ feature/api    │ 2 hours ago  │
+│   3 │ master         │ 1 day ago    │
+└─────┴────────────────┴──────────────┘
+```
+
+#### `git-jump jump [INDEX]`
+Jump to the next branch in the list, or to a specific branch by index.
+
+```bash
+# Jump to the next branch
+git-jump jump
+
+# Jump to branch at index 3
+git-jump jump 3
+```
+
+#### `git-jump clear`
+Clear branches that don't match the keep patterns defined in your configuration. This is useful for cleaning up old feature branches while preserving important branches like main, master, etc.
+
+```bash
+git-jump clear
+```
+
+You'll be prompted to confirm before clearing.
+
+#### `git-jump status`
+Show the current status, configuration, and tracking statistics.
+
+```bash
+git-jump status
+```
+
+Output example:
+```
+Git Jump Status
+───────────────
+ℹ Project: my-project
+ℹ Path: /Users/me/code/my-project
+ℹ Current branch: feature/auth
+
+Configuration
+─────────────
+ℹ Config file: /Users/me/.config/git-jump/config.toml
+ℹ Config exists: Yes
+ℹ Database: /Users/me/.local/share/git-jump/branches.db
+ℹ Max branches: 20
+ℹ Auto-track: Enabled
+ℹ Keep patterns: ^main$, ^master$, ^develop$, ^staging$
+
+Hook Status
+───────────
+ℹ Post-checkout hook: Installed
+
+Tracking Statistics
+───────────────────
+ℹ Total branches tracked: 5
+ℹ Most recent: feature/auth
+```
+
+#### `git-jump version`
+Show the current version of git-jump.
+
+```bash
+git-jump version
+```
+
+### Global Options
+
+All commands support these global options:
+
+- `--config PATH` or `-c PATH`: Use a custom configuration file
+- `--quiet` or `-q`: Suppress output
+- `--verbose` or `-v`: Enable verbose output
+
+Example:
+```bash
+git-jump --config ~/my-config.toml list
+git-jump -q jump
+git-jump -v status
+```
+
+## Configuration
+
+Git::Jump uses a TOML configuration file located at `~/.config/git-jump/config.toml` (or `$XDG_CONFIG_HOME/git-jump/config.toml`).
+
+Run `git-jump setup` to create the default configuration file.
+
+### Configuration Options
+
+```toml
+[database]
+# SQLite database location (defaults to XDG_DATA_HOME/git-jump/branches.db)
+# You can use environment variables like $XDG_DATA_HOME or $HOME
+path = "$XDG_DATA_HOME/git-jump/branches.db"
+
+[tracking]
+# Maximum number of branches to track per project
+max_branches = 20
+
+# Automatically track branches on checkout (via git hook)
+auto_track = true
+
+# Global branch patterns to always keep when clearing (regex patterns)
+keep_patterns = ["^main$", "^master$", "^develop$", "^staging$"]
+
+# Example project-specific configuration
+# [[projects]]
+# name = "my-project"
+# path = "/path/to/my-project"
+# keep_patterns = ["^main$", "^feature/.*$"]
+```
+
+### Keep Patterns
+
+Keep patterns are regex patterns that define which branches should be preserved when running `git-jump clear`. By default, common main branches are kept:
+
+- `^main$` - main branch
+- `^master$` - master branch
+- `^develop$` - develop branch
+- `^staging$` - staging branch
+
+You can customize these patterns globally or per-project in your configuration file.
+
+### XDG Base Directory Support
+
+Git::Jump follows the XDG Base Directory Specification:
+
+- **Configuration**: `$XDG_CONFIG_HOME/git-jump/config.toml` (defaults to `~/.config/git-jump/config.toml`)
+- **Data**: `$XDG_DATA_HOME/git-jump/branches.db` (defaults to `~/.local/share/git-jump/branches.db`)
+- **Cache**: `$XDG_CACHE_HOME/git-jump/` (defaults to `~/.cache/git-jump/`)
+
+## Usage Examples
+
+### Typical Workflow
+
+```bash
+# First time setup
+git-jump setup
+
+# In your project directory
+cd ~/code/my-project
+git-jump install
+
+# Work on different branches
+git checkout feature/authentication
+git checkout feature/api
+git checkout feature/ui
+
+# List your tracked branches
+git-jump list
+# Output:
+# Tracked Branches
+# ────────────────
+# ┌─────┬─────────────────────────┬──────────────┐
+# │ #   │ Branch                  │ Last Visited │
+# ├─────┼─────────────────────────┼──────────────┤
+# │ → 1 │ feature/ui              │ just now     │
+# │   2 │ feature/api             │ 5 minutes ago│
+# │   3 │ feature/authentication  │ 10 minutes ago│
+# └─────┴─────────────────────────┴──────────────┘
+
+# Jump to the next branch (feature/api)
+git-jump jump
+
+# Jump to a specific branch by index
+git-jump jump 3  # Switches to feature/authentication
+
+# Clean up old feature branches (keeps main/master/develop/staging)
+git-jump clear
+```
+
+### Working Across Multiple Projects
+
+Git::Jump tracks branches per project, so you can use it across all your repositories:
+
+```bash
+# Project A
+cd ~/code/project-a
+git-jump install
+git checkout feature/new-ui
+git checkout feature/refactor
+
+# Project B
+cd ~/code/project-b
+git-jump install
+git checkout bugfix/login
+git checkout feature/dashboard
+
+# Each project maintains its own branch history
+cd ~/code/project-a
+git-jump list  # Shows only project-a branches
+
+cd ~/code/project-b
+git-jump list  # Shows only project-b branches
+```
+
+### Using Custom Configuration
+
+```bash
+# Use a custom config file
+git-jump --config ~/my-custom-config.toml status
+
+# Run commands quietly (no output)
+git-jump -q jump
+
+# Verbose output for debugging
+git-jump -v add feature/new-feature
+```
+
+## How It Works
+
+Git::Jump tracks your branch history in a SQLite database. Each time you check out a branch (with the hook installed) or manually add a branch, it's recorded in the database with:
+
+- Project path and name
+- Branch name
+- Last visited timestamp
+- Position in the branch list
+
+Branches are automatically reordered based on when they were last visited, so the most recently used branches appear at the top of the list. This makes it easy to jump between branches you're actively working on.
+
+When you run `git-jump jump`, it checks out the next branch in the list (or the branch at the specified index) and updates the last visited timestamp, moving it to the top of the list.
+
+### Post-Checkout Hook
+
+When you run `git-jump install`, it creates a post-checkout hook in `.git/hooks/post-checkout` that automatically tracks branches when you check them out using `git checkout`. The hook is safe and will not interfere with existing hooks if you chain them properly.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dsaenzriv/git-jump. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/dsaenzriv/git-jump/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Git::Jump project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dsaenzriv/git-jump/blob/master/CODE_OF_CONDUCT.md).
+
+## Acknowledgments
+
+Inspired by the need to quickly switch between feature branches during development. Architecture follows the modular design patterns from [dotsync](https://github.com/dotboris/dotsync).

data/Rakefile

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
+
+namespace :release do
+  desc "Tag git with the current GitJump::VERSION"
+  task :tag do
+    require_relative "lib/git_jump/version"
+    version = GitJump::VERSION
+    tag_name = "v#{version}"
+
+    # Check if tag already exists
+    if `git tag --list`.split.include?(tag_name)
+      puts "Tag #{tag_name} already exists."
+      exit(1)
+    end
+
+    puts "Tagging commit as #{tag_name}..."
+    sh "git tag -a #{tag_name} -m 'Release #{tag_name}'"
+    puts "Pushing tag #{tag_name} to origin..."
+    sh "git push origin #{tag_name}"
+    puts "Done!"
+  end
+end

data/db/schema.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "sqlite3"
+
+def setup_database
+  db = SQLite3::Database.new File.join(Dir.home, ".git_jump.sqlite3")
+
+  db.execute <<-SQL
+    CREATE TABLE IF NOT EXISTS branches (
+      id INTEGER PRIMARY KEY AUTOINCREMENT,
+      project_name TEXT NOT NULL,
+      branch_name TEXT NOT NULL,
+      created_at DATETIME DEFAULT CURRENT_TIMESTAMP
+    );
+  SQL
+
+  db
+end

data/exe/git-jump

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Load only the minimal git_jump library
+require_relative "../lib/git_jump"
+
+# Lazy-load CLI when needed
+require_relative "../lib/git_jump/cli"
+
+GitJump::CLI.start(ARGV)

data/lib/git_jump/action.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module GitJump
+  class Action
+    def initialize(repository_path)
+      @repository_path = repository_path
+      # @db = setup_database
+    end
+
+    def add(branch_name)
+      project_name = File.basename(Dir.pwd)
+
+      puts "GitJump::Action#add project_name: #{project_name}"
+
+      # @db.execute(
+      #   'INSERT INTO branches (project_name, branch_name) VALUES (?, ?)',
+      #   [project_name, branch_name]
+      # )
+
+      puts "Branch '#{branch_name}' added for project '#{project_name}'"
+    end
+
+    def toggle
+      project_name = File.basename(Dir.pwd)
+
+      branches = @db.execute(
+        "SELECT branch_name FROM branches WHERE project_name = ?",
+        [project_name]
+      ).map(&:first)
+
+      if branches.empty?
+        puts "No branches found for project '#{project_name}'"
+        return
+      end
+
+      current_branch = `git branch --show-current`.strip
+      next_branch = branches[(branches.index(current_branch) || -1) + 1] || branches.first
+
+      system("git checkout #{next_branch}")
+      puts "Switched to branch '#{next_branch}'"
+    end
+  end
+end

data/lib/git_jump/actions/add.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module GitJump
+  module Actions
+    # Action to manually add a branch to tracking
+    class Add < Base
+      attr_reader :branch_name, :verify
+
+      def initialize(branch_name:, verify: true, **)
+        super(**)
+        @branch_name = branch_name
+        @verify = verify
+      end
+
+      def execute
+        if verify && !repository.branch_exists?(branch_name)
+          output.error("Branch '#{branch_name}' does not exist in repository")
+          return false
+        end
+
+        database.add_branch(project_id, branch_name)
+        output.success("Added branch '#{branch_name}' to tracking for #{repository.project_basename}")
+
+        # Check if we've exceeded max_branches
+        total = database.count_branches(project_id)
+        max = config.max_branches
+
+        output.warning("Project has #{total} branches (max: #{max}). Consider running 'git-jump clear'") if total > max
+
+        true
+      end
+    end
+  end
+end