git 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2d97fee392eb89bbfc8963b8207db3ef1c57149788aa7dfae63a420811121d6
-  data.tar.gz: f116ee398b4631b6625ed37ab3af78086fd7368bcf506554e2a8451e561f97d5
+  metadata.gz: 0b4267b97da7a2024f34b388707eb119370d7006d6606efb8963c4bfde76f460
+  data.tar.gz: 3383dffa2ff71b075c62bfa40f417e37c082dc78946f2cf4c413d3bdca89a153
 SHA512:
-  metadata.gz: 3f9c01312658ea5daf34cb76202b27f7d707e88837415170c0183ed80a066d1996b4c5c52be327ded868cd169241c0b5aa488857c4f62bb1291df0094a2817f9
-  data.tar.gz: 5b8fb64f63da828453d6adcc02e35b8450d4ba1431a7bd55002eb10acbbe28e9e0df6ffeec73e7bf09c6714c589a01b900a5a7a3242ed4cad7a754ad26d456c9
+  metadata.gz: 2bd0fdfe6cce4d48a0efe62204350227d4c9eb20f184e6be43cc12811639e3e1ba789a467ab74dd24374ba758d1abd311a1875c13a368fbe28ea42080109b58b
+  data.tar.gz: cdc75148835d1a68b76681941a28a49955b42729f085f8fdac79dc393c293447099c33748701b86f66c4db1c93344df6a6c668eff72c6c3a2899ca88b65444b3

data/CHANGELOG.md

@@ -1,5 +1,14 @@
+<!--
+# @markup markdown
+# @title Change Log
+-->
+
 # Change Log
 
+## 1.8.0
+
+See https://github.com/ruby-git/ruby-git/releases/tag/v1.8.0
+
 ## 1.7.0
 
 See https://github.com/ruby-git/ruby-git/releases/tag/v1.7.0

data/CONTRIBUTING.md

@@ -1,3 +1,8 @@
+<!--
+# @markup markdown
+# @title How To Contribute
+-->
+
 # Contributing to ruby-git
 
 Thank you for your interest in contributing to the ruby-git project.
@@ -8,7 +13,7 @@ judgement.
 
 Propose changes to these guidelines with a pull request.
 
-## How to contribute to ruby-git
+## How to contribute
 
 You can contribute in two ways:
 

data/MAINTAINERS.md

@@ -1,3 +1,8 @@
+<!--
+# @markup markdown
+# @title Maintainers
+-->
+
 # Maintainers
 
 When making changes in this repository, one of the maintainers below must review and approve your pull request.

data/README.md

@@ -1,22 +1,47 @@
-# Git Library for Ruby
+<!--
+# @markup markdown
+# @title README
+-->
 
-Library for using Git in Ruby.
+# The Git Gem
+
+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.
 
 ## Homepage
 
-Git public hosting of the project source code is at:
+The project source code is at:
 
 http://github.com/ruby-git/ruby-git
 
