perobs 4.5.0 → 4.6.0

data/lib/perobs/BigTreeNode.rb

@@ -1,5 +1,5 @@
-# encoding: UTF-8
-#
+# frozen_string_literal: true
+
 # = BigTreeNode.rb -- Persistent Ruby Object Store
 #
 # Copyright (c) 2016, 2017 by Chris Schlaeger <chris@taskjuggler.org>
@@ -25,11 +25,10 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-require 'perobs/Object'
-require 'perobs/Array'
+require_relative 'Object'
+require_relative 'Array'
 
 module PEROBS
-
   # The BigTreeNode class provides the BTree nodes for the BigTree objects.
   # A node can either be a branch node or a leaf node. Branch nodes don't
   # store values, only references to child nodes. Leaf nodes don't have child
@@ -38,9 +37,8 @@ module PEROBS
   # associated with a value or determines the lower key boundary for the
   # following child node.
   class BigTreeNode < PEROBS::Object
-
     attr_persist :tree, :parent, :keys, :values, :children,
-      :prev_sibling, :next_sibling
+                 :prev_sibling, :next_sibling
 
     # Internal constructor. Use Store.new(BigTreeNode, ...) instead.
     # @param p [Handle]
@@ -94,23 +92,19 @@ module PEROBS
       node = myself
 
       # Traverse the tree to find the right node to add or replace the value.
-      while node do
+      while node
         # All nodes that we find on the way that are full will be split into
         # two half-full nodes.
-        if node.keys.size >= @tree.node_size
-          node = node.split_node
-        end
+        node = node.split_node if node.keys.size >= @tree.node_size
 
         # Once we have reached a leaf node we can insert or replace the value.
-        if node.is_leaf?
-          return node.insert_element(key, value)
-        else
-          # Descend into the right child node to add the value to.
-          node = node.children[node.search_key_index(key)]
-        end
+        return node.insert_element(key, value) if node.is_leaf?
+
+        # Descend into the right child node to add the value to.
+        node = node.children[node.search_key_index(key)]
       end
 
-      PEROBS.log.fatal "Could not find proper node to insert into"
+      PEROBS.log.fatal 'Could not find proper node to insert into'
     end
 
     # Return the value that matches the given key or return nil if they key is
@@ -120,7 +114,7 @@ module PEROBS
     def get(key)
       node = self
 
-      while node do
+      while node
         # Find index of the entry that best fits the key.
         i = node.search_key_index(key)
         if node.is_leaf?
@@ -133,8 +127,8 @@ module PEROBS
         node = node.children[i]
       end
 
-      PEROBS.log.fatal "Could not find proper node to get from while " +
-        "looking for key #{key}"
+      PEROBS.log.fatal 'Could not find proper node to get from while ' \
+                       "looking for key #{key}"
     end
 
     # Return the node chain from the root to the leaf node storing the
@@ -143,9 +137,9 @@ module PEROBS
     # @return [Array of BigTreeNode] node list (may be empty)
     def node_chain(key)
       node = myself
-      list = [ node ]
+      list = [node]
 
-      while node do
+      while node
         # Find index of the entry that best fits the key.
         i = node.search_key_index(key)
         if node.is_leaf?
@@ -169,7 +163,7 @@ module PEROBS
     def has_key?(key)
       node = self
 
-      while node do
+      while node
         # Find index of the entry that best fits the key.
         i = node.search_key_index(key)
         if node.is_leaf?
@@ -182,8 +176,8 @@ module PEROBS
         node = node.children[i]
       end
 
-      PEROBS.log.fatal "Could not find proper node to get from while " +
-        "looking for key #{key}"
+      PEROBS.log.fatal 'Could not find proper node to get from while ' \
+                       "looking for key #{key}"
     end
 
     # Return the value that matches the given key and remove the value from
@@ -193,18 +187,16 @@ module PEROBS
     def remove(key)
       node = self
 
-      while node do
+      while node
         # Find index of the entry that best fits the key.
         i = node.search_key_index(key)
         if node.is_leaf?
           # This is a leaf node. Check if there is an exact match for the
           # given key and return the corresponding value or nil.
