gitflash 0.7.0.beta1 → 0.7.0.beta3

data/lib/gitflash/state_capture.rb

@@ -18,8 +18,11 @@ module Gitflash
       'GIT_AUTHOR_DATE' => '1970-01-01T00:00:00Z', 'GIT_COMMITTER_DATE' => '1970-01-01T00:00:00Z'
     }.freeze
 
-    def initialize(bash: Git::BashCommand)
+    # `exclude` says whether an untracked path must stay out of snapshots; by default the
+    # `snapshot_exclude` setting of the repository decides
+    def initialize(bash: Git::BashCommand, exclude: nil)
       @bash = bash
+      @exclude = exclude
     end
 
     # Snapshot fields except id, time and reason. `branch_names` nil records every branch.
@@ -30,7 +33,7 @@ module Gitflash
         head: { branch: current_branch, sha: head_sha },
         branches: scope.include?('branches') ? branch_tips(branch_names) : {},
         stashes: scope.include?('stashes') ? try('stash', 'list', '--format=%H').to_s.split : [],
-        index: nil, worktree: nil, skipped_files: []
+        index: nil, worktree: nil, skipped_files: [], excluded_files: []
       }
       state.merge!(worktree(head_sha)) if scope.include?('worktree') && dirty?
       state
@@ -48,13 +51,15 @@ module Gitflash
     private
 
     def git(*, env: {})
-      @bash.exec('git', *, env: env).strip
+      # Only git's final newline goes: a path may start or end with whitespace, even a carriage
+      # return, which `chomp` would take together with the newline
+      @bash.exec('git', *, env: env).delete_suffix("\n")
     end
 
     # Stripped stdout, or nil when the command fails
     def try(*)
       stdout, _stderr, success = @bash.capture('git', *)
-      success ? stdout.strip : nil
+      success ? stdout.delete_suffix("\n") : nil
     end
 
     def rev(ref)
@@ -78,11 +83,11 @@ module Gitflash
     def worktree(head_sha)
       parents = [head_sha].compact
       index_tree = try('write-tree') # nil while a merge conflict is unresolved
-      tree, skipped = worktree_tree
+      tree, skipped, excluded = worktree_tree
       {
         index: index_tree && content_commit(index_tree, parents, 'gitflash index'),
         worktree: content_commit(tree, parents, 'gitflash worktree'),
-        skipped_files: skipped
+        skipped_files: skipped, excluded_files: excluded
       }
     end
 
@@ -100,30 +105,27 @@ module Gitflash
         env = { 'GIT_INDEX_FILE' => file.path }
 
         git('-C', top, 'add', '--update', env: env)
-        skipped = add_untracked(top, env)
-        [git('write-tree', env: env), skipped]
+        skipped, excluded = add_untracked(top, env)
+        [git('write-tree', env: env), skipped, excluded]
       end
     end
 
-    # [path, size] pairs. A file removed since `ls-files` ran (a build writing temporary files)
-    # is left out, so `git add` is not given a path that is gone.
-    def file_sizes(top, paths)
-      paths.filter_map do |path|
-        [path, File.lstat(File.join(top, path)).size]
-      rescue Errno::ENOENT
-        nil
-      end
-    end
-
-    # Adds untracked files that are not ignored; returns the ones skipped for their size
+    # Adds untracked files that are not ignored; returns [skipped for their size, excluded by
+    # snapshot_exclude]
     def add_untracked(top, env)
       paths = git('-C', top, 'ls-files', '-z', '--others', '--exclude-standard')
               .split("\0").reject { |path| path.end_with?('/') }
-      sizes = file_sizes(top, paths)
-      small, large = sizes.partition { |_path, size| size <= MAX_UNTRACKED_FILE_BYTES }
-                          .map { |group| group.map(&:first) }
-      small.each_slice(ADD_BATCH_SIZE) { |batch| git('-C', top, 'add', '--', *batch, env: env) }
-      large
+      excluded, paths = paths.partition { |path| exclude.call(path) }
+      small, large = UntrackedFiles.split_by_size(top, paths, MAX_UNTRACKED_FILE_BYTES)
+      # File names are literal paths, never pathspec magic such as `:(exclude)*`
+      small.each_slice(ADD_BATCH_SIZE) do |batch|
+        git('--literal-pathspecs', '-C', top, 'add', '--', *batch, env: env)
+      end
+      [large, excluded]
+    end
+
+    def exclude
+      @exclude ||= Config.load(root: Repo.new(bash: @bash).main_root).method(:snapshot_excluded?)
     end
   end
 end

