git-fancy 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03a33152dbf41fc359d422a9e44cdeae8e2f1e9205bc6515525155a90cb98f19
-  data.tar.gz: 8b2c242b5cbe8e9cfdebe41a17658d169ed65a609731b865ce9dc12c24597e30
+  metadata.gz: 685d5e178fb8233c3c22be3c24618b164c8e11ef96b809dada54ee831ffdd04e
+  data.tar.gz: ce0556c30dfb4e1b3ec8ff83b3f1fc19fb10c890696ec609358f2ce7c81bb4c8
 SHA512:
-  metadata.gz: e99664ee065b29e79c45ad6eeddca64641a442fbe8dafe75ad414a332bc8f369830e273350fb72735db8cb518bff9b1c0a89bb87fd97a720fae0e1203a581ab4
-  data.tar.gz: b6c90f97a02d093ba58beda95d95cc42eafc6827cae124dbfb773c18fd0e1f7f30cf2b79aa4150975ef6d05ab462e27383785a5e1bbc199cf8e2603303701acb
+  metadata.gz: d00a35e7f8e172ba10759dae5a62c6eee46f5519f54e66295dbfa51a0958c55b40edc3d2fb9583b91562a4de51a646d1f87b3191ae7a5ac320f77b8fb7426cd4
+  data.tar.gz: cbcd6327de0c9b9708d4cd1e75f383515f2bd84c5aaab6263df43afb890330aead57333f5627a7f40d020389890010eaccf88eda59d41feb3c132e90cc9c9b97

data/README.md

@@ -1,28 +1,42 @@
 # Git::Fancy
 
-TODO: Delete this and the text below, and describe your gem
+Git fancy is a command line tool that makes switching between git branches faster and easier.
+It also allows you to annotate branches and quickly match branches based on either part of the branch name or notes.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/git/fancy`. To experiment with that code, run `bin/console` for an interactive prompt.
+Git fancy tracks branches by most recently used.
 
-## Installation
+![Kapture 2025-05-06 at 02 31 07](https://github.com/user-attachments/assets/238e45c0-e612-4d58-8bd4-543356f52730)
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
 
-Install the gem and add to the application's Gemfile by executing:
+## Installation
 
-```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```console
+$ gem install git-fancy
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+## Usage
 
-```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+The `sb` command is an alias for `switch-branch`. Both commands can be used interchangeably.
+
+To list recently used branches: (sb only tracks recently used branches when you use sb to switch branches)
+```console
+sb
 ```
 
-## Usage
+To switch to a branch when you only have a portion of a branch name:
+```console
+sb <portion_of_branch_name>
+```
+
+To annotate the current branch you are on:
+```console
+sb -n "make the logo bigger"
+```
 
-TODO: Write usage instructions here
+List all of the branches git fancy is tracking:
+```console
+sb -l
+```
 
 ## Development
 

data/exe/sb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
 # This is just an alias for the switch-branch script
-path = File.join(__dir__, './switch-branch')
+path = File.join(__dir__, 'switch-branch')
 eval(File.read(path)) if File.exist?(path)

data/exe/switch-branch

@@ -4,10 +4,13 @@
 # Switch to git branch by matching part of a name
 
 require 'optparse'
+require 'pastel'
 require 'tty-prompt'
 require 'tty-logger'
 require 'sqlite3'
 require 'git/fancy'
+require 'open3'
+require 'debug'
 
 options = {}
 
@@ -27,12 +30,31 @@ OptionParser.new do |opts|
   end
 end.parse!
 
+logger = TTY::Logger.new do |config|
+  config.handlers = [[:console, {
+    styles: {
+      info: {
+        color: :green,
+        symbol: '→',
+        label: nil,
+        levelpad: 0,
+      },
+      warn: {
+        label: nil,
+      },
+      error: {
+        label: nil,
+      },
+    }
+  }]]
+end
+@logger = logger
+
 Signal.trap('TERM') do
-  puts 'Terminating...'
+  @logger.error 'Terminating...'
   shutdown
 end
 
-logger = TTY::Logger.new
 
 @search_term = ARGV[0]&.strip
 search_term = @search_term
