Class: Git::BranchDeleteResult

Inherits:
Data
  • Object
show all
Defined in:
lib/git/branch_delete_result.rb

Overview

Represents the result of a branch delete operation

This is an immutable data object returned by Commands::Branch::Delete#call. It contains information about which branches were successfully deleted and which failed to be deleted, along with the reason for each failure.

Git's git branch -d command uses "best effort" semantics - it deletes as many branches as possible and reports errors for those that couldn't be deleted. This result object reflects that behavior, allowing callers to inspect both successes and failures.

Examples:

Successful deletion of all branches

result = branch_delete.call('feature-1', 'feature-2')
result.success?            #=> true
result.deleted.map(&:name) #=> ['feature-1', 'feature-2']
result.not_deleted         #=> []

Partial failure (some branches deleted, some not found)

result = branch_delete.call('feature-1', 'nonexistent', 'feature-2')
result.success?                    #=> false
result.deleted.map(&:name)         #=> ['feature-1', 'feature-2']
result.not_deleted.first.name          #=> 'nonexistent'
result.not_deleted.first.error_message #=> "branch 'nonexistent' not found."

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#deleted ⇒ Array<Git::BranchInfo> (readonly)

Branches that were successfully deleted

Returns:



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/git/branch_delete_result.rb', line 49

BranchDeleteResult = Data.define(:deleted, :not_deleted) do
  # Returns true if all requested branches were successfully deleted
  #
  # @example Check if the delete operation succeeded
  #   result = branch_delete.call('feature-branch')
  #   if result.success?
  #     puts "All branches deleted successfully"
  #   else
  #     puts "Some branches could not be deleted:"
  #     result.not_deleted.each { |f| puts "  #{f.name}: #{f.error_message}" }
  #   end
  #
  # @return [Boolean] true if no branches failed to delete, false otherwise
  def success?
    not_deleted.empty?
  end
end

#not_deleted ⇒ Array<Git::BranchDeleteFailure> (readonly)

Branches that could not be deleted, with the reason for each failure

Returns:



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/git/branch_delete_result.rb', line 49

BranchDeleteResult = Data.define(:deleted, :not_deleted) do
  # Returns true if all requested branches were successfully deleted
  #
  # @example Check if the delete operation succeeded
  #   result = branch_delete.call('feature-branch')
  #   if result.success?
  #     puts "All branches deleted successfully"
  #   else
  #     puts "Some branches could not be deleted:"
  #     result.not_deleted.each { |f| puts "  #{f.name}: #{f.error_message}" }
  #   end
  #
  # @return [Boolean] true if no branches failed to delete, false otherwise
  def success?
    not_deleted.empty?
  end
end

Instance Method Details

#success? ⇒ Boolean

Returns true if all requested branches were successfully deleted

Examples:

Check if the delete operation succeeded

result = branch_delete.call('feature-branch')
if result.success?
  puts "All branches deleted successfully"
else
  puts "Some branches could not be deleted:"
  result.not_deleted.each { |f| puts "  #{f.name}: #{f.error_message}" }
end

Returns:

  • (Boolean) —

    true if no branches failed to delete, false otherwise



62
63
64
 
# File 'lib/git/branch_delete_result.rb', line 62

def success?
  not_deleted.empty?
end