rugged 0.16.0 → 0.17.0b1

data/lib/rugged/reference.rb

@@ -0,0 +1,9 @@
+module Rugged
+  class Reference
+
+    def inspect
+      "#<Rugged::Reference:#{object_id} {name: #{name.inspect}, target: #{target.inspect}}>"
+    end
+
+  end
+end

data/lib/rugged/repository.rb

@@ -1,6 +1,30 @@
 module Rugged
-
+  # Repository is an interface into a Git repository on-disk. It's the primary
+  # interface between your app and the main Git objects Rugged makes available
+  # to you.
   class Repository
+    # Pretty formatting of a Repository.
+    #
+    # Returns a very pretty String.
+    def inspect
+      "#<Rugged::Repository:#{object_id} {path: #{path.inspect}}>"
+    end
+
+    # Get the most recent commit from this repo.
+    #
+    # Returns a Rugged::Commit object.
+    def last_commit
+      self.lookup self.head.target
+    end
+
+    # Walks over a set of commits using Rugged::Walker.
+    #
+    # from    - The String SHA1 to push onto Walker to begin our walk.
+    # sorting - The sorting order of the commits, as defined in the README.
+    # block   - A block that we pass into walker#each.
+    #
+    # Returns nothing if called with a block, otherwise returns an instance of
+    # Enumerable::Enumerator containing Rugged::Commit objects.
     def walk(from, sorting=Rugged::SORT_DATE, &block)
       walker = Rugged::Walker.new(self)
       walker.sorting(sorting)
@@ -8,22 +32,94 @@ module Rugged
       walker.each(&block)
     end
 
+    # Find the HEAD of this repository.
+    #
+    # Returns a Reference.
     def head
       ref = Reference.lookup(self, "HEAD")
       ref.resolve
     end
 
+    # Look up a SHA1.
+    #
+    # Returns one of the four classes that inherit from Rugged::Object.
     def lookup(oid)
       Rugged::Object.lookup(self, oid)
     end
 
-    def refs
+    # Look up a single reference by name.
+    #
+    # Example:
+    #
+    #   repo.ref 'refs/heads/master'
+    #   # => #<Rugged::Reference:2199125780 {name: "refs/heads/master",
+    #          target: "25b5d3b40c4eadda8098172b26c68cf151109799"}>
+    #
+    # Returns a Rugged::Reference.
+    def ref(ref_name)
+      Rugged::Reference.lookup(self, ref_name)
+    end
+
+    # Retuns all the References that match a pattern.
+    #
+    # refs - A Regexp (or String) to search for. Optional.
+    #
+    # Examples:
+    #
+    #   # All refs
+    #   repo.refs
+    #
+    #   # All remote refs
+    #   repo.refs 'refs/remotes'
+    #
+    # Returns an Array of References.
+    def refs(pattern = nil)
+      r = []
+      ref_names.each do |ref_name|
+        if pattern
+          p = Regexp.new(pattern)
+          r << Rugged::Reference.lookup(self, ref_name) if p.match(ref_name)
+        else
+          r << Rugged::Reference.lookup(self, ref_name)
+        end
+      end
+      r
+    end
+
+    # The names of all the refs.
+    #
+    # Returns an Enumerable::Enumerator containing all the String ref names.
+    def ref_names
       Rugged::Reference.each(self)
     end
 
+    # All of the tags in the repository.
+    #
+    # Returns an Enumerable::Enumerator containing all the String tag names.
     def tags(pattern="")
       Rugged::Tag.each(self, pattern)
     end
-  end
 
+    # All of the remotes in the repository.
+    #
+    # Returns an Enumerable::Enumerator containing all the String remote names.
+    def remotes
+      Rugged::Remote.each(self)
+    end
+
+    # Get the content of a file at a specific revision.
+    #
+    # revision - The String SHA1.
+    # path     - The String file path.
+    #
+    # Returns a String.
+    def file_at(revision, path)
+      tree = Rugged::Commit.lookup(self, revision).tree
+      subtree = tree.get_subtree(path)
+      blob_data = subtree.get_entry(File.basename path)
+      return nil unless blob_data
+      blob = Rugged::Blob.lookup(self, blob_data[:oid])
+      blob.content
+    end
+  end
 end

data/lib/rugged/tag.rb

@@ -0,0 +1,22 @@
+module Rugged
+  class Tag
+
+    def inspect
+      "#<Rugged::Reference:#{object_id} {name: #{name.inspect}, message: #{message.inspect}, target: #{target.inspect}>"
+    end
+
+    def to_hash
+      {
+        :message => message,
+        :name => name,
+        :target => target,
+        :tagger => tagger,
+      }
+    end
+
+    def modify(new_args, force=True)
+      args = self.to_hash.merge(new_args)
+      Tag.create(args, force)
+    end
+  end
+end

data/lib/rugged/tree.rb

@@ -1,5 +1,13 @@
 module Rugged
   class Tree
+    include Enumerable
+
+    def inspect
+      data = "#<Rugged::Tree:#{object_id} {oid: #{oid}}>\n"
+      self.each { |e| data << "  <\"#{e[:name]}\" #{e[:oid]}>\n" }
+      data
+    end
+
     # Walks the tree but only yields blobs
     def walk_blobs(mode=:postorder)
       self.walk(mode) { |root, e| yield root, e if e[:type] == :blob }

