steenzout-dao 0.1.0

data/lib/dao/manager.rb

@@ -0,0 +1,39 @@
+module Steenzout
+  module DAO
+
+    class DAOManager
+
+      @config = Steenzout::ConfigurationManager.configuration_for_gem 'steenzout-dao'
+
+
+      def self.create_dao(name)
+
+      end
+
+
+
+      def self.commit_transaction()
+
+      end
+
+
+
+      def self.end_transaction()
+
+      end
+
+
+
+      def self.rollback_transaction()
+
+      end
+
+
+
+      def self.start_transaction()
+
+      end
+
+    end
+  end
+end

data/lib/dao/tokyocabinet.rb

@@ -0,0 +1,140 @@
+include TokyoCabinet
+
+module Steenzout
+  module DAO
+
+    # Generic TokyoCabinet Data Access Object.
+    #
+    # @var name: the name of the implemented DAO.
+    # @var database: the TokyoCabinet database.
+    #
+    class TokyoCabinetDAO
+
+      attr_reader :database
+
+      # Constructs a generic TokyoCabinet DAO.
+      #
+      # @param name: the name of the implemented DAO.
+      # @param configuration: hash containing the DAO configuration.
+      #                       :kvstore => the TokyoCabinet database implementation.
+      #                       :location => the TokyoCabinet database location.
+      #
+      def initialize(name, configuration)
+
+        @name = name
+
+        raise ArgumentError, "TokyoCabinetDAO name is nil!" \
+          if name.nil?
+        raise ArgumentError, "TokyoCabinetDAO configuration nil!" \
+          if configuration.nil?
+        raise ArgumentError, "TokyoCabinetDAO configuration for #{@name} is missing the :kvstore property!" \
+          if !configuration.has_key? :kvstore
+        raise ArgumentError, "TokyoCabinetDAO configuration for #{@name} is missing the :location property!" \
+          if !configuration.has_key? :location
+
+
+        case configuration[:kvstore]
+          when :hdb, :hash
+            @database = HDB::new
+          when :bdb, :btree
+            @database = BDB::new
+          when :fdb, :'fixed-length'
+            @database = FDB::new
+          when :tdb, :table
+            @database = TDB::new
+          when :adb, :abstract
+            @database = ADB::new
+          else
+            raise ArgumentError, "Unknown TokyoCabinet database #{configuration[:kvstore]}!"
+        end
+
+        @location = configuration[:location]
+
+      end
+
+      def open()
+
+        if !@database.open(@location, HDB::OWRITER | HDB::OCREAT)
+          LOGGER.error('steenzout-dao.TokyoCabinetDAO][#{@name}') {"open error: #{@database.errmsg(@database.ecode)}"} if LOGGER.error?
+        end
+
+      end
+
+      def close()
+
+        if !@database.nil?
+          LOGGER.error('steenzout-dao.TokyoCabinetDAO[#{@name}') {"close error: #{@database.errmsg(@database.ecode)}"} if !@database.close
+        end
+
+      end
+
+
+
+      def delete(key)
+
+        @database.out key
+
+        LOGGER.info('steenzout-dao.TokyoCabinetDAO[#{@name}') {"deleted #{key} mapping."}
+
+        nil
+
+      end
+
+
+
+      def has?(key)
+
+        !@database[key].nil?
+
+      end
+
+
+
+      def get(key)
+
+        @database[key]
+
+      end
+
+
+
+      def list()
+
+        @database.iterinit
+        while key = @database.iternext
+          yield key, get(key)
+        end
+
+      end
+
+
+
+      def map(key, value)
+
+        status = @database.put key, value
+        if !status
+          LOGGER.debug('steenzout-dao.TokyoCabinetDAO][#{@name}') {"#{@database.ecode} : #{@database.errmsg(@database.ecode)}"}
+          error = "failed mapping #{key}->#{value}!"
+          LOGGER.error('steenzout-dao.TokyoCabinetDAO][#{@name}') {error}
+          raise Exception, error
+        end
+        LOGGER.info('steenzout-dao.TokyoCabinetDAO][#{@name}') {"created #{key}->#{value} mapping."}
+
+      end
+
+
+
+      def update(key, value)
+
+        if !has? key
+          raise ArgumentError, "There is no mapping for the given #{key} key."
+        end
+
+        map(key, value)
+
+      end
+
+    end
+
+  end
+end

data/lib/steenzout-dao.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'steenzout-cfg'
+
+
+module Steenzout
+  module DAO
+
+    autoload :DAOManager, "#{File.dirname(__FILE__)}/dao/manager"
+    autoload :TokyoCabinetDAO, "#{File.dirname(__FILE__)}/dao/tokyocabinet"
+
+  end
+end

data/test/unit/manager_test.rb