@@ -48,7 +70,7 @@ end
 
 if options[:delete_history]
   @branch_history.purge_history!
-  logger.success @color.green('Removed branch history')
+  @logger.success @color.green('Removed branch history')
   exit 0
 end
 
@@ -62,22 +84,22 @@ end
 if options[:note]
   @branch_history.add_branch @branch_history.current_branch
   @branch_history.add_note options[:note]
-  logger.success @color.green('Note added')
+  @logger.success @color.green('Note added')
   exit 0
 end
 
 if options[:list]
   branches = @branch_history.recent_branches(limit: 20, include_current: true)
   if branches.empty?
-    logger.warn 'No recent branches found'
+    @logger.warn 'No recent branches found'
     exit 0
   end
 
-  puts 'Recent branches:'
+  @logger.info 'Recent branches:'
   branches.each do |branch|
-    time = branch.last_accessed ? Time.at(branch.last_accessed).strftime('%y-%m-%d') : nil
+    time = branch.last_accessed ? Time.at(branch.last_accessed).strftime('%Y-%m-%d') : nil
     note = branch.note ? @color.yellow(branch.note) : nil
-    puts [time, branch.name, note].compact.join(' -- ')
+    puts [time, branch.name, note].compact.join(@color.dim(' → '))
   end
   exit 0
 end
@@ -99,32 +121,35 @@ end
 branches = find_branches(search_term) || []
 
 def switch_branch(branch_name, location:)
-  logger = TTY::Logger.new
-  `git switch #{branch_name}`
+  Open3.popen3("git switch #{branch_name}") do |stdin, stdout, stderr, wait_thr|
+    # For some reason, even succesful git switch goes to stderr
+    out = stderr.read
+    if wait_thr.value.success?
+      @logger.success @color.green(out.strip)
+    else
+      # Also for some reason errors are duplicated
+      @logger.error @color.red(out.split("\nerror: ").first.strip)
+      exit 1
+    end
+  end
 
   @branch_history.add_branch(branch_name)
   branch_note = @branch_history.branches_matching_notes(@search_term).find { |b| b.name == branch_name }&.note if @search_term
-  logger.success "Switched to #{location} branch: #{branch_name} #{branch_note ? @color.yellow(branch_note) : ''}"
 end
 
 def select_branch(branches, location: 'local', selected_branch: nil)
-  logger = TTY::Logger.new
-  prompt = TTY::Prompt.new
-
   choices = branches.each_with_object({}) do |branch, hash|
     time = branch.last_accessed ? Time.at(branch.last_accessed).strftime('%y-%m-%d') : nil
     note = branch.note ? @color.yellow(branch.note) : nil
     key = [time, branch.name, note].compact.join(' -- ')
     hash[key] = branch.name
   end
-
-  selection = prompt.select("Choose #{location} branch", choices.merge('none' => 'none'))
-  if selection == 'none'
-    logger.info 'Cancelling selection'
-    exit 0
-  end
-
-  switch_branch(selection, location:)
+  prompt = TTY::Prompt.new
+  cancel_str = @color.dim('ctrl-c to cancel')
+  selection = prompt.select("Choose #{location} branch #{cancel_str}", choices)
+  switch_branch(selection, location:) if selection != 'none'
+rescue TTY::Reader::InputInterrupt
+  exit 0
 end
 
 if branches.length == 1
@@ -135,10 +160,10 @@ if branches.length == 1
 
   switch_branch(branch_name, location: 'local')
 elsif branches.length > 1
-  logger.warn 'More than one branch name matched' unless search_term
+  @logger.warn 'More than one branch name matched' if search_term
   select_branch(branches, location: 'local')
 else
-  logger.warn "No local branches named: '#{branches.join(', ')}' with that name were found"
+  @logger.warn "No local branches named: '#{branches.join(', ')}' with that name were found"
   remote_branches = prep_branch_results(`git branch -r | grep #{search_term} | cut -f 1`)
 
   select_branch(remote_branches, location: 'remote')

data/lib/git/fancy/version.rb

@@ -2,6 +2,6 @@
 
 module Git
   module Fancy
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-fancy
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Sean McCleary