rugged 0.0.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2010 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/README.md

@@ -0,0 +1,290 @@
+Rugged - libgit2 bindings in Ruby
+===================================
+
+Rugged is a Ruby bindings to the libgit2 linkable C Git library. This is
+for testing and using the libgit2 library in a language that is awesome.
+
+INSTALLING AND RUNNING
+========================
+
+First you need to install libgit2:
+
+    $ git clone git://github.com/libgit2/libgit2.git
+    $ cd libgit2
+    $ make
+    $ make install
+
+Next, you need to install rake-compiler:
+
+    $ sudo gem install rake-compiler
+
+Now that those are installed, you can install Rugged:
+
+    $ git clone git://github.com/libgit2/rubbit.git
+    $ cd rugged
+    $ rake compile
+    $ rake test
+
+
+API 
+==============
+
+There is a general library for some basic Gitty methods.  So far, just converting
+a raw sha (20 bytes) into a readable hex sha (40 char).
+
+    raw = Rugged::Lib.hex_to_raw(hex_sha)
+    hex = Rugged::Lib.raw_to_hex(20_byte_raw_sha)
+
+
+Repository Access
+-----------------
+
+There is a Repository class that you can instantiate with a path.
+This lets you check for objects, read raw object data, write raw object data and
+get a hash (SHA1 checksum) of what contents would be without writing them out.
+You also use it to lookup Git objects from it.
+
+Repository is the main repository object that everything
+else will emanate from.
+
+    repo =
+    Rugged::Repository.new(path, git_dir=nil, index_path=nil)
+      ctnt, type = repo.read(sha)
+      gobj = repo.lookup(sha, type[?])  # optional type argument for checking
+      sha  = repo.write(content, type)
+      sha  = repo.hash(content, type)
+      bool = repo.exists(sha)
+
+If Repository is initialized without `git_dir`, path + '.git' will be assumed
+and path will be assumed to be the working directory.  If `path` is a git 
+directory, then `git_dir` will be set to that and none of the Rugged functions
+that need a working directory will work. If the `index_path` is not specified, 
+the `git_dir` path plus '/index' will be assumed.
+
+
+Object Access
+-----------------
+
+Object is the main object class - it shouldn't be created directly,
+but all of these methods should be useful in it's derived classes
+
+    object = 
+    # Constructor is inherited by all the repository objects
+    # 'sha' is the ID of the object; 
+    # 'repo' is the repository where the object resides
+    # If both 'sha' and 'repo' exist, the object will be looked up on
+    # the repository and instantiated
+    # If the 'sha' ID of the object is missing, the object will be
+    # created in memory and can be written later on to the repository
+    Rugged::Object(repo, sha)
+      obj.sha
+      obj.type
+
+      str = obj.read_raw	# read the raw data of the object
+      sha = obj.write		# write the object to a repository
+
+
+The next classes are for consuming and creating the 4 base
+git object types.  just about every method should be able to take
+of each should be able to take a parameter to change the value
+so the object can be re-written slightly differently or no parameter
+to simply read the current value out
+
+    gobjc =
+    Rugged::Commit.new < Rugged::Object
+      str   = gobjc.message
+      str   = gobjc.message_short
+      str   = gobjc.message_body # TODO
+      prsn  = gobjc.author
+      prsn  = gobjc.committer
+      gobjr = gobjc.tree
+      sha   = gobjc.tree_sha
+      arr   = gobjc.parents [*] # TODO
+
+    gobtg =
+    Rugged::Tag.new < Rugged::Object
+      gobj  = gobtg.target
+      int   = gobtg.target_type
+      str   = gobtg.name
+      prsn  = gobtg.tagger
+      str   = gobtg.message
+
+    gobtr =
+    Rugged::Tree.new < Rugged::Object
+              gobtr.add(ent) # TODO
+              gobtr.remove(name) # TODO
+      int   = gobtr.entry_count
+      ent   = gobtr.get_entry
+
+    ent =
+    Rugged::TreeEntry.new(attributes, name, sha)
+      int  = ent.attributes
+      str  = ent.name
+      sha  = ent.sha
+      gobj = ent.to_object
+
+// * Person information is returned as a hash table
+
+
+Commit Walker
+-----------------
+
+There is also a Walker class that currently takes a repo object. You can push 
+head SHAs onto the walker, 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 for a `git log master ^origin/master` type deal).
+
+    walker = 
+    Rugged::Walker.new(repo) 
+             walker.push(hex_sha_interesting)
+             walker.hide(hex_sha_uninteresting)
+      cmt  = walker.next # false if none left
+             walker.reset
+
+
+
+Index/Staging Area
+-------------------
+
+We can inspect and manipulate the Git Index as well.
+
+    # the remove and add functions immediately flush to the index file on disk
+    index =
+    Rugged::Index.new(repo, path=nil)  # TODO: take a repo or a path
+            index.refresh              # re-read the index file from disk
+      int = index.entry_count # count of index entries
+      ent = index.get_entry(i/path)
+            index.remove(i/path)
+            index.add(ientry)    # also updates existing entry if there is one
+            index.add(path)      # create ientry from file in path, update index
+      #TODO index.read_tree(gobtr, path='/')
+      #TODO index.write_tree
+    
+    ientry = 
+    Rugged::IndexEntry.new(index, offset)
+      str = ientry.path
+     time = ientry.ctime
+     time = ientry.mtime
+      str = ientry.sha
+      int = ientry.dev
+      int = ientry.ino
+      int = ientry.mode
+      int = ientry.uid
+      int = ientry.gid
+      int = ientry.file_size
+      int = ientry.flags # (what flags are available?)
+      int = ientry.flags_extended # (what flags are available?)
+
+Index Status # TODO
+-------------------
+
+      #TODO index.status # how does the index differ from the work tree and the last commit
+
+    # >> pp stat
+    # [ ['file1', :staged],
+    #   ['file2', :modified],
+    #   ['file3', :deleted],
+    #   ['file4', :untracked],
+    #   ['file4', :unmerged],
+    # ]
+
+
+Ref Management # TODO
+-------------------
+
+The RefList class allows you to list, create and delete packed and loose refs.
+
+    list =
+    Rugged::RefList.new(repo)
+     ref   = list.head         # can retrieve and set HEAD with this - returns ref obj or commit obj if detatched
+     array = list.list([type]) # type is 'heads', 'tags', 'remotes', 'notes', et
+             list.add(oref)
+             list.pack
+             list.unpack
+
+    oref =
+    Rugged::Ref.new(ref, sha)
+             br.name # master
+             br.ref  # refs/heads/master
+             br.type # heads
+             br.object
+             br.sha
+             br.delete
+             br.save
+
+
+Config Management # TODO
+------------------------
+
+    conf =
+    Rugged::Config.new(repo)
+      hash = conf.list([section])
+       val = conf.get(key, [scope])
+      bool = conf.set(key, value, [scope]) # scope is 'local'(default), 'global', 'system'
+
+
+Client Transport # TODO
+-----------------------
+
+    client =
+    Rugged::Client.new(repo)
+    summry = client.fetch(url, [refs])
+    summry = client.push(url, refs)
+      refs = client.refs(url)  # ls-remote
+
+
+Remote Management # TODO
+------------------------
+
+    remlist =
+    Rugged::RemoteList.new(repo)
+    array = remlist.list
+      rem = remlist.add(alias, url)
+
+    rem =
+    Rugged::Remote.new(repo)
+    summry = rem.fetch([refs])
+    summry = rem.push(refs)
+    summry = rem.remove(refs)
+      bool = rem.delete
+     heads = rem.heads
+
+
+Server Transport # TODO
+------------------------
+
+    server =
+    Rugged::Server.new
+             server.listen(port = 8080, ip = 0.0.0.0)
+             server.export_repo(path/repo)
+             server.export_path(path)
+
+
+TODO
+==============
+
+I will try to keep this up to date with the working public API available in
+the libgit2 linkable library.  Whatever is available there should be here
+as well.  The latest libgit2 commit known to link and build successfully will
+be listed in the LIBGIT2_VERSION file.
+
+
+CONTRIBUTING
+==============
+
+Fork libgit2/rugged on GitHub, make it awesomer (preferably in a branch named
+for the topic), send a pull request.
+
+
+AUTHORS 
+==============
+
+* Scott Chacon <schacon@gmail.com>
+* Vicent Marti <tanoku@gmail.com>
+
+
+LICENSE
+==============
+
+MIT.  See LICENSE file.
+

