adapter-git 0.5.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+examples/test/
+spec/test-repo/

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright © 2011 Brandon Keepers
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,31 @@
+= adapter-git
+
+Git adapter for adapter gem.
+
+    require 'adapter/git'
+
+    repo = Grit::Repo.init('path/to/repo')
+    adapter = Adapter[:git].new(repo, :branch => 'data', :path => 'db/records')
+    adapter.clear
+
+    adapter.write('foo', 'bar')
+    puts 'Should be bar: ' + adapter.read('foo').inspect
+
+    adapter.delete('foo')
+    puts 'Should be nil: ' + adapter.read('foo').inspect
+
+    adapter.write('foo', 'bar')
+    adapter.clear
+    puts 'Should be nil: ' + adapter.read('foo').inspect
+
+    puts 'Should be bar: ' + adapter.fetch('foo', 'bar')
+
+See examples/ or specs/ for more usage.
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so we don't break it in a future version unintentionally.
+* Commit, do not mess with Rakefile, version, or history. (if you want to have your own version, that is fine, but bump version in a commit by itself so we can ignore when we pull)
+* Send us a pull request. Bonus points for topic branches.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/adapter-git.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "adapter/git/version"
+
+Gem::Specification.new do |s|
+  s.name        = "adapter-git"
+  s.version     = Adapter::Git::VERSION
+  s.authors     = ["Brandon Keepers"]
+  s.email       = ["brandon@opensoul.org"]
+  s.homepage    = ""
+  s.summary     = %q{Adapter for git}
+  s.description = %q{Adapter for git}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'adapter', '~> 0.5.1'
+  s.add_dependency 'grit', '~> 2.0'
+  s.add_development_dependency 'rspec', '~> 2.0'
+  s.add_development_dependency 'rake'
+end

data/examples/git.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'pathname'
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'adapter/git'
+
+require 'grit'
+
+repo = Grit::Repo.init(File.expand_path('../test', __FILE__))
+adapter = Adapter[:git].new(repo)
+adapter.clear
+
+adapter.write('foo', 'bar')
+puts 'Should be bar: ' + adapter.read('foo').inspect
+
+adapter.delete('foo')
+puts 'Should be nil: ' + adapter.read('foo').inspect
+
+adapter.write('foo', 'bar')
+adapter.clear
+puts 'Should be nil: ' + adapter.read('foo').inspect
+
+puts 'Should be bar: ' + adapter.fetch('foo', 'bar')

data/lib/adapter-git.rb

@@ -0,0 +1 @@
+require "adapter/git"

data/lib/adapter/git.rb

@@ -0,0 +1,79 @@
+require 'adapter'
+require 'yaml'
+require 'grit'
+
+module Adapter
+  module Git
+    def branch
+      options[:branch] || 'master'
+    end
+
+    def head
+      client.get_head(branch)
+    end
+
+    def key?(key)
+      !(head && head.commit.tree / key_for(key)).nil?
+    end
+
+    def read(key)
+      if head && blob = head.commit.tree / key_for(key)
+        decode(blob.data)
+      end
+    end
+
+    def write(key, value)
+      commit("Updated #{key}") do |index|
+        index.add(key_for(key), encode(value))
+      end
+    end
+
+    def delete(key)
+      read(key).tap do
+        commit("Delete #{key}") {|index| index.delete(key_for(key)) }
+      end
+    end
+
+    def clear
+      commit("Cleared") do |index|
+        tree = index.current_tree
+        tree = tree / options[:path] if options[:path] && tree
+        if tree
+          tree.contents.each do |entry|
+            index.delete(key_for(entry.name))
+          end
+        end
+      end
+    end
+
+    def encode(value)
+      value.to_yaml
+    end
+
+    def decode(value)
+      YAML.load(value)
+    end
+
+    def key_for(key)
+      File.join(*[options[:path], super].compact)
+    end
+
+  private
+
+    def commit(message)
+      index = client.index
+
+      if head
+        commit = head.commit
+        index.current_tree = commit.tree
+      end
+
+      yield index
+
+      index.commit(message, :parents => Array(commit), :head => branch) unless index.tree.empty?
+    end
+
+  end
+end
+
+Adapter.define(:git, Adapter::Git)

