daybreak 0.1.1 → 0.1.2

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - ruby-head
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode

data/README

@@ -5,10 +5,10 @@
 
 Daybreak is a simple key value store for ruby. It has user defined persistence,
 and all data is stored in a table in memory so ruby niceties are available.
-Daybreak is faster than other options ruby options like pstore and dbm.
+Daybreak is faster than other ruby options like pstore and dbm.
 
 $ gem install daybreak
 
 Docs: http://propublica.github.com/daybreak/
 Issue Tracker: http://propublica.github.com/daybreak/issues
-Benchmarks: https://gist.github.com/4146590
+Benchmarks: https://gist.github.com/4146590

data/daybreak.gemspec

@@ -14,7 +14,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.licenses      = ["MIT"]
   gem.version       = Daybreak::VERSION
+  gem.add_development_dependency 'rake'
   gem.add_development_dependency 'minitest'
-  gem.add_development_dependency 'simplecov'
-  gem.add_development_dependency 'ruby-prof'
 end

data/lib/daybreak.rb

@@ -1,17 +1,11 @@
-# Daybreak, a simple dimple key value store for ruby.
-module Daybreak
-  # The root path for Daybreak
-  ROOT = File.expand_path(File.dirname(__FILE__))
-end
-
 require 'tempfile'
 require 'thread'
-require 'zlib'
 require 'fcntl'
+require 'zlib'
 
-require "#{Daybreak::ROOT}/daybreak/version"
-require "#{Daybreak::ROOT}/daybreak/locking"
-require "#{Daybreak::ROOT}/daybreak/record"
-require "#{Daybreak::ROOT}/daybreak/writer"
-require "#{Daybreak::ROOT}/daybreak/reader"
-require "#{Daybreak::ROOT}/daybreak/db"
+require 'daybreak/version'
+require 'daybreak/locking'
+require 'daybreak/record'
+require 'daybreak/writer'
+require 'daybreak/reader'
+require 'daybreak/db'

data/lib/daybreak/db.rb

@@ -14,10 +14,11 @@ module Daybreak
     # @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)
+      @table  = {}
       @file_name = file
-      reset!
-      @default = default
-      @default = blk if block_given?
+      @reader = Reader.new(@file_name)
+      @writer = Writer.new(@file_name)
+      @default = block_given? ? blk : default
       read!
     end
 
@@ -64,12 +65,7 @@ module Daybreak
       if @table.has_key? key
         @table[key]
       elsif default?
-        if @default.is_a? Proc
-          value = @default.call(key)
-        else
-          value = @default
-        end
-        set key, value
+        set key, Proc === @default ? @default.call(key) : @default
       end
     end
     alias_method :get, :"[]"
@@ -78,8 +74,8 @@ module Daybreak
     # @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)) }
+    def each
+      keys.each { |k| yield(k, get(k)) }
     end
 
     # Does this db have a default value.
@@ -104,6 +100,7 @@ module Daybreak
     def length
       @table.keys.length
     end
+    alias_method :size, :length
 
     # Serialize the data for writing to disk, if you don't want to use <tt>Marshal</tt>
     # overwrite this method.
@@ -121,11 +118,10 @@ module Daybreak
       Marshal.load(value)
     end
 
-    # Reset and empty the database file.
+    # Empty the database file.
     def empty!
       @writer.truncate!
-      close!
-      reset!
+      @table.clear
       read!
     end
     alias_method :clear, :empty!
@@ -135,53 +131,42 @@ module Daybreak
       @writer.flush!
     end
 
-    # Reset the state of the database, you should call <tt>read!</tt> after calling this.
-    def reset!
-      @table  = {}
-      @writer = Daybreak::Writer.new(@file_name)
-      @reader = Daybreak::Reader.new(@file_name)
-    end
-
     # Close the database for reading and writing.
     def close!
       @writer.close!
-      @reader.close!
     end
 
     # Compact the database to remove stale commits and reduce the file size.
     def compact!
-      # Create a new temporary file
-      tmp_file = Tempfile.new File.basename(@file_name)
-      copy_db  = self.class.new tmp_file.path
+      # Create a new temporary database
+      tmp_file = @file_name + "-#{$$}-#{Thread.current.object_id}"
+      copy_db  = self.class.new tmp_file
 
       # Copy the database key by key into the temporary table
