git-status-tree 3.5.1 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92b497a283f3b3e3c260ea64423ad9350acc0973821ebad9b69fe2368cdf0324
-  data.tar.gz: 8fec32b7303b4de5e2390655b1d20ee53c4c7197cedba99fa17db348fbe942e8
+  metadata.gz: 465d1e069565fd9710b3ee6077ccedb08d94ffaf97b413a6f09fc6c18e24e277
+  data.tar.gz: 9a04be3d59a43020c81f251e87c18a8c3246bb63d1bd84873db8ba9aacb05a46
 SHA512:
-  metadata.gz: d551f8f7cb67163edde8680402d0092bb590ade73a4c4ec4ad97cf7551937e6d983f71e261eca8c5b27773bb9a51d7782a9c6096d80ef01a2afa4cd3947c74db
-  data.tar.gz: f1eb272a459af1b52b8c13c59fd1d510ff43c213692ed6159a53e4e468405b96711d3b5b7314acd6d2d45df7ae666c3a289149143381a50ba20d5e3fab659de0
+  metadata.gz: f07708afe5c16f2df3131e687ece19887f8ce8321552c5b26c5d3beca3ceab2978111c07ee72081ff2b6cab460f830819002c835146dcf4eacdcaaf6430a5669
+  data.tar.gz: eedfc54282fb88c3662f881dcf94d8b2ced92730f77d0e42ad2f3928916361520f769e5a9b06d9c16ea64e9ff6ac7a12887e489a57121536e9818be802a88a42

data/VERSION

@@ -1 +1 @@
-3.5.1
+3.7.0

data/bin/git-status-tree

@@ -8,7 +8,7 @@ require File.join File.dirname(__FILE__), '../lib/version'
 options = {}
 
 parser = OptionParser.new do |opts|
-  opts.banner = 'Usage: git-status-tree [options]'
+  opts.banner = 'Usage: git-status-tree [options] [<commit> [<commit>] | <commit>..<commit>]'
 
   opts.on('-i', '--indent INDENT', Integer, 'Set indentation (2-10 spaces)') do |indent|
     options[:indent] = indent
@@ -36,9 +36,24 @@ end
 begin
   parser.parse!
 rescue OptionParser::InvalidOption => e
-  puts "Error: #{e.message}"
-  puts parser
+  warn "Error: #{e.message}"
+  warn parser
   exit 1
 end
 
-puts GitStatusTree.new(options)
+# Residual ARGV holds the positional commit args (options are consumed by
+# parse!). At most two commits are accepted; a single "A..B" range token counts
+# as one positional and is expanded later in GitStatusTree.
+if ARGV.length > 2
+  warn 'Error: git tree accepts at most two commits'
+  warn parser
+  exit 1
+end
+options[:commits] = ARGV.dup
+
+begin
+  puts GitStatusTree.new(options)
+rescue GitStatusTree::RevisionError => e
+  warn e.message
+  exit 1
+end

data/lib/node.rb

@@ -11,7 +11,8 @@ class Node
   include NodeCollapsing
 
   class << self
-    attr_accessor :indent, :collapse_dirs
+    # mode is :status (default working-tree view) or :commit (history view).
+    attr_accessor :indent, :collapse_dirs, :mode
   end
 
   attr_accessor :status, :name, :children
@@ -129,9 +130,13 @@ class Node
     end
   end
 
-  def file? = children.nil?
+  def file?
+    children.nil?
+  end
 
-  def dir? = !file?
+  def dir?
+    !file?
+  end
 
   def valid?
     file? ? valid_file? : valid_dir?
@@ -168,17 +173,44 @@ class Node
     end
   end
 
