gaga 0.0.2 → 0.0.3

data/README.md

@@ -60,6 +60,46 @@ Returns an array of commit messages along with meta data about each key/value sa
 ]
 ```
 
+### Options
+
+Custom commit options can be set globally when creating a new Gaga instance, or
+passed in with calls to #set, #delete, or #clear.
+
+Examples:
+
+```ruby
+# Global options
+store1 = Gaga.new(
+	:repo => '/path/to/repo/',
+	:branch => :example,
+	:author => {
+		:name => 'Jim Bob',
+		:email => 'jbob@example.com'
+	},
+	:committer => {
+		:name => 'Jane Doe',
+		:email => 'jdoe@example.com'
+	}
+)
+
+# Custom message when storing a key/value
+store1.set('key_1', 'Hello World', {:message => 'This is a custom commit log message'})
+
+store2 = Gaga.new(:repo => '/path/to/repo/', :branch => :example)
+
+# Assigns an author when storing a key/value
+store2.set('key_1', 'Goodbye', {
+	:message => 'Another custom log message',
+	:author => {
+		:name => 'Sally',
+		:email => 'sally@example.com'
+	}
+})
+
+# Delete operations can also have a custom message
+store2.delete('key_1', {:message => 'Farewell message'})
+```
+
 Installing Gaga
 ----------
 

data/lib/gaga.rb

@@ -5,9 +5,14 @@ require 'gaga/version'
 class Gaga
 
   def initialize(options = {})
+    @author = options.delete(:author)
+    @committer = options.delete(:committer)
     @options = options
-    unless ::File.exists?(File.join(path,'.git'))
-      Grit::Repo.init(path)
+    
+    if path.end_with?('.git/')
+      Grit::Repo.init_bare(path) unless File.exists?(File.join(path,'refs'))
+    else
+      Grit::Repo.init(path) unless File.exists?(File.join(path,'.git'))
     end
   end
 
@@ -17,9 +22,11 @@ class Gaga
   #   @store.set('key', 'value')
   #
   # Returns nothing
-  def set(key, value)
-    save("set '#{key}'") do |index|
-      index.add(key_for(key), encode(value))
+  def set(key, value, opts = {})
+    unless value == get(key)
+      save(setup_commit_options({:message => "set '#{key}'"}.merge(opts))) do |index|
+        index.add(key_for(key), encode(value))
+      end
     end
   end
 
@@ -68,17 +75,18 @@ class Gaga
   #  @store.delete('key')
   #
   # Returns nothing
-  def delete(key, *)
+  def delete(key, opts = {})
+    options = setup_commit_options({:message => "deleted #{key}"}.merge(opts))
     self[key].tap do
-      save("deleted #{key}") {|index| index.delete(key_for(key)) }
+      save(options) {|index| index.delete(key_for(key)) }
     end
   end
 
   # Deletes all contents of the store
   #
   # Returns nothing
-  def clear
-    save("all clear") do |index|
+  def clear(opts = {})    
+    save(setup_commit_options({:message => "all clear"}.merge(opts))) do |index|
       if tree = index.current_tree
         tree.contents.each do |entry|
           index.delete(key_for(entry.name))
@@ -108,6 +116,13 @@ class Gaga
   end
 
   private
+  
+  def setup_commit_options(opts = {})
+    {
+      :author => @author,
+      :committer => @committer
+    }.merge(opts)
+  end
 
   # Format the given key so that it ensures it's git worthy
   def key_for(key)
@@ -121,7 +136,7 @@ class Gaga
 
   # The git branch to use for this store
   def branch
-    @options[:branch].to_s || 'master'
+    (@options[:branch] || 'master').to_s
   end
 
   # Checks out the branch on the repo
@@ -130,14 +145,17 @@ class Gaga
   end
 
   # Commits the the value into the git repository with the given commit message
-  def save(message)
+  def save(options)
+    author = options[:author] ? Grit::Actor.new(options[:author][:name], options[:author][:email]) : nil
+    committer = options[:committer] ? Grit::Actor.new(options[:committer][:name], options[:committer][:email]) : nil
+    
     index = git.index
     if head
       commit = head.commit
       index.current_tree = commit.tree
     end
     yield index
-    index.commit(message, :parents => Array(commit), :head => branch) if index.tree.any?
+    index.commit(options[:message], :parents => Array(commit), :author => author, :committer => committer, :head => branch) if index.tree.any?
   end
 
   # Converts the value to yaml format

data/lib/gaga/version.rb

@@ -1,3 +1,3 @@
 class Gaga
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/gaga_test.rb

@@ -23,10 +23,59 @@ describe Gaga do
       @store[key] = "value"
       @store[key].must_equal "value"
     end
+    
+    it "writes String values to keys with explicit custom log data" do
+      @store.set(key, "value", {:message => "Custom message", :author => {:name => 'Test', :email => 'test@example.com'} })
+      @store[key].must_equal "value"
+      
+      entry = @store.log(key).first
+      entry['message'].must_equal "Custom message"
+      entry['author'].must_equal({'name' => 'Test', 'email' => 'test@example.com'})
+    end
+    
+    it "writes String values to keys with global custom log data" do
+      store = Gaga.new(
+        :repo => tmp_dir, 
+        :branch => :lady, 
+        :author => {:name => 'Test', :email => 'test@example.com'},
+        :committer => {:name => 'Test2', :email => 'test2@example.com'}
+      )
+      
+      store.set(key, "value", {:message => "Custom message"})
+      store[key].must_equal "value"
+      
+      entry = store.log(key).first
+      entry['message'].must_equal "Custom message"
+      entry['author'].must_equal({'name' => 'Test', 'email' => 'test@example.com'})
+      entry['committer'].must_equal({'name' => 'Test2', 'email' => 'test2@example.com'})
+    end
+    
+    it "does not create empty commit" do
+      grit = Grit::Repo.new(tmp_dir)      
+      initial_count = grit.commit_count
+      
+      @master.set(key, "value", {:message => 'First commit'})
+      @master.set(key, "value", {:message => 'Second commit'})
+      
+      current_count = grit.commit_count
+      
+      (current_count - initial_count).must_equal 1
+      @master[key].must_equal "value"
+    end
 
     it "reads from keys" do
       @store[key].must_be_nil
     end
+    
+    it "should default to master when no branch is specified" do
+      value = 'testing'
+      @master[key] = value
+      @master[key].must_equal value
+      @store[key].must_be_nil
+      
+      tmp = Gaga.new(:repo => tmp_dir, :branch => :master)
+      tmp[key].must_equal value
+    end
 
     it 'guarantess the key is stored in the right branch' do
       @store[key] = 'value'
@@ -70,6 +119,15 @@ describe Gaga do
       @store.delete(key).must_equal "value"
       @store.key?(key).must_equal false
     end
+    
+    it "removes a key using a custom commit message" do
+      @store[key] = "value"
+      @store.delete(key, {:message => "Removed it"}).must_equal "value"
+      @store.key?(key).must_equal false
+      
+      entry = @store.log(key).first
+      entry['message'].must_equal "Removed it"
+    end
 
     it "returns nil from delete if an element for a key does not exist" do
       @store.delete(key).must_be_nil
@@ -82,6 +140,19 @@ describe Gaga do
       @store.key?(key).wont_equal true
       @store.key?(key2).wont_equal true
     end
+    
+    it "removes all keys from the store with clear and custom commit message" do
+      @store[key] = "value"
+      @store[key2] = "value2"
+      @store.clear({:message => "All gone"})
+      @store.key?(key).wont_equal true
+      @store.key?(key2).wont_equal true
+      
+      [key, key2].each do |k|
+        entry = @store.log(k).first
+        entry['message'].must_equal "All gone"
+      end
+    end
 
     it "does not run the block if the #{type} key is available" do
       @store[key] = "value"
@@ -99,7 +170,24 @@ describe Gaga do
       @store[key] = "value"
       @store.log(key).first['message'].must_equal("set '#{key}'")
     end
-
+  end
+  
+  it 'creates a bare repository' do
+    bare = Gaga.new(:repo => tmp_bare, :branch => :lady)
+    File.exists?(File.join(tmp_bare, '.git')).must_equal false
+    File.exists?(File.join(tmp_bare, 'refs')).must_equal true
+    bare['key1'] = 'Value 1'
+    bare['key2'] = 'Value 2'
+    bare['key3'] = 'Value 3'
+    bare['key1'].must_equal 'Value 1'
+    bare['key2'].must_equal 'Value 2'
+    bare.keys.must_equal %w(key1 key2 key3)
+    bare.delete('key1')
+    bare['key1'].must_be_nil
+    bare.clear
+    bare.keys.must_equal []
+    
+    remove_tmpdir!(tmp_bare)
   end
 
 end

data/test/helper.rb

@@ -10,11 +10,16 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'gaga'
 
 TMP_DIR = '/tmp/gaga_test'
+TMP_BARE = '/tmp/gaga_test_bare.git'
 
 def tmp_dir
   TMP_DIR
 end
 
+def tmp_bare
+  TMP_BARE
+end
+
 def remove_tmpdir!(passed_dir = nil)
   FileUtils.rm_rf(passed_dir || tmp_dir)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gaga
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-23 00:00:00.000000000 Z
+date: 2011-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grit
-  requirement: &70351841569680 !ruby/object:Gem::Requirement
+  requirement: &70238515496040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70351841569680
+  version_requirements: *70238515496040
 description: Gaga is a Git-backed key/value store
 email:
 - matt@mattsears.com