jsi 0.4.0 → 0.6.0

data/lib/jsi/schema/validation/const.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module JSI
+  module Schema::Validation::Const
+    # @private
+    def internal_validate_const(result_builder)
+      if schema_content.key?('const')
+        value = schema_content['const']
+        # The value of this keyword MAY be of any type, including null.
+        # An instance validates successfully against this keyword if its value is equal to the value of
+        # the keyword.
+        result_builder.validate(
+          result_builder.instance == value,
+          'instance is not equal to `const` value',
+          keyword: 'const',
+        )
+      end
+    end
+  end
+end

data/lib/jsi/schema/validation/contains.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module JSI
+  module Schema::Validation::Contains
+    # @private
+    def internal_validate_contains(result_builder)
+      if schema_content.key?('contains')
+        # An array instance is valid against "contains" if at least one of its elements is valid against
+        # the given schema.
+        if result_builder.instance.respond_to?(:to_ary)
+          results = {}
+          result_builder.instance.each_index do |i|
+            results[i] = result_builder.child_subschema_validate(['contains'], [i])
+          end
+          result_builder.validate(
+            results.values.any?(&:valid?),
+            'instance array does not contain any items valid against `contains` schema value',
+            keyword: 'contains',
+            results: results.values,
+          )
+        end
+      end
+    end
+  end
+end

data/lib/jsi/schema/validation/core.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module JSI
+  module Schema::Validation::Core
+    # validates the given instance against this schema
+    #
+    # @private
+    # @param instance_ptr [JSI::Ptr] a pointer to the instance to validate against the schema, in the instance_document
+    # @param instance_document [#to_hash, #to_ary, Object] document containing the instance instance_ptr pointer points to
+    # @param validate_only [Boolean] whether to return a full schema validation result or a simple, validation-only result
+    # @param visited_refs [Enumerable<JSI::Schema::Ref>]
+    # @return [JSI::Validation::Result]
+    def internal_validate_instance(instance_ptr, instance_document, validate_only: false, visited_refs: [])
+      if validate_only
+        result = JSI::Validation::VALID
+      else
+        result = JSI::Validation::FullResult.new
+      end
+      result_builder = result.builder(self, instance_ptr, instance_document, validate_only, visited_refs)
+
+      catch(:jsi_validation_result) do
+        # note: true/false are not valid as schemas in draft 4; they are only values of
+        # additionalProperties / additionalItems. since their behavior is undefined, though,
+        # it's fine for them to behave the same as boolean schemas in later drafts.
+        # I don't care about draft 4 to implement a different structuring for that.
+        if schema_content == true
+          # noop
+        elsif schema_content == false
+          result_builder.validate(false, 'instance is not valid against `false` schema')
+        elsif schema_content.respond_to?(:to_hash)
+          internal_validate_keywords(result_builder)
+        else
+          result_builder.schema_error('schema is not a boolean or a JSON object')
+        end
+        result
+      end.freeze
+    end
+  end
+end

data/lib/jsi/schema/validation/dependencies.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module JSI
+  module Schema::Validation::Dependencies
+    # @private
+    def internal_validate_dependencies(result_builder)
+      if schema_content.key?('dependencies')
+        value = schema_content['dependencies']
+        # This keyword's value MUST be an object. Each property specifies a dependency.  Each dependency
+        # value MUST be an array or a valid JSON Schema.
+        if value.respond_to?(:to_hash)
+          value.each_pair do |property_name, dependency|
+            if dependency.respond_to?(:to_ary)
+              # If the dependency value is an array, each element in the array, if
+              # any, MUST be a string, and MUST be unique.  If the dependency key is
+              # a property in the instance, each of the items in the dependency value
+              # must be a property that exists in the instance.
+              if result_builder.instance.respond_to?(:to_hash) && result_builder.instance.key?(property_name)
+                missing_required = dependency.reject { |name| result_builder.instance.key?(name) }
+                # TODO include property_name / missing dependent required property names in the validation error
+                result_builder.validate(
+                  missing_required.empty?,
+                  'instance object does not contain all dependent required property names specified by `dependencies` value',
+                  keyword: 'dependencies',
+                )
+              end
+            else
+              # If the dependency value is a subschema, and the dependency key is a
+              # property in the instance, the entire instance must validate against
+              # the dependency value.
+              if result_builder.instance.respond_to?(:to_hash) && result_builder.instance.key?(property_name)
+                dependency_result = result_builder.inplace_subschema_validate(['dependencies', property_name])
+                # TODO include property_name in the validation error
+                result_builder.validate(
+                  dependency_result.valid?,
+                  'instance object is not valid against the schema corresponding to a matched property name specified by `dependencies` value',
+                  keyword: 'dependencies',
+                  results: [dependency_result],
+                )
+              end
+            end
+          end
+        else
+          result_builder.schema_error('`dependencies` is not an object', 'dependencies')
+        end
+      end
+    end
+  end
+end

