gitflash 0.1.2.alpha → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e2ab919eb4408a42c7bbd519e063a8f749e5c76802f078a410934bd6bf0faec
-  data.tar.gz: e821bb291632e98b292a0b6df49ede8836566904342026e9aa6693c8a0367ca6
+  metadata.gz: 308e1c6f4eba1ab9251d7606e919e91108df058d0618b04e2c8f35aac8370ad0
+  data.tar.gz: 47da55dc51b8f5b38e6dae281560f0dc880c3a58a95baea0689d4b0fd82536f7
 SHA512:
-  metadata.gz: 5f855639bd9cee9d4761198e37e86a5b76e3ce6641a35be10602aaeb2698524aedf6c0fb4df761f3fcb3e306629ced9816586c8f5c0adea7e9acdcacca3636f5
-  data.tar.gz: 8a90c367cea30c5bbc242bb73eced1907e773a6e6cbad0d3673f4cf07a27bbcc1c972256d60eafde834cdc1134de2fcc3142ee2c4c8d7aad1faaa7e2c1dfa48d
+  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 2.7+.
+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
 
@@ -37,7 +48,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/git_flash. 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/[USERNAME]/git_flash/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/Kleanthismits/git_flash. 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/Kleanthismits/git_flash/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -45,4 +56,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the GitFlash project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/git_flash/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the GitFlash project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Kleanthismits/git_flash/blob/main/CODE_OF_CONDUCT.md).

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

@@ -0,0 +1,33 @@
+checkout:
+  short: 'Checkout the selected branch'
+  long: |
+    Presents a list with all the available local branches.
+
+    You can use the arrow keys to navigate through the branches.
+    Type for quick searching a specific branch.
+    Press `enter` to choose and checkout the branch.
+    Press `ctrl+c` to cancel the operation.
+
+delete:
+  short: 'Delete the selected branches'
+  long: |
+    Presents a list with all the available local branches (without current or main/master).
+
+    You can use the arrow keys to navigate through the branches.
+    Type for quick searching a specific branch.
+    Press `space` to choose multiple branches.
+    Press `enter` to confirm selection and delete branches.
+    Press `ctrl+c` to cancel the operation.
+
+reset:
+  short: 'Reset your code to the selected commit'
+  long: |
+    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 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 `enter` to confirm selection and reset to that commit.
+    Press `ctrl+c` to cancel the operation.

data/lib/gitflash/cli.rb

@@ -4,41 +4,42 @@ require 'thor'
 
 module Gitflash
   class Cli < Thor
+    extend Configuration::Descriptions
+
     def self.exit_on_failure?
       true
     end
 
-    desc 'checkout', 'Checkout the selected branch'
-    long_desc <<-TEXT
-
-    Presents a list with all the available local branches.
-
-    You can use the arrow keys to navigate through the branches.
-    Type for quick searching a specific branch.
-    Press `enter` to choose and checkout the branch.
-    Press `ctrl+c` to cancel the operation.
-    TEXT
+    desc 'checkout', descriptions.checkout.short
+    long_desc descriptions.checkout.long
 
     def checkout
+      ensure_git_repo!
       branches? ? checkout_branch : prompt.ok('You only have one branch!')
     end
 
-    desc 'delete', 'Delete the selected branches'
-    long_desc <<-TEXT
+    desc 'delete', descriptions.delete.short
+    long_desc descriptions.delete.long
+
+    def delete
+      ensure_git_repo!
+      branches? ? delete_branch : prompt.ok('You only have one branch!')
+    end
 
-    Presents a list with all the available local branches(without current or main/master).
+    desc 'reset', descriptions.reset.short
+    long_desc descriptions.reset.long
 
-    You can use the arrow keys to navigate through the branches.
-    Type for quick searching a specific branch.
-    Press `space` to choose multiple branches.
-    Press `enter` to confirm selection and delete branches.
-    Press `ctrl+c` to cancel the operation.
+    option :hard, type: :boolean, default: false, desc: 'Perform a hard reset'
+    def reset
+      ensure_git_repo!
+      commits? ? reset_to_commit : prompt.ok('You only have one commit!')
+    end
 
