gash 0.1 → 0.1.1

data/CHANGELOG

@@ -1 +1,3 @@
+v0.1.1. Tree got more Hash-methods. Better documentation.
+
 v0.1. First version.

data/Rakefile

@@ -8,6 +8,7 @@ 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
+# Gem::Specification for Gash-0.1.1
 # Originally generated by Echoe
 
 --- !ruby/object:Gem::Specification 
 name: gash
 version: !ruby/object:Gem::Version 
-  version: "0.1"
+  version: 0.1.1
 platform: ruby
 authors: 
 - Magnus Holm
 autorequire: 
 bindir: bin
 
-date: 2008-09-04 00:00:00 +02:00
+date: 2008-09-27 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -66,14 +66,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - "="
+  - - ">="
     - !ruby/object:Gem::Version 
-      version: "1.2"
+      version: "0"
   version: 
 requirements: []
 
 rubyforge_project: dojo
-rubygems_version: 1.2.0
+rubygems_version: 1.3.0
 specification_version: 2
 summary: Git + Hash
 test_files: []

data/lib/gash.rb

@@ -3,13 +3,15 @@ require 'delegate'
 # == What is Gash?
 #
 # * Gash lets you access a Git-repo as a Hash.
+# * Gash doesn't touch your working directory
 # * Gash only cares about the data, not the commits.
 # * Gash only cares about the _latest_ data.
 # * Gash can commit.
-# * Gash doesn't touch your working directory
 # * Gash will automatically create branches if they don't exists.
 # * Gash only loads what it needs, so it handles large repos well.
 #
+# Some of these "rules" might change it the future.
+#
 # == How do you use it?
 #
 #   gash = Gash.new
@@ -19,16 +21,12 @@ require 'delegate'
 # It's also important to remember that a Gash is simply a Tree, so you can
 # also call those methods.
 #
-# <strong>See also</strong>: #new, #commit, Tree
-#
-# == Limitation
-#
-# The only Hash-like features which currently works is #[] and #[]=,
-# so don't try #merge or something like that.
+# <b>See also</b>: #new, #commit, Tree
 class Gash < SimpleDelegator
   module Errors
     # This error is raised when the Git-command fails.
     class Git < StandardError; end
+    class NoGitRepo < StandardError; end
   end
   
   # Some common methods used by both Tree and Blob.
@@ -55,28 +53,63 @@ class Gash < SimpleDelegator
     # Checks if this object has been changed (since last commit).
     def changed?; !@sha1 end
     # Mark this, and all parents as changed.
-    def changed!; @sha1 = nil;parent.changed! end
+    def changed!; @sha1 = nil;parent.changed! if parent end
     # Returns the Gash-object (top-parent).
-    def gash; parent.gash end
+    def gash; parent.gash if parent end
+    
+    # Converts the +value+ to a Tree or a Blob, using some rules:
+    # 
+    # == 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 +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. 
+    def normalize(value)
+      case value
+      when Tree, Blob, Gash
+        if value.parent && value.parent != self
+          if (g = value.gash) && self.gash == g
+            value.dup
+          else
+            normalize(value.tree? ? value.to_hash : value.to_s)
+          end
+        else
+          value
+        end
+      when Hash
+        Tree[value]
+      else
+        Blob.new(:content => value.to_s)
+      end
+    end
   end
   
   # A Tree is a Hash which can store other instances of Tree and Blob.
   #
-  # <strong>See also</strong>: Helpers, Blob
+  # <b>See also</b>: Helpers, Blob
   class Tree < Hash
     include Helpers
     
     # Retrieves the _value_ stored as +key+:
     #
-    #   tree["FILE"] == the file
-    #   tree["DIR/FILE"] == tree["DIR"]["FILE"] = another file
+    #   tree["FILE"] == File.read("FILE")
+    #   tree["DIR/FILE"] == tree["DIR"]["FILE"] == File.read("DIR/FILE")
+    #
+    # ==== Lazy loading
     #
-    # It will automatically call the +load!+-method in order to load
-    # it from the repo. Set +lazy+ to +true+ if this is not what you want:
+    # By default, this method will automatically load the blob/tree from
+    # the repo. If you rather want to load it later, simply set +lazy+ to
+    # +true+:
     #
-    #   blob = tree["FILE", true] == #<Blob:1234...>
+    #   blob = tree["FILE", true]
     #   # do some other stuff...
-    #   blob.laod! # Load it now!
+    #   blob.load! # Load it now!
     def [](key, lazy = nil)
       ret = if key.include?("/")
         key, rest = key.split("/", 2)
@@ -91,23 +124,27 @@ class Gash < SimpleDelegator
     end
     alias / []
     
-    # Stores the given _value_:
+    # Stores the given _value_ at +key+:
     #
     #   tree["FILE"] = "Content"
     #