-      each do |key|
+      each do |key, value|
         copy_db.set(key, get(key))
       end
       copy_db.close!
 
-      # Empty this database
-      empty!
       close!
 
       # Move the copy into place
-      tmp_file.close
-      FileUtils.mv tmp_file.path, @file_name
-      tmp_file.unlink
+      File.rename tmp_file, @file_name
 
-      # Reset this database
-      reset!
+      # Reopen this database
+      @writer = Writer.new(@file_name)
+      @table.clear
       read!
     end
 
     # Read all values from the log file. If you want to check for changed data
     # call this again.
     def read!
-      @reader.read do |record|
-        if record.deleted?
-          @table.delete record.key
+      @reader.read do |(key, data, deleted)|
+        if deleted
+          @table.delete key
         else
-          @table[record.key] = parse(record.data)
+          @table[key] = parse(data)
         end
       end
     end
@@ -189,7 +174,7 @@ module Daybreak
     private
 
     def write(key, value, sync = false, delete = false)
-      @writer.write(Record.new(key, serialize(value), delete))
+      @writer.write([key, serialize(value), delete])
       flush! if sync
     end
   end

data/lib/daybreak/reader.rb

@@ -8,30 +8,19 @@ module Daybreak
       @file_name = file
     end
 
-    # Close the Reader's file descriptor.
-    def close!
-      @fd.close unless @fd.nil? || !@fd.closed?
-    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.
-    def read(&blk)
-      open!
-      while !@fd.eof?
-        blk.call(Record.read(@fd))
+    def read
+      File.open(@file_name, 'r') do |fd|
+        fd.binmode
+        fd.advise(:sequential) if fd.respond_to? :advise
+        while !fd.eof?
+          yield Record.read(fd)
+        end
       end
-      close!
-    end
-
-    private
-
-    def open!
-      @fd = File.open @file_name, 'r'
-      @fd.binmode
-      @fd.advise(:sequential) if @fd.respond_to? :advise
     end
   end
 end

data/lib/daybreak/record.rb

@@ -1,87 +1,67 @@
 module Daybreak
   # Records define how data is serialized and read from disk.
-  class Record
+  module Record
     # Thrown when either key or data is missing
     class UnnacceptableDataError < Exception; end
 
     # Thrown when there is a CRC mismatch between the data from the disk
     # and what was written to disk previously.
     class CorruptDataError < Exception; end
-    include Locking
 
-    # The mask a record uses to check for deletion.
-    DELETION_MASK = (1 << 31)
-
-    attr_accessor :key, :data
+    extend self
+    extend Locking
 
-    def initialize(key = nil, data = nil, deleted = false)
-      @key  = key
-      @data = data
-      if deleted
-        @deleted = DELETION_MASK
-      else
-        @deleted = 0
-      end
-    end
+    # The mask a record uses to check for deletion.
+    DELETION_MASK = 1 << 31
 
     # 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
-        @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
-      self
-    end
 
     # 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?
-      byte_string + crc_string
+    def serialize(record)
+      raise UnnacceptableDataError, 'key and data must be defined' unless record[0] && record[1]
+      s = key_data_string(record)
+      s << crc_string(s)
     end
 
     # Create a new record to read from IO.
     # @param [#read] io an IO instance to read from
-    def self.read(io)
-      new.read(io)
-    end
-
-    def deleted?
-      @deleted > 0
+    def read(io)
+      lock io do
+        record = []
+        masked = read32(io)
+        # Read the record's key bytes
+        record << io.read(masked & (DELETION_MASK - 1)) <<
+          # Read the record's value bytes
+          io.read(read32(io)) <<
+          # Set the deletion flag
+          ((masked & DELETION_MASK) != 0)
+        crc = io.read(4)
+        raise CorruptDataError, 'CRC mismatch' unless crc == crc_string(key_data_string(record))
+        record
+      end
     end
 
     private
 
-    def byte_string
-      @byte_string ||= part(@key, @key.bytesize + @deleted) + part(@data, @data.bytesize)
-    end
-
-    def crc_string
-      [Zlib.crc32(byte_string, 0)].pack('N')
+    # Return the deletion flag plus two length prefixed cells
+    def key_data_string(record)
+      part(record[0], record[0].bytesize + (record[2] ? DELETION_MASK : 0)) << part(record[1], record[1].bytesize)
     end
 
