gash 0.1.1 → 0.1.2

data/CHANGELOG

@@ -1,3 +1,5 @@
+v0.1.2. Working correctly on empty branches.
+
 v0.1.1. Tree got more Hash-methods. Better documentation.
 
 v0.1. First version.

data/Rakefile

@@ -8,7 +8,6 @@ Echoe.new('gash') do |p|
   p.summary = "Git + Hash"
   p.url = "http://dojo.rubyforge.org/gash/"
   p.rdoc_options += ["--main", "Gash", "--title", "Gash"]
-  p.rubygems_version = nil
 end
 
 Rake::Task[:publish_docs].instance_eval do

data/gash.gemspec

@@ -1,18 +1,18 @@
 
-# Gem::Specification for Gash-0.1.1
+# Gem::Specification for Gash-0.1.2
 # Originally generated by Echoe
 
 --- !ruby/object:Gem::Specification 
 name: gash
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Magnus Holm
 autorequire: 
 bindir: bin
 
-date: 2008-09-27 00:00:00 +02:00
+date: 2008-09-28 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -68,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
+      version: "1.2"
   version: 
 requirements: []
 

data/lib/gash.rb

@@ -9,6 +9,9 @@ require 'delegate'
 # * Gash can commit.
 # * Gash will automatically create branches if they don't exists.
 # * Gash only loads what it needs, so it handles large repos well.
+# * Gash got {pretty good documentation}[http://dojo.rubyforge.org/gash].
+# * Gash got {a bug tracker}[http://dojo.lighthouseapp.com/projects/17529-gash].
+# * Gash is being {developed at GitHub}[http://github.com/judofyr/gash].
 #
 # Some of these "rules" might change it the future.
 #
@@ -22,6 +25,11 @@ require 'delegate'
 # also call those methods.
 #
 # <b>See also</b>: #new, #commit, Tree
+#
+# == Credits
+#
+# This code is based upon git-shelve[http://www.siebert-wd.de/projects/git-shelve],
+# and is released under the same license; LGPL.
 class Gash < SimpleDelegator
   module Errors
     # This error is raised when the Git-command fails.
@@ -59,14 +67,14 @@ class Gash < SimpleDelegator
     
     # Converts the +value+ to a Tree or a Blob, using some rules:
     # 
-    # == If +value+ is already a Tree or a Blob:
+    # ==== If +value+ is already a Tree or a Blob:
     # 
     # * If +value+ comes from another repo, we load it and return a deep copy.
     # * If +value+ got no parent, we simply return the same tree.
     # * If +value+'s parent is +self+, we also return the same tree.
     # * If +value+'s parent is something else, we return a duplicated tree.
     #
-    # == If it's something else:
+    # ==== If it's something else:
     #
     # * If +value+ is a Hash, we create a Tree from it.
     # * If it's not any of the former rules, we turn it into a string and create a Blob from it. 
@@ -92,6 +100,36 @@ class Gash < SimpleDelegator
   
   # A Tree is a Hash which can store other instances of Tree and Blob.
   #
+  # == Special methods
+  #
+  # Internally, a tree is being stored like this:
+  #
+  #   {
+  #     "README" => blob,
+  #     "examples" => {
+  #       "test.rb" => blob,
+  #       "yay.rb" => blob
+  #     }
+  #   }
+  #
+  # So you have to do <code>tree["examples"].delete("test.rb")</code> instead
+  # of <code>tree.delete("examples/test.rb")</code>. However, there are some
+  # methods which supports the slash. All of these will work:
+  #
+  #   tree["examples/test.rb"]
+  #   tree.fetch("examples/test.rb")
+  #   tree["examples/another.rb"] = "Content"
+  #   tree.store("examples/another.rb", "Content") # Exactly the same as above.
+  #   
+  #   tree["examples"]["test.rb"] # Or, you could use this
+  #
+  # == Documentation
+  #
+  # The point of Tree is that it should be as close to Hash as possible.
+  # Therefore, methods which behaves exactly equally in Gash and Hash will
+  # not be documentated below. Please see the Ruby documentation if you
+  # wonder what you can do.
+  #
   # <b>See also</b>: Helpers, Blob
   class Tree < Hash
     include Helpers
@@ -111,14 +149,7 @@ class Gash < SimpleDelegator
     #   # do some other stuff...
     #   blob.load! # Load it now!
     def [](key, lazy = nil)
-      ret = if key.include?("/")
-        key, rest = key.split("/", 2)
-        value = super(key)
-        return if value.nil?
-        value[rest]
-      else
-        super(key)
-      end
+      ret = fetch(key, default)
     ensure
       ret.load! if ret.respond_to?(:load!) && !lazy
     end
@@ -158,7 +189,7 @@ class Gash < SimpleDelegator
         keys = key.split("/")
         name = keys.pop
         keys.inject(self) do |memo, i|
-          memo[i] = Tree.new(:parent => self) unless memo.include?(i)
+          memo[i, not_changed] = Tree.new(:parent => self) unless memo.include?(i)
           memo[i, true]
         end[name, not_changed] = value
       else
@@ -169,7 +200,8 @@ class Gash < SimpleDelegator
     ensure
       self.changed! unless not_changed
     end
-    
+    alias store []=
+     
     # Converts the tree to a Hash.
     def to_hash
       inject({}) do |memo, (key, value)|
@@ -177,17 +209,54 @@ class Gash < SimpleDelegator
         memo
       end
     end
+
+    # :stopdoc:
+    def fetch(*args)
+      key = args.first.to_s
+      
+      case args.length
+      when 1
+        r = true
+      when 2
+        r = false
+        default = args.last
+      else
+        raise ArgumentError, "wrong number of arguments (#{args.length} for 2)"
+      end
+      
+      if key.include?("/")
+        key, rest = key.split("/", 2)
+        value = super(key)
+        value.fetch(rest)
+      else
+        super(key)
+      end
+    rescue IndexError => e
+      (r && raise(e)) || default
+    end
     
-    def self.[](*val) # :nodoc:
+    def delete(key)
+      super && changed!
+    end
+    
+    def self.[](*val)
       new.merge!(Hash[*val])
     end
+
+    def ==(other)
+      if other.is_a?(Tree) && sha1 && other.sha1
+        sha1 == other.sha1
+      else
+        super
+      end
+    end
     
-    def merge(hash) # :nodoc:
+    def merge(hash)
       tree = self.dup
       tree.merge!(hash)
     end
     
-    def merge!(hash) # :nodoc:
+    def merge!(hash)
       hash.each do |key, value|
         self[key] = value
       end
@@ -195,7 +264,7 @@ class Gash < SimpleDelegator
     end
     alias update merge!
     
-    def replace(hash) # :nodoc:
+    def replace(hash)
       if hash.is_a?(Gash::Tree)
         super
       else
@@ -203,6 +272,7 @@ class Gash < SimpleDelegator
         merge!(hash)
       end
     end
+# :startdoc:
   end
   
   # A Blob represent a string:
@@ -365,9 +435,7 @@ class Gash < SimpleDelegator
   end
   
   def git_tree(&blk)
-    git('ls-tree', '-r', '-t', @branch, '2>&1') do |f|
-      f.each_line(&blk)
-    end
+    git('ls-tree', '-r', '-t', @branch, '2>&1').each_line(&blk)
   rescue Errors::Git
     ""
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gash
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Magnus Holm
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-27 00:00:00 +02:00
+date: 2008-09-28 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -65,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
+      version: "1.2"
   version: 
 requirements: []