rubcask 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7d54e3884c99955ecbab6624997f84c8469d1f60ad73a34631e206efffebbeb
-  data.tar.gz: d2c62d450a8ebd9abfc5e12ac26c2747365afbe98ff72fe8117fc8659c02b1d0
+  metadata.gz: '0568bcb47da50a78d9679c88b735cb5b2c259efb00297bb87f749463520cb371'
+  data.tar.gz: 210aaa3e1dd5eb5b0dd26a105f3151717661ff92f24ff54ded3077306b07b838
 SHA512:
-  metadata.gz: 6be6603b4238edd7a93548e6440c4dcee3263afb254b40999b774e7b8e60dc39d021457bd88a4f3cc0017a2812685c48d574aacbc1f35a0ae0eda35c46fad468
-  data.tar.gz: 57e451dd32e7e555e6692bbaf441370a90df623cffef4aa52169db0869ad1b99650372e20abed61ca0eefe3f1247ca4e8ae39f06d3a142d2b932713387c787dc
+  metadata.gz: f52adc24589f583eb1e777c5fe42c1c672e9b2c39e6cd2da5ca75f9be61d7c208a90d146a43adee28978c6217e3557e3b2c89a4290051f10fc2bf92290ab3d6c
+  data.tar.gz: 626f339669b988a5f844b90285e92985122a08d6144d22bd1a311411ca298876656ef375b13e4230da1c49edb00120191d53d046358fef107e13b34ab1634812

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubcask (0.1.0)
+    rubcask (0.2.0)
       concurrent-ruby (~> 1.1)
 
 GEM
@@ -9,7 +9,7 @@ GEM
   specs:
     ast (2.4.2)
     benchmark-ips (2.10.0)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.0)
     docile (1.4.0)
     json (2.6.3)
     json (2.6.3-java)

data/lib/rubcask/data_file.rb

@@ -22,18 +22,35 @@ module Rubcask
       @write_pos = file_size
     end
 
+    # @!macro [new] might_change_pos
+    #   @note Calling this method might change `pos` of the `file`
+
+    # @!macro [new] no_change_pos
+    #   @note Calling this method will not change `pos` of the `file`
+
+    # @!macro [new] read_result_return
+    #   @return [DataEntry]
+    #   @return [nil] if at the end of file
+    #   @raise [ChecksumError] if the entry has an incorrect checksum
+
     # Fetch entry at given offset.
-    # Optional size parameter is size of the record. With it we make one less I/O
+    # With optional size parameter we can do less I/O operations.
+    # @macro might_change_pos
     # @param [Integer] offset File offset in bytes
-    # @param [Integer, nil] size Record size in bytes
+    # @param [Integer, nil] size Entry size in bytes
+    # @macro read_result_return
     def [](offset, size = nil)
-      seek(offset)
-      read(size)
+      if size.nil?
+        seek(offset)
+        return read
+      end
+      pread(offset, size)
     end
 
-    # yields each record in the file
+    # yields each entry in the file
+    # @macro might_change_pos
     # @return [Enumerator] if no block given
-    # @yieldparam [DataEntry]
+    # @yieldparam [DataEntry] data_entry Entry from the file
     def each
       return to_enum(__method__) unless block_given?
 
@@ -46,28 +63,30 @@ module Rubcask
       end
     end
 
-    # Read entry at the current file position
-    # @return [DataEntry]
-    # @return [nil] if at the end of file
-    # @raise [ChecksumError] if the entry has an incorrect checksum
+    # Read an entry at the current file position
+    # @macro might_change_pos
+    # @param [Integer, nil] size Entry size in bytes
+    # @macro read_result_return
     def read(size = nil)
-      io = size ? StringIO.new(@file.read(size)) : @file
-      header = io.read(18)
-
-      return nil unless header
-
-      crc, expire_timestamp, key_size, value_size = header.unpack(HEADER_FORMAT)
-      key = io.read(key_size)
-      value = io.read(value_size)
+      read_from_io(
+        size ? StringIO.new(@file.read(size)) : @file
+      )
+    end
 
-      raise ChecksumError, "Checksums do not match" if crc != Zlib.crc32(header[4..] + key + value)
-      DataEntry.new(expire_timestamp, key, value)
+    # Fetch an entry at given offset and with provided size
+    # @macro no_change_pos
+    # @param [Integer] offset File offset in bytes
+    # @param [Integer] size Entry size in bytes
+    # @macro read_result_return
+    def pread(offset, size)
+      read_from_io(StringIO.new(@file.pread(size, offset)))
     end
 
     AppendResult = Struct.new(:value_pos, :value_size)
