j2119 0.1.0

data/lib/j2119/node_validator.rb

@@ -0,0 +1,78 @@
+# 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
+
+  class NodeValidator
+
+    def initialize(parser)
+      @parser = parser
+    end
+
+    def validate_node(node, path, roles, problems)
+
+      if !node.is_a?(Hash)
+        return
+      end
+
+      # may have more roles based on field presence/value etc
+      @parser.find_more_roles(node, roles)
+
+      # constraints are attached per-role
+      # TODO - look through the constraints and if there is a
+      #  "Field should not exist" constraint, then disable
+      #  type and value checking constraints
+      #
+      roles.each do |role|
+        @parser.get_constraints(role).each do |constraint|
+          if constraint.applies(node, roles)
+            constraint.check(node, path, problems)
+          end
+        end
+      end
+
+      # for each field
+      node.each do |name, val|
+
+        if !@parser.field_allowed?(roles, name)
+          problems << "Field \"#{name}\" not allowed in #{path}"
+        end
+
+        # only recurse into children if they have roles
+        child_roles = @parser.find_child_roles(roles, name)
+        if !child_roles.empty?
+          validate_node(val, "#{path}.#{name}", child_roles, problems)
+        end
+
+        # find inheritance-based roles for that field
+        grandchild_roles = @parser.find_grandchild_roles(roles, name)
+
+        # recurse into grandkids
+        if val.is_a? Hash
+          val.each do |child_name, child_val|
+            validate_node(child_val, "#{path}.#{name}.#{child_name}",
+                          grandchild_roles.clone, problems)
+          end
+        elsif val.is_a? Array
+          i = 0
+          val.each do |member|
+            validate_node(member, "#{path}.#{name}[#{i}]",
+                          grandchild_roles.clone, problems)
+            i += 1
+          end
+          
+        end
+      end
+    end
+  end
+end

data/lib/j2119/oxford.rb