data/lib/gitflash/terminal_text.rb

@@ -15,5 +15,14 @@ module Gitflash
         format(char.ord > 0xFF ? '\\u%04X' : '\\x%02X', char.ord)
       end
     end
+
+    # Text that must stay on one line, such as a path inside a bullet list: as `safe`, and a
+    # newline or tab in it is shown as an escape too, so it cannot start a fake row. A literal
+    # backslash is doubled first, so two different texts never look the same (a real newline
+    # shows as `\n`, the two characters backslash and n as `\\n`); that keeps menu labels unique.
+    def line(text)
+      doubled = text.to_s.scrub.gsub('\\') { '\\\\' }
+      safe(doubled).gsub("\n") { '\\n' }.gsub("\t") { '\\t' }
+    end
   end
 end

data/lib/gitflash/ui.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'digest'
 require 'json'
 
 module Gitflash
@@ -12,11 +13,12 @@ module Gitflash
     JSON_SCHEMA_VERSION = 1
     OK_STATUSES = %w[done planned noop cancelled].freeze
 
-    def initialize(command:, json: false, yes: false, dry_run: false)
+    def initialize(command:, json: false, yes: false, dry_run: false, confirm: nil)
       @command = command
       @json = json
       @yes = yes
       @dry_run = dry_run
+      @confirm = confirm
     end
 
     def json?
@@ -46,7 +48,9 @@ module Gitflash
 
     def error(error)
       if json?
-        details = { code: error.code, message: error.message, exit_code: error.exit_code }
+        details = { code: error.code, message: error.message, exit_code: error.exit_code,
+                    confirm_token: error.respond_to?(:confirm_token) ? error.confirm_token : nil }
+                  .compact
         $stdout.puts JSON.generate(envelope(status: error.status, plan: error.plan, error: details))
       else
         warn TerminalText.safe(error.message)
@@ -63,17 +67,41 @@ module Gitflash
 
     # True when the action may proceed: --yes was given or the user confirmed in a terminal.
     # Raises ConfirmationRequired, carrying the plan, when nobody can confirm.
-    def confirm?(summary, plan:)
+    #
+    # An irreversible action (one `gitflash undo` cannot revert) is not covered by --yes: it
+    # needs --confirm with a token made from its plan, or the token typed in a terminal. The
+    # token changes with the plan, so a confirmation never carries over to a different change.
+    def confirm?(summary, plan:, irreversible: false)
+      return confirm_irreversible?(summary, plan) if irreversible
       return true if @yes
 
       message = "#{summary}\nRe-run with --yes to confirm."
       raise ConfirmationRequired.new(message, plan: plan) unless interactive?
 
-      prompt.proceed_with_warning(summary) { true } == true
+      prompt.proceed_with_warning(TerminalText.safe(summary)) { true } == true
+    end
+
+    # The token that confirms this plan with --confirm
+    def self.confirm_token(plan)
+      Digest::SHA256.hexdigest(JSON.generate(plan))[0, 8]
     end
 
     private
 
