carton_db 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bbf7e47a17f6d3f6f19bb40d4a13524cc2704cd0
-  data.tar.gz: 26098104742787b3bfa8bf0b01b8274a7cdb8e13
+  metadata.gz: ce323ba4a0df06b409f1b35a150a9a638740e586
+  data.tar.gz: b2c95dca25fe7be9c0b7c8ff7ca2f8d3ea6e7ed0
 SHA512:
-  metadata.gz: f00b6ad528b7ec75286244bffce56ee467eeaf2e8c470a6db680e1002c242a7130b0225c77e5a4d7e853d3e1ffbfa59cdedc554e95cab6095a6c25778bbd3632
-  data.tar.gz: 1b7c46564dae0037b6c12dfea983e4d780e2720e70a670b65ee174e08264689434ff37d7fb2c55856088375b05be1eb1e16bc8c448b2b2480d5bc3d213ebff73
+  metadata.gz: ed9890e79acc8c72d7005834b9ed6f8fec56ab941d9c078957cb2fa84c5e82f486ea876d981af6850bd2835ea9fc58789194e0e061087054def1a2a35ab25fdb
+  data.tar.gz: 69de8aac4491cd13b67c3e2bb0a707961c8a359259278303a70e094c19fe7e60b3c5c3b2983f1b6268b74bc5045f762eeb7abb53b22e031049bfa6d2e962e06c

data/README.md

@@ -18,12 +18,12 @@ Ruby program running on Heroku to collect data into a map of
 sets of elements that would be too large to be effectively
 handled in memory. The application didn't already have any use
 for a relational database server, and I didn't want to add one
-just for this requirement. A redis db with sufficient capacity
+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 `PStore`, `DBM` and
-`SDMB` each proved to be too unpredicatable and flakey to be
-practical solutions.
+`SDMB` each proved to be too unpredicatable and flakey to be a
+practical solution.
 
 Although this tool was initially developed to store transient
 data for use within a single process invocation and then
@@ -54,7 +54,9 @@ filesystem containing the files that store the data.
 A database is accessed through an instance of a database class.
 
 An instance of a database class maintains no state in memory
-between calls to its methods except for the database name.
+between calls to its methods except for the database name and the
+expectation of a directory with that name existing in the
+filesystem.
 
 An empty directory is a valid empty database.
 
@@ -66,8 +68,8 @@ attempting to do that are unpredictable.
 
 Initializing a new database class instance creates its directory
 in the filesystem if it does not already exist. The parent of the
-database directory is expected to already  exist, and an error
-will occur if it doesn't.
+database directory is expected to already  exist, and an
+exception will be raised if it doesn't.
 
 The database structure is designed to effectively handle up to
 several million elements with entries containing up to 1 or 2

data/lib/carton_db/list_map_db.rb

@@ -87,6 +87,13 @@ module CartonDb
       ary
     end
 
+    # Returns true if an entry with the given key exists.
+    #
+    # Performance is similar to #[] but may be somewhat faster
+    # when a key is found since it doesn't need to ensure that
+    # it has read all of the elements for an entry.
+    #
+    # @param key [String] The key identifying the entry.
     def key?(key)
       key_d = CartonDb::Datum.for_plain(key)
       segment = segment_containing(key_d)
@@ -97,6 +104,14 @@ module CartonDb
       false
     end
 
+    # Returns trus if an entry with the given key exists and its
+    # content includes at least one element with the given
+    # element value.
+    #
+    # Performance is similar to #key?
+    #
+    # @param key [String] The key identifying the entry.
+    # @param element [String] The element value to match.
     def element?(key, element)
       key_d = CartonDb::Datum.for_plain(key)
       element_d = CartonDb::Datum.for_plain(element)

data/lib/carton_db/version.rb

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

metadata

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