json-ld-validate 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94bf8b975edaeefd4bb0226ca8994c7ff06a1a45339567ddba1fca5bccd6eea0
-  data.tar.gz: 23292145af308aeeb80585e061c8576517bdaa505337fac5a185a3d4e22118de
+  metadata.gz: 24f7e49ba2ad97d5ec2c2746ac541e17167eea91a9c618a364e3c866e979500a
+  data.tar.gz: 31a0660a604c9713e91648086fe6945078df30cba88da859eb00a579b6fc6589
 SHA512:
-  metadata.gz: ae77e588fc9a057f83e92d3697bee755fadeb8f48f5b8fc3847f74aad10393699f46c45463364ad7ef5ad4eafc459cb8896d9e2fb5624a48a91eb8a7974b95b3
-  data.tar.gz: 32465d54a3d390ca5d2efe06d1d24711edc9ed47fa891ae033f4747bbb23e33d897d13cf68510d8357824ad0e0987dfde3ebba235285846ceba0ab4b24f0e642
+  metadata.gz: 006dc0932bce4be731d5078afbf4d98bee88b2b63af946bbfd3e3614cc956baa09e163810b23a1cb16aecbf5aeedb6d405c82354f3e7949a02d080131c8b7c9f
+  data.tar.gz: 5ceaccc40e461010b5037ebf713f6df68f7d9a3028a3c749db7bd979a23ad9edcd434eb1f12ea9b691882b2c0a6e2c30ed2b1829dfc534baa2e5a1e4900194be

data/lib/jsonld_validate/matchers/be_valid_json_ld.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'json/ld'
-
 module JsonldValidate
   module Matchers
     class BeValidJsonLd

data/lib/jsonld_validate/validator.rb

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
+require 'json/ld'
+require_relative 'xsd_type_validator'
+
 module JsonldValidate
   class Validator
-    attr_accessor :content, :errors
+    include XsdTypeValidator
+
+    attr_reader :content, :errors
 
     def initialize(content)
       @content = content
@@ -10,30 +15,119 @@ module JsonldValidate
     end
 
     def valid?
+      @errors = []
       return false if content.nil?
       return true if content.empty?
 
-      doc
-      return false unless errors.empty?
-
-      validates_no_unknown_field
-
+      validate_document
       errors.empty?
     end
 
     private
 
-    def doc
-      @doc ||= JSON::LD::API.compact(JSON::LD::API.expand(content), content['@context'])
+    attr_reader :doc, :expanded_doc
+
+    def validate_document
+      if content.is_a?(Array)
+        validate_array_items
+        return
+      end
+
+      return if hash_missing_context? && (@errors << 'missing @context')
+
+      build_expanded_doc
+      build_doc
+      return unless errors.empty?
+
+      validate_typed_values
+      find_unknown_fields(content, doc, [])
+    end
+
+    def validate_array_items
+      content.each_with_index do |item, i|
+        item_validator = self.class.new(item)
+        next if item_validator.valid?
+
+        if item_validator.errors.empty?
+          @errors << "#{i}: invalid document"
+        else
+          item_validator.errors.each { |e| @errors << "#{i}.#{e}" }
+        end
+      end
+    end
+
+    def hash_missing_context?
+      content.is_a?(Hash) && (!content.key?('@context') || content['@context'].nil?)
+    end
+
+    def build_doc
+      return if expanded_doc.nil?
+
+      @doc = JSON::LD::API.compact(expanded_doc, content['@context'])
+    end
+
+    def build_expanded_doc
+      @expanded_doc = clean_expanded_doc(JSON::LD::API.expand(content))
     rescue JSON::LD::JsonLdError::LoadingDocumentFailed
       @errors << 'failed loading document'
+    rescue JSON::LD::JsonLdError => e
+      @errors << e.to_s
+    end
+
+    def find_unknown_fields(original, compacted, path)
+      return unless original.is_a?(Hash)
+      return report_all_fields(original, path) unless compacted.is_a?(Hash)
+
+      report_unknown_keys(original, compacted, path)
+      recurse_known_keys(original, compacted, path)
     end
 
-    def validates_no_unknown_field
-      return if doc.keys.length == content.keys.length
+    def report_all_fields(original, path)
+      original.each_key do |key|
+        next if key.start_with?('@')
+
+        errors << "found unknown field: #{(path + [key]).join('.')}"
+      end
+    end
+
+    def report_unknown_keys(original, compacted, path)
+      (original.keys - compacted.keys).each do |field|
+        errors << "found unknown field: #{(path + [field]).join('.')}"
+      end
+    end
+
+    def recurse_known_keys(original, compacted, path)
+      (original.keys & compacted.keys).each do |key|
+        next if key.start_with?('@')
+
+        recurse_field(original[key], compacted[key], path + [key])
+      end
+    end
+
+    def recurse_field(orig_val, comp_val, path)
+      if orig_val.is_a?(Array)
+        comp_val = [] unless comp_val.is_a?(Array)
+        orig_val.each_with_index do |item, i|
+          find_unknown_fields(item, comp_val[i], path + [i.to_s])
+        end
+      elsif orig_val.is_a?(Hash)
+        find_unknown_fields(orig_val, comp_val, path)
+      elsif orig_val != comp_val
+        @errors << "invalid value at #{path.join('.')}: #{orig_val.inspect}"
+      end
+    end
 