data/lib/rugged/version.rb

@@ -1,3 +1,3 @@
 module Rugged
-  Version = VERSION = '0.16.0'
+  Version = VERSION = '0.17.0b1'
 end

data/lib/rugged.rb

@@ -1,7 +1,10 @@
 require 'rugged/rugged'
 require 'rugged/index'
-require 'rugged/objects'
+require 'rugged/object'
+require 'rugged/commit'
 require 'rugged/version'
 require 'rugged/repository'
+require 'rugged/reference'
 require 'rugged/walker'
 require 'rugged/tree'
+require 'rugged/tag'

data/test/blob_test.rb

@@ -11,12 +11,12 @@ context "Rugged::Blob tests" do
     blob = @repo.lookup(@oid)
     assert_equal 9, blob.size
     assert_equal "new file\n", blob.content
-    assert_equal "blob", blob.type
+    assert_equal :blob, blob.type
     assert_equal @oid, blob.oid
   end
 
   test "can write new blob data" do
-    oid = Rugged::Blob.create(@repo, "a new blob content", true)
+    oid = Rugged::Blob.create(@repo, "a new blob content")
     rm_loose(oid)
   end
 

data/test/commit_test.rb

@@ -11,9 +11,10 @@ context "Rugged::Commit tests" do
     obj = @repo.lookup(oid)
 
     assert_equal obj.oid, oid
-    assert_equal obj.type, "commit"
+    assert_equal obj.type, :commit
     assert_equal obj.message, "testing\n"
     assert_equal obj.time.to_i, 1273360386
+    assert_equal obj.epoch_time, 1273360386
 
     c = obj.committer
     assert_equal c[:name], "Scott Chacon"
@@ -28,7 +29,7 @@ context "Rugged::Commit tests" do
     assert_equal obj.tree.oid, "181037049a54a1eb5fab404658a3a250b44335d7"
     assert_equal [], obj.parents
   end
-  
+
   test "can have multiple parents" do
     oid = "a4a7dce85cf63874e984719f4fdd239f5145052f"
     obj = @repo.lookup(oid)
@@ -37,19 +38,32 @@ context "Rugged::Commit tests" do
     assert parents.include?("c47800c7266a2be04c571c04d5a6614691ea99bd")
   end
 
-  xtest "can write new commit data" do
-    toid = "c4dc1555e4d4fa0e0c9c3fc46734c7c35b3ce90b"
-    tree = @repo.lookup(toid)
+  test "can list parent oids only" do
+    oid = "a4a7dce85cf63874e984719f4fdd239f5145052f"
+    obj = @repo.lookup(oid)
+    parents = obj.parent_oids
+    assert parents.include?("9fd738e8f7967c078dceed8190330fc8648ee56a")
+    assert parents.include?("c47800c7266a2be04c571c04d5a6614691ea99bd")
+  end
+
+  test "can read a tree oid only" do
+    oid = "8496071c1b46c854b31185ea97743be6a8774479"
+    obj = @repo.lookup(oid)
+
+    assert_equal obj.tree_oid, "181037049a54a1eb5fab404658a3a250b44335d7"
+  end
+
+  test "can write new commit data" do
+    person = {:name => 'Scott', :email => 'schacon@gmail.com', :time => Time.now }
 
-    obj = Rugged::Commit.new(@repo)
-    person = Rugged::Signature.new('Scott', 'schacon@gmail.com', Time.now)
+    commit_oid = Rugged::Commit.create(@repo,
+      :message => "This is the commit message\n\nThis commit is created from Rugged",
+      :committer => person,
+      :author => person,
+      :parents => [@repo.head.target],
+      :tree => "c4dc1555e4d4fa0e0c9c3fc46734c7c35b3ce90b")
 
-    obj.message = 'new message'
-    obj.author = person
-    obj.committer = person
-    obj.tree = tree
-    obj.write
-    rm_loose(obj.oid)
+    rm_loose(commit_oid)
   end
 
 end

data/test/config_test.rb

@@ -0,0 +1,44 @@
+require File.expand_path "../test_helper", __FILE__
+
+context "Rugged::Config tests" do
+  setup do
+    @repo = Rugged::Repository.new(test_repo('testrepo.git'))
+  end
+
+  test "can read the config file from repo" do
+    config = @repo.config
+    assert_equal 'false', config['core.bare']
+    assert_nil config['not.exist']
+  end
+
+  test "can read the config file from path" do
+    config = Rugged::Config.new(File.join(@repo.path, 'config'))
+    assert_equal 'false', config['core.bare']
+  end
+
+  test "can read the global config file" do
+    config = Rugged::Config.open_global
+    assert_not_nil config['user.name']
+    assert_nil config['core.bare']
+  end
+
+  test "can write config values" do
+    config = @repo.config
+    config['custom.value'] = 'my value'
+
+    config2 = @repo.config
+    assert_equal 'my value', config2['custom.value']
+
+    content = File.read(File.join(@repo.path, 'config'))
+    assert_match /value = my value/, content
+  end
+
+  test "can delete config values" do
+    config = @repo.config
+    config.delete('core.bare')
+
+    config2 = @repo.config
+    assert_nil config2.get('core.bare')
+  end
+
+end