params-registry 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 056d5ebab254d389e210590cfbb3e2f68302189933e1bb352cf857f78d5e4dbc
+  data.tar.gz: 9269fd8561ff6fe8510dfdb2f3e5d7e003e0aba1a6a3fb1e9ec093c034a7c057
+SHA512:
+  metadata.gz: be1ccb24babc79fd919b1781fab9cf3f354519eb85ea95336f6c4edcb6758c24f4735b468f887f74eb278428d3c01bd72ceba322491ade5adab6d428ac501310
+  data.tar.gz: 2c4e8fec183a9d60bbfe440baaacc0e8674533d300c65ba404d7b603e208396152dfaf8d9e557a6bb10981f79fdcbb75863afca4b042be61381df7a1fa897593

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.yardopts

@@ -0,0 +1,2 @@
+--markup=markdown
+--no-private

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,86 @@
+# `Params::Registry`: A registry for named parameters
+
+This module enables an organization to specify a single company-wide
+set of named parameters: their syntax, semantics, cardinalities, type
+coercions, constraints, conflicts and other interrelationships,
+groupings, and so on. The goal is to enforce consistency over
+(especially) public-facing parameters and what they mean, promote
+re-use, perform input sanitation and other preprocessing chores, and
+do consistent, one-to-one, round-trip serialization for things like
+URI query strings.
+
+The theoretical underpinning for `Params::Registry` is a phenomenon I
+call [the symbol management
+problem](https://doriantaylor.com/the-symbol-management-problem),
+namely that within a given information system, you have a bunch of
+_symbols_, which you have to _manage_, and this is a _problem_.
+`Params::Registry` endeavours to take one category of symbols off the
+table: named parameters that are exposed to the wild through
+mechanisms like URLs and APIs.
+
+## So, query parameters, isn't that like, _super_ anal?
+
+So, I vacillated for _years_ before making [the _first_ version of
+this module](https://metacpan.org/dist/Params-Registry) back in 2013.
+_Query_ parameters? I mean, who cares? Well, it turns out that if you
+want certain outcomes, this is the kind of software you need. _What_
+outcomes, you ask?
+
+* Your organization has different parts of its website that use the
+  same parameters to mean the same or similar things.
+* Your organization has different parts of its website that use
+  _different_ parameters to mean the _same_ things.
+* Your organization has _more_ than one website, with non-zero overlap
+  in their respective functionalities.
+* Arbitrary data coming in off the wire (even in something like a
+  URL!) is untrustworthy, so it behooves us to check it.
+* Some parameters may be required, others optional, or they could have
+  complex relationships with each other like dependencies and conflicts.
+* Whatever code that consumes the parameters is turning them into some
+  kind of object (i.e., not just a primitive datatype like a string or
+  integer), potentially combining two or more key-value pairs into
+  composites.
+* Whatever's consuming the parameters may be able to correct if a
+  parameter value is out of bounds (e.g. not in a database), even if
+  it is otherwise valid.
+* You want to be able to issue redirects in the case of recoverable
+  conflicts in the input, and genuinely helpful error messages for the
+  non-recoverable ones.
+
+Okay, all that is pretty uncontroversially useful stuff, but
+represents something you could probably hack together on an ad-hoc
+basis if you really cared. It wouldn't require maintaining an
+organization-wide parameter registry. But how about crazy stuff like:
+
+* What if you wanted to round-trip the parameter sets, so that a given
+  data structure would _always_ serialize—bit for bit—to the same
+  query string, and back again?
+* What if you wanted to gracefully handle name changes for the
+  parameters, and/or translate their names into different languages?
+
+I shouldn't have to spell out the value of these, but the reason why
+you would care about round-tripping the query string is to lower the
+footprint out in the wild of URLs that were _different_ lexically but
+identified the same resource and/or representational state. The reason
+why you would care about parameter naming history is to improve user
+experience—directly and via search engines—by catching otherwise
+broken links and correcting them (e.g. through a `301` redirect), for
+the same purpose. The reason why you would want to localize parameter
+names _should_ be obvious, it just shares its mechanism with the
+naming history.
+
+In essence, this module takes a category of symbol that couldn't
+viably be managed in an organization of even _modest_ size, and makes
+it manageable for an organization of _any_ size.
+
+# Contributing
+
+Bug reports and pull requests are welcome at
+[the GitHub repository](https://github.com/doriantaylor/rb-params-registry).
+
+# Copyright & License
+
+©2023 [Dorian Taylor](https://doriantaylor.com/)
+
+This software is provided under
+the [Apache License, 2.0](https://www.apache.org/licenses/LICENSE-2.0).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/params/registry/error.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative 'version'
+require_relative 'types'
+
+# We assume all errors are argument errors
+class Params::Registry::Error < ArgumentError
+
+  def initialize message, context: nil, value: nil
+    @context = context
+    @value   = value
+    super message
+  end
+
+  # Errors for when nothing can be done with the lexical value of the input
+  class Syntax < self
+  end
+
+  # Errors for when the syntax checks out but the value doesn't
+  # conform empirically
+  class Empirical < self
+  end
+
+  class Cardinality < Empirical
+  end
+
+  # A correctable error
+  class Correction < Empirical
+    def initialize message, context: nil, value: nil, nearest: nil
+      @nearest = nearest
+      super message, context: context, value: value
+    end
+  end
+
+  # Errors for when there is a missing dependency
+  class Dependency < Empirical
+    def initialize message, context: nil, value: nil, others: nil
+      @others = Types::Array[others]
+      super message, context: context, value: value, others: others
+    end
+  end
+
+  # Errors for when there is an actual conflict between parameters
+  class Conflict < Dependency
+  end
+end

data/lib/params/registry/instance.rb

@@ -0,0 +1,210 @@
+# frozen_string_literal: true
+
+require_relative 'types'
+
+# This class represents a parsed instance of a set of parameters. It
+# is intended to be used like a {::Hash}, and, among other things,
+# manages the serialization of the parameters back into a normalized
+# query string.
+#
+class Params::Registry::Instance
+
+  private
+
+  # i wish it was smart and would just resolve relative class names
+  Types = Params::Registry::Types
+
+  # This is the epitome of an internal method. It has weird
+  # parameters, modifies state, and returns a value that is useless
+  # for anything but subsequent internal processing.
+  def process_one template, values, complement: false, force: false
+    del = Set[]
+
+    # run the preprocessor
+    if template.preproc? and template.consumes.all? { |k| @content.key? k }
+      others = @content.values_at(*template.consumes)
+
+      # XXX maybe we should
+      values = template.preproc values, others
+      del += template.consumes
+    end
+
+    # if this actually goes here then there's a bug in the perl one
+    return del if values.empty? and not force
+
+    # now we use the template to process it (note this raises)
+    tmp = template.process(*values)
+    @content[template.id] = tmp if !tmp.nil? or template.empty?
+
+    # now we test for conflicts
+    tc = template.conflicts - template.consumes - del.to_a
+    unless tc.empty?
+      conflicts = @content.keys & tc
+      raise Params::Registry::Error::Conflict.new(
+        "Parameter #{template.id} conflicts with #{conflicts.join(', ')}"
+      ) unless conflicts.empty?
+    end
+
+    # now we handle the complement
+    @content[template.id] = template.complement(@content[template.id]) if
+      complement and template.complement?
+
+    del # the keys slated for deletion
+  end
+
+  public
+
+  attr_reader :registry
+
+  # Make a new instance.
+  #
+  # @param registry [Params::Registry] the registry
+  # @param struct [Hash{Symbol => Array<String>}] something that
+  #  resembles the output of `URI.decode_www_form`.
+  #
+  def initialize registry, struct, defaults: false, force: false
+    struct    = Types::Input[struct]
+    @registry = registry
+    @content  = {}
+    @extra    = {}
+
+    # canonicalize the keys of the struct
+    struct = struct.reduce({}) do |hash, pair|
+      key, value = pair
+      if t = registry.templates[key]
+        hash[t.id] = value
+      else
+        extra[key] = value
+      end
+
+      hash
+    end
+
+    errors = {} # collect errors so we only raise once at the end
+    del = Set[] # mark for deletion
+
+    # grab the complements now
+    complements = @content[registry.complement.id] =
+      registry.complement.process(*struct.fetch(registry.complement.id, []))
+
+    # warn registry.templates.ranked.inspect
+
+    # warn complements.class
+
+    # now we get the ranked templates and pass them through
+    registry.templates.ranked.each do |templates|
+      # give me the intersection of templates
+      templates.values.each do |t|
+
+        # warn t.id
+
+        # obtain the raw values or an empty array instead
+        raw = struct.fetch t.id, []
+
+        c = complements.include? t.id
+
+        begin
+          del += process_one t, raw, force: force, complement: c
+        rescue Params::Registry::Error => e
+          errors[t.id] = e
+        end
+
+      end
+    end
+
+    # raise any errors if we need to
+    raise Params::Registry::Error::Processing.new(
+      'One or more parameters failed to process', errors: errors) unless
+      errors.empty?
+
+    # delete the unwanted parameters
+    del.each { |d| @content.delete d }
+  end
+
+  # Retrieve the processed value for a parameter.
+  #
+  # @param param [Object, #to_sym] the parameter identifier, or
+  #  slug, or alias.
+  #
+  # @return [Object, Array, nil] the value, if present.
+  #
+  def [] param
+    param = @registry.templates.canonical(param) or return @extra[param]
+    @content[param]
+  end
+
+  # Assign a new value to a key. The new value will be tested
+  # against the `composite` type if one is present, then an
+  # {::Array} of the ordinary atomic type if the cardinality is
+  # greater than 1, then finally the atomic type.
+  #
+  # @param param [Object, #to_sym] the parameter identifier, or
+  #  slug, or alias.
+  # @param value [Object, Array] the value, which is subject to type
+  #  assertion/coercion.
+  #
+  # @return [Object, Array] the value(s) associated with the
+  #  parameter.
+  #
+  def []= param, value
+    unless template = registry.templates[param]
+      value = value.respond_to?(:to_a) ? value.to_a : value
+      return @extras[param] = value
+    end
+
+    # XXX do something less dumb about this
+    c = (@content[registry.complement.id] || Set[]).include? template.id
+
+    # this modifies @content and may raise
+    del = process_one template, value, force: true, complement: c
+
+    del.each { |d| @content.delete d }
+
+    # return
+    @content[template.id]
+  end
+
+  # Taxidermy this object as an ordinary hash.
+  #
+  # @return [Hash] basically the same thing, minus its metadata.
+  #
+  def to_h
+    # XXX maybe enforce the ordering better??
+    @content.merge @extra
+  end
+
+  # Retrieve an {Params::Registry::Instance} that isolates the
+  # intersection of one or more groups
+  #
+  # @param group [Object] the group identifier.
+  # @param extra [false, true] whether to include any "extra" unparsed
+  #  parameters.
+  #
+  # @return [Params::Registry::Instance] an instance containing just
+  #  the group(s) identified.
+  #
+  def group *group, extra: false
+  end
+
+  # Serialize the instance back to a {::URI} query string.
+  #
+  # @return [String] the instance serialized as a URI query string.
+  #
+  def to_s
+    ts = registry.templates
+    sequence = ts.keys & @content.keys
+    complements = Set[]
+    sequence.map do |k|
+      template = ts[k]
+      deps = @content.values_at(*(template.depends - template.consumes))
+      v, c = template.unprocess @content[k], *deps, with_complement_flag: true
+      complements << k if c
+
+      # warn @content[k], v.inspect
+
+      next if v.empty?
+
+      v.map { |v| "#{template.slug || k}=#{v}" }.join ?&
+    end.compact.join ?&
+  end
+end