etcher 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c9a9da371f697c41f455434c269b2230dc07ae9f9342d009c4f562e4a047a57
-  data.tar.gz: 2daffd0030266da21a1192a1031358f098f3523852e0857a9195009d18598b5a
+  metadata.gz: bdae8d6e407c3a6d7f9c43c79be0f97040996c4460f726976931a0a395c6f0c5
+  data.tar.gz: 0ff6f4e79245a0e14c4e7dc36672562b5ae7ea370dd9a9ce1dae0cc83ff950bc
 SHA512:
-  metadata.gz: 968e58e3c5f1fa21ae898d6d71fb3fca3134b368a6bdb85eaa397ca92d19e7de255ec1ae0bb8f31710d53163defeaace018b93eb52b41ac25ed47d6af9e35f1a
-  data.tar.gz: 99eea4d38800458cd1d674e250c09764bde7e32a34cf27eaeb33b640b3650346b9ddcb7687f6800553eca891ac209e29c33f5b71b6331abb56a8ce01b7f49371
+  metadata.gz: e9cd8e067ab556f27a53804f18f389a41a3987f9e942dcfa471cfbc937fc4a2a353c3f6a0bf260daa91667906bdcd8e162d99133563a6386fa98c9e241f3174c
+  data.tar.gz: 5feeefaa7b6216791071572592d69e93fcbd5de940ff36713c68fec83e368fa53374ab42b780748c26b08c8acc283dbe03ef77c0d2a45cf0ca379a992754db38

data/README.adoc

@@ -17,6 +17,7 @@
 :sod_link: link:https://alchemists.io/projects/sod[Sod]
 :struct_link: link:https://alchemists.io/articles/ruby_structs[Struct]
 :transactable_link: link:https://alchemists.io/projects/transactable[Transactable]
+:versionaire_link: link:https://alchemists.io/projects/versionaire[Versionaire]
 :xdg_link: link:https://alchemists.io/projects/xdg[XDG]
 :yaml_link: link:https://rubyapi.org/o/yaml[YAML]
 
@@ -125,6 +126,18 @@ While this is a more advanced use case, you'll usually only need to register a c
 
 ℹ️ All keys are converted to symbols before being processed. This is done to ensure consistency and improve debugablity when dealing with raw input that might be a mix of strings and/or symbols.
 
+=== Steps
+
+As hinted at above, the complete sequence of steps are performed in the order listed:
+
+. *Load*: Each loader, if any, is called and merged with the previous loader to build initial content.
+. *Override*: Any overrides are merged with the result of the last loader to produce updated content.
+. *Transform*: Each transformer, if any, is called to transform and manipulate the content.
+. *Validate*: The contract is called to validate the content as previously loaded, overwritten, and transformed.
+. *Model*: The model consumes the content of the validated contract and creates a new record for you to use as needed.
+
+You can use the above steps as a reference when using this gem. Each step is explained in greater detail below.
+
 === 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:
@@ -198,14 +211,16 @@ Here you can see the power of using a contract to validate your data both as a f
 
 === Types
 
-To support contracts further, especially when working with file paths, there is a custom type for pathnames:
+To support contracts further, there are a couple custom types which might be of interest. Each custom type, as described below, is made possible via {dry_types_link}.
+
+==== Pathnames
 
 [source,ruby]
 ----
 Etcher::Types::Pathname
 ----
 
-This means you can use this custom type in your contracts to validate and cast pathnames:
+The above allows you to use pathname types in your contracts to validate and cast as pathnames:
 
 [source,ruby]
 ----
@@ -217,7 +232,24 @@ contract.call(path: "a/path").to_monad
 # Success(#<Dry::Schema::Result{:path=>#<Pathname:a/path>} errors={} path=[]>)
 ----
 
-All of this is made possible via {dry_types_link} so make sure to check out documentation for details.
+==== Versions
+
+[source,ruby]
+----
+Etcher::Types::Version
+----
+
+The above allows you to validate and cast versions within your contracts -- via the {versionaire_link} gem -- as follows:
+
+[source,ruby]
+----
+contract = Dry::Schema.Params do
+  required(:version).filled Etcher::Types::Version
+end
+
+contract.call(version: "1.2.3").to_monad
+# Success(#<Dry::Schema::Result{:version=>"1.2.3"} errors={} path=[]>)
+----
 
 === Models
 

data/etcher.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "etcher"
-  spec.version = "0.2.1"
+  spec.version = "0.3.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/etcher"
@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "dry-monads", "~> 1.6"
   spec.add_dependency "dry-types", "~> 1.7"
   spec.add_dependency "refinements", "~> 11.0"
+  spec.add_dependency "versionaire", "~> 12.1"
   spec.add_dependency "zeitwerk", "~> 2.6"
 
   spec.extra_rdoc_files = Dir["README*", "LICENSE*"]

data/lib/etcher/types.rb

@@ -2,6 +2,7 @@
 
 require "dry/types"
 require "pathname"
+require "versionaire"
 
 module Etcher
   # Defines custom types.
@@ -9,5 +10,6 @@ module Etcher
     include Dry.Types(default: :strict)
 
     Pathname = Constructor ::Pathname
+    Version = Constructor Versionaire::Version, Versionaire.method(:Version)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: etcher
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2023-06-19 00:00:00.000000000 Z
+date: 2023-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cogger
@@ -107,6 +107,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: versionaire
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -168,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.14
+rubygems_version: 3.4.15
 signing_key:
 specification_version: 4
 summary: A monadic configuration loader, transformer, and validator.