marameters 0.1.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e9a67405793129c6913e84a4ead90cbc6eda2abbec139f00764a677aa6d30b1
-  data.tar.gz: fe3d699a7717e37ae79d07773870cf1137ad0b4b14a761c3eaaa56ed9a4f9fdd
+  metadata.gz: 8f31405cf6109f53ee8ea25db37e48dd65520397f634f49ccbeb63403c02ac97
+  data.tar.gz: be9f7277b4099c0b6f6edafde1b3fafd3cb8cb63ce0894f067fc7bfbc663e8f4
 SHA512:
-  metadata.gz: ded0a8de22a2f67bdb2f308bbfc02db520fb98028b1595825d9e4ab82396b6bdb062a5a602c1df52ced38862963c5b0eb3285cdee586a6934f5f888a6777d313
-  data.tar.gz: bc840a326f4116973cda051c23b411f92e74b53e2f704e69adb9536159ef178a16b094c29f52b038dfb17af65be2f26fbe10e7d062da2b5e222bb704895a7793
+  metadata.gz: a96509751fe29351233ab41b79b730b6e16f7fb7f7a72f59dd4cf8083b042860679fb18f9f3b4ab60e17a918211bc645466414fcf38072f1801e15a8e7c25824
+  data.tar.gz: ed832277fba30755bee9162eb427ef65ae0f434fbdae7b8a35b90b6c5213202c199c95575458d28e637ad9e5a4e8b226f293f25146a2d639123dfc4e40597826

data/README.adoc

@@ -4,9 +4,9 @@
 
 = Marameters
 
-Marameters is short for method parameters (i.e. `[m]ethod + p[arameters] = marameters`) which is
-designed to provide additional insight and diagnostics to method parameters. For context, the
-difference between a method's parameters and arguments is:
+Marameters is a portmanteau (i.e. `[m]ethod + p[arameters] = marameters`) which is designed to
+provide additional insight and diagnostics to method parameters. For context, the difference between
+a method's parameters and arguments is:
 
 * *Parameters*: Represents the _expected_ values to be passed to a method when
   messaged as defined when the method is implemented. Example: `def demo(one, two: nil)`.
@@ -14,13 +14,13 @@ difference between a method's parameters and arguments is:
   Example: `demo 1, two: 2`.
 
 This gem will help you debug methods or -- more importantly -- aid your workflow when
-metaprogramming and architecting more sophisticated applications.
+metaprogramming, as used in the link:https://www.alchemists.io/projects/auto_injector[Auto Injector]
+gem, when architecting more sophisticated applications.
 
 toc::[]
 
 == Features
 
-* Provides a core object as a primary interface.
 * Provides specialized objects for keyword, positional, and splatted parameters.
 
 == Requirements
@@ -45,8 +45,16 @@ gem "marameters"
 
 == Usage
 
-The primary object you'll want to interact with is the `Marameters::Analyzer` class. To understand
-how to _analyze_ a method's parameters, consider the following demonstration class:
+There are two main objects you'll want to interact with:
+
+* *Marameters::Probe*: Allows you to analyze a method's parameters.
+* *Marameters::Signature*: Allows you to dynamically build a method signature from raw parameters.
+
+Both of these objects are meant to serve as building blocks to more complex architectures.
+
+=== Probe
+
+To understand how to analyze a method's parameters, consider the following demonstration class:
 
 [source,ruby]
 ----
@@ -55,40 +63,154 @@ class Demo
     @logger = logger
   end
 
-  def example one, two = nil, *three, four:, five: nil, **six, &seven
+  def all one, two = nil, *three, four:, five: nil, **six, &seven
     logger.debug [one, two, three, four, five, six, seven]
   end
 
+  def none = logger.debug "Nothing to see here."
+
   private
 
   attr_reader :logger
 end
 ----
 
-We can then analyze the above `#example` method's parameters as follows:
+You can then probe the `#all` method's parameters as follows:
+
+[source,ruby]
+----
+probe = Marameters::Probe.new Demo.instance_method(:all).parameters
+
+probe.block                # :seven
+probe.block?               # true
+probe.empty?               # false
+probe.keywords             # [:four, :five]
+probe.keywords?            # true
+probe.kind?(:keyrest)      # true
+probe.kinds                # [:req, :opt, :rest, :keyreq, :key, :keyrest, :block]
+probe.name?(:three)        # true
+probe.names                # [:one, :two, :three, :four, :five, :six, :seven]
+probe.only_bare_splats?    # false
+probe.only_double_splats?  # false
+probe.only_single_splats?  # false
+probe.positionals          # [:one, :two]
+probe.positionals?         # true
+probe.splats               # [:three, :six]
+probe.splats?              # true
+probe.to_a                 # [[:req, :one], [:opt, :two], [:rest, :three], [:keyreq, :four], [:key, :five], [:keyrest, :six], [:block, :seven]]
+probe.to_h                 # {:req=>:one, :opt=>:two, :rest=>:three, :keyreq=>:four, :key=>:five, :keyrest=>:six, :block=>:seven}
+----
+
+In contrast the above, we can also probe the `#none` method which has no parameters for a completely
+different result:
 
 [source,ruby]
 ----
-analyzer = Marameters::Analyzer.new Demo.instance_method(:example).parameters
-
-analyzer.block                # :seven
-analyzer.block?               # true
-analyzer.empty?               # false
-analyzer.keywords             # [:four, :five]
-analyzer.keywords?            # true
-analyzer.kind?(:keyrest)      # true
-analyzer.kinds                # [:req, :opt, :rest, :keyreq, :key, :keyrest, :block]
-analyzer.name?(:three)        # true
-analyzer.names                # [:one, :two, :three, :four, :five, :six, :seven]
-analyzer.only_bare_splats?    # false
-analyzer.only_double_splats?  # false
-analyzer.only_single_splats?  # false
-analyzer.positionals          # [:one, :two]
-analyzer.positionals?         # true
-analyzer.splats               # [:three, :six]
-analyzer.splats?              # true
-analyzer.to_a                 # [[:req, :one], [:opt, :two], [:rest, :three], [:keyreq, :four], [:key, :five], [:keyrest, :six], [:block, :seven]]
-analyzer.to_h                 # {:req=>:one, :opt=>:two, :rest=>:three, :keyreq=>:four, :key=>:five, :keyrest=>:six, :block=>:seven}
+probe = Marameters::Probe.new Demo.instance_method(:none).parameters
+
+probe.block                # nil
+probe.block?               # false
+probe.empty?               # true
+probe.keywords             # []
+probe.keywords?            # false
+probe.kind?(:req)          # true
+probe.kinds                # []
+probe.name?(:three)        # false
+probe.names                # []
+probe.only_bare_splats?    # false
+probe.only_double_splats?  # false
+probe.only_single_splats?  # false
+probe.positionals          # []
+probe.positionals?         # false
+probe.splats               # []
+probe.splats?              # false
+probe.to_a                 # []
+probe.to_h                 # {}
+----
+
+=== Signature
+
+The signature class is the opposite of the probe in that you want to feed it parameters for turning
+into a method signature. This is useful when dynamically building method signatures or using the
+same signature when metaprogramming multiple methods.
+
+The following demonstrates how you might construct a method signature with all possible parameters:
+
+[source,ruby]
+----
+signature = Marameters::Signature.new(
+  {
+    req: :one,
+    opt: [:two, 2],
+    rest: :three,
+    keyreq: :four,
+    key: [:five, 5],
+    keyrest: :six,
+    block: :seven
+  }
+)
+
+puts signature
+# one, two = 2, *three, four:, five: 5, **six, &seven
+----
+
+You'll notice that the parameters are a hash _and_ some values can be tuples. The reason is that
+it's easier to write a hash than a double nested array as normally produced by the probe or directly
+from `Method#parameters`. The optional positional and keyword parameters use tuples because you
+might want to supply a default value and this provides a way for you to do that with minimal syntax.
+This can be demonstrated further by using optional keywords (same applies for optional positionals):
+
+[source,ruby]
+----
+# With no default
+puts Marameters::Signature.new({key: :demo})
+# demo: nil
+
+# With explicit nil as default
+puts Marameters::Signature.new({key: [:demo, nil]})
+# demo: nil
+
+# With string as default
+puts Marameters::Signature.new({key: [:demo, "test"]})
+# demo: "test"
+
+# With symbol as default
+puts Marameters::Signature.new({key: [:demo, :test]})
+# demo: :test
+
+# With object(dependency) as default
+puts Marameters::Signature.new({key: [:demo, "*Object.new"]})
+# demo: Object.new
+----
+
+In the case of object dependencies, you need to wrap these in a string _and_ prefix them with a star
+(`*`) so the signature builder won't confuse them as normal strings. There are two reasons why this
+is important:
+
+* The star (`*`) signifies you want an object to be passed through without further processing while
+  also not being confused as a normal string.
+* Objects wrapped as strings allows your dependency to be lazy loaded. Otherwise, if `Object.new`
+  was pass in directly, you'd be passing the evaluated instance (i.e.
+  `#<Object:0x0000000107df4028>`) which is not what you want until much later when your method is
+  defined.
+
+When you put all of this together, you can dynamically build a method as follows:
+
+[source,ruby]
+----
+signature = Marameters::Signature.new({opt: [:text, "This is a test."]})
+
+Example = Module.new do
+  module_eval <<~DEFINITION, __FILE__, __LINE__ + 1
+    def self.say(#{signature}) = text
+  DEFINITION
+end
+
+puts Example.say
+# This is a test.
+
+puts Example.say "Hello"
+# Hello
 ----
 
 == Development

data/lib/marameters/builder.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Marameters
+  # Builds a single parameter of a method's parameter signature.
+  class Builder
+    def initialize defaulter: Defaulter
+      @defaulter = defaulter
+    end
+
+    # :reek:DuplicateMethodCall
+    def call kind, name, default: nil
+      case kind
+        when :req then name
+        when :opt then "#{name} = #{defaulter.call default}"
+        when :rest then "*#{name}"
+        when :keyreq then "#{name}:"
+        when :key then "#{name}: #{defaulter.call default}"
+        when :keyrest then "**#{name}"
+        when :block then "&#{name}"
+        else fail ArgumentError, "Wrong kind (#{kind}), name (#{name}), or default (#{default})."
+      end
+    end
+
+    private
+
+    attr_reader :defaulter
+  end
+end

data/lib/marameters/defaulter.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Marameters
+  # Calculates the default for a given value when used within a method's parameter.
+  class Defaulter
+    PASSTHROUGH = "*"
+
+    def self.call(...) = new(...).call
+
+    def initialize value, passthrough: PASSTHROUGH
+      @value = value
+      @passthrough = passthrough
+    end
+
+    def call
+      case value
+        when nil then "nil"
+        when /\A#{Regexp.escape passthrough}/ then value.delete_prefix passthrough
+        when String then value.dump
+        when Symbol then value.inspect
+        else value
+      end
+    end
+
+    private
+
+    attr_reader :value, :passthrough
+  end
+end

data/lib/marameters/{analyzer.rb → probe.rb}

@@ -3,8 +3,8 @@
 require "refinements/arrays"
 
 module Marameters
-  # Provides analysis of a method's parameters.
-  class Analyzer
+  # Provides insight into a method's parameters.
+  class Probe
     using Refinements::Arrays
 
     # :reek:TooManyStatements

data/lib/marameters/signature.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Marameters
+  # Produces a method signature for given parameters.
+  class Signature
+    def initialize parameters, builder: Builder.new
+      @parameters = parameters
+      @builder = builder
+    end
+
+    def to_s = build.join ", "
+
+    alias to_str to_s
+
+    private
+
+    attr_reader :parameters, :builder
+
+    def build
+      parameters.reduce [] do |signature, (kind, (name, default))|
+        signature << builder.call(kind, name, default:)
+      end
+    end
+  end
+end

data/marameters.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |spec|
   spec.name = "marameters"
-  spec.version = "0.1.0"
+  spec.version = "0.3.1"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://www.alchemists.io/projects/marameters"
-  spec.summary = "Provides method parameter introspection which is useful when metaprogramming."
+  spec.summary = "Provides dynamic method parameter construction and deconstruction."
   spec.license = "Hippocratic-2.1"
 
   spec.metadata = {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: marameters
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -10,9 +10,9 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIC/jCCAeagAwIBAgIBBDANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBpicm9v
-  a2UvREM9YWxjaGVtaXN0cy9EQz1pbzAeFw0yMTAzMTkxMjQ4MDZaFw0yMjAzMTkx
-  MjQ4MDZaMCUxIzAhBgNVBAMMGmJyb29rZS9EQz1hbGNoZW1pc3RzL0RDPWlvMIIB
+  MIIC/jCCAeagAwIBAgIBBTANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBpicm9v
+  a2UvREM9YWxjaGVtaXN0cy9EQz1pbzAeFw0yMjAzMTkxNzI0MzJaFw0yMzAzMTkx
+  NzI0MzJaMCUxIzAhBgNVBAMMGmJyb29rZS9EQz1hbGNoZW1pc3RzL0RDPWlvMIIB
   IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6l1qpXTiomH1RfMRloyw7MiE
   xyVx/x8Yc3EupdH7uhNaTXQGyORN6aOY//1QXXMHIZ9tW74nZLhesWMSUMYy0XhB
   brs+KkurHnc9FnEJAbG7ebGvl/ncqZt72nQvaxpDxvuCBHgJAz+8i5wl6FhLw+oT
@@ -20,15 +20,15 @@ cert_chain:
   D5vkU0YlAm1r98BymuJlcQ1qdkVEI1d48ph4kcS0S0nv1RiuyVb6TCAR3Nu3VaVq
   3fPzZKJLZBx67UvXdbdicWPiUR75elI4PXpLIic3xytaF52ZJYyKZCNZJhNwfQID
   AQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU0nzow9vc
-  2CdikiiE3fJhP/gY4ggwDQYJKoZIhvcNAQELBQADggEBAEjpaOXHHp8s/7GL2qCb
-  YAs7urOLv9VHSPfQWAwaTMVnSsIf3Sw4xzISOP/mmfEPBPXtz61K5esrE/uTFtgb
-  FyjxQk2H0sEWgrRXGGNHBWQRhhEs7LP/TByoC15A0br++xLxRz4r7HBLGAWQQDpg
-  66BJ2TBVjxS6K64tKbq7+ACyrOZGgTfNHACh4M076y0x0oRf/rwBrU39/KRfuhbb
-  cm+nNCEtO35gTmZ2bVDHLGvWazi3gJt6+huQjfXTCUUG2YYBxwhu+GPdAGQPxpf9
-  lkHilIrX69jq8wMPpBhlaw2mRmeSL50Wv5u6xVBvOHhXFSP1crXM95vfLhLyRYod
-  W2A=
+  2CdikiiE3fJhP/gY4ggwDQYJKoZIhvcNAQELBQADggEBAJbbNyWzFjqUNVPPCUCo
+  IMrhDa9xf1xkORXNYYbmXgoxRy/KyNbUr+jgEEoWJAm9GXlcqxxWAUI6pK/i4/Qi
+  X6rPFEFmeObDOHNvuqy8Hd6AYsu+kP94U/KJhe9wnWGMmGoNKJNU3EkW3jM/osSl
+  +JRxiH5t4WtnDiVyoYl5nYC02rYdjJkG6VMxDymXTqn7u6HhYgZkGujq1UPar8x2
+  hNIWJblDKKSu7hA2d6+kUthuYo13o1sg1Da/AEDg0hoZSUvhqDEF5Hy232qb3pDt
+  CxDe2+VuChj4I1nvIHdu+E6XoEVlanUPKmSg6nddhkKn2gC45Kyzh6FZqnzH/CRp
+  RFE=
   -----END CERTIFICATE-----
-date: 2022-03-11 00:00:00.000000000 Z
+date: 2022-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: refinements
@@ -70,7 +70,10 @@ files:
 - LICENSE.adoc
 - README.adoc
 - lib/marameters.rb
-- lib/marameters/analyzer.rb
+- lib/marameters/builder.rb
+- lib/marameters/defaulter.rb
+- lib/marameters/probe.rb
+- lib/marameters/signature.rb
 - marameters.gemspec
 homepage: https://www.alchemists.io/projects/marameters
 licenses:
@@ -97,8 +100,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.8
+rubygems_version: 3.3.11
 signing_key:
 specification_version: 4
-summary: Provides method parameter introspection which is useful when metaprogramming.
+summary: Provides dynamic method parameter construction and deconstruction.
 test_files: []