etcher 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f77fefa60ba596414bd1453ca278ef82a4839286e4c822260bbf7ed391b2fa5a
+  data.tar.gz: 34076cfa28541ac3f6778bde4167a758473bb03874aa3233029df6248af24c78
+SHA512:
+  metadata.gz: f6c2d11ab82fb53535fb7606e5a160381febab7632eb39f8fe91b677b629416536016db42f1838a2a59cf0c51595f6647762758b70356685a7194bda023ac00e
+  data.tar.gz: 260f3e2e1e55d3a82d862aa3140a453f7a357dbc8a5e0702f472e113d180b62b0bd011f641c612846230726b5514231c7b7412fa07cfe3251ad3dc126d204493

checksums.yaml.gz.sig

@@ -0,0 +1 @@
+v��*�m���JЄ�p��u-Ϸ�u��Kҩ��	�U��QlW�kZ���%F�3�}*�eO��|g˶���q�h4a&�])��d,yY�0q�O?�K
dnQ�^v\��K�b�x�\�fj�G�/OE�	��G�ݏ�Rҽ�T�+��/�R&������Y�y�nr�&�z�:܈���?X�F��

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,509 @@
+:toc: macro
+:toclevels: 5
+:figure-caption!:
+
+:data_link: link:https://alchemists.io/articles/ruby_data[Data]
+:demeter_link: link:https://en.wikipedia.org/wiki/Law_of_Demeter[Law of Demeter]
+:dry_container_link: link:https://dry-rb.org/gems/dry-container[Dry Container]
+:dry_monads_link: link:https://dry-rb.org/gems/dry-monads[Dry Monads]
+:dry_schema_link: link:https://dry-rb.org/gems/dry-schema[Dry Schema]
+:dry_validation_link: link:https://dry-rb.org/gems/dry-validation[Dry Validation]
+:environment_link: link:https://rubyapi.org/3.2/o/env[Environment]
+:gitt_link: link:https://alchemists.io/projects/gitt[Gitt]
+:hash_link: link:https://rubyapi.org/o/hash[Hash]
+:json_link: link:https://rubyapi.org/o/json[JSON]
+:runcom_link: link:https://alchemists.io/projects/runcom[Runcom]
+:struct_link: link:https://alchemists.io/articles/ruby_structs[Struct]
+:transactable_link: link:https://alchemists.io/projects/transactable[Transactable]
+:xdg_link: link:https://alchemists.io/projects/xdg[XDG]
+:yaml_link: link:https://rubyapi.org/o/yaml[YAML]
+
+= Etcher
+
+Etcher allows you to take raw settings and/or user input and _etch_ them into a concrete and valid configuration for use within your application. As quoted from link:https://en.wikipedia.org/wiki/Etching[Wikipedia], to _etch_ is to:
+
+____
+[Use] strong acid or mordant to cut into the unprotected parts of a metal surface to create a design in intaglio (incised) in the metal.
+____
+
+By using Etcher, you have a reliable way to load default configurations (i.e. {environment_link}, {json_link}, {yaml_link}) which can be validated and turned into records (i.e. {hash_link}, {data_link}, {struct_link}) for consumption within your application. In other words, the ability to take primitive hashes and _etch_ them into a _frozen_ record with a nice interface that doesn't violate the {demeter_link}. This comes complete with transformations and validations all via a simple Object API. Finally, this pairs well with the {xdg_link} and {runcom_link} gems, Command Line Interfaces (CLIs), Application Programming Interfaces (APIs), or any application that can be configured by the user.
+
+toc::[]
+
+== Features
+
+* Supports contracts which respond to `#call` to validate a {hash_link} before building the final record. This works extremely well with the {dry_schema_link} and {dry_validation_link} gems.
+* Supports models which respond to `.[]` for consuming a splatted {hash_link} to instantiate new records. This works extremely well with primitives such as: {hash_link}, {data_link}, and {struct_link}.
+* Supports loading of default configurations from the {environment_link}, a {json_link} configuration, a {yaml_link} configuration, or anything that can answer a hash.
+* Supports multiple transformations which can process loaded configuration hashes and answer a transformed hash.
+* Supports {hash_link} overrides as a final customization which is handy for Command Line Interfaces (CLI) or anything that might require user input at runtime.
+
+== Requirements
+
+. link:https://www.ruby-lang.org[Ruby].
+
+== 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/gems.pem)
+gem install etcher --trust-policy HighSecurity
+----
+
+To install _without_ security, run:
+
+[source,bash]
+----
+gem install etcher
+----
+
+You can also add the gem directly to your project:
+
+[source,bash]
+----
+bundle add etcher
+----
+
+Once the gem is installed, you only need to require it:
+
+[source,ruby]
+----
+require "etcher"
+----
+
+== Usage
+
+Basic usage is to new up an instance:
+
+[source,ruby]
+----
+etcher = Etcher.new
+etcher.call({one: 1, two: 2})
+
+# Success({:one=>1, :two=>2})
+----
+
+Notice you get a monad -- either a `Success` or `Failure` -- as provided by the {dry_monads_link} gem. This allows you to create more sophisticated pipelines as found with the {transactable_link} gem or any kind of failsafe workflow you might need. The only problem is -- by default -- any attributes you message the instance with will only pass through what you gave it and always answer a `Success`. This is nice for initial experimentation but true power comes with full customization of the instance. Here's an advanced configuration showing all features:
+
+[source,ruby]
+----
+require "dry/monads"
+require "dry/schema"
+
+Dry::Schema.load_extensions :monads
+
+contract = Dry::Schema.Params do
+  required(:user).filled :string
+  required(:home).filled :string
+end
+
+model = Data.define :user, :home
+transformer = -> content { Dry::Monads::Success content.merge! user: content[:user].upcase }
+
+Etcher::Registry.new(contract:, model:, transformers: [transformer])
+                .add_loader(Etcher::Loaders::Environment.new(%w[USER HOME]))
+                .then { |registry| Etcher.new(registry).call }
+
+# Success(#<data user="DEMO", home="/Users/demo">)
+----
+
+The above can be broken down into a series of steps:
+
+. A {dry_schema_link} contract -- loaded with {dry_monads_link} extensions -- is created to verify untrusted attributes.
+. A model is created with attributes: `user` and `home`.
+. A registry is constructed with a custom contract, model, loader, and transformer.
+. Finally, we see a _successfully_ built configuration for further use.
+
+While this is a more advanced use case, you'll usually only need to register a contract and model. The loaders and transformers provide additional firepower in situations where you need to do more with your data. We'll look at each of these components in greater detail next.
+
+=== Registry
+
+The registry is provided as a way to register any/all complexity for before creating a new Etcher instance. Here's what you get by default:
+
+[source,ruby]
+----
+Etcher::Registry.new
+# #<data Etcher::Registry contract=#<Proc:0x000000010e393550 contract.rb:7 (lambda)>, model=Hash, loaders=[], transformers=[]>
+----
+
+Since the registry is a {data_link}, you can initialize with everything you need:
+
+[source,ruby]
+----
+Etcher::Registry[
+  contract: MyContract,
+  model: MyModel,
+  loaders: [MyLoader.new],
+  transformers: [MyTransformer]
+]
+----
+
+You can also add additional loaders and/or transformers after the fact:
+
+[source,ruby]
+----
+registry = Etcher::Registry.new
+                           .add_loader(MyLoader.new)
+                           .add_transformer(MyTransformer)
+----
+
+💡 Order matters so ensure you list your loaders and transformers in the order you want them to be processed.
+
+=== Contracts
+
+Contracts are critical piece of this workflow as they provide a way to validate incoming data, strip out unwanted data, and create a sanitized record for use in your application. Any contract that has the following behavior will work:
+
+* `#call`: Must be able to consume a {hash_link} and answer an object which can respond to `#to_monad`.
+
+The best gems which adhere to this interface are: {dry_schema_link} and {dry_validation_link}. You'll also want to make sure the {dry_monads_link} extensions are loaded as briefly shown earlier so the result will respond to `#to_monad`. Here's how to enable monad support if using both gems:
+
+[source,ruby]
+----
+Dry::Schema.load_extensions :monads
+Dry::Validation.load_extensions :monads
+----
+
+Using {dry_schema_link} syntax, we could create a contract for verifying email addresses and use it to build a new Etcher instance. Example:
+
+[source,ruby]
+----
+require "dry/schema"
+
+Dry::Schema.load_extensions :monads
+
+contract = Dry::Schema.Params do
+  required(:from).filled :string
+  required(:to).filled :string
+end
+
+etcher = Etcher::Registry[contract:].then { |registry| Etcher.new registry }
+etcher.call
+
+# Failure({:step=>:validate, :payload=>{:from=>["is missing"], :to=>["is missing"]}})
+
+etcher.call from: "Mork", to: "Mindy"
+# Success({:from=>"Mork", :to=>"Mindy"})
+----
+
+Here you can see the power of using a contract to validate your data both as a failure and a success. Unfortunately, with the success, we only get a {hash_link} as a record and it would be nice to structured model which which we'll look at next.
+
+=== Models
+
+A model is any object which responds to `.[]` and can accept a splatted hash. Example: `Model[**attributes]`. These primitives are excellent choices: {hash_link}, {data_link}, and {struct_link}.
+
+ℹ️ Keep in mind that using a `Hash` is the default model and will only result in a pass through situation. You'll want to reach for the more robust `Data` or `Struct` objects instead.
+
+The model is used in the last step of the _etching_ process to create a _frozen_ record for further use by your application. Here's an example where a {data_link} model is used:
+
+[source,ruby]
+----
+model = Data.define :from, :to
+etcher = Etcher::Registry[model:].then { |registry| Etcher.new registry }
+
+etcher.call
+# Failure({:step=>:record, :payload=>"Missing keywords: :from, :to."})
+
+etcher.call from: "Mork", to: "Mindy"
+# Success(#<data Model from="Mork", to="Mindy">)
+----
+
+Notice we get an failure if all attributes are not provided but if we supply the required attributes we get a success.
+
+ℹ️ Keep in mind the default contract is always a pass through so no validation is being done when only using a {hash_link}. Generally you want to supply both a custom contract and model at a minimum.
+
+=== Loaders
+
+Loaders are a great way to load _default_ configuration information for your application which can be in multiple formats. There are a few guidelines to using them:
+
+* They must respond to `#call` with no arguments.
+* All keys are symbolized which helps streamline merging and overriding values from the same keys across multiple configurations.
+* All nested keys will be flattened after being loaded. This means a key structure of `{demo: {one: "test"}}` will be flattened to `demo_one: "test"` which adheres to the {demeter_link} when a new recored is _etched_ for you.
+* The order in which you define your loaders matters. This means the first loader defined will be processed first, then the second, and so forth. Loaders defined last take precedence over loaders defined first when overriding the same keys.
+
+The next couple of sections will help you learn about the supported loaders and how to build your own custom loader.
+
+==== Environment
+
+Use `Etcher::Loaders::Environment` to load configuration information from your {environment_link}. By default, this object wraps `ENV`, uses an empty array for keys to include, and answers a filtered hash where all keys are downcased. _If you don't specify keys to include, then an empty hash is answered back_. Here's a few examples:
+
+[source,ruby]
+----
+# Default behavior.
+loader = Etcher::Loaders::Environment.new
+loader.call
+# Success({})
+
+# With specific includes.
+loader = Etcher::Loaders::Environment.new %w[RACK_ENV DATABASE_URL]
+loader.call
+# Success({"rack_env" => "test", "database_url" => "postgres://localhost/demo_test"})
+
+# With a custom environment and specific include.
+loader = Etcher::Loaders::Environment.new "USER", source: {"USER" => "Jack"}
+loader.call
+# Success({"user"=>"Jack"})
+----
+
+This loader is great for pulling from environment variables as a fallback configuration for your application.
+
+==== JSON
+
+Use `Etcher::Loaders::JSON` to load configuration information from a {json_link} file. Here's how to use this loader (using a file that doesn't exist):
+
+[source,ruby]
+----
+# Default behavior (a custom path is required).
+loader = Etcher::Loaders::JSON.new "your/path/to/configuration.json"
+loader.call  # Success({})
+----
+
+You can also customize the fallback and logger used. Here are the defaults:
+
+[source,ruby]
+----
+loader = Etcher::Loaders::JSON.new "your/path/to/configuration.json",
+                                   fallback: {},
+                                   logger: Logger.new(STDOUT)
+loader.call  # Success({})
+----
+
+If the file did exist and had content, you'd get a `Success` with a `Hash` of the contents.
+
+ℹ️ The logger is only used to log debug information when issues are encountered when reading from the file. This is done to reduce noise in your console when a configuration might have issues and can safely revert to the fallback in order to load the rest of the configuration.
+
+==== YAML
+
+Use `Etcher::Loaders::YAML` to load configuration information from a {yaml_link} file. Here's how to use this loader (using a file that doesn't exist):
+
+[source,ruby]
+----
+# Default behavior (a custom path is required).
+loader = Etcher::Loaders::YAML.new "your/path/to/configuration.yml"
+loader.call  # Success({})
+----
+
+You can also customize the fallback and logger used. Here are the defaults:
+
+[source,ruby]
+----
+loader = Etcher::Loaders::YAML.new "your/path/to/configuration.yml",
+                                   fallback: {},
+                                   logger: Logger.new(STDOUT)
+loader.call  # Success({})
+----
+
+If the file did exist and had content, you'd get a `Success` with a `Hash` of the contents.
+
+ℹ️ The logger is only used to log debug information when issues are encountered when reading from the file. This is done to reduce noise in your console when a configuration might have issues and can safely revert to the fallback in order to load the rest of the configuration.
+
+==== Custom
+
+You can always create your own loader if you don't need or want any of the default loaders provided for you. The only requirement is your loader _must_ respond to `#call` and answer a `Success` with a `Hash` for content which means you can use a class, method, lambda, or proc. Here's an example of creating a custom loader, registering, and using it:
+
+[source,ruby]
+----
+require "dry/monads"
+
+class Demo
+  include Dry::Monads[:result]
+
+  def initialize fallback: {}
+    @fallback = fallback
+  end
+
+  def call = Success fallback
+
+  private
+
+  attr_reader :fallback
+end
+
+etcher = Etcher::Registry[loaders: [Demo.new]].then { |registry| Etcher.new registry }
+etcher.call  # Success({})
+----
+
+While the above isn't super useful since it only answers whatever you provide as fallback information, you can see there is little effort required to implement and customize as desired.
+
+=== Transformers
+
+Transformers are great for modifying specific keys and values. They give you finer grained control over your configuration and are the last step before validating and creating an associated record of your configuration. There are a few guidelines to using them:
+
+* They can be initialized with whatever requirements you might need.
+* They must respond to `#call` which takes a single argument (i.e. `content`) and answers a modified representation of this content as a `Success` with a `Hash` for content.
+
+Here are a few examples of where you could go with this:
+
+The following capitalizes all values (which may or may not be good depending on your data structure).
+
+[source,ruby]
+----
+require "dry/monads"
+
+Capitalize = -> content { Dry::Monads::Success content.transform_values!(&:capitalize) }
+Capitalize.call(name: "test")
+
+# Success({:name=>"Test"})
+----
+
+The following updates current time relative to when configuration was transformed.
+
+[source,ruby]
+----
+require "dry/monads"
+
+CurrentTime = lambda do |content, at: Time.now|
+  content[:at] = at
+  Dry::Monads::Success content
+end
+
+CurrentTime.call({})
+
+# Success({:at=>2023-04-23 15:22:23.746408 -0600})
+----
+
+The following obtains the current Git user's email address from the global Git configuration using the {gitt_link} gem.
+
+[source,ruby]
+----
+require "dry/monads"
+require "gitt"
+
+class GitEmail
+  def initialize git: Gitt::Repository.new
+    @git = git
+  end
+
+  def call(content) = git.get("user.email").fmap { |email| content[:author_email] = email }
+
+  private
+
+  attr_reader :git
+end
+
+GitEmail.new.call({})
+
+# Success("demo@alchemists.io")
+----
+
+To use all of the above, you'd only need to register and use them:
+
+[source,ruby]
+----
+registry = Etcher::Registry[transformers: [Capitalize, CurrentTime, GitEmail.new]]
+etcher = Etcher.new(registry)
+etcher.call
+----
+
+=== Overrides
+
+Overrides are what you pass to the Etcher instance when called. Example:
+
+[source,ruby]
+----
+etcher = Etcher.new
+etcher.call name: "test", label: "Test"
+
+# Success({:name=>"test", :label=>"Test"})
+----
+
+These _overrides_ are applied _after_ all loaders are processed and _before_ any transformations. They are a nice way to deal with user input during runtime or provide any additional configuration not supplied by the loading of your default configuration.
+
+=== Resolver
+
+In situations where you'd like Etcher to handle the complete load, transform, validate, and build steps for you, then you can use the resolver. This is provided for use cases where you'd like Etcher to handle everything for you and abort if otherwise. Example:
+
+[source,ruby]
+----
+Etcher.call name: "demo"
+# {:name=>"demo"}
+----
+
+When called _and there are no issues_, you'll get the fully formed record as a result (in this case a Hash which is the default model). You'll never a get a monad when using `Etcher.call` because this is meant to resolve the monadic pipeline for you. If any failure is encountered, then Etcher will _abort_ with a fatal log message. Here's a variation of earlier examples which demonstrates fatal errors:
+
+[source,ruby]
+----
+require "dry/monads"
+require "dry/schema"
+
+Dry::Schema.load_extensions :monads
+
+contract = Dry::Schema.Params do
+  required(:to).filled :string
+  required(:from).filled :string
+end
+
+model = Data.define :to, :from
+registry = Etcher::Registry.new(contract:, model:)
+
+Etcher.call registry
+
+# 🔥 Unable to load configuration due to the following issues:
+#   - to is missing
+#   - from is missing
+
+Etcher.call registry, to: "Mindy"
+
+# 🔥 Unable to load configuration due to the following issues:
+#   - from is missing
+
+
+registry = Etcher::Registry.new(model: Data.define(:name, :label))
+Etcher.call registry, to: "Mindy"
+
+# 🔥 Build failure: :record. Missing keywords: :name, :label.
+----
+
+💡 When using a custom registry, make sure it's the first argument. All arguments afterwards can be any number of key/values overrides which is similar to how `Etcher.new` works.
+
+== Development
+
+To contribute, run:
+
+[source,bash]
+----
+git clone https://github.com/bkuhlmann/etcher
+cd etcher
+bin/setup
+----
+
+You can also use the IRB console for direct access to all objects:
+
+[source,bash]
+----
+bin/console
+----
+
+=== Architecture
+
+The following illustrates the full sequences of events when _etching_ new records:
+
+image::https://alchemists.io/images/projects/etcher/doc/architecture.svg[Architecture Diagram]
+
+== 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/etcher/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/etcher.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name = "etcher"
+  spec.version = "0.0.0"
+  spec.authors = ["Brooke Kuhlmann"]
+  spec.email = ["brooke@alchemists.io"]
+  spec.homepage = "https://alchemists.io/projects/etcher"
+  spec.summary = "A configuration loader, transformer, and validator."
+  spec.license = "Hippocratic-2.1"
+
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/bkuhlmann/etcher/issues",
+    "changelog_uri" => "https://alchemists.io/projects/etcher/versions",
+    "documentation_uri" => "https://alchemists.io/projects/etcher",
+    "funding_uri" => "https://github.com/sponsors/bkuhlmann",
+    "label" => "Etcher",
+    "rubygems_mfa_required" => "true",
+    "source_code_uri" => "https://github.com/bkuhlmann/etcher"
+  }
+
+  spec.signing_key = Gem.default_key_path
+  spec.cert_chain = [Gem.default_cert_path]
+
+  spec.required_ruby_version = "~> 3.2"
+  spec.add_dependency "cogger", "~> 0.9"
+  spec.add_dependency "core", "~> 0.1"
+  spec.add_dependency "dry-monads", "~> 1.6"
+  spec.add_dependency "refinements", "~> 10.0"
+  spec.add_dependency "zeitwerk", "~> 2.6"
+
+  spec.extra_rdoc_files = Dir["README*", "LICENSE*"]
+  spec.files = Dir["*.gemspec", "lib/**/*"]
+end

