ykk 1.0.0

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/ChangeLog

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

data/README.markdown

@@ -0,0 +1,61 @@
+YKK
+========
+
+[http://github.com/jugyo/ykk](http://github.com/jugyo/ykk)
+
+Description
+--------
+
+YKK is a simple key value store.
+
+Install
+--------
+
+    gem install ykk
+
+Usage
+--------
+
+use as singleton:
+
+    YKK.dir = '/tmp/ykk'
+
+    YKK['foo'] = 'bar'
+    puts YKK['foo'] #=> bar
+
+    key = YKK << 'jugyo'
+    puts YKK[key] #=> jugyo
+
+    YKK.delete('foo')
+
+use as instance:
+
+    YKK_A = YKK.new('/tmp/ykk_a')
+    YKK_A['foo'] = 'bar'
+    puts YKK_A['foo'] #=> bar
+
+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,43 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ykk"
+    gem.summary = %Q{Simple key value store.}
+    gem.description = %Q{YKK is a simple key value store using YAML.}
+    gem.email = "jugyo.org@gmail.com"
+    gem.homepage = "http://github.com/jugyo/ykk"
+    gem.authors = ["jugyo"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ykk #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/ykk.rb

@@ -0,0 +1,75 @@
+require 'digest/sha1'
+require 'yaml'
+require 'fileutils'
+
+class YKK
+  @instance = self.new
+
+  def self.method_missing(method, *args, &block)
+    if @instance.respond_to?(method)
+      @instance.__send__(method, *args, &block)
+    else
+      super
+    end
+  end
+
+  def self.inspect
+    @instance.inspect
+  end
+
+  attr_accessor :dir
+
+  def initialize(dir = nil)
+    self.dir = dir
+  end
+
+  def <<(value)
+    key = key_gen(value)
+    self[key] = value
+    key
+  end
+
+  def [](key)
+    path = file_of(key)
+    return nil unless File.exists?(path)
+    YAML.load(File.read(path))
+  end
+
+  def key?(key)
+    !!self[key]
+  end
+
+  def []=(key, value)
+    path = file_of(key)
+    FileUtils.mkdir_p(dir) unless File.exists?(dir)
+    File.open(path, 'wb') { |f| f << value.to_yaml }
+  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
+
+  def keys
+    Dir.glob(dir + '/*').map {|f| File.basename(f) }
+  end
+
+  def inspect
+    pairs = Dir.glob(dir + '/*').map {|f|
+      "#{File.basename(f).inspect}: #{YAML.load_file(f).inspect}"
+    }
+    "YKK(#{pairs.join ', '})"
+  end
+end

data/spec/ykk_spec.rb

@@ -0,0 +1,120 @@
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'ykk'
+require 'tmpdir'
+require 'fileutils'
+
+describe YKK do
+  before do
+    @tmpdir = Dir.tmpdir + '/ykk_test'
+    FileUtils.rm_rf(@tmpdir)
+    YKK.dir = @tmpdir
+  end
+
+  it 'generates file path' do
+    YKK.file_of('foo').should == @tmpdir + '/foo'
+  end
+
+  it 'stores data' do
+    YKK['foo'] = {:a => 'b', :c => 'd'}
+    YKK['foo'].should == {:a => 'b', :c => 'd'}
+    File.exists?(YKK.file_of('foo')).should be_true
+    YKK['bar'] = 'bar'
+    YKK.keys.include?('foo').should be_true
+    YKK.keys.include?('bar').should be_true
+  end
+
+  it 'should store data with "<<"' do
+    key = YKK << {:a => 'b', :c => 'd'}
+    YKK[key].should == {:a => 'b', :c => 'd'}
+    File.exists?(YKK.file_of(key)).should be_true
+  end
+
+  it 'can also use Symbol as key' do
+    YKK[:foo] = 'test'
+    YKK['foo'].should == 'test'
+    YKK['bar'] = 'test test'
+    YKK[:bar].should == 'test test'
+  end
+
+  describe 'no value exists' do
+    it 'should return nil' do
+      YKK['x'].should be_nil
+    end
+  end
+
+  describe 'delete value' do
+    it 'should delete value' do
+      YKK['foo'] = 'bar'
+      YKK['foo'].should == 'bar'
+      YKK.delete('foo')
+      YKK['foo'].should be_nil
+      File.exists?(YKK.file_of('foo')).should be_false
+    end
+
+    it 'should return nil' do
+      YKK['foo'] = 'bar'
+      YKK.delete('foo').should be_nil
+      YKK.delete('foo').should be_nil
+    end
+  end
+
+  describe 'should always return nil' do
+    it 'should not raise ArgumentError' do
+      lambda { YKK['foo'] }.should_not raise_error(ArgumentError)
+      lambda { YKK['_'] }.should_not raise_error(ArgumentError)
+      lambda { YKK['1'] }.should_not raise_error(ArgumentError)
+    end
+  end
+
+  describe 'use invalid key' do
+    it 'raises ArgumentError' do
+      lambda { YKK['.'] }.should raise_error(ArgumentError)
+      lambda { YKK['../'] }.should raise_error(ArgumentError)
+      lambda { YKK['/'] }.should raise_error(ArgumentError)
+    end
+  end
+
+  describe 'dir is nil' do
+    before do
+      YKK.dir = nil
+    end
+
+    it 'raises ArgumentError' do
+      lambda { YKK['foo'] = {:a => 'b'} }.should raise_error(RuntimeError)
+      lambda { YKK['foo'] }.should raise_error(RuntimeError)
+    end
+  end
+
+  describe 'instantiate' do
+    before do
+      @tmpdir_for_foo = Dir.tmpdir + '/ykk_test_foo'
+      FileUtils.rm_rf(@tmpdir_for_foo)
+      @ykk = YKK.new(@tmpdir_for_foo)
+    end
+
+    it 'generates file path' do
+      @ykk.file_of('foo').should == @tmpdir_for_foo + '/foo'
+    end
+
+    it 'stores data' do
+      @ykk['bar'] = 'bar'
+      @ykk['bar'].should == 'bar'
+      YKK['bar'].should_not == 'bar'
+    end
+  end
+
+  describe 'YKK#inspect' do
+    before do
+      @tmpdir = Dir.tmpdir + '/ykk_test'
+      FileUtils.rm_rf(@tmpdir)
+      YKK.dir = @tmpdir
+    end
+
+    it 'shows the pairs of key and value' do
+      YKK.inspect.should == 'YKK()'
+
+      YKK['foo'] = 'bar'
+      YKK.inspect.should == 'YKK("foo": "bar")'
+    end
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: ykk
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- jugyo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-08 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: YKK is a simple key value store using YAML.
+email: jugyo.org@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- ChangeLog
+- README.markdown
+files: 
+- .gitignore
+- ChangeLog
+- README.markdown
+- Rakefile
+- VERSION
+- lib/ykk.rb
+- spec/ykk_spec.rb
+has_rdoc: true
+homepage: http://github.com/jugyo/ykk
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Simple key value store.
+test_files: 
+- spec/ykk_spec.rb