gitflash 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37431db670588b8025d973c045532de047b33a667fc1c86152e1180d2d0a01a6
-  data.tar.gz: 307fe7991415b2bedce69a08f7b0e09e591be3cbcb6be692c1d46c87c79019b1
+  metadata.gz: 308e1c6f4eba1ab9251d7606e919e91108df058d0618b04e2c8f35aac8370ad0
+  data.tar.gz: 47da55dc51b8f5b38e6dae281560f0dc880c3a58a95baea0689d4b0fd82536f7
 SHA512:
-  metadata.gz: dcc8b7a6a6c740c46c78d29766bc78b99fa9949217482a71e47070a077a51759903c74a82adbcbe24590e27dbc04f5db5501175efda1a2a624f7b84211e72579
-  data.tar.gz: 541587b9f335e4ccd47f4cb0e7ec9806d1e4a2abb06d8811e81e8c483c2eba2126c26f7cbaebe5074d07d968d4e156b6ea751ccfbff08b6128a6239af0cd4272
+  metadata.gz: e21748dad35cd17a28452b9593dc08b015544d08d68fb615c4ae71e7681a3ac7790a2a95f0eec2aaad389d46fe95fb63d969d8043b668f695e39e7903afef640
+  data.tar.gz: e91e1e12645b2af6d0079209c690e08b4dfdb0e951cf99cf5b1c01b2b831e79d890a3eec1450be09434d14d448cae9cc58d93ccf61aded66e246da9c711bc670

data/CHANGELOG.md

@@ -0,0 +1,43 @@
+## [Unreleased]
+
+## [0.1.0.alpha] - 2023-06-17
+
+- Initial release
+
+## [0.1.1.alpha] - 2023-10-28
+
+- Fix delete method
+- Added and updated test
+- bug fixes
+
+## [0.1.2.alpha] - 2023-11-4
+
+- Refactors and code improvements
+- Zeitwerk warning suppress
+- Update README
+- Bug fixes
+
+## [0.2.0.alpha] - 2023-12-9
+
+- Add reset command
+- Code improvements
+
+## [0.3.0] - 2025-10-10
+
+- Fix reset method
+- Update to Ruby version 3.3.2
+- Bug fixes
+
+## [0.4.0] - 2026-09-24
+
+- Run git commands without a shell and raise on failure
+- List branches with `git for-each-ref`; detached HEAD no longer shows as a branch
+- List the latest 100 commits for `reset`, unaffected by `log.decorate`
+- Exit with an error when a git command fails or outside a git repository
+- `delete` does nothing when no branches are available or selected
+- `reset --hard` prints `Exited` when declined; fix single-commit message
+- Correct `reset` help text
+- Portable `bin/gitflash` shebang
+- Require thor >= 1.4 (CVE-2025-54314) and Ruby >= 3.3
+- Add `version` command (`--version`, `-v`)
+- CI: pin third-party action to a commit SHA, restrict token permissions, test Ruby 3.3–3.4

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/gitflash.svg)](https://badge.fury.io/rb/gitflash)
 
-⚠️ **This project is stil under development**: Use at your own risk!
+⚠️ **This project is still under development**: Use at your own risk!
 
 This gem allows you to use some of the most common git commands in a more user intuitive way.
 
@@ -24,10 +24,21 @@ Or install it yourself as:
 
 ## Requirements
 
-This gem requires Ruby 3.3.2+.
+This gem requires Ruby 3.3+ and git.
+
 ## Usage
 
-Run `gitflash` to get a list with the available commands and their description.
+Run `gitflash` inside a git repository to get a list with the available commands and their description.
+
+| Command | Description |
+| --- | --- |
+| `gitflash checkout` | Select a local branch and check it out |
+| `gitflash delete` | Select local branches (excluding the current branch and main/master) and force-delete them |
+| `gitflash reset` | Select one of the latest 100 commits and reset to it (mixed reset) |
+| `gitflash reset --hard` | Same as `reset`, but discard all current changes after confirmation |
+| `gitflash version` | Print the installed version (also `--version`, `-v`) |
+
+Run `gitflash help <command>` for details on a command.
 
 ## Development
 

data/bin/gitflash

@@ -1,4 +1,5 @@
-#!/usr/bin/env ruby -wU
+#!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'gitflash'
 require 'gitflash/cli'

data/command_descriptions.yml

@@ -22,12 +22,12 @@ delete:
 reset:
   short: 'Reset your code to the selected commit'
   long: |
-    Accepts an optional parameter (hard) if you want to hard reset.
+    By default performs a mixed reset: your changes are kept as unstaged changes.
+    Pass --hard to discard all your current changes.
 
-    Presents a list with all the available commits.
+    Presents a list with the latest 100 commits of the current branch.
 
     You can use the arrow keys to navigate through the commits.
     Type for quick searching a specific commit.
-    Press `space` to choose multiple commits.
     Press `enter` to confirm selection and reset to that commit.
     Press `ctrl+c` to cancel the operation.

data/lib/gitflash/cli.rb

@@ -14,6 +14,7 @@ module Gitflash
     long_desc descriptions.checkout.long
 
     def checkout
+      ensure_git_repo!
       branches? ? checkout_branch : prompt.ok('You only have one branch!')
     end
 
@@ -21,6 +22,7 @@ module Gitflash
     long_desc descriptions.delete.long
 
     def delete
+      ensure_git_repo!
       branches? ? delete_branch : prompt.ok('You only have one branch!')
     end
 
@@ -29,7 +31,15 @@ module Gitflash
 
     option :hard, type: :boolean, default: false, desc: 'Perform a hard reset'
     def reset
-      commits? ? reset_to_commit : prompt.ok('You only have one branch!')
+      ensure_git_repo!
+      commits? ? reset_to_commit : prompt.ok('You only have one commit!')
+    end
+
+    desc 'version', 'Print the gitflash version'
+    map %w[--version -v] => :version
+
+    def version
+      puts VERSION
     end
 
     private
@@ -41,14 +51,15 @@ module Gitflash
         **checkout_options
       )
 
