git-glimmer 1.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4ede8893df1335bae755f81a3d3637cdd1b4802c803a2efc9d148b4211d4bad6
+  data.tar.gz: 8755d505a35644ff248a299d72ba1c536f30b23faa7d7c1e85cfdd649d4a45a5
+SHA512:
+  metadata.gz: 682c4a18dda7cd06ba998ae30d53079143b140c10f31bb4903601a98c1bc4f3c9269cc7000211fb53686286ac369b0581c4a74cb32a59f7c106a441f00a143a9
+  data.tar.gz: 621d1b65aeae923a9080e01910da618b8b76c93e8fa7aadce8bc35821d65484c26c7569e4d61010aa49bc1baf7912c259079c7a5c9bfbc098900b3cc4d462506

data/CHANGELOG.md

@@ -0,0 +1,106 @@
+# Change Log
+
+## 1.7.0
+
+See https://github.com/ruby-git/ruby-git/releases/tag/v1.7.0
+
+## 1.6.0
+
+See https://github.com/ruby-git/ruby-git/releases/tag/v1.6.0
+
+## 1.6.0.pre1
+
+See https://github.com/ruby-git/ruby-git/releases/tag/v1.6.0.pre1
+
+## 1.5.0
+
+See https://github.com/ruby-git/ruby-git/releases/tag/v1.5.0
+
+## 1.4.0
+
+See https://github.com/ruby-git/ruby-git/releases/tag/v1.4.0
+
+## 1.3.0
+
+ * Dropping Ruby 1.8.x support
+
+## 1.2.10
+
+ * Adding Git::Diff.name_status
+ * Checking and fixing encoding on commands output to prevent encoding errors afterwards
+
+## 1.2.9
+
+* Adding Git.configure (to configure the git env)
+* Adding Git.ls_remote [Git.ls_remote(repo_path_or_url='.')]
+* Adding Git.describe [repo.describe(objectish, opts)]
+* Adding Git.show [repo.show(objectish=nil, path=nil)]
+* Fixing Git::Diff to support default references (implicit references)
+* Fixing Git::Diff to support diff over git .patch files
+* Fixing Git.checkout when using :new_branch opt
+* Fixing Git::Object::Commit to preserve its sha after fetching metadata
+* Fixing Git.is_remote_branch? to actually check against remote branches
+* Improvements over how ENV variables are modified
+* Improving thrade safety (using --git-dir and --work-tree git opts)
+* Improving Git::Object::Tag. Adding annotated?, tagger and message
+* Supporting a submodule path as a valid repo
+* Git.checkout - supporting -f and -b
+* Git.clone - supporting --branch
+* Git.fetch - supporting --prune
+* Git.tag - supporting
+
+## 1.2.8
+
+* Keeping the old escape format for windows users
+* revparse: Supporting ref names containing SHA like substrings (40-hex strings)
+* Fix warnings on Ruby 2.1.2
+
+## 1.2.7
+
+* Fixing mesages encoding
+* Fixing -f flag in git push
+* Fixing log parser for multiline messages
+* Supporting object references on Git.add_tag
+* Including dotfiles on Git.status
+* Git.fetch - supporting --tags
+* Git.clean - supporting -x
+* Git.add_tag options - supporting -a, -m and -s
+* Added Git.delete_tag
+
+## 1.2.6
+
+* Ruby 1.9.X/2.0 fully supported
+* JRuby 1.8/1.9 support
+* Rubinius support
+* Git.clone - supporting --recursive and --config
+* Git.log - supporting last and [] over the results
+* Git.add_remote - supporting -f and -t
+* Git.add - supporting --fore
+* Git.init - supporting --bare
+* Git.commit - supporting --all and --amend
+* Added Git.remote_remote, Git.revert and Git.clean
+* Added Bundler to the formula
+* Travis configuration
+* Licence included with the gem
+
+## 1.0.4
+
+* added camping/gitweb.rb frontend
+* added a number of speed-ups
+
+## 1.0.3
+
+* Sped up most of the operations
+* Added some predicate functions (commit?, tree?, etc)
+* Added a number of lower level operations (read-tree, write-tree, checkout-index, etc)
+* Fixed a bug with using bare repositories
+* Updated a good amount of the documentation
+
+## 1.0.2
+
+* Added methods to the git objects that might be helpful
+
+## 1.0.1
+
+* Initial version
+

