module Git::Repository::StatusOperations

Facade methods for repository-status operations

Provides methods for querying the state of the repository: checking whether any commits exist, listing untracked working-tree files, and listing files tracked in the index.

Included by {Git::Repository}.

@api private

Public Instance Methods

ls_files (location = nil)

Source

# File lib/git/repository/status_operations.rb, line 138
def ls_files(location = nil)
  location ||= '.'
  {}.tap do |files|
    Git::Commands::LsFiles.new(@execution_context).call(location, stage: true).stdout.split("\n").each do |line|
      info, file = Private.split_status_line(line)
      mode, sha, stage = info.split
      files[file] = { path: file, mode_index: mode, sha_index: sha, stage: stage }
    end
  end
end

List all files tracked in the index

Runs ‘git ls-files –stage` under the given `location` and returns a hash keyed by file path with per-file index metadata.

@example List all indexed files in the working tree

repo.ls_files
#=> { "README.md" => { path: "README.md", mode_index: "100644",
#=>                    sha_index: "abc123...", stage: "0" }, ... }

@example List indexed files under a specific directory

repo.ls_files('lib/')
#=> { "lib/git.rb" => { path: "lib/git.rb", ... }, ... }

@param location [String, nil] the path to restrict the listing to;

defaults to `'.'` (all tracked files) when `nil`

@return [Hash{String => Hash}] a hash of index entries keyed by file path

Each value is a Hash with the following keys:
* `:path` [String] the file path
* `:mode_index` [String] the file's index mode (e.g. `"100644"`)
* `:sha_index` [String] the file's index SHA
* `:stage` [String] the merge stage (`"0"` for normal entries)

@raise [Git::FailedError] if git exits with a non-zero exit status

no_commits? ()

Source

# File lib/git/repository/status_operations.rb, line 38
def no_commits?
  Git::Commands::RevParse.new(@execution_context).call('HEAD', verify: true)
  false
rescue Git::FailedError => e
  raise unless e.result.status.exitstatus == 128 &&
               e.result.stderr == 'fatal: Needed a single revision'

  true
end

Returns ‘true` if the repository has no commits yet

Checks whether ‘HEAD` can be resolved to a commit object. A brand-new repository (or one created with `git checkout –orphan`) where no commit has been made yet will have no commits.

@example Check whether a repository is empty

repo.no_commits? #=> true   # freshly initialized, no commits yet
repo.no_commits? #=> false  # at least one commit exists

@return [Boolean] ‘true` when the repository has no commits, `false` otherwise

@raise [Git::FailedError] if git exits with a non-zero exit status other

than when the repository has no commits

status_info ()

Source

# File lib/git/repository/status_operations.rb, line 102
def status_info
  result = Git::Commands::Status.new(@execution_context).call(
    porcelain: 'v2', z: true, untracked_files: 'all'
  )
  files = Git::Parsers::Status.parse(result.stdout)
  ignore_case = config_get('core.ignoreCase', type: 'bool')&.value == 'true'
  Git::StatusInfo.new(files: files, ignore_case: ignore_case)
end

Returns a {Git::StatusInfo} describing the index and working tree state

Runs ‘git status` in porcelain v2 format with NUL-separated entries and every untracked file listed individually, then reads `core.ignoreCase` as a boolean so that the path predicates on the result compare paths the way git does in this repository. Every entry type git reports is represented, including renames, copies, and merge conflicts. Clean tracked paths are not reported by `git status`, so they are absent from the result; {#ls_files} lists them.

@example Check which files are modified

repo.status_info.changed
#=> { "lib/foo.rb" => #<data Git::StatusFileInfo path="lib/foo.rb", ...> }

@example Check for untracked files

repo.status_info.untracked.keys #=> ["new_file.rb"]

@example Check one path

repo.status_info.changed?('lib/foo.rb') #=> true

@example Iterate over every entry

repo.status_info.files.each do |file|
  puts "#{file.index_status}#{file.worktree_status} #{file.path}"
end

@return [Git::StatusInfo] the status of the repository

@raise [Git::FailedError] if git exits with a non-zero exit status

@see git-scm.com/docs/git-status git-status

untracked_files ()

Source

# File lib/git/repository/status_operations.rb, line 65
def untracked_files
  Git::Commands::LsFiles.new(@execution_context).call(
    others: true, exclude_standard: true, chdir: @execution_context.git_work_dir
  ).stdout.split("\n").map { |f| Private.unescape_quoted_path(f) }
end

List all files in the working tree that are not tracked by git

Runs ‘git ls-files –others –exclude-standard` from the working tree root and returns an array of repository-relative file paths. Files that match `.gitignore` or other standard exclusion rules are omitted.

@example Get untracked files

repo.untracked_files #=> ["new_feature.rb", "tmp/debug.log"]

@example No untracked files

repo.untracked_files #=> []

@return [Array<String>] repository-relative paths of untracked,

non-ignored files; empty when there are none

@raise [Git::FailedError] if git exits with a non-zero exit status