-    # Unless it's already a Tree or a Blob, it will be converted to a Blob,
-    # and the parent will _always_ be set to +self+.
+    # It uses Helpers#normalize in order convert it to a blob/tree, and will
+    # always set the parent to itself:
     #
     #   tree["FILE"] = "Content"
     #     # is the same as:
     #   tree["FILE"] = Gash::Blob.new(:content => "Content", :parent => tree)
     #
-    # It will also mark the object as changed (using <code>Helpers#changed!</code>).
-    # Set +not_changed+ to +true+ if this is not what you want.
-    # 
-    # (If you give it three arguments, then the second one will act as
-    # +not_changed+, not the third):
+    # ==== Mark as changed
+    #
+    # By default, the object will be marked as changed (using
+    # <code>Helpers#changed!</code>). If this is not what you want, simply set
+    # +not_changed+ to +true+.
+    #
+    # However, if you give it three arguments, then the second one will act as
+    # +not_changed+, not the third:
     #
+    #          1       2        3
     #   tree["FILE", true] = "Test"
     #   tree["FILE"].changed? # => false
     def []=(key, value, not_changed = nil)
@@ -125,18 +162,47 @@ class Gash < SimpleDelegator
           memo[i, true]
         end[name, not_changed] = value
       else
-        value = case value
-        when Tree, Blob
-          value
-        else
-          Blob.new(:content => value.to_s)
-        end
+        value = normalize(value)
         value.parent = self
         super(key, value)
       end
     ensure
       self.changed! unless not_changed
     end
+    
+    # Converts the tree to a Hash.
+    def to_hash
+      inject({}) do |memo, (key, value)|
+        memo[key] = value.respond_to?(:to_hash) ? value.to_hash : value.to_s
+        memo
+      end
+    end
+    
+    def self.[](*val) # :nodoc:
+      new.merge!(Hash[*val])
+    end
+    
+    def merge(hash) # :nodoc:
+      tree = self.dup
+      tree.merge!(hash)
+    end
+    
+    def merge!(hash) # :nodoc:
+      hash.each do |key, value|
+        self[key] = value
+      end
+      self
+    end
+    alias update merge!
+    
+    def replace(hash) # :nodoc:
+      if hash.is_a?(Gash::Tree)
+        super
+      else
+        clear
+        merge!(hash)
+      end
+    end
   end
   
   # A Blob represent a string:
@@ -160,9 +226,9 @@ class Gash < SimpleDelegator
   #
   #   tree["FILE"] = Gash::Blob.new(:sha1 => a_sha1)
   #
-  # <strong>See also</strong>: Helpers, Tree
+  # <b>See also</b>: Helpers, Tree
   class Blob < Delegator
-    include Helpers
+    include Helpers, Comparable
     attr_accessor :content
     
     # Loads the file from Git, unless it's already been loaded.
@@ -174,6 +240,14 @@ class Gash < SimpleDelegator
       @content ? @content.inspect : (@sha1 ? "#<Blob:#{@sha1}>" : to_s.inspect) 
     end
     
+    def <=>(other) #:nodoc:
+      if other.is_a?(Blob) && sha1 && other.sha1
+        sha1 <=> other.sha1
+      else
+        __getobj__ <=> other
+      end
+    end
+    
     def __getobj__ #:nodoc:
       @content ||= @sha1 ? load! : ''
     end
@@ -184,9 +258,9 @@ class Gash < SimpleDelegator
   
   # Opens the +repo+ with the specified +branch+.
   #
-  # <strong>Please note:</strong> The +repo+ must link to the actual repo,
+  # <b>Please note:</b> The +repo+ must link to the actual repo,
   # not the working directory!
-  def initialize(branch = "master", repo = ".git")
+  def initialize(repo = ".git", branch = "master")
     @branch = branch
     @repository = File.expand_path(repo)
     __setobj__(Tree.new(:parent => self))
@@ -330,7 +404,11 @@ class Gash < SimpleDelegator
     result, status = run_git(cmd, *rest, &block)
 
     if status != 0
-      raise Errors::Git.new("Error: #{cmd} returned #{status}. Result: #{result}")
+      if result =~ /Not a git repository/
+        raise Errors::NoGitRepo.new("No Git repository at: " + @repository)
+      else
+        raise Errors::Git.new("Error: #{cmd} returned #{status}. Result: #{result}")
+      end
     end
     result
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gash
 version: !ruby/object:Gem::Version 
-  version: "0.1"
+  version: 0.1.1
 platform: ruby
 authors: 
 - Magnus Holm
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-04 00:00:00 +02:00
+date: 2008-09-27 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -63,14 +63,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - "="
+  - - ">="
     - !ruby/object:Gem::Version 
-      version: "1.2"
+      version: "0"
   version: 
 requirements: []
 
 rubyforge_project: dojo
-rubygems_version: 1.2.0
+rubygems_version: 1.3.0
 signing_key: 
 specification_version: 2
 summary: Git + Hash