data/lib/jsi/schema/validation/draft04/minmax.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module JSI
+  module Schema::Validation::Draft04::MinMax
+    # @private
+    def internal_validate_maximum(result_builder)
+      if schema_content.key?('exclusiveMaximum')
+        value = schema_content['exclusiveMaximum']
+        # The value of "exclusiveMaximum" MUST be a boolean.
+        unless [true, false].include?(value)
+          result_builder.schema_error('`exclusiveMaximum` is not true or false', 'exclusiveMaximum')
+        end
+        if !schema_content.key?('maximum')
+          result_builder.schema_error('`exclusiveMaximum` has no effect without adjacent `maximum` keyword', 'exclusiveMaximum')
+        end
+      end
+
+      if schema_content.key?('maximum')
+        value = schema_content['maximum']
+        # The value of "maximum" MUST be a JSON number.
+        if value.is_a?(Numeric)
+          if result_builder.instance.is_a?(Numeric)
+            # Successful validation depends on the presence and value of "exclusiveMaximum":
+            if schema_content['exclusiveMaximum'] == true
+              # if "exclusiveMaximum" has boolean value true, the instance is valid if it is strictly lower
+              # than the value of "maximum".
+              result_builder.validate(
+                result_builder.instance < value,
+                'instance is not less than `maximum` value with `exclusiveMaximum` = true',
+                keyword: 'maximum',
+              )
+            else
+              # if "exclusiveMaximum" is not present, or has boolean value false, then the instance is
+              # valid if it is lower than, or equal to, the value of "maximum"
+              result_builder.validate(
+                result_builder.instance <= value,
+                'instance is not less than or equal to `maximum` value',
+                keyword: 'maximum',
+              )
+            end
+          end
+        else
+          result_builder.schema_error('`maximum` is not a number', 'maximum')
+        end
+      end
+    end
+
+    # @private
+    def internal_validate_minimum(result_builder)
+      if schema_content.key?('exclusiveMinimum')
+        value = schema_content['exclusiveMinimum']
+        # The value of "exclusiveMinimum" MUST be a boolean.
+        unless [true, false].include?(value)
+          result_builder.schema_error('`exclusiveMinimum` is not true or false', 'exclusiveMinimum')
+        end
+        if !schema_content.key?('minimum')
+          result_builder.schema_error('`exclusiveMinimum` has no effect without adjacent `minimum` keyword', 'exclusiveMinimum')
+        end
+      end
+
+      if schema_content.key?('minimum')
+        value = schema_content['minimum']
+        # The value of "minimum" MUST be a JSON number.
+        if value.is_a?(Numeric)
+          if result_builder.instance.is_a?(Numeric)
+            # Successful validation depends on the presence and value of "exclusiveMinimum":
+            if schema_content['exclusiveMinimum'] == true
+              # if "exclusiveMinimum" is present and has boolean value true, the instance is valid if it is
+              # strictly greater than the value of "minimum".
+              result_builder.validate(
+                result_builder.instance > value,
+                'instance is not greater than `minimum` value with `exclusiveMinimum` = true',
+                keyword: 'minimum',
+              )
+            else
+              # if "exclusiveMinimum" is not present, or has boolean value false, then the instance is
+              # valid if it is greater than, or equal to, the value of "minimum"
+              result_builder.validate(
+                result_builder.instance >= value,
+                'instance is not greater than or equal to `minimum` value',
+                keyword: 'minimum',
+              )
+            end
+          end
+        else
+          result_builder.schema_error('`minimum` is not a number', 'minimum')
+        end
+      end
+    end
+  end
+end

