git 1.19.1 → 3.1.1

data/lib/git/base.rb

@@ -1,17 +1,18 @@
-require 'git/base/factory'
+# frozen_string_literal: true
+
 require 'logger'
 require 'open3'
 
 module Git
-  # Git::Base is the main public interface for interacting with Git commands.
+  # The main public interface for interacting with Git commands
   #
   # Instead of creating a Git::Base directly, obtain a Git::Base instance by
   # calling one of the follow {Git} class methods: {Git.open}, {Git.init},
   # {Git.clone}, or {Git.bare}.
   #
+  # @api public
+  #
   class Base
-    include Git::Base::Factory
-
     # (see Git.bare)
     def self.bare(git_dir, options = {})
       normalize_paths(options, default_repository: git_dir, bare: true)
@@ -37,6 +38,26 @@ module Git
       @@config ||= Config.new
     end
 
+    def self.binary_version(binary_path)
+      result = nil
+      status = nil
+
+      begin
+        result, status = Open3.capture2e(binary_path, "-c", "core.quotePath=true", "-c", "color.ui=false", "version")
+        result = result.chomp
+      rescue Errno::ENOENT
+        raise RuntimeError, "Failed to get git version: #{binary_path} not found"
+      end
+
+      if status.success?
+        version = result[/\d+(\.\d+)+/]
+        version_parts = version.split('.').collect { |i| i.to_i }
+        version_parts.fill(0, version_parts.length...3)
+      else
+        raise RuntimeError, "Failed to get git version: #{status}\n#{result}"
+      end
+    end
+
     # (see Git.init)
     def self.init(directory = '.', options = {})
       normalize_paths(options, default_working_directory: directory, default_repository: directory, bare: options[:bare])
@@ -68,9 +89,14 @@ module Git
       result = working_dir
       status = nil
 
-      git_cmd = "#{Git::Base.config.binary_path} -c core.quotePath=true -c color.ui=false rev-parse --show-toplevel 2>&1"
-      result, status = Open3.capture2(git_cmd, chdir: File.expand_path(working_dir))
-      result = result.chomp
+      raise ArgumentError, "'#{working_dir}' does not exist" unless Dir.exist?(working_dir)
+
+      begin
+        result, status = Open3.capture2e(Git::Base.config.binary_path, "-c", "core.quotePath=true", "-c", "color.ui=false", "rev-parse", "--show-toplevel", chdir: File.expand_path(working_dir))
+        result = result.chomp
+      rescue Errno::ENOENT
+        raise ArgumentError, "Failed to find the root of the worktree: git binary not found"
+      end
 
       raise ArgumentError, "'#{working_dir}' is not in a git working tree" unless status.success?
       result
@@ -122,6 +148,62 @@ module Git
       @index = options[:index] ? Git::Index.new(options[:index], false) : nil
     end
 