+    def confirm_irreversible?(summary, plan)
+      token = self.class.confirm_token(plan)
+      return true if @confirm == token
+
+      summary = "#{summary}\ngitflash undo cannot revert this."
+      unless interactive?
+        message = "#{summary}\nRe-run with --confirm #{token} to confirm (--yes is not enough)."
+        raise ConfirmationRequired.new(message, plan: plan, confirm_token: token)
+      end
+
+      warn TerminalText.safe(summary)
+      prompt.ask("Type #{token} to confirm:").to_s.strip == token
+    end
+
     def envelope(status:, plan: nil, result: nil, error: nil, undo: nil)
       {
         schema: JSON_SCHEMA_VERSION,

data/lib/gitflash/untracked_files.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Gitflash
+  # Sizes of untracked files, for StateCapture
+  module UntrackedFiles
+    module_function
+
+    # [paths up to max bytes, larger paths]. A file removed since `ls-files` ran (a build
+    # writing temporary files) is left out, so `git add` is not given a path that is gone.
+    def split_by_size(top, paths, max)
+      sizes = paths.filter_map do |path|
+        [path, File.lstat(File.join(top, path)).size]
+      rescue Errno::ENOENT
+        nil
+      end
+      sizes.partition { |_path, size| size <= max }.map { |group| group.map(&:first) }
+    end
+  end
+end

data/lib/gitflash/usage_report.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Gitflash
+  # Prints an error Thor raised while reading the command line (an unknown option, a value
+  # outside an enum, a missing argument) as gitflash's own errors are printed: in the JSON
+  # envelope with --json, else as text on stderr.
+  class UsageReport
+    TRUE_VALUES = %w[true TRUE t T].freeze
+    FALSE_VALUES = %w[false FALSE f F].freeze
+
+    # The command names the JSON envelope knows (schema/v1.json)
+    def self.commands
+      @commands ||= JSON.parse(File.read(Cli::SCHEMA_PATH)).dig('properties', 'command', 'enum')
+    end
+
+    def initialize(args)
+      @args = args
+    end
+
+    def print(error)
+      error = UsageError.new(error.message)
+      return Ui.new(command: command, json: true).error(error) if json?
+
+      warn TerminalText.safe(error.message)
+    end
+
+    private
+
+    # Whether the command line asks for JSON, read as Thor reads a boolean: `--json`,
+    # `--json=t` and the like, `--json false`; the last one given wins
+    def json?
+      @args.each_with_index.reduce(false) do |json, (arg, index)|
+        if arg == '--json' then !FALSE_VALUES.include?(@args[index + 1])
+        elsif arg.start_with?('--json=') then TRUE_VALUES.include?(arg.delete_prefix('--json='))
+        elsif arg == '--no-json' then false
+        else json
+        end
+      end
+    end
+
+    # The command as the envelope names it: `wt` and `worktree` subcommands as
+    # `worktree SUBCOMMAND`, `hook SUBCOMMAND`, else the first word; `gitflash` when the line
+    # names no known command
+    def command
+      words = @args.reject { |arg| arg.start_with?('-') }
+      first = resolve(Cli, words.first.to_s)
+      first = 'worktree' if first == 'wt'
+      name = case first
+             when 'worktree' then "worktree #{resolve(WorktreeCli, words[1].to_s)}"
+             when 'hook' then "hook #{resolve(HookCli, words[1].to_s)}"
+             else first
+             end
+      self.class.commands.include?(name) ? name : 'gitflash'
+    end
+
+    # The command Thor runs for a word: itself, or the one command it is an unambiguous prefix
+    # of (Thor runs `mar` as `mark`)
+    def resolve(klass, word)
+      names = klass.all_commands.keys.map { |key| key.tr('_', '-') }
+      return word if names.include?(word)
+
+      matches = names.select { |key| key.start_with?(word) }
+      matches.one? && !word.empty? ? matches.first : word
+    end
+  end
+end

data/lib/gitflash/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gitflash
-  VERSION = '0.7.0.beta1'
+  VERSION = '0.7.0.beta3'
 end

data/lib/gitflash/worktree.rb

@@ -17,16 +17,16 @@ module Gitflash
     # Why this worktree must not be removed, nil when it can go. `current` is true for the
     # worktree gitflash runs in. The main checkout and the current one are never removable.
     def removal_blocker(force:, current:)
-      return "#{path} is the main checkout" if main?
-      return "#{path} is the current worktree" if current
+      return "#{TerminalText.line(path)} is the main checkout" if main?
+      return "#{TerminalText.line(path)} is the current worktree" if current
 
       in_use_blocker unless force || (missing? && !locked?)
     end
 
     def in_use_blocker
-      return "#{path} is locked (use --force)" if locked?
+      return "#{TerminalText.line(path)} is locked (use --force)" if locked?
 
-      "#{path} has uncommitted changes (use --force)" if dirty? != false
+      "#{TerminalText.line(path)} has uncommitted changes (use --force)" if dirty? != false
     end
   end
 end

data/schema/v1.json

@@ -37,8 +37,10 @@
         "clean",
         "worktree clean",
         "pick",
-        "mark"
-      ]
+        "mark",
+        "gitflash"
+      ],
+      "description": "`gitflash` when the command line names no known command (an invalid_usage error)."
     },
     "ok": {
       "type": "boolean"
@@ -575,6 +577,10 @@
             1,
             2
           ]
