json-schema-diff 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1aea7e4fe80d247f0391631e587a149d622839d7b78b99443e334eea7c422df1
-  data.tar.gz: 4a9aeceeb2c7d356306cb237c03f8710eb4bd8291d010f583e2d1bb433110046
+  metadata.gz: 05eac26b2e1df57105bd4adddc22d72062db1450b442a393a3af227393ec47d6
+  data.tar.gz: 6accbbf59486d9ed5ee7b4a725dfb751e3d71038885eefddb5f12bf3071fb8e4
 SHA512:
-  metadata.gz: 86c942503b94f7ab01c896fabefa07e9def0701daabff6bf17725dbf9e148c49282293a95e52ebb06a9ee941905c767124134a38243533591bab35b1a59a06c0
-  data.tar.gz: 5ef4bbfcf3fc8957ec04800a8ea3ea3c3696553dec7f746050194ef6e241c8b55170cfbc87b0505c6238f0af4c5bccef205fe571b451d22cf9f27dcae0727e79
+  metadata.gz: 2bfaabdb040888fe7e908a7a52fdf66f6904b506df445c634ec5e14870799c0d80657c1dde023ecdb6d249286926627531152b5d7ef51efa0da6a38e23589f4d
+  data.tar.gz: 43356130be48c1566844f3af16a66bb4247ffc053073c3eacc51526949cceeb19fc9e2539df200f6dae5bc8be2d4a478254a47f87014273f464a0effcc644e49

data/CHANGELOG.md

@@ -7,6 +7,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.0] - 2025-01-26
+
+### Added
+
+- JSON Schema validation capabilities with `json-schema` gem dependency
+- New CLI options for validation control:
+  - `--[no-]validate` for JSON Schema format validation (enabled by default)
+  - `--[no-]validate-json` for JSON content validation against schema (disabled by default)
+- Comprehensive error handling for invalid schemas and JSON validation failures
+- Schema structure validation with clear error messages for malformed schemas
+- Type checking validation ensuring JSON data types match schema expectations
+- Required field validation for object schemas
+- Fallback validation approach for complex schemas with external references
+
+### Changed
+
+- Updated `json-schema` dependency to version ~> 5.0 for improved performance and compatibility
+- Removed `bigdecimal` dependency (no longer needed with json-schema v5)
+- Enhanced error messages with specific validation failure details
+
 ## [0.1.0] - 2025-01-26
 
 ### Added

data/README.md

@@ -60,6 +60,19 @@ json-schema-diff --format json schema.json old.json new.json
 json-schema-diff --no-color schema.json old.json new.json
 ```
 
+### Validation Options
+
+```bash
+# Enable JSON validation against schema (helps catch data format errors)
+json-schema-diff --validate-json schema.json old.json new.json
+
+# Disable schema format validation (for malformed schemas)
+json-schema-diff --no-validate schema.json old.json new.json
+
+# Both validation options
+json-schema-diff --validate-json --validate schema.json old.json new.json
+```
+
 ### Ignoring Fields
 
 ```bash
@@ -83,6 +96,8 @@ Options:
   -f, --format FORMAT          Output format (pretty, json)
   -i, --ignore-fields FIELDS   Comma-separated list of field paths to ignore
       --[no-]color             Enable/disable colored output (default: enabled)