data/lib/jsi/schema/validation/draft04.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module JSI
+  module Schema::Validation::Draft04
+    autoload :MinMax, 'jsi/schema/validation/draft04/minmax'
+
+    include Schema::Validation::Core
+
+    include Schema::Validation::Ref
+
+    include Schema::Validation::MultipleOf
+    include Schema::Validation::Draft04::MinMax
+
+    include Schema::Validation::StringLength
+    include Schema::Validation::Pattern
+
+    include Schema::Validation::Items
+    include Schema::Validation::ArrayLength
+    include Schema::Validation::UniqueItems
+
+    include Schema::Validation::MinMaxProperties
+    include Schema::Validation::Required
+    include Schema::Validation::Properties
+    include Schema::Validation::Dependencies
+
+    include Schema::Validation::Enum
+    include Schema::Validation::Type
+
+    include Schema::Validation::AllOf
+    include Schema::Validation::AnyOf
+    include Schema::Validation::OneOf
+    include Schema::Validation::Not
+
+    # @private
+    def internal_validate_keywords(result_builder)
+      internal_validate_ref(result_builder, throw_result: true)
+
+      # 5.1.  Validation keywords for numeric instances (number and integer)
+
+      # 5.1.1.  multipleOf
+      internal_validate_multipleOf(result_builder)
+
+      # 5.1.2.  maximum and exclusiveMaximum
+      internal_validate_maximum(result_builder)
+
+      # 5.1.3.  minimum and exclusiveMinimum
+      internal_validate_minimum(result_builder)
+
+      # 5.2.  Validation keywords for strings
+
+      # 5.2.1.  maxLength
+      internal_validate_maxLength(result_builder)
+
+      # 5.2.2.  minLength
+      internal_validate_minLength(result_builder)
+
+      # 5.2.3.  pattern
+      internal_validate_pattern(result_builder)
+
+      # 5.3.  Validation keywords for arrays
+
+      # 5.3.1.  additionalItems and items
+      internal_validate_items(result_builder)
+
+      # 5.3.2.  maxItems
+      internal_validate_maxItems(result_builder)
+
+      # 5.3.3.  minItems
+      internal_validate_minItems(result_builder)
+
+      # 5.3.4.  uniqueItems
+      internal_validate_uniqueItems(result_builder)
+
+      # 5.4.  Validation keywords for objects
+
+      # 5.4.1.  maxProperties
+      internal_validate_maxProperties(result_builder)
+
+      # 5.4.2.  minProperties
+      internal_validate_minProperties(result_builder)
+
+      # 5.4.3.  required
+      internal_validate_required(result_builder)
+
+      # 5.4.4.  additionalProperties, properties and patternProperties
+      internal_validate_properties(result_builder)
+
+      # 5.4.5.  dependencies
+      internal_validate_dependencies(result_builder)
+
+      # 5.5.  Validation keywords for any instance type
+
+      # 5.5.1.  enum
+      internal_validate_enum(result_builder)
+
+      # 5.5.2.  type
+      internal_validate_type(result_builder)
+
+      # 5.5.3.  allOf
+      internal_validate_allOf(result_builder)
+
+      # 5.5.4.  anyOf
+      internal_validate_anyOf(result_builder)
+
+      # 5.5.5.  oneOf
+      internal_validate_oneOf(result_builder)
+
+      # 5.5.6.  not
+      internal_validate_not(result_builder)
+    end
+  end
+end