-  def modified? = status.include?('M')
-  def added? = status.include?('A')
-  def deleted? = status.include?('D')
-  def renamed? = status.include?('R')
-  def copied? = status.include?('C')
-  def unmerged? = status.include?('U')
-  def new? = status.include?('?')
-  def staged? = status.include?('+')
+  def modified?
+    status.include?('M')
+  end
+
+  def added?
+    status.include?('A')
+  end
+
+  def deleted?
+    status.include?('D')
+  end
+
+  def renamed?
+    status.include?('R')
+  end
+
+  def copied?
+    status.include?('C')
+  end
+
+  def unmerged?
+    status.include?('U')
+  end
+
+  def new?
+    status.include?('?')
+  end
+
+  def staged?
+    staged_status?(status)
+  end
 
   private
 
+  def staged_status?(status)
+    status.include?('+')
+  end
+
   def validate_name!(name)
     msg = '"name" must be a String.'
     raise NodeNameError, msg unless name.is_a? String
@@ -196,13 +228,21 @@ class Node
     if dir?
       color_name += BashColor::EMB + name
     else
-      color_name += BashColor::G if staged?
-      color_name += BashColor::R unless staged?
+      color_name += status_color(status)
       color_name += "#{name} (#{status})"
     end
     color_name + BashColor::NONE
   end
 
+  # Commit-mode entries render in a distinct third color (cyan) to signal
+  # "history view, not your working tree". Status mode keeps the green=staged /
+  # red=dirty palette unchanged. Shared with the collapsed-file renderer.
+  def status_color(status)
+    return BashColor::C if self.class.mode == :commit
+
+    staged_status?(status) ? BashColor::G : BashColor::R
+  end
+
   def name_valid?
     name.is_a?(String) &&
       name.length.positive? &&

data/lib/node_collapsing.rb

@@ -104,7 +104,6 @@ module NodeCollapsing
   end
 
   def color_file_with_status(file_name, status)
-    color = status.include?('+') ? BashColor::G : BashColor::R
-    "#{color}#{file_name} (#{status})#{BashColor::NONE}"
+    "#{status_color(status)}#{file_name} (#{status})#{BashColor::NONE}"
   end
 end

data/src/git_status_tree.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'open3'
 require File.join File.dirname(__FILE__), '../lib/node'
 require File.join File.dirname(__FILE__), '../lib/node_collapsing'
 require File.join File.dirname(__FILE__), '../lib/nodes_collection'
@@ -8,19 +9,22 @@ require File.join File.dirname(__FILE__), '../lib/version'
 
 # Main class for generating and displaying git status as a tree structure
 class GitStatusTree
+  # Raised when a positional commit argument is not a valid revision.
+  class RevisionError < StandardError; end
+
   attr_reader :files, :nodes, :tree
 
   def initialize(options = {})
-    Node.indent = indent(options)
-    Node.collapse_dirs = collapse(options)
-    @files = parse_status(`git status --porcelain -z#{untracked_files(options)}`)
+    commits = Array(options[:commits])
+    configure_node(options, commits)
+    @files = source_files(commits, options)
     @nodes = files.map { |file| Node.create_from_string file }
     @tree = nodes.reduce { |a, i| (a + i).nodes[0] }
   end
 
   def to_s
     if tree.nil?
-      '(working directory clean)'
+      Node.mode == :commit ? '(no changes)' : '(working directory clean)'
     else
       tree.to_tree_s
     end
@@ -28,6 +32,110 @@ class GitStatusTree
 
   private
 
