initable 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 11652b09ebedba190e0b35394028990c76e9102ab9f0a35f16d48af094cfeb74
+  data.tar.gz: a92c36ccaa4ee2b6ee7cb8598017fb8a10c92769255196bf301df8594b6ec812
+SHA512:
+  metadata.gz: fce4f982b787297b4d392fab52a64fd77684b74516007f403badf86abaeea65cae9129c48f02b343ac3d57b0783731b36ff07ddc46762252eac9dea259e142ca
+  data.tar.gz: 17ab62fe13848134324f536a8d4b0b867623d37c538aec81aa724b5ff7b9c51cb2137270681948895f72baf949ff33a5ef02a5fc342ce7691e70c388fb5d294f

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,694 @@
+:toc: macro
+:toclevels: 5
+:figure-caption!:
+
+:barewords_link: link:https://alchemists.io/articles/barewords_pattern[Barewords]
+:containable_link: link:https://alchemists.io/projects/containable[Containable]
+:infusible_link: link:https://alchemists.io/projects/infusible[Infusible]
+:marameters_link: link:https://alchemists.io/projects/marameters[Marameters]
+:method_parameters_and_arguments_link: link:https://alchemists.io/articles/ruby_method_parameters_and_arguments[Method Parameters and Arguments]
+:method_parameters_link: link:https://docs.ruby-lang.org/en/master/Method.html#method-i-parameters[Method#parameters]
+
+= Initable
+
+Initable provides automatic initialization of your objects by leveraging the same parameter structure as provided by {method_parameters_link} while adhering to the {barewords_link} pattern for scoping of attributes. This allows you to quickly define what data/dependencies your object should be constructed with while minimizing the amount of code written. 🎉
+
+toc::[]
+
+== Features
+
+* Provides a Domain Specific Language (DSL) for initializing objects.
+* 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.
+
+== Requirements
+
+. link:https://www.ruby-lang.org[Ruby].
+. A solid understanding of {method_parameters_and_arguments_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/gems.pem)
+gem install initable --trust-policy HighSecurity
+----
+
+To install _without_ security, run:
+
+[source,bash]
+----
+gem install initable
+----
+
+You can also add the gem directly to your project:
+
+[source,bash]
+----
+bundle add initable
+----
+
+Once the gem is installed, you only need to require it:
+
+[source,ruby]
+----
+require "initable"
+----
+
+== Usage
+
+You only need to require this gem, include the module within your class, and configure the necessary parameters for object initialization. The following provides a simple `Person` object that is  implemented with and without the use of this gem so you can compare, contrast, and notice the reduction in code used:
+
+*With*
+
+[source,ruby]
+----
+require "initable"
+
+class Person
+  include Initable[%i[keyreq first], %i[keyreq last], %i[key middle]]
+
+  def name = [first, middle, last].compact.join " "
+end
+
+person = Person.new first: "Alfred", last: "Pennyworth"
+#<Person:0x000000012d0711c8 @first="Alfred", @last="Pennyworth", @middle=nil>
+
+person.name
+# "Alfred Pennyworth"
+
+person.first
+# private method `first' called for #<Person:0x0000000123899eb8> (NoMethodError)
+----
+
+*Without*
+
+[source,ruby]
+----
+class Person
+  def initialize first:, last:, middle: nil
+    @first = first
+    @last = last
+    @middle = middle
+  end
+
+  def name = [first, middle, last].compact.join " "
+
+  private
+
+  attr_reader :first, :last, :middle
+end
+
+person = Person.new first: "Alfred", last: "Pennyworth"
+#<Person:0x0000000123899eb8 @first="Alfred", @last="Pennyworth", @middle=nil>
+
+person.name
+# "Alfred Pennyworth"
+
+person.first
+# private method `first' called for #<Person:0x0000000123899eb8> (NoMethodError)
+----
+
+Notice, in the examples above, we are able to obtain an instance of `Person` with identical behavior. Even better, using this gem requires less code. We can also see the associated attributes are properly initialized as instance variables. All attributes are _privately_ scoped, by default, so your object doesn't break encapsulation.
+
+The rest of this documentation will focus on how to use this gem with the parameters data structure shared {method_parameters_link}.
+
+ℹ️ Please note, for the rest of this documentation, anonymous classes will be used for code examples which makes local experimentation a smoother experience within your IRB console since you get a new instance of a class each time without having to create new constants or deal with constant collisions.
+
+=== Parameters
+
+There are eight _kinds_ of parameters you can use in method signatures as supported by {method_parameters_link} and detailed in the {method_parameters_and_arguments_link} article. The format is always kind, name, and default. Example:
+
+----
+[<kind>, <name>, <default>]
+----
+
+💡 The default (third element) is always optional which, granted, isn't supported by {method_parameters_link} but is part of this DSL so you can supply a default value for optional positional or keyword parameters with minimal effort.
+
+As detailed in the {method_parameters_and_arguments_link} article, the order of each kind of parameter matters because if you define them out of order, you'll get a syntax error as you would get when not using this gem to initialize an object. For reference, here's the natural order of parameters for a method signature in case it helps:
+
+----
+%i[req opt rest nokey keyreq key keyrest block]
+----
+
+Simply speaking, this means `req` is always in the first position and `block` is always in the last position. You can skip parameters in between, as necessary, but position is always important regardless of what you use.
+
+Each _kind_ of parameter is detailed in the following sections.
+
+==== req
+
+Use `req` when you need a _required positional_ parameter:
+
+[source,ruby]
+----
+demo = Class.new do
+  include Initable[%i[req example]]
+end
+
+demo.new    # wrong number of arguments (given 0, expected 1) (ArgumentError)
+demo.new 1  #<#<Class:0x0000000121562940>:0x0000000122244500 @example=1>
+----
+
+==== opt
+
+Use `opt` when you need an _optional positional_ parameter:
+
+[source,ruby]
+----
+demo = Class.new do
+  include Initable[%i[opt example]]
+end
+
+demo.new    #<#<Class:0x00000001215c1a58>:0x0000000124c3d000 @example=nil>
+demo.new 1  #<#<Class:0x0000000120d4f5a0>:0x00000001248b3ee8 @example=1>
+----
+
+You can also provide a default value by supplying a third element for the parameter:
+
+[source,ruby]
+----
+demo = Class.new do
+  include Initable[[:opt, :example, 1]]
+end
+
+demo.new     #<#<Class:0x00000001232d6198>:0x0000000131c31c98 @example=1>
+demo.new 10  #<#<Class:0x00000001232d6198>:0x0000000131d1fb00 @example=10>
+----
+
+==== rest
+
+Use `rest` when you need any number of _optional positional_ parameters:
+
+[source,ruby]
+----
+demo = Class.new do
+  include Initable[%i[rest example]]
+end
+
+demo.new          #<#<Class:0x00000001215ef8e0>:0x0000000125272f88 @example=[]>
+demo.new 1, 2, 3  #<#<Class:0x00000001215ef8e0>:0x0000000124f9c228 @example=[1, 2, 3]>
+----
+
+For anonymous single splats (i.e. `+*+`), don't provide a name. Use only the kind:
+
+[source,ruby]
+----
+demo = Class.new do
+  include Initable[[:rest]]
+end
+----
+
+This is useful when needing to forward all positional arguments to the super class.
+
+==== nokey
+
+Use `nokey` when you want to prevent use of any _keyword_ parameter (i.e. `+**nil+`):
+
+[source,ruby]
+----
+demo = Class.new do
+  include Initable[[:nokey]]
+end
+
+demo.new       #<#<Class:0x0000000123d1f820>:0x00000001300baf78>
+demo.new a: 1  # wrong number of arguments (given 1, expected 0) (ArgumentError)
+----
+
+==== keyreq
+
+Use `keyreq` when you need a _required keyword_ parameter:
+
+[source,ruby]
+----
+demo = Class.new do
+  include Initable[%i[keyreq example]]
+end
+
+demo.new             # missing keyword: :example (ArgumentError)
+demo.new example: 1  #<#<Class:0x0000000123c99d88>:0x0000000130655ed8 @example=1>
+----
+
+==== key
+
+Use `key` when you need an _optional keyword_ parameter:
+
+[source,ruby]
+----
+demo = Class.new do
+  include Initable[%i[key example]]
+end
+
+demo.new             #<#<Class:0x0000000123c30e78>:0x00000001307b0008 @example=nil>
+demo.new example: 1  #<#<Class:0x0000000123c99d88>:0x0000000130655ed8 @example=1>
+----
+
+You can also provide a default value by supplying a third element for the parameter:
+
+[source,ruby]
+----
+demo = Class.new do
+  include Initable[[:key, :example, 1]]
+end
+
+demo.new              #<#<Class:0x0000000123215b50>:0x000000013007ee88 @example=1>
+demo.new example: 10  #<#<Class:0x0000000123215b50>:0x00000001300ff998 @example=10>
+----
+
+==== keyrest
+
+Use `keyrest` when you need any number of _keyword_ parameters:
+
+[source,ruby]
+----
+demo = Class.new do
+  include Initable[%i[keyrest example]]
+end
+
+demo.new
+#<#<Class:0x0000000123d117c0>:0x000000013051e3f8 @example={}>
+
+demo.new a: 1, b: 2
+#<#<Class:0x0000000123d117c0>:0x000000013069e2c8 @example={:a=>1, :b=>2}>
+----
+
+For anonymous double splats (i.e. `+**+`), don't provide a name. Use only the kind:
+
+[source,ruby]
+----
+demo = Class.new do
+  include Initable[[:keyrest]]
+end
+----
+
+This is useful when needing to forward all keyword arguments to the super class.
+
+==== block
+
+Use `block` when you need a _block_ parameter:
+
+[source,ruby]
+----
+demo = Class.new do
+  include Initable[%i[block example]]
+end
+
+demo.new
+#<#<Class:0x0000000123b59b08>:0x000000013193bac0 @example=nil>
+
+instance = demo.new { "Hi" }
+#<#<Class:0x0000000123b59b08>:0x0000000131a9a380 @example=#<Proc:0x0000000131a9a358 (irb):45>>
+----
+
+For anonymous blocks (i.e. `+&+`), don't provide a name. Use only the kind:
+
+[source,ruby]
+----
+demo = Class.new do
+  include Initable[[:block]]
+end
+----
+
+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:
+
+[source,ruby]
+----
+demo = Class.new do
+  include Initable[
+    [:opt, :one, proc { %w[O n e].join }],
+    [:key, :two, proc { Object.new }]
+  ]
+end
+
+demo.new
+#<#<Class:0x00000001532d4390>:0x0000000153a9b0b0 @one="One", @two=#<Object:0x0000000153a9ade0>>
+----
+
+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:
+
+* 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`.
+
+=== Barewords
+
+As mentioned earlier, all instances adhere to the {barewords_link} pattern so you have direct access to all data/dependencies via bare word methods. Here's an example with an instance using a required positional and optional keyword parameter.
+
+[source,ruby]
+----
+demo = Class.new do
+  include Initable[%i[req one], [:key, :two, 2]]
+
+  def debug = puts "One: #{one}, Two: #{two}."
+end
+
+demo.new(1).debug  # One: 1, Two: 2.
+----
+
+Notice, with the `debug` method, only bare words are used as provided by the attribute readers.
+
+=== Scopes
+
+As mentioned earlier, all attributes are scoped -- via `attr_reader` -- as `private` by default but `protected` and `public` scopes are supported too. Here are examples of each:
+
+==== Private
+
+[source,ruby]
+----
+demo = Class.new do
+  include Initable[%i[req example]]
+end
+
+demo.new(1).example
+# private method `example' called for an instance of #<Class:0x000000012c1f78b8> (NoMethodError)
+----
+
+==== Protected
+
+[source,ruby]
+----
+demo = Class.new do
+  include Initable.protected(%i[req example])
+end
+
+demo.new(1).example
+# protected method `example' called for an instance of #<Class:0x000000012b316ec0> (NoMethodError)
+----
+
+==== Public
+
+[source,ruby]
+----
+demo = Class.new do
+  include Initable.public(%i[req example])
+end
+
+demo.new(1).example
+# 1
+----
+
+==== Combinations
+
+You can combine scopes, if desired, as well. Here's an example using three required positional parameters with different scopes:
+
+[source,ruby]
+----
+demo = Class.new do
+  include Initable[%i[req one]]
+  include Initable.protected(%i[req two])
+  include Initable.public(%i[req three])
+end
+
+instance = demo.new 1, 2, 3
+#<#<Class:0x000000012c4d3708>:0x00000001501fbc78 @one=1, @two=2, @three=3>
+
+instance.one
+# private method `one' called for an instance of #<Class:0x000000012c4d3708> (NoMethodError)
+
+instance.two
+# protected method `two' called for an instance of #<Class:0x000000012c4d3708> (NoMethodError)
+
+instance.three
+# 3
+----
+
+⚠️ While convenient to initialize an object with different scopes, this does introduce additional multiple inheritance in your object ancestry. While not necessarily bad, if your object isn't overly complicated or requires more than three parameters (🎗️ Don't forget to adhere to the _rule of three_), you might need to break your class into smaller dependencies and/or switch to manually defining the `initialize` method.
+
+=== Inheritance
+
+Inheritance works similar to parent/child relationships as found in standard Ruby classes with a few enhancements thrown in for convenience. Several examples are provided below. For each, there is an identical implementation using Plain Old Ruby Objects (POROs) so you can contrast/compare for clarity.
+
+[source,ruby]
+----
+parent = Class.new do
+  include Initable.protected(%i[req one])
+end
+
+child = Class.new parent do
+  include Initable[[:opt, :two, 2]]
+end
+
+parent.new 1
+#<#<Class:0x00000001252988f0>:0x00000001265f0c90 @one=1>
+
+child.new 1
+#<#<Class:0x0000000123a5a158>:0x00000001254beb20 @one=1, @two=2>
+
+child.new 10, 20
+#<#<Class:0x000000012261a828>:0x0000000126973d40 @one=10, @two=20>
+----
+
+.Plain Implementation
+[%collapsible]
+====
+[source,ruby]
+----
+parent = Class.new do
+  def initialize one
+    @one = one
+  end
+
+  protected
+
+  attr_reader :one
+end
+
+child = Class.new parent do
+  def initialize one, two = 2
+    super one
+    @two = two
+  end
+
+  private
+
+  attr_reader :two
+end
+
+parent.new 1
+#<#<Class:0x0000000127b3f790>:0x0000000134abe368 @one=1>
+
+child.new 1
+#<#<Class:0x0000000127b3f5b0>:0x0000000134b16748 @one=1, @two=2>
+
+child.new 10, 20
+#<#<Class:0x0000000127b3f5b0>:0x0000000134b91880 @one=10, @two=20>
+----
+====
+
+Notice the `child` instance has access to both the `one` and `two` attributes where `one` is defined as _protected_ by the `parent` and `two` is defined as _private_ for the `child`. This is no different in how you'd subclass without using this gem. You only need to define the attributes you need in the `child` class since there is no need to redefine what the `parent` already has defined. This gem will handle proper setup of your instance variables as well as forwarding, via `super`, any/all attributes to the `parent` as necessary. The automatic forwarding, via `super`, applies for all parameters.
+
+==== Positionals
+
+[source,ruby]
+----
+parent = Class.new do
+  include Initable.protected(%i[req one], [:opt, :two, 2])
+end
+
+child = Class.new parent do
+  include Initable[%i[req three], [:opt, :two, 2]]
+end
+
+child.new 1, 3
+#<#<Class:0x0000000126012ee0>:0x0000000128591478 @one=1, @two=2, @three=3>
+
+child.new 1, 3, 20
+#<#<Class:0x0000000126012ee0>:0x00000001286353e8 @one=1, @two=20, @three=3>
+----
+
+.Plain Implementation
+[%collapsible]
+====
+[source,ruby]
+----
+parent = Class.new do
+  def initialize one, two = 2
+    @one = one
+    @two = two
+  end
+
+  private
+
+  attr_reader :one, :two
+end
+
+child = Class.new parent do
+  def initialize one, three, two = 2
+    super one, two
+    @three = three
+  end
+
+  private
+
+  attr_reader :three
+end
+
+child.new 1, 3
+#<#<Class:0x0000000126076e18>:0x0000000128297240 @one=1, @two=2, @three=3>
+
+child.new 1, 3, 20
+#<#<Class:0x0000000126076e18>:0x00000001284344b8 @one=1, @two=20, @three=3>
+----
+====
+
+Positional parameters are less flexible than keyword parameters especially when optional parameters are involved because the order of parameters matters and the `two` parameter with a default of `2` has to be repeated in the child so `two` can be forwarded by `super` when not supplied.
+
+==== Keywords
+
+[source,ruby]
+----
+parent = Class.new do
+  include Initable.protected(%i[keyreq one], [:key, :two, 2])
+end
+
+child = Class.new parent do
+  include Initable[%i[keyreq three], [:key, :four, 4]]
+end
+
+child.new one: 1, three: 3
+#<#<Class:0x000000012e052ee8>:0x0000000138311800 @one=1, @two=2, @three=3, @four=4>
+
+child.new one: 1, two: 20, three: 3, four: 40
+#<#<Class:0x000000012e052ee8>:0x00000001383d0b10 @one=1, @two=20, @three=3, @four=40>
+----
+
+.Plain Implementation
+[%collapsible]
+====
+[source,ruby]
+----
+parent = Class.new do
+  def initialize one:, two: 2
+    @one = one
+    @two = two
+  end
+
+  private
+
+  attr_reader :one, :two
+end
+
+child = Class.new parent do
+  def initialize(three:, four: 4, **)
+    super(**)
+    @three = three
+    @four = four
+  end
+
+  private
+
+  attr_reader :three, :four
+end
+
+child.new one: 1, three: 3
+#<#<Class:0x000000012e052ee8>:0x0000000138311800 @one=1, @two=2, @three=3, @four=4>
+
+child.new one: 1, two: 20, three: 3, four: 40
+#<#<Class:0x000000012a558680>:0x0000000139831c80 @one=1, @two=20, @three=3, @four=40>
+----
+====
+
+Due to the power of keyword parameters, we don't have to redefine defaults in the `child` and can simply forward any/all missing arguments to the `parent`. This happens automatically but you can see how this done in the plain implementation.
+
+==== Blocks
+
+[source,ruby]
+----
+parent = Class.new do
+  include Initable.protected(%i[block function])
+end
+
+child = Class.new parent
+
+
+child.new { "demo" }
+#<#<Class:0x0000000129c92320>:0x0000000139c95538 @function=#<Proc:0x0000000139c95470 (irb):50>>
+----
+
+.Plain Implementation
+[%collapsible]
+====
+[source,ruby]
+----
+parent = Class.new do
+  def initialize &function
+    @function = function
+  end
+
+  private
+
+  attr_reader :function
+end
+
+child = Class.new parent
+
+child.new { "demo" }
+#<#<Class:0x000000012a5f0160>:0x0000000138375580 @function=#<Proc:0x0000000138375508 (irb):65>>
+----
+====
+
+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.
+
+=== Guidelines
+
+The following is worth adhering to:
+
+* Use the _rule of three_ where you only don't use more than three parameters for your method signature. Anything more than that and you have an unborn object that needs a name for dependency injection instead. 💡 For advanced dependency management, consider using {containable_link} and/or {infusible_link}.
+* Avoid using complex logic in proc-wrapped defaults. Procs should only be used for lazy loading of default objects.
+
+== Development
+
+To contribute, run:
+
+[source,bash]
+----
+git clone https://github.com/bkuhlmann/initable
+cd initable
+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/policies/developer_certificate_of_origin[Developer Certificate of Origin]
+
+== link:https://alchemists.io/projects/initable/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/initable.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name = "initable"
+  spec.version = "0.0.0"
+  spec.authors = ["Brooke Kuhlmann"]
+  spec.email = ["brooke@alchemists.io"]
+  spec.homepage = "https://alchemists.io/projects/initable"
+  spec.summary = "An automatic object initializer."
+  spec.license = "Hippocratic-2.1"
+
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/bkuhlmann/initable/issues",
+    "changelog_uri" => "https://alchemists.io/projects/initable/versions",
+    "homepage_uri" => "https://alchemists.io/projects/initable",
+    "funding_uri" => "https://github.com/sponsors/bkuhlmann",
+    "label" => "Initable",
+    "rubygems_mfa_required" => "true",
+    "source_code_uri" => "https://github.com/bkuhlmann/initable"
+  }
+
+  spec.signing_key = Gem.default_key_path
+  spec.cert_chain = [Gem.default_cert_path]
+
+  spec.required_ruby_version = "~> 3.4"
+  spec.add_dependency "marameters", "~> 4.0"
+
+  spec.extra_rdoc_files = Dir["README*", "LICENSE*"]
+  spec.files = Dir["*.gemspec", "lib/**/*"]
+end