data/lib/jsi/schema/validation/draft06.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module JSI
+  module Schema::Validation::Draft06
+    include Schema::Validation::Core
+
+    include Schema::Validation::Ref
+    include Schema::Validation::AllOf
+    include Schema::Validation::AnyOf
+    include Schema::Validation::OneOf
+    include Schema::Validation::Not
+
+    include Schema::Validation::Items
+    include Schema::Validation::Contains
+    include Schema::Validation::Properties
+
+    include Schema::Validation::MultipleOf
+    include Schema::Validation::MinMax
+
+    include Schema::Validation::StringLength
+
+    include Schema::Validation::Pattern
+
+    include Schema::Validation::ArrayLength
+    include Schema::Validation::UniqueItems
+
+    include Schema::Validation::MinMaxProperties
+    include Schema::Validation::Required
+    include Schema::Validation::Dependencies
+    include Schema::Validation::PropertyNames
+
+    include Schema::Validation::Const
+    include Schema::Validation::Enum
+
+    include Schema::Validation::Type
+
+    # @private
+    def internal_validate_keywords(result_builder)
+      # json-schema 8.  Schema references with $ref
+      internal_validate_ref(result_builder, throw_result: true)
+
+      # json-schema-validation 6.1.  multipleOf
+      internal_validate_multipleOf(result_builder)
+
+      # json-schema-validation 6.2.  maximum
+      internal_validate_maximum(result_builder)
+
+      # json-schema-validation 6.3.  exclusiveMaximum
+      internal_validate_exclusiveMaximum(result_builder)
+
+      # json-schema-validation 6.4.  minimum
+      internal_validate_minimum(result_builder)
+
+      # json-schema-validation 6.5.  exclusiveMinimum
+      internal_validate_exclusiveMinimum(result_builder)
+
+      # json-schema-validation 6.6.  maxLength
+      internal_validate_maxLength(result_builder)
+
+      # json-schema-validation 6.7.  minLength
+      internal_validate_minLength(result_builder)
+
+      # json-schema-validation 6.8.  pattern
+      internal_validate_pattern(result_builder)
+
+      # json-schema-validation 6.9.  items
+      # json-schema-validation 6.10.  additionalItems
+      internal_validate_items(result_builder)
+
+      # json-schema-validation 6.11.  maxItems
+      internal_validate_maxItems(result_builder)
+
+      # json-schema-validation 6.12.  minItems
+      internal_validate_minItems(result_builder)
+
+      # json-schema-validation 6.13.  uniqueItems
+      internal_validate_uniqueItems(result_builder)
+
+      # json-schema-validation 6.14.  contains
+      internal_validate_contains(result_builder)
+
+      # json-schema-validation 6.15.  maxProperties
+      internal_validate_maxProperties(result_builder)
+
+      # json-schema-validation 6.16.  minProperties
+      internal_validate_minProperties(result_builder)
+
+      # json-schema-validation 6.17.  required
+      internal_validate_required(result_builder)
+
+      # json-schema-validation 6.18.  properties
+      # json-schema-validation 6.19.  patternProperties
+      # json-schema-validation 6.20.  additionalProperties
+      internal_validate_properties(result_builder)
+
+      # json-schema-validation 6.21.  dependencies
+      internal_validate_dependencies(result_builder)
+
+      # json-schema-validation 6.22.  propertyNames
+      internal_validate_propertyNames(result_builder)
+
+      # json-schema-validation 6.23.  enum
+      internal_validate_enum(result_builder)
+
+      # json-schema-validation 6.24.  const
+      internal_validate_const(result_builder)
+
+      # json-schema-validation 6.25.  type
+      internal_validate_type(result_builder)
+
+      # json-schema-validation 6.26.  allOf
+      internal_validate_allOf(result_builder)
+      # json-schema-validation 6.27.  anyOf
+      internal_validate_anyOf(result_builder)
+      # json-schema-validation 6.28.  oneOf
+      internal_validate_oneOf(result_builder)
+
+      # json-schema-validation 6.29.  not
+      internal_validate_not(result_builder)
+    end
+  end
+end

data/lib/jsi/schema/validation/draft07.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+module JSI
+  module Schema::Validation::Draft07
+    include Schema::Validation::Core
+
+    include Schema::Validation::Ref
+
+    include Schema::Validation::Type
+    include Schema::Validation::Enum
+    include Schema::Validation::Const
+
+    include Schema::Validation::MultipleOf
+    include Schema::Validation::MinMax
+
+    include Schema::Validation::StringLength
+    include Schema::Validation::Pattern
+
+    include Schema::Validation::Items
+    include Schema::Validation::ArrayLength
+    include Schema::Validation::UniqueItems
+    include Schema::Validation::Contains
+
+    include Schema::Validation::MinMaxProperties
+    include Schema::Validation::Required
+
+    include Schema::Validation::Properties
+    include Schema::Validation::Dependencies
+    include Schema::Validation::PropertyNames
+
+    include Schema::Validation::IfThenElse
+    include Schema::Validation::AllOf
+    include Schema::Validation::AnyOf
+    include Schema::Validation::OneOf
+    include Schema::Validation::Not
+
+    # @private
+    def internal_validate_keywords(result_builder)
+      internal_validate_ref(result_builder, throw_result: true)
+
+      # 6.1.  Validation Keywords for Any Instance Type
+
+      # 6.1.1.  type
+      internal_validate_type(result_builder)
+
+      # 6.1.2.  enum
+      internal_validate_enum(result_builder)
+
+      # 6.1.3.  const
+      internal_validate_const(result_builder)
+
+      # 6.2.  Validation Keywords for Numeric Instances (number and integer)
+
+      # 6.2.1.  multipleOf
+      internal_validate_multipleOf(result_builder)
+
+      # 6.2.2.  maximum
+      internal_validate_maximum(result_builder)
+
+      # 6.2.3.  exclusiveMaximum
+      internal_validate_exclusiveMaximum(result_builder)
+
+      # 6.2.4.  minimum
+      internal_validate_minimum(result_builder)
+
+      # 6.2.5.  exclusiveMinimum
+      internal_validate_exclusiveMinimum(result_builder)
+
+      # 6.3.  Validation Keywords for Strings
+
+      # 6.3.1.  maxLength
+      internal_validate_maxLength(result_builder)
+
+      # 6.3.2.  minLength
+      internal_validate_minLength(result_builder)
+
+      # 6.3.3.  pattern
+      internal_validate_pattern(result_builder)
+
+      # 6.4.  Validation Keywords for Arrays
+
+      # 6.4.1.  items
+      # 6.4.2.  additionalItems
+      internal_validate_items(result_builder)
+
+      # 6.4.3.  maxItems
+      internal_validate_maxItems(result_builder)
+
+      # 6.4.4.  minItems
+      internal_validate_minItems(result_builder)
+
+      # 6.4.5.  uniqueItems
+      internal_validate_uniqueItems(result_builder)
+
+      # 6.4.6.  contains
+      internal_validate_contains(result_builder)
+
+      # 6.5.  Validation Keywords for Objects
+
+      # 6.5.1.  maxProperties
+      internal_validate_maxProperties(result_builder)
+
+      # 6.5.2.  minProperties
+      internal_validate_minProperties(result_builder)
+
+      # 6.5.3.  required
+      internal_validate_required(result_builder)
+
+      # 6.5.4.  properties
+      # 6.5.5.  patternProperties
+      # 6.5.6.  additionalProperties
+      internal_validate_properties(result_builder)
+
+      # 6.5.7.  dependencies
+      internal_validate_dependencies(result_builder)
+
+      # 6.5.8.  propertyNames
+      internal_validate_propertyNames(result_builder)
+
+      # 6.6.  Keywords for Applying Subschemas Conditionally
+
+      # 6.6.1.  if
+      # 6.6.2.  then
+      # 6.6.3.  else
+      internal_validate_ifthenelse(result_builder)
+
+      # 6.7.  Keywords for Applying Subschemas With Boolean Logic
+
+      # 6.7.1.  allOf
+      internal_validate_allOf(result_builder)
+
+      # 6.7.2.  anyOf
+      internal_validate_anyOf(result_builder)
+
+      # 6.7.3.  oneOf
+      internal_validate_oneOf(result_builder)
+
+      # 6.7.4.  not
+      internal_validate_not(result_builder)
+
+      # 7.  Semantic Validation With "format"
+      # TODO
+
+      # 10.  Schema Annotations
+
+      # 10.1.  "title" and "description"
+      # TODO
+
+      # 10.2.  "default"
+      # TODO
+
+      # 10.3.  "readOnly" and "writeOnly"
+      # TODO
+
+      # 10.4.  "examples"
+      # TODO
+    end
+  end
+end

