j2119 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 77e37161a3dd37e54c5bd312adf906ba4acb3f31
+  data.tar.gz: 28ec7bfb523432d79a1be3b52119aca775dfea08
+SHA512:
+  metadata.gz: 0ec99127e2a2db8e9708d3736952c5a0a7e61974756576ed3dc9df83f7c95dab55daad4f701dcd87356415d180dcacbe88d49c6e2ac582f0492990e93779d300
+  data.tar.gz: 317119a518e9e0d6802edfa478acb0275bd0bb0b4cd139bc4e1e9caa43c0601f319951319dc18f75c6cb9e8de1874b4cad38a4d3e6b4ceedd8c115646ac83e88

data/.gitignore

@@ -0,0 +1,2 @@
+*~
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem 'json', '>=1.7.7'

data/LICENSE

@@ -0,0 +1,201 @@
+                                 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/NOTICE.txt

@@ -0,0 +1,3 @@
+statelint
+
+Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.

data/README.md

@@ -0,0 +1,97 @@
+# j2119
+A general-purpose validator generator that uses RFC2119-style assertions as input.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'j2119'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install j2119
+
+## Usage
+
+There is only one outward-facing class, Validator.
+
+```ruby
+validator = J2119::Validator.new(schema-file)
+```
+
+Where ```schema-file``` is the name of a file containing text in the J2119 
+syntax described below. This yields a validator, which can be re-used,
+and should be, since its construction is moderately expensive:
+
+```ruby
+problems = validator.validate(json_source)
+```
+
+```json_source``` is the text to be validated; it can be a string or an IO or
+a filename, J2119 tries to do the right thing. ```validate``` returns a string
+array containing messages describing any problems it found. If the array is
+empty, then there were no problems.
+
+There are also two utility methods. ```parsed``` returns the parsed form of
+the ```json_source``` text.  The idea is that if you want to do any further
+semantic validation, there's no reason to parse the JSON twice.
+
+```root``` returns the root "role" in the J2119 schema, a string that is
+useful in making user-friendly error messages.
+
+## J2119 Syntax
+
+J2119's operations are driven by a set of assertions containing the words
+"MUST" and "MAY" used in the style found in IETF RFCs, and specified in
+RFC 2119.  It is organized in lines, each terminated with a single full stop.
+There are three formalisms, "roles", "types" and "constraints". For example:
+
+```
+A Message MUST have an object-array field named "Paragraphs"; each member is a "Paragraph".
+```
+
+In the above assertion, "Message" and "Paragraph" are roles, "string-array" is a
+type; the whole line says that a JSON node with the role "Message" is required
+to have a field named "Paragraphs" whose value is a JSON array containing only
+object values.   It further says that when validating the object members of
+the array, they are considered to have the role "Paragraph".
+
+The first line of the J2119 schema must be of the following form:
+
+```
+This document specifies a JSON object called a "Message".
+```
+
+This gives the root object the role "Message". Descendant nodes can be given
+roles based on their parentage (as in the first J2119 example above) and the
+presence or value of certain fields, and nodes can have multiple roles
+simultaneously.
+
+The J2119 syntax was invented for the purpose of constructing a validator for
+one specific JSON DSL, and at the time of writing of this document, there is
+no claim that it is suitable as a general-purpose JSON schema facility.  At
+this point, the best way to understand J2119 is by example.  In the
+```data/``` directory of this gem there is a file ```AWL.j2119```, which
+may be considered a complete worked example of how to specify a DSL.
+
+## TODO
+
+At the moment, the J2119 syntax is parsed via the brute-force application of
+overly complex regular expressions.  It is in serious need of modularization,
+a real modern parser architecture, and perhaps the application of some
+natural-language processing techniques.
+
+Aside from that, the framework of roles,
+conditionals, and constraints is simple enough and performs at acceptable
+speed.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub 
+

data/Rakefile

@@ -0,0 +1,10 @@
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), "lib"))
+$:.unshift(lib_dir)
+$:.uniq!
+
+require 'rspec/core/rake_task'
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new
+

data/j2119.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name        = 'j2119'
+  s.version     = '0.1.0'
+  s.date        = '2016-09-28'
+  s.summary     = "JSON DSL Validator"
+  s.description = "Validates JSON objects based on constraints in RFC2119-like language"
+  s.authors     = ["Tim Bray"]
+  s.email       = 'timbray@amazon.com'
+  s.files       = `git ls-files`.split("\n").reject do |f|
+    f.match(%r{^(spec|data)/})
+  end
+  s.homepage    = 'http://rubygems.org/gems/j2119'
+  s.license     = 'Apache 2.0'
+  s.add_runtime_dependency "json"
+end