data/lib/etcher/builder.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "core"
+require "dry/monads"
+require "refinements/hashes"
+
+module Etcher
+  # Builds a configuration.
+  class Builder
+    include Dry::Monads[:result]
+
+    using Refinements::Hashes
+
+    def initialize registry = Registry.new
+      @registry = registry
+    end
+
+    def call(**overrides)
+      load(overrides).then { |content| transform content }
+                     .bind { |content| validate content }
+                     .bind { |content| record content }
+    end
+
+    private
+
+    attr_reader :registry
+
+    # :reek:NestedIterators
+    # :reek:TooManyStatements
+    def load overrides
+      registry.loaders
+              .map { |loader| loader.call.fmap { |content| content.flatten_keys.symbolize_keys! } }
+              .each
+              .with_object({}) { |content, all| content.bind { |body| all.merge! body } }
+              .merge!(overrides.flatten_keys)
+              .then { |content| Success content }
+    end
+
+    # :reek:NestedIterators
+    def transform content
+      registry.transformers.reduce content do |all, transformer|
+        all.bind { |body| transformer.call body }
+      end
+    end
+
+    def validate content
+      registry.contract
+              .call(content)
+              .to_monad
+              .or { |result| Failure(step: __method__, payload: result.errors.to_h) }
+    end
+
+    def record content
+      Success registry.model[**content.to_h].freeze
+    rescue ArgumentError => error
+      Failure step: __method__, payload: "#{error.message.capitalize}."
+    end
+  end
+end