+    # Update the index from the current worktree to prepare the for the next commit
+    #
+    # @example
+    #   lib.add('path/to/file')
+    #   lib.add(['path/to/file1','path/to/file2'])
+    #   lib.add(all: true)
+    #
+    # @param [String, Array<String>] paths a file or files to be added to the repository (relative to the worktree root)
+    # @param [Hash] options
+    #
+    # @option options [Boolean] :all Add, modify, and remove index entries to match the worktree
+    # @option options [Boolean] :force Allow adding otherwise ignored files
+    #
+    def add(paths = '.', **options)
+      self.lib.add(paths, options)
+    end
+
+    # adds a new remote to this repository
+    # url can be a git url or a Git::Base object if it's a local reference
+    #
+    #  @git.add_remote('scotts_git', 'git://repo.or.cz/rubygit.git')
+    #  @git.fetch('scotts_git')
+    #  @git.merge('scotts_git/master')
+    #
+    # Options:
+    #   :fetch => true
+    #   :track => <branch_name>
+    def add_remote(name, url, opts = {})
+      url = url.repo.path if url.is_a?(Git::Base)
+      self.lib.remote_add(name, url, opts)
+      Git::Remote.new(self, name)
+    end
+
+    # Create a new git tag
+    #
+    # @example
+    #   repo.add_tag('tag_name', object_reference)
+    #   repo.add_tag('tag_name', object_reference, {:options => 'here'})
+    #   repo.add_tag('tag_name', {:options => 'here'})
+    #
+    # @param [String] name The name of the tag to add
+    # @param [Hash] options Opstions to pass to `git tag`.
+    #   See [git-tag](https://git-scm.com/docs/git-tag) for more details.
+    # @option options [boolean] :annotate Make an unsigned, annotated tag object
+    # @option options [boolean] :a An alias for the `:annotate` option
+    # @option options [boolean] :d Delete existing tag with the given names.
+    # @option options [boolean] :f Replace an existing tag with the given name (instead of failing)
+    # @option options [String] :message Use the given tag message
+    # @option options [String] :m An alias for the `:message` option
+    # @option options [boolean] :s Make a GPG-signed tag.
+    #
+    def add_tag(name, *options)
+      self.lib.tag(name, *options)
+      self.tag(name)
+    end
+
     # changes current working directory for a block
     # to the git working directory
     #
@@ -254,27 +336,11 @@ module Git
       self.object('HEAD').grep(string, path_limiter, opts)
     end
 
-    # updates the repository index using the working directory content
-    #
-    # @example
-    #   git.add
-    #   git.add('path/to/file')
-    #   git.add(['path/to/file1','path/to/file2'])
-    #   git.add(:all => true)
-    #
-    # options:
-    #   :all => true
-    #
-    # @param [String,Array] paths files paths to be added (optional, default='.')
-    # @param [Hash] options
-    # @option options [boolean] :all
-    #   Update the index not only where the working tree has a file matching
-    #   <pathspec> but also where the index already has an entry.
-    #   See [the --all option to git-add](https://git-scm.com/docs/git-add#Documentation/git-add.txt--A)
-    #   for more details.
+    # List the files in the worktree that are ignored by git
+    # @return [Array<String>] the list of ignored files relative to teh root of the worktree
     #
-    def add(paths = '.', **options)
-      self.lib.add(paths, options)
+    def ignored_files
+      self.lib.ignored_files
     end
 
     # removes file(s) from the git repository
@@ -409,14 +475,27 @@ module Git
       self.lib.conflicts(&block)
     end
 
-    # pulls the given branch from the given remote into the current branch
+    # Pulls the given branch from the given remote into the current branch
+    #
+    # @param remote [String] the remote repository to pull from
+    # @param branch [String] the branch to pull from
+    # @param opts [Hash] options to pass to the pull command
     #
-    #  @git.pull                          # pulls from origin/master
-    #  @git.pull('upstream')              # pulls from upstream/master
-    #  @git.pull('upstream', 'develope')  # pulls from upstream/develop
+    # @option opts [Boolean] :allow_unrelated_histories (false) Merges histories of two projects that started their
+    #   lives independently
+    # @example pulls from origin/master
+    #   @git.pull
+    # @example pulls from upstream/master
+    #   @git.pull('upstream')
+    # @example pulls from upstream/develop
+    #   @git.pull('upstream', 'develop')
     #
-    def pull(remote = nil, branch = nil)
-      self.lib.pull(remote, branch)
+    # @return [Void]
+    #
+    # @raise [Git::FailedError] if the pull fails
+    # @raise [ArgumentError] if a branch is given without a remote
+    def pull(remote = nil, branch = nil, opts = {})
+      self.lib.pull(remote, branch, opts)
     end
 
     # returns an array of Git:Remote objects
@@ -424,22 +503,6 @@ module Git
       self.lib.remotes.map { |r| Git::Remote.new(self, r) }
     end
 
