jugyo-kvs 0.2.0

data/ChangeLog

@@ -0,0 +1,3 @@
+== 0.1.0 2009-09-15
+
+* first release!

data/README.markdown

@@ -0,0 +1,53 @@
+KVS
+========
+
+[http://github.com/jugyo/kvs](http://github.com/jugyo/kvs)
+
+Description
+--------
+
+KVS is a simple key value store.
+
+Install
+--------
+
+    sudo gem install jugyo-kvs --source http://gems.github.com
+
+Usage
+--------
+
+    KVS.dir = '/tmp/kvs'
+
+    KVS['foo'] = 'bar'
+    puts KVS['foo'] #=> bar
+
+    key = KVS << 'jugyo'
+    puts KVS[key] #=> jugyo
+
+    KVS.delete('foo')
+
+License
+--------
+
+(The MIT License)
+
+Copyright (c) 2008-2009 jugyo
+
+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/Rakefile

@@ -0,0 +1,56 @@
+$:.unshift File.dirname(__FILE__) + '/lib'
+require 'rubygems'
+require 'kvs'
+require 'spec/rake/spectask'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+
+name = 'kvs'
+version = KVS::VERSION
+
+spec = Gem::Specification.new do |s|
+  s.name = name
+  s.version = version
+  s.summary = "simple key value store."
+  s.description = "KVS is a simple key value store."
+  s.files = %w(Rakefile README.markdown ChangeLog) + Dir.glob("{lib,spec}/**/*.rb")
+  s.authors = %w(jugyo)
+  s.email = 'jugyo.org@gmail.com'
+  s.homepage = 'http://github.com/jugyo/kvs'
+  s.rubyforge_project = 'kvs'
+  s.has_rdoc = false
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.need_tar = true
+end
+
+task :gemspec do
+  filename = "#{name}.gemspec"
+  open(filename, 'w') do |f|
+    f.write spec.to_ruby
+  end
+  puts <<-EOS
+  Successfully generated gemspec
+  Name: #{name}
+  Version: #{version}
+  File: #{filename}
+  EOS
+end
+
+task :install => [ :package ] do
+  sh %{sudo gem install pkg/#{name}-#{version}.gem}
+end
+
+task :uninstall => [ :clean ] do
+  sh %{sudo gem uninstall #{name}}
+end
+
+desc 'run all specs'
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ['-c']
+end
+
+CLEAN.include ['pkg']

data/lib/kvs.rb

@@ -0,0 +1,43 @@
+require 'digest/sha1'
+require 'tmpdir'
+
+module KVS
+  VERSION = '0.2.0'
+
+  class <<self
+    attr_accessor :dir
+
+    def <<(value)
+      key = key_gen(value)
+      self[id] = value
+      key
+    end
+
+    def [](key)
+      path = file_of(key)
+      return nil unless File.exists?(path)
+      File.read(path)
+    end
+
+    def []=(key, value)
+      File.open(file_of(key), 'wb') { |f| f << value.to_s }
+    end
+
+    def delete(key)
+      path = file_of(key)
+      File.delete(path) if File.exists?(path)
+      nil
+    end
+
+    def file_of(key)
+      key = key.to_s
+      raise ArgumentError, 'invalid key' unless key =~ /^[\w]+$/
+      raise "dir is not specified" unless dir
+      File.join(dir, key)
+    end
+
+    def key_gen(value)
+      Digest::SHA1.hexdigest(value.to_s)
+    end
+  end
+end

data/spec/kvs_spec.rb

@@ -0,0 +1,81 @@
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'kvs'
+
+describe KVS do
+  before do
+    @tmpdir = Dir.tmpdir
+    KVS.dir = @tmpdir
+  end
+
+  it 'should generate file path' do
+    KVS.file_of('foo').should == @tmpdir + '/foo'
+  end
+
+  it 'should store data' do
+    KVS['foo'] = 'bar'
+    KVS['foo'].should == 'bar'
+    File.exists?(KVS.file_of('foo')).should be_true
+  end
+
+  it 'should store data with "<<"' do
+    key = KVS << 'test'
+    KVS[key].should == 'test'
+    File.exists?(KVS.file_of(key)).should be_true
+  end
+
+  it 'can also use Symbol as key' do
+    KVS[:foo] = 'test'
+    KVS['foo'].should == 'test'
+    KVS['bar'] = 'test test'
+    KVS[:bar].should == 'test test'
+  end
+
+  describe 'no value exists' do
+    it 'should return nil' do
+      KVS['x'].should be_nil
+    end
+  end
+
+  describe 'delete value' do
+    it 'should delete value' do
+      KVS['foo'] = 'bar'
+      KVS['foo'].should == 'bar'
+      KVS.delete('foo')
+      KVS['foo'].should be_nil
+      File.exists?(KVS.file_of('foo')).should be_false
+    end
+
+    it 'should return nil' do
+      KVS['foo'] = 'bar'
+      KVS.delete('foo').should be_nil
+      KVS.delete('foo').should be_nil
+    end
+  end
+
+  describe 'should always return nil' do
+    it 'should not raise ArgumentError' do
+      lambda { KVS['foo'] }.should_not raise_error(ArgumentError)
+      lambda { KVS['_'] }.should_not raise_error(ArgumentError)
+      lambda { KVS['1'] }.should_not raise_error(ArgumentError)
+    end
+  end
+
+  describe 'use invalid key' do
+    it 'should raise ArgumentError' do
+      lambda { KVS['.'] }.should raise_error(ArgumentError)
+      lambda { KVS['../'] }.should raise_error(ArgumentError)
+      lambda { KVS['/'] }.should raise_error(ArgumentError)
+    end
+  end
+
+  describe 'dir is nil' do
+    before do
+      KVS.dir = nil
+    end
+
+    it 'should raise ArgumentError' do
+      lambda { KVS['foo'] = 'bar' }.should raise_error(RuntimeError)
+      lambda { KVS['foo'] }.should raise_error(RuntimeError)
+    end
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+name: jugyo-kvs
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- jugyo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-15 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: KVS is a simple key value store.
+email: jugyo.org@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- README.markdown
+- ChangeLog
+- lib/kvs.rb
+- spec/kvs_spec.rb
+has_rdoc: false
+homepage: http://github.com/jugyo/kvs
+licenses: 
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: kvs
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: simple key value store.
+test_files: []
+