git 5.0.0.beta.2 → 5.0.0.beta.4

data/lib/git/status.rb

@@ -1,12 +1,18 @@
 # frozen_string_literal: true
 
-# These would be required by the main `git.rb` file
-
 module Git
   # The Status class gets the status of a git repository. It identifies which
   # files have been modified, added, or deleted, including untracked files.
   # The Status object is an Enumerable of StatusFile objects.
   #
+  # @example Inspect repository status
+  #   repo = Git.open('/path/to/repo')
+  #   status = repo.status
+  #   status.changed.each { |path, _file| puts "Modified: #{path}" }
+  #   status.added.each { |path, _file| puts "Added: #{path}" }
+  #   status.deleted.each { |path, _file| puts "Deleted: #{path}" }
+  #   status.untracked.each { |path, _file| puts "Untracked: #{path}" }
+  #
   # @api public
   #
   class Status
@@ -91,13 +97,19 @@ module Git
 
     # Iterate over all status files
     #
-    # @yield [file] each {Git::Status::StatusFile} in the repository
+    # @overload each
     #
-    # @yieldparam file [Git::Status::StatusFile] a single file's status
+    #   @return [Enumerator<Git::Status::StatusFile>] an enumerator over all status files
+    #
+    # @overload each(&block)
     #
-    # @return [Enumerator<Git::Status::StatusFile>] if no block is given
+    #   @return [Array<Git::Status::StatusFile>] the full list of status files
     #
-    # @return [Array<Git::Status::StatusFile>] if a block is given
+    #   @yield [file] each {Git::Status::StatusFile} in the repository
+    #
+    #   @yieldparam file [Git::Status::StatusFile] a single file's status
+    #
+    #   @yieldreturn [void]
     #
     def each(&) = @files.values.each(&)
 
@@ -131,11 +143,13 @@ module Git
 
     # Return a hash of files for which the block returns a truthy value
     #
+    # @return [Hash{String => Git::Status::StatusFile}] matching files keyed by path
+    #
     # @yield [file] each {Git::Status::StatusFile} in the repository
     #
     # @yieldparam file [Git::Status::StatusFile] a single file's status
     #
-    # @return [Hash{String => Git::Status::StatusFile}] matching files keyed by path
+    # @yieldreturn [Boolean] truthy to include the file in the result
     #
     def select_files(&block)
       @files.select { |_path, file| block.call(file) }
@@ -172,17 +186,15 @@ module Git
 
     # Return `true` when git is configured to ignore filename case
     #
-    # Reads `core.ignoreCase` from the repository config. Returns `false` if
-    # the config value is absent or if reading it raises {Git::FailedError}.
+    # Reads `core.ignoreCase` with {Git::Repository#config_get}. Returns `false`
+    # when the config value is absent.
     #
     # @return [Boolean] `true` when `core.ignoreCase` is `"true"`
     #
     def ignore_case?
-      return @_ignore_case if defined?(@_ignore_case)
+      return @ignore_case if defined?(@ignore_case)
 
-      @_ignore_case = (@base.config('core.ignoreCase') == 'true')
-    rescue Git::FailedError
-      @_ignore_case = false
+      @ignore_case = (@base.config_get('core.ignoreCase')&.value == 'true')
     end
   end
 end

data/lib/git/tag_delete_failure.rb

@@ -15,16 +15,19 @@ module Git
   #   failure.error_message #=> "tag 'nonexistent' not found."
   #
   # @see Git::TagDeleteResult
+  #
   # @see Git::Commands::Tag::Delete
   #
   # @api public
   #
   # @!attribute [r] name
   #   The name of the tag that failed to be deleted
+  #
   #   @return [String]
   #
   # @!attribute [r] error_message
   #   The error message from git explaining why the tag could not be deleted
+  #
   #   @return [String]
   #
   TagDeleteFailure = Data.define(:name, :error_message)

data/lib/git/tag_delete_result.rb

@@ -29,25 +29,27 @@ module Git
   #   result.not_deleted.first.error_message #=> "tag 'nonexistent' not found."
   #
   # @see Git::TagInfo
+  #
   # @see Git::TagDeleteFailure
+  #
   # @see Git::Commands::Tag::Delete
   #
   # @api public
   #
   # @!attribute [r] deleted
   #   Tags that were successfully deleted
+  #
   #   @return [Array<Git::TagInfo>]
   #
   # @!attribute [r] not_deleted
   #   Tags that could not be deleted, with the reason for each failure
+  #
   #   @return [Array<Git::TagDeleteFailure>]
   #
   TagDeleteResult = Data.define(:deleted, :not_deleted) do
     # Returns true if all requested tags were successfully deleted
     #
