marameters 0.0.0

checksums.yaml

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

checksums.yaml.gz.sig

@@ -0,0 +1 @@
+��-�dY�T���6��s�6����hj�V�����΋������7�?A+�'GHFt�����!fG֨o2N d:h�PPn��O-�+^�hP��p[&�aB?r�Z#Z�Y>��nvQ�+;���5a6=#o�/=(��(#�M.*C�J�@�)�OU9��LT���3zG	,+p�T	P��%ڝ1E�sdJQDkh�@ׂ�

data/LICENSE.adoc

@@ -0,0 +1,134 @@
+= Hippocratic License
+
+Version: 2.1.0.
+
+Purpose. The purpose of this License is for the Licensor named above to
+permit the Licensee (as defined below) broad permission, if consistent
+with Human Rights Laws and Human Rights Principles (as each is defined
+below), to use and work with the Software (as defined below) within the
+full scope of Licensor’s copyright and patent rights, if any, in the
+Software, while ensuring attribution and protecting the Licensor from
+liability.
+
+Permission and Conditions. The Licensor grants permission by this
+license ("License"), free of charge, to the extent of Licensor’s
+rights under applicable copyright and patent law, to any person or
+entity (the "Licensee") obtaining a copy of this software and
+associated documentation files (the "Software"), to do everything with
+the Software that would otherwise infringe (i) the Licensor’s copyright
+in the Software or (ii) any patent claims to the Software that the
+Licensor can license or becomes able to license, subject to all of the
+following terms and conditions:
+
+* Acceptance. This License is automatically offered to every person and
+entity subject to its terms and conditions. Licensee accepts this
+License and agrees to its terms and conditions by taking any action with
+the Software that, absent this License, would infringe any intellectual
+property right held by Licensor.
+* Notice. Licensee must ensure that everyone who gets a copy of any part
+of this Software from Licensee, with or without changes, also receives
+the License and the above copyright notice (and if included by the
+Licensor, patent, trademark and attribution notice). Licensee must cause
+any modified versions of the Software to carry prominent notices stating
+that Licensee changed the Software. For clarity, although Licensee is
+free to create modifications of the Software and distribute only the
+modified portion created by Licensee with additional or different terms,
+the portion of the Software not modified must be distributed pursuant to
+this License. If anyone notifies Licensee in writing that Licensee has
+not complied with this Notice section, Licensee can keep this License by
+taking all practical steps to comply within 30 days after the notice. If
+Licensee does not do so, Licensee’s License (and all rights licensed
+hereunder) shall end immediately.
+* Compliance with Human Rights Principles and Human Rights Laws.
+[arabic]
+. Human Rights Principles.
+[loweralpha]
+.. Licensee is advised to consult the articles of the United Nations
+Universal Declaration of Human Rights and the United Nations Global
+Compact that define recognized principles of international human rights
+(the "Human Rights Principles"). Licensee shall use the Software in a
+manner consistent with Human Rights Principles.
+.. Unless the Licensor and Licensee agree otherwise, any dispute,
+controversy, or claim arising out of or relating to (i) Section 1(a)
+regarding Human Rights Principles, including the breach of Section 1(a),
+termination of this License for breach of the Human Rights Principles,
+or invalidity of Section 1(a) or (ii) a determination of whether any Law
+is consistent or in conflict with Human Rights Principles pursuant to
+Section 2, below, shall be settled by arbitration in accordance with the
+Hague Rules on Business and Human Rights Arbitration (the "Rules");
+provided, however, that Licensee may elect not to participate in such
+arbitration, in which event this License (and all rights licensed
+hereunder) shall end immediately. The number of arbitrators shall be one
+unless the Rules require otherwise.
++
+Unless both the Licensor and Licensee agree to the contrary: (1) All
+documents and information concerning the arbitration shall be public and
+may be disclosed by any party; (2) The repository referred to under
+Article 43 of the Rules shall make available to the public in a timely
+manner all documents concerning the arbitration which are communicated
+to it, including all submissions of the parties, all evidence admitted
+into the record of the proceedings, all transcripts or other recordings
+of hearings and all orders, decisions and awards of the arbitral
+tribunal, subject only to the arbitral tribunal’s powers to take such
+measures as may be necessary to safeguard the integrity of the arbitral
+process pursuant to Articles 18, 33, 41 and 42 of the Rules; and (3)
+Article 26(6) of the Rules shall not apply.
+. Human Rights Laws. The Software shall not be used by any person or
+entity for any systems, activities, or other uses that violate any Human
+Rights Laws. "Human Rights Laws" means any applicable laws,
+regulations, or rules (collectively, "Laws") that protect human,
+civil, labor, privacy, political, environmental, security, economic, due
+process, or similar rights; provided, however, that such Laws are
+consistent and not in conflict with Human Rights Principles (a dispute
+over the consistency or a conflict between Laws and Human Rights
+Principles shall be determined by arbitration as stated above). Where
+the Human Rights Laws of more than one jurisdiction are applicable or in
+conflict with respect to the use of the Software, the Human Rights Laws
+that are most protective of the individuals or groups harmed shall
+apply.
+. Indemnity. Licensee shall hold harmless and indemnify Licensor (and
+any other contributor) against all losses, damages, liabilities,
+deficiencies, claims, actions, judgments, settlements, interest, awards,
+penalties, fines, costs, or expenses of whatever kind, including
+Licensor’s reasonable attorneys’ fees, arising out of or relating to
+Licensee’s use of the Software in violation of Human Rights Laws or
+Human Rights Principles.
+* Failure to Comply. Any failure of Licensee to act according to the
+terms and conditions of this License is both a breach of the License and
+an infringement of the intellectual property rights of the Licensor
+(subject to exceptions under Laws, e.g., fair use). In the event of a
+breach or infringement, the terms and conditions of this License may be
+enforced by Licensor under the Laws of any jurisdiction to which
+Licensee is subject. Licensee also agrees that the Licensor may enforce
+the terms and conditions of this License against Licensee through
+specific performance (or similar remedy under Laws) to the extent
+permitted by Laws. For clarity, except in the event of a breach of this
+License, infringement, or as otherwise stated in this License, Licensor
+may not terminate this License with Licensee.
+* Enforceability and Interpretation. If any term or provision of this
+License is determined to be invalid, illegal, or unenforceable by a
+court of competent jurisdiction, then such invalidity, illegality, or
+unenforceability shall not affect any other term or provision of this
+License or invalidate or render unenforceable such term or provision in
+any other jurisdiction; provided, however, subject to a court
+modification pursuant to the immediately following sentence, if any term
+or provision of this License pertaining to Human Rights Laws or Human
+Rights Principles is deemed invalid, illegal, or unenforceable against
+Licensee by a court of competent jurisdiction, all rights in the
+Software granted to Licensee shall be deemed null and void as between
+Licensor and Licensee. Upon a determination that any term or provision
+is invalid, illegal, or unenforceable, to the extent permitted by Laws,
+the court may modify this License to affect the original purpose that
+the Software be used in compliance with Human Rights Principles and
+Human Rights Laws as closely as possible. The language in this License
+shall be interpreted as to its fair meaning and not strictly for or
+against any party.
+* Disclaimer. TO THE FULL EXTENT ALLOWED BY LAW, THIS SOFTWARE COMES
+"AS IS," WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED, AND LICENSOR AND
+ANY OTHER CONTRIBUTOR SHALL NOT BE LIABLE TO ANYONE FOR ANY DAMAGES OR
+OTHER LIABILITY ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE
+OR THIS LICENSE, UNDER ANY KIND OF LEGAL CLAIM.
+
+This Hippocratic License is an link:https://ethicalsource.dev[Ethical Source license] and is offered
+for use by licensors and licensees at their own risk, on an "AS IS" basis, and with no warranties
+express or implied, to the maximum extent permitted by Laws.

data/README.adoc

@@ -0,0 +1,127 @@
+:toc: macro
+:toclevels: 5
+:figure-caption!:
+
+= 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:
+
+* *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`.
+
+This gem will help you debug methods or -- more importantly -- aid your workflow when
+metaprogramming and architecting more sophisticated applications.
+
+toc::[]
+
+== Features
+
+* Provides a core object as a primary interface.
+* Provides specialized objects for keyword, positional, and splatted parameters.
+
+== Requirements
+
+. link:https://www.ruby-lang.org[Ruby].
+
+== Setup
+
+To install, run:
+
+[source,bash]
+----
+gem install marameters
+----
+
+Add the following to your Gemfile file:
+
+[source,ruby]
+----
+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:
+
+[source,ruby]
+----
+class Demo
+  def example one, two = nil, *three, four:, five: nil, **six, &seven
+    [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
+----
+
+The `Marameters::Core` delegates to the following classes which you can use individually as well:
+
+[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
+----
+
+== Development
+
+You can also use the IRB console for direct access to all objects:
+
+[source,bash]
+----
+bin/console
+----
+
+== Tests
+
+To test, run:
+
+[source,bash]
+----
+bundle exec rake
+----
+
+== link:https://www.alchemists.io/policies/license[License]
+
+== link:https://www.alchemists.io/policies/security[Security]
+
+== link:https://www.alchemists.io/policies/code_of_conduct[Code of Conduct]
+
+== link:https://www.alchemists.io/policies/contributions[Contributions]
+
+== link:https://www.alchemists.io/projects/marameters/versions[Versions]
+
+== link:https://www.alchemists.io/community[Community]
+
+== Credits
+
+* Built with link:https://www.alchemists.io/projects/gemsmith[Gemsmith].
+* Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].

data/lib/marameters/core.rb

@@ -0,0 +1,64 @@
+# 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

@@ -0,0 +1,25 @@
+# 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

@@ -0,0 +1,23 @@
+# 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

@@ -0,0 +1,29 @@
+# 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

data/lib/marameters.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+
+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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name = "marameters"
+  spec.version = "0.0.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.license = "Hippocratic-2.1"
+
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/bkuhlmann/marameters/issues",
+    "changelog_uri" => "https://www.alchemists.io/projects/marameters/versions",
+    "documentation_uri" => "https://www.alchemists.io/projects/marameters",
+    "label" => "Marameters",
+    "rubygems_mfa_required" => "true",
+    "source_code_uri" => "https://github.com/bkuhlmann/marameters"
+  }
+
+  spec.signing_key = Gem.default_key_path
+  spec.cert_chain = [Gem.default_cert_path]
+
+  spec.required_ruby_version = "~> 3.1"
+  spec.add_dependency "refinements", "~> 9.2"
+  spec.add_dependency "zeitwerk", "~> 2.5"
+
+  spec.extra_rdoc_files = Dir["README*", "LICENSE*"]
+  spec.files = Dir["*.gemspec", "lib/**/*"]
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: marameters
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Brooke Kuhlmann
+autorequire:
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIC/jCCAeagAwIBAgIBBDANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBpicm9v
+  a2UvREM9YWxjaGVtaXN0cy9EQz1pbzAeFw0yMTAzMTkxMjQ4MDZaFw0yMjAzMTkx
+  MjQ4MDZaMCUxIzAhBgNVBAMMGmJyb29rZS9EQz1hbGNoZW1pc3RzL0RDPWlvMIIB
+  IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6l1qpXTiomH1RfMRloyw7MiE
+  xyVx/x8Yc3EupdH7uhNaTXQGyORN6aOY//1QXXMHIZ9tW74nZLhesWMSUMYy0XhB
+  brs+KkurHnc9FnEJAbG7ebGvl/ncqZt72nQvaxpDxvuCBHgJAz+8i5wl6FhLw+oT
+  9z0A8KcGhz67SdcoQiD7qiCjL/2NTeWHOzkpPrdGlt088+VerEEGf5I13QCvaftP
+  D5vkU0YlAm1r98BymuJlcQ1qdkVEI1d48ph4kcS0S0nv1RiuyVb6TCAR3Nu3VaVq
+  3fPzZKJLZBx67UvXdbdicWPiUR75elI4PXpLIic3xytaF52ZJYyKZCNZJhNwfQID
+  AQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU0nzow9vc
+  2CdikiiE3fJhP/gY4ggwDQYJKoZIhvcNAQELBQADggEBAEjpaOXHHp8s/7GL2qCb
+  YAs7urOLv9VHSPfQWAwaTMVnSsIf3Sw4xzISOP/mmfEPBPXtz61K5esrE/uTFtgb
+  FyjxQk2H0sEWgrRXGGNHBWQRhhEs7LP/TByoC15A0br++xLxRz4r7HBLGAWQQDpg
+  66BJ2TBVjxS6K64tKbq7+ACyrOZGgTfNHACh4M076y0x0oRf/rwBrU39/KRfuhbb
+  cm+nNCEtO35gTmZ2bVDHLGvWazi3gJt6+huQjfXTCUUG2YYBxwhu+GPdAGQPxpf9
+  lkHilIrX69jq8wMPpBhlaw2mRmeSL50Wv5u6xVBvOHhXFSP1crXM95vfLhLyRYod
+  W2A=
+  -----END CERTIFICATE-----
+date: 2022-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: refinements
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.2'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+description:
+email:
+- brooke@alchemists.io
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.adoc
+- LICENSE.adoc
+files:
+- LICENSE.adoc
+- README.adoc
+- lib/marameters.rb
+- lib/marameters/core.rb
+- lib/marameters/keyword.rb
+- lib/marameters/positional.rb
+- lib/marameters/splat.rb
+- marameters.gemspec
+homepage: https://www.alchemists.io/projects/marameters
+licenses:
+- Hippocratic-2.1
+metadata:
+  bug_tracker_uri: https://github.com/bkuhlmann/marameters/issues
+  changelog_uri: https://www.alchemists.io/projects/marameters/versions
+  documentation_uri: https://www.alchemists.io/projects/marameters
+  label: Marameters
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/bkuhlmann/marameters
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.8
+signing_key:
+specification_version: 4
+summary: Provides method parameter introspection.
+test_files: []