data/lib/adapter/git/version.rb

@@ -0,0 +1,5 @@
+module Adapter
+  module Git
+    VERSION = "0.5.0"
+  end
+end

data/spec/git_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+require 'grit'
+
+describe "Git adapter" do
+  let(:repo_dir) { File.expand_path('../test-repo', __FILE__) }
+  let(:adapter)  { Adapter[:git].new(client, :branch => 'adapter-git') }
+  let(:client)   { Grit::Repo.init(repo_dir) }
+
+  before do
+    FileUtils.rm_rf(repo_dir)
+
+    # Some adapter specs don't pass if there is not at least one commit in the
+    # repo since the git adapter short-circuits the key marshalling if there
+    # are no commits.
+    adapter.set('specs', 'running')
+  end
+
+  it_should_behave_like 'an adapter'
+
+  it 'should create a branch when it does not exist' do
+    adapter.options[:branch] = 'foobar'
+    adapter.set('foo', 'bar')
+    client.get_head('foobar').should_not be_nil
+  end
+
+  it 'should not raise error on clear when branch does not exist' do
+    client.git.fs_delete("refs/heads/#{adapter.branch}")
+    lambda { adapter.clear }.should_not raise_error
+  end
+
+  it 'should successfully delete a key' do
+    adapter.set('foo', 'bar')
+    adapter.delete('foo')
+    adapter.get('foo').should be_nil
+  end
+
+  it 'should not generate a commit message if there are no changes' do
+    adapter.clear
+    head = adapter.head.commit
+    adapter.clear
+    adapter.head.commit.id.should == head.id
+  end
+
+  context 'with the path option' do
+    before do
+      adapter.options[:path] = 'db/things'
+    end
+
+    it_should_behave_like 'an adapter'
+
+    it 'should store keys in the directory' do
+      adapter.set('foo', 'bar')
+      (adapter.head.commit.tree / 'foo').should be_nil
+      (adapter.head.commit.tree / 'db/things/foo').should_not be_nil
+    end
+
+    it 'should not clear other keys' do
+      other_adapter = Adapter[:git].new(client, :branch => 'adapter-git')
+      other_adapter.set('foo', 'bar')
+
+      adapter.set('foo', 'baz')
+      adapter.clear
+
+      other_adapter.get('foo').should == 'bar'
+      adapter.get('foo').should be_nil
+    end
+
+    it 'should not raise error on clear when branch does not exist' do
+      client.git.fs_delete("refs/heads/#{adapter.branch}")
+      lambda { adapter.clear }.should_not raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+$:.unshift(File.expand_path('../../lib', __FILE__))
+
+require 'rubygems'
+require 'bundler'
+
+Bundler.require(:default, :development)
+
+require 'pathname'
+require 'logger'
+
+root_path = Pathname(__FILE__).dirname.join('..').expand_path
+lib_path  = root_path.join('lib')
+log_path  = root_path.join('log')
+log_path.mkpath
+
+require 'adapter/spec/an_adapter'
+require 'adapter/spec/json_adapter'
+require 'adapter/spec/types'
+
+require 'adapter-git'

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification 
+name: adapter-git
+version: !ruby/object:Gem::Version 
+  hash: 11
+  prerelease: 
+  segments: 
+  - 0
+  - 5
+  - 0
+  version: 0.5.0
+platform: ruby
+authors: 
+- Brandon Keepers
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-12 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: adapter
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 0
+        - 5
+        - 1
+        version: 0.5.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: grit
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Adapter for git
+email: 
+- brandon@opensoul.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- adapter-git.gemspec
+- examples/git.rb
+- lib/adapter-git.rb
+- lib/adapter/git.rb
+- lib/adapter/git/version.rb
+- spec/git_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.1
+signing_key: 
+specification_version: 3
+summary: Adapter for git
+test_files: 
+- spec/git_spec.rb
+- spec/spec_helper.rb