git 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ebad290719cdefc27125cf9a2ebb0d3544334c2d49a079220c0714a701ce141
-  data.tar.gz: 293499cbb61ca9b4d374e86d0bd4357ed3f3b1254a46aa57c095cf0816afd7f6
+  metadata.gz: 7c7aebf8b61eb75a0d3e587fae03711b1d9cec89c7fb69462bda24c069daeaa4
+  data.tar.gz: f73bd8a6e030209305ffbcc1bae372cd6820745569142ddd7239b366ef78d322
 SHA512:
-  metadata.gz: 8fc0929f6ff79eea57f5dbd5f05da813bb55f6c44f925ce45f4ad4f3a011c99e3cfa2d00c4a18824e1521ab975fa70057127b143d77e301f0d5d2382cd4d7480
-  data.tar.gz: 5ef0e326223cc983605c8afc002e3fe77808d337a3a3dcfd1b25588adf58b5c697a3451fd8baae777f727a5f2ba3cb92f2c3e811c79bc9f5da836b24ad5a8a6b
+  metadata.gz: 32c0e605d3ee280c19cf863f5b9a5fc9437171b9facbbee074b2ddca096c4cae3f08ddf42cb6cad7a91512824f40cd51940e1846c1f1a3e5bb7f4e7ee52e154b
+  data.tar.gz: 528bf8926dbf6b76681b8333ca3d797b1e28854921f6abcd5b2fd9a13c6861c25e6ad75462efb818c1c74de0980c96974a423ad2a19aaf87d5b27e3e2ffca8cf

data/CHANGELOG.md

@@ -5,6 +5,17 @@
 
 # Change Log
 