-      git.checkout(selection)
+      run_git('checkout') { git.checkout(selection) }
     end
 
     def delete_branch
-      selection = prompt.multi_select(
-        'Select branches to delete',
-        branches(options: { master: false, current: false })
-      )
+      choices = branches(options: { master: false, current: false })
+      return prompt.ok('No branches available to delete') if choices.empty?
+
+      selection = prompt.multi_select('Select branches to delete', choices)
+      return prompt.ok('No branches selected') if selection.empty?
 
       warning_message = <<~TEXT
         You are about to permanently delete the following branches even if they have unmerged changes:
@@ -56,7 +67,9 @@ module Gitflash
         #{selection.map { |br| "* #{br}" }.join("\n")}
       TEXT
 
-      prompt_proceed_warning(warning_message) { git.delete(selection) }
+      proceed_with_warning(warning_message) do
+        run_git('delete') { git.delete(selection) }
+      end
     end
 
     def reset_to_commit
@@ -65,12 +78,27 @@ module Gitflash
 
       if options[:hard]
         warning_message = 'You are about to reset your branch and lose all your current changes'
-        prompt.proceed_with_warning(warning_message) { git.reset(**reset_options) }
+        proceed_with_warning(warning_message) { run_git('reset') { git.reset(**reset_options) } }
       else
-        git.reset(**reset_options)
+        run_git('reset') { git.reset(**reset_options) }
       end
     end
 
+    def proceed_with_warning(message, &)
+      result = prompt.proceed_with_warning(message, &)
+      puts result if result == 'Exited'
+    end
+
+    def run_git(command)
+      raise Thor::Error, "git #{command} failed" unless yield
+    end
+
+    def ensure_git_repo!
+      git.inside_work_tree!
+    rescue Git::CommandError
+      raise Thor::Error, 'Not a git repository'
+    end
+
     def branches?
       all_branches && all_branches.size > 1
     end
@@ -83,15 +111,9 @@ module Gitflash
       @prompt ||= Prompt.create
     end
 
-    def prompt_proceed_warning(message)
-      prompt.warn(message)
-      answer = prompt.yes?('Do you want to proceed?')
-      puts answer ? yield : 'Exited'
-    end
-
     def checkout_options
       {}.tap do |opt|
-        opt[:default] = current unless current.nil?
+        opt[:default] = current unless current.to_s.empty?
       end
     end
 
@@ -108,7 +130,7 @@ module Gitflash
     end
 
     def branch_commits
-      @branch_commits = git.branch_commits
+      @branch_commits ||= git.branch_commits
     end
 
     def git

data/lib/gitflash/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 
 module Gitflash
@@ -20,7 +22,7 @@ module Gitflash
         keys = data.keys.map(&:to_sym)
         Struct.new(*keys).new(*data.values).tap do |st|
           keys.each do |method|
-            st.send("#{method}=".to_sym, transform_to_struct(st.send(method)))
+            st.public_send("#{method}=", transform_to_struct(st.public_send(method)))
           end
         end
       end

data/lib/gitflash/git/bash_command.rb

@@ -1,15 +1,24 @@
 # frozen_string_literal: true
 
+require 'open3'
+
 module Gitflash
   module Git
     class BashCommand
       class << self
-        def exec(command)
-          `#{command}`
+        # Runs a command without a shell and returns its stdout.
+        # Raises CommandError when the command exits with a non-zero status.
+        def exec(*args)
+          stdout, stderr, status = Open3.capture3(*args)
+          raise CommandError, "#{args.join(' ')} failed: #{stderr.strip}" unless status.success?
+
+          stdout
+        rescue SystemCallError => e
+          raise CommandError, "#{args.join(' ')} failed: #{e.message}"
         end
 
