marameters 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0656ba29b3d12d44f9f34ae3a012542dc3a274712d2cabf8ba153053d1491310
-  data.tar.gz: 21e3a15d709561a6c30adb4a212b1193c0d45a2e0f783761719054412a014136
+  metadata.gz: '09f8116959180daa2b1ac61d0e8b92ba5e5859fc44cdadcef4aaa3686e15a5c6'
+  data.tar.gz: 3a87c1d82885b8390c17849c48a38ce4541f818a4ea3d51e4c223e449cd88e6f
 SHA512:
-  metadata.gz: 152aa26bb96768bc363f55a7fa43b5aed99f08038ac1bbb4a943a1efdf8b5138ce214b6a4b8012f179f12d00894a44869df6d25d938521712de35a3ab2c6efbd
-  data.tar.gz: 620bf72c7c8bbe25b48dc370cee7d3a0e1b03f5df8090c326bc760be1dfb400168d62dac304e55acded56f75da24ca821c4ce04fa9cfb2740ad749434de69fec
+  metadata.gz: 7f9c1d0796c5b84df75288678b3a4336c1878d4b449247bf161a8f0ebf09699462db385a43cbfdac11d0e08dc716afa8fc3cca5d1538f9421dfa601abbc85a43
+  data.tar.gz: a6d9ce536adcb82d3f2014d0187f1a3758e942ded308b585be347f0f0916e8a0f6f822dec8e79b0a522aad4da96e2fe4dc6a359bb695f5747cdeb2d2edf7e117

data/README.adoc

@@ -13,7 +13,7 @@ Marameters is a portmanteau (i.e. `[m]ethod + p[arameters] = marameters`) which
 * *Arguments*: Represents the _actual_ values passed to the method when messaged. Example: `demo 1, two: 2`.
 
 This gem will help you debug methods or aid your workflow when
-metaprogramming -- as used in the link:https://www.alchemists.io/projects/auto_injector[Auto Injector] gem -- when architecting more sophisticated applications.
+metaprogramming -- as used in the link:https://www.alchemists.io/projects/infusible[Infusible] gem -- when architecting more sophisticated applications.
 
 toc::[]
 
@@ -153,7 +153,7 @@ probe.to_a                 # []
 
 === Categorizer
 
-The categorizer allows you to dynamically build positional, keyword, and block arguments for message passing. This is most valuable when you know the object, method, and arguments while also needing to assemble the arguments are in the right order. Here's a demonstration where {amazing_print_link} (i.e. `ap`) is used to format the output:
+The categorizer allows you to dynamically build positional, keyword, and block arguments for message passing. This is most valuable when you know the object and method while needing to align the arguments in the right order. Here's a demonstration where {amazing_print_link} (i.e. `ap`) is used to format the output:
 
 [source,ruby]
 ----
@@ -207,7 +207,7 @@ Inspector.call [1, nil, nil, {four: 4}]
 
 When we step through the above implementation and output, we see the following unfold:
 
-. The `Demo` module allows us define a maximum set of parameters and then print the arguments received for inspection purposes.
+. The `Demo` module allows us to define a maximum set of parameters and then print the arguments received for inspection purposes.
 . The `Inspector` module provides a wrapper around the `Categorizer` so we can conveniently pass in different arguments for experimentation purposes.
 . We pass in our arguments to `Inspector.call` where `nil` is used for optional arguments and hashes for keyword arguments.
 . Once inside `Inspector.call`, the `Categorizer` is initialized with the `Demo.test` method parameters.
@@ -248,7 +248,7 @@ Inspector.call [1, 2, [98, 99], {four: 4}, {five: 5}, {twenty: 20, thirty: 30},
 # 7. #<Proc:0x000000010a88cec0 (irb):1>
 ----
 
-Once again, it is important to keep in mind that the argument positions _must_ align with the parameter positions since the parameters are an array of elements too. For illustration purposes -- and using the above example -- we can compare the parameters to the arguments as follows:
+Once again, it is important to keep in mind that the argument positions _must_ align with the parameter positions since the parameters are an array of elements too. For illustration purposes -- using the above example -- we can compare the parameters to the arguments as follows:
 
 [source,ruby]
 ----
@@ -280,10 +280,22 @@ ap arguments
 
 This also means that:
 
-* All positions much be filled if you want to supply arguments beyond the first couple of positions because everything is positional due to the nature of how link:https://rubyapi.org/o/method#method-i-parameters[Method#parameters] works. Use `nil` to fill an optional argument when you don't need it.
-* The `:rest` (single splat) argument must an array or `nil` if not present because even though it is _optional_, it is still _positional_.
+* All positions must be filled if you want to supply arguments beyond the first couple of positions because everything is positional due to the nature of how link:https://rubyapi.org/o/method#method-i-parameters[Method#parameters] works. Use `nil` to fill an optional argument when you don't need it.
+* The `:rest` (single splat) argument must be an array or `nil` if not present because even though it is _optional_, it is still _positional_.
 * The `:keyrest` (double splat) argument -- much like the `:rest` argument -- must be a hash or `nil` if not present.
 
+Lastly, in all of the above examples, only an array of arguments has been used but you can pass in a single argument too (i.e. non-array). This is handy for method signatures which have only a single parameter or only use splats. Having to remember to wrap your argument in an array each time can get tedious so when _only_ a single argument is supplied, the categorizer will automatically cast the argument as an array. A good example of this use case is when using structs. Example:
+
+[source,ruby]
+----
+url = Struct.new :label, :url, keyword_init: true
+
+Marameters.categorize(url.method(:new).parameters, {label: "Eaxmple", url: "https://example.com"})
+          .then { |splat| url.new(*splat.positionals, **splat.keywords) }
+
+# Yields: #<struct label="Eaxmple", url="https://example.com">
+----
+
 For further details, please refer back to my {article_link} article mentioned in the _Requirements_ section.
 
 === Signature
@@ -371,6 +383,15 @@ puts Example.say "Hello"
 
 == Development
 
+To contribute, run:
+
+[source,bash]
+----
+git clone https://github.com/bkuhlmann/marameters
+cd marameters
+bin/setup
+----
+
 You can also use the IRB console for direct access to all objects:
 
 [source,bash]

data/lib/marameters/categorizer.rb

@@ -14,7 +14,7 @@ module Marameters
 
     def call arguments
       @record = model.new
-      map arguments
+      map arguments.is_a?(Array) ? arguments : [arguments]
       record
     end
 
@@ -23,7 +23,13 @@ module Marameters
     attr_reader :parameters, :model, :record
 
     def map arguments
-      parameters.each.with_index { |pair, index| filter pair, arguments[index] }
+      return record if arguments.empty?
+
+      size = arguments.size
+
+      parameters.each.with_index do |pair, index|
+        filter pair, arguments[index] if index < size
+      end
     end
 
     def filter pair, value

data/lib/marameters/probe.rb

@@ -1,12 +1,8 @@
 # frozen_string_literal: true
 
-require "refinements/arrays"
-
 module Marameters
   # Provides information on a method's parameters.
   class Probe
-    using Refinements::Arrays
-
     CATEGORIES = {
       positionals: %i[req opt],
       keywords: %i[keyreq key],

data/marameters.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "marameters"
-  spec.version = "0.8.0"
+  spec.version = "0.10.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://www.alchemists.io/projects/marameters"
@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.cert_chain = [Gem.default_cert_path]
 
   spec.required_ruby_version = "~> 3.1"
-  spec.add_dependency "refinements", "~> 9.6"
+  spec.add_dependency "refinements", "~> 9.7"
   spec.add_dependency "zeitwerk", "~> 2.6"
 
   spec.extra_rdoc_files = Dir["README*", "LICENSE*"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: marameters
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   CxDe2+VuChj4I1nvIHdu+E6XoEVlanUPKmSg6nddhkKn2gC45Kyzh6FZqnzH/CRp
   RFE=
   -----END CERTIFICATE-----
-date: 2022-09-03 00:00:00.000000000 Z
+date: 2022-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: refinements
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.6'
+        version: '9.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.6'
+        version: '9.7'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -103,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.21
+rubygems_version: 3.3.24
 signing_key:
 specification_version: 4
 summary: Provides dynamic method parameter construction and deconstruction.