kyoto_record 0.0.1 → 0.0.2

data/kyoto_record.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name                     = "kyoto_record"
-  s.version                  = "0.0.1"
+  s.version                  = "0.0.2"
   s.summary                  = "Persist your classes in Kyoto Cabinet."
   s.description              = "\"KyotoRecord\": Kyoto Cabinet wrapper for Ruby binding.  Scannable. Indexable. A programming interface made for babies."
   s.homepage                 = "http://github.com/thirdreplicator/kyoto_record"

data/kyoto_record.rb

@@ -1,3 +1,4 @@
+# kyoto_record.rb
 require 'kyotocabinet'
 
 module KyotoRecord
@@ -9,6 +10,8 @@ module KyotoRecord
   module Cabinet
     include KyotoCabinet
 
+    DATA_DIR = File.dirname(__FILE__) + '/data'
+
     def find(id)
       value = @db.get(id)
       if value
@@ -18,6 +21,16 @@ module KyotoRecord
       end
     end
 
+    def delete(id)
+      @db.remove(id)      
+    end
+
+    def delete_all
+      scan(1, 1/0.0) do |obj|
+        obj.delete
+      end
+    end
+
     def scan(start_key=nil, limit=1/0.0, &block)
       cur = @db.cursor
       i = 0 
@@ -52,16 +65,16 @@ module KyotoRecord
     end
 
     # Utilities
-    def open_db(base_name)
-      Dir.mkdir('data') if !Dir.exists?('data')
+    def open_db
+      Dir.mkdir(DATA_DIR) if !Dir.exists?(DATA_DIR)
       db = DB::new
-      unless db.open("./data/#{base_name}.kch", DB::OWRITER | DB::OCREATE)
+      unless db.open(data_file, DB::OWRITER | DB::OCREATE)
         STDERR.printf("open error: %s\n", db.error)
       end
       db
     end
 
-    def close_db(base_name)
+    def close_db
       unless @db.close
         STDERR.printf("close error: %s\n", db.error)
       end
@@ -70,9 +83,9 @@ module KyotoRecord
     # Utilities
 
     def set(k,v)
-      @db.set(k, Marshal.dump(v))
+      set_error(k,v) unless @db.set(k, Marshal.dump(v))
     end
-
+ 
     def get(k)
       val = @db.get(k)
       Marshal.load(val) if val
@@ -97,6 +110,16 @@ module KyotoRecord
     def class_name
       @class_name ||= self.to_s
     end
+
+    def data_file
+      "#{DATA_DIR}/#{@base_name}.kch"
+    end
+
+    def set_error(k,v)
+      STDERR.printf("set error for (k,v)=(%s, %s): %s\n", k, v, @db.error)
+      raise @db.error
+    end
+
   end # Cabinet
 
   # Reuse the Cabinet module to make indexes of attributes.
@@ -112,7 +135,7 @@ module KyotoRecord
       @klass = klass
       @attr = attribute
       @base_name = klass.to_s + "_" + attribute.to_s
-      @db = open_db(@base_name) 
+      @db = open_db
     end
   end # class Index
 
@@ -121,35 +144,33 @@ module KyotoRecord
     include Cabinet
 
     def attr_kyoto( *attrs )
-      @db = open_db(class_name)
+      @base_name = class_name
+      @db = open_db
 
       @attrs ||= {}
       @indices ||= {} 
 
-      # Don't redefine it if it was already defined.
-      if !self.respond_to?(:id)
-        # a general setter
-        define_method :set_attr do |k, v|
-          @values[k] = v
+      # a general setter
+      define_method :set_attr do |k, v|
+        @values[k] = v
+      end
+
+      # a general getter
+      define_method :get_attr do |k|
+        @values[k]
+      end 
+     
+      def define_getter_and_setter(attr)
+        define_method :"#{attr}".to_s do
+          @values[attr]
         end
   
-        # a general getter
-        define_method :get_attr do |k|
-          @values[k]
-        end 
-       
-        def define_getter_and_setter(attr)
-          define_method :"#{attr}".to_s do
-            @values[attr]
-          end
-    
-          define_method :"#{attr}=".to_s do |val|
-            set_attr(attr, val)
-          end
-        end 
+        define_method :"#{attr}=".to_s do |val|
+          set_attr(attr, val)
+        end
+      end 
 
-        define_getter_and_setter(:id)
-      end # if
+      define_getter_and_setter(:id)
 
       # In case multiple attributes were passed in, let's loop over each one.
       attrs.each do |attr|
@@ -189,14 +210,23 @@ EOM
   def save
     if !id
       # TODO: use KyotoCabinet::DB#increment
-      id = self.class.last_id + 1
+      self.id = self.class.last_id + 1
       self.class.last_id = id
     end
-
+ 
     write_indices(id)
     write_to_kyoto(id, self)
   end
 
+  def update(attr, value)
+    @values[attr] = value
+    save
+  end
+
+  def delete
+    self.class.delete(self.id)
+  end
+
   def write_indices(id)
     self.class.indices.each do |attr, index|
       index.set(@values[attr], id)