-          if node.keys[i] == key
-            @tree.entry_counter -= 1
-            return node.remove_element(i)
-          else
-            return nil
-          end
+          return nil if node.keys[i] != key
+
+          @tree.entry_counter -= 1
+          return node.remove_element(i)
         end
 
         # Descend into the right child node to continue the search.
@@ -217,10 +209,9 @@ module PEROBS
     # Iterate over all the key/value pairs in this node and all sub-nodes.
     # @yield [key, value]
     def each
-      traverse do |node, position, stack|
-        if node.is_leaf? && position < node.keys.size
+      traverse do |node, position, _|
+        node.is_leaf? && position < node.keys.size &&
           yield(node.keys[position], node.values[position])
-        end
       end
     end
 
@@ -252,7 +243,7 @@ module PEROBS
       branch_depth = nil
 
       traverse do |node, position, stack|
-        if position == 0
+        if position.zero?
           if node.parent
             # After a split the nodes will only have half the maximum keys.
             # For branch nodes one of the split nodes will have even 1 key
@@ -264,16 +255,16 @@ module PEROBS
           end
 
           if node.keys.size > @tree.node_size
-            node.error "BigTree node must not have more then " +
-              "#{@tree.node_size} keys, but has #{node.keys.size} keys"
+            node.error 'BigTree node must not have more then ' \
+                       "#{@tree.node_size} keys, but has #{node.keys.size} keys"
             return false
           end
 
           last_key = nil
           node.keys.each do |key|
             if last_key && key < last_key
-              node.error "Keys are not increasing monotoneously: " +
-                "#{node.keys.inspect}"
+              node.error 'Keys are not increasing monotoneously: ' \
+                         "#{node.keys.inspect}"
               return false
             end
             last_key = key
@@ -282,7 +273,7 @@ module PEROBS
           if node.is_leaf?
             if branch_depth
               unless branch_depth == stack.size
-                node.error "All leaf nodes must have same distance from root"
+                node.error 'All leaf nodes must have same distance from root'
                 return false
               end
             else
@@ -290,54 +281,54 @@ module PEROBS
             end
             if node.prev_sibling.nil?
               if @tree.first_leaf != node
-                node.error "Leaf node #{node._id} has no previous sibling " +
-                  "but is not the first leaf of the tree"
+                node.error "Leaf node #{node._id} has no previous sibling " \
+                           'but is not the first leaf of the tree'
                 return false
               end
             elsif node.prev_sibling.next_sibling != node
-              node.error "next_sibling of previous sibling does not point to " +
-                "this node"
+              node.error 'next_sibling of previous sibling does not point to ' \
+                         'this node'
               return false
             end
             if node.next_sibling.nil?
               if @tree.last_leaf != node
-                node.error "Leaf node #{node._id} has no next sibling " +
-                  "but is not the last leaf of the tree"
+                node.error "Leaf node #{node._id} has no next sibling " \
+                  'but is not the last leaf of the tree'
                 return false
               end
             elsif node.next_sibling.prev_sibling != node
-              node.error "previous_sibling of next sibling does not point to " +
-                "this node"
+              node.error 'previous_sibling of next sibling does not point to ' \
+                         'this node'
               return false
             end
             unless node.keys.size == node.values.size
-              node.error "Key count (#{node.keys.size}) and value " +
-                "count (#{node.values.size}) don't match"
-                return false
+              node.error "Key count (#{node.keys.size}) and value " \
+                        "count (#{node.values.size}) don't match"
+              return false
             end
             if node.children
-              node.error "children must be nil for a leaf node"
+              node.error 'children must be nil for a leaf node'
               return false
             end
           else
             if node.values
-              node.error "values must be nil for a branch node"
+              node.error 'values must be nil for a branch node'
               return false
             end
             unless node.children.size == node.keys.size + 1
-              node.error "Key count (#{node.keys.size}) must be one " +
-                "less than children count (#{node.children.size})"
-                return false
+              node.error "Key count (#{node.keys.size}) must be one " \
+                         "less than children count (#{node.children.size})"
+              return false
             end
             node.children.each_with_index do |child, i|
               unless child.is_a?(BigTreeNode)
-                node.error "Child #{i} is of class #{child.class} " +
-                  "instead of BigTreeNode"
+                node.error "Child #{i} is of class #{child.class} " \
+                           'instead of BigTreeNode'
                 return false
               end
               unless child.parent.is_a?(BigTreeNode)