@@ -0,0 +1,34 @@
+require 'test/unit'
+require 'lib/steenzout-dao'
+
+
+
+class TestManager < Test::Unit::TestCase
+
+  def setup
+
+  end
+
+  def teardown
+
+  end
+
+
+
+  def test_commit_transaction
+
+  end
+
+  def test_end_transaction
+
+  end
+
+  def test_rollback_transaction
+
+  end
+
+  def test_start_transaction
+
+  end
+
+end

data/test/unit/tokyocabinet_test.rb

@@ -0,0 +1,130 @@
+require 'test/unit'
+require 'logger'
+require 'tokyocabinet'
+require 'lib/steenzout-dao'
+
+
+LOGGER = Logger.new('log/development.log') if !defined? LOGGER
+
+
+
+class TestTokyoCabinetDAO < Test::Unit::TestCase
+
+  KEY_STRING1 = 'string1'
+  KEY_STRING2 = 'string2'
+  KEY_UNKNOWN = 'UNKNOWN'
+
+  VALUE_STRING1 = 'value_string1'
+  VALUE_STRING2 = 'value_string2'
+
+
+
+  def setup()
+
+    @dao = Steenzout::DAO::TokyoCabinetDAO.new(:test_dao, {:kvstore => :hdb, :location => 'test/test.tch'})
+    @dao.open
+
+    @dao.map(KEY_STRING1, VALUE_STRING1)
+
+  end
+
+  def teardown()
+
+    @dao.database.vanish unless @dao.nil? or @dao.database.nil? # removes all records from the database
+
+  ensure
+    @dao.close if !@dao.nil?
+  end
+
+
+
+  def test_create_abstract()
+
+    dao = Steenzout::DAO::TokyoCabinetDAO.new(:test_dao, {:kvstore => :adb, :location => 'test/abstract.tch'})
+    assert(dao.database.instance_of? ADB)
+
+  end
+
+  def test_create_btree()
+
+    dao = Steenzout::DAO::TokyoCabinetDAO.new(:test_dao, {:kvstore => :bdb, :location => 'test/btree.tch'})
+    assert(dao.database.instance_of? BDB)
+
+  end
+
+  def test_create_hash()
+
+    dao = Steenzout::DAO::TokyoCabinetDAO.new(:test_dao, {:kvstore => :hdb, :location => 'test/hash.tch'})
+    assert(dao.database.instance_of? HDB)
+
+  end
+
+  def test_create_fixed_length()
+
+    dao = Steenzout::DAO::TokyoCabinetDAO.new(:test_dao, {:kvstore => :fdb, :location => 'test/fixed.tch'})
+    assert(dao.database.instance_of? FDB)
+
+  end
+
+  def test_create_table()
+
+    dao = Steenzout::DAO::TokyoCabinetDAO.new(:test_dao, {:kvstore => :tdb, :location => 'test/abstract.tch'})
+    assert(dao.database.instance_of? TDB)
+
+  end
+
+
+
+  def test_delete()
+
+    @dao.delete(KEY_STRING1)
+    assert_nil @dao.get(KEY_STRING1)
+
+  end
+
+  def test_delete_unknown_key()
+    assert_nil @dao.delete('UNKNOWN')
+  end
+
+
+  def test_get()
+
+    # 0. adding one more mapping
+    @dao.map(KEY_STRING2, VALUE_STRING2)
+
+    # 1. test
+    assert_equal VALUE_STRING1, @dao.get(KEY_STRING1)
+    assert_equal VALUE_STRING2, @dao.get(KEY_STRING2)
+
+  end
+
+  def test_get_unknown_key()
+    assert_nil @dao.get(KEY_UNKNOWN)
+  end
+
+
+  def test_has?()
+    assert @dao.has? KEY_STRING1
+    assert_equal false, @dao.has?('UNKNOWN')
+  end
+
+
+  def test_list()
+
+    # 1. with mappings
+    @dao.list { |key, value|
+      assert_equal key, KEY_STRING1
+      assert_equal value, VALUE_STRING1}
+
+    # 2. with no mappings
+    @dao.delete(KEY_STRING1)
+    assert_nil @dao.list
+
+  end
+
+
+  def test_map()
+    assert_equal VALUE_STRING1, @dao.get(KEY_STRING1)
+  end
+
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification 
+name: steenzout-dao
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- ""
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-22 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: steenzout-cfg
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 0
+        - 4
+        version: 1.0.4
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: tokyocabinet
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 53
+        segments: 
+        - 1
+        - 29
+        version: "1.29"
+  type: :runtime
+  version_requirements: *id003
+description: ""
+email: 
+- ""
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- lib/dao/manager.rb
+- lib/dao/tokyocabinet.rb
+- lib/steenzout-dao.rb
+- README.textile
+- test/unit/manager_test.rb
+- test/unit/tokyocabinet_test.rb
+has_rdoc: true
+homepage: https://github.com/steenzout/steenzout-dao
+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.2
+signing_key: 
+specification_version: 3
+summary: .
+test_files: 
+- test/unit/manager_test.rb
+- test/unit/tokyocabinet_test.rb