@@ -204,14 +234,11 @@ EOM
   end
 
   def write_to_kyoto(k, v)
-    set_error(k,v) unless self.class.set(k, v)
+    self.class.set(k, v)
   end
 
   private
 
-  def set_error(k,v)
-    STDERR.printf("set error for (k,v)=(%s, %s): %s\n", k, v, kc.error)
-  end
 
 end
 

data/kyoto_record_spec.rb

@@ -19,13 +19,20 @@ describe 'KyotoRecord module' do
     File.exist?('./data/A.kch').should be_true
   end
 
-  it "should retrieve 3 if 3 was saved into a kyoto attribute" do
+  it "find should return an instance of the enhanced user-defined class" do
     @a = A.new
     @a.x = 3
     @a.save
     A.find(1).should be_an_instance_of(A)
   end
 
+  it "should have an id after being saved." do
+    @a = A.new
+    @a.x = 3
+    @a.save
+    @a.id.should == 1
+  end
+
   it "should retrieve 3 if 3 was saved into a kyoto attribute" do
     @a = A.new
     @a.x = 3
@@ -47,6 +54,21 @@ describe 'KyotoRecord module' do
     A.find(1).x.should be_an_instance_of( Time )
   end
 
+  it "should be able to save 2 different objects using the same variable" do
+    a = A.new
+    a.x = "David"
+    a.save
+
+    a = A.new
+    a.x = "Bob"
+    a.save
+
+    A.find(1).x.should == "David"      
+    A.find(1).id.should == 1
+    A.find(2).x.should == "Bob"      
+    A.find(2).id.should == 2
+  end
+
   it "should have a last_id of nil if nothing has been saved yet." do
     A.last_id.should == 0
   end
@@ -108,7 +130,7 @@ describe 'KyotoRecord module' do
 
   describe "Iterating over the records." do
     before(:each) do
-      # Insert 100 records
+      # Insert some records
       10.times do |i|
         a = A.new
         a.x = i+1
@@ -148,6 +170,7 @@ describe 'KyotoRecord module' do
       word.should == "56"
     end
   end
+
   describe "Indexing of attributes." do
     before(:each) do
       class A
@@ -170,6 +193,110 @@ describe 'KyotoRecord module' do
       A.find_by_username("David").username.should == "David"
     end
   end
+  describe "DELETE functionality" do
+    it "should be able to delete records by key (class utility function)" do
+      a = A.new
+      a.username = "David"
+      a.save
+      A.find(1).should_not be_nil
+      A.delete(1)
+      A.find(1).should be_nil
+    end
+
+    it "should be able to delete records by key (instance method)" do
+      a = A.new
+      a.username = "David"
+      a.save
+      A.find(1).should_not be_nil
+      a.delete
+      A.find(1).should be_nil
+    end
+  end
+
+  describe "UPDATE functionality" do
+    it "should be able to update just by saving over the existing one." do
+      a = A.new
+      a.username = "David"
+      a.save
+
+      # Loop him up.
+      a1 = A.find(1)
+      a1.username.should == "David"
+
+      # Modify him.
+      a1.username = "Bob"
+      a1.save
+
+      # Make sure he changed.
+      A.find(1).username.should == "Bob"
+    end
+
+    it "should be able to update with a instance method." do
+      a = A.new
+      a.username = "David"
+      a.save
+
+      A.find(1).update(:username, "Bob")
+      A.find(1).username.should == "Bob"  
+    end
+
+    it "should be able to batch update by scanning over a range of ids." do
+      10.times do |i|
+        a = A.new
+        a.username = i+1
+        a.save
+      end
+
+      A.scan(1,5) do |a|
+        a.update(:username, "Anonymous")
+      end
+
+      A.find(1).username.should  == "Anonymous"
+      A.find(3).username.should  == "Anonymous"
+      A.find(5).username.should  == "Anonymous"
+      A.find(6).username.should  == 6
+      A.find(7).username.should  == 7
+      A.find(10).username.should == 10
+    end
+  end
+
+  describe "DROP the whole database" do
+    it "should be able to drop the whole database." do
+      a = A.new
+      a.username = "David"
+      a.save
+
+      a = A.new
+      a.username = "Bob"
+      a.save
+
+      A.find(1).username.should == "David"
+      A.find(2).username.should == "Bob"
+
+      A.delete_all
+
+      A.find(1).should be_nil
+      A.find(2).should be_nil
+    end  
+
+    it "should be able to add more items after the database was dropped." do
+      a = A.new
+      a.username = "David"
+      a.save
+
+      A.find(1).username.should == "David"
+
+      A.delete_all
+
+      b = A.new
+      b.username = "Duck"
+      b.id.should be_nil
+      b.save
+
+      b.id.should == 2
+      A.find(2).should_not be_nil
+    end
+  end
 
   describe "Auxilliary functions" do
     it "should be able to know it's own name as a string" do

metadata

@@ -2,7 +2,7 @@
 name: kyoto_record
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - David Beckwith
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-02 00:00:00 -08:00
+date: 2011-03-05 00:00:00 -08:00
 default_executable: 
 dependencies: []