marameters 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a92d21f1146d77f296e63cf36db2f70a2b71318c6d117bb962fc4d4ac34616c
-  data.tar.gz: 102690432048fb246e14f6bce38ed34d1ac6415ed82a7356ac3f43313bf78eeb
+  metadata.gz: 0e9a67405793129c6913e84a4ead90cbc6eda2abbec139f00764a677aa6d30b1
+  data.tar.gz: fe3d699a7717e37ae79d07773870cf1137ad0b4b14a761c3eaaa56ed9a4f9fdd
 SHA512:
-  metadata.gz: 91efba790017f9d67f5de1513027455a34915822346b6e0e4502dfb6d4e1d0bb4e638342b364108caac35a8598cd18344f6df7d68743107db355cf36eb9470cd
-  data.tar.gz: 7931c8990397233aac682ca43701b5b90c4d045263abde99c3d52ac800050acbaabea5b96d02e5f0fae687d635894d3d1681d9f0eb856a1cd5f27219c0e8b6cb
+  metadata.gz: ded0a8de22a2f67bdb2f308bbfc02db520fb98028b1595825d9e4ab82396b6bdb062a5a602c1df52ced38862963c5b0eb3285cdee586a6934f5f888a6777d313
+  data.tar.gz: bc840a326f4116973cda051c23b411f92e74b53e2f704e69adb9536159ef178a16b094c29f52b038dfb17af65be2f26fbe10e7d062da2b5e222bb704895a7793

data/README.adoc

@@ -4,14 +4,14 @@
 
 = Marameters
 
-Marameters is short for method parameters (i.e. [m]ethod + p[arameters] = marameters) which is
+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:
 
-* *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)`.
+* *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)`.
 * *Arguments*: Represents the _actual_ values passed to the method when messaged.
-  Example: `demo 1, two :2`.
+  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.
@@ -45,50 +45,50 @@ gem "marameters"
 
 == Usage
 
-The primary object you'll most likely want to interact with is the `Marameters::Core` class. The
-following code snippet will help demonstrate the Object API:
+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:
 
 [source,ruby]
 ----
 class Demo
+  def initialize logger: Logger.new(STDOUT)
+    @logger = logger
+  end
+
   def example one, two = nil, *three, four:, five: nil, **six, &seven
-    [one, two, three, four, five, six, seven]
+    logger.debug [one, two, three, four, five, six, seven]
   end
-end
 
-marameters = Marameters::Core.new Demo.instance_method(:example).parameters
-
-marameters.empty?                    # false
-marameters.keyword? :one             # false
-marameters.keyword? :four            # true
-marameters.keywords                  # [:four, :five]
-marameters.kinds                     # [:req, :opt, :keyreq, :key, :rest, :keyrest]
-marameters.named_single_splat_only?  # false
-marameters.names                     # [:one, :two, :four, :five, :three, :six]
-marameters.positional?               # true
-marameters.positionals               # [:one, :two]
-marameters.to_a                      # [[:req, :one], [:opt, :two], [:rest, :three], [:keyreq, :four], [:key, :five], [:keyrest, :six], [:block, :seven]]
-marameters.unnamed_splats_only?      # false
+  private
+
+  attr_reader :logger
+end
 ----
 
-The `Marameters::Core` delegates to the following classes which you can use individually as well:
+We can then analyze the above `#example` method's parameters as follows:
 
 [source,ruby]
 ----
-class Demo
-  def example one, two = nil, *three, four:, five: nil, **six, &seven
-    [one, two, three, four, five, six, seven]
-  end
-end
-
-# Specializes in positional method parameters only.
-positional = Marameters::Positional.new Demo.instance_method(:example).parameters
-
-# Specializes in keyword method parameters only.
-keyword = Marameters::Keyword.new Demo.instance_method(:example).parameters
-
-# Specializes in splatted method parameters only.
-splat = Marameters::Splat.new Demo.instance_method(:example).parameters
+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}
 ----
 
 == Development

data/lib/marameters/analyzer.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "refinements/arrays"
+
+module Marameters
+  # Provides analysis of a method's parameters.
+  class Analyzer
+    using Refinements::Arrays
+
+    # :reek:TooManyStatements
+    def self.of klass, name, collection: []
+      method = klass.instance_method name
+
+      return collection unless method
+
+      collection << new(method.parameters)
+      super_method = method.super_method
+      of super_method.owner, super_method.name, collection:
+    rescue NameError
+      collection
+    end
+
+    def initialize parameters
+      @parameters = parameters
+      @items = parameters.reduce({}) { |all, (kind, name)| all.merge kind => name }
+    end
+
+    def block = items[:block]
+
+    def block? = items.key? :block
+
+    def empty? = items.empty?
+
+    def keyword_slice collection, keys:
+      collection.select { |key| !keys.include?(key) || keywords.include?(key) }
+    end
+
+    def keywords = items.values_at(:keyreq, :key).compress!
+
+    def keywords? = keywords.any?
+
+    def kind?(kind) = items.key? kind
+
+    def kinds = items.keys
+
+    def name?(name) = items.value? name
+
+    def names = items.values
+
+    def only_bare_splats? = (parameters in [[:rest]] | [[:keyrest]] | [[:rest], [:keyrest]])
+
+    def only_double_splats? = (parameters in [[:keyrest, *]])
+
+    def only_single_splats? = (parameters in [[:rest, *]])
+
+    def positionals = items.values_at(:req, :opt).compress!
+
+    def positionals? = positionals.any?
+
+    def splats = items.values_at(:rest, :keyrest).compress!
+
+    def splats? = splats.any?
+
+    def to_a = parameters
+
+    def to_h = items
+
+    private
+
+    attr_reader :parameters, :items
+  end
+end

