gitflash 0.3.0 → 0.5.0

data/schema/v1.json

@@ -0,0 +1,172 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/Kleanthismits/git_flash/blob/main/schema/v1.json",
+  "title": "gitflash --json output, schema version 1",
+  "description": "Every gitflash command run with --json prints exactly one object in this envelope. `ok` is true for the statuses done, planned, noop and cancelled. Fields may be added in later releases of version 1; existing fields keep their meaning.",
+  "type": "object",
+  "required": ["schema", "command", "ok", "status", "dry_run"],
+  "properties": {
+    "schema": { "const": 1 },
+    "command": { "enum": ["branches", "checkout", "delete", "reset"] },
+    "ok": { "type": "boolean" },
+    "status": {
+      "description": "done: the change was made. planned: --dry-run, nothing changed. noop: nothing to do. cancelled: the user declined. failed: git refused part of the change. confirmation_required: re-run with --yes after reviewing `plan`. error: invalid input or environment.",
+      "enum": ["done", "planned", "noop", "cancelled", "failed", "confirmation_required", "error"]
+    },
+    "dry_run": { "type": "boolean" },
+    "plan": { "type": "object", "description": "The change that will be, would be or was made." },
+    "result": { "type": "object", "description": "What happened, including what is needed to revert it." },
+    "error": { "$ref": "#/$defs/error" }
+  },
+  "allOf": [
+    {
+      "if": { "properties": { "status": { "enum": ["done", "planned", "noop", "cancelled"] } } },
+      "then": { "properties": { "ok": { "const": true } }, "not": { "required": ["error"] } },
+      "else": { "properties": { "ok": { "const": false } }, "required": ["error"] }
+    },
+    {
+      "if": { "properties": { "status": { "const": "confirmation_required" } } },
+      "then": { "required": ["plan"] }
+    },
+    {
+      "if": { "properties": { "command": { "const": "branches" } } },
+      "then": { "properties": { "result": { "$ref": "#/$defs/branches_result" } } }
+    },
+    {
+      "if": { "properties": { "command": { "const": "checkout" } } },
+      "then": {
+        "properties": {
+          "plan": { "$ref": "#/$defs/checkout_plan" },
+          "result": { "$ref": "#/$defs/checkout_result" }
+        }
+      }
+    },
+    {
+      "if": { "properties": { "command": { "const": "delete" } } },
+      "then": {
+        "properties": {
+          "plan": { "$ref": "#/$defs/delete_plan" },
+          "result": { "$ref": "#/$defs/delete_result" }
+        }
+      }
+    },
+    {
+      "if": { "properties": { "command": { "const": "reset" } } },
+      "then": {
+        "properties": {
+          "plan": { "$ref": "#/$defs/reset_plan" },
+          "result": { "$ref": "#/$defs/reset_result" }
+        }
+      }
+    }
+  ],
+  "$defs": {
+    "sha": { "type": "string", "pattern": "^[0-9a-f]{4,64}$" },
+    "error": {
+      "type": "object",
+      "required": ["code", "message", "exit_code"],
+      "properties": {
+        "code": {
+          "description": "Stable identifier to branch on; the message is for humans.",
+          "enum": [
+            "not_a_repository", "input_required", "invalid_usage", "invalid_options",
+            "unknown_branch", "unknown_commit", "protected_branch",
+            "confirmation_required", "git_failed", "failed"
+          ]
+        },
+        "message": { "type": "string" },
+        "exit_code": { "enum": [1, 2] }
+      }
+    },
+    "branch": {
+      "type": "object",
+      "required": [
+        "name", "sha", "current", "default", "upstream", "upstream_gone", "ahead", "behind",
+        "merged", "last_commit_at", "last_commit_author", "last_commit_subject"
+      ],
+      "properties": {
+        "name": { "type": "string" },
+        "sha": { "$ref": "#/$defs/sha" },
+        "current": { "type": "boolean" },
+        "default": { "type": "boolean", "description": "The branch origin/HEAD points to, else main or master." },
+        "upstream": { "type": ["string", "null"] },
+        "upstream_gone": { "type": "boolean", "description": "The upstream branch was deleted on the remote." },
+        "ahead": { "type": "integer", "minimum": 0 },
+        "behind": { "type": "integer", "minimum": 0 },
+        "merged": { "type": ["boolean", "null"], "description": "Merged into the default branch; null when there is no default branch." },
+        "last_commit_at": { "type": "string", "format": "date-time" },
+        "last_commit_author": { "type": "string" },
+        "last_commit_subject": { "type": "string" }
+      }
+    },
+    "branches_result": {
+      "type": "object",
+      "required": ["default_branch", "branches"],
+      "properties": {
+        "default_branch": { "type": ["string", "null"] },
+        "branches": { "type": "array", "items": { "$ref": "#/$defs/branch" } }
+      }
+    },
+    "checkout_plan": {
+      "type": "object",
+      "required": ["branch"],
+      "properties": { "branch": { "type": "string" } }
+    },
+    "checkout_result": {
+      "type": "object",
+      "required": ["branch", "previous_branch"],
+      "properties": {
+        "branch": { "type": ["string", "null"] },
+        "previous_branch": { "type": ["string", "null"], "description": "Check this out to go back; null on a detached HEAD." }
+      }
+    },
+    "delete_plan": {
+      "type": "object",
+      "required": ["branches", "force"],
+      "properties": {
+        "branches": { "type": "array", "items": { "type": "string" } },
+        "force": { "type": "boolean" }
+      }
+    },
+    "delete_result": {
+      "type": "object",
+      "required": ["deleted", "failed"],
+      "properties": {
+        "deleted": {
+          "type": "array",
+          "description": "Recreate a branch with: git branch NAME SHA",
+          "items": {
+            "type": "object",
+            "required": ["branch", "sha"],
+            "properties": { "branch": { "type": "string" }, "sha": { "$ref": "#/$defs/sha" } }
+          }
+        },
+        "failed": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": ["branch", "error"],
+            "properties": { "branch": { "type": "string" }, "error": { "type": "string" } }
+          }
+        }
+      }
+    },
+    "reset_plan": {
+      "type": "object",
+      "required": ["commit", "mode"],
+      "properties": {
+        "commit": { "$ref": "#/$defs/sha" },
+        "mode": { "enum": ["soft", "mixed", "hard"] }
+      }
+    },
+    "reset_result": {
+      "type": "object",
+      "required": ["commit", "mode", "previous_commit"],
+      "properties": {
+        "commit": { "$ref": "#/$defs/sha" },
+        "mode": { "enum": ["soft", "mixed", "hard"] },
+        "previous_commit": { "$ref": "#/$defs/sha", "description": "Reset to this commit to go back. Uncommitted changes lost by a hard reset cannot be restored this way." }
+      }
+    }
+  }
+}