data/Rakefile

@@ -0,0 +1,118 @@
+# stolen largely from defunkt/mustache
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/extensiontask'
+
+Rake::ExtensionTask.new('rugged') do |r|
+  r.lib_dir = 'lib/rugged'
+end
+
+#
+# Helpers
+#
+
+def command?(command)
+  system("type #{command} > /dev/null")
+end
+
+
+#
+# Tests
+#
+
+task :default => :test
+
+if command? :turn
+  desc "Run tests"
+  task :test do
+    suffix = "-n #{ENV['TEST']}" if ENV['TEST']
+    sh "turn test/*_test.rb #{suffix}"
+  end
+else
+  Rake::TestTask.new do |t|
+    t.libs << 'lib'
+    t.pattern = 'test/**/*_test.rb'
+    t.verbose = false
+  end
+end
+
+if command? :kicker
+  desc "Launch Kicker (like autotest)"
+  task :kicker do
+    puts "Kicking... (ctrl+c to cancel)"
+    exec "kicker -e rake test lib"
+  end
+end
+
+desc "Update the libgit2 SHA"
+task :libgit do
+  sha = `git --git-dir=../libgit2/.git rev-parse HEAD`
+  File.open("LIBGIT2_VERSION", 'w') do |f|
+    f.puts "# git --git-dir=../libgit2/.git rev-parse HEAD"
+    f.puts sha
+  end
+end
+
+
+#
+# Ron
+#
+
+if command? :ronn
+  desc "Show the manual"
+  task :man => "man:build" do
+    exec "man man/mustache.1"
+  end
+
+  desc "Build the manual"
+  task "man:build" do
+    sh "ronn -br5 --organization=SCHACON --manual='Rugged Manual' man/*.ron"
+  end
+end
+
+
+#
+# Gems
+#
+
+begin
+  require 'mg'
+  MG.new("rugged.gemspec")
+
+  desc "Push a new version to Gemcutter and publish docs."
+  task :publish => "gem:publish" do
+    require File.dirname(__FILE__) + '/lib/mustache/version'
+
+    system "git tag v#{Rugged::Version}"
+    sh "git push origin master --tags"
+    sh "git clean -fd"
+    exec "rake pages"
+  end
+rescue LoadError
+  warn "mg not available."
+  warn "Install it with: gem i mg"
+end
+
+#
+# Documentation
+#
+
+desc "Publish to GitHub Pages"
+task :pages => [ "man:build" ] do
+  Dir['man/*.html'].each do |f|
+    cp f, File.basename(f).sub('.html', '.newhtml')
+  end
+
+  `git commit -am 'generated manual'`
+  `git checkout site`
+
+  Dir['*.newhtml'].each do |f|
+    mv f, f.sub('.newhtml', '.html')
+  end
+
+  `git add .`
+  `git commit -m updated`
+  `git push site site:master`
+  `git checkout master`
+  puts :done
+end

