kioku 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    yard (0.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Maximilian Stroh
+
+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,29 @@
+= kioku
+
+A handy little Ruby Gem for a very leightweight NoSQL data storage solution. In fact, it is simply a key-value-store in a single file. The name of this gem is equivalent to the japanese word for storage ;)
+
+== Advantages of kioku: 
+* extremly lightweight, no need for configurations
+* blazing fast for small to mid-size datasets
+* pure Ruby implementation, no native extensions neccessary
+* let you store in your data in the human-readable YAML format
+
+== When NOT to use kioku
+* big amount of data
+* write-intensive applications
+
+== Contributing to kioku
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Maximilian Stroh. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "kioku"
+  gem.homepage = "http://github.com/Anonyfox/kioku"
+  gem.license = "MIT"
+  gem.summary = %Q{A leightweight key-value store solution.}
+  gem.description = %Q{See the Homepage for more Informations!}
+  gem.email = "Fox56@gmx.de"
+  gem.authors = ["Maximilian Stroh"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/kioku.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{kioku}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Maximilian Stroh}]
+  s.date = %q{2012-01-11}
+  s.description = %q{See the Homepage for more Informations!}
+  s.email = %q{Fox56@gmx.de}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "kioku.gemspec",
+    "lib/kioku.rb",
+    "test/bindata.bz2",
+    "test/helper.rb",
+    "test/sample.yml",
+    "test/test_kioku_basics.rb"
+  ]
+  s.homepage = %q{http://github.com/Anonyfox/kioku}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
+  s.summary = %q{A leightweight key-value store solution.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/kioku.rb

@@ -0,0 +1,91 @@
+#encoding: utf-8
+
+require 'yaml'
+require 'profile'
+
+class Kioku
+
+	# opens up a database file and loads the content, 
+	# or creates one first if it doesn't exist yet
+	def initialize filepath
+		@filepath = filepath
+		@data_base = {}
+		init_database
+	end
+
+	# add any new content to the database, identified by the given key. 
+	# returns false if the key is already existing.
+	def set key, data
+		@data_base[ key ] = data
+		update_database
+	end
+
+	# a shorthand method for the set method
+	def []=(key, data)
+		set key, data
+	end
+
+	# return the data corresponding to the given key. 
+	def get key
+		@data_base[ key ]
+	end
+
+	# a shorthand method for the get method
+	def [](key)
+		get key
+	end
+
+	# delete the key and all associated data 
+	def delete key
+		data = @data_base.delete key
+		update_database
+		data
+	end
+
+	def clear
+		@data_base = {}
+		update_database
+	end
+
+	def destroy
+		File.delete @filepath
+		self.freeze
+	end
+
+	def exists? key
+		@data_base.has_key? key
+	end
+
+	def keys
+		@data_base.keys
+		#puts @data_base.values
+	end
+
+private
+
+	def init_database
+		if File.exists? @filepath
+			f = File.open @filepath, 'r'
+			@data_base = YAML.load_file @filepath
+			f.close
+
+			#f = File.open @filepath, 'rb'
+			#@data_base = Marshal.load f.read
+			#f.close
+		else
+			f = File.new @filepath, 'wb'
+			f.close
+		end
+	end
+
+	def update_database
+		f = File.new @filepath, 'w'
+		f << @data_base.to_yaml
+		f.close
+
+		#f = File.new @filepath, 'wb'
+		#f << Marshal.dump(@data_base)
+		#f.close
+	end
+
+end

data/test/helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'kioku'
+
+class Test::Unit::TestCase
+end

data/test/sample.yml

@@ -0,0 +1,6 @@
+---
+obj:
+- 1
+- 2
+- 4
+höhö: süß

data/test/test_kioku_basics.rb

@@ -0,0 +1,43 @@
+#encoding: utf-8
+
+require_relative 'helper'
+
+class TestKiokuBasics < Test::Unit::TestCase
+
+	def setup
+		@k = Kioku.new "sample.yml"
+	end
+
+  def test_general_working_and_syntax
+  	@k.clear
+  	@k["entry"] = "a sample"
+  	assert_equal( "a sample", @k["entry"] )
+  	@k.delete "entry"
+  	assert_equal( nil, @k["entry"] )
+  end
+
+  def test_general_serialization
+  	@k["entry"] = "This!"
+  	tmp = Kioku.new "sample.yml"
+  	assert_equal( @k["entry"], tmp["entry"] )
+  	tmp.destroy
+  end
+
+  def test_umlauts
+  	@k["höhö"] = "süß"
+  	assert_equal( @k["höhö"], "süß" )
+  end
+
+  def test_object_data
+  	@k["obj"] = [1,2,4]
+  	assert_equal( @k["obj"], [1,2,4] )
+  end
+
+  def test_binary_data
+  	f = File.open("bindata.bz2","rb").read
+  	@k["bin"] = f.dup
+  	tmp = Kioku.new "sample.yml"
+  	assert_equal( tmp.exists?("bin"), true)
+  	assert_equal( tmp["bin"], @k["bin"] )
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: kioku
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Maximilian Stroh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-11 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &22960400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *22960400
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &22959560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *22959560
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &22958420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *22958420
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &22957140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22957140
+description: See the Homepage for more Informations!
+email: Fox56@gmx.de
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- kioku.gemspec
+- lib/kioku.rb
+- test/bindata.bz2
+- test/helper.rb
+- test/sample.yml
+- test/test_kioku_basics.rb
+homepage: http://github.com/Anonyfox/kioku
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4502759015728651600
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: A leightweight key-value store solution.
+test_files: []