metadata

@@ -1,29 +1,34 @@
 --- !ruby/object:Gem::Specification
 name: gitflash
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.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,28 +67,39 @@ 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/branch.rb
 - lib/gitflash/cli.rb
+- lib/gitflash/commands/base.rb
+- lib/gitflash/commands/branches.rb
+- lib/gitflash/commands/checkout.rb
+- lib/gitflash/commands/delete.rb
+- lib/gitflash/commands/reset.rb
+- lib/gitflash/commit.rb
 - lib/gitflash/configuration.rb
+- lib/gitflash/confirmation_required.rb
+- lib/gitflash/error.rb
 - lib/gitflash/git/bash_command.rb
-- lib/gitflash/git/wrapper.rb
+- lib/gitflash/git/command_error.rb
 - lib/gitflash/prompt.rb
+- lib/gitflash/repo.rb
+- lib/gitflash/result.rb
+- lib/gitflash/ui.rb
+- lib/gitflash/usage_error.rb
 - lib/gitflash/version.rb
+- schema/v1.json
 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 +107,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

data/lib/gitflash/git/wrapper.rb

@@ -1,80 +0,0 @@
-# frozen_string_literal: true
-
-module Gitflash
-  module Git
-    class Wrapper
-      HIDDEN_BRANCHES = %w[–show-current].freeze
-
-      class << self
-        def local_branches(current: true, master: true)
-          formatted_branches.tap do |branches|
-            hidden_branches(current, master).each { |br| branches.delete(br) }
-          end
-        end
-
-        def all_local_branches
-          formatted_branches
-        end
-
-        def current_branch
-          bash.exec('git branch --show-current').strip
-        end
-
-        def 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 branch_commits
-          commits_string = bash.exec('git log --oneline')
-          {}.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
-            end
-          end
-        end
-
-        private
-
-        def hidden_branches(current, master)
-          [].tap { |hb|
-            hb.push('master') unless master
-            hb.push('main') unless master
-            hb.push(current_branch) unless current
-          } + HIDDEN_BRANCHES
-        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)
-        end
-
-        def bash
-          BashCommand
-        end
-      end
-    end
-  end
-end