daybreak 0.0.1 → 0.0.2

data/daybreak.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test)/})
   gem.name          = "daybreak"
   gem.require_paths = ["lib"]
+  gem.licenses      = ["MIT"]
   gem.version       = Daybreak::VERSION
   gem.add_development_dependency 'simplecov'
   gem.add_development_dependency 'ruby-prof'

data/lib/daybreak/db.rb

@@ -11,7 +11,8 @@ module Daybreak
     # @param [String] file the path to the db file
     # @param default the default value to store and return when a key is
     #  not yet in the database.
-    # @yield [key] blk a block that will return the default value to store.
+    # @yield [key] a block that will return the default value to store.
+    # @yieldparam [String] key the key to be stored.
     def initialize(file, default=nil, &blk)
       @file_name = file
       reset!
@@ -60,6 +61,9 @@ module Daybreak
     alias_method :get, :"[]"
 
     # Iterate over the key, value pairs in the database.
+    # @yield [key, value] blk the iterator for each key value pair.
+    # @yieldparam [String] key the key.
+    # @yieldparam value the value from the database.
     def each(&blk)
       keys.each { |k| blk.call(k, get(k)) }
     end
@@ -70,6 +74,7 @@ module Daybreak
     end
 
     # Does this db have a value for this key?
+    # @param [key#to_s] key the key to check if the DB has a key.
     def has_key?(key)
       @table.has_key? key.to_s
     end
@@ -104,8 +109,8 @@ module Daybreak
 
     # Reset and empty the database file.
     def empty!
-      reset!
       @writer.truncate!
+      reset!
     end
 
     # Force all queued commits to be written to disk.

data/lib/daybreak/reader.rb

@@ -8,11 +8,13 @@ module Daybreak
       @file_name = file
     end
 
-    # Close's the Reader's file descriptor
+    # Close the Reader's file descriptor.
     def close!
       @fd.close unless @fd.nil?
     end
 
+    # Read all values from the aof file.
+    #
     # Right now this is really expensive, every call to read will
     # close and reread the whole db file, but since cross process
     # consistency is handled by the user, this should be fair warning.

data/lib/daybreak/record.rb

@@ -16,7 +16,8 @@ module Daybreak
       @data = data
     end
 
-    # Read a record from an open io source, check the CRC, and set @key and @data
+    # Read a record from an open io source, check the CRC, and set <tt>@key</tt>
+    # and <tt>@data</tt>.
     # @param [#read] io an IO instance to read from
     def read(io)
       lock io do
@@ -28,7 +29,7 @@ module Daybreak
       self
     end
 
-    # The serialized representation of the key value pair plus the CRC
+    # The serialized representation of the key value pair plus the CRC.
     # @return [String]
     def representation
       raise UnnacceptableDataError, "key and data must be defined" if @key.nil? || @data.nil?

data/lib/daybreak/version.rb

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

data/lib/daybreak/writer.rb

@@ -4,11 +4,9 @@ module Daybreak
   class Writer
     # Open up the file, ready it for binary and nonblocking writing.
     def initialize(file)
-      @fd = File.open file, 'a'
-      @fd.binmode
+      @file = file
 
-      f = @fd.fcntl(Fcntl::F_GETFL, 0)
-      @fd.fcntl(Fcntl::F_SETFL, Fcntl::O_NONBLOCK | f)
+      open!
 
       @worker = Worker.new(@fd)
     end
@@ -28,7 +26,7 @@ module Daybreak
       @worker.flush!
     end
 
-    # Finish writing and close the file descriptor
+    # Finish writing and close the file descriptor.
     def close!
       finish!
       @fd.close
@@ -36,11 +34,21 @@ module Daybreak
 
     # Truncate the file.
     def truncate!
+      flush!
       @fd.truncate(0)
+      open!
     end
 
     private
 
+    def open!
+      @fd = File.open @file, 'a'
+      @fd.binmode
+
+      f = @fd.fcntl(Fcntl::F_GETFL, 0)
+      @fd.fcntl(Fcntl::F_SETFL, Fcntl::O_NONBLOCK | f)
+    end
+
     # Workers handle the actual fiddly bits of asynchronous io and
     # and handle background writes.
     class Worker

data/test/prof.rb

@@ -4,7 +4,7 @@ require 'ruby-prof'
 
 result = RubyProf.profile do
   db = Daybreak::DB.new './t.db'
-  1000.times {|n| db[n] = n}
+  100000.times {|n| db[n] = n}
   db.flush!
 end
 

data/test/test.rb

@@ -59,10 +59,9 @@ describe "database functions" do
     db2.set! '1', 5
     @db.read!
     assert_equal @db['1'], 5
-    @db.close!
   end
 
-  it " should be able to handle another process's call to compact" do
+  it "should be able to handle another process's call to compact" do
     20.times {|i| @db.set i, i, true }
     db2 = Daybreak::DB.new DB_PATH
     20.times {|i| @db.set i, i + 1, true }
@@ -71,6 +70,13 @@ describe "database functions" do
     assert_equal 20, db2['19']
   end
 
+  it "can empty the database" do
+    20.times {|i| @db[i] = i }
+    @db.empty!
+    db2 = Daybreak::DB.new DB_PATH
+    assert_equal nil, db2['19']
+  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.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-19 00:00:00.000000000 Z
+date: 2012-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -71,7 +71,8 @@ files:
 - test/test.rb
 - test/test_helper.rb
 homepage: http://propublica.github.com/daybreak/
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -90,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Daybreak provides an in memory key-value store that is easily enumerable