data/lib/jsi/schema/validation/enum.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module JSI
+  module Schema::Validation::Enum
+    # @private
+    def internal_validate_enum(result_builder)
+      if schema_content.key?('enum')
+        value = schema_content['enum']
+        # The value of this keyword MUST be an array. This array SHOULD have at least one element.
+        # Elements in the array SHOULD be unique.
+        if value.respond_to?(:to_ary)
+          # An instance validates successfully against this keyword if its value is equal to one of the
+          # elements in this keyword's array value.
+          result_builder.validate(
+            value.include?(result_builder.instance),
+            'instance is not equal to any `enum` value',
+            keyword: 'enum',
+          )
+        else
+          result_builder.schema_error('`enum` is not an array', 'enum')
+        end
+      end
+    end
+  end
+end

data/lib/jsi/schema/validation/ifthenelse.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module JSI
+  module Schema::Validation::IfThenElse
+    # @private
+    def internal_validate_ifthenelse(result_builder)
+      if schema_content.key?('if')
+        # This keyword's value MUST be a valid JSON Schema.
+        # This validation outcome of this keyword's subschema has no direct effect on the overall validation
+        # result. Rather, it controls which of the "then" or "else" keywords are evaluated.
+        if_result = result_builder.inplace_subschema_validate(['if'])
+
+        result_builder.merge_schema_issues(if_result)
+
+        if if_result.valid?
+          if schema_content.key?('then')
+            then_result = result_builder.inplace_subschema_validate(['then'])
+            result_builder.validate(
+              then_result.valid?,
+              'instance did not validate against the schema defined by `then` value after validating against the schema defined by the `if` value',
+              keyword: 'if',
+              results: [then_result],
+            )
+          end
+        else
+          if schema_content.key?('else')
+            else_result = result_builder.inplace_subschema_validate(['else'])
+            result_builder.validate(
+              else_result.valid?,
+              'instance did not validate against the schema defined by `else` value after not validating against the schema defined by the `if` value',
+              keyword: 'if',
+              results: [else_result],
+            )
+          end
+        end
+      else
+        if schema_content.key?('then')
+          result_builder.schema_warning('`then` has no effect without adjacent `if` keyword', 'then')
+        end
+        if schema_content.key?('else')
+          result_builder.schema_warning('`else` has no effect without adjacent `if` keyword', 'else')
+        end
+      end
+    end
+  end
+end