carton_db 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e7ba5f88cc93515fb05ed0ef3a77763387b9b4e
-  data.tar.gz: 9fc367bfbe054f2bb4bb553cb61653e86a4e2690
+  metadata.gz: bbf7e47a17f6d3f6f19bb40d4a13524cc2704cd0
+  data.tar.gz: 26098104742787b3bfa8bf0b01b8274a7cdb8e13
 SHA512:
-  metadata.gz: 0fb470b19985adbd257994ab07982f45966e3c8a4c261b212e29e1e2984e1a81fec30f4a07a43814d584754daf03b3db1e4ed54618bb24bbeae991f60fb1894f
-  data.tar.gz: d3a179c84ab03bac558c59d3c5df3e1cbf6c5a7beb8510aba89d85c67c28842016a818f264e0ba982a4af7b173d758f31c41d39e2005a9353cd1c71e24f6a9e3
+  metadata.gz: f00b6ad528b7ec75286244bffce56ee467eeaf2e8c470a6db680e1002c242a7130b0225c77e5a4d7e853d3e1ffbfa59cdedc554e95cab6095a6c25778bbd3632
+  data.tar.gz: 1b7c46564dae0037b6c12dfea983e4d780e2720e70a670b65ee174e08264689434ff37d7fb2c55856088375b05be1eb1e16bc8c448b2b2480d5bc3d213ebff73

data/README.md

@@ -21,13 +21,14 @@ for a relational database server, and I didn't want to add one
 just for this requirement. A redis db with sufficient capacity
 would have been expensive, and solutions such as SQLite are
 specifically not supported by Heroku so people don't mistakenly
-expect the data to be preserved. Ruby's `DBM` and `SDMB` proved
-to be too unpredicatable and flakey to be practical solutions.
+expect the data to be preserved. Ruby's `PStore`, `DBM` and
+`SDMB` each proved to be too unpredicatable and flakey to be
+practical solutions.
 
 Although this tool was initially developed to store transient
 data for use within a single process invocation and then
-discarded, it is also quite well suited for long term data
-storage on a system that preserves filesystem data over time.
+discarded, it is also well suited for long term data storage on a
+system that retains filesystem contents.
 
 ## Installation
 

data/lib/carton_db/datum.rb

@@ -5,6 +5,7 @@ module CartonDb
   module Datum
 
     def self.for_plain(plain_text, auto_placeholder: false)
+      return plain_text if plain_text.is_a?(Datum::Base)
       if auto_placeholder && plain_text.nil?
         Datum::Placeholder
       else
@@ -13,6 +14,7 @@ module CartonDb
     end
 
     def self.for_escaped(escaped_text, auto_placeholder: false)
+      return escaped_text if escaped_text.is_a?(Datum::Base)
       if auto_placeholder && escaped_text.nil?
         Datum::Placeholder
       else

data/lib/carton_db/list_map_db.rb

@@ -27,6 +27,14 @@ module CartonDb
     # The directory for the database will be created if it does
     # not already exist.
     #
+    # The parent directory is assumed to already exist, and an
+    # exception will be raised if it does not.
+    #
+    # Other instance methods assume that the directory exists but
+    # make no other assumptions about the state of the persisted
+    # data, and an empty directory is a valid representation of
+    # an empty database.
+    #
     # This is a very fast operation.
     #
     # @param name [String] The full path of the directory in the
@@ -89,6 +97,17 @@ module CartonDb
       false
     end
 
+    def element?(key, element)
+      key_d = CartonDb::Datum.for_plain(key)
+      element_d = CartonDb::Datum.for_plain(element)
+      segment = segment_containing(key_d)
+
+      segment.each_entry_element_line do |kd, ed, _line|
+        return true if kd == key_d && ed == element_d
+      end
+      false
+    end
+
     # Returns true if the map has no entries.
     #
     # This is a fairly fast operation.
@@ -270,6 +289,43 @@ module CartonDb
       end
     end
 
+    # Appends an element to the content of an entry if no
+    # element with the same value already exists in the content.
+    #
+    # @param key [String] The key identifying the entry.
+    # @param element [String] The element to be appended to the
+    #   content of the entry if applicable.
+    def touch_element(key, element)
+      key_d = CartonDb::Datum.for_plain(key)
+      element_d = CartonDb::Datum.for_plain(element)
+      return if element?(key_d, element_d)
+      append_element key_d, element_d
+    end
+
+    # Performs a bag-wise merge of the given elements with the
+    # content of an entry. Appends whatever elements are
+    # necessary so the content has an element corresponding to
+    # each of the given elements.
+    #
+    # @param key [String] The key identifying the entry.
+    # @param elements [Array<String>] An array or other
+    #   enumerable collection of elements to appended as
+    #   applicable.
+    def merge_elements(key, elements)
+      key_d = CartonDb::Datum.for_plain(key)
+      element_ds = elements.map { |el|
+        CartonDb::Datum.for_plain(el)
+      }
+      segment = segment_containing(key_d)
+      segment.each_entry_element_line do |kd, ed, _line|
+        next unless kd == key_d
+        eds_idx = element_ds.index(ed)
+        element_ds.delete_at(eds_idx) if eds_idx
+      end
+
+      concat_elements key_d, element_ds
+    end
+
     private
 
     attr_accessor :name

data/lib/carton_db/version.rb

@@ -1,4 +1,4 @@
 # -*- coding: UTF-8 -*-
 module CartonDb
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: carton_db
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Steve Jorgensen