etcher 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f77fefa60ba596414bd1453ca278ef82a4839286e4c822260bbf7ed391b2fa5a
-  data.tar.gz: 34076cfa28541ac3f6778bde4167a758473bb03874aa3233029df6248af24c78
+  metadata.gz: 34d9eedad8aac01a9cc35426821d3e8893d312f03c21aa22a75ceb808347248f
+  data.tar.gz: a24eaa182c934a5974031e5ab3502c5bc7ae927ab7323989626c86923839e6af
 SHA512:
-  metadata.gz: f6c2d11ab82fb53535fb7606e5a160381febab7632eb39f8fe91b677b629416536016db42f1838a2a59cf0c51595f6647762758b70356685a7194bda023ac00e
-  data.tar.gz: 260f3e2e1e55d3a82d862aa3140a453f7a357dbc8a5e0702f472e113d180b62b0bd011f641c612846230726b5514231c7b7412fa07cfe3251ad3dc126d204493
+  metadata.gz: 92e846388ce7fa423218b12db7c7082cdc4b9907bdfeebe6f0a86143ca0f3b82d053f35a6987a91d884bac2d9c9612d65abd5f764b41a8a423fc17837d842fe2
+  data.tar.gz: a7b0025873525c4e907ed455d5b5403bad83eac37d45710b62cc24339d75d22022797b18e42e92d51d72e6861da664854420ad8f901623d2f853054c866d4c8c

checksums.yaml.gz.sig

@@ -1 +1,4 @@
-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��
+y�k�?�_̑$$�<o,��x"W��|j��?6�qu�7�]#�Qņ��^
+\�`�$�ٷn���X��'�1VN���TJ �����a�����<N�}�mp�-��?7Xˡ*ˡ
+6�>:b�|�6�>�-�����l��Nڰ���d�u �t����귽�mG@e��`�o�6�0�Aqa/��i�i���������;_#/J���RK�d�{�_9�Tpj��XE~v�r��*
+��ۤ�����И]�6��Qz�9����8Y<�U��c�W��8u3�_�

data/README.adoc

@@ -7,6 +7,7 @@
 :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_types_link: link:https://dry-rb.org/gems/dry-types[Dry Types]
 :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]
@@ -190,6 +191,29 @@ etcher.call 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.
 
+=== Types
+
+To support contracts further, especially when working with file paths, there is a custom type for pathnames:
+
+[source,ruby]
+----
+Etcher::Types::Pathname
+----
+
+This means you can use this custom type in your contracts to validate and cast pathnames:
+
+[source,ruby]
+----
+contract = Dry::Schema.Params do
+  required(:path).filled Etcher::Types::Pathname
+end
+
+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.
+
 === 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}.

data/etcher.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |spec|
   spec.name = "etcher"
-  spec.version = "0.0.0"
+  spec.version = "0.1.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.summary = "A monadic configuration loader, transformer, and validator."
   spec.license = "Hippocratic-2.1"
 
   spec.metadata = {
@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "cogger", "~> 0.9"
   spec.add_dependency "core", "~> 0.1"
   spec.add_dependency "dry-monads", "~> 1.6"
+  spec.add_dependency "dry-types", "~> 1.7"
   spec.add_dependency "refinements", "~> 10.0"
   spec.add_dependency "zeitwerk", "~> 2.6"
 

data/lib/etcher/builder.rb

@@ -16,9 +16,9 @@ module Etcher
     end
 
     def call(**overrides)
-      load(overrides).then { |content| transform content }
-                     .bind { |content| validate content }
-                     .bind { |content| record content }
+      load(overrides.symbolize_keys!).then { |content| transform content }
+                                     .bind { |content| validate content }
+                                     .bind { |content| record content }
     end
 
     private

data/lib/etcher/types.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "dry/types"
+require "pathname"
+
+module Etcher
+  # Defines custom types.
+  module Types
+    include Dry.Types(default: :strict)
+
+    Pathname = Constructor ::Pathname
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: etcher
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2023-04-23 00:00:00.000000000 Z
+date: 2023-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cogger
@@ -79,6 +79,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: refinements
   requirement: !ruby/object:Gem::Requirement
@@ -127,6 +141,7 @@ files:
 - lib/etcher/loaders/yaml.rb
 - lib/etcher/registry.rb
 - lib/etcher/resolver.rb
+- lib/etcher/types.rb
 homepage: https://alchemists.io/projects/etcher
 licenses:
 - Hippocratic-2.1
@@ -156,5 +171,5 @@ requirements: []
 rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
-summary: A configuration loader, transformer, and validator.
+summary: A monadic configuration loader, transformer, and validator.
 test_files: []