+      --[no-]validate          Enable/disable JSON Schema format validation (default: enabled)
+      --[no-]validate-json     Enable/disable JSON validation against schema (default: disabled)
   -h, --help                   Show help message
   -v, --version                Show version
 ```

data/lib/json/schema/diff/cli.rb

@@ -20,12 +20,18 @@ module Json
           schema_file, old_file, new_file = args
 
           begin
-            schema = SchemaParser.new(schema_file)
+            schema = SchemaParser.new(schema_file, validate_schema: options[:validate])
             comparer = Comparer.new(schema, options[:ignore_fields] || [])
             
             old_json = JSON.parse(File.read(old_file))
             new_json = JSON.parse(File.read(new_file))
             
+            # Validate JSON files against schema if requested
+            if options[:validate_json]
+              schema.validate_json(old_json)
+              schema.validate_json(new_json)
+            end
+            
             diff_result = comparer.compare(old_json, new_json)
             
             formatter = Formatter.new(options[:format], options[:color])
@@ -48,7 +54,9 @@ module Json
           options = {
             format: "pretty",
             color: true,
-            ignore_fields: []
+            ignore_fields: [],
+            validate: true,
+            validate_json: false
           }
 
           parser = OptionParser.new do |opts|
@@ -77,6 +85,14 @@ module Json
               options[:color] = color
             end
 
+            opts.on("--[no-]validate", "Enable/disable JSON Schema format validation (default: enabled)") do |validate|
+              options[:validate] = validate
+            end
+
+            opts.on("--[no-]validate-json", "Enable/disable JSON validation against schema (default: disabled)") do |validate_json|
+              options[:validate_json] = validate_json
+            end
+
             opts.on("-h", "--help", "Show this help message") do
               puts opts
               exit 0

data/lib/json/schema/diff/schema_parser.rb

@@ -6,14 +6,42 @@ module Json
       class SchemaParser
         attr_reader :schema
 
-        def initialize(schema_file)
+        def initialize(schema_file, validate_schema: true)
           @schema = JSON.parse(File.read(schema_file))
+          
+          if validate_schema
+            validate_basic_schema_structure!
+          end
         rescue JSON::ParserError => e
           raise Error, "Invalid JSON schema: #{e.message}"
         rescue Errno::ENOENT => e
           raise Error, "Schema file not found: #{e.message}"
         end
 
+        def validate_json(json_data)
+          # Simple structural validation - check if JSON structure roughly matches schema expectations
+          begin
+            # Basic check - if schema has type "array", JSON should be array, etc.
+            if @schema["type"] == "array" && !json_data.is_a?(Array)
+              raise Error, "JSON validation failed: Expected array but got #{json_data.class.name.downcase}"
+            elsif @schema["type"] == "object" && !json_data.is_a?(Hash)
+              raise Error, "JSON validation failed: Expected object but got #{json_data.class.name.downcase}"
+            end
+            
+            # If we have required fields in schema, check they exist in JSON
+            if @schema["required"] && json_data.is_a?(Hash)
+              missing_fields = @schema["required"] - json_data.keys
+              unless missing_fields.empty?
+                raise Error, "JSON validation failed: Missing required fields: #{missing_fields.join(', ')}"
+              end
+            end
+            
+            true
+          rescue StandardError => e
+            raise Error, "JSON validation error: #{e.message}"
+          end
+        end
+
         def get_field_info(path)
           field_schema = traverse_schema(path.split('.'))
           return {} unless field_schema
@@ -49,6 +77,18 @@ module Json
 
         private
 
+        def validate_basic_schema_structure!
+          # Basic structural validation for schema
+          unless @schema.is_a?(Hash)
+            raise Error, "Schema must be a JSON object"
+          end
+          
+          # Check for basic schema structure
+          if @schema["type"].nil? && @schema["properties"].nil? && @schema["items"].nil?
+            raise Error, "Schema appears to be missing basic JSON Schema structure (no type, properties, or items)"
+          end
+        end
+
         def traverse_schema(path_parts)
           current = @schema
           

data/lib/json/schema/diff/version.rb

@@ -3,7 +3,7 @@
 module Json
   module Schema
     module Diff
-      VERSION = "0.1.0"
+      VERSION = "0.2.0"
     end
   end
 end

data/lib/json/schema/diff.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "json"
+require "json-schema"
 require "optparse"
 require_relative "diff/version"
 require_relative "diff/cli"

metadata

@@ -1,14 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: json-schema-diff
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Nesbitt
 bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description: A Ruby gem that performs semantic diffs between JSON files, using JSON
   Schema to guide and annotate the diff output with type information, field metadata,
   and structured change detection.