data/lib/etcher/contract.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+
+module Etcher
+  # A simple passthrough contract.
+  Contract = lambda do |content|
+    def content.to_monad = Dry::Monads::Success self unless content.respond_to? :to_monad
+    content
+  end
+end

data/lib/etcher/loaders/environment.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "core"
+require "dry/monads"
+
+module Etcher
+  module Loaders
+    # Loads environment configuration with optional includes.
+    class Environment
+      include Dry::Monads[:result]
+
+      def initialize includes = Core::EMPTY_ARRAY, source: ENV
+        @includes = Array includes
+        @source = source
+      end
+
+      def call = Success source.slice(*includes).transform_keys(&:downcase)
+
+      private
+
+      attr_reader :includes, :source
+    end
+  end
+end

data/lib/etcher/loaders/json.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "core"
+require "dry/monads"
+require "json"
+
+module Etcher
+  module Loaders
+    # Loads a JSON configuration.
+    class JSON
+      include Dry::Monads[:result]
+
+      def initialize path, fallback: Core::EMPTY_HASH, logger: LOGGER
+        @path = path
+        @fallback = fallback
+        @logger = logger
+      end
+
+      def call
+        Success ::JSON.load_file(path)
+      rescue TypeError, Errno::ENOENT
+        debug_and_fallback "Invalid path: #{path_info}. Using fallback."
+      rescue ::JSON::ParserError => error
+        debug_and_fallback "#{error.message}. Path: #{path_info}. Using fallback."
+      end
+
+      private
+
+      attr_reader :path, :fallback, :logger
+
+      def path_info = path.to_s.inspect
+
+      def debug_and_fallback message
+        logger.debug { message }
+        Success fallback
+      end
+    end
+  end
+end

