tokyo_wrapper 0.1.4 → 0.1.5

data/README.rdoc

@@ -10,6 +10,29 @@
   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).
 
+== Basic underlying philosophy
+
+  1. Preserve the functionality and behaviour of rufus-tokyo. 
+
+    1-1. No fork of rufus-tokyo. 
+
+    1-2. This gem doesn't open rufus-tokyo class and add a functionality there. 
+         It is developed as a pure wrapper. 
+
+    1-3. The minimum or no exception handling of its own is done. 
+         All the exceptions should directly come from rufus-tokyo, so that usage of this gem doesn't 
+       interfere the usage of rufus-tokyo to access Tokyo Cabinet. 
+         (Of course, as found necessary, this gem raises its own exception but it should be minimum.)
+
+  2. The data are used in Hash format. 
+
+    2-1. This gem is not meant to be a mapper to Object like Object-Relational Mapping. 
+         Comment from the author (tadatoshi): 
+         "I'm using Ruby on Rails most of the time. I'm thinking of using DataMapper for all the 
+          Object-Relational Mappings when Ruby on Rails 3.0 becomes available. 
+          I don't know much about DataMapper for Tokyo Cabinet so I cannot make a comment about it. 
+          But at least, I'm thinking of using this gem only when I want to use the data in Hash format."
+
 == Required Ruby Gems
 
   rufus-tokyo 1.0.1 or above. 

data/lib/tokyo_wrapper/table.rb

@@ -51,10 +51,14 @@ module TokyoWrapper
       @table.query
     end  
   
-    def find(id)
-      @table[id.to_s]
+    def find(id, options = {})
+      if !options.empty? && options[:pk_included] == true
+        @table[id.to_s].merge({:pk => id.to_s})
+      else
+        @table[id.to_s]
+      end
     end
-    
+
     def all_by_key_value(key, value)
       @table.query do |query|
         query.add key, :equals, value

data/spec/fixtures/temp.txt

@@ -0,0 +1,2 @@
+This is for testing storing the content of the file. 
+Don't modify the content.

data/spec/tokyo_wrapper/table_spec.rb

@@ -139,6 +139,40 @@ describe TokyoWrapper::Table do
     
   end
   
+  context "Find" do
+    
+    it "should find a row with a given id" do
+      
+      begin
+        write_table = TokyoWrapper::Table.create_with_create_write_non_blocking_lock(@table_file)
+
+        data_hash = {"street" => "1111 Main", 
+                     "city" => "Montreal", 
+                     "notes" => "Some notes"}
+        id = write_table.add(data_hash)
+      ensure
+        write_table.close unless write_table.nil?
+      end
+      
+      begin
+        read_table = TokyoWrapper::Table.create_with_read_non_locking(@table_file)
+                                      
+        read_table.find(id).should == {"street" => "1111 Main", 
+                                       "city" => "Montreal", 
+                                       "notes" => "Some notes"} 
+        read_table.find(id, :pk_included => true).should == {:pk => id.to_s, 
+                                                             "street" => "1111 Main", 
+                                                             "city" => "Montreal", 
+                                                             "notes" => "Some notes"}                                        
+                                       
+      ensure      
+        read_table.close unless read_table.nil?
+      end                 
+      
+    end
+    
+  end
+  
   context "Find all" do
     
     it "should find all the rows that have a given value" do
@@ -192,4 +226,75 @@ describe TokyoWrapper::Table do
     
   end
   
+  context "store file content" do
+    
+    it "should store the content of the specified text file" do
+      
+      begin
+        write_table = TokyoWrapper::Table.create_with_create_write_non_blocking_lock(@table_file)
+      
+        temp_file_content = open(File.expand_path(File.dirname(__FILE__) + '/../fixtures/temp.txt')).read
+
+        data_hash = {"filename" => "temp.txt", 
+                     "content_type" => "text/plain", 
+                     "size" => File.size(File.expand_path(File.dirname(__FILE__) + '/../fixtures/temp.txt')),
+                     "file_data" => temp_file_content}
+        id = write_table.add(data_hash)   
+
+      ensure
+        write_table.close unless write_table.nil?
+      end            
+      
+      begin
+        read_table = TokyoWrapper::Table.create_with_read_non_locking(@table_file)
+
+        read_table.find(id)["filename"].should == "temp.txt"   
+        read_table.find(id)["content_type"].should == "text/plain"   
+        read_table.find(id)["size"].should == "79"                           
+        read_table.find(id)["file_data"].should == "This is for testing storing the content of the file. \nDon't modify the content."
+      ensure
+        read_table.close unless read_table.nil?
+      end   
+      
+    end
+      
+    it "should store the content of the specified image file" do      
+      
+      begin
+        write_table = TokyoWrapper::Table.create_with_create_write_non_blocking_lock(@table_file)
+      
+        image_file_content = open(File.expand_path(File.dirname(__FILE__) + '/../fixtures/rails.png')).read
+
+        data_hash = {"filename" => "rails.png", 
+                     "content_type" => "image/png", 
+                     "size" => File.size(File.expand_path(File.dirname(__FILE__) + '/../fixtures/rails.png')),
+                     "file_data" => image_file_content}
+        id = write_table.add(data_hash)   
+
+      ensure
+        write_table.close unless write_table.nil?
+      end            
+      
+      begin
+        read_table = TokyoWrapper::Table.create_with_read_non_locking(@table_file)
+        
+        read_table.find(id)["filename"].should == "rails.png"   
+        read_table.find(id)["content_type"].should == "image/png"   
+        read_table.find(id)["size"].should == "1787"
+                                     
+        file_for_retrieved_content = File.new(File.expand_path(File.dirname(__FILE__) + '/../fixtures/retrieved_rails.png'), "w")
+        file_for_retrieved_content.write(read_table.find(id)["file_data"])
+        file_for_retrieved_content.close
+        File.exists?(File.expand_path(File.dirname(__FILE__) + '/../fixtures/retrieved_rails.png')).should be_true
+        File.size(File.expand_path(File.dirname(__FILE__) + '/../fixtures/retrieved_rails.png')).should == File.size(File.expand_path(File.dirname(__FILE__) + '/../fixtures/rails.png'))
+
+      ensure
+        File.delete(File.expand_path(File.dirname(__FILE__) + '/../fixtures/retrieved_rails.png')) if File.exists?(File.expand_path(File.dirname(__FILE__) + '/../fixtures/retrieved_rails.png'))
+        read_table.close unless read_table.nil?
+      end                   
+      
+    end
+    
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tokyo_wrapper
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - Tadatoshi Takahashi
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-24 00:00:00 -05:00
+date: 2010-01-29 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -29,6 +29,8 @@ files:
 - lib/tokyo_wrapper.rb
 - Rakefile
 - README.rdoc
+- spec/fixtures/rails.png
+- spec/fixtures/temp.txt
 - spec/macros/rufus_tokyo_macros.rb
 - spec/spec_helper.rb
 - spec/tokyo_cabinet_files/table.tct