lode 0.1.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0c26a2071caf89746b1582a9bd24fdce30ca3cf2301292d8bb709f7f3ed1aae
-  data.tar.gz: 3576a868e17557a2b079b44865481a0bb69cfae232b682aa2f881b32c0b77cc4
+  metadata.gz: 53547ef20d061cc6875625c4a82430c5a7c6b6d1826b41b56f16446ec9202085
+  data.tar.gz: d22865856c792c76dee3e58b8106285683d0fc2e78f752c69bc7603bb3581eb8
 SHA512:
-  metadata.gz: 380058a439bf8a94889124a5340faae07f6c89d3812252217ff2a2be61719173c75de75ec655512676a4fff7aca216b01b936dfe6bf37099f5b5948f1be4ce95
-  data.tar.gz: 6c3b82518cf8d3e05825f7c087863f018b45e9321c0da9ea28a459baac141bb534b5fe32304609666579f51ab606e2dec07e7273c593547fe5766f682a28078d
+  metadata.gz: b6cafe0d0ffdec73e06a76994bfdae4b9b4c9f3acb3e29a0415148ef6c00ea0163fef33afeef9224b2d1d468025385bc33fed160bc3b2708afbdab9f2433bd65
+  data.tar.gz: 590792995478977eb6e4abdf626a25e32d0c830154857f1fa6480d059acea8fdae0f6c968d6c655034e68c6ecbb642fed6208107e22c9d2e1595e25976b1702a

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,10 +30,12 @@ module Lode
 
     attr_reader :configuration
 
-    def transact(mode, key, &)
+    # rubocop:todo Naming/BlockForwarding
+    def transact mode, key, &block
       store.transaction mode == :read do
-        configuration.table_for(store, key).instance_eval(&)
+        configuration.table_for(store, key).instance_eval(&block)
       end
     end
+    # rubocop:enable Naming/BlockForwarding
   end
 end

data/lib/lode/configuration.rb

@@ -6,7 +6,7 @@ module Lode
   # Models the default configuration.
   Configuration = Struct.new :store, :mode, :table, :primary_key, :registry do
     using Refines::PersistentStore
-    using Refinements::Arrays
+    using Refinements::Array
 
     def initialize store: PStore,
                    mode: :default,

data/lib/lode/refines/persistent_store.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 require "pstore"
-require "refinements/arrays"
+require "refinements/array"
 
 module Lode
   module Refines
-    # Refined and enhanced PStore functionality.
+    # Refines and enhances PStore functionality.
     module PersistentStore
-      using Refinements::Arrays
+      using Refinements::Array
 
       refine PStore.singleton_class do
         def with path, mode: :default

data/lib/lode/setting.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Lode
+  # Defines a configuration setting.
   Setting = Data.define :model, :primary_key do
     def initialize model: Hash, primary_key: PRIMARY_KEY
       super

data/lib/lode/tables/abstract.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "dry/monads"
-require "refinements/arrays"
+require "refinements/array"
 
 module Lode
   module Tables
@@ -9,7 +9,7 @@ module Lode
     class Abstract
       include Dry::Monads[:result]
 
-      using Refinements::Arrays
+      using Refinements::Array
 
       def initialize store, key, setting: Setting.new
         @store = store

data/lode.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "lode"
-  spec.version = "0.1.1"
+  spec.version = "1.0.1"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/lode"
@@ -22,9 +22,9 @@ Gem::Specification.new do |spec|
   spec.signing_key = Gem.default_key_path
   spec.cert_chain = [Gem.default_cert_path]
 
-  spec.required_ruby_version = [">= 3.2", "<= 3.3"]
+  spec.required_ruby_version = "~> 3.3"
   spec.add_dependency "dry-monads", "~> 1.6"
-  spec.add_dependency "refinements", "~> 11.0"
+  spec.add_dependency "refinements", "~> 12.0"
   spec.add_dependency "zeitwerk", "~> 2.6"
 
   spec.extra_rdoc_files = Dir["README*", "LICENSE*"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lode
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2023-11-15 00:00:00.000000000 Z
+date: 2024-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-monads
@@ -57,14 +57,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '12.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -116,10 +116,7 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
-    - !ruby/object:Gem::Version
-      version: '3.2'
-  - - "<="
+  - - "~>"
     - !ruby/object:Gem::Version
       version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -128,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.5.4
 signing_key:
 specification_version: 4
 summary: A monadic store of marshaled objects.