rugged 0.19.0 → 0.28.0

data/test/fixtures/text_file.md

@@ -1,464 +0,0 @@
-# Rugged
-**libgit2 bindings in Ruby**
-
-Rugged is a library for accessing [libgit2](https://github.com/libgit2/libgit2) in Ruby. It gives you the speed and
-portability of libgit2 with the beauty of the Ruby language.
-
-### libgit2
-
-libgit2 is a pure C implementation of the Git core methods. It's designed to be
-fast and portable. For more information about libgit2,
-[check out libgit2's website](http://libgit2.github.com) or browse the
-[libgit2 organization](https://github.com/libgit2) on GitHub.
-
-## Install
-
-Rugged is a self-contained gem. You can install it by running:
-
-    $ gem install rugged
-
-To load Rugged, you'll usually want to add something like this:
-
-```ruby
-require 'rugged'
-```
-
-## Usage
-
-Rugged gives you access to the many parts of a Git repository. You can read and
-write objects, walk a tree, access the staging area, and lots more. Let's look
-at each area individually.
-
-### Repositories
-
-#### Instantiation
-
-The repository is naturally central to Git. Rugged has a `Repository` class that
-you can instantiate with a path to open an existing repository :
-
-```ruby
-repo = Rugged::Repository.new('path/to/my/repository')
-# => #<Rugged::Repository:2228536260 {path: "path/to/my/repository/.git/"}>
-```
-
-You can create a new repository with `init_at`. Add a second parameter `:bare` to make a bare repository:
-
-```ruby
-Rugged::Repository.init_at('.', :bare)
-```
-
-You can also let Rugged discover the path to the .git directory if you give it a
-subdirectory.
-
-```ruby
-Rugged::Repository.discover("/Users/me/projects/repo/lib/subdir/")
-# => "/Users/me/projects/repo/.git/"
-```
-
-Once your Repository instantiated (in the following examples, as `repo`), you
-can access or modify it.
-
-#### Accessing a Repository
-
-```ruby
-# Does the given SHA1 exist in this repository?
-repo.exists?('07b44cbda23b726e5d54e2ef383495922c024202')
-# => true
-
-# Boolean repository state values:
-repo.bare?
-# => false
-repo.empty?
-# => true
-repo.head_orphan?
-# => false
-repo.head_detached?
-# => false
-
-# Path accessors
-repo.path
-# => "path/to/my/repository/.git/"
-repo.workdir
-# => "path/to/my/repository/"
-
-# The HEAD of the repository.
-ref = repo.head
-# => #<Rugged::Reference:2228467240 {name: "refs/heads/master", target: "07b44cbda23b726e5d54e2ef383495922c024202"}>
-
-# From the returned ref, you can also access the `name` and `target`:
-ref.name
-# => "refs/heads/master"
-ref.target
-# => "07b44cbda23b726e5d54e2ef383495922c024202"
-
-# Reading an object
-object = repo.read('a0ae5566e3c8a3bddffab21022056f0b5e03ef07')
-# => #<Rugged::OdbObject:0x109a64780>
-object.len
-# => 237
-object.data
-# => "tree 76f23f186076fc291742816721ea8c3e95567241\nparent 8e3c5c52b8f29da0adc7e8be8a037cbeaea6de6b\nauthor Vicent Mart\303\255 <tanoku@gmail.com> 1333859005 +0200\ncommitter Vicent Mart\303\255 <tanoku@gmail.com> 1333859005 +0200\n\nAdd `Repository#blob_at`\n"
-object.type
-# => :commit
-```
-
-#### Writing to a Repository
-
-There's a few ways to write to a repository. To write directly from your
-instantiated repository object:
-
-```ruby
-sha = repo.write(content, type)
-```
-
-You can also use the `Commit` object directly to craft a commit; this is a bit
-more high-level, so it may be preferable:
-
-```ruby
-oid = repo.write("This is a blob.", :blob)
-index = Rugged::Index.new
-index.add(:path => "README.md", :oid => oid, :mode => 0100644)
-
-options = {}
-options[:tree] = index.write_tree(repo)
-
-options[:author] = { :email => "testuser@github.com", :name => 'Test Author', :time => Time.now }
-options[:committer] = { :email => "testuser@github.com", :name => 'Test Author', :time => Time.now }
-options[:message] ||= "Making a commit via Rugged!"
-options[:parents] = repo.empty? ? [] : [ repo.head.target ].compact
-options[:update_ref] = 'HEAD'
-
-Rugged::Commit.create(repo, options)
-```
-
----
-
-### Objects
-
-`Object` is the main object class - it shouldn't be created directly, but all of
-these methods should be useful in their derived classes.
-
-```ruby
-obj = repo.lookup(sha)
-obj.oid  # object sha
-obj.type # One of :commit, :tree, :blob or :tag
-
-robj = obj.read_raw
-str  = robj.data
-int  = robj.len
-```
-
-There are four base object types in Git: **blobs**, **commits**, **tags**, and
-**trees**. Each of these object types have a corresponding class within Rugged.
-
-### Commit Objects
-
-```ruby
-commit = repo.lookup('a0ae5566e3c8a3bddffab21022056f0b5e03ef07')
-# => #<Rugged::Commit:2245304380>
-
-commit.message
-# => "Add `Repository#blob_at`\n"
-
-commit.time
-# => Sat Apr 07 21:23:25 -0700 2012
-
-commit.author
-# => {:email=>"tanoku@gmail.com", :name=>"Vicent Mart\303\255", :time=>Sun Apr 08 04:23:25 UTC 2012}
-
-commit.tree
-# => #<Rugged::Tree:2245269740>
-
-commit.parents
-=> [#<Rugged::Commit:2245264600 {message: "Merge pull request #47 from isaac/remotes\n\nAdd Rugged::Repository#remotes", tree: #<Rugged::Tree:2245264240 {oid: 6a2aee58a41fa007d07aa55565e2231f9b39b4a9}>
-```
-
-You can also write new objects to the database this way:
-
-```ruby
-author = {:email=>"tanoku@gmail.com", :time=>Time.now, :name=>"Vicent Mart\303\255"}
-
-Rugged::Commit.create(r,
-	:author => author,
-	:message => "Hello world\n\n",
-	:committer => author,
-	:parents => ["2cb831a8aea28b2c1b9c63385585b864e4d3bad1"],
-	:tree => some_tree,
-	:update_ref => "HEAD") #=> "f148106ca58764adc93ad4e2d6b1d168422b9796"
-```
-
-### Tag Objects
-
-```ruby
-tag  = repo.lookup(tag_sha)
-
-object = tag.target
-sha    = tag.target.oid
-str    = tag.target_type # :commit, :tag, :blob
-str    = tag.name        # "v1.0"
-str    = tag.message
-person = tag.tagger
-```
-
-### Tree Objects
-
-```ruby
-tree = repo.lookup('779fbb1e17e666832773a9825875300ea736c2da')
-# => #<Rugged::Tree:2245194360>
-
-# number of tree entries
-tree.count
-
-tree[0]           # or...
-tree.first        # or...
-tree.get_entry(0)
-# => {:type=>:blob, :oid=>"99e7edb53db9355f10c6f2dfaa5a183f205d93bf", :filemode=>33188, :name=>".gitignore"}
-```
-
-The tree object is an Enumerable, so you can also do stuff like this:
-
-```ruby
-tree.each { |e| puts e[:oid] }
-tree.sort { |a, b| a[:oid] <=> b[:oid] }.map { |e| e[:name] }.join(':')
-```
-
-And there are some Rugged-specific methods, too:
-
-```ruby
-tree.each_tree { |entry| puts entry[:name] }  # list subdirs
-tree.each_blob { |entry| puts entry[:name] }  # list only files
-```
-
-You can also write trees with the `TreeBuilder`:
-
-```ruby
-oid = repo.write("This is a blob.", :blob)
-builder = Rugged::Tree::Builder.new
-builder << { :type => :blob, :name => "README.md", :oid => oid, :filemode => 0100644 }
-
-options = {}
-options[:tree] = builder.write(repo)
-
-options[:author] = { :email => "testuser@github.com", :name => 'Test Author', :time => Time.now }
-options[:committer] = { :email => "testuser@github.com", :name => 'Test Author', :time => Time.now }
-options[:message] ||= "Making a commit via Rugged!"
-options[:parents] = repo.empty? ? [] : [ repo.head.target ].compact
-options[:update_ref] = 'HEAD'
-
-Rugged::Commit.create(repo, options)
-```
-
----
-
-### Commit Walker
-
-`Rugged::Walker` is a class designed to help you traverse a set of commits over
-a repository.
-
-You first push head SHAs onto the walker, and then call next to get a list of
-the reachable commit objects one at a time. You can also `hide()` commits if you
-are not interested in anything beneath them (useful in situations like when
-you're running something like `git log master ^origin/master`).
-
-```ruby
-walker = Rugged::Walker.new(repo)
-walker.sorting(Rugged::SORT_TOPO | Rugged::SORT_REVERSE) # optional
-walker.push(hex_sha_interesting)
-walker.hide(hex_sha_uninteresting)
-walker.each { |c| puts c.inspect }
-walker.reset
-```
-
----
-
-### Index ("staging") area
-
-We can inspect and manipulate the Git Index as well. To work with the index
-inside an existing repository, instantiate it by using the `Repository.index`
-method instead of manually opening the Index by its path.
-
-```ruby
-index = Rugged::Index.new(path)
-
-# Re-read the index file from disk.
-index.reload
-
-# Count up index entries.
-count = index.count
-
-# The collection of index entries.
-index.entries
-
-# Iterating over index entries.
-index.each { |i| puts i.inspect }
-
-# Get a particular entry in the index.
-index[path]
-
-# Unstage.
-index.remove(path)
-
-# Stage. Also updates existing entry if there is one.
-index.add(ientry)
-
-# Stage. Create ientry from file in path, updates the index.
-index.add(path)
-```
-
----
-
-### Refs
-
-The `Rugged::Reference` class allows you to list, create and delete packed and loose refs.
-
-```ruby
-ref = repo.head # or...
-ref = Rugged::Reference.lookup(repo, "refs/heads/master")
-
-sha = ref.target
-str = ref.type   # :direct
-str = ref.name   # "refs/heads/master"
-```
-
-You can also easily get an array of references:
-
-```ruby
-repo.refs.each do |ref|
-  puts ref.name
-end
-```
-
-Or use a pattern (regex):
-
-```ruby
-repo.refs(/tags/).each do |ref|
-  puts ref.name
-end
-```
-
-It is also easy to create, update, rename or delete a reference:
-
-```ruby
-ref = Rugged::Reference.create(repo, "refs/heads/unit_test", some_commit_sha)
-
-ref.set_target(new_sha)
-
-ref.rename("refs/heads/blead")
-
-ref.delete!
-```
-
-Finally, you can access the reflog for any branch:
-
-```ruby
-ref = Rugged::Reference.lookup(repo, "refs/heads/master")
-entry = ref.log.first
-sha   = entry[:id_old]
-sha   = entry[:id_new]
-str   = entry[:message]
-prsn  = entry[:committer]
-```
-
----
-
-### Branches
-
-`Rugged::Branch` will help you with all of your branch-related needs.
-
-Iterate over all branches:
-
-```ruby
-Rugged::Branch.each_name(repo).sort
-# => ["master", "origin/HEAD", "origin/master", "origin/packed"]
-
-Rugged::Branch.each_name(repo, :local).sort
-# => ["master"]
-
-Rugged::Branch.each_name(repo, :remote).sort
-# => ["origin/HEAD", "origin/master", "origin/packed"]
-```
-
-Look up branches and get attributes:
-
-```ruby
-branch = Rugged::Branch.lookup(repo, "master")
-branch.name # => 'master'
-branch.canonical_name # => 'refs/heads/master'
-```
-
-Look up the oid for the tip of a branch:
-
-```ruby
-Rugged::Branch.lookup(repo, "master").tip.oid
-# => "36060c58702ed4c2a40832c51758d5344201d89a"
-```
-
-Creation and deletion:
-
-```ruby
-branch = repo.create_branch("test_branch")
-branch.move("new_branch")
-branch.delete!
-```
-
----
-
-### Config files
-
-It's also easy to read and manipulate the Git config file data with Rugged.
-
-```ruby
-# Read values
-repo.config['core.bare']
-
-# Set values
-repo.config['user.name'] = true
-
-# Delete values
-repo.config.delete('user.name')
-```
-
----
-
-### General methods
-
-Rugged also includes a general library for handling basic Git operations. One of
-these is converting a raw sha (20 bytes) into a readable hex sha (40
-characters).
-
-```ruby
-Rugged.hex_to_raw('bfde59cdd0dfac1d892814f66a95641abd8a1faf')
-# => "\277\336Y\315\320\337\254\035\211(\024\366j\225d\032\275\212\037\257"
-
-Rugged.raw_to_hex("\277\336Y\315\320\337\254\035\211(\024\366j\225d\032\275\212\037\257")
-=> "bfde59cdd0dfac1d892814f66a95641abd8a1faf"
-```
-
----
-
-## Contributing
-
-Fork libgit2/rugged on GitHub, make it awesomer (preferably in a branch named
-for the topic), send a pull request.
-
-
-## Development
-
-Simply clone and install:
-
-    $ git clone https://github.com/libgit2/rugged.git
-    $ cd rugged
-    $ bundle install
-    $ rake compile
-    $ rake test
-
-
-## Authors
-
-* Vicent Marti <tanoku@gmail.com>
-* Scott Chacon <schacon@gmail.com>
-
-
-## License
-
-MIT. See LICENSE file.

data/test/fixtures/unsymlinked.git/HEAD

@@ -1 +0,0 @@
-ref: refs/heads/master

data/test/fixtures/unsymlinked.git/config

@@ -1,6 +0,0 @@
-[core]
-	bare = true
-	repositoryformatversion = 0
-	filemode = false
-	logallrefupdates = true
-	ignorecase = true

data/test/fixtures/unsymlinked.git/description

@@ -1 +0,0 @@
-Unnamed repository; edit this file 'description' to name the repository.

data/test/fixtures/unsymlinked.git/info/exclude

@@ -1,2 +0,0 @@
-# File patterns to ignore; see `git help ignore` for more information.
-# Lines that start with '#' are comments.

data/test/fixtures/unsymlinked.git/objects/a8/595ccca04f40818ae0155c8f9c77a230e597b6

@@ -1,2 +0,0 @@
-x
��[
-�0E��*�_��y��݀{�4ShZ))�|�����N[ks=�Kߙ��Ś�[���Q"4&&�M*�i/޴��!��1��S�*��A��Gt)��-'U����m��7O	cc�չ=z�崵;(�PY���+*Dq��^�E!��*�/�0�}Z�?<���P慥���Jp

data/test/fixtures/unsymlinked.git/refs/heads/exe-file

@@ -1 +0,0 @@
-a8595ccca04f40818ae0155c8f9c77a230e597b6

data/test/fixtures/unsymlinked.git/refs/heads/master

@@ -1 +0,0 @@
-7fccd75616ec188b8f1b23d67506a334cc34a49d

data/test/fixtures/unsymlinked.git/refs/heads/reg-file

@@ -1 +0,0 @@
-806999882bf91d24241e4077906b9017605eb1f3