data/ext/rugged/extconf.rb

@@ -0,0 +1,9 @@
+require 'mkmf'
+
+dir_config("rugged")
+
+have_library("git2")
+have_library('z')
+
+create_makefile("rugged")
+

data/lib/rugged/index.rb

@@ -0,0 +1,13 @@
+class Rugged
+  class Index
+    include Enumerable
+
+    def each
+      entries = self.entry_count
+      0.upto(entries - 1) do |i|
+        yield self[i]
+      end
+    end
+
+  end
+end

data/lib/rugged/tree.rb

@@ -0,0 +1,13 @@
+class Rugged
+  class Tree
+    include Enumerable
+
+    def each
+      entries = self.entry_count
+      0.upto(entries - 1) do |i|
+        yield self[i]
+      end
+    end
+
+  end
+end

data/lib/rugged/tree_entry.rb

@@ -0,0 +1,9 @@
+class Rugged
+  class TreeEntry
+
+    def <=>(a)
+      self.name <=> a.name
+    end
+
+  end
+end

data/lib/rugged/version.rb

@@ -0,0 +1,3 @@
+class Rugged
+  Version = VERSION = '0.0.1'
+end

data/lib/rugged.rb

@@ -0,0 +1,5 @@
+require 'rugged/rugged'
+require 'rugged/index'
+require 'rugged/tree'
+require 'rugged/tree_entry'
+require 'rugged/version'

