gaga 0.0.1 → 0.0.2

data/README.md

@@ -1,43 +1,84 @@
 Gaga
 ==========
 
-Git as a key-value store! Build with [Grit](https://github.com/mojombo/grit), it supports SET, GET, KEYS, and DELETE operations. In addition, we can also get the change history key/values.
+Gaga is a Git-backed key/value store written in Ruby. Built with
+[Grit](https://github.com/mojombo/grit), it supports SET, GET, KEYS, and DELETE
+operations. And since it's Git, we can easily enhance it to include other
+awesome Git features such as branches, diffs, reverting, and more!
 
-It can easily be enhanced to include other git features such as branches, diffs, etc
 
-Example:
+Usage
+----------
 
 ```ruby
 
-@gaga = Gaga.new(:path => File.expand_path('..', __FILE__))
-@gaga.clear
+@gaga = Gaga.new(:repo => File.expand_path('..', __FILE__))
 
 # SET
-
 @gaga['lady'] = "gaga"
 
 # GET
-
 @gaga['lady'] #=> "gaga"
 
 # KEYS
-
 @gaga.keys  #=> ['lady']
 
 # DELETE
-
 @gaga.delete('lady') #=> 'gaga'
 
-# LOG
+# Remove all items from the store
+@gaga.clear
+
+```
+
+### Branches
+
+You can always store key/values in separate branches.  Just specify the `branch`
+option parameter:
+
+```ruby
+@gaga = Gaga.new(:repo => path_to_repo, :branch => 'config')
+```
+
+Though not recommended, Gaga can store the identical key in different branches.
 
+### Logs
+
+Gaga keeps a history of key/value saves.
+
+```ruby
 @gaga.log('key')
+```
 
-# Produces:
+Returns an array of commit messages along with meta data about each key/value save.
 
+```ruby
 [
  {"message"=>"all clear","committer"=>{"name"=>"Matt Sears", "email"=>"matt@mattsears.com"}, "committed_date"=>"2011-09-05..."},
  {"message"=>"set 'lady' ", "committer"=>{"name"=>"Matt Sears", "email"=>"matt@mattsears.com"}, "committed_date"=>"2011-09-05..."}
  {"message"=>"delete 'lady' ", "committer"=>{"name"=>"Matt Sears", "email"=>"matt@mattsears.com"}, "committed_date"=>"2011-09-05..."}
 ]
+```
+
+Installing Gaga
+----------
 
 ```
+$ gem install gaga
+```
+
+Contributing
+----------
+
+Once you've made your great commits:
+
+1. Fork Gaga
+2. Create a topic branch - git checkout -b my_branch
+3. Push to your branch - git push origin my_branch
+4. Create a Pull Request from your branch
+5. That's it!
+
+Author
+----------
+[Matt Sears](https://wwww.mattsears.com) :: @mattsears
+

data/gaga.gemspec

@@ -7,9 +7,9 @@ Gem::Specification.new do |s|
   s.version     = Gaga::VERSION
   s.authors     = ["Matt Sears"]
   s.email       = ["matt@mattsears.com"]
-  s.homepage    = "http://github.com/mattsears/gaga"
-  s.summary     = %q{Git as a key value store}
-  s.description = %q{Git as a key value store}
+  s.homepage    = "http://mtts.rs/gaga"
+  s.summary     = %q{Gaga is a Git-backed key/value store}
+  s.description = %q{Gaga is a Git-backed key/value store}
   s.rubyforge_project = "gaga"
 
   s.files         = `git ls-files`.split("\n")

data/lib/gaga.rb

@@ -121,7 +121,7 @@ class Gaga
 
   # The git branch to use for this store
   def branch
-    @options[:branch] || 'master'
+    @options[:branch].to_s || 'master'
   end
 
   # Checks out the branch on the repo

data/lib/gaga/version.rb

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

data/test/gaga_test.rb

@@ -9,8 +9,12 @@ describe Gaga do
   }
 
   before do
-    @store = Gaga.new(:repo => tmp_dir)
-    @store.clear
+    @store  = Gaga.new(:repo => tmp_dir, :branch => :lady)
+    @master = Gaga.new(:repo => tmp_dir)
+  end
+
+  after do
+    remove_tmpdir!
   end
 
   @types.each do |type, (key, key2)|
@@ -24,6 +28,12 @@ describe Gaga do
       @store[key].must_be_nil
     end
 
+    it 'guarantess the key is stored in the right branch' do
+      @store[key] = 'value'
+      @master[key].must_be_nil
+      @store[key].must_equal "value"
+    end
+
     it "returns a list of keys" do
       @store[key] = "value"
       @store.keys.must_include(key)
@@ -85,9 +95,11 @@ describe Gaga do
       @store[key].must_equal "value"
     end
 
-    it "returns a list of commit history for the key" do
-      @store.log(key).wont_be_empty
+    it 'stores a log message for the key' do
+      @store[key] = "value"
+      @store.log(key).first['message'].must_equal("set '#{key}'")
     end
+
   end
 
 end

metadata

@@ -1,38 +1,34 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: gaga
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.0.2
   prerelease: 
-  version: 0.0.1
 platform: ruby
-authors: 
+authors:
 - Matt Sears
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-10-23 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: grit
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70351841569680 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-description: Git as a key value store
-email: 
+  prerelease: false
+  version_requirements: *70351841569680
+description: Gaga is a Git-backed key/value store
+email:
 - matt@mattsears.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - README.md
@@ -42,33 +38,30 @@ files:
 - lib/gaga/version.rb
 - test/gaga_test.rb
 - test/helper.rb
-homepage: http://github.com/mattsears/gaga
+homepage: http://mtts.rs/gaga
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: gaga
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Git as a key value store
-test_files: 
+summary: Gaga is a Git-backed key/value store
+test_files:
 - test/gaga_test.rb
 - test/helper.rb