+  def configure_node(options, commits)
+    Node.indent = indent(options)
+    Node.collapse_dirs = collapse(options)
+    Node.mode = commits.empty? ? :status : :commit
+  end
+
+  # Dispatch on the number of commit args: no commits keeps the working-tree
+  # status view; one or two commits switch to the git diff-tree history view.
+  def source_files(commits, options)
+    if commits.empty?
+      parse_status(`git status --porcelain -z#{untracked_files(options)}`)
+    else
+      parse_diff_tree(diff_tree_output(commits))
+    end
+  end
+
+  def diff_tree_output(commits)
+    refs = validate_revs!(commits)
+    # -M enables rename detection (no -C: copy detection is off by default in
+    # git and is slower/noisier), -r recurses into subtrees, --no-commit-id
+    # suppresses the leading SHA line, --root lists every file as added for a
+    # root commit (no parent), -z gives unambiguous paths.
+    # --diff-merges=first-parent diffs a single merge commit against its first
+    # parent (diff-tree skips merges by default, and plain -m diffs against
+    # every parent); it is a no-op for a two-commit diff.
+    run_git!('diff-tree', '--no-commit-id', '--name-status', '-M', '-r', '--root',
+             '--diff-merges=first-parent', '-z', *refs)
+  end
+
+  # Run git with an argv array (no shell, so revisions are never word-split,
+  # globbed or interpreted) and raise RevisionError with git's own stderr on
+  # failure.
+  def run_git!(*args)
+    stdout, stderr, status = Open3.capture3('git', *args)
+    raise RevisionError, stderr.strip unless status.success?
+
+    stdout
+  end
+
+  # Translate diff-tree -z output into the porcelain entry strings the node
+  # pipeline already understands. The stream is "<status>\0<path>\0 …", with
+  # rename/copy entries spanning a triplet "<status>\0<old>\0<new>\0".
+  def parse_diff_tree(raw)
+    tokens = raw.force_encoding('UTF-8').split("\0")
+    files = []
+    index = 0
+    while index < tokens.length
+      status = tokens[index]
+      index += 1
+      next if status.nil? || status.empty?
+
+      index = append_diff_entry(files, tokens, index, status[0])
+    end
+    files
+  end
+
+  # Append a single porcelain entry and return the advanced token index.
+  # The status letter goes in the porcelain Y column so Node.status reads it
+  # verbatim (no staged "+" suffix), and commit-mode rendering colors it cyan.
+  def append_diff_entry(files, tokens, index, code)
+    if %w[R C].include?(code)
+      old = tokens[index]
+      new = tokens[index + 1]
+      files << " #{code} #{old} -> #{new}"
+      index + 2
+    else
+      files << " #{code} #{tokens[index]}"
+      index + 1
+    end
+  end
+
+  # Normalize positional args into resolved SHAs, expanding a single "A..B"
+  # token into two endpoints; an omitted side defaults to HEAD, as in git.
+  # "A...B" is rejected: diff-tree does not honor symmetric-difference
+  # semantics and would silently return nothing.
+  def validate_revs!(commits)
+    if commits.length == 1 && commits[0].include?('..')
+      if commits[0].include?('...')
+        raise RevisionError, "fatal: '#{commits[0]}': '...' range is not supported; use 'A..B'"
+      end
+
+      commits = commits[0].split('..', 2).map { |rev| rev.empty? ? 'HEAD' : rev }
+    end
+    commits.map { |rev| validate_rev!(rev) }
+  end
+
+  # Resolve first, then peel to a commit in a second step: appending ^{commit}
+  # to the user's text would break revisions like ":/message", where git
+  # treats everything after ":/" as the search pattern.
+  def validate_rev!(rev)
+    object = rev_parse(rev, rev)
+    rev_parse("#{object}^{commit}", rev)
+  end
+
+  def rev_parse(spec, rev)
+    stdout, stderr, status = Open3.capture3('git', 'rev-parse', '--verify', '--quiet', '--end-of-options', spec)
+    sha = stdout.strip
+    return sha if status.success? && !sha.empty?
+
+    # --quiet silences "bad revision"; any stderr left is a real git error
+    # (e.g. not a git repository), so surface it instead.
+    raise RevisionError, stderr.strip.empty? ? "fatal: bad revision '#{rev}'" : stderr.strip
+  end
+
   # Parse NUL-terminated `git status --porcelain -z` output into porcelain
   # entry strings. Unlike the default output, -z never quotes or escapes
   # paths, so names with spaces, non-ASCII characters, quotes, backslashes

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-status-tree
 version: !ruby/object:Gem::Version
-  version: 3.5.1
+  version: 3.7.0
 platform: ruby
 authors:
 - Wolfgang Teuber
@@ -45,14 +45,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.4'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.19
 specification_version: 4
 summary: git status in file tree format
 test_files: []