+        },
+        "confirm_token": {
+          "type": "string",
+          "description": "Only for a change gitflash undo cannot revert: re-run with --confirm TOKEN to make it. --yes is not enough. The token belongs to this plan."
         }
       }
     },
@@ -908,6 +914,13 @@
             "type": "string"
           },
           "description": "Untracked files not saved because they are larger than 50 MB."
+        },
+        "excluded_files": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Untracked files not saved because the snapshot_exclude setting matches them."
         }
       }
     },
@@ -924,6 +937,10 @@
         "snapshot": {
           "type": "string"
         },
+        "reason": {
+          "type": "string",
+          "description": "Why the snapshot was taken, such as `agent hook: before ...`; check it before confirming."
+        },
         "branches": {
           "type": "array",
           "items": {
@@ -1093,6 +1110,22 @@
         "marking_command": {
           "type": "string",
           "description": "The PostToolUse command that marks branches an agent creates as agent work."
+        },
+        "mode": {
+          "enum": [
+            "snapshot",
+            "ask",
+            "deny"
+          ],
+          "description": "The mode the PreToolUse hook runs in after this install."
+        },
+        "previous_mode": {
+          "enum": [
+            "snapshot",
+            "ask",
+            "deny"
+          ],
+          "description": "The mode the installed hook had, when this install changes it."
         }
       }
     },
@@ -1592,6 +1625,10 @@
         "skipped"
       ],
       "properties": {
+        "warning": {
+          "type": "string",
+          "description": "Set when the repository has an origin remote but no origin/HEAD: the default branch, and so what counts as merged, was guessed."
+        },
         "branches": {
           "type": "array",
           "items": {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitflash
 version: !ruby/object:Gem::Version
-  version: 0.7.0.beta1
+  version: 0.7.0.beta3
 platform: ruby
 authors:
 - Kleanthis Mitsioulis
@@ -73,8 +73,10 @@ files:
 - bin/gitflash
 - command_descriptions.yml
 - lib/gitflash.rb
+- lib/gitflash/atomic_file.rb
 - lib/gitflash/branch.rb
 - lib/gitflash/cherry_pick.rb
+- lib/gitflash/cherry_pick/log_parser.rb
 - lib/gitflash/cleanup.rb
 - lib/gitflash/cli.rb
 - lib/gitflash/command_runner.rb
@@ -117,9 +119,19 @@ files:
 - lib/gitflash/hook/branch_marker.rb
 - lib/gitflash/hook/claude.rb
 - lib/gitflash/hook/command_parser.rb
+- lib/gitflash/hook/command_words.rb
 - lib/gitflash/hook/creations.rb
+- lib/gitflash/hook/failure.rb
+- lib/gitflash/hook/git_invocation.rb
+- lib/gitflash/hook/history_rules.rb
+- lib/gitflash/hook/losses.rb
+- lib/gitflash/hook/messages.rb
+- lib/gitflash/hook/paths.rb
 - lib/gitflash/hook/rules.rb
 - lib/gitflash/hook/settings.rb
+- lib/gitflash/hook/shell_quotes.rb
+- lib/gitflash/hook/shell_text.rb
+- lib/gitflash/hook/wrappers.rb
 - lib/gitflash/hook_cli.rb
 - lib/gitflash/ownership.rb
 - lib/gitflash/prompt.rb
@@ -128,11 +140,14 @@ files:
 - lib/gitflash/restore.rb
 - lib/gitflash/result.rb
 - lib/gitflash/snapshot.rb
+- lib/gitflash/snapshot_check.rb
 - lib/gitflash/snapshots.rb
 - lib/gitflash/state_capture.rb
 - lib/gitflash/terminal_text.rb
 - lib/gitflash/ui.rb
+- lib/gitflash/untracked_files.rb
 - lib/gitflash/usage_error.rb
+- lib/gitflash/usage_report.rb
 - lib/gitflash/version.rb
 - lib/gitflash/worktree.rb
 - lib/gitflash/worktree_cli.rb