data/lib/marameters.rb

@@ -6,8 +6,4 @@ Zeitwerk::Loader.for_gem.setup
 
 # Main namespace.
 module Marameters
-  TRANSFORMER = lambda do |parameters, pattern|
-    parameters.select { |kind, _name| pattern.include? kind }
-              .reduce({}) { |collection, (kind, name)| collection.merge kind => name }
-  end
 end

data/marameters.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |spec|
   spec.name = "marameters"
-  spec.version = "0.0.0"
+  spec.version = "0.1.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://www.alchemists.io/projects/marameters"
-  spec.summary = "Provides method parameter introspection."
+  spec.summary = "Provides method parameter introspection which is useful when metaprogramming."
   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.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   lkHilIrX69jq8wMPpBhlaw2mRmeSL50Wv5u6xVBvOHhXFSP1crXM95vfLhLyRYod
   W2A=
   -----END CERTIFICATE-----
-date: 2022-03-06 00:00:00.000000000 Z
+date: 2022-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: refinements
@@ -70,10 +70,7 @@ files:
 - LICENSE.adoc
 - README.adoc
 - lib/marameters.rb
-- lib/marameters/core.rb
-- lib/marameters/keyword.rb
-- lib/marameters/positional.rb
-- lib/marameters/splat.rb
+- lib/marameters/analyzer.rb
 - marameters.gemspec
 homepage: https://www.alchemists.io/projects/marameters
 licenses:
@@ -103,5 +100,5 @@ requirements: []
 rubygems_version: 3.3.8
 signing_key:
 specification_version: 4
-summary: Provides method parameter introspection.
+summary: Provides method parameter introspection which is useful when metaprogramming.
 test_files: []

data/lib/marameters/core.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-module Marameters
-  # Provides access to method arguments for meta-programming and/or debugging purposes.
-  class Core
-    # Order matters.
-    DELEGATES = {positional: Positional, keyword: Keyword, splat: Splat}.freeze
-
-    # :reek:TooManyStatements
-    def self.of klass, name, collection: []
-      method = klass.instance_method name
-
-      return collection unless method
-
-      collection << new(method.parameters)
-      super_method = method.super_method
-      of super_method.owner, super_method.name, collection:
-    rescue NameError
-      collection
-    end
-
-    def initialize parameters, delegates: DELEGATES
-      @parameters = parameters
-
-      @delegates = delegates.reduce({}) do |accumulator, (key, klass)|
-        accumulator.merge key => klass.new(parameters)
-      end
-    end
-
-    def empty? = parameters.empty?
-
-    def keyword?(name) = keyword.name? name
-
-    def keywords = keyword.names
-
-    def kinds = delegates.values.reduce([]) { |collection, delegate| collection + delegate.kinds }
-
-    def named_single_splat_only? = splat.named_single_only?
-
-    def names = delegates.values.reduce([]) { |collection, delegate| collection + delegate.names }
-
-    def positional? = !positional.empty?
-
-    def positionals = positional.names
-
-    def slice collection, keys:
-      collection.select { |key| !keys.include?(key) || keyword.names.include?(key) }
-    end
-
-    def to_a = parameters
-
-    def unnamed_splats_only? = splat.unnamed_only?
-
-    private
-
-    attr_reader :parameters, :delegates
-
-    def keyword = delegates.fetch(__method__)
-
-    def splat = delegates.fetch(__method__)
-
-    def positional = delegates.fetch(__method__)
-  end
-end

data/lib/marameters/keyword.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Marameters
-  # Specializes in providing keyword method parameter information only.
-  class Keyword
-    PATTERN = %i[key keyreq].freeze
-
-    def initialize parameters, pattern: PATTERN, transformer: TRANSFORMER
-      @parameters = parameters
-      @collection = transformer.call parameters, pattern
-    end
-
-    def empty? = collection.empty?
-
-    def kinds = collection.keys
-
-    def name?(name) = collection.value? name
-
-    def names = collection.values
-
-    private
-
-    attr_reader :parameters, :collection
-  end
-end

data/lib/marameters/positional.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Marameters
-  # Specializes in providing positional method paratemer information only.
-  class Positional
-    PATTERN = %i[req opt].freeze
-
-    def initialize parameters, pattern: PATTERN, transformer: TRANSFORMER
-      @parameters = parameters
-      @collection = transformer.call parameters, pattern
-    end
-
-    def empty? = collection.empty?
-
-    def kinds = collection.keys
-
-    def names = collection.values
-
-    private
-
-    attr_reader :parameters, :collection
-  end
-end

data/lib/marameters/splat.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module Marameters
-  # Specializes in providing passthrough method parameter information only.
-  class Splat
-    PATTERN = %i[rest keyrest].freeze
-
-    def initialize parameters, pattern: PATTERN, transformer: TRANSFORMER
-      @parameters = parameters
-      @collection = transformer.call parameters, pattern
-    end
-
-    def empty? = collection.empty?
-
-    def kinds = collection.keys
-
-    def names = collection.values
-
-    def named_double_only? = (parameters in [[:keyrest, *]])
-
-    def named_single_only? = (parameters in [[:rest, *]])
-
-    def unnamed_only? = (parameters in [[:rest]] | [[:keyrest]] | [[:rest], [:keyrest]])
-
-    private
-
-    attr_reader :parameters, :collection
-  end
-end