data/test/commit_test.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+context "Rugged::Commit tests" do
+  setup do
+    path = File.dirname(__FILE__) + '/fixtures/testrepo.git/'
+    @repo = Rugged::Repository.new(path)
+  end
+
+  test "can read the commit data" do
+    sha = "8496071c1b46c854b31185ea97743be6a8774479"
+    obj = @repo.lookup(sha)
+
+    assert_equal obj.sha, sha
+	  assert_equal obj.type, "commit"
+    assert_equal obj.message, "testing\n"
+    assert_equal obj.message_short, "testing"
+    assert_equal obj.time.to_i, 1273360386
+    c = obj.committer
+    assert_equal c['name'], "Scott Chacon"
+    assert_equal c['time'].to_i, 1273360386
+    assert_equal c['email'], "schacon@gmail.com"
+    c = obj.author
+    assert_equal c['name'], "Scott Chacon"
+    assert_equal c['time'].to_i, 1273360386
+    assert_equal c['email'], "schacon@gmail.com"
+    assert_equal obj.tree.sha, "181037049a54a1eb5fab404658a3a250b44335d7"
+  end
+  
+  test "can write the commit data" do
+    sha = "8496071c1b46c854b31185ea97743be6a8774479"
+    obj = @repo.lookup(sha)
+    obj.message = 'new message'
+    obj.write
+  end
+
+end

data/test/fixtures/testrepo.git/HEAD

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

data/test/fixtures/testrepo.git/config

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

data/test/fixtures/testrepo.git/description

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

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

@@ -0,0 +1,6 @@
+# git-ls-files --others --exclude-from=.git/info/exclude
+# Lines that start with '#' are comments.
+# For a project mostly in C, the following would be a good set of
+# exclude patterns (uncomment them if you want to use them):
+# *.[oa]
+# *~

data/test/fixtures/testrepo.git/logs/HEAD

@@ -0,0 +1,3 @@
+0000000000000000000000000000000000000000 8496071c1b46c854b31185ea97743be6a8774479 Scott Chacon <schacon@gmail.com> 1273360386 -0700	commit (initial): testing
+8496071c1b46c854b31185ea97743be6a8774479 5b5b025afb0b4c913b4c338a42934a3863bf3644 Scott Chacon <schacon@gmail.com> 1273610322 -0700	commit: another commit
+5b5b025afb0b4c913b4c338a42934a3863bf3644 36060c58702ed4c2a40832c51758d5344201d89a Scott Chacon <schacon@gmail.com> 1288115062 -0200	push

data/test/fixtures/testrepo.git/logs/refs/heads/master