data/lib/etcher/loaders/yaml.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "core"
+require "dry/monads"
+require "yaml"
+
+module Etcher
+  module Loaders
+    # Loads a YAML configuration.
+    class YAML
+      include Dry::Monads[:result]
+
+      def initialize path, fallback: Core::EMPTY_HASH, logger: LOGGER
+        @path = path
+        @fallback = fallback
+        @logger = logger
+      end
+
+      def call
+        load
+      rescue TypeError, Errno::ENOENT
+        debug_and_fallback "Invalid path: #{path_info}. Using fallback."
+      rescue Psych::Exception => error
+        debug_and_fallback "#{error.message}. Path: #{path_info}. Using fallback."
+      end
+
+      private
+
+      attr_reader :path, :fallback, :logger
+
+      def load
+        content = ::YAML.safe_load_file path
+
+        return Success content if content.is_a? Hash
+
+        debug_and_fallback "Invalid content: #{content.inspect}. Using fallback."
+      end
+
+      def path_info = path.to_s.inspect
+
+      def debug_and_fallback message
+        logger.debug { message }
+        Success fallback
+      end
+    end
+  end
+end

data/lib/etcher/registry.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Etcher
+  # Provides a registry of customization for loading and resolving a configuration.
+  Registry = Data.define :contract, :model, :loaders, :transformers do
+    def initialize contract: Contract, model: Hash, loaders: [], transformers: []
+      super
+    end
+
+    def add_loader loader
+      loaders.append loader
+      self
+    end
+
+    def add_transformer transformer
+      transformers.append transformer
+      self
+    end
+  end
+end

