protovalidate 0.1.0.beta1-aarch64-linux-gnu

data/lib/protovalidate/errors.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Protovalidate
+  # Base class of the errors raised by this gem.
+  class Error < StandardError; end
+
+  # Raised when the rules of a message type cannot be compiled, for example a
+  # CEL expression that does not parse or type-check.
+  class CompilationError < Error; end
+
+  # Raised when a rule fails while being evaluated against a message.
+  class EvaluationError < Error; end
+
+  # Raised by {Protovalidate.validate} and {Validator#validate} for a message
+  # that violates its rules.
+  class ValidationError < Error
+    # @return [Array<Violation>] the violations, in evaluation order
+    attr_reader :violations
+
+    # @param message [String]
+    # @param violations [Array<Violation>]
+    def initialize(message, violations)
+      super(message)
+      @violations = violations
+    end
+
+    # @return [Buf::Validate::Violations] the violations as a buf.validate message
+    def to_proto
+      Buf::Validate::Violations.new(violations: violations.map(&:proto))
+    end
+  end
+end

data/lib/protovalidate/native.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Precompiled gems carry one extension per Ruby minor under lib/protovalidate/<X.Y>/.
+fat = File.expand_path("#{RUBY_VERSION[/\A\d+\.\d+/]}/protovalidate_native", __dir__.to_s)
+if File.exist?("#{fat}.#{RbConfig::CONFIG.fetch("DLEXT")}")
+  require fat
+else
+  require_relative "protovalidate_native"
+end
+
+# @!parse
+#   module Protovalidate
+#     # Binding to protovalidate-cc, implemented by the native extension.
+#     # @api private
+#     module Native
+#       # A descriptor pool plus a rule cache. Bytes in, bytes out.
+#       # @api private
+#       class Engine
+#         # @param file [String] a serialized google.protobuf.FileDescriptorProto
+#         # @return [void]
+#         def add_file(file); end
+#
+#         # @param type_name [String] fully qualified message name
+#         # @param payload [String] the serialized message
+#         # @param fail_fast [Boolean]
+#         # @return [String, nil] serialized buf.validate.Violations, or nil when valid
+#         def validate(type_name, payload, fail_fast); end
+#       end
+#     end
+#   end

data/lib/protovalidate/validator.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "set"
+
+module Protovalidate
+  # Validates messages against the buf.validate rules of their schema.
+  #
+  # A validator owns a native engine that compiles the rules of each message
+  # type once and caches them, so reuse one instance rather than creating one
+  # per validation. Instances may be shared between threads; Ractors are not
+  # supported.
+  class Validator
+    # @param descriptor_pool [Google::Protobuf::DescriptorPool] pool the
+    #   validated messages' schema files and their imports are looked up in
+    def initialize(descriptor_pool: Google::Protobuf::DescriptorPool.generated_pool)
+      @descriptor_pool = descriptor_pool
+      @engine = Native::Engine.new
+      @registered_files = Set.new
+      @registered_types = Set.new
+      @registration = Mutex.new
+    end
+
+    # Validates a message, raising when it is invalid.
+    #
+    # @param message [Google::Protobuf::MessageExts]
+    # @param fail_fast [Boolean] stop at the first violation
+    # @return [void]
+    # @raise [ValidationError] when the message violates its rules; its
+    #   violations equal what {#collect_violations} returns
+    # @raise [CompilationError] when the rules of the message type cannot be compiled
+    # @raise [EvaluationError] when a rule fails during evaluation
+    # @raise [TypeError] when `message` is not a Protobuf message
+    def validate(message, fail_fast: false)
+      violations = collect_violations(message, fail_fast:)
+      return if violations.empty?
+
+      raise ValidationError.new("invalid #{message.class.descriptor.name}", violations)
+    end
+
+    # Validates a message and returns its violations instead of raising.
+    #
+    # @param message [Google::Protobuf::MessageExts]
+    # @param fail_fast [Boolean] stop at the first violation
+    # @return [Array<Violation>] empty when the message is valid
+    # @raise [CompilationError] when the rules of the message type cannot be compiled
+    # @raise [EvaluationError] when a rule fails during evaluation
+    # @raise [TypeError] when `message` is not a Protobuf message
+    def collect_violations(message, fail_fast: false)
+      descriptor = descriptor_of(message)
+      register(descriptor)
+      serialized = @engine.validate(descriptor.name, message.class.encode(message), fail_fast)
+      return [] if serialized.nil?
+
+      Buf::Validate::Violations.decode(serialized).violations.map do |proto|
+        Violation.new(proto, message)
+      end
+    end
+
+    private def descriptor_of(message)
+      klass = message.class
+      unless klass.respond_to?(:descriptor) && klass.descriptor.is_a?(Google::Protobuf::Descriptor)
+        raise TypeError, "expected a Google::Protobuf message, got #{klass}"
+      end
+
+      klass.descriptor
+    end
+
+    private def register(descriptor)
+      return if @registered_types.include?(descriptor.name)
+
+      @registration.synchronize do
+        next if @registered_types.include?(descriptor.name)
+
+        register_file(descriptor.file_descriptor)
+        @registered_types << descriptor.name
+      end
+    end
+
+    # The engine resolves imports eagerly, so they are added before the importer.
+    private def register_file(file)
+      return if @registered_files.include?(file.name)
+
+      proto = file.to_proto
+      proto.dependency.each do |name|
+        dependency = @descriptor_pool.lookup(name)
+        unless dependency.is_a?(Google::Protobuf::FileDescriptor)
+          raise ArgumentError, "#{file.name} imports #{name}, which is not in the descriptor pool"
+        end
+
+        register_file(dependency)
+      end
+      @engine.add_file(Google::Protobuf::FileDescriptorProto.encode(proto))
+      @registered_files << file.name
+    end
+  end
+end