data/lib/initable/builder.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "marameters"
+
+module Initable
+  # Builds initialization behavior.
+  # :reek:TooManyInstanceVariables
+  class Builder < Module
+    def initialize *parameters, scope: :private, marameters: Marameters
+      super()
+
+      @parameters = marameters.for parameters
+      @scope = scope
+      @marameters = marameters
+      @names = @parameters.names.compact
+      @instance_module = Module.new.set_temporary_name "initable"
+
+      freeze
+    end
+
+    def included descendant
+      super
+      define_initialize descendant
+      descendant.include instance_module
+    end
+
+    private
+
+    attr_reader :scope, :parameters, :marameters, :names, :instance_module
+
+    def define_initialize descendant,
+                          inheritor: Marameters::Signatures::Inheritor.new,
+                          forwarder: Marameters::Signatures::Super.new
+      ancestor = marameters.of(descendant, :initialize).first
+      signature = inheritor.call(ancestor, parameters).then { |params| marameters.signature params }
+
+      instance_module.module_eval <<-METHOD, __FILE__, __LINE__ + 1
+        def initialize(#{signature})
+          super(#{forwarder.call ancestor, parameters})
+          #{build_instance_variables ancestor}
+        end
+      METHOD
+
+      define_readers ancestor
+    end
+
+    def build_instance_variables ancestor
+      (names - ancestor.names).map { |name| "@#{name} = #{name}" }
+                              .join "\n"
+    end
+
+    def define_readers ancestor
+      (names - ancestor.names).each do |name|
+        symbol = name.inspect
+
+        instance_module.module_eval <<-READERS, __FILE__, __LINE__ + 1
+          #{compute_scope} attr_reader #{symbol}
+        READERS
+      end
+    end
+
+    def compute_scope = METHOD_SCOPES.include?(scope) ? scope : :private
+  end
+end

data/lib/initable.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "initable/builder"
+
+# Main namespace.
+module Initable
+  METHOD_SCOPES = %i[public protected private].freeze
+
+  def self.[](*) = Builder.new(*)
+
+  def self.protected(*) = Builder.new(*, scope: __method__)
+
+  def self.public(*) = Builder.new(*, scope: __method__)
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: initable
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Brooke Kuhlmann
+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: 2025-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: marameters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+email:
+- brooke@alchemists.io
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.adoc
+- LICENSE.adoc
+files:
+- LICENSE.adoc
+- README.adoc
+- initable.gemspec
+- lib/initable.rb
+- lib/initable/builder.rb
+homepage: https://alchemists.io/projects/initable
+licenses:
+- Hippocratic-2.1
+metadata:
+  bug_tracker_uri: https://github.com/bkuhlmann/initable/issues
+  changelog_uri: https://alchemists.io/projects/initable/versions
+  homepage_uri: https://alchemists.io/projects/initable
+  funding_uri: https://github.com/sponsors/bkuhlmann
+  label: Initable
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/bkuhlmann/initable
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: An automatic object initializer.
+test_files: []