data/lib/etcher/resolver.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "refinements/arrays"
+
+module Etcher
+  # Builds and fully resolves a configuration.
+  class Resolver
+    include Dry::Monads[:result]
+
+    using Refinements::Arrays
+
+    def initialize registry = Registry.new, kernel: Kernel, logger: LOGGER
+      @builder = Builder.new registry
+      @kernel = kernel
+      @logger = logger
+    end
+
+    def call(**overrides)
+      case builder.call(**overrides)
+        in Success(content) then content
+        in Failure(step:, payload: String => payload)
+          logger.fatal { "Build failure: #{step.inspect}. #{payload}" }
+          kernel.abort
+        in Failure(step:, payload: Hash => payload) then log_and_abort payload
+        else fail StandardError, "Unable to parse configuration."
+      end
+    end
+
+    private
+
+    attr_reader :builder, :kernel, :logger
+
+    def log_and_abort errors
+      logger.fatal do
+        details = errors.map { |key, message| "  - #{key} #{message.to_sentence}\n" }
+                        .join
+        "Unable to load configuration due to the following issues:\n#{details}"
+      end
+
+      kernel.abort
+    end
+  end
+end

data/lib/etcher.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "cogger"
+require "zeitwerk"
+
+Zeitwerk::Loader.for_gem.then do |loader|
+  loader.inflector.inflect "json" => "JSON", "yaml" => "YAML"
+  loader.setup
+end
+
+# Main namespace.
+module Etcher
+  LOGGER = Cogger.new id: :etcher, formatter: :emoji
+
+  def self.new(...) = Builder.new(...)
+
+  def self.call(registry = Registry.new, **) = Resolver.new(registry).call(**)
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: etcher
+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-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cogger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !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: '10.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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
+- etcher.gemspec
+- lib/etcher.rb
+- lib/etcher/builder.rb
+- lib/etcher/contract.rb
+- lib/etcher/loaders/environment.rb
+- lib/etcher/loaders/json.rb
+- lib/etcher/loaders/yaml.rb
+- lib/etcher/registry.rb
+- lib/etcher/resolver.rb
+homepage: https://alchemists.io/projects/etcher
+licenses:
+- Hippocratic-2.1
+metadata:
+  bug_tracker_uri: https://github.com/bkuhlmann/etcher/issues
+  changelog_uri: https://alchemists.io/projects/etcher/versions
+  documentation_uri: https://alchemists.io/projects/etcher
+  funding_uri: https://github.com/sponsors/bkuhlmann
+  label: Etcher
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/bkuhlmann/etcher
+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.12
+signing_key:
+specification_version: 4
+summary: A configuration loader, transformer, and validator.
+test_files: []