lode 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0df5dca345e4cec7f64f0ac6b5f13ad2075cc06cd64021ea9e20e6c4b54d3a3e
+  data.tar.gz: f6aaec62dc57a6df4fa25d6f2f1dcbf337380a52a4e6eae560d87e1aa70f19db
+SHA512:
+  metadata.gz: 2e9985b9140e620b17485c711d43e734bd7dd4d3fd13dcf02a1957afc9e2a69a4650734f16992f698ca27dc7e8b45304ac2d06526ae4c4bf2166ade280330733
+  data.tar.gz: 8fbd85cd0ce466be6d9e97db86d5e8dd995f41168af9e619cd63791259890ed4b692f429a3d41380012a15b2a50a8dd4cfab5698c7a4bb6e420fd3c62fb2088a

data/LICENSE.adoc

@@ -0,0 +1,134 @@
+= Hippocratic License
+
+Version: 2.1.0.
+
+Purpose. The purpose of this License is for the Licensor named above to
+permit the Licensee (as defined below) broad permission, if consistent
+with Human Rights Laws and Human Rights Principles (as each is defined
+below), to use and work with the Software (as defined below) within the
+full scope of Licensor’s copyright and patent rights, if any, in the
+Software, while ensuring attribution and protecting the Licensor from
+liability.
+
+Permission and Conditions. The Licensor grants permission by this
+license ("License"), free of charge, to the extent of Licensor’s
+rights under applicable copyright and patent law, to any person or
+entity (the "Licensee") obtaining a copy of this software and
+associated documentation files (the "Software"), to do everything with
+the Software that would otherwise infringe (i) the Licensor’s copyright
+in the Software or (ii) any patent claims to the Software that the
+Licensor can license or becomes able to license, subject to all of the
+following terms and conditions:
+
+* Acceptance. This License is automatically offered to every person and
+entity subject to its terms and conditions. Licensee accepts this
+License and agrees to its terms and conditions by taking any action with
+the Software that, absent this License, would infringe any intellectual
+property right held by Licensor.
+* Notice. Licensee must ensure that everyone who gets a copy of any part
+of this Software from Licensee, with or without changes, also receives
+the License and the above copyright notice (and if included by the
+Licensor, patent, trademark and attribution notice). Licensee must cause
+any modified versions of the Software to carry prominent notices stating
+that Licensee changed the Software. For clarity, although Licensee is
+free to create modifications of the Software and distribute only the
+modified portion created by Licensee with additional or different terms,
+the portion of the Software not modified must be distributed pursuant to
+this License. If anyone notifies Licensee in writing that Licensee has
+not complied with this Notice section, Licensee can keep this License by
+taking all practical steps to comply within 30 days after the notice. If
+Licensee does not do so, Licensee’s License (and all rights licensed
+hereunder) shall end immediately.
+* Compliance with Human Rights Principles and Human Rights Laws.
+[arabic]
+. Human Rights Principles.
+[loweralpha]
+.. Licensee is advised to consult the articles of the United Nations
+Universal Declaration of Human Rights and the United Nations Global
+Compact that define recognized principles of international human rights
+(the "Human Rights Principles"). Licensee shall use the Software in a
+manner consistent with Human Rights Principles.
+.. Unless the Licensor and Licensee agree otherwise, any dispute,
+controversy, or claim arising out of or relating to (i) Section 1(a)
+regarding Human Rights Principles, including the breach of Section 1(a),
+termination of this License for breach of the Human Rights Principles,
+or invalidity of Section 1(a) or (ii) a determination of whether any Law
+is consistent or in conflict with Human Rights Principles pursuant to
+Section 2, below, shall be settled by arbitration in accordance with the
+Hague Rules on Business and Human Rights Arbitration (the "Rules");
+provided, however, that Licensee may elect not to participate in such
+arbitration, in which event this License (and all rights licensed
+hereunder) shall end immediately. The number of arbitrators shall be one
+unless the Rules require otherwise.
++
+Unless both the Licensor and Licensee agree to the contrary: (1) All
+documents and information concerning the arbitration shall be public and
+may be disclosed by any party; (2) The repository referred to under
+Article 43 of the Rules shall make available to the public in a timely
+manner all documents concerning the arbitration which are communicated
+to it, including all submissions of the parties, all evidence admitted
+into the record of the proceedings, all transcripts or other recordings
+of hearings and all orders, decisions and awards of the arbitral
+tribunal, subject only to the arbitral tribunal’s powers to take such
+measures as may be necessary to safeguard the integrity of the arbitral
+process pursuant to Articles 18, 33, 41 and 42 of the Rules; and (3)
+Article 26(6) of the Rules shall not apply.
+. Human Rights Laws. The Software shall not be used by any person or
+entity for any systems, activities, or other uses that violate any Human
+Rights Laws. "Human Rights Laws" means any applicable laws,
+regulations, or rules (collectively, "Laws") that protect human,
+civil, labor, privacy, political, environmental, security, economic, due
+process, or similar rights; provided, however, that such Laws are
+consistent and not in conflict with Human Rights Principles (a dispute
+over the consistency or a conflict between Laws and Human Rights
+Principles shall be determined by arbitration as stated above). Where
+the Human Rights Laws of more than one jurisdiction are applicable or in
+conflict with respect to the use of the Software, the Human Rights Laws
+that are most protective of the individuals or groups harmed shall
+apply.
+. Indemnity. Licensee shall hold harmless and indemnify Licensor (and
+any other contributor) against all losses, damages, liabilities,
+deficiencies, claims, actions, judgments, settlements, interest, awards,
+penalties, fines, costs, or expenses of whatever kind, including
+Licensor’s reasonable attorneys’ fees, arising out of or relating to
+Licensee’s use of the Software in violation of Human Rights Laws or
+Human Rights Principles.
+* Failure to Comply. Any failure of Licensee to act according to the
+terms and conditions of this License is both a breach of the License and
+an infringement of the intellectual property rights of the Licensor
+(subject to exceptions under Laws, e.g., fair use). In the event of a
+breach or infringement, the terms and conditions of this License may be
+enforced by Licensor under the Laws of any jurisdiction to which
+Licensee is subject. Licensee also agrees that the Licensor may enforce
+the terms and conditions of this License against Licensee through
+specific performance (or similar remedy under Laws) to the extent
+permitted by Laws. For clarity, except in the event of a breach of this
+License, infringement, or as otherwise stated in this License, Licensor
+may not terminate this License with Licensee.
+* Enforceability and Interpretation. If any term or provision of this
+License is determined to be invalid, illegal, or unenforceable by a
+court of competent jurisdiction, then such invalidity, illegality, or
+unenforceability shall not affect any other term or provision of this
+License or invalidate or render unenforceable such term or provision in
+any other jurisdiction; provided, however, subject to a court
+modification pursuant to the immediately following sentence, if any term
+or provision of this License pertaining to Human Rights Laws or Human
+Rights Principles is deemed invalid, illegal, or unenforceable against
+Licensee by a court of competent jurisdiction, all rights in the
+Software granted to Licensee shall be deemed null and void as between
+Licensor and Licensee. Upon a determination that any term or provision
+is invalid, illegal, or unenforceable, to the extent permitted by Laws,
+the court may modify this License to affect the original purpose that
+the Software be used in compliance with Human Rights Principles and
+Human Rights Laws as closely as possible. The language in this License
+shall be interpreted as to its fair meaning and not strictly for or
+against any party.
+* Disclaimer. TO THE FULL EXTENT ALLOWED BY LAW, THIS SOFTWARE COMES
+"AS IS," WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED, AND LICENSOR AND
+ANY OTHER CONTRIBUTOR SHALL NOT BE LIABLE TO ANYONE FOR ANY DAMAGES OR
+OTHER LIABILITY ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE
+OR THIS LICENSE, UNDER ANY KIND OF LEGAL CLAIM.
+
+This Hippocratic License is an link:https://ethicalsource.dev[Ethical Source license] and is offered
+for use by licensors and licensees at their own risk, on an "AS IS" basis, and with no warranties
+express or implied, to the maximum extent permitted by Laws.

