daybreak 0.0.4 → 0.1.0

data/lib/daybreak/db.rb

@@ -28,8 +28,7 @@ module Daybreak
     # @param [Boolean] sync if true, sync this value immediately
     def []=(key, value, sync = false)
       key = key.to_s
-      @writer.write(Record.new(key, serialize(value)))
-      flush! if sync
+      write key, value, sync
       @table[key] = value
     end
     alias_method :set, :"[]="
@@ -41,6 +40,21 @@ module Daybreak
       set key, value, true
     end
 
+    # Delete a key from the database
+    # @param [#to_s] key the key of the storage slot in the database
+    # @param [Boolean] sync if true, sync this deletion immediately
+    def delete(key, sync = false)
+      key = key.to_s
+      write key, '', sync, true
+      @table.delete key
+    end
+
+    # delete! immediately deletes the key on disk.
+    # @param [#to_s] key the key of the storage slot in the database
+    def delete!(key)
+      delete key, true
+    end
+
     # Retrieve a value at key from the database. If the default value was specified
     # when this database was created, that value will be set and returned. Aliased
     # as <tt>get</tt>.
@@ -112,6 +126,7 @@ module Daybreak
       @writer.truncate!
       reset!
     end
+    alias_method :clear, :empty!
 
     # Force all queued commits to be written to disk.
     def flush!
@@ -138,7 +153,7 @@ module Daybreak
       copy_db  = self.class.new tmp_file.path
 
       # Copy the database key by key into the temporary table
-      each do |key, i|
+      each do |key|
         copy_db.set(key, get(key))
       end
       copy_db.close!
@@ -161,8 +176,19 @@ module Daybreak
     # call this again.
     def read!
       @reader.read do |record|
-        @table[record.key] = parse record.data
+        if record.deleted?
+          @table.delete record.key
+        else
+          @table[record.key] = parse(record.data)
+        end
       end
     end
+
+    private
+
+    def write(key, value, sync = false, delete = false)
+      @writer.write(Record.new(key, serialize(value), delete))
+      flush! if sync
+    end
   end
 end

data/lib/daybreak/record.rb

@@ -9,11 +9,19 @@ module Daybreak
     class CorruptDataError < Exception; end
     include Locking
 
+    # The mask a record uses to check for deletion.
+    DELETION_MASK = (1 << 31)
+
     attr_accessor :key, :data
 
-    def initialize(key = nil, data = nil)
+    def initialize(key = nil, data = nil, deleted = false)
       @key  = key
       @data = data
+      if deleted
+        @deleted = DELETION_MASK
+      else
+        @deleted = 0
+      end
     end
 
     # Read a record from an open io source, check the CRC, and set <tt>@key</tt>
@@ -21,8 +29,8 @@ module Daybreak
     # @param [#read] io an IO instance to read from
     def read(io)
       lock io do
-        @key  = read_bytes(io)
-        @data = read_bytes(io)
+        @key  = read_key(io)
+        @data = read_data(io)
         crc   = io.read(4)
         raise CorruptDataError, "CRC mismatch #{crc} should be #{crc_string}" unless crc == crc_string
       end
@@ -42,24 +50,38 @@ module Daybreak
       new.read(io)
     end
 
+    def deleted?
+      @deleted > 0
+    end
+
     private
 
     def byte_string
-      @byte_string ||= part(@key) + part(@data)
+      @byte_string ||= part(@key, @key.bytesize + @deleted) + part(@data, @data.bytesize)
     end
 
     def crc_string
       [Zlib.crc32(byte_string, 0)].pack('N')
     end
 
-    def read_bytes(io)
+    def read_data(io)
+      io.read read32(io)
+    end
+
+    def read_key(io)
+      masked   = read32 io
+      @deleted = masked & DELETION_MASK
+      length   = masked & (DELETION_MASK - 1)
+      io.read length
+    end
+
+    def read32(io)
       raw = io.read(4)
-      length = raw.unpack('N')[0]
-      io.read(length)
+      raw.unpack('N')[0]
     end
 
-    def part(data)
-      [data.bytesize].pack('N') + data
+    def part(data, length)
+      [length].pack('N') + data
     end
   end
 end

data/lib/daybreak/version.rb

@@ -1,4 +1,4 @@
 module Daybreak
   # Updated using SemVer
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/test/test.rb

@@ -77,6 +77,40 @@ describe "database functions" do
     assert_equal nil, db2['19']
   end
 
+  it "should compact subclassed dbs" do
+    class StringDB < Daybreak::DB
+      def serialize(it)
+        it.to_s
+      end
+
+      def parse(it)
+        it
+      end
+    end
+
+    db = StringDB.new 'string.db'
+    db[1] = 'one'
+    db[2] = 'two'
+    db.delete 2
+    db.compact!
+    assert_equal db[1], 'one'
+    assert_equal db[2], nil
+    db.empty!
+    db.close!
+  end
+
+  it "should handle deletions" do
+    @db[1] = 'one'
+    @db[2] = 'two'
+    @db.delete 'two'
+    assert !@db.has_key?('two')
+    assert_equal @db['two'], nil
+
+    db2 = Daybreak::DB.new DB_PATH
+    assert !db2.has_key?('two')
+    assert_equal db2['two'], nil
+  end
+
   after do
     @db.empty!
     @db.close!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: daybreak
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-27 00:00:00.000000000 Z
+date: 2013-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest