initable 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96778d9b0314485a1c240e2c5ef7867df42092d4f906e794ec54097de2c6de93
-  data.tar.gz: 6b3619194eb1d9767e80ad31e13a7037fe10542c7b497a14df77ad7f04dade71
+  metadata.gz: 2daf64cfb3c191bbde13cf2df0906dc5eb61a53b5692d81759a04377574dbd47
+  data.tar.gz: 05f51e03305374baef88f4c316ab076fccae03440da452e94bd2a65b728e79f7
 SHA512:
-  metadata.gz: ddabf5ef26a500fd501f59a89a6a7dc370b00136206737a14f534ee72fb7dce5ce58848b7c03985952c66212e6d53cfa1ce8882acefd7d36ca23befb1f070acc
-  data.tar.gz: 65e7d06a70d8f00f24b5b3edc7b4ccaf6672e7a357533c38991f7f4ea1619c5a9411b673f26d95444ba5530642e03c1ed0a339d4eeba2bdd47091e4cd7c1252c
+  metadata.gz: 8a39dd5abf3ac374ca96b1bcb6debe1445116a868afc5f5e36634cc50beac663cc8fd949983b5f51a21127bb518b10151ba27cf192bdb7a8ccd0893fab585d1c
+  data.tar.gz: 30ce0f75f840e2536219f51dc1011974ce86b2855331d94117c08d1a5fc75039ce5606f3f99d741f6882ccb6ec3d7d641d0eccc4629c0328f5a298c712034337

data/README.adoc

@@ -129,7 +129,7 @@ There are eight _kinds_ of parameters you can use in method signatures as suppor
 [<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.
+💡 The default (third element) is always optional and 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:
 
@@ -316,6 +316,45 @@ end
 
 This is useful when needing to forward a block to the super class.
 
+=== Keywords
+
+As an added convenience, you can use keywords in addition to positional arguments when initializing your class. Example:
+
+[source,ruby]
+----
+demo = Class.new do
+  include Initable[one: 1, two: 2]
+end
+
+demo.new  #<#<Class:0x0000000135753678>:0x0000000136091f00 @one=1, @two=2>
+----
+
+The above is identical to the following but with less typing:
+
+[source,ruby]
+----
+demo = Class.new do
+  include Initable[[:key, :one, 1], [:key, :two, 2]]
+end
+
+demo.new  #<#<Class:0x0000000136f1ef78>:0x00000001518775b0 @one=1, @two=2>
+----
+
+You can also combine positionals with keywords:
+
+[source,ruby]
+----
+demo = Class.new do
+  include Initable[%i[req one], [:key, :two, 2], three: 3]
+end
+
+demo.new 1  # #<#<Class:0x0000000136ede9c8>:0x0000000151ebab98 @one=1, @two=2, @three=3>
+----
+
+⚠️ As with default `+#initialize+` implementations, ensure you don't duplicate parameter names to avoid naming collisions.
+
+In most cases, you'll want to use xref:_parameters[Parameters] as documented earlier. Otherwise, this is a nice way to initialize with safe defaults or utilize lightweight dependency injection without having to reach for {infusible_link} when you don't need a full fledged {containable_link} container.
+
 === Defaults
 
 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:
@@ -325,12 +364,17 @@ You've already seen you can provide a third element for defaults with optional p
 demo = Class.new do
   include Initable[
     [:opt, :one, proc { %w[O n e].join }],
-    [:key, :two, proc { Object.new }]
+    [:key, :two, proc { Object.new }],
+    three: proc { StringIO.new }
   ]
 end
 
 demo.new
-#<#<Class:0x00000001532d4390>:0x0000000153a9b0b0 @one="One", @two=#<Object:0x0000000153a9ade0>>
+# <#<Class:0x00000001532d4390>:0x0000000153a9b0b0
+#    @one="One",
+#    @two=#<Object:0x000000012f89b108>,
+#    @three=#<StringIO:0x000000012fe361f8>
+# >
 ----
 
 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.
@@ -340,6 +384,7 @@ Notice, for the `one` optional positional parameter, we get a default value of `
 * Use procs because lambdas will throw a `TypeError`.
 * Use procs _with no arguments_ because only the body of the `Proc` is parsed. Otherwise, you'll get an `ArgumentError`.
 * 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 link:https://bugs.ruby-lang.org/issues/21005[adds] source location with line start, line end, column start, and column end information.
+* This does not work consistently in IRB due to the above mentioned Ruby issue.
 
 === Barewords
 

data/initable.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "initable"
-  spec.version = "0.2.0"
+  spec.version = "0.3.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/initable"

data/lib/initable/builder.rb

@@ -4,14 +4,13 @@ require "marameters"
 
 module Initable
   # Builds initialization behavior.
-  # :reek:TooManyInstanceVariables
   class Builder < Module
-    def initialize *parameters, scope: :private, marameters: Marameters
+    def initialize *parameters, method_scope: :private, **keywords
       super()
+      keywords.each { |key, value| parameters.push [:key, key, value] }
 
-      @parameters = marameters.for parameters
-      @scope = scope
-      @marameters = marameters
+      @parameters = Marameters.for parameters
+      @method_scope = method_scope
       @names = @parameters.names.compact
       @instance_module = Module.new.set_temporary_name "initable"
 
@@ -26,18 +25,18 @@ module Initable
 
     private
 
-    attr_reader :scope, :parameters, :marameters, :names, :instance_module
+    attr_reader :method_scope, :parameters, :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 }
+      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}
+          super(#{forwarder.call ancestor, parameters})
         end
       METHOD
 
@@ -55,6 +54,6 @@ module Initable
       READERS
     end
 
-    def compute_scope = METHOD_SCOPES.include?(scope) ? scope : :private
+    def compute_scope = METHOD_SCOPES.include?(method_scope) ? method_scope : :private
   end
 end

data/lib/initable.rb

@@ -6,9 +6,9 @@ require "initable/builder"
 module Initable
   METHOD_SCOPES = %i[public protected private].freeze
 
-  def self.[](*) = Builder.new(*)
+  def self.[](*, **) = Builder.new(*, **)
 
-  def self.protected(*) = Builder.new(*, scope: __method__)
+  def self.protected(*, **) = Builder.new(*, method_scope: __method__, **)
 
-  def self.public(*) = Builder.new(*, scope: __method__)
+  def self.public(*, **) = Builder.new(*, method_scope: __method__, **)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: initable
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -34,7 +34,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2025-02-05 00:00:00.000000000 Z
+date: 2025-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: marameters
@@ -88,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 3.6.6
 specification_version: 4
 summary: An automatic object initializer.
 test_files: []