data/README.adoc

@@ -0,0 +1,329 @@
+:toc: macro
+:toclevels: 5
+:figure-caption!:
+
+:dry_monads_link: link:https://dry-rb.org/gems/dry-monads[Dry Monads]
+:pstore_link: link:https://github.com/ruby/pstore[PStore]
+:ruby_link: link:https://www.ruby-lang.org[Ruby]
+:xdg_link: link:https://alchemists.io/projects/xdg[XDG]
+
+= 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.
+
+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.
+
+toc::[]
+
+== Features
+
+- Built atop {pstore_link}.
+- Uses the _Railway Pattern_ via {dry_monads_link} for fault tolerant pipelines.
+- Emphasizes use of `Hash`, `Data`, `Struct`, or link:https://alchemists.io/projects/wholable[whole value objects] in general.
+- Great for {xdg_link} caches, simple file-based databases, or simple file stores in general.
+
+== Requirements
+
+. {ruby_link}.
+
+== Setup
+
+To install _with_ security, run:
+
+[source,bash]
+----
+# 💡 Skip this line if you already have the public certificate installed.
+gem cert --add <(curl --compressed --location https://alchemists.io/projects/lode/gems.pem)
+gem install lode --trust-policy HighSecurity
+----
+
+To install _without_ security, run:
+
+[source,bash]
+----
+gem install lode
+----
+
+You can also add the gem directly to your project:
+
+[source,bash]
+----
+bundle add lode
+----
+
+Once the gem is installed, you only need to require it:
+
+[source,ruby]
+----
+require "lode"
+----
+
+== Usage
+
+To use, create a Lode instance and then use database-like messages to interact with your table of records as desired. For example, the following creates a table of _links_ and stores them within the `demo.store` file and then interacts with those records:
+
+[source,ruby]
+----
+lode = Lode.new "demo.store"
+
+lode.commit :links do
+  upsert({id: 1, url: "https://one.com"})
+  upsert({id: 2, url: "https://2.com"})
+  upsert({id: 3, url: "https://three.com"})
+end
+
+# Success({:id=>3, :url=>"https://three.com"})
+# (only the last record created/updated is answered back)
+
+lode.commit(:links) { upsert({id: 2, url: "https://two.com"}) }
+# Success({:id=>2, :url=>"https://two.com"})
+
+lode.commit(:links) { find 1 }
+# Success({:id=>1, :url=>"https://one.com"})
+
+lode.commit(:links) { find 13 }
+# Failure("Unable to find id: 13.")
+
+lode.commit(:links) { delete 2 }
+# Success({:id=>2, :url=>"https://two.com"})
+
+lode.commit(:links) { delete 13 }
+# Failure("Unable to find id: 13.")
+
+lode.commit(:links, &:all)
+# Success([{:id=>1, :url=>"https://one.com"}, {:id=>3, :url=>"https://three.com"}])
+----
+
+The default configuration is set up to use a primitive `Hash` which is the default behavior when using {pstore_link}. Everything answered back is a result monad as provided by the {dry_monads_link} gem so you can leverage the _Railway Pattern_ to build robust, fault tolerant, pipelines.
+
+=== Configuration
+
+Lode can be configured using a block or a keyword argument. The following are identical:
+
+[source,ruby]
+----
+# With block.
+lode = Lode.new "demo.store" do |config|
+  config.mode = :max
+  config.table = Lode::Tables::Value
+  config.primary_key = :name
+end
+
+# With keyword argument.
+configuration = Lode::Configuration[mode: :max, table: Lode::Tables::Value, primary_key: :name]
+lode = Lode.new "demo.store", configuration:
+----
+
+The default configuration consists of the following attributes:
+
+[source,ruby]
+----
+Lode::Configuration[
+  store: PStore,
+  mode: :default,
+  table: Lode::Tables::Dictionary,
+  primary_key: :id,
+  registry: {}
+]
+----
+
+Each key can be configured as follows:
+
+* `store`: Any object that adhere's to the {pstore_link} Object API. You'll most likely never need to change this but is available if desired. Default: `PStore`.
+* `mode`: The mode determines {pstore_link} behavior and can be one of the following:
+** `:default`: The default mode and is identical to `PStore.new path`.
+** `:thread`: Ensures a thread safe `PStore` instance is created. This is identical to `PStore.new path, true`.
+** `:file`: Ensures a file safe `PStore` instance is created. This is identical to setting `store.ultra_safe = true` on a `PStore` instance.
+** `:max`: Ensures a thread _and_ file safe `PStore` instance is created for situations where you need maximum safety.
+* `table`: Defines the _type_ of table used to interact with your records. The following values are supported:
+** `Lode::Tables::Dictionary`: The default value which allows you to interact with a `Hash` of records but would also work with any object that can respond to `+#[]+` and `+#[]=+`.
+** `Lode::Tables::Value`: Allows you to interact with whole value objects like `Data`, `Struct`, or link:https://alchemists.io/projects/wholable[whole value objects] in general which have attribute readers and writers.
+* `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.
+
+=== 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:
+
+....
+key, model:, primary_key:
+....
+
+The default model is a `Hash` but could be `Data`, `Struct`, or any value object. The default primary key is `:id` but could be any attribute that uniquely identifies a record. This means the following is identical when registering default table settings:
+
+[source,ruby]
+----
+# Initialization with registration.
+lode = Lode.new("demo.store") { |config| config.register :links, primary_key: :slug }
+
+# Direct registration.
+lode = Lode.new "demo.store"
+lode.register :links, primary_key: :slug
+----
+
+Given the above, you could now create and find _link_ records by _slug_ like so:
+
+[source,ruby]
+----
+lode.commit(:links) { upsert({id: 1, slug: :demo, url: "https://demo.com"}) }
+lode.read(:links) { find :demo }
+
+# Success({:id=>1, :slug=>:demo, :url=>"https://demo.com"})
+----
+
+Keep in mind that the registry _only defines default behavior_. You can override default behavior by specifying a key. Example:
+
+[source,ruby]
+----
+lode.read(:links) { find 1, key: :id }
+# Success({:id=>1, :slug=>:demo, :url=>"https://demo.com"})
+----
+
+Even though the default primary key was registered to be `:slug`, we were able to use `:id` instead. The optional `:key` keyword argument is also available for _all_ table methods.
+
+=== Tables
+
+As mentioned when configuring a Lode instance, two _types_ of tables are available to you. The default (i.e. `Lode::Tables::Dictionary`) allows you to interact with `Hash` records which is compatible with default `PStore` functionality. Example:
+
+[source,ruby]
+----
+lode = Lode.new "demo.store"
+lode.commit(:links) { upsert({id: 1, url: "https://one.com"}) }
+# Success({:id=>1, :url=>"https://one.com"})
+----
+
+The second, and more powerful table type, is a value object table (i.e. `Lode::Tables::Value`). Here's an example using a `Data` model:
+
+[source,ruby]
+----
+Model = Data.define :id, :url
+
+lode = Lode.new("demo.store") do |config|
+  config.table = Lode::Tables::Value
+  config.register :links, model: Model
+end
+
+lode.commit :links do
+  upsert({id: 1, url: "https://one.com"})
+  upsert Model[id: 2, url: "https://"]
+end
+
+lode.commit(:links, &:all)
+# Success([#<data Model id=1, url="https://one.com">, #<data Model id=2, url="https://">])
+----
+
+The above would work with a `Struct` or any value object. One of many conveniences when using value objects -- as shown above -- is you can upsert records using a `Hash` or an instance of your value object.
+
+Each table supports the following methods:
+
+* `#primary_key`: Answers the primary key as defined when the table was registered or the default key (i.e. `:id`).
+* `#all`: Answers all records for a table.
+* `#find`: Finds a record by primary key.
+* `#upsert`: Creates or updates a new or existing record by primary key.
+* `#delete`: Deletes an existing record by primary key.
+
+All of the above (except `#primary_key`) support an optional `:key` keyword argument which allows you to use a different key that is not the primary key if desired.
+
+=== Read/Write
+
+You've already seen a few examples of how to read and write to your object store but, to be explicit, the following are supported:
+
+* `#commit`: Allows you to read and write records as a single transaction.
+* `#read`: Allows you to _only_ read data from your object store as a single transaction. Write operations will result in an exception.
+
+Both of the above methods require you to supply the table name and a block with operations. Since a table name must always be supplied this means you can interact with multiple tables within the same file store or you can write different tables to different files. Up to you. Here's an example of a basic write and read operation:
+
+[source,ruby]
+----
+lode = Lode.new "demo.store"
+
+# Read/Write
+lode.commit(:links) { upsert({id: 1, url: "https://demo.com"}) }
+
+# Read Only
+lode.read(:links) { find 1 }
+----
+
+Attempting to `#read` with a _write_ operation will result in an error. Example:
+
+[source,ruby]
+----
+lode.read(:links) { delete 1 }
+# in read-only transaction (PStore::Error)
+----
+
+For those familiar with {pstore_link} behavior, a commit and read operation is the equivalent of the following using `PStore` directly:
+
+[source,ruby]
+----
+require "pstore"
+
+store = PStore.new "demo.store"
+
+# Read/Write
+store.transaction do |store|
+  store[:links] = store.fetch(:links, []).append({id: 1, url: "https://demo.com"})
+end
+
+# [{:id=>1, :url=>"https://demo.com"}]
+
+# Read Only
+store.transaction(true) { |store| store.fetch(:links, []).find { |record| record[:id] == 1 } }
+# {:id=>1, :url=>"https://demo.com"}
+----
+
+=== Store
+
+If at any time you need access to the original `PStore` instance, you can ask for it. Example:
+
+[source,ruby]
+----
+lode = Lode.new "demo.store"
+load.store
+
+# #<PStore:0x000000010c592178 @abort=false, @filename="demo.store", @lock=#<Thread::Mutex:0x000000010c5fbfd8>, @thread_safe=false, @ultra_safe=false>
+----
+
+== Development
+
+To contribute, run:
+
+[source,bash]
+----
+git clone https://github.com/bkuhlmann/lode
+cd lode
+bin/setup
+----
+
+You can also use the IRB console for direct access to all objects:
+
+[source,bash]
+----
+bin/console
+----
+
+== Tests
+
+To test, run:
+
+[source,bash]
+----
+bin/rake
+----
+
+== link:https://alchemists.io/policies/license[License]
+
+== link:https://alchemists.io/policies/security[Security]
+
+== link:https://alchemists.io/policies/code_of_conduct[Code of Conduct]
+
+== link:https://alchemists.io/policies/contributions[Contributions]
+
+== link:https://alchemists.io/projects/lode/versions[Versions]
+
+== link:https://alchemists.io/community[Community]
+
+== Credits
+
+* Built with link:https://alchemists.io/projects/gemsmith[Gemsmith].
+* Engineered by link:https://alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].

data/lib/lode/client.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module Lode
+  # Provides an enhanced PStore-based client.
+  class Client
+    extend Forwardable
+
+    attr_reader :path, :store
+
+    delegate %i[register registry] => :configuration
+
+    def initialize path, configuration: Configuration.new
+      yield configuration if block_given?
+
+      @path = path
+      @configuration = configuration
+      @store = configuration.store_for path
+    end
+
+    def read(key, &) = transact(__method__, key, &)
+
+    def commit(key, &) = transact(__method__, key, &)
+
+    private
+
+    attr_reader :configuration
+
+    def transact(mode, key, &)
+      store.transaction mode == :read do
+        configuration.table_for(store, key).instance_eval(&)
+      end
+    end
+  end
+end

data/lib/lode/configuration.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "pstore"
+
+module Lode
+  # Models the default configuration.
+  Configuration = Struct.new :store, :mode, :table, :primary_key, :registry do
+    using Refines::PersistentStore
+    using Refinements::Arrays
+
+    def initialize store: PStore,
+                   mode: :default,
+                   table: Tables::Dictionary,
+                   primary_key: PRIMARY_KEY,
+                   registry: {}
+      super
+    end
+
+    def store_for(path) = store.with(path, mode:)
+
+    def table_for store, key, setting: Setting.new
+      table.new store, key, setting: registry.fetch(key, setting)
+    end
+
+    def register key, model: Hash, primary_key: PRIMARY_KEY
+      registry[key] = Setting[model:, primary_key:]
+      self
+    end
+  end
+end

data/lib/lode/refines/persistent_store.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "pstore"
+require "refinements/arrays"
+
+module Lode
+  module Refines
+    # Refined and enhanced PStore functionality.
+    module PersistentStore
+      using Refinements::Arrays
+
+      refine PStore.singleton_class do
+        def with path, mode: :default
+          case mode
+            when :default then new path
+            when :thread then new path, true
+            when :file then new(path).tap { |instance| instance.ultra_safe = true }
+            when :max then new(path, true).tap { |instance| instance.ultra_safe = true }
+            else fail PStore::Error, %(Invalid mode. Use: #{MODES.to_usage "or"}.)
+          end
+        end
+      end
+
+      refine PStore do
+        def thread_safe? = @thread_safe
+
+        def file_safe? = @ultra_safe
+      end
+    end
+  end
+end

data/lib/lode/setting.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Lode
+  Setting = Data.define :model, :primary_key do
+    def initialize model: Hash, primary_key: PRIMARY_KEY
+      super
+    end
+  end
+end

data/lib/lode/tables/abstract.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "refinements/arrays"
+
+module Lode
+  module Tables
+    # Provides an abstract table for subclassing.
+    class Abstract
+      include Dry::Monads[:result]
+
+      using Refinements::Arrays
+
+      def initialize store, key, setting: Setting.new
+        @store = store
+        @key = key
+        @setting = setting
+        @records = store.fetch key, []
+      end
+
+      def primary_key = setting.primary_key
+
+      def all = Success records.dup.freeze
+
+      def find value, key: primary_key
+        fail NotImplementedError,
+             "`#{self.class}##{__method__} #{method(__method__).parameters}` must be implemented."
+      end
+
+      def upsert value, key: primary_key
+        fail NotImplementedError,
+             "`#{self.class}##{__method__} #{method(__method__).parameters}` must be implemented."
+      end
+
+      def delete value, key: primary_key
+        find(value, key:).fmap do |record|
+          records.delete record
+          store[key] = records
+          record
+        end
+      end
+
+      protected
+
+      attr_reader :store, :key, :setting, :records
+
+      def update existing, record
+        records.supplant existing, record
+        store[key] = records
+        Success record
+      end
+
+      def append record
+        records.append record
+        store[key] = records
+        Success record
+      end
+    end
+  end
+end

data/lib/lode/tables/dictionary.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+
+module Lode
+  module Tables
+    # Provides an array-based table for dictionary or hash-like objects.
+    class Dictionary < Abstract
+      include Dry::Monads[:result]
+
+      def find value, key: primary_key
+        records.find { |record| record[key] == value }
+               .then do |record|
+                 return Success record if record
+
+                 Failure "Unable to find #{key}: #{value.inspect}."
+               end
+      end
+
+      def upsert value, key: primary_key
+        find(value[key]).either(
+          -> existing { update existing, value },
+          proc { append value }
+        )
+      end
+    end
+  end
+end

data/lib/lode/tables/value.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+
+module Lode
+  module Tables
+    # Provides an array-based table for value objects.
+    class Value < Abstract
+      include Dry::Monads[:result]
+
+      def find value, key: primary_key
+        records.find { |record| record.public_send(key) == value }
+               .then do |record|
+                 return Success record if record
+
+                 Failure "Unable to find #{key}: #{value.inspect}."
+               end
+      end
+
+      def upsert value, key: primary_key
+        record = record_for value
+
+        find(record.public_send(key)).either(
+          -> existing { update existing, record },
+          proc { append record }
+        )
+      end
+
+      private
+
+      # :reek:FeatureEnvy
+      def record_for value
+        model = setting.model
+        value.is_a?(model) ? value : model[**value.to_h]
+      end
+    end
+  end
+end

data/lib/lode.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+
+Zeitwerk::Loader.for_gem.setup
+
+# Main namespace.
+module Lode
+  PRIMARY_KEY = :id
+  MODES = %i[default thread file max].freeze
+
+  def self.new(...) = Client.new(...)
+end

data/lode.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name = "lode"
+  spec.version = "0.0.0"
+  spec.authors = ["Brooke Kuhlmann"]
+  spec.email = ["brooke@alchemists.io"]
+  spec.homepage = "https://alchemists.io/projects/lode"
+  spec.summary = "A monadic store of marshaled objects."
+  spec.license = "Hippocratic-2.1"
+
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/bkuhlmann/lode/issues",
+    "changelog_uri" => "https://alchemists.io/projects/lode/versions",
+    "documentation_uri" => "https://alchemists.io/projects/lode",
+    "funding_uri" => "https://github.com/sponsors/bkuhlmann",
+    "label" => "Lode",
+    "rubygems_mfa_required" => "true",
+    "source_code_uri" => "https://github.com/bkuhlmann/lode"
+  }
+
+  spec.signing_key = Gem.default_key_path
+  spec.cert_chain = [Gem.default_cert_path]
+
+  spec.required_ruby_version = "~> 3.2"
+  spec.add_dependency "dry-monads", "~> 1.6"
+  spec.add_dependency "refinements", "~> 11.0"
+  spec.add_dependency "zeitwerk", "~> 2.6"
+
+  spec.extra_rdoc_files = Dir["README*", "LICENSE*"]
+  spec.files = Dir["*.gemspec", "lib/**/*"]
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: lode
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Brooke Kuhlmann
+autorequire:
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEeDCCAuCgAwIBAgIBATANBgkqhkiG9w0BAQsFADBBMQ8wDQYDVQQDDAZicm9v
+  a2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQBGRYC
+  aW8wHhcNMjMwMzIyMTYxNDQxWhcNMjUwMzIxMTYxNDQxWjBBMQ8wDQYDVQQDDAZi
+  cm9va2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQB
+  GRYCaW8wggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQCro8tj5/E1Hg88
+  f4qfiwPVd2zJQHvdYt4GHVvuHRRgx4HGhJuNp+4BId08RBn7V6V1MW6MY3kezRBs
+  M+7QOQ4b1xNLTvY7FYQB1wGK5a4x7TTokDrPYQxDB2jmsdDYCzVbIMrAvUfcecRi
+  khyGZCdByiiCl4fKv77P12tTT+NfsvXkLt/AYCGwjOUyGKTQ01Z6eC09T27GayPH
+  QQvIkakyFgcJtzSyGzs8bzK5q9u7wQ12MNTjJoXzW69lqp0oNvDylu81EiSUb5S6
+  QzzPxZBiRB1sgtbt1gUbVI262ZDq1gR+HxPFmp+Cgt7ZLIJZAtesQvtcMzseXpfn
+  hpmm0Sw22KGhRAy/mqHBRhDl5HqS1SJp2Ko3lcnpXeFResp0HNlt8NSu13vhC08j
+  GUHU9MyIXbFOsnp3K3ADrAVjPWop8EZkmUR3MV/CUm00w2cZHCSGiXl1KMpiVKvk
+  Ywr1gd2ZME4QLSo+EXUtLxDUa/W3xnBS8dBOuMMz02FPWYr3PN8CAwEAAaN7MHkw
+  CQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFAFgmv0tYMZnItuPycSM
+  F5wykJEVMB8GA1UdEQQYMBaBFGJyb29rZUBhbGNoZW1pc3RzLmlvMB8GA1UdEgQY
+  MBaBFGJyb29rZUBhbGNoZW1pc3RzLmlvMA0GCSqGSIb3DQEBCwUAA4IBgQAX+EGY
+  9RLYGxF1VLZz+G1ACQc4uyrCB6kXwI06kzUa5dF9tPXqTX9ffnz3/W8ck2IQhKzu
+  MKO2FVijzbDWTsZeZGglS4E+4Jxpau1lU9HhOIcKolv6LeC6UdALTFudY+GLb8Xw
+  REXgaJkjzzhkUSILmEnRwEbY08dVSl7ZAaxVI679vfI2yapLlIwpbBgmQTiTvPr3
+  qyyLUno9flYEOv9fmGHunSrM+gE0/0niGTXa5GgXBXYGS2he4LQGgSBfGp/cTwMU
+  rDKJRcusZ12lNBeDfgqACz/BBJF8FLodgk6rGMRZz7+ZmjjHEmpG5bQpR6Q2BuWL
+  XMtYk/QzaWuhiR7pWjiF8jbdd7RO6or0ohq7iFkokz/5xrtQ/vPzU2RQ3Qc6YaKw
+  3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
+  gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
+  -----END CERTIFICATE-----
+date: 2023-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: refinements
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description:
+email:
+- brooke@alchemists.io
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.adoc
+- LICENSE.adoc
+files:
+- LICENSE.adoc
+- README.adoc
+- lib/lode.rb
+- lib/lode/client.rb
+- lib/lode/configuration.rb
+- lib/lode/refines/persistent_store.rb
+- lib/lode/setting.rb
+- lib/lode/tables/abstract.rb
+- lib/lode/tables/dictionary.rb
+- lib/lode/tables/value.rb
+- lode.gemspec
+homepage: https://alchemists.io/projects/lode
+licenses:
+- Hippocratic-2.1
+metadata:
+  bug_tracker_uri: https://github.com/bkuhlmann/lode/issues
+  changelog_uri: https://alchemists.io/projects/lode/versions
+  documentation_uri: https://alchemists.io/projects/lode
+  funding_uri: https://github.com/sponsors/bkuhlmann
+  label: Lode
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/bkuhlmann/lode
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.18
+signing_key:
+specification_version: 4
+summary: A monadic store of marshaled objects.
+test_files: []