data/CONTRIBUTING.md

@@ -0,0 +1,144 @@
+# Contributing to ruby-git
+
+Thank you for your interest in contributing to the ruby-git project.
+
+This document gives the guidelines for contributing to the ruby-git project.
+These guidelines may not fit every situation.  When contributing use your best
+judgement.
+
+Propose changes to these guidelines with a pull request.
+
+## How to contribute to ruby-git
+
+You can contribute in two ways:
+
+1. [Report an issue or make a feature request](#how-to-report-an-issue-or-make-a-feature-request)
+2. [Submit a code or documentation change](#how-to-submit-a-code-or-documentation-change)
+
+## How to report an issue or make a feature request
+
+ruby-git utilizes [GitHub Issues](https://help.github.com/en/github/managing-your-work-on-github/about-issues)
+for issue tracking and feature requests.
+
+Report an issue or feature request by [creating a ruby-git Github issue](https://github.com/ruby-git/ruby-git/issues/new).
+Fill in the template to describe the issue or feature request the best you can.
+
+## How to submit a code or documentation change
+
+There is three step process for code or documentation changes:
+
+1. [Commit your changes to a fork of ruby-git](#commit-changes-to-a-fork-of-ruby-git)
+2. [Create a pull request](#create-a-pull-request)
+3. [Get your pull request reviewed](#get-your-pull-request-reviewed)
+
+### Commit changes to a fork of ruby-git
+
+Make your changes in a fork of the ruby-git repository.
+
+Each commit must include a [DCO sign-off](#developer-certificate-of-origin-dco)
+by adding the line `Signed-off-by: Name <email>` to the end of the commit
+message.
+
+### Create a pull request
+
+See [this article](https://help.github.com/articles/about-pull-requests/) if you
+are not familiar with GitHub Pull Requests.
+
+Follow the instructions in the pull request template.
+
+### Get your pull request reviewed
+
+Code review takes place in a GitHub pull request using the [the Github pull request review feature](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews).
+
+Once your pull request is ready for review, request a review from at least one
+[maintainer](MAINTAINERS.md) and any number of other contributors.
+
+During the review process, you may need to make additional commits which would
+need to be squashed.  It may also be necessary to rebase to master again if other
+changes are merged before your PR.
+
+At least one approval is required from a project maintainer before your pull
+request can be merged.  The maintainer is responsible for ensuring that the pull
+request meets [the project's coding standards](#coding-standards).
+
+## Coding standards
+
+In order to ensure high quality, all pull requests must meet these requirements:
+
+### 1 PR = 1 Commit
+  * All commits for a PR must be squashed into one commit
+  * To avoid an extra merge commit, the PR must be able to be merged as [a fast forward merge](https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging)
+  * The easiest way to ensure a fast forward merge is to rebase your local branch
+    to the ruby-git master branch
+
+### 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
+
+### Documentation
+  * New and updated public methods must have [YARD](https://yardoc.org/)
+    documentation added to them
+  * New and updated public facing features should be documented in the project's
+    [README.md](README.md)
+
+### Licensing sign-off
+  * Each commit must contain [the DCO sign-off](#developer-certificate-of-origin-dco)
+    in the form:  `Signed-off-by: Name <email>`
+
+## Licensing
+
+ruby-git uses [the MIT license](https://choosealicense.com/licenses/mit/) as
+declared in the [LICENSE](LICENSE) file.
+
+Licensing is very important to open source projects. It helps ensure the
+software continues to be available under the terms that the author desired.
+
+### Developer Certificate of Origin (DCO)
+
+This project requires that authors have permission to submit their contributions
+under the MIT license. To make a good faith effort to ensure this, ruby-git
+requires the [Developer Certificate of Origin (DCO)](https://elinux.org/Developer_Certificate_Of_Origin)
+process be followed.
+
+This process requires that each commit include a `Signed-off-by` line that
+indicates the author accepts the DCO.  Here is an example DCO sign-off line:
+
+```
+Signed-off-by: John Doe <john.doe@hisdomain.com>
+```
+
+The full text of the DCO version 1.1 is below or at <http://developercertificate.org/>.
+
+```
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the
+    best of my knowledge, is covered under an appropriate open
+    source license and I have the right under that license to
+    submit that work with modifications, whether created in whole
+    or in part by me, under the same open source license (unless
+    I am permitted to submit under a different license), as
+    Indicated in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including
+    all personal information I submit with it, including my
+    sign-off) is maintained indefinitely and may be redistributed
+    consistent with this project or the open source license(s)
+    involved.
+```

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2008 Scott Chacon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/MAINTAINERS.md

@@ -0,0 +1,9 @@
+# Maintainers
+
+When making changes in this repository, one of the maintainers below must review and approve your pull request.
+
+### Maintainers
+
+* [Per Lundberg](https://github.com/perlun)
+* [Vern Burton](https://github.com/tarcinil)
+* [James Couball](https://github.com/jcouball)

data/README.md

@@ -0,0 +1,300 @@
+# Git Library for Ruby
+
+Library for using Git in Ruby.
+
+## Homepage
+
+Git public hosting of the project source code is at:
+
+http://github.com/ruby-git/ruby-git
+
+## Install
+
+You can install Ruby/Git like this:
+
+    $ 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)
+* [![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)
+
+## Major Objects
+
+**Git::Base** - The object returned from a `Git.open` or `Git.clone`. Most major actions are called from this object.
+
+**Git::Object** - The base object for your tree, blob and commit objects, returned from `@git.gtree` or `@git.object` calls.  the `Git::AbstractObject` will have most of the calls in common for all those objects.
+
+**Git::Diff** - returns from a `@git.diff` command.  It is an Enumerable that returns `Git::Diff:DiffFile` objects from which you can get per file patches and insertion/deletion statistics.  You can also get total statistics from the Git::Diff object directly.
+
+**Git::Status** - returns from a `@git.status` command.  It is an Enumerable that returns
+`Git:Status::StatusFile` objects for each object in git, which includes files in the working
+directory, in the index and in the repository.  Similar to running 'git status' on the command line to determine untracked and changed files.
+
+**Git::Branches** - Enumerable object that holds `Git::Branch objects`.  You can call .local or .remote on it to filter to just your local or remote branches.
+
+**Git::Remote**- A reference to a remote repository that is tracked by this repository.
+
+**Git::Log** - An Enumerable object that references all the `Git::Object::Commit` objects that encompass your log query, which can be constructed through methods on the `Git::Log object`,
+like:
+
+ `@git.log(20).object("some_file").since("2 weeks ago").between('v2.6', 'v2.7').each { |commit| [block] }`
+
+## Examples
+
+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 the 'git' gem.
+```ruby
+    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'
+
+    # 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`_
+
+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('.')
+
+```
+
+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'))
+```
+
+Some examples of more low-level index and tree operations
+
+```ruby
+     g.with_temp_index do
+
+       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])
+
+       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.set_index('/path/to/index')
+
+
+     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_temp_working(dir) do
+       g.checkout_index(:prefix => dir, :path_limiter => path)
+       # do file work
+       g.commit # commits to index
+     end
+```
+
+## License
+
+licensed under MIT License Copyright (c) 2008  Scott Chacon. See LICENSE for further details.