initable 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11652b09ebedba190e0b35394028990c76e9102ab9f0a35f16d48af094cfeb74
-  data.tar.gz: a92c36ccaa4ee2b6ee7cb8598017fb8a10c92769255196bf301df8594b6ec812
+  metadata.gz: d077a6ae86ec556acd9cb1bb729502462f1f854a81038ab425b1785cea02953f
+  data.tar.gz: 758d05271874c63d0d050126e83b79faf3e84376642c19842ee2ee58542185f4
 SHA512:
-  metadata.gz: fce4f982b787297b4d392fab52a64fd77684b74516007f403badf86abaeea65cae9129c48f02b343ac3d57b0783731b36ff07ddc46762252eac9dea259e142ca
-  data.tar.gz: 17ab62fe13848134324f536a8d4b0b867623d37c538aec81aa724b5ff7b9c51cb2137270681948895f72baf949ff33a5ef02a5fc342ce7691e70c388fb5d294f
+  metadata.gz: f9aaf8054d7ce64c1d0ea29c4f1c8fd068cd5d634adad82da5720483962ce8a248f97528e1f3f54477920b0f12a4c6f7c9ab7c9e0f3183dcdf6e81394b76833f
+  data.tar.gz: fc56bac11899b0042df1ebe715683bd680f82aceb849e51561e9c57f23c696aa5a55b7049257bae02458d914e642a8e3bc1ef2157ad7feb0cc2ae28e001226ff

data/README.adoc

@@ -18,10 +18,11 @@ toc::[]
 == Features
 
 * Provides a Domain Specific Language (DSL) for initializing objects.
+* Built atop the {marameters_link}.
 * Uses the same data structure as answered by {method_parameters_link}.
 * Adheres to the {barewords_link} pattern.
 * Reduces the amount of code necessary to implement an object.
-* Built atop the {marameters_link} gem.
+* Pairs well with {infusible_link}.
 
 == Requirements
 
@@ -317,7 +318,7 @@ This is useful when needing to forward a block to the super class.
 
 === Defaults
 
-You've already seen that you can provide a third element for defaults with optional positional and keyword parameters. Sometimes, though, you might want to use a more complex object as a default (especially if you want the default to be lazy loaded/initialized). For those situations use a `Proc`. Example:
+You've already seen you can provide a third element for defaults with optional positional and keyword parameters. Sometimes, though, you might want to use a more complex object as a default (especially if you want the default to be lazy loaded/initialized). For those situations use a `Proc`. Example:
 
 [source,ruby]
 ----
@@ -334,12 +335,12 @@ demo.new
 
 Notice, for the `one` optional positional parameter, we get a default value of `"One"` once evaluated. For the `two` optional keyword parameter, we get a new instance of `Object` as a default value.
 
-⚠️ At the moment, there a few caveats to be aware of when using procs as defaults:
+⚠️ There a few caveats to be aware of when using proc-based defaults:
 
 * Use procs because lambdas will throw a `TypeError`.
 * Use procs _with no arguments_ because only the body of the `Proc` is meant to be parsed. Otherwise, you'll get an `ArgumentError`.
-* Ensure each parameter is defined on a distinct line because the body of the `Proc` is extracted at runtime from the source location of the `Proc`. The goal is to improve upon this more in the future.
-* Avoid using within an IRB session because each value will evaluate as `nil`.
+* Ensure each parameter -- with a default -- is defined on a distinct line because the body of the `Proc` is extracted at runtime from the source location of the `Proc`. The goal is to improve upon this further once Ruby supports source location with line start, line end, column start, and column end information.
+* Avoid using C-based primitives since source code can't be obtained and you'll get a `StandardError`.
 
 === Barewords
 
@@ -640,6 +641,20 @@ child.new { "demo" }
 
 With blocks, you only have to name them in the `parent` and they will be forwarded by the child. Keep in mind that if you only need to pass the block to the parent but want to use a `block_given?` check before messaging the function in your parent class, then you don't need to use this gem for those situations.
 
+=== Infusible
+
+This gem pairs well with the {infusible_link} gem and requires no additional effort on your part. In terms of style, stick with including Initiable before Infusible because you'll most likely be using Initable to define basic parameters while Infusible will be used to inject dependencies from your container. This way your parameters will read sequentially left-to-right or top-to-bottom when looking at the implementation which improves readability. Example:
+
+[source,ruby]
+----
+class Demo
+  include Initable[%i[req label]]
+  include Infusible[:logger]
+end
+----
+
+You can include Initiable and Infusible in any order, though. Lastly, as with all keyword parameters, make sure you don't define the same key for both or you'll have an order of operations issue where one key overrides the other.
+
 === Guidelines
 
 The following is worth adhering to:

data/initable.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "initable"
-  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/initable"
@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.cert_chain = [Gem.default_cert_path]
 
   spec.required_ruby_version = "~> 3.4"
-  spec.add_dependency "marameters", "~> 4.0"
+  spec.add_dependency "marameters", "~> 4.1"
 
   spec.extra_rdoc_files = Dir["README*", "LICENSE*"]
   spec.files = Dir["*.gemspec", "lib/**/*"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: initable
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -34,7 +34,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2025-01-01 00:00:00.000000000 Z
+date: 2025-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: marameters
@@ -42,14 +42,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.1'
 email:
 - brooke@alchemists.io
 executables: []