git 1.8.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b4267b97da7a2024f34b388707eb119370d7006d6606efb8963c4bfde76f460
-  data.tar.gz: 3383dffa2ff71b075c62bfa40f417e37c082dc78946f2cf4c413d3bdca89a153
+  metadata.gz: f7d02f0f135a2a2f9e4f8d661bc4c5d4323af8b46a527581c0f47ff17df88019
+  data.tar.gz: c45684c1b8f6af0c5a44a90c0e8918860653a6abb4a6464d11faff90278ef7c7
 SHA512:
-  metadata.gz: 2bd0fdfe6cce4d48a0efe62204350227d4c9eb20f184e6be43cc12811639e3e1ba789a467ab74dd24374ba758d1abd311a1875c13a368fbe28ea42080109b58b
-  data.tar.gz: cdc75148835d1a68b76681941a28a49955b42729f085f8fdac79dc393c293447099c33748701b86f66c4db1c93344df6a6c668eff72c6c3a2899ca88b65444b3
+  metadata.gz: 5bd13aa06dcdb48d0f47ac72d82608120a73b9fb83db278070715d9ce98023e18e75f61c5c42ea13fc24a8f125bde989e8afbc0460c94e1a6eb5c4cd658f7639
+  data.tar.gz: 5c9a4e9d8734a23162e9c858246ac705ac3413db73f8e728845b7ae62aec7b6096f2b06ddcdc195c57efe052058e26c5b9340f1d9dbdc972bf8f68f303c7eba9

data/.github/stale.yml

@@ -0,0 +1,25 @@
+# Probot: Stale
+# https://github.com/probot/stale
+
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+
+# Number of days of inactivity before a stale issue is closed
+# Set to false to disable. If disabled, issues still need to be closed
+# manually, but will remain marked as stale.
+daysUntilClose: false
+
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+
+# Label to use when marking an issue as stale
+staleLabel: stale
+
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  A friendly reminder that this issue had no activity for 60 days.
+
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

data/.github/workflows/continuous_integration.yml

@@ -0,0 +1,45 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  continuous_integration_build:
+    continue-on-error: true
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.3, 2.7]
+        operating-system: [ubuntu-latest]
+        include:
+          - ruby: head
+            operating-system: ubuntu-latest
+          - ruby: truffleruby-head
+            operating-system: ubuntu-latest
+          - ruby: 2.7
+            operating-system: windows-latest
+          - ruby: jruby-head
+            operating-system: windows-latest
+
+    name: Ruby ${{ matrix.ruby }} on ${{ matrix.operating-system }}
+
+    runs-on: ${{ matrix.operating-system }}
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v2
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+      - name: Run Build
+        run: bundle exec rake default
+
+      - name: Test Gem
+        run: bundle exec rake test:gem

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+*.kpf
+*.sw?
+.DS_Store
+coverage
+doc
+.yardoc
+pkg
+rdoc
+Gemfile.lock

data/.yardopts

@@ -0,0 +1,11 @@
+--default-return=''
+--hide-void-return
+--markup-provider=redcarpet
+--markup=markdown
+--fail-on-warning
+-
+README.md
+CHANGELOG.md
+CONTRIBUTING.md
+RELEASING.md
+MAINTAINERS.md

data/CHANGELOG.md

@@ -5,6 +5,22 @@
 
 # Change Log
 
+## 1.10.0
+
+See https://github.com/ruby-git/ruby-git/releases/tag/v1.10.0
+
+## 1.9.1
+
+See https://github.com/ruby-git/ruby-git/releases/tag/v1.9.1
+
+## 1.9.0
+
+See https://github.com/ruby-git/ruby-git/releases/tag/v1.9.0
+
+## 1.8.1
+
+See https://github.com/ruby-git/ruby-git/releases/tag/v1.8.1
+
 ## 1.8.0
 
 See https://github.com/ruby-git/ruby-git/releases/tag/v1.8.0

data/CONTRIBUTING.md

@@ -78,12 +78,14 @@ In order to ensure high quality, all pull requests must meet these requirements:
 
 ### Unit tests
   * All changes must be accompanied by new or modified unit tests
