lode 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18f3728eb2391285467b9dbdf6cda694bdf8ee167b9f84b8d9f60e4869938d67
-  data.tar.gz: cd5e03ccd6554d48c09e67514cd82c427cc636be527f351311089a6cbcdcfd93
+  metadata.gz: 51471745bb0d6abb49d97534051fb85c58d61db18f547f963f96a7636132fa0a
+  data.tar.gz: 7aa1cd828b8f61ce29e7ed1ffba7ee1e820c7dfc4f96911880e158850a665f72
 SHA512:
-  metadata.gz: 0da905f28b4ac347b4bebe53a0bb58c87f185fe2f948bbf3e3e13af8f6a3461fe768848f69351f4767f50a10e34914ae71290125ab6e4af03affd7fcc0f851b0
-  data.tar.gz: 63b9f264fd388402cfd00a5cfab3062c7bed11f49738ec3cae760b579d26a26d6a49b635482b8181b0a3b462b2f24dd693f7d764595a660c063eaadb585867e9
+  metadata.gz: 52baa436a259f122b8501cc3dc46a230a5b70f8d7389c3f39db2cf3c9d06da038bf931af05109f37bfd8dcdceee5569668b181fac12ac982e8584ae2731d4b37
+  data.tar.gz: 3869644daa4ff5a7a7b975557abe53d7e0dcc56d95c879b031f82e553332b50707e9c3c26d1378e5b26c55263a07ef9fb738c537ad487c2f489d7b7a500431f0

data/README.adoc

@@ -9,9 +9,9 @@
 
 = Lode
 
-Lode -- as in a geological deposit or a vein of minerals -- is a {pstore_link} of object data that can be mined for valuable information.
+Lode -- as in geological deposit or a vein of minerals -- is a {pstore_link} of object data that can be mined for valuable information.
 
-As noted in the {pstore_link} documentation all objects are marshaled which is not without caveats and dangers but, if you only need a simple object store, {pstore_link} is a solution. Lode takes this a step further by allowing you to have a pipeline workflow with a Domain Specific Language (DSL) for creating, updating, finding, and deleting records.
+As noted in the {pstore_link} documentation all objects are marshaled which is not without caveats and dangers but, if you only need a simple object store, {pstore_link} is a solution. Lode takes this a step further by allowing you to have a pipeline workflow along with a Domain Specific Language (DSL) for creating, updating, finding, and deleting records.
 
 toc::[]
 
@@ -141,6 +141,19 @@ Each key can be configured as follows:
 * `primary_key`: Defines the primary key used when interacting with your table of records (useful when finding or upserting records). Default: `:id`.
 * `registry`: Used for registering default settings for your tables. _This is not meant to be used directly_ but is documented for transparency.
 
+=== Paths
+
+Upon initialization, and when given a file, the file is only created once you start saving records. Although, when given a nested path, the full parent path will be created in anticipation of the file eventually being created. Example:
+
+[source,ruby]
+----
+# The file, "demo.store", is not created until data is saved.
+Lode.new "demo.store"
+
+# The path, "a/nested/path", will be created so `demo.store` can eventually be saved.
+Lode.new "a/nested/path/demo.store"
+----
+
 === Registry
 
 The registry is part of the configuration and directly accessible via a Lode instance. The registry allows you to customize individual table behavior as desired. For instance, you could have a `Hash` table or value table (i.e. `Data`, `Struct`, etc). Additionally, each table can have different primary keys too. The registry accepts three arguments in this format:

data/lib/lode/client.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
 require "forwardable"
+require "refinements/pathname"
 
 module Lode
   # Provides an enhanced PStore-based client.
   class Client
     extend Forwardable
 
+    using Refinements::Pathname
+
     attr_reader :path, :store
 
     delegate %i[register registry] => :configuration
@@ -14,7 +17,7 @@ module Lode
     def initialize path, configuration: Configuration.new
       yield configuration if block_given?
 
-      @path = path
+      @path = Pathname(path).make_ancestors
       @configuration = configuration
       @store = configuration.store_for path
     end
@@ -27,12 +30,10 @@ module Lode
 
     attr_reader :configuration
 
-    # rubocop:todo Naming/BlockForwarding
     def transact mode, key, &block
       store.transaction mode == :read do
         configuration.table_for(store, key).instance_eval(&block)
       end
     end
-    # rubocop:enable Naming/BlockForwarding
   end
 end

data/lib/lode/refines/persistent_store.rb

@@ -5,7 +5,7 @@ require "refinements/array"
 
 module Lode
   module Refines
-    # Refined and enhanced PStore functionality.
+    # Refines and enhances PStore functionality.
     module PersistentStore
       using Refinements::Array
 

data/lode.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "lode"
-  spec.version = "1.0.0"
+  spec.version = "1.1.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/lode"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lode
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2024-01-01 00:00:00.000000000 Z
+date: 2024-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-monads
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: A monadic store of marshaled objects.