data/lib/protovalidate/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Protovalidate
+  # Version of this gem.
+  VERSION = "0.1.0.beta1"
+
+  # Version of the protovalidate specification (buf.validate protos and
+  # conformance suite) this gem bundles and is validated against.
+  PROTOVALIDATE_VERSION = "1.2.2"
+end

data/lib/protovalidate/violation.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module Protovalidate
+  # A single rule violation, wrapping its `buf.validate.Violation` form.
+  class Violation
+    # @return [Buf::Validate::Violation] the violation as a buf.validate message
+    attr_reader :proto
+
+    # @param proto [Buf::Validate::Violation]
+    # @param source [Google::Protobuf::MessageExts, nil] the validated message,
+    #   used to resolve {#field_value}
+    def initialize(proto, source = nil)
+      @proto = proto
+      @source = source
+    end
+
+    # @return [String] identifier of the violated rule, such as `string.min_len`
+    def rule_id
+      proto.rule_id
+    end
+
+    # @return [String] human-readable description of the violation
+    def message
+      proto.message
+    end
+
+    # @return [Boolean] whether the violation is about a map key rather than its value
+    def for_key?
+      proto.for_key
+    end
+
+    # @return [Buf::Validate::FieldPath, nil] path to the violating field, if any
+    def field
+      proto.field
+    end
+
+    # @return [Buf::Validate::FieldPath, nil] path to the violated rule within
+    #   the field's `buf.validate.FieldRules`, if any
+    def rule
+      proto.rule
+    end
+
+    # @return [String] {#field} rendered as `a.b[0].c["key"]`, empty for message-level rules
+    def field_path
+      path = field
+      return "" if path.nil?
+
+      path.elements.map { |element| render_element(element) }.join(".")
+    end
+
+    # Walks {#field} through the validated message.
+    #
+    # @return [Object, nil] the value that violated the rule, the map key when
+    #   {#for_key?}, or nil when the message is not known or the path does not resolve
+    def field_value
+      path = field
+      return nil if @source.nil? || path.nil?
+
+      elements = path.elements
+      value = @source #: untyped
+      elements.each_with_index do |element, index|
+        return nil unless value.is_a?(Google::Protobuf::MessageExts)
+
+        descriptor = value.class.descriptor.find do |candidate|
+          candidate.is_a?(Google::Protobuf::FieldDescriptor) && candidate.number == element.field_number
+        end
+        descriptor ||= value.class.descriptor.lookup(element.field_name)
+        return nil unless descriptor
+
+        value = value[descriptor.name]
+        key = subscript_of(element)
+        next if key.equal?(NO_SUBSCRIPT)
+
+        last = index == elements.size - 1
+        return key if last && for_key?
+
+        value = value[key]
+      end
+      value
+    end
+
+    # @return [String]
+    def to_s
+      location = field_path
+      location = "#{location}: " unless location.empty?
+      "#{location}#{message} [#{rule_id}]"
+    end
+
+    # @return [String]
+    def inspect
+      "#<#{self.class.name} #{self}>"
+    end
+
+    NO_SUBSCRIPT = Object.new.freeze
+    private_constant :NO_SUBSCRIPT
+
+    private def subscript_of(element)
+      case element.subscript
+      when :index then element.index
+      when :bool_key then element.bool_key
+      when :int_key then element.int_key
+      when :uint_key then element.uint_key
+      when :string_key then element.string_key
+      else NO_SUBSCRIPT
+      end
+    end
+
+    private def render_element(element)
+      subscript = subscript_of(element)
+      return element.field_name if subscript.equal?(NO_SUBSCRIPT)
+
+      "#{element.field_name}[#{subscript.inspect}]"
+    end
+  end
+end

data/lib/protovalidate.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "google/protobuf"
+require "google/protobuf/descriptor_pb"
+
+require_relative "protovalidate/version"
+require_relative "protovalidate/errors"
+
+# Validates Protobuf messages against the buf.validate rules declared in their
+# schema. Rules are evaluated by protovalidate-cc through a native extension.
+#
+# @example
+#   Protovalidate.validate(message)                # raises Protovalidate::ValidationError
+#   Protovalidate.collect_violations(message).each { |v| puts v }
+module Protovalidate
+  DEFAULT_VALIDATOR_LOCK = Mutex.new
+  private_constant :DEFAULT_VALIDATOR_LOCK
+
+  # The validator shared by {validate} and {collect_violations}, built on first use.
+  #
+  # @return [Validator]
+  def self.validator
+    @validator || DEFAULT_VALIDATOR_LOCK.synchronize { @validator ||= Validator.new }
+  end
+
+  # Validates a message with the shared validator.
+  #
+  # @param (see Validator#validate)
+  # @return [void]
+  # @raise (see Validator#validate)
+  def self.validate(message, fail_fast: false)
+    validator.validate(message, fail_fast:)
+  end
+
+  # Collects the violations of a message with the shared validator.
+  #
+  # @param (see Validator#collect_violations)
+  # @return (see Validator#collect_violations)
+  # @raise (see Validator#collect_violations)
+  def self.collect_violations(message, fail_fast: false)
+    validator.collect_violations(message, fail_fast:)
+  end
+end
+
+require_relative "protovalidate/native"
+require_relative "buf/validate/validate_pb"
+require_relative "protovalidate/violation"
+require_relative "protovalidate/validator"

data/licenses/abseil-cpp-LICENSE

@@ -0,0 +1,203 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://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
+
+       https://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/licenses/antlr4-LICENSE.txt

@@ -0,0 +1,28 @@
+Copyright (c) 2012-2022 The ANTLR Project. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+3. Neither name of copyright holders nor the names of its contributors
+may be used to endorse or promote products derived from this software
+without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.