@@ -0,0 +1,67 @@
+# 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
+
+  # We have to recognize lots of lists like so:
+  #  X
+  #  X or X
+  #  X, X, or X
+  # Examples:
+  # one of "Foo", "Bar", or "Baz"
+  # a Token1, a Token2, or a Token3
+  class Oxford
+    BASIC = "(?<CAPTURE>X((((,\\s+X)+,)?)?\\s+or\\s+X)?)"
+
+    def self.re(particle, opts = {})
+      has_capture, inter, has_connector, last = BASIC.split 'X'
+      has_connector.gsub!('or', opts[:connector]) if opts[:connector]
+      if opts[:use_article]
+        particle = "an?\\s+(#{particle})"
+      else
+        particle = "(#{particle})"
+      end
+      if opts[:capture_name]
+        has_capture.gsub!('CAPTURE', opts[:capture_name])
+      else
+        has_capture.gsub!('?<CAPTURE>', '')
+      end
+      [ has_capture, inter, has_connector, last].join(particle)
+    end
+
+    def self.break_string_list list
+      pieces = []
+      re = Regexp.compile "^[^\"]*\"([^\"]*)\""
+      while list =~ re
+        pieces << $1
+        list = $'
+      end
+      pieces
+    end
+
+    def self.break_role_list(matcher, list)
+      pieces = []
+      re = Regexp.compile "^an?\\s+(#{matcher.role_matcher})(,\\s+)?"
+      while list =~ re
+        pieces << $1
+        list = $'
+      end
+      if list =~ /^\s*(and|or)\s+an?\s+(#{matcher.role_matcher})/
+        pieces << $2
+      end
+      pieces
+    end
+    
+  end
+
+end

data/lib/j2119/parser.rb

@@ -0,0 +1,101 @@
+# 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
+
+  class Parser
+
+    ROOT = Regexp.new('This\s+document\s+specifies\s+' +
+                      'a\s+JSON\s+object\s+called\s+an?\s+"([^"]+)"\.')
+
+    attr_reader :root
+
+    # for debugging
+    attr_reader :finder
+
+    def initialize(j2119_file)
+
+      have_root = false
+      @failed = false
+      @constraints = RoleConstraints.new
+      @finder = RoleFinder.new
+      @allowed_fields = AllowedFields.new
+      
+      j2119_file.each_line do |line|
+        if line =~ ROOT
+          if have_root
+            fail "Only one root declaration"
+          else
+            @root = $1
+            @matcher = Matcher.new(root)
+            @assigner =
+              Assigner.new(@constraints, @finder, @matcher, @allowed_fields)
+            have_root = true
+          end
+        else
+          if !have_root
+            fail "Root declaration must come first"
+          else
+            proc_line(line)
+          end
+        end
+      end
+      if @failed
+        raise "Could not create parser"
+      end
+    end
+
+    def proc_line(line)
+      if @matcher.is_constraint_line(line)
+        @assigner.assign_constraints @matcher.build_constraint(line)
+      elsif @matcher.is_only_one_match_line(line)
+        @assigner.assign_only_one_of(@matcher.build_only_one(line))
+      elsif line =~ /^Each of a/
+        eaches_line = @matcher.eachof_match.match(line)
+        eaches = Oxford.break_role_list(@matcher, eaches_line['each_of'])
+        eaches.each do |each|
+          proc_line("A #{each} #{eaches_line['trailer']}")
+        end
+      elsif @matcher.is_role_def_line(line)
+        @assigner.assign_roles @matcher.build_role_def(line)
+      else
+        fail "Unrecognized line: #{line}"
+      end
+    end
+
+    def fail(message)
+      @failed = true
+      STDERR.puts message
+    end
+
+    def find_more_roles(node, roles)
+      @finder.find_more_roles(node, roles)
+    end
+
+    def find_grandchild_roles(roles, name)
+      @finder.find_grandchild_roles(roles, name)
+    end
+
+    def find_child_roles(roles, name)
+      @finder.find_child_roles(roles, name)
+    end
+
+    def get_constraints(role)
+      @constraints.get_constraints(role)
+    end
+
+    def field_allowed?(roles, child)
+      @allowed_fields.allowed?(roles, child)
+    end
+  end
+end

data/lib/j2119/role_constraints.rb

@@ -0,0 +1,32 @@
+# 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
+
+  # Just a hash to remember constraints
+  class RoleConstraints
+    def initialize
+      @constraints = {}
+    end
+    
+    def add(role, constraint)
+      @constraints[role] ||= []
+      @constraints[role] << constraint
+    end
+    
+    def get_constraints(role)
+      @constraints[role] || []
+    end
+  end
+
+end

data/lib/j2119/role_finder.rb

@@ -0,0 +1,143 @@
+# 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
+
+  # This is about figuring out which roles apply to a node and
+  #  potentially to its children in object and array valued fields
+  #
+  class RoleFinder
+
+    # for debugging
+    attr_reader :field_value_roles
+    
+    def initialize
+      # roles of the form: If an object with role X has field Y which
+      #  is an object, that object has role R
+      @child_roles = {}
+
+      # roles of the form: If an object with role X has field Y which
+      #  is an object/array, the object-files/array-elements have role R
+      @grandchild_roles = {}
+
+      # roles of the form: If an object with role X has a field Y with
+      #  value Z, it has role R
+      # map[role][field_name][field_val] => child_role
+      @field_value_roles = {}
+
+      # roles of the form: If an object with role X has a field Y, then
+      #  it has role R
+      # map[role][field_name] => child_role
+      @field_presence_roles = {}
+
+      # roles of the form: A Foo is a Bar
+      @is_a_roles = {}
+    end
+
+    def add_is_a_role(role, other_role)
+      @is_a_roles[role] ||= []
+      @is_a_roles[role] << other_role
+    end
+
+    def add_field_value_role(role, field_name, field_value, new_role)
+      @field_value_roles[role] ||= {}
+      @field_value_roles[role][field_name] ||= {}
+      field_value = Deduce.value(field_value)
+   
+      @field_value_roles[role][field_name][field_value] = new_role
+    end
+
+    def add_field_presence_role(role, field_name, new_role)
+      @field_presence_roles[role] ||= {}
+      @field_presence_roles[role][field_name] = new_role
+    end
+
+    def add_child_role(role, field_name, child_role)
+      @child_roles[role] ||= {}
+      @child_roles[role][field_name] = child_role
+    end
+
+    def add_grandchild_role(role, field_name, child_role)
+      @grandchild_roles[role] ||= {}
+      @grandchild_roles[role][field_name] = child_role
+    end
+
+    # Consider a node which has one or more roles. It may have more
+    #  roles based on the presence or value of child nodes. This method
+    #  addes any such roles to the "roles" list
+    #
+    def find_more_roles(node, roles)
+
+      # find roles depending on field values
+      roles.each do |role|
+        per_field_name = @field_value_roles[role]
+        if per_field_name
+          per_field_name.each do |field_name, value_roles|
+            value_roles.each do |field_value, child_role|
+              if field_value == node[field_name]
+                roles << child_role
+              end
+            end
+          end
+        end
+      end
+
+      # find roles depending on field presence
+      roles.each do |role|
+        per_field_name = @field_presence_roles[role]
+        if per_field_name
+          per_field_name.each do |field_name, child_role|
+            if node.key? field_name
+              roles << child_role
+            end
+          end
+        end
+      end
+
+      # is_a roles
+      roles.each do |role|
+        other_roles = @is_a_roles[role]
+        if other_roles
+          other_roles.each { |o| roles << o }
+        end
+      end
+    end
+
+    # A node has a role, and one of its fields might be object-valued
+    #  and that value is given a role
+    def find_child_roles(roles, field_name)
+      newroles = []
+      roles.each do |role|
+        if @child_roles[role] && @child_roles[role][field_name]
+          newroles << @child_roles[role][field_name]
+        end
+      end
+      newroles
+    end
+
+    # A node has a role, and one of its field is an object or an
+    #  array whose fields or elements are given a role
+    #
+    def find_grandchild_roles(roles, field_name)
+      newroles = []
+      roles.each do |role|
+        if @grandchild_roles[role] && @grandchild_roles[role][field_name]
+          newroles << @grandchild_roles[role][field_name]
+        end
+      end
+      newroles
+    end
+    
+  end
+
+end

data/lib/j2119.rb

@@ -0,0 +1,77 @@
+# 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.
+
+require 'json'
+$:.unshift("#{File.expand_path(File.dirname(__FILE__))}/../lib")
+require 'j2119/assigner'
+require 'j2119/conditional'
+require 'j2119/constraints'
+require 'j2119/deduce'
+require 'j2119/matcher'
+require 'j2119/node_validator'
+require 'j2119/oxford'
+require 'j2119/parser'
+require 'j2119/role_constraints'
+require 'j2119/role_finder'
+require 'j2119/allowed_fields'
+require 'j2119/json_path_checker'
+
+module J2119
+
+  class Validator
+
+    attr_reader :parsed
+    
+    def initialize assertions_source
+      assertions = File.open(assertions_source, "r")
+      @parser = Parser.new assertions
+    end
+
+    def root
+      @parser.root
+    end
+
+    def validate json_source
+      # already parsed?
+      if json_source.is_a?(Hash)
+        @parsed = json_source
+      else
+        if json_source.respond_to?(:read)
+          text = json_source.read
+        elsif File.readable? json_source
+          text = File.read json_source
+        else
+          text = json_source
+        end
+        begin
+          @parsed = JSON.parse text
+        rescue Exception => e
+          return [ "Problem reading/parsing JSON: #{e.to_s}" ]
+        end
+      end
+      
+      problems = []
+      validator = NodeValidator.new(@parser)
+      validator.validate_node(@parsed,
+                              @parser.root,
+                              [ @parser.root ],
+                              problems)
+      problems
+    end
+
+    def to_s
+      "J2119 validator for instances of \"#{@parser.root}\""
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: j2119
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Bray
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Validates JSON objects based on constraints in RFC2119-like language
+email: timbray@amazon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- NOTICE.txt
+- README.md
+- Rakefile
+- j2119.gemspec
+- lib/j2119.rb
+- lib/j2119/allowed_fields.rb
+- lib/j2119/assigner.rb
+- lib/j2119/conditional.rb
+- lib/j2119/constraints.rb
+- lib/j2119/deduce.rb
+- lib/j2119/json_path_checker.rb
+- lib/j2119/matcher.rb
+- lib/j2119/node_validator.rb
+- lib/j2119/oxford.rb
+- lib/j2119/parser.rb
+- lib/j2119/role_constraints.rb
+- lib/j2119/role_finder.rb
+homepage: http://rubygems.org/gems/j2119
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14.1
+signing_key: 
+specification_version: 4
+summary: JSON DSL Validator
+test_files: []