data/lib/j2119/allowed_fields.rb

@@ -0,0 +1,35 @@
+# Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You may
+# not use this file except in compliance with the License. A copy of the
+# License is located at
+#
+#    http://aws.amazon.com/apache2.0/
+#
+# or in the LICENSE.txt file accompanying this file. This file 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.
+
+# The States language is draconian/must-understand; no fields may appear which
+#  aren't explicitly blessed by a MUST/MAY clause
+module J2119
+
+  class AllowedFields
+
+    def initialize
+      @allowed = {}
+    end
+
+    def set_allowed(role, child)
+      @allowed[role] ||= []
+      @allowed[role] << child
+    end
+
+    def allowed?(roles, child)
+      roles.any? do |role|
+        @allowed[role] && @allowed[role].include?(child)
+      end
+    end
+  end
+end

data/lib/j2119/assigner.rb

@@ -0,0 +1,223 @@
+# Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You may
+# not use this file except in compliance with the License. A copy of the
+# License is located at
+#
+#    http://aws.amazon.com/apache2.0/
+#
+# or in the LICENSE.txt file accompanying this file. This file 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.
+
+module J2119
+
+  # Looks at the parsed form of the J2119 lines and figures out,
+  #  by looking at which part of the regexes match, 
+  #  the assignments of roles to nodes and constraints to roles
+  class Assigner
+    
+    def initialize(role_constraints, role_finder, matcher, allowed_fields)
+      @constraints = role_constraints
+      @roles = role_finder
+      @matcher = matcher
+      @allowed_fields = allowed_fields
+    end
+
+    def assign_roles(assertion)
+      if assertion['val_match_present']
+        @roles.add_field_value_role(assertion['role'],
+                                    assertion['fieldtomatch'],
+                                    assertion['valtomatch'],
+                                    assertion['newrole'])
+        @matcher.add_role(assertion['newrole'])
+      elsif assertion['with_a_field']
+        @roles.add_field_presence_role(assertion['role'],
+                                       assertion['with_a_field'],
+                                       assertion['newrole'])
+        @matcher.add_role(assertion['newrole'])
+      else
+        @roles.add_is_a_role(assertion['role'], assertion['newrole'])
+        @matcher.add_role(assertion['newrole'])
+      end
+    end
+
+    def assign_only_one_of(assertion)
+      role = assertion['role']
+      values = Oxford.break_string_list assertion['field_list']
+      add_constraint(role, OnlyOneOfConstraint.new(values), nil)
+    end
+    
+    def assign_constraints(assertion)
+      role = assertion['role']
+      modal = assertion['modal']
+      type = assertion['type']
+      field_name = assertion['field_name']
+      field_list_string = assertion['field_list']
+      relation = assertion['relation']
+      target = assertion['target']
+      strings = assertion['strings']
+      vals = assertion['vals']
+
+      # watch out for conditionals
+      condition = nil
+      if assertion['excluded']
+        excluded_roles =
+          Oxford.break_role_list(@matcher, assertion['excluded'])
+        condition = RoleNotPresentCondition.new(excluded_roles)
+      end
+        
+      if relation
+        add_relation_constraint(role, field_name, relation, target,
+                                condition)
+      end
+      
+      if strings
+        # of the form MUST have a <type> field named <field_name> whose value
+        #  MUST be one of "a", "b", or "c"
+        fields = Oxford.break_string_list strings
+        add_constraint(role,
+                       FieldValueConstraint.new(field_name, :enum => fields),
+                       condition)
+      end
+      
+      if type
+        add_type_constraints(role, field_name, type, condition)
+      end
+
+      if field_list_string
+        field_list = Oxford.break_string_list field_list_string
+      end
+
+      # register allowed fields
+      if field_list_string
+        field_list.each { |field| @allowed_fields.set_allowed(role, field) }
+      elsif field_name
+        @allowed_fields.set_allowed(role, field_name)
+      end
+      
+      if modal == 'MUST'
+        if field_list_string
+          # Of the form MUST have a <type>? field named one of "a", "b", or "c".
+          add_constraint(role, HasFieldConstraint.new(field_list), condition)
+        else
+          add_constraint(role, HasFieldConstraint.new(field_name), condition)
+        end
+      elsif modal == 'MUST NOT'
+        add_constraint(role,
+                       DoesNotHaveFieldConstraint.new(field_name), condition)
+      end
+      
+      # there can be role defs there too
+      if assertion['child_type']
+        @matcher.add_role assertion['child_role']
+        child_type = assertion['child_type']
+        if child_type == 'value'
+          @roles.add_child_role(role, field_name, assertion['child_role'])
+        elsif child_type == 'element' || child_type == 'field'
+          @roles.add_grandchild_role(role, field_name, assertion['child_role'])
+        end
+      end
+    end
+
+    def add_constraint(role, constraint, condition)
+      if condition
+        constraint.add_condition condition
+      end
+      @constraints.add(role, constraint)
+    end
+
+    def add_relation_constraint(role, field, relation, target, condition)
+      target = Deduce.value target
+      case relation
+      when 'equal to'
+        params = { :equal => target }
+      when 'greater than'
+        params = { :floor => target }
+      when 'less than'
+        params = { :ceiling => target }
+      when 'greater than or equal to'
+        params = { :min => target }
+      when 'less than or equal to'
+        params = { :max => target }
+      end
+      add_constraint(role, FieldValueConstraint.new(field, params), condition)
+    end
+
+    def add_type_constraints(role, field, type, condition)
+
+      is_array = (type =~ /-array/)
+      is_nullable = (type =~ /nullable-/)
+      type.split('-').each do |part|
+        case part
+        when 'object'
+          add_constraint(role,
+                         FieldTypeConstraint.new(field, :object,
+                                                 is_array, is_nullable),
+                         condition)
+        when 'string'
+          add_constraint(role,
+                         FieldTypeConstraint.new(field, :string,
+                                                 is_array, is_nullable),
+                         condition)
+        when 'URI'
+          add_constraint(role,
+                         FieldTypeConstraint.new(field, :URI,
+                                                 is_array, is_nullable),
+                         condition)
+        when 'boolean'
+          add_constraint(role,
+                         FieldTypeConstraint.new(field, :boolean,
+                                                 is_array, is_nullable),
+                         condition)
+        when 'numeric'
+          add_constraint(role,
+                         FieldTypeConstraint.new(field, :numeric,
+                                                 is_array, is_nullable),
+                         condition)
+        when 'integer'
+          add_constraint(role,
+                         FieldTypeConstraint.new(field, :integer,
+                                                 is_array, is_nullable),
+                         condition)
+        when 'float'
+          add_constraint(role,
+                         FieldTypeConstraint.new(field, :float,
+                                                 is_array, is_nullable),
+                         condition)
+        when 'timestamp'
+          add_constraint(role,
+                         FieldTypeConstraint.new(field, :timestamp,
+                                                 is_array, is_nullable),
+                         condition)
+        when 'JSONPath'
+          add_constraint(role,
+                         FieldTypeConstraint.new(field, :json_path,
+                                                 is_array, is_nullable),
+                         condition)
+        when 'referencePath'
+          add_constraint(role,
+                         FieldTypeConstraint.new(field, :reference_path,
+                                                 is_array, is_nullable),
+                         condition)
+        when 'positive'
+          add_constraint(role,
+                         FieldValueConstraint.new(field, :floor => 0),
+                         condition)
+        when 'nonnegative'
+          add_constraint(role,
+                         FieldValueConstraint.new(field, :min => 0),
+                         condition)
+        when 'negative'
+          add_constraint(role,
+                         FieldValueConstraint.new(field, :ceiling => 0),
+                         is_array, condition)
+        when 'nonempty'
+          add_constraint(role, NonEmptyConstraint.new(field), condition)
+        end
+      end
+    end
+
+  end
+end

data/lib/j2119/conditional.rb

@@ -0,0 +1,40 @@
+# Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You may
+# not use this file except in compliance with the License. A copy of the
+# License is located at
+#
+#    http://aws.amazon.com/apache2.0/
+#
+# or in the LICENSE.txt file accompanying this file. This file 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.
+
+module J2119
+
+  # to be applied to a role/constraint combo, so the constraint is applied
+  #  conditionally
+  #
+  # These all respond_to
+  # constraint_applies(node, roles)
+  #  - node is the JSON node being checked
+  #  - roles is the roles the node currently has
+
+  class RoleNotPresentCondition
+
+    def initialize(exclude_roles)
+      @excluded_roles = exclude_roles
+    end
+
+    def to_s
+      "excluded roles: #{@excluded_roles}"
+    end
+
+    def constraint_applies(node, roles)
+      (roles & @excluded_roles).empty?
+    end
+    
+  end
+
+end