-    def read_data(io)
-      io.read read32(io)
+    def crc_string(s)
+      [Zlib.crc32(s, 0)].pack('N')
     end
 
-    def read_key(io)
-      masked   = read32 io
-      @deleted = masked & DELETION_MASK
-      length   = masked & (DELETION_MASK - 1)
-      io.read length
+    def part(data, length)
+      [length].pack('N') << data
     end
 
     def read32(io)
       raw = io.read(4)
       raw.unpack('N')[0]
     end
-
-    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.1.1"
+  VERSION = "0.1.2"
 end

data/lib/daybreak/writer.rb

@@ -5,9 +5,7 @@ module Daybreak
     # Open up the file, ready it for binary and nonblocking writing.
     def initialize(file)
       @file = file
-
       open!
-
       @worker = Worker.new(@fd)
     end
 
@@ -65,20 +63,20 @@ module Daybreak
 
       # Queue up a write to be committed later.
       def enqueue(record)
-        @queue << record.representation
+        @queue << record
       end
 
       # Loop and block if we don't have work to do or if
       # the file isn't ready for another write just yet.
       def work
-        buf = ""
+        buf = ''
         loop do
-          str = @queue.pop
-          if str.nil?
+          record = @queue.pop
+          unless record
             @fd.flush
             break
           end
-          buf << str
+          buf << Record.serialize(record)
           read, write = IO.select [], [@fd]
           if write and fd = write.first
             lock(fd, File::LOCK_EX) { buf = try_write fd, buf }
@@ -98,7 +96,7 @@ module Daybreak
           if s < buf.length
             buf = buf[s..-1] # didn't finish
           else
-            buf = ""
+            buf = ''
           end
         rescue Errno::EAGAIN
           buf = buf # try this again

data/test/test.rb

@@ -1,8 +1,12 @@
-require 'rubygems'
-require 'simplecov'
 require 'set'
-SimpleCov.start
-SimpleCov.command_name "Unit tests"
+
+begin
+  require 'simplecov'
+  SimpleCov.start
+  SimpleCov.command_name "Unit tests"
+rescue Exception => ex
+  puts "No coverage report generated: #{ex.message}"
+end
 
 require File.expand_path(File.dirname(__FILE__)) + '/test_helper.rb'
 

data/test/test_helper.rb

@@ -4,4 +4,5 @@ require 'minitest/benchmark'
 HERE = File.expand_path(File.dirname(__FILE__))
 DB_PATH = File.join HERE, "test.db"
 
-require File.join HERE, '..', 'lib', 'daybreak'
+$: << File.join(HERE, '..', 'lib')
+require 'daybreak'

metadata

@@ -1,72 +1,63 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: daybreak
-version: !ruby/object:Gem::Version
+version: !ruby/object:Gem::Version 
+  hash: 31
   prerelease: 
-  version: 0.1.1
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
 platform: ruby
-authors:
+authors: 
 - Jeff Larson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-07 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-    none: false
-  name: minitest
-  type: :development
+
+date: 2013-01-07 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-    none: false
-- !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-  name: simplecov
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: minitest
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-    none: false
-- !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-  name: ruby-prof
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-    none: false
+  version_requirements: *id002
 description: A simple dimple key-value store for ruby.
-email:
+email: 
 - thejefflarson@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
+- .travis.yml
 - .yardopts
 - EPIGRAPH
 - Gemfile
@@ -86,36 +77,43 @@ files:
 - test/prof.rb
 - test/test.rb
 - test/test_helper.rb
+has_rdoc: true
 homepage: http://propublica.github.com/daybreak/
-licenses:
+licenses: 
 - MIT
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-required_rubygems_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: Daybreak provides an in memory key-value store that is easily enumerable
-  in ruby.
-test_files:
+summary: Daybreak provides an in memory key-value store that is easily enumerable in ruby.
+test_files: 
 - test/bench.rb
 - test/compare.rb
 - test/prof.rb
 - test/test.rb
 - test/test_helper.rb
-has_rdoc: