marameters 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3daee40e52b7df55680618be8c5a37a6a62c3ca7f62b88128fbc724f4222c50
-  data.tar.gz: 3b4d527a40fc8ed6500faea3e6676b45be484a2fb9288b5e79ee38684ac0bec0
+  metadata.gz: 832b6f5bce93dd251a0e1972c9e4ef234237dc1d1e94f6b8ca15814dec7ddc00
+  data.tar.gz: 23c459d6e85fa64da272f5c9b319084f188c31d0360856be9826a92f59b619d9
 SHA512:
-  metadata.gz: 459d04fcc654dcf3ef58d23dfaaff01f5df52e0ffbb8d670cb0d1a9f59f10f91d0e9ff424e5871c9e892a1ba7f2b4cbdb236a287e3b3ffbdf32a1e56de9b5f97
-  data.tar.gz: 92df818d39aeacd231721b69299e0e23705b0f889db54360fefd0f269355fcbf40499b62c59bfc30a22b99dac39874b8a168c381e825ae4b2891a18b6fd9f53f
+  metadata.gz: '0338c575983adaff7b72af01ddc941ba2084b095f073992e853c740ac2aac70f8c4f3eaff9cea4001802240393e52b0a6cceb00ac3d20b47eda320591546e7b7'
+  data.tar.gz: 9bddaf3365b3b3d60f766479a036d754f6323082d606a1120a99343145858ba92436177236bf6f1cb6901b810bba55184ff0512262061fe25d58cf3db36a3663

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)`.
@@ -21,7 +21,6 @@ toc::[]
 
 == Features
 
-* Provides a core object as a primary interface.
 * Provides specialized objects for keyword, positional, and splatted parameters.
 
 == Requirements
@@ -48,14 +47,14 @@ gem "marameters"
 
 There are two main objects you'll want to interact with:
 
-* *Analyzer*: Allows you to analyze a method's parameters.
-* *Signature*: Allows you to dynamically build a method signature.
+* *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.
 
-=== Analyzer
+=== Probe
 
-To understand how to _analyze_ a method's parameters, consider the following demonstration class:
+To understand how to analyze a method's parameters, consider the following demonstration class:
 
 [source,ruby]
 ----
@@ -76,64 +75,64 @@ class Demo
 end
 ----
 
-You can then analyze the `#all` method's parameters as follows:
+You can then probe the `#all` method's parameters as follows:
 
 [source,ruby]
 ----
-analyzer = Marameters::Analyzer.new Demo.instance_method(:all).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}
-----
-
-In contrast the above, we can also analyze the `#none` method which has no parameters for a
-completely different result:
+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(:none).parameters
-
-analyzer.block                # nil
-analyzer.block?               # false
-analyzer.empty?               # true
-analyzer.keywords             # []
-analyzer.keywords?            # false
-analyzer.kind?(:req)          # true
-analyzer.kinds                # []
-analyzer.name?(:three)        # false
-analyzer.names                # []
-analyzer.only_bare_splats?    # false
-analyzer.only_double_splats?  # false
-analyzer.only_single_splats?  # false
-analyzer.positionals          # []
-analyzer.positionals?         # false
-analyzer.splats               # []
-analyzer.splats?              # false
-analyzer.to_a                 # []
-analyzer.to_h                 # {}
+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 analyzer 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 for multiple methods when metaprogramming.
+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:
 
@@ -155,8 +154,8 @@ puts signature
 # one, two = 2, *three, four:, five: 5, **six, &seven
 ----
 
-You'll notice that the parameters is 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 analyzer or directly
+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):
@@ -184,15 +183,16 @@ 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 these as a normal string. There are two reasons why
-this is important:
+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 that you want the object to be passed through without any further
-  processing while also not being confused normal strings.
+* 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 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.
+  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:
 
@@ -202,9 +202,7 @@ 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
-    end
+    def self.say(#{signature}) = text
   DEFINITION
 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

@@ -10,6 +10,8 @@ module Marameters
 
     def to_s = build.join ", "
 
+    alias to_str to_s
+
     private
 
     attr_reader :parameters, :builder

data/marameters.gemspec

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: marameters
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 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-12 00:00:00.000000000 Z
+date: 2022-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: refinements
@@ -70,9 +70,9 @@ 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
@@ -100,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.9
+rubygems_version: 3.3.10
 signing_key:
 specification_version: 4
 summary: Provides dynamic method parameter construction and deconstruction.