-  * The entire test suite must pass when `bundle exec rake test` is run from the
-    project's local working copy
-
-### Continuous Integration
-  * All tests must pass in the project's [Travis CI](https://travis-ci.org/ruby-git/ruby-git)
-    build before the pull request will be merged
+  * The entire test suite must pass when `bundle exec rake default` is run from the
+    project's local working copy.
+
+### Continuous integration
+  * All tests must pass in the project's [GitHub Continuous Integration build](https://github.com/ruby-git/ruby-git/actions?query=workflow%3ACI)
+    before the pull request will be merged.
+  * The [Continuous Integration workflow](https://github.com/ruby-git/ruby-git/blob/master/.github/workflows/continuous_integration.yml)
+    runs both `bundle exec rake default` and `bundle exec rake test:gem` from the project's [Rakefile](https://github.com/ruby-git/ruby-git/blob/master/Rakefile).
 
 ### Documentation
   * New and updated public methods must have [YARD](https://yardoc.org/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec :name => 'git'
+

data/ISSUE_TEMPLATE.md

@@ -0,0 +1,15 @@
+### Subject of the issue
+Describe your issue here.
+
+### Your environment
+* version of git and ruby-git
+* version of ruby
+
+### Steps to reproduce
+Tell us how to reproduce this issue. 
+
+### Expected behaviour
+What did you expect to happen?
+
+### Actual behaviour
+What actually happened?

data/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,9 @@
+### Your checklist for this pull request
+🚨Please review the [guidelines for contributing](https://github.com/ruby-git/ruby-git/blob/master/CONTRIBUTING.md) to this repository.
+
+- [ ] Ensure all commits include DCO sign-off.
+- [ ] Ensure that your contributions pass unit testing.
+- [ ] Ensure that your contributions contain documentation if applicable.
+
+### Description
+Please describe your pull request.

data/README.md

@@ -146,6 +146,7 @@ g.revparse('v2.5:Makefile')
 
 g.branches # returns Git::Branch objects
 g.branches.local
+g.current_branch
 g.branches.remote
 g.branches[:master].gcommit
 g.branches['origin/master'].gcommit
@@ -225,6 +226,14 @@ g.remove('file.txt', :cached => true)		# git rm -f --cached -- "file.txt"
 g.commit('message')
 g.commit_all('message')
 
+# Sign a commit using the gpg key configured in the user.signingkey config setting
+g.config('user.signingkey', '0A46826A')
+g.commit('message', gpg_sign: true)
+
+# Sign a commit using a specified gpg key
+key_id = '0A46826A'
+g.commit('message', gpg_sign: key_id)
+
 g = Git.clone(repo, 'myrepo')
 g.chdir do
 new_file('test-file', 'blahblahblah')

data/RELEASING.md

@@ -0,0 +1,62 @@
+<!--
+# @markup markdown
+# @title Releasing
+-->
+
+# How to release a new git.gem
+
+Releasing a new version of the `git` gem requires these steps:
+  * [Prepare the release](#prepare-the-release)
+  * [Create a GitHub release](#create-a-github-release)
+  * [Build and release the gem](#build-and-release-the-gem)
+
+These instructions use an example where the current release version is `1.5.0`
+and the new release version to be created is `1.6.0.pre1`.
+
+## Prepare the release
+
+From a fork of ruby-git, create a PR containing changes to (1) bump the
+version number, (2) update the CHANGELOG.md, and (3) tag the release.
+
+  * Bump the version number in lib/git/version.rb following [Semantic Versioning](https://semver.org)
+    guidelines
+  * Add a link in CHANGELOG.md to the release tag which will be created later
+    in this guide
+  * Create a new tag using [git-extras](https://github.com/tj/git-extras/blob/master/Commands.md#git-release)
+    `git release` command
+    * For example: `git release v1.6.0.pre1`
+  * These should be the only changes in the PR
+  * An example of these changes for `v1.6.0.pre1` can be found in [PR #435](https://github.com/ruby-git/ruby-git/pull/435)
+  * Get the PR reviewed, approved and merged to master.
+
+## Create a GitHub release
+
+On [the ruby-git releases page](https://github.com/ruby-git/ruby-git/releases),
+select `Draft a new release`
+
+  * Select the tag corresponding to the version being released `v1.6.0.pre1`
+  * The Target should be `master`
+  * For the release description, use the output of [changelog-rs](https://github.com/perlun/changelog-rs)
+    * Since the release has not been created yet, you will need to supply
+      `changeling-rs` with the current release tag and the tag the new release
+      is being created from
+    * For example: `changelog-rs . v1.5.0 v1.6.0.pre1`
+    * Copy the output, omitting the tag header `## v1.6.0.pre1` and paste into
+      the release description
+    * The release description can be edited later if needed
+  * Select the appropriate value for `This is a pre-release`
+    * Since `v1.6.0.pre1` is a pre-release, check `This is a pre-release`
+
+## Build and release the gem
+
+Clone [ruby-git/ruby-git](https://github.com/ruby-git/ruby-git) directly (not a
+fork) and ensure your local working copy is on the master branch
+
+  * Verify that you are not on a fork with the command `git remote -v`
+  * Verify that the version number is correct by running `rake -T` and inspecting
+    the output for the `release[remote]` task
+
+Build the git gem and push it to rubygems.org with the command `rake release`
+
+  * Ensure that your `gem sources list` includes `https://rubygems.org` (in my
+    case, I usually have my work’s internal gem repository listed)

data/Rakefile

@@ -0,0 +1,56 @@
+require 'bundler/gem_tasks'
+require 'English'
+
+require "#{File.expand_path(File.dirname(__FILE__))}/lib/git/version"
+
+default_tasks = []
+
+desc 'Run Unit Tests'
+task :test do
+  sh 'git config --global user.email "git@example.com"' if `git config user.email`.empty?
+  sh 'git config --global user.name "GitExample"' if `git config user.name`.empty?
+
+  require File.dirname(__FILE__) + '/tests/all_tests.rb'
+end
+default_tasks << :test
+
+unless RUBY_PLATFORM == 'java'
+  #
+  # YARD documentation for this project can NOT be built with JRuby.
+  # This project uses the redcarpet gem which can not be installed on JRuby.
+  #
+  require 'yard'
+  YARD::Rake::YardocTask.new
+  CLEAN << '.yardoc'
+  CLEAN << 'doc'
+  default_tasks << :yard
+
+  require 'yardstick/rake/verify'
+  Yardstick::Rake::Verify.new(:'yardstick:coverage') do |t|
+    t.threshold = 50
+    t.require_exact_threshold = false
+  end
+  default_tasks << :'yardstick:coverage'
+
+  desc 'Run yardstick to check yard docs'
+  task :yardstick do
+    sh "yardstick 'lib/**/*.rb'"
+  end
+  # Do not include yardstick as a default task for now since there are too many
+  # warnings.  Will work to get the warnings down before re-enabling it.
+  #
+  # default_tasks << :yardstick
+end
+
+default_tasks << :build
+
+task default: default_tasks
+
+desc 'Build and install the git gem and run a sanity check'
+task :'test:gem' => :install do
+  output = `ruby -e "require 'git'; g = Git.open('.'); puts g.log.size"`.chomp
+  raise 'Gem test failed' unless $CHILD_STATUS.success?
+  raise 'Expected gem test to return an integer' unless output =~ /^\d+$/
+
+  puts 'Gem Test Succeeded'
+end

data/git.gemspec

@@ -0,0 +1,46 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'git/version'
+
+Gem::Specification.new do |s|
+  s.author = 'Scott Chacon and others'
+  s.email = 'schacon@gmail.com'
+  s.homepage = 'http://github.com/ruby-git/ruby-git'
+  s.license = 'MIT'
+  s.name = 'git'
+  s.summary = 'An API to create, read, and manipulate Git repositories'
+  s.description = <<~DESCRIPTION
+    The Git Gem provides an API that can be used to create, read, and manipulate
+    Git repositories by wrapping system calls to the `git` binary. 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.
+  DESCRIPTION
+  s.version = Git::VERSION
+
+  s.metadata['homepage_uri'] = s.homepage
+  s.metadata['source_code_uri'] = s.homepage
+  s.metadata['changelog_uri'] = 'http://rubydoc.info/gems/git/file.CHANGELOG.html'
+
+  s.require_paths = ['lib']
+  s.required_ruby_version = '>= 2.3'
+  s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to?(:required_rubygems_version=)
+  s.requirements = ['git 1.6.0.0, or greater']
+
+  s.add_runtime_dependency 'rchardet', '~> 1.8'
+
+  s.add_development_dependency 'minitar', '~> 0.9'
+  s.add_development_dependency 'rake', '~> 13.0'
+  s.add_development_dependency 'test-unit', '~> 3.3'
+
+  unless RUBY_PLATFORM == 'java'
+    s.add_development_dependency 'redcarpet', '~> 3.5'
+    s.add_development_dependency 'yard', '~> 0.9'
+    s.add_development_dependency 'yardstick', '~> 0.9'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(tests|spec|features)/}) }
+  end
+end

data/lib/git/base.rb

@@ -12,40 +12,35 @@ module Git
 
     # (see Git.bare)
     def self.bare(git_dir, options = {})
-      self.new({:repository => git_dir}.merge(options))
+      normalize_paths(options, default_repository: git_dir, bare: true)
+      self.new(options)
     end
 
     # (see Git.clone)
     def self.clone(repository, name, options = {})
-      self.new(Git::Lib.new(nil, options[:log]).clone(repository, name, options))
+      new_options = Git::Lib.new(nil, options[:log]).clone(repository, name, options)
+      normalize_paths(new_options, bare: options[:bare] || options[:mirror])
+      self.new(new_options)
     end
 
     # Returns (and initialize if needed) a Git::Config instance
     #
     # @return [Git::Config] the current config instance.
     def self.config
-      return @@config ||= Config.new
+      @@config ||= Config.new
     end
 
     # (see Git.init)
-    def self.init(directory, options = {})
-      options[:working_directory] ||= directory
-      options[:repository] ||= File.join(options[:working_directory], '.git')
-
-      FileUtils.mkdir_p(options[:working_directory]) if options[:working_directory] && !File.directory?(options[:working_directory])
+    def self.init(directory = '.', options = {})
+      normalize_paths(options, default_working_directory: directory, default_repository: directory, bare: options[:bare])
 
-      init_options = { :bare => options[:bare] }
+      init_options = {
+        :bare => options[:bare],
+        :initial_branch => options[:initial_branch],
+      }
 
-      options.delete(:working_directory) if options[:bare]
-
-      # Submodules have a .git *file* not a .git folder.
-      # This file's contents point to the location of
-      # where the git refs are held (In the parent repo)
-      if options[:working_directory] && File.file?(File.join(options[:working_directory], '.git'))
-        git_file = File.open('.git').read[8..-1].strip
-        options[:repository] = git_file
-        options[:index] = git_file + '/index'
-      end
+      directory = options[:bare] ? options[:repository] : options[:working_directory]
+      FileUtils.mkdir_p(directory) unless File.exist?(directory)
 
       # TODO: this dance seems awkward: this creates a Git::Lib so we can call
       #   init so we can create a new Git::Base which in turn (ultimately)
@@ -63,21 +58,8 @@ module Git
     end
 
     # (see Git.open)
-    def self.open(working_dir, options={})
-       # TODO: move this to Git.open?
-
-      options[:working_directory] ||= working_dir
-      options[:repository] ||= File.join(options[:working_directory], '.git')
-
-       # Submodules have a .git *file* not a .git folder.
-      # This file's contents point to the location of
-      # where the git refs are held (In the parent repo)
-      if options[:working_directory] && File.file?(File.join(options[:working_directory], '.git'))
-        git_file = File.open('.git').read[8..-1].strip
-        options[:repository] = git_file
-        options[:index] = git_file + '/index'
-      end
-
+    def self.open(working_dir, options = {})
+      normalize_paths(options, default_working_directory: working_dir)
       self.new(options)
     end
 
@@ -137,13 +119,14 @@ module Git
 
     #g.config('user.name', 'Scott Chacon') # sets value
     #g.config('user.email', 'email@email.com')  # sets value
+    #g.config('user.email', 'email@email.com', file: 'path/to/custom/config)  # sets value in file
     #g.config('user.name')  # returns 'Scott Chacon'
     #g.config # returns whole config hash
-    def config(name = nil, value = nil)
-      if(name && value)
+    def config(name = nil, value = nil, options = {})
+      if name && value
         # set value
-        lib.config_set(name, value)
-      elsif (name)
+        lib.config_set(name, value, options)
+      elsif name
         # return value
         lib.config_get(name)
       else
@@ -286,6 +269,7 @@ module Git
     # options:
     #  :force
     #  :d
+    #  :ff
     #
     def clean(opts = {})
       self.lib.clean(opts)
@@ -387,7 +371,7 @@ module Git
     #  @git.pull('upstream', 'develope')  # pulls from upstream/develop
     #
     def pull(remote='origin', branch='master')
-			self.lib.pull(remote, branch)
+      self.lib.pull(remote, branch)
     end
 
     # returns an array of Git:Remote objects
@@ -566,7 +550,6 @@ module Git
       with_working(temp_dir, &blk)
     end
 
-
     # runs git rev-parse to convert the objectish to a full sha
     #
     # @example
@@ -591,6 +574,93 @@ module Git
       self.lib.branch_current
     end
 
-  end
+    private
+
+    # Normalize options before they are sent to Git::Base.new
+    #
+    # Updates the options parameter by setting appropriate values for the following keys:
+    #   * options[:working_directory]
+    #   * options[:repository]
+    #   * options[:index]
+    #
+    # All three values will be set to absolute paths. An exception is that
+    # :working_directory will be set to nil if bare is true.
+    #
+    private_class_method def self.normalize_paths(
+      options, default_working_directory: nil, default_repository: nil, bare: false
+    )
+      normalize_working_directory(options, default: default_working_directory, bare: bare)
+      normalize_repository(options, default: default_repository, bare: bare)
+      normalize_index(options)
+    end
+
+    # Normalize options[:working_directory]
+    #
+    # If working with a bare repository, set to `nil`.
+    # Otherwise, set to the first non-nil value of:
+    #   1. `options[:working_directory]`,
+    #   2. the `default` parameter, or
+    #   3. the current working directory
+    #
+    # Finally, if options[:working_directory] is a relative path, convert it to an absoluite
+    # path relative to the current directory.
+    #
+    private_class_method def self.normalize_working_directory(options, default:, bare: false)
+      working_directory =
+        if bare
+          nil
+        else
+          File.expand_path(options[:working_directory] || default || Dir.pwd)
+        end
 
+      options[:working_directory] = working_directory
+    end
+
+    # Normalize options[:repository]
+    #
+    # If working with a bare repository, set to the first non-nil value out of:
+    #   1. `options[:repository]`
+    #   2. the `default` parameter
+    #   3. the current working directory
+    #
+    # Otherwise, set to the first non-nil value of:
+    #   1. `options[:repository]`
+    #   2. `.git`
+    #
+    # Next, if options[:repository] refers to a *file* and not a *directory*, set
+    # options[:repository] to the contents of that file.  This is the case when
+    # working with a submodule or a secondary working tree (created with git worktree
+    # add). In these cases the repository is actually contained/nested within the
+    # parent's repository directory.
+    #
+    # Finally, if options[:repository] is a relative path, convert it to an absolute
+    # path relative to:
+    #   1. the current directory if working with a bare repository or
+    #   2. the working directory if NOT working with a bare repository
+    #
+    private_class_method def self.normalize_repository(options, default:, bare: false)
+      repository =
+        if bare
+          File.expand_path(options[:repository] || default || Dir.pwd)
+        else
+          File.expand_path(options[:repository] || '.git', options[:working_directory])
+        end
+
+      if File.file?(repository)
+        repository = File.expand_path(File.open(repository).read[8..-1].strip, options[:working_directory])
+      end
+
+      options[:repository] = repository
+    end
+
+    # Normalize options[:index]
+    #
+    # If options[:index] is a relative directory, convert it to an absolute
+    # directory relative to the repository directory
+    #
+    private_class_method def self.normalize_index(options)
+      index = File.expand_path(options[:index] || 'index', options[:repository])
+      options[:index] = index
+    end
+  end
 end

data/lib/git/lib.rb

@@ -71,10 +71,12 @@ module Git
     # options:
     #   :bare
     #   :working_directory
+    #   :initial_branch
     #
     def init(opts={})
       arr_opts = []
       arr_opts << '--bare' if opts[:bare]
+      arr_opts << "--initial-branch=#{opts[:initial_branch]}" if opts[:initial_branch]
 
       command('init', arr_opts)
     end
@@ -583,8 +585,12 @@ module Git
 
     ## WRITE COMMANDS ##
 
-    def config_set(name, value)
-      command('config', name, value)
+    def config_set(name, value, options = {})
+      if options[:file].to_s.empty?
+        command('config', name, value)
+      else
+        command('config', '--file', options[:file], name, value)
+      end
     end
 
     def global_config_set(name, value)
@@ -642,6 +648,7 @@ module Git
     #  :date
     #  :no_verify
     #  :allow_empty_message
+    #  :gpg_sign
     #
     # @param [String] message the commit message to be used
     # @param [Hash] opts the commit options to be used
@@ -655,6 +662,14 @@ module Git
       arr_opts << "--date=#{opts[:date]}" if opts[:date].is_a? String
       arr_opts << '--no-verify' if opts[:no_verify]
       arr_opts << '--allow-empty-message' if opts[:allow_empty_message]
+      if opts[:gpg_sign]
+        arr_opts <<
+          if opts[:gpg_sign] == true
+            '--gpg-sign'
+          else
+            "--gpg-sign=#{opts[:gpg_sign]}"
+          end
+      end
 
       command('commit', arr_opts)
     end
@@ -669,6 +684,7 @@ module Git
     def clean(opts = {})
       arr_opts = []
       arr_opts << '--force' if opts[:force]
+      arr_opts << '-ff' if opts[:ff]
       arr_opts << '-d' if opts[:d]
       arr_opts << '-x' if opts[:x]
 
@@ -759,6 +775,7 @@ module Git
 
     def merge(branch, message = nil, opts = {})
       arr_opts = []
+      arr_opts << '--no-commit' if opts[:no_commit]
       arr_opts << '--no-ff' if opts[:no_ff]
       arr_opts << '-m' << message if message
       arr_opts += [branch]
@@ -866,6 +883,7 @@ module Git
       arr_opts << '--tags' if opts[:t] || opts[:tags]
       arr_opts << '--prune' if opts[:p] || opts[:prune]
       arr_opts << '--unshallow' if opts[:unshallow]
+      arr_opts << '--depth' << opts[:depth] if opts[:depth]
 
       command('fetch', arr_opts)
     end

data/lib/git/version.rb

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

data/lib/git/worktree.rb

@@ -0,0 +1,38 @@
+require 'git/path'
+
+module Git
+
+  class Worktree < Path
+
+    attr_accessor :full, :dir, :gcommit
+
+    def initialize(base, dir, gcommit = nil)
+      @full = dir
+      @full += ' ' + gcommit if !gcommit.nil?
+      @base = base
+      @dir = dir
+      @gcommit = gcommit
+    end
+
+    def gcommit
+      @gcommit ||= @base.gcommit(@full)
+      @gcommit
+    end
+
+    def add
+      @base.lib.worktree_add(@dir, @gcommit)
+    end
+
+    def remove
+      @base.lib.worktree_remove(@dir)
+    end
+
+    def to_a
+      [@full]
+    end
+
+    def to_s
+      @full
+    end
+  end
+end

data/lib/git/worktrees.rb

@@ -0,0 +1,47 @@
+module Git
+  # object that holds all the available worktrees
+  class Worktrees
+
+    include Enumerable
+
+    def initialize(base)
+      @worktrees = {}
+
+      @base = base
+
+      # Array contains [dir, git_hash]
+      @base.lib.worktrees_all.each do |w|
+        @worktrees[w[0]] = Git::Worktree.new(@base, w[0], w[1])
+      end
+    end
+
+    # array like methods
+
+    def size
+      @worktrees.size
+    end
+
+    def each(&block)
+      @worktrees.values.each(&block)
+    end
+
+    def [](worktree_name)
+      @worktrees.values.inject(@worktrees) do |worktrees, worktree|
+        worktrees[worktree.full] ||= worktree
+        worktrees
+      end[worktree_name.to_s]
+    end
+
+    def to_s
+      out = ''
+      @worktrees.each do |k, b|
+        out << b.to_s << "\n"
+      end
+      out
+    end
+
+    def prune
+      @base.lib.worktree_prune
+    end
+  end
+end

data/lib/git.rb

@@ -212,6 +212,9 @@ module Git
   #   `"#{directory}/.git"`, create a bare repository at `"#{directory}"`.
   #   See [what is a bare repository?](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefbarerepositoryabarerepository).
   #
+  # @option options [String] :initial_branch Use the specified name for the
+  #   initial branch in the newly created repository.
+  #
   # @option options [Pathname] :repository the path to put the newly initialized
   #   Git repository. The default for non-bare repository is `"#{directory}/.git"`.
   #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Scott Chacon and others
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-31 00:00:00.000000000 Z
+date: 2021-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rchardet
@@ -119,11 +119,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/stale.yml"
+- ".github/workflows/continuous_integration.yml"
+- ".gitignore"
+- ".yardopts"
 - CHANGELOG.md
 - CONTRIBUTING.md
+- Gemfile
+- ISSUE_TEMPLATE.md
 - LICENSE
 - MAINTAINERS.md
+- PULL_REQUEST_TEMPLATE.md
 - README.md
+- RELEASING.md
+- Rakefile
+- git.gemspec
 - lib/git.rb
 - lib/git/author.rb
 - lib/git/base.rb
@@ -144,6 +154,8 @@ files:
 - lib/git/status.rb
 - lib/git/version.rb
 - lib/git/working_directory.rb
+- lib/git/worktree.rb
+- lib/git/worktrees.rb
 homepage: http://github.com/ruby-git/ruby-git
 licenses:
 - MIT
@@ -167,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - git 1.6.0.0, or greater
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: An API to create, read, and manipulate Git repositories