@@ -0,0 +1,3 @@
+0000000000000000000000000000000000000000 8496071c1b46c854b31185ea97743be6a8774479 Scott Chacon <schacon@gmail.com> 1273360386 -0700	commit (initial): testing
+8496071c1b46c854b31185ea97743be6a8774479 5b5b025afb0b4c913b4c338a42934a3863bf3644 Scott Chacon <schacon@gmail.com> 1273610322 -0700	commit: another commit
+5b5b025afb0b4c913b4c338a42934a3863bf3644 36060c58702ed4c2a40832c51758d5344201d89a Scott Chacon <schacon@gmail.com> 1288115062 -0200	push

data/test/fixtures/testrepo.git/objects/36/060c58702ed4c2a40832c51758d5344201d89a

@@ -0,0 +1,2 @@
+x
��Q
+�0��)r
e�ݴ

data/test/fixtures/testrepo.git/objects/4a/202b346bb0fb0db7eff3cffeb3c70babbd2045

@@ -0,0 +1,2 @@
+x
��Q
+�0D��)��6�ͦ "xO���-�Fb��Eo��0�Ǥ�,ske�[�Pn8R,EpD?�g�}�^3���<��G�hYK���8ЖDA��)���;g�ݧ���j�p�4����-������r���;�s�GA4ۺ=���(�in7�I�K�FE

data/test/fixtures/testrepo.git/objects/5b/5b025afb0b4c913b4c338a42934a3863bf3644

@@ -0,0 +1,2 @@
+x
���	1E�Ni@��k2 "X�$�YW0Yc����Ås���z����MD�
�0��8!�����s�X��g�d�::@X0�P�w�"F/����R��Uz��m�ZZ�����V}|�/�o5����I�!�1z��:v��Uim}�/�>
+�F-

data/test/fixtures/testrepo.git/objects/9f/d738e8f7967c078dceed8190330fc8648ee56a

@@ -0,0 +1,3 @@
+x
��[
+�0E��*f��դ "�W0��-�F�t�݁��pS[�Y��x�^
+D�b	CLhut��}�8X*4Z��sY���U��A��

data/test/fixtures/testrepo.git/objects/a4/a7dce85cf63874e984719f4fdd239f5145052f

@@ -0,0 +1,2 @@
+x
��;j1D��md�����ǎ|M��3`��V{>���Q����vL0I?�!�4�Z=�!�צ8�F���!r�sQ�y�9�]$D�&�l6A�>jFW�ҵIKNi��Z�%�S���
+��	������U~̽��>'���	�w�

data/test/fixtures/testrepo.git/objects/be/3563ae3f795b2b4353bcce3a527ad0a4f7f644

@@ -0,0 +1,3 @@
+x
��Kj1D��)z�UB��-0��uV9����<#������+�W<J���&8�/s��e���ȕKJ����S
+�Rv��{��Q��r��Y�QN$H\E����=6�X5���K Fr)�(�dC��Ά�����j�s�}���9�c-�w8�o�\�r��I���:
+l}F�W$Ds�ǣ��ٚOW�e�]V8-Ý��"U

data/test/fixtures/testrepo.git/objects/c4/7800c7266a2be04c571c04d5a6614691ea99bd

@@ -0,0 +1,3 @@
+x
��Q
+�0D��)�ʦ�I<�'�lR+�Fj��Eo��0<x�h���a ���]ș��XUl�PF)�z�4y�,\r	'S��-mI4
+�Xh��&��F�}n+\���Y�-p|鷜oU�z;-��a�
�lt{��?�I�,:�o�R��cHK

data/test/fixtures/testrepo.git/packed-refs

@@ -0,0 +1,2 @@
+# pack-refs with: peeled 
+41bc8c69075bbdb46c5c6f0566cc8cc5b46e8bd9 refs/heads/packed

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

@@ -0,0 +1 @@
+36060c58702ed4c2a40832c51758d5344201d89a

data/test/fixtures/testrepo.git/refs/tags/v0.9

@@ -0,0 +1 @@
+5b5b025afb0b4c913b4c338a42934a3863bf3644

data/test/fixtures/testrepo.git/refs/tags/v1.0

@@ -0,0 +1 @@
+0c37a5391bbff43c37f0d0371823a5509eed5b1d