+## v2.0.1 (2024-05-21)
+
+[Full Changelog](https://github.com/ruby-git/ruby-git/compare/v2.0.0..v2.0.1)
+
+Changes since v2.0.0:
+
+* da435b1 Document and add tests for Git::Status
+* c8a77db Fix Git::Base#status on an empty repo
+* 712fdad Fix Git::Status#untracked when run from worktree subdir
+* 6a59bc8 Remove the Git::Base::Factory module
+
 ## v2.0.0 (2024-05-10)
 
 [Full Changelog](https://github.com/ruby-git/ruby-git/compare/v2.0.0.pre4..v2.0.0)

data/README.md

@@ -23,11 +23,8 @@
 
 ## Summary
 
-The [git gem](https://rubygems.org/gems/git) provides an API that can be used to
-create, read, and manipulate Git repositories by wrapping system calls to the `git`
-command line. The API can be used for working with Git in complex interactions
-including branching and merging, object inspection and manipulation, history, patch
-generation and more.
+The [git gem](https://rubygems.org/gems/git) provides a Ruby interface to the `git`
+command line.
 
 Get started by obtaining a repository object by:
 
@@ -41,8 +38,7 @@ Methods that can be called on a repository object are documented in [Git::Base](
 
 git 2.0.0 has recently been released. Please give it a try.
 
-
-**If you have problems with the 2.x release, open an issue and use the 1.9.1 version
+**If you have problems with the 2.x release, open an issue and use the 1.x version
 instead.** We will do our best to fix your issues in a timely fashion.
 
 **JRuby on Windows is not yet supported by the 2.x release line. Users running JRuby

data/lib/git/base.rb

@@ -1,4 +1,3 @@
-require 'git/base/factory'
 require 'logger'
 require 'open3'
 
@@ -10,8 +9,6 @@ module Git
   # {Git.clone}, or {Git.bare}.
   #
   class Base
-    include Git::Base::Factory
-
     # (see Git.bare)
     def self.bare(git_dir, options = {})
       normalize_paths(options, default_repository: git_dir, bare: true)
@@ -632,6 +629,96 @@ module Git
       self.lib.branch_current
     end
 
+    # @return [Git::Branch] an object for branch_name
+    def branch(branch_name = self.current_branch)
+      Git::Branch.new(self, branch_name)
+    end
+
+    # @return [Git::Branches] a collection of all the branches in the repository.
+    #   Each branch is represented as a {Git::Branch}.
+    def branches
+      Git::Branches.new(self)
+    end
+
+    # returns a Git::Worktree object for dir, commitish
+    def worktree(dir, commitish = nil)
+      Git::Worktree.new(self, dir, commitish)
+    end
+
+    # returns a Git::worktrees object of all the Git::Worktrees
+    # objects for this repo
+    def worktrees
+      Git::Worktrees.new(self)
+    end
+
+    # @return [Git::Object::Commit] a commit object
+    def commit_tree(tree = nil, opts = {})
+      Git::Object::Commit.new(self, self.lib.commit_tree(tree, opts))
+    end
+
+    # @return [Git::Diff] a Git::Diff object
+    def diff(objectish = 'HEAD', obj2 = nil)
+      Git::Diff.new(self, objectish, obj2)
+    end
+
+    # @return [Git::Object] a Git object
+    def gblob(objectish)
+      Git::Object.new(self, objectish, 'blob')
+    end
+
+    # @return [Git::Object] a Git object
+    def gcommit(objectish)
+      Git::Object.new(self, objectish, 'commit')
+    end
+
+    # @return [Git::Object] a Git object
+    def gtree(objectish)
+      Git::Object.new(self, objectish, 'tree')
+    end
+
+    # @return [Git::Log] a log with the specified number of commits
+    def log(count = 30)
+      Git::Log.new(self, count)
+    end
+
+    # returns a Git::Object of the appropriate type
+    # you can also call @git.gtree('tree'), but that's
+    # just for readability.  If you call @git.gtree('HEAD') it will
+    # still return a Git::Object::Commit object.
+    #
+    # object calls a method that will run a rev-parse
+    # on the objectish and determine the type of the object and return
+    # an appropriate object for that type
+    #
+    # @return [Git::Object] an instance of the appropriate type of Git::Object
+    def object(objectish)
+      Git::Object.new(self, objectish)
+    end
+
+    # @return [Git::Remote] a remote of the specified name
+    def remote(remote_name = 'origin')
+      Git::Remote.new(self, remote_name)
+    end
+
+    # @return [Git::Status] a status object
+    def status
+      Git::Status.new(self)
+    end
+
+    # @return [Git::Object::Tag] a tag object
+    def tag(tag_name)
+      Git::Object.new(self, tag_name, 'tag', true)
+    end
+
+    # Find as good common ancestors as possible for a merge
+    # example: g.merge_base('master', 'some_branch', 'some_sha', octopus: true)
+    #
+    # @return [Array<Git::Object::Commit>] a collection of common ancestors
+    def merge_base(*args)
+      shas = self.lib.merge_base(*args)
+      shas.map { |sha| gcommit(sha) }
+    end
+
     private
 
     # Normalize options before they are sent to Git::Base.new

data/lib/git/lib.rb

@@ -600,6 +600,9 @@ module Git
       command_lines('ls-files', '--others', '-i', '--exclude-standard')
     end
 
+    def untracked_files
+      command_lines('ls-files', '--others', '--exclude-standard', chdir: @git_work_dir)
+    end
 
     def config_remote(name)
       hsh = {}
@@ -704,6 +707,19 @@ module Git
       command('rm', *arr_opts)
     end
 
+    # Returns true if the repository is empty (meaning it has no commits)
+    #
+    # @return [Boolean]
+    #
+    def empty?
+      command('rev-parse', '--verify', 'HEAD')
+      false
+    rescue Git::FailedError => e
+      raise unless e.result.status.exitstatus == 128 &&
+        e.result.stderr == 'fatal: Needed a single revision'
+      true
+    end
+
     # Takes the commit message with the options and executes the commit command
     #
     # accepts options:

data/lib/git/status.rb

@@ -1,6 +1,12 @@
 module Git
+  # The status class gets the status of a git repository
   #
-  # A class for git status
+  # This identifies which files have been modified, added, or deleted from the
+  # worktree. Untracked files are also identified.
+  #
+  # The Status object is an Enumerable that contains StatusFile objects.
+  #
+  # @api public
   #
   class Status
     include Enumerable
@@ -31,7 +37,6 @@ module Git
       changed.member?(file)
     end
 
-    #
     # Returns an Enumerable containing files that have been added.
     # File path starts at git base directory
     #
@@ -40,8 +45,8 @@ module Git
       @files.select { |_k, f| f.type == 'A' }
     end
 
-    #
     # Determines whether the given file has been added to the repository
+    #
     # File path starts at git base directory
     #
     # @param file [String] The name of the file.
@@ -126,9 +131,63 @@ module Git
 
     # subclass that does heavy lifting
     class StatusFile
-      attr_accessor :path, :type, :stage, :untracked
-      attr_accessor :mode_index, :mode_repo
-      attr_accessor :sha_index, :sha_repo
+      # @!attribute [r] path
+      #   The path of the file relative to the project root directory
+      #   @return [String]
+      attr_accessor :path
+
+      # @!attribute [r] type
+      #   The type of change
+      #
+      #   * 'M': modified
+      #   * 'A': added
+      #   * 'D': deleted
+      #   * nil: ???
+      #
+      #   @return [String]
+      attr_accessor :type
+
+      # @!attribute [r] mode_index
+      #   The mode of the file in the index
+      #   @return [String]
+      #   @example 100644
+      #
+      attr_accessor :mode_index
+
+      # @!attribute [r] mode_repo
+      #   The mode of the file in the repo
+      #   @return [String]
+      #   @example 100644
+      #
+      attr_accessor :mode_repo
+
+      # @!attribute [r] sha_index
+      #   The sha of the file in the index
+      #   @return [String]
+      #   @example 123456
+      #
+      attr_accessor :sha_index
+
+      # @!attribute [r] sha_repo
+      #   The sha of the file in the repo
+      #   @return [String]
+      #   @example 123456
+      attr_accessor :sha_repo
+
+      # @!attribute [r] untracked
+      #   Whether the file is untracked
+      #   @return [Boolean]
+      attr_accessor :untracked
+
+      # @!attribute [r] stage
+      #   The stage of the file
+      #
+      #   * '0': the unmerged state
+      #   * '1': the common ancestor (or original) version
+      #   * '2': "our version" from the current branch head
+      #   * '3': "their version" from the other branch head
+      #   @return [String]
+      attr_accessor :stage
 
       def initialize(base, hash)
         @base = base
@@ -158,10 +217,19 @@ module Git
     private
 
     def construct_status
+      # Lists all files in the index and the worktree
+      # git ls-files --stage
+      # { file => { path: file, mode_index: '100644', sha_index: 'dd4fc23', stage: '0' } }
       @files = @base.lib.ls_files
 
+      # Lists files in the worktree that are not in the index
+      # Add untracked files to @files
       fetch_untracked
+
+      # Lists files that are different between the index vs. the worktree
       fetch_modified
+
+      # Lists files that are different between the repo HEAD vs. the worktree
       fetch_added
 
       @files.each do |k, file_hash|
@@ -170,28 +238,30 @@ module Git
     end
 
     def fetch_untracked
-      ignore = @base.lib.ignored_files
-
-      root_dir = @base.dir.path
-      Dir.glob('**/*', File::FNM_DOTMATCH, base: root_dir) do |file|
-        next if @files[file] || File.directory?(File.join(root_dir, file)) ||
-                ignore.include?(file) || file =~ %r{^.git\/.+}
-
+      # git ls-files --others --exclude-standard, chdir: @git_work_dir)
+      # { file => { path: file, untracked: true } }
+      @base.lib.untracked_files.each do |file|
         @files[file] = { path: file, untracked: true }
       end
     end
 
     def fetch_modified
-      # find modified in tree
+      # Files changed between the index vs. the worktree
+      # git diff-files
+      # { file => { path: file, type: 'M', mode_index: '100644', mode_repo: '100644', sha_index: '0000000', :sha_repo: '52c6c4e' } }
       @base.lib.diff_files.each do |path, data|
         @files[path] ? @files[path].merge!(data) : @files[path] = data
       end
     end
 
     def fetch_added
-      # find added but not committed - new files
+      unless @base.lib.empty?
+      # Files changed between the repo HEAD vs. the worktree
+      # git diff-index HEAD
+      # { file => { path: file, type: 'M', mode_index: '100644', mode_repo: '100644', sha_index: '0000000', :sha_repo: '52c6c4e' } }
       @base.lib.diff_index('HEAD').each do |path, data|
-        @files[path] ? @files[path].merge!(data) : @files[path] = data
+          @files[path] ? @files[path].merge!(data) : @files[path] = data
+        end
       end
     end
   end

data/lib/git/version.rb

@@ -1,5 +1,5 @@
 module Git
   # The current gem version
   # @return [String] the current gem version.
-  VERSION='2.0.0'
+  VERSION='2.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Scott Chacon and others
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-11 00:00:00.000000000 Z
+date: 2024-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -213,7 +213,6 @@ files:
 - lib/git.rb
 - lib/git/author.rb
 - lib/git/base.rb
-- lib/git/base/factory.rb
 - lib/git/branch.rb
 - lib/git/branches.rb
 - lib/git/command_line.rb
@@ -244,8 +243,8 @@ licenses:
 metadata:
   homepage_uri: http://github.com/ruby-git/ruby-git
   source_code_uri: http://github.com/ruby-git/ruby-git
-  changelog_uri: https://rubydoc.info/gems/git/2.0.0/file/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/git/2.0.0
+  changelog_uri: https://rubydoc.info/gems/git/2.0.1/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/git/2.0.1
 post_install_message:
 rdoc_options: []
 require_paths:

data/lib/git/base/factory.rb

@@ -1,99 +0,0 @@
-module Git
-
-  class Base
-
-    module Factory
-      # @return [Git::Branch] an object for branch_name
-      def branch(branch_name = self.current_branch)
-        Git::Branch.new(self, branch_name)
-      end
-
-      # @return [Git::Branches] a collection of all the branches in the repository.
-      #   Each branch is represented as a {Git::Branch}.
-      def branches
-        Git::Branches.new(self)
-      end
-
-      # returns a Git::Worktree object for dir, commitish
-      def worktree(dir, commitish = nil)
-        Git::Worktree.new(self, dir, commitish)
-      end
-
-      # returns a Git::worktrees object of all the Git::Worktrees
-      # objects for this repo
-      def worktrees
-        Git::Worktrees.new(self)
-      end
-
-      # @return [Git::Object::Commit] a commit object
-      def commit_tree(tree = nil, opts = {})
-        Git::Object::Commit.new(self, self.lib.commit_tree(tree, opts))
-      end
-
-      # @return [Git::Diff] a Git::Diff object
-      def diff(objectish = 'HEAD', obj2 = nil)
-        Git::Diff.new(self, objectish, obj2)
-      end
-
-      # @return [Git::Object] a Git object
-      def gblob(objectish)
-        Git::Object.new(self, objectish, 'blob')
-      end
-
-      # @return [Git::Object] a Git object
-      def gcommit(objectish)
-        Git::Object.new(self, objectish, 'commit')
-      end
-
-      # @return [Git::Object] a Git object
-      def gtree(objectish)
-        Git::Object.new(self, objectish, 'tree')
-      end
-
-      # @return [Git::Log] a log with the specified number of commits
-      def log(count = 30)
-        Git::Log.new(self, count)
-      end
-
-      # returns a Git::Object of the appropriate type
-      # you can also call @git.gtree('tree'), but that's
-      # just for readability.  If you call @git.gtree('HEAD') it will
-      # still return a Git::Object::Commit object.
-      #
-      # object calls a factory method that will run a rev-parse
-      # on the objectish and determine the type of the object and return
-      # an appropriate object for that type
-      #
-      # @return [Git::Object] an instance of the appropriate type of Git::Object
-      def object(objectish)
-        Git::Object.new(self, objectish)
-      end
-
-      # @return [Git::Remote] a remote of the specified name
-      def remote(remote_name = 'origin')
-        Git::Remote.new(self, remote_name)
-      end
-
-      # @return [Git::Status] a status object
-      def status
-        Git::Status.new(self)
-      end
-
-      # @return [Git::Object::Tag] a tag object
-      def tag(tag_name)
-        Git::Object.new(self, tag_name, 'tag', true)
-      end
-
-      # Find as good common ancestors as possible for a merge
-      # example: g.merge_base('master', 'some_branch', 'some_sha', octopus: true)
-      #
-      # @return [Array<Git::Object::Commit>] a collection of common ancestors
-      def merge_base(*args)
-        shas = self.lib.merge_base(*args)
-        shas.map { |sha| gcommit(sha) }
-      end
-    end
-
-  end
-
-end