-                node.error "Parent reference of child #{i} is of class " +
-                  "#{child.class} instead of BigTreeNode"
+                node.error "Parent reference of child #{i} is of class " \
+                           "#{child.class} instead of BigTreeNode"
                 return false
               end
               if child == node
@@ -349,25 +340,22 @@ module PEROBS
                 return false
               end
               unless child.parent == node
-                node.error "Child #{i} does not have parent pointing " +
-                  "to this node"
+                node.error "Child #{i} does not have parent pointing " \
+                           'to this node'
                 return false
               end
-              if i > 0
-                unless node.children[i - 1].next_sibling == child
-                  node.error "next_sibling of node " +
-                    "#{node.children[i - 1]._id} " +
-                    "must point to node #{child._id}"
-                  return false
-                end
+              if i.positive? && node.children[i - 1].next_sibling != child
+                node.error 'next_sibling of node ' \
+                           "#{node.children[i - 1]._id} " \
+                           "must point to node #{child._id}"
+                return false
               end
-              if i < node.children.length - 1
-                unless child == node.children[i + 1].prev_sibling
-                  node.error "prev_sibling of node " +
-                    "#{node.children[i + 1]._id} " +
-                    "must point to node #{child._id}"
-                  return false
-                end
+              if i < node.children.length - 1 &&
+                 child != node.children[i + 1].prev_sibling
+                node.error 'prev_sibling of node ' \
+                           "#{node.children[i + 1]._id} " \
+                           "must point to node #{child._id}"
+                return false
               end
             end
           end
@@ -382,15 +370,15 @@ module PEROBS
             end
           else
             unless node.children[index].keys.last < node.keys[index]
-              node.error "Child #{node.children[index]._id} " +
-                "has too large key #{node.children[index].keys.last}. " +
-                "Must be smaller than #{node.keys[index]}."
+              node.error "Child #{node.children[index]._id} " \
+                         "has too large key #{node.children[index].keys.last}. " \
+                         "Must be smaller than #{node.keys[index]}."
               return false
             end
             unless node.children[position].keys.first >= node.keys[index]
-              node.error "Child #{node.children[position]._id} " +
-                "has too small key #{node.children[position].keys.first}. " +
-                "Must be larger than or equal to #{node.keys[index]}."
+              node.error "Child #{node.children[position]._id} " \
+                         "has too small key #{node.children[position].keys.first}. " \
+                        "Must be larger than or equal to #{node.keys[index]}."
               return false
             end
           end
@@ -404,12 +392,12 @@ module PEROBS
     def to_s
       str = ''
 
-      traverse do |node, position, stack|
-        if position == 0
+      traverse do |node, position, _|
+        if position.zero?
           begin
-            str += "#{node.parent ? node.parent.tree_prefix + '  +' : 'o'}" +
-              "#{node.tree_branch_mark}-" +
-              "#{node.keys.first.nil? ? '--' : 'v-'}#{node.tree_summary}\n"
+            str += "#{node.parent ? node.parent.tree_prefix + '  +' : 'o'}" \
+                   "#{node.tree_branch_mark}-" \
+                   "#{node.keys.first.nil? ? '--' : 'v-'}#{node.tree_summary}\n"
           rescue => e
             str += "@@@@@@@@@@: #{e.message}\n"
           end
@@ -417,14 +405,12 @@ module PEROBS
           begin
             if node.is_leaf?
               if node.keys[position - 1]
-                str += "#{node.tree_prefix}  |" +
-                  "[#{node.keys[position - 1]}, " +
+                str += "#{node.tree_prefix}  |" \
+                  "[#{node.keys[position - 1]}, " \
                   "#{node.values[position - 1]}]\n"
               end
-            else
-              if node.keys[position - 1]
-                str += "#{node.tree_prefix}  #{node.keys[position - 1]}\n"
-              end
+            elsif node.keys[position - 1]
+              str += "#{node.tree_prefix}  #{node.keys[position - 1]}\n"
             end
           rescue => e
             str += "@@@@@@@@@@: #{e.message}\n"
@@ -518,10 +504,9 @@ module PEROBS
     def remove_element(index)
       # Delete the key at the specified index.
       unless (key = @keys.delete_at(index))
