tokyo_wrapper 0.1.0

data/README.rdoc

@@ -0,0 +1,41 @@
+= Tokyo Wrapper
+
+  Ruby gem with the code with the convenient methods written on the top of rufus-tokyo. 
+
+  It is extracted from the code I frequently use when using rufus-tokyo to access Tokyo Cabinet. 
+
+  For example, for table, I always add a row with unique id so I always use generate_unique_id method. By wrapping the call to this method, the code that is using the rufus/tokyo doesn't get cluttered. 
+
+  rufus-tokyo is "ffi based ruby library to access Tokyo Cabinet and Tokyo Tyrant" by John Mettraux (Copyright (c) 2009-2010, see http://github.com/jmettraux/rufus-tokyo/blob/master/LICENSE.txt).
+
+== Required Ruby Gems
+
+  rufus-tokyo 1.0.1 or above. 
+
+  sudo gem install rufus-tokyo --source http://gemcutter.org
+
+== Install
+
+  sudo gem install tokyo_wrapper --source http://gemcutter.org
+
+== Licence
+
+Copyright (c) 2010, Tadatoshi Takahashi
+
+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,3 @@
+require 'rubygems'
+require 'rake'
+require 'spec/autorun'

data/init.rb

@@ -0,0 +1 @@
+require 'tokyo_wrapper'

data/lib/tokyo_wrapper.rb

@@ -0,0 +1,2 @@
+require 'rufus/tokyo'
+require 'tokyo_wrapper/table'

data/lib/tokyo_wrapper/table.rb

@@ -0,0 +1,53 @@
+module TokyoWrapper
+
+  class Table
+    
+    def initialize(table)
+      @table = table
+    end
+  
+    def self.create_with_create_write_non_blocking_lock(file)
+      table = Rufus::Tokyo::Table.new(File.expand_path(file), :mode => "cwf")
+      self.new(table)
+    end  
+  
+    def self.create_with_write_non_blocking_lock(file)
+      table = Rufus::Tokyo::Table.new(File.expand_path(file), :mode => "wf")
+      self.new(table)
+    end
+  
+    def self.create_with_read_non_locking(file)
+      table = Rufus::Tokyo::Table.new(File.expand_path(file), :mode => "re")
+      self.new(table)
+    end
+
+    def close
+      @table.close
+    end  
+  
+    def add(params = {})
+      id = @table.generate_unique_id
+      @table[id] = params
+      id
+    end
+  
+    def update(id, params)
+      if !@table[id.to_s].nil? && !@table[id.to_s].empty?
+        @table[id.to_s] = @table[id.to_s].merge(params)
+        true
+      else
+        false
+      end
+    end    
+  
+    def all
+      @table.query
+    end  
+  
+    def find(id)
+      @table[id.to_s]
+    end
+    
+  end
+
+end

data/spec/macros/rufus_tokyo_macros.rb

@@ -0,0 +1,11 @@
+module RufusTokyoMacros
+  
+  def clear_table(file)
+    if File.exists?(File.expand_path(file))
+      table = Rufus::Tokyo::Table.new(File.expand_path(file), :mode => "wf")
+      table.clear
+      table.close
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require File.dirname(__FILE__) + '/../lib/tokyo_wrapper'
+require File.dirname(__FILE__) + "/macros/rufus_tokyo_macros" 

data/spec/tokyo_wrapper/table_spec.rb

@@ -0,0 +1,77 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe TokyoWrapper::Table do
+  include RufusTokyoMacros
+  
+  before(:each) do
+    @table_file = File.expand_path(File.dirname(__FILE__) + '/../tokyo_cabinet_files/table.tct')
+    clear_table(@table_file)
+  end
+
+  after(:each) do
+    clear_table(@table_file)
+  end
+  
+  context "Add" do
+    
+    before(:each) do
+      @table = TokyoWrapper::Table.create_with_create_write_non_blocking_lock(@table_file)
+    end
+    
+    after(:each) do
+      @table.close  
+    end
+    
+    it "should add data" do
+
+      data_hash = {"street" => "1111 Main", 
+                   "city" => "Montreal", 
+                   "notes" => "Some notes"}
+      id = @table.add(data_hash)
+
+      @table.all.should == [{:pk => id.to_s,
+                             "street" => "1111 Main", 
+                             "city" => "Montreal", 
+                             "notes" => "Some notes"}]
+                                      
+      @table.find(id).should == {"street" => "1111 Main", 
+                                 "city" => "Montreal", 
+                                 "notes" => "Some notes"}                        
+      
+    end
+    
+  end
+  
+  context "Update" do
+    
+    before(:each) do
+      @table = TokyoWrapper::Table.create_with_create_write_non_blocking_lock(@table_file)
+    end
+    
+    after(:each) do
+      @table.close  
+    end    
+    
+    it "should update data" do   
+      
+      data_hash = {"street" => "1111 Main", 
+                   "city" => "Montreal", 
+                   "notes" => "Some notes"}
+      id = @table.add(data_hash)
+                                      
+      @table.find(id).should == {"street" => "1111 Main", 
+                                 "city" => "Montreal", 
+                                 "notes" => "Some notes"}    
+                                          
+      result = @table.update(id, "notes" => "Recently situation has been changed.")
+      
+      result.should be_true
+      @table.find(id).should == {"street" => "1111 Main", 
+                                 "city" => "Montreal", 
+                                 "notes" => "Recently situation has been changed."}        
+      
+    end
+    
+  end
+  
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: tokyo_wrapper
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tadatoshi Takahashi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-17 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Collection of convenient methods written on the top of rufus/tokyo to access Tokyo Cabinet
+email: tadatoshi.3.takahashi@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/tokyo_wrapper.rb
+files: 
+- init.rb
+- lib/tokyo_wrapper/table.rb
+- lib/tokyo_wrapper.rb
+- Rakefile
+- README.rdoc
+- spec/macros/rufus_tokyo_macros.rb
+- spec/spec_helper.rb
+- spec/tokyo_cabinet_files/table.tct
+- spec/tokyo_wrapper/table_spec.rb
+has_rdoc: true
+homepage: http://github.com/tadatoshi/tokyo_wrapper
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Tokyo Wrapper
+- --main
+- README.rdoc
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: tokyo_wrapper
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Collection of convenient methods written on the top of rufus/tokyo to access Tokyo Cabinet
+test_files: []
+