-    # adds a new remote to this repository
-    # url can be a git url or a Git::Base object if it's a local reference
-    #
-    #  @git.add_remote('scotts_git', 'git://repo.or.cz/rubygit.git')
-    #  @git.fetch('scotts_git')
-    #  @git.merge('scotts_git/master')
-    #
-    # Options:
-    #   :fetch => true
-    #   :track => <branch_name>
-    def add_remote(name, url, opts = {})
-      url = url.repo.path if url.is_a?(Git::Base)
-      self.lib.remote_add(name, url, opts)
-      Git::Remote.new(self, name)
-    end
-
     # sets the url for a remote
     # url can be a git url or a Git::Base object if it's a local reference
     #
@@ -463,7 +526,7 @@ module Git
       self.lib.tags.map { |r| tag(r) }
     end
 
-    # Creates a new git tag (Git::Tag)
+    # Create a new git tag
     #
     # @example
     #   repo.add_tag('tag_name', object_reference)
@@ -598,27 +661,127 @@ module Git
     # runs git rev-parse to convert the objectish to a full sha
     #
     # @example
-    #   git.revparse("HEAD^^")
-    #   git.revparse('v2.4^{tree}')
-    #   git.revparse('v2.4:/doc/index.html')
+    #   git.rev_parse("HEAD^^")
+    #   git.rev_parse('v2.4^{tree}')
+    #   git.rev_parse('v2.4:/doc/index.html')
     #
-    def revparse(objectish)
-      self.lib.revparse(objectish)
+    def rev_parse(objectish)
+      self.lib.rev_parse(objectish)
     end
 
-    def ls_tree(objectish)
-      self.lib.ls_tree(objectish)
+    # For backwards compatibility
+    alias revparse rev_parse
+
+    def ls_tree(objectish, opts = {})
+      self.lib.ls_tree(objectish, opts)
     end
 
     def cat_file(objectish)
-      self.lib.object_contents(objectish)
+      self.lib.cat_file(objectish)
     end
 
-    # returns the name of the branch the working directory is currently on
+    # The name of the branch HEAD refers to or 'HEAD' if detached
+    #
+    # Returns one of the following:
+    #   * The branch name that HEAD refers to (even if it is an unborn branch)
+    #   * 'HEAD' if in a detached HEAD state
+    #
+    # @return [String] the name of the branch HEAD refers to or 'HEAD' if detached
+    #
     def current_branch
       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/branch.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'git/path'
 
 module Git

data/lib/git/branches.rb

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 module Git
-  
+
   # object that holds all the available branches
   class Branches
 
     include Enumerable
-    
+
     def initialize(base)
       @branches = {}
-      
+
       @base = base
-            
+
       @base.lib.branches_all.each do |b|
         @branches[b[0]] = Git::Branch.new(@base, b[0])
       end
@@ -18,21 +20,21 @@ module Git
     def local
       self.select { |b| !b.remote }
     end
-    
+
     def remote
       self.select { |b| b.remote }
     end
-    
+
     # array like methods
 
     def size
       @branches.size
-    end    
-    
+    end
+
     def each(&block)
       @branches.values.each(&block)
     end
-    
+
     # Returns the target branch
     #
     # Example:
@@ -50,14 +52,14 @@ module Git
       @branches.values.inject(@branches) do |branches, branch|
         branches[branch.full] ||= branch
 
-        # This is how Git (version 1.7.9.5) works. 
-        # Lets you ignore the 'remotes' if its at the beginning of the branch full name (even if is not a real remote branch). 
+        # This is how Git (version 1.7.9.5) works.
+        # Lets you ignore the 'remotes' if its at the beginning of the branch full name (even if is not a real remote branch).
         branches[branch.full.sub('remotes/', '')] ||= branch if branch.full =~ /^remotes\/.+/
-        
+
         branches
       end[branch_name.to_s]
     end
-    
+
     def to_s
       out = ''
       @branches.each do |k, b|
@@ -65,7 +67,6 @@ module Git
       end
       out
     end
-    
   end
 
 end