-      unknown_fields = content.keys - doc.keys
-      errors << "found unknown fields: #{unknown_fields.join(', ')}"
+    def clean_expanded_doc(obj)
+      case obj
+      when Array
+        obj.map { |item| clean_expanded_doc(item) }
+      when Hash
+        obj.each_with_object({}) do |(k, v), h|
+          h[k] = clean_expanded_doc(v) unless k.start_with?('_:')
+        end
+      else
+        obj
+      end
     end
   end
 end

data/lib/jsonld_validate/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JsonldValidate
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

data/lib/jsonld_validate/xsd_type_validator.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module JsonldValidate
+  module XsdTypeValidator
+    XSD = 'http://www.w3.org/2001/XMLSchema#'
+
+    INTEGER_TYPES = %w[
+      integer int long short byte
+      unsignedInt unsignedLong unsignedShort unsignedByte
+      nonNegativeInteger positiveInteger nonPositiveInteger negativeInteger
+    ].to_set { |t| "#{XSD}#{t}" }.freeze
+
+    DECIMAL_TYPES = %w[decimal double float].to_set { |t| "#{XSD}#{t}" }.freeze
+
+    BOOLEAN_TYPE = "#{XSD}boolean".freeze
+
+    def validate_typed_values
+      return unless expanded_doc
+
+      iri_to_term, vocab = build_iri_map
+      expanded_doc.each { |node| check_node_types(node, iri_to_term, vocab, []) }
+    end
+
+    def build_iri_map
+      ctx = JSON::LD::Context.parse(content['@context'])
+      map = ctx.term_definitions.each_with_object({}) do |(term, defn), h|
+        h[defn.id] = term if defn.id
+      end
+      [map, ctx.vocab]
+    rescue StandardError
+      [{}, nil]
+    end
+
+    def check_node_types(node, iri_to_term, vocab, path)
+      return unless node.is_a?(Hash)
+
+      node.each do |iri, values|
+        next if iri.start_with?('@')
+
+        term = compact_term(iri, iri_to_term, vocab)
+        Array(values).each_with_index do |value, i|
+          child_path = Array(values).length > 1 ? path + [term, i.to_s] : path + [term]
+          check_typed_value(value, child_path, iri_to_term, vocab)
+        end
+      end
+    end
+
+    def check_typed_value(value, path, iri_to_term, vocab)
+      return unless value.is_a?(Hash)
+
+      if value.key?('@value') && value.key?('@type')
+        report_type_mismatch(value['@value'], value['@type'], path)
+      else
+        check_node_types(value, iri_to_term, vocab, path)
+      end
+    end
+
+    def report_type_mismatch(val, type_iri, path)
+      return if valid_xsd_value?(val, type_iri)
+
+      @errors << "invalid type for #{path.join('.')}: #{val.inspect}"
+    end
+
+    def valid_xsd_value?(val, type_iri)
+      if INTEGER_TYPES.include?(type_iri)
+        val.is_a?(Integer)
+      elsif DECIMAL_TYPES.include?(type_iri)
+        val.is_a?(Numeric)
+      elsif type_iri == BOOLEAN_TYPE
+        [true, false].include?(val)
+      else
+        true
+      end
+    end
+
+    def compact_term(iri, iri_to_term, vocab)
+      return iri_to_term[iri] if iri_to_term.key?(iri)
+      return iri.delete_prefix(vocab) if vocab && iri.start_with?(vocab)
+
+      iri
+    end
+  end
+end

data/lib/jsonld_validate.rb

@@ -4,5 +4,4 @@ module JsonldValidate
 end
 
 require 'jsonld_validate/validator'
-require 'jsonld_validate/matchers'
 require 'jsonld_validate/version'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json-ld-validate
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Damien MATHIEU
@@ -23,20 +23,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rspec-core
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 description: JSON-LD documents validation
 email:
 - 42@dmathieu.com
@@ -51,6 +37,7 @@ files:
 - lib/jsonld_validate/matchers/be_valid_json_ld.rb
 - lib/jsonld_validate/validator.rb
 - lib/jsonld_validate/version.rb
+- lib/jsonld_validate/xsd_type_validator.rb
 homepage: https://codeberg.org/dmathieu/json-ld-validate
 licenses:
 - AGPL
@@ -70,7 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: JSON-LD documents validation
 test_files: []