-        PEROBS.log.fatal "Could not remove element #{index} from BigTreeNode " +
-          "@#{@_id}"
+        PEROBS.log.fatal "Could not remove element #{index} from BigTreeNode @#{@_id}"
       end
-      update_branch_key(key) if index == 0
+      update_branch_key(key) if index.zero?
 
       # Delete the corresponding value.
       removed_value = @values.delete_at(index)
@@ -533,7 +518,7 @@ module PEROBS
           borrow_from_next_sibling(@next_sibling) ||
             merge_with_leaf_node(@next_sibling)
         elsif @parent
-          PEROBS.log.fatal "Cannot not find adjecent leaf siblings"
+          PEROBS.log.fatal 'Cannot not find adjecent leaf siblings'
         end
       end
 
@@ -549,7 +534,7 @@ module PEROBS
         PEROBS.log.fatal "Cannot remove child #{node._id} from node #{@_id}"
       end
 
-      if index == 0
+      if index.zero?
         # Removing the first child is a bit more complicated as the
         # corresponding branch key is in a parent node.
         key = @keys.shift
@@ -592,7 +577,7 @@ module PEROBS
 
     def merge_with_leaf_node(node)
       if @keys.length + node.keys.length > @tree.node_size
-        PEROBS.log.fatal "Leaf nodes are too big to merge"
+        PEROBS.log.fatal 'Leaf nodes are too big to merge'
       end
 
       self.keys += node.keys
@@ -603,7 +588,7 @@ module PEROBS
 
     def merge_with_branch_node(node)
       if @keys.length + 1 + node.keys.length > @tree.node_size
-        PEROBS.log.fatal "Branch nodes are too big to merge"
+        PEROBS.log.fatal 'Branch nodes are too big to merge'
       end
 
       index = @parent.search_node_index(node) - 1
@@ -670,9 +655,9 @@ module PEROBS
     def traverse
       # We use a non-recursive implementation to traverse the tree. This stack
       # keeps track of all the known still to be checked nodes.
-      stack = [ [ self, 0 ] ]
+      stack = [[self, 0]]
 
-      while !stack.empty?
+      until stack.empty?
         node, position = stack.pop
 
         # Call the payload method. The position marks where we are in the node
@@ -684,15 +669,15 @@ module PEROBS
         # to return to the parent node.
         yield(node, position, stack)
 
-        if position <= node.keys.size
-          # Push the next position for this node onto the stack.
-          stack.push([ node, position + 1 ])
+        next unless position <= node.keys.size
 
-          if !node.is_leaf? && node.children[position]
-            # If we have a child node for this position, push the linked node
-            # and the starting position onto the stack.
-            stack.push([ node.children[position], 0 ])
-          end
+        # Push the next position for this node onto the stack.
+        stack.push([node, position + 1])
+
+        if !node.is_leaf? && node.children[position]
+          # If we have a child node for this position, push the linked node
+          # and the starting position onto the stack.
+          stack.push([node.children[position], 0])
         end
       end
     end
@@ -701,16 +686,12 @@ module PEROBS
     # @param stats [Stats] Data structure that stores the gathered data
     def statistics(stats)
       traverse do |node, position, stack|
-        if position == 0
+        if position.zero?
           if node.is_leaf?
             stats.leaf_nodes += 1
             depth = stack.size + 1
-            if stats.min_depth.nil? || stats.min_depth < depth
-              stats.min_depth = depth
-            end
-            if stats.max_depth.nil? || stats.max_depth > depth
-              stats.max_depth = depth
-            end
+            stats.min_depth = depth if stats.min_depth.nil? || stats.min_depth < depth
+            stats.max_depth = depth if stats.max_depth.nil? || stats.max_depth > depth
           else
             stats.branch_nodes += 1
           end
@@ -743,6 +724,7 @@ module PEROBS
     # Branch node decoration for the inspection method.
     def tree_branch_mark
       return '' unless @parent
+
       '-'
     end
 
@@ -866,8 +848,5 @@ module PEROBS
 
       # The smallest element has no branch key.
     end
-
   end
-
 end
-

data/lib/perobs/ClassMap.rb

@@ -60,6 +60,12 @@ module PEROBS
       @by_id[id]
     end
 