+## Documentation
+
+Detailed documentation can be found at:
+
+https://rubydoc.info/gems/git/Git.html
+
+Get started by obtaining a repository object by:
+
+* opening an existing working copy with [Git.open](https://rubydoc.info/gems/git/Git#open-class_method)
+* initializing a new repository with [Git.init](https://rubydoc.info/gems/git/Git#init-class_method)
+* cloning a repository with [Git.clone](https://rubydoc.info/gems/git/Git#clone-class_method)
+
+Methods that can be called on a repository object are documented in [Git::Base](https://rubydoc.info/gems/git/Git/Base)
+
 ## Install
 
 You can install Ruby/Git like this:
 
-    $ sudo gem install git
+```
+sudo gem install git
+```
 
 ## Code Status
 
-* [![Build Status](https://travis-ci.org/ruby-git/ruby-git.svg?branch=master)](https://travis-ci.org/ruby-git/ruby-git)
+* [![Build Status](https://github.com/ruby-git/ruby-git/workflows/CI/badge.svg?branch=master)](https://github.com/ruby-git/ruby-git/actions?query=workflow%3ACI)
 * [![Code Climate](https://codeclimate.com/github/ruby-git/ruby-git.png)](https://codeclimate.com/github/ruby-git/ruby-git)
 * [![Gem Version](https://badge.fury.io/rb/git.svg)](https://badge.fury.io/rb/git)
 
@@ -41,6 +66,8 @@ like:
 
  `@git.log(20).object("some_file").since("2 weeks ago").between('v2.6', 'v2.7').each { |commit| [block] }`
 
+ **Git::Worktrees** - Enumerable object that holds `Git::Worktree objects`.
+
 ## Examples
 
 Here are a bunch of examples of how to use the Ruby/Git package.
@@ -48,24 +75,24 @@ Here are a bunch of examples of how to use the Ruby/Git package.
 Ruby < 1.9 will require rubygems to be loaded.
 
 ```ruby
-    require 'rubygems'
+require 'rubygems'
 ```
 
 Require the 'git' gem.
 ```ruby
-    require 'git'
+require 'git'
 ```
 
 Git env config
 
 ```ruby
-  Git.configure do |config|
-    # If you want to use a custom git binary
-    config.binary_path = '/git/bin/path'
+Git.configure do |config|
+  # If you want to use a custom git binary
+  config.binary_path = '/git/bin/path'
 
-    # If you need to use a custom SSH script
-    config.git_ssh = '/path/to/ssh/script'
-  end
+  # If you need to use a custom SSH script
+  config.git_ssh = '/path/to/ssh/script'
+end
 ```
 
 _NOTE: Another way to specify where is the `git` binary is through the environment variable `GIT_PATH`_
@@ -73,226 +100,243 @@ _NOTE: Another way to specify where is the `git` binary is through the environme
 Here are the operations that need read permission only.
 
 ```ruby
-    g = Git.open(working_dir, :log => Logger.new(STDOUT))
-
-    g.index
-    g.index.readable?
-    g.index.writable?
-    g.repo
-    g.dir
-
-    g.log   # returns array of Git::Commit objects
-    g.log.since('2 weeks ago')
-    g.log.between('v2.5', 'v2.6')
-    g.log.each {|l| puts l.sha }
-    g.gblob('v2.5:Makefile').log.since('2 weeks ago')
-
-    g.object('HEAD^').to_s  # git show / git rev-parse
-    g.object('HEAD^').contents
-    g.object('v2.5:Makefile').size
-    g.object('v2.5:Makefile').sha
-
-    g.gtree(treeish)
-    g.gblob(treeish)
-    g.gcommit(treeish)
-
-
-    commit = g.gcommit('1cc8667014381')
-
-    commit.gtree
-    commit.parent.sha
-    commit.parents.size
-    commit.author.name
-    commit.author.email
-    commit.author.date.strftime("%m-%d-%y")
-    commit.committer.name
-    commit.date.strftime("%m-%d-%y")
-    commit.message
-
-    tree = g.gtree("HEAD^{tree}")
-
-    tree.blobs
-    tree.subtrees
-    tree.children # blobs and subtrees
-
-    g.revparse('v2.5:Makefile')
-
-    g.branches # returns Git::Branch objects
-    g.branches.local
-    g.branches.remote
-    g.branches[:master].gcommit
-    g.branches['origin/master'].gcommit
-
-    g.grep('hello')  # implies HEAD
-    g.blob('v2.5:Makefile').grep('hello')
-    g.tag('v2.5').grep('hello', 'docs/')
-    g.describe()
-    g.describe('0djf2aa')
-    g.describe('HEAD', {:all => true, :tags => true})
-
-    g.diff(commit1, commit2).size
-    g.diff(commit1, commit2).stats
-    g.diff(commit1, commit2).name_status
-    g.gtree('v2.5').diff('v2.6').insertions
-    g.diff('gitsearch1', 'v2.5').path('lib/')
-    g.diff('gitsearch1', @git.gtree('v2.5'))
-    g.diff('gitsearch1', 'v2.5').path('docs/').patch
-    g.gtree('v2.5').diff('v2.6').patch
-
-    g.gtree('v2.5').diff('v2.6').each do |file_diff|
-       puts file_diff.path
-       puts file_diff.patch
-       puts file_diff.blob(:src).contents
-    end
-
-    g.config('user.name')  # returns 'Scott Chacon'
-    g.config # returns whole config hash
-
-    g.tags # returns array of Git::Tag objects
-
-    g.show()
-    g.show('HEAD')
-    g.show('v2.8', 'README.md')
-
-    Git.ls_remote('https://github.com/ruby-git/ruby-git.git') # returns a hash containing the available references of the repo.
-    Git.ls_remote('/path/to/local/repo')
-    Git.ls_remote() # same as Git.ls_remote('.')
-
+g = Git.open(working_dir, :log => Logger.new(STDOUT))
+
+g.index
+g.index.readable?
+g.index.writable?
+g.repo
+g.dir
+
+g.log   # returns array of Git::Commit objects
+g.log.since('2 weeks ago')
+g.log.between('v2.5', 'v2.6')
+g.log.each {|l| puts l.sha }
+g.gblob('v2.5:Makefile').log.since('2 weeks ago')
+
+g.object('HEAD^').to_s  # git show / git rev-parse
+g.object('HEAD^').contents
+g.object('v2.5:Makefile').size
+g.object('v2.5:Makefile').sha
+
+g.gtree(treeish)
+g.gblob(treeish)
+g.gcommit(treeish)
+
+
+commit = g.gcommit('1cc8667014381')
+
+commit.gtree
+commit.parent.sha
+commit.parents.size
+commit.author.name
+commit.author.email
+commit.author.date.strftime("%m-%d-%y")
+commit.committer.name
+commit.date.strftime("%m-%d-%y")
+commit.message
+
+tree = g.gtree("HEAD^{tree}")
+
+tree.blobs
+tree.subtrees
+tree.children # blobs and subtrees
+
+g.revparse('v2.5:Makefile')
+
+g.branches # returns Git::Branch objects
+g.branches.local
+g.branches.remote
+g.branches[:master].gcommit
+g.branches['origin/master'].gcommit
+
+g.grep('hello')  # implies HEAD
+g.blob('v2.5:Makefile').grep('hello')
+g.tag('v2.5').grep('hello', 'docs/')
+g.describe()
+g.describe('0djf2aa')
+g.describe('HEAD', {:all => true, :tags => true})
+
+g.diff(commit1, commit2).size
+g.diff(commit1, commit2).stats
+g.diff(commit1, commit2).name_status
+g.gtree('v2.5').diff('v2.6').insertions
+g.diff('gitsearch1', 'v2.5').path('lib/')
+g.diff('gitsearch1', @git.gtree('v2.5'))
+g.diff('gitsearch1', 'v2.5').path('docs/').patch
+g.gtree('v2.5').diff('v2.6').patch
+
+g.gtree('v2.5').diff('v2.6').each do |file_diff|
+  puts file_diff.path
+  puts file_diff.patch
+  puts file_diff.blob(:src).contents
+end
+
+g.worktrees # returns Git::Worktree objects
+g.worktrees.count
+g.worktrees.each do |worktree|
+  worktree.dir
+  worktree.gcommit
+  worktree.to_s
+end
+
+g.config('user.name')  # returns 'Scott Chacon'
+g.config # returns whole config hash
+
+g.tags # returns array of Git::Tag objects
+
+g.show()
+g.show('HEAD')
+g.show('v2.8', 'README.md')
+
+Git.ls_remote('https://github.com/ruby-git/ruby-git.git') # returns a hash containing the available references of the repo.
+Git.ls_remote('/path/to/local/repo')
+Git.ls_remote() # same as Git.ls_remote('.')
 ```
 
 And here are the operations that will need to write to your git repository.
 
 ```ruby
-      g = Git.init
-       Git.init('project')
-       Git.init('/home/schacon/proj',
-        { :repository => '/opt/git/proj.git',
-           :index => '/tmp/index'} )
-
-     g = Git.clone(URI, NAME, :path => '/tmp/checkout')
-     g.config('user.name', 'Scott Chacon')
-     g.config('user.email', 'email@email.com')
-
-     g.add                                   # git add -- "."
-     g.add(:all=>true)                       # git add --all -- "."
-     g.add('file_path')                      # git add -- "file_path"
-     g.add(['file_path_1', 'file_path_2'])   # git add -- "file_path_1" "file_path_2"
-
-     g.remove()									# git rm -f -- "."
-     g.remove('file.txt')						# git rm -f -- "file.txt"
-     g.remove(['file.txt', 'file2.txt'])		# git rm -f -- "file.txt" "file2.txt"
-     g.remove('file.txt', :recursive => true) 	# git rm -f -r -- "file.txt"
-     g.remove('file.txt', :cached => true)		# git rm -f --cached -- "file.txt"
-
-     g.commit('message')
-     g.commit_all('message')
-
-     g = Git.clone(repo, 'myrepo')
-     g.chdir do
-      new_file('test-file', 'blahblahblah')
-      g.status.changed.each do |file|
-       puts file.blob(:index).contents
-      end
-     end
-
-     g.reset # defaults to HEAD
-     g.reset_hard(Git::Commit)
-
-     g.branch('new_branch') # creates new or fetches existing
-     g.branch('new_branch').checkout
-     g.branch('new_branch').delete
-     g.branch('existing_branch').checkout
-     g.branch('master').contains?('existing_branch')
-
-     g.checkout('new_branch')
-     g.checkout(g.branch('new_branch'))
-
-     g.branch(name).merge(branch2)
-     g.branch(branch2).merge  # merges HEAD with branch2
-
-     g.branch(name).in_branch(message) { # add files }  # auto-commits
-     g.merge('new_branch')
-     g.merge('origin/remote_branch')
-     g.merge(g.branch('master'))
-     g.merge([branch1, branch2])
-
-     g.merge_base('branch1', 'branch2')
-
-     r = g.add_remote(name, uri)  # Git::Remote
-     r = g.add_remote(name, Git::Base)  # Git::Remote
-
-     g.remotes  # array of Git::Remotes
-     g.remote(name).fetch
-     g.remote(name).remove
-     g.remote(name).merge
-     g.remote(name).merge(branch)
-
-     g.fetch
-     g.fetch(g.remotes.first)
-     g.fetch('origin', {:ref => 'some/ref/head'} )
-
-     g.pull
-     g.pull(Git::Repo, Git::Branch) # fetch and a merge
-
-     g.add_tag('tag_name') # returns Git::Tag
-     g.add_tag('tag_name', 'object_reference')
-     g.add_tag('tag_name', 'object_reference', {:options => 'here'})
-     g.add_tag('tag_name', {:options => 'here'})
-
-     Options:
-       :a | :annotate
-       :d
-       :f
-       :m | :message
-       :s
-
-     g.delete_tag('tag_name')
-
-     g.repack
-
-     g.push
-     g.push(g.remote('name'))
+g = Git.init
+  Git.init('project')
+  Git.init('/home/schacon/proj',
+  { :repository => '/opt/git/proj.git',
+      :index => '/tmp/index'} )
+
+g = Git.clone(URI, NAME, :path => '/tmp/checkout')
+g.config('user.name', 'Scott Chacon')
+g.config('user.email', 'email@email.com')
+
+# Clone can take an optional logger
+logger = Logger.new
+g = Git.clone(URI, NAME, :log => logger)
+
+g.add                                   # git add -- "."
+g.add(:all=>true)                       # git add --all -- "."
+g.add('file_path')                      # git add -- "file_path"
+g.add(['file_path_1', 'file_path_2'])   # git add -- "file_path_1" "file_path_2"
+
+g.remove()									# git rm -f -- "."
+g.remove('file.txt')						# git rm -f -- "file.txt"
+g.remove(['file.txt', 'file2.txt'])		# git rm -f -- "file.txt" "file2.txt"
+g.remove('file.txt', :recursive => true) 	# git rm -f -r -- "file.txt"
+g.remove('file.txt', :cached => true)		# git rm -f --cached -- "file.txt"
+
+g.commit('message')
+g.commit_all('message')
+
+g = Git.clone(repo, 'myrepo')
+g.chdir do
+new_file('test-file', 'blahblahblah')
+g.status.changed.each do |file|
+  puts file.blob(:index).contents
+end
+end
+
+g.reset # defaults to HEAD
+g.reset_hard(Git::Commit)
+
+g.branch('new_branch') # creates new or fetches existing
+g.branch('new_branch').checkout
+g.branch('new_branch').delete
+g.branch('existing_branch').checkout
+g.branch('master').contains?('existing_branch')
+
+g.checkout('new_branch')
+g.checkout(g.branch('new_branch'))
+
+g.branch(name).merge(branch2)
+g.branch(branch2).merge  # merges HEAD with branch2
+
+g.branch(name).in_branch(message) { # add files }  # auto-commits
+g.merge('new_branch')
+g.merge('new_branch', 'merge commit message', no_ff: true)
+g.merge('origin/remote_branch')
+g.merge(g.branch('master'))
+g.merge([branch1, branch2])
+
+g.merge_base('branch1', 'branch2')
+
+r = g.add_remote(name, uri)  # Git::Remote
+r = g.add_remote(name, Git::Base)  # Git::Remote
+
+g.remotes  # array of Git::Remotes
+g.remote(name).fetch
+g.remote(name).remove
+g.remote(name).merge
+g.remote(name).merge(branch)
+
+g.fetch
+g.fetch(g.remotes.first)
+g.fetch('origin', {:ref => 'some/ref/head'} )
+
+g.pull
+g.pull(Git::Repo, Git::Branch) # fetch and a merge
+
+g.add_tag('tag_name') # returns Git::Tag
+g.add_tag('tag_name', 'object_reference')
+g.add_tag('tag_name', 'object_reference', {:options => 'here'})
+g.add_tag('tag_name', {:options => 'here'})
+
+Options:
+  :a | :annotate
+  :d
+  :f
+  :m | :message
+  :s
+
+g.delete_tag('tag_name')
+
+g.repack
+
+g.push
+g.push(g.remote('name'))
+
+g.worktree('/tmp/new_worktree').add
+g.worktree('/tmp/new_worktree', 'branch1').add
+g.worktree('/tmp/new_worktree').remove
+g.worktrees.prune
 ```
 
 Some examples of more low-level index and tree operations
 
 ```ruby
-     g.with_temp_index do
+g.with_temp_index do
 
-       g.read_tree(tree3) # calls self.index.read_tree
-       g.read_tree(tree1, :prefix => 'hi/')
+  g.read_tree(tree3) # calls self.index.read_tree
+  g.read_tree(tree1, :prefix => 'hi/')
 
-       c = g.commit_tree('message')
-       # or #
-       t = g.write_tree
-       c = g.commit_tree(t, :message => 'message', :parents => [sha1, sha2])
+  c = g.commit_tree('message')
+  # or #
+  t = g.write_tree
+  c = g.commit_tree(t, :message => 'message', :parents => [sha1, sha2])
 
-       g.branch('branch_name').update_ref(c)
-       g.update_ref(branch, c)
+  g.branch('branch_name').update_ref(c)
+  g.update_ref(branch, c)
 
-       g.with_temp_working do # new blank working directory
-         g.checkout
-         g.checkout(another_index)
-         g.commit # commits to temp_index
-       end
-     end
+  g.with_temp_working do # new blank working directory
+    g.checkout
+    g.checkout(another_index)
+    g.commit # commits to temp_index
+  end
+end
 
-     g.set_index('/path/to/index')
+g.set_index('/path/to/index')
 
 
-     g.with_index(path) do
-       # calls set_index, then switches back after
-     end
+g.with_index(path) do
+  # calls set_index, then switches back after
+end
 
-     g.with_working(dir) do
-     # calls set_working, then switches back after
-     end
+g.with_working(dir) do
+# calls set_working, then switches back after
+end
 
-     g.with_temp_working(dir) do
-       g.checkout_index(:prefix => dir, :path_limiter => path)
-       # do file work
-       g.commit # commits to index
-     end
+g.with_temp_working(dir) do
+  g.checkout_index(:prefix => dir, :path_limiter => path)
+  # do file work
+  g.commit # commits to index
+end
 ```
 
 ## License