georgi-git_store 0.2.3 → 0.2.4

data/.gitignore

@@ -2,3 +2,4 @@
 doc/*
 pkg/*
 test/repo
+html/*

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rake'
+require "rake/rdoctask"
+
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install the rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['-cfs']
+  t.spec_files = FileList['test/**/*_spec.rb']
+end
+
+desc "Print SpecDocs"
+Spec::Rake::SpecTask.new(:doc) do |t|
+  t.spec_opts = ["--format", "specdoc"]
+  t.spec_files = FileList['test/*_spec.rb']
+end
+
+desc "Generate the RDoc"
+Rake::RDocTask.new do |rdoc|
+  files = ["README.md", "LICENSE", "lib/**/*.rb"]
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README.md"
+  rdoc.title = "Git Store - using Git as versioned data store in Ruby"
+end
+
+desc "Run the rspec"
+task :default => :spec

data/git_store.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'git_store'
-  s.version = '0.2.3'
+  s.version = '0.2.4'
   s.summary = 'a simple data store based on git'
   s.author = 'Matthias Georgi'
   s.email = 'matti.georgi@gmail.com'
@@ -12,6 +12,7 @@ Gem::Specification.new do |s|
   s.files = %w{
 .gitignore
 LICENSE
+Rakefile
 README.md
 git_store.gemspec
 lib/git_store.rb

data/lib/git_store.rb

@@ -45,10 +45,16 @@ class GitStore
     @root   = Tree.new(self)
     @packs  = {}
     
+    raise(ArgumentError, "first argument must be a valid Git repository") unless valid?
+
     load_packs("#{path}/.git/objects/pack")
     load
   end
 
+  def valid?
+    File.exists?("#{path}/.git")
+  end
+
   # The path to the current head file.
   def head_path
     "#{path}/.git/refs/heads/#{branch}"
@@ -284,6 +290,7 @@ class GitStore
     def initialize(path)
       @mtime = {}
       super
+    rescue ArgumentError
     end
 
     def load

data/test/git_store_spec.rb

@@ -1,10 +1,11 @@
-require 'git_store'
+require "#{File.dirname(__FILE__)}/../lib/git_store"
 
 describe GitStore do
 
-  REPO = File.expand_path(File.dirname(__FILE__) + '/repo')
+  #REPO = File.expand_path(File.dirname(__FILE__) + '/repo')
+  REPO = '/tmp/git_store_test'
 
-  before do
+  before(:each) do
     FileUtils.rm_rf REPO
     Dir.mkdir REPO
     Dir.chdir REPO
@@ -24,187 +25,186 @@ describe GitStore do
     end
   end
 
-  def self.it(text, &block)
-    super "#{text} with git" do
-      `git init`
-      @use_git = true
-      @store = GitStore.new(REPO)
-      instance_eval(&block)
-    end
-    
-    super "#{text} without git" do
-      @use_git = false
-      @store = GitStore::FileStore.new(REPO)
-      instance_eval(&block)
-    end
-  end
+  shared_examples_for 'all stores' do
+    it 'should find modified entries' do
+      store['a'] = 'Hello'
 
-  it 'should have a head commit' do
-    next unless @use_git
-    
-    file 'a', 'Hello'
+      store.root.should be_modified
+      store.root.table['a'].should be_modified
 
-    store.read_head.should_not be_nil
-    File.should be_exist(store.object_path(store.read_head))
-  end
+      store.commit
 
-  it 'should detect changes' do
-    next unless @use_git
+      store['a'] = 'Bello'
 
-    file 'a', 'Hello'
+      store.root.table['a'].should be_modified
+    end
 
-    store.should be_changed
-  end
+    it 'should load a repo' do
+      file 'a', 'Hello'
+      file 'b', 'World'
+   
+      store.load
 
-  it 'should find modified entries' do
-    store['a'] = 'Hello'
+      store['a'].should == 'Hello'
+      store['b'].should == 'World'
+    end
 
-    store.root.should be_modified
-    store.root.table['a'].should be_modified
+    it 'should load folders' do
+      file 'x/a', 'Hello'
+      file 'y/b', 'World'
+    
+      store.load
+      store['x'].should be_kind_of(GitStore::Tree)
+      store['y'].should be_kind_of(GitStore::Tree)
 
-    store.commit
+      store['x']['a'].should == 'Hello'
+      store['y']['b'].should == 'World'
+    end
 
-    store['a'] = 'Bello'
+    it 'should load yaml' do
+      file 'x/a.yml', '[1, 2, 3, 4]'
 
-    store.root.table['a'].should be_modified
-  end
+      store.load
+    
+      store['x']['a.yml'].should == [1,2,3,4]    
+      store['x']['a.yml'] = [1,2,3,4,5]
+    end
 
-  it 'should load a repo' do
-    file 'a', 'Hello'
-    file 'b', 'World'
-   
-    store.load
+    it 'should resolve paths' do
+      file 'x/a', 'Hello'
+      file 'y/b', 'World'
+    
+      store.load
+    
+      store['x/a'].should == 'Hello'
+      store['y/b'].should == 'World'
 
-    store['a'].should == 'Hello'
-    store['b'].should == 'World'
-  end
+      store['y/b'] = 'Now this'
 
-  it 'should rollback a transaction' do
-    next if not @use_git
-    
-    file 'a/b', 'Hello'
-    file 'c/d', 'World'
+      store['y']['b'].should == 'Now this'        
+    end
 
-    begin
-      store.transaction do
-        store['a/b'] = 'Changed'
-        store['x/a'] = 'Added'
-        raise
-      end
-    rescue
+    it 'should create new trees' do
+      store['new/tree'] = 'This tree'
+      store['this', 'tree'] = 'Another'    
+      store['new/tree'].should == 'This tree'
+      store['this/tree'].should == 'Another'
     end
 
-    store['a/b'].should == 'Hello'
-    store['c/d'].should == 'World'
-    store['x/a'].should be_nil
+    it 'should delete entries' do
+      store['a'] = 'Hello'
+      store.delete('a')
+    
+      store['a'].should be_nil
+    end
   end
 
-  it 'should commit a transaction' do
-    next if not @use_git
-    
-    file 'a/b', 'Hello'
-    file 'c/d', 'World'
+  describe 'with Git' do
+    before(:each) do
+      `git init`
+      @use_git = true
+      @store = GitStore.new(REPO)
+    end
 
-    store.transaction do
-      store['a/b'] = 'Changed'
-      store['x/a'] = 'Added'
+    it_should_behave_like 'all stores'
+
+    it 'should have a head commit' do
+      file 'a', 'Hello'
+
+      store.read_head.should_not be_nil
+      File.should be_exist(store.object_path(store.read_head))
     end
 
-    store.load
-    
-    store['a/b'].should == 'Changed'
-    store['c/d'].should == 'World'
-    store['x/a'].should == 'Added'
-  end
+    it 'should detect changes' do
+      file 'a', 'Hello'
 
-  it 'should allow only one transaction' do
-    next if not @use_git
-    
-    file 'a/b', 'Hello'
+      store.should be_changed
+    end
 
-    ready = false
+    it 'should rollback a transaction' do
+      file 'a/b', 'Hello'
+      file 'c/d', 'World'
 
-    store.transaction do
-      Thread.start do
+      begin
         store.transaction do
-          store['a/b'] = 'Changed by second thread'
+          store['a/b'] = 'Changed'
+          store['x/a'] = 'Added'
+          raise
         end
-        ready = true
+      rescue
       end
-      store['a/b'] = 'Changed'
-    end
-    
-    sleep 0.01 until ready
 
-    store.load
-    
-    store['a/b'].should == 'Changed by second thread'
-  end
+      store['a/b'].should == 'Hello'
+      store['c/d'].should == 'World'
+      store['x/a'].should be_nil
+    end
 
-  it 'should load folders' do
-    file 'x/a', 'Hello'
-    file 'y/b', 'World'
-    
-    store.load
-    store['x'].should be_kind_of(GitStore::Tree)
-    store['y'].should be_kind_of(GitStore::Tree)
+    it 'should commit a transaction' do
+      file 'a/b', 'Hello'
+      file 'c/d', 'World'
 
-    store['x']['a'].should == 'Hello'
-    store['y']['b'].should == 'World'
-  end
+      store.transaction do
+        store['a/b'] = 'Changed'
+        store['x/a'] = 'Added'
+      end
 
-  it 'should commit added files' do
-    next if not @use_git
+      store.load
     
-    store.load
-    store['c'] = 'Hello'
-    store['d'] = 'World'
-    store.commit
-
-    `git checkout`
-
-    File.should be_exist('c')
-    File.should be_exist('d')
+      store['a/b'].should == 'Changed'
+      store['c/d'].should == 'World'
+      store['x/a'].should == 'Added'
+    end
 
-    File.read('c').should == 'Hello'
-    File.read('d').should == 'World'
-  end
+    it 'should allow only one transaction' do
+      file 'a/b', 'Hello'
 
-  it 'should load yaml' do
-    file 'x/a.yml', '[1, 2, 3, 4]'
+      ready = false
 
-    store.load
+      store.transaction do
+        Thread.start do
+          store.transaction do
+            store['a/b'] = 'Changed by second thread'
+          end
+          ready = true
+        end
+        store['a/b'] = 'Changed'
+      end
     
-    store['x']['a.yml'].should == [1,2,3,4]    
-    store['x']['a.yml'] = [1,2,3,4,5]
-  end
+      sleep 0.01 until ready
 
-  it 'should resolv paths' do
-    file 'x/a', 'Hello'
-    file 'y/b', 'World'
+      store.load
     
-    store.load
-    
-    store['x/a'].should == 'Hello'
-    store['y/b'].should == 'World'
+      store['a/b'].should == 'Changed by second thread'
+    end
 
-    store['y/b'] = 'Now this'
+    it 'should commit added files' do
+      store.load
+      store['c'] = 'Hello'
+      store['d'] = 'World'
+      store.commit
 
-    store['y']['b'].should == 'Now this'        
-  end
+      `git checkout`
+
+      File.should be_exist('c')
+      File.should be_exist('d')
 
-  it 'should create new trees' do
-    store['new/tree'] = 'This tree'
-    store['this', 'tree'] = 'Another'    
-    store['new/tree'].should == 'This tree'
-    store['this/tree'].should == 'Another'
+      File.read('c').should == 'Hello'
+      File.read('d').should == 'World'
+    end
   end
 
-  it 'should delete entries' do
-    store['a'] = 'Hello'
-    store.delete('a')
-    
-    store['a'].should be_nil
+  describe 'without Git' do
+    before(:each) do
+      @use_git = false
+      @store = GitStore::FileStore.new(REPO)
+    end
+
+    it_should_behave_like 'all stores'
   end
 
+  it 'should fail to initialize without a valid git repository' do
+    lambda {
+      GitStore.new(REPO)
+    }.should raise_error(ArgumentError)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: georgi-git_store
 version: !ruby/object:Gem::Version 
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors: 
 - Matthias Georgi
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-25 00:00:00 -08:00
+date: 2009-04-08 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -24,6 +24,7 @@ extra_rdoc_files:
 files: 
 - .gitignore
 - LICENSE
+- Rakefile
 - README.md
 - git_store.gemspec
 - lib/git_store.rb