+    # Get a list of all classes used in the Store.
+    # @return [Array] list of Ruby classes
+    def classes
+      @by_class.keys
+    end
+
     # Rename a set of classes to new names.
     # @param rename_map [Hash] Hash that maps old names to new names
     def rename(rename_map)

data/lib/perobs/DataBase.rb

@@ -34,18 +34,23 @@ require 'fileutils'
 
 require 'perobs/Log'
 require 'perobs/ObjectBase'
+require_relative 'ProgressMeter'
 
 module PEROBS
-
   # Base class for all storage back-ends.
   class DataBase
-
     # Create a new DataBase object. This method must be overwritten by the
     # deriving classes and then called via their constructor.
     def initialize(options)
       @serializer = options[:serializer] || :json
       @progressmeter = options[:progressmeter] || ProgressMeter.new
       @config = {}
+      @class_map = nil
+    end
+
+    # Register the class map object needed to de-serialize objects.
+    def register_class_map(class_map)
+      @class_map = class_map
     end
 
     # A dummy open method. Deriving classes must overload them to insert their
@@ -81,19 +86,21 @@ module PEROBS
     # @param raw [String]
     # @return [Hash] Deserialized version
     def deserialize(raw)
-      begin
-        case @serializer
-        when :marshal
-          Marshal.load(raw)
-        when :json
-          JSON.parse(raw, :create_additions => true)
-        when :yaml
+      case @serializer
+      when :marshal
+        Marshal.load(raw)
+      when :json
+        JSON.parse(raw, create_additions: true)
+      when :yaml
+        if RUBY_VERSION < '3.2'
           YAML.load(raw)
+        else
+          YAML.load(raw, permitted_classes: [Symbol, POReference] + @class_map.classes)
         end
-      rescue => e
-        PEROBS.log.fatal "Cannot de-serialize object with #{@serializer} " +
-          "parser: " + e.message
       end
+    rescue => e
+      PEROBS.log.fatal "Cannot de-serialize object with #{@serializer} " +
+        "parser: " + e.message
     end
 
     # Check a config option and adjust it if needed.
@@ -127,7 +134,5 @@ module PEROBS
         end
       end
     end
-
   end
-
 end

data/lib/perobs/IDList.rb

@@ -46,7 +46,7 @@ module PEROBS
     #        that will be kept in memory. If the list is larger, values will
     #        be cached in the specified file.
     # @param page_size [Integer] The number of values per page. The default
-    #        value is 32 which was found the best performing config in  tests.
+    #        value is 32 which was found the best performing config in tests.
     def initialize(dir, name, max_in_memory, page_size = 32)
       # The page_file manages the pages that store the values.
       @page_file = IDListPageFile.new(self, dir, name,
@@ -63,7 +63,7 @@ module PEROBS
       page = @page_records[index]
 
       # In case the page is already full we'll have to create a new page.
-      # There is no guarantee that a split will yield an page with space as we
+      # There is no guarantee that a split will yield a page with space as we
       # split by ID range, not by distributing the values evenly across the
       # two pages.
       while page.is_full?

data/lib/perobs/Store.rb

@@ -157,6 +157,7 @@ module PEROBS
       # Create a map that can translate classes to numerical IDs and vice
       # versa.
       @class_map = ClassMap.new(@db)
+      @db.register_class_map(@class_map)
 
       # List of PEROBS objects that are currently available as Ruby objects
       # hashed by their ID.
@@ -712,4 +713,3 @@ module PEROBS
   end
 
 end
-

data/lib/perobs/version.rb

@@ -1,4 +1,4 @@
 module PEROBS
   # The version number
-  VERSION = "4.5.0"
+  VERSION = "4.6.0"
 end

data/perobs.gemspec

@@ -16,9 +16,10 @@ GEM_SPEC = Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = '>=2.4'
+  spec.required_ruby_version = '>=2.5'
 
-  spec.add_development_dependency 'bundler', '~> 2.3'
+  spec.add_development_dependency 'bundler', '~> 2.2'
   spec.add_development_dependency 'yard', '~>0.9.12'
   spec.add_development_dependency 'rake', '~> 13.0.3'
+  spec.add_development_dependency 'rspec', '~> 3.12'
 end