-    WARNING: The branches will be deleted even if they have unmerged changes!!
-    TEXT
+    desc 'version', 'Print the gitflash version'
+    map %w[--version -v] => :version
 
-    def delete
-      branches? ? delete_branch : prompt.ok('You only have one branch!')
+    def version
+      puts VERSION
     end
 
     private
@@ -50,36 +51,69 @@ 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?
 
-      prompt.warn(<<~TEXT
+      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:
 
         #{selection.map { |br| "* #{br}" }.join("\n")}
       TEXT
-                 )
-      answer = prompt.yes?('Do you want to proceed?')
-      puts answer ? git.delete(selection) : 'Exited'
+
+      proceed_with_warning(warning_message) do
+        run_git('delete') { git.delete(selection) }
+      end
+    end
+
+    def reset_to_commit
+      selection = prompt.select('Select a commit to reset to', branch_commits)
+      reset_options = { commit_hash: selection, hard: options[:hard] }
+
+      if options[:hard]
+        warning_message = 'You are about to reset your branch and lose all your current changes'
+        proceed_with_warning(warning_message) { run_git('reset') { git.reset(**reset_options) } }
+      else
+        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
 
+    def commits?
+      branch_commits && branch_commits.size > 1
+    end
+
     def prompt
       @prompt ||= Prompt.create
     end
 
     def checkout_options
       {}.tap do |opt|
-        opt[:default] = current unless current.nil?
+        opt[:default] = current unless current.to_s.empty?
       end
     end
 
@@ -95,6 +129,10 @@ module Gitflash
       @current ||= git.current_branch
     end
 
+    def branch_commits
+      @branch_commits ||= git.branch_commits
+    end
+
     def git
       Gitflash::Git::Wrapper
     end

data/lib/gitflash/configuration.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Gitflash
+  module Configuration
+    module Descriptions
+      def descriptions
+        @descriptions ||= load_descriptions
+      end
+
+      private
+
+      def load_descriptions
+        file = File.expand_path('../../command_descriptions.yml', __dir__)
+        transform_to_struct(YAML.load_file(file))
+      end
+
+      def transform_to_struct(data)
+        return data unless data.is_a? Hash
+
+        keys = data.keys.map(&:to_sym)
+        Struct.new(*keys).new(*data.values).tap do |st|
+          keys.each do |method|
+            st.public_send("#{method}=", transform_to_struct(st.public_send(method)))
+          end
+        end
+      end
+    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

@@ -1,52 +1,80 @@
 # frozen_string_literal: true
+
 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)
+          bash.system_exec('git', 'branch', '-D', *branch)
+        end
+
+        def reset(commit_hash:, hard:)
+          params = [].tap do |ar|
+            ar << '--hard' if hard
+          end
+
+          bash.system_exec('git', 'reset', *params, commit_hash, '--')
         end
 
-        def delete(selection)
-          bash.system_exec('git', 'branch', '-D', *selection)
+        def branch_commits
+          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|
+              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
+
         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,9 +23,15 @@ module Gitflash
       super(message, collection, default_select_options(options))
     end
 
-    private
+    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 ? yield : 'Exited'
+    end
 
-    attr_reader :prompt
+    private
 
     def default_create_options(options)
       {
@@ -37,7 +43,6 @@ module Gitflash
     def default_select_options(options)
       {
         cycle: true,
-        per_page: 50,
         filter: true,
         symbols: { marker: '>' }
       }.merge(options)

data/lib/gitflash/version.rb

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

data/lib/gitflash.rb

@@ -5,7 +5,6 @@ original_verbose = $VERBOSE
 $VERBOSE = nil
 
 require 'zeitwerk'
-require 'pry'
 
 loader = Zeitwerk::Loader.for_gem
 loader.setup

metadata

@@ -1,15 +1,62 @@
 --- !ruby/object:Gem::Specification
 name: gitflash
 version: !ruby/object:Gem::Version
-  version: 0.1.2.alpha
+  version: 0.4.0
 platform: ruby
 authors:
 - Kleanthis Mitsioulis
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-04 00:00:00.000000000 Z
-dependencies: []
+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: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
 description: This gem allows you to perform a number of git commands using interactive
   cli prompts
 email:
@@ -20,14 +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
@@ -35,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
@@ -47,15 +94,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.2.15
-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