-        def system_exec(*args)
-          system(*args)
+        def system_exec(*)
+          system(*)
         end
       end
     end

data/lib/gitflash/git/command_error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Gitflash
+  module Git
+    class CommandError < StandardError; end
+  end
+end

data/lib/gitflash/git/wrapper.rb

@@ -3,25 +3,29 @@
 module Gitflash
   module Git
     class Wrapper
-      HIDDEN_BRANCHES = %w[–show-current].freeze
+      COMMITS_LIMIT = 100
 
       class << self
         def local_branches(current: true, master: true)
-          formatted_branches.tap do |branches|
-            hidden_branches(current, master).each { |br| branches.delete(br) }
-          end
+          formatted_branches - hidden_branches(current, master)
         end
 
         def all_local_branches
           formatted_branches
         end
 
+        # Raises CommandError when the working directory is not inside a git repository
+        def inside_work_tree!
+          output = bash.exec('git', 'rev-parse', '--is-inside-work-tree').strip
+          raise CommandError, 'Not inside a git work tree' unless output == 'true'
+        end
+
         def current_branch
-          bash.exec('git branch --show-current').strip
+          bash.exec('git', 'branch', '--show-current').strip
         end
 
         def checkout(branch)
-          bash.system_exec('git', 'checkout', branch)
+          bash.system_exec('git', 'checkout', branch, '--')
         end
 
         def delete(branch)
@@ -33,42 +37,44 @@ module Gitflash
             ar << '--hard' if hard
           end
 
-          bash.system_exec('git', 'reset', *params, commit_hash)
+          bash.system_exec('git', 'reset', *params, commit_hash, '--')
         end
 
         def branch_commits
-          commits_string = bash.exec('git log --oneline')
+          commits_string = bash.exec(
+            'git', 'log', "--max-count=#{COMMITS_LIMIT}", '--format=%h%x09%s'
+          )
+          parse_commits(commits_string)
+        rescue CommandError
+          # `git log` fails on a branch without commits
+          {}
+        end
+
+        private
+
+        def parse_commits(commits_string)
           {}.tap do |hsh|
             commits_string.each_line do |line|
-              parts = line.strip.split
-              commit_code = parts[0]
-              commit_name = parts[1..].join(' ')
-              label = "#{commit_code} - #{commit_name}"
-              hsh[label] = commit_code
+              commit_code, commit_name = line.chomp.split("\t", 2)
+              next if commit_code.nil? || commit_code.empty?
+
+              hsh["#{commit_code} - #{commit_name}"] = commit_code
             end
           end
         end
 
-        private
-
         def hidden_branches(current, master)
           [].tap { |hb|
-            hb.push('master') unless master
-            hb.push('main') unless master
+            hb.push('master', 'main') unless master
             hb.push(current_branch) unless current
-          } + HIDDEN_BRANCHES
+          }.reject(&:empty?)
         end
 
         def formatted_branches
-          raw_branches.map do |str|
-            next str unless str.start_with?('* ')
-
-            str.gsub('* ', '')
-          end
-        end
-
-        def raw_branches
-          bash.exec('git branch').strip.split("\n").map(&:strip)
+          bash.exec('git', 'for-each-ref', '--format=%(refname:short)', 'refs/heads/')
+              .split("\n")
+              .map(&:strip)
+              .reject(&:empty?)
         end
 
         def bash

data/lib/gitflash/prompt.rb

@@ -23,12 +23,12 @@ module Gitflash
       super(message, collection, default_select_options(options))
     end
 
-    def proceed_with_warning(message, &block)
+    def proceed_with_warning(message)
       raise ArgumentError, 'A block is required for this method' unless block_given?
 
       warn(message)
       answer = yes?('Do you want to proceed?')
-      answer ? block.call : 'Exited'
+      answer ? yield : 'Exited'
     end
 
     private

data/lib/gitflash/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gitflash
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,29 +1,34 @@
 --- !ruby/object:Gem::Specification
 name: gitflash
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Kleanthis Mitsioulis
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: tty-prompt
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +57,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
 description: This gem allows you to perform a number of git commands using interactive
   cli prompts
 email:
@@ -76,16 +67,16 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
-- bin/console
 - bin/gitflash
-- bin/setup
 - command_descriptions.yml
 - lib/gitflash.rb
 - lib/gitflash/cli.rb
 - lib/gitflash/configuration.rb
 - lib/gitflash/git/bash_command.rb
+- lib/gitflash/git/command_error.rb
 - lib/gitflash/git/wrapper.rb
 - lib/gitflash/prompt.rb
 - lib/gitflash/version.rb
@@ -93,11 +84,9 @@ homepage: https://github.com/Kleanthismits/git_flash
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/Kleanthismits/git_flash
   source_code_uri: https://github.com/Kleanthismits/git_flash
   changelog_uri: https://github.com/Kleanthismits/git_flash/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -105,15 +94,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Simplified usage of some git cli commands
 test_files: []

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'gitflash'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here