-    # @return [Boolean] true if no tags failed to delete, false otherwise
-    #
-    # @example
+    # @example Check if the delete operation succeeded
     #   result = tag_delete.call('v1.0.0')
     #   if result.success?
     #     puts "All tags deleted successfully"
@@ -56,6 +58,7 @@ module Git
     #     result.not_deleted.each { |f| puts "  #{f.name}: #{f.error_message}" }
     #   end
     #
+    # @return [Boolean] true if no tags failed to delete, false otherwise
     def success?
       not_deleted.empty?
     end

data/lib/git/tag_info.rb

@@ -38,6 +38,7 @@ module Git
   #   info.tagger        #=> nil
   #
   # @see Git::Tag for the full-featured tag object with operations
+  #
   # @see Git::Commands::Tag::List for the command that produces these
   #
   # @api public

data/lib/git/url.rb

@@ -8,9 +8,10 @@ module Git
   # Any URL that can be passed to `git clone` can be parsed by this class.
   #
   # @see https://git-scm.com/docs/git-clone#_git_urls GIT URLs
-  # @see https://github.com/sporkmonger/addressable Addresable::URI
   #
-  # @api public
+  # @see https://github.com/sporkmonger/addressable Addressable::URI
+  #
+  # @api private
   #
   class URL
     # Regexp used to match a Git URL with an alternative SSH syntax
@@ -30,7 +31,7 @@ module Git
     # The URI returned can be converted back to a string with 'to_s'. This is
     # guaranteed to return the same URL string that was parsed.
     #
-    # @example
+    # @example Parsing clone target from HTTPS and local paths
     #   uri = Git::URL.parse('https://github.com/ruby-git/ruby-git.git')
     #     #=> #<Addressable::URI:0x44c URI:https://github.com/ruby-git/ruby-git.git>
     #   uri.scheme #=> "https"
@@ -54,11 +55,15 @@ module Git
 
     # The directory `git clone` would use for the repository directory for the given URL
     #
-    # @example
+    # @example Deriving the clone directory name
     #   Git::URL.clone_to('https://github.com/ruby-git/ruby-git.git') #=> 'ruby-git'
     #
     # @param url [String] the Git URL containing the repository directory
     #
+    # @param bare [Boolean] whether the repository should be cloned as bare
+    #
+    # @param mirror [Boolean] whether the repository should be cloned as a mirror
+    #
     # @return [String] the name of the repository directory
     #
     def self.clone_to(url, bare: false, mirror: false)
@@ -80,7 +85,7 @@ module Git
   # This class is necessary to ensure that #to_s returns the same string
   # that was passed to the initializer.
   #
-  # @api public
+  # @api private
   #
   class GitAltURI < Addressable::URI
     # Create a new GitAltURI object
@@ -90,7 +95,9 @@ module Git
     #   uri.to_s #=> 'james@github.com/james/ruby-git'
     #
     # @param user [String, nil] the user from the URL or nil
+    #
     # @param host [String] the host from the URL
+    #
     # @param path [String] the path from the URL
     #
     def initialize(user:, host:, path:)

data/lib/git/version.rb

@@ -4,7 +4,7 @@ module Git
   # The current gem version
   #
   # @return [String] the current gem version
-  VERSION = '5.0.0.beta.2'
+  VERSION = '5.0.0.beta.4'
 
   # Represents a git version with major, minor, and patch components
   #
@@ -14,14 +14,17 @@ module Git
   #
   # @!attribute [r] major
   #   The major version number
+  #
   #   @return [Integer]
   #
   # @!attribute [r] minor
   #   The minor version number
+  #
   #   @return [Integer]
   #
   # @!attribute [r] patch
   #   The patch version number
+  #
   #   @return [Integer]
   #
   # @example Creating a version directly
@@ -102,11 +105,10 @@ module Git
     # Useful when legacy code expects the array shape returned by the
     # deprecated `Git::Lib#current_command_version` method.
     #
-    # @return [Array<Integer>] [major, minor, patch]
-    #
-    # @example
+    # @example Get version as integer components
     #   Git.git_version.to_a  #=> [2, 42, 0]
     #
+    # @return [Array<Integer>] [major, minor, patch]
     def to_a
       deconstruct
     end

data/lib/git/version_constraint.rb

@@ -26,8 +26,12 @@ module Git
   # @api public
   #
   VersionConstraint = Data.define(:min, :before) do
+    # Initialize a new VersionConstraint
+    #
     # @param min [Git::Version, nil] minimum version (inclusive)
+    #
     # @param before [Git::Version, nil] upper bound version (exclusive)
+    #
     def initialize(min: nil, before: nil)
       super
     end