-    # Append a record at the end of the file
+    # Append an entry at the end of the file
+    # @macro no_change_pos
     # @param [DataEntry] entry Entry to write to the file
-    # @return [AppendResult] struct containing position and size of the record
+    # @return [AppendResult] struct containing position and size of the entry
     def append(entry)
       current_pos = @write_pos
 
@@ -87,5 +106,20 @@ module Rubcask
       @file.flush
       AppendResult.new(current_pos, @write_pos - current_pos)
     end
+
+    private
+
+    def read_from_io(io)
+      header = io.read(18)
+
+      return nil unless header
+
+      crc, expire_timestamp, key_size, value_size = header.unpack(HEADER_FORMAT)
+      key = io.read(key_size)
+      value = io.read(value_size)
+
+      raise ChecksumError, "Checksums do not match" if crc != Zlib.crc32(header[4..] + key + value)
+      DataEntry.new(expire_timestamp, key, value)
+    end
   end
 end

data/lib/rubcask/directory.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
-require "concurrent"
+require "concurrent/atomic/atomic_fixnum"
+require "concurrent/atomic/reentrant_read_write_lock"
 
+require "fiber" # rubocop:disable Lint/RedundantRequireStatement It is needed for `Fiber.current`(used by concurrent) in some rubies
 require "forwardable"
 require "logger"
 require "monitor"
@@ -131,11 +133,11 @@ module Rubcask
         end
 
         data_file = @files[entry.file_id]
-        data_file.synchronize do
-          value = data_file[entry.value_pos, entry.value_size].value
-          return nil if Tombstone.is_tombstone?(value)
-          return value
-        end
+
+        # We are using pread so there's no need to synchronize the read
+        value = data_file.pread(entry.value_pos, entry.value_size).value
+        return nil if Tombstone.is_tombstone?(value)
+        return value
       end
     end
 
@@ -190,21 +192,16 @@ module Rubcask
     # @yieldparam [String] value
     # @macro lock_block_for_iteration
     # @macro key_any_order
-    # @return Enumerator if block not given
+    # @return [Enumerator<Array(String, String)>] if no block given
     def each
       return to_enum(__method__) unless block_given?
 
       @lock.with_read_lock do
         @keydir.each do |key, entry|
           file = @files[entry.file_id]
-          file.mon_enter
-          begin
-            value = file[entry.value_pos, entry.value_size].value
-            next if Tombstone.is_tombstone?(value)
-            yield [key, value]
-          ensure
-            file.mon_exit
-          end
+          value = file[entry.value_pos, entry.value_size].value
+          next if Tombstone.is_tombstone?(value)
+          yield [key, value]
         end
       end
     end
@@ -213,7 +210,7 @@ module Rubcask
     # @macro deleted_keys
     # @macro key_any_order
     # @macro lock_block_for_iteration
-    # @return Enumerator if block not given
+    # @return [Enumerator<String>] if no block given
     def each_key(&block)
       return to_enum(__method__) unless block
 

data/lib/rubcask/hinted_file.rb

@@ -13,7 +13,7 @@ module Rubcask
     ID_REGEX = /(\d+)\.data$/
     HINT_EXTENSION_REGEX = /\.data$/
 
-    def_delegators :@data_file, :seek, :[], :close, :flush, :each, :pos, :write_pos
+    def_delegators :@data_file, :seek, :[], :pread, :close, :flush, :each, :pos, :write_pos
 
     # @return [String] path of the file
     attr_reader :path

data/lib/rubcask/server/abstract_server.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "stringio"
+
 require_relative "../bytes"
 require_relative "../protocol"
 require_relative "config"

data/lib/rubcask/server/runner.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require "concurrent"
+require "concurrent/timer_task"
+
 require_relative "./config"
 require_relative "./runner/config"
 require_relative "../config"

data/lib/rubcask/server/threaded.rb

@@ -3,7 +3,6 @@
 require "logger"
 require "socket"
 require "io/wait"
-require "stringio"
 
 require_relative "../bytes"
 require_relative "../protocol"

data/lib/rubcask/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rubcask
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubcask
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Marcin Henryk Bartkowiak
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-28 00:00:00.000000000 Z
+date: 2023-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby