metadata-json-lint 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29e4b11eb67ac424ce447445c58a2f2d1cc401dd38512403e444b9d05dd7eec7
-  data.tar.gz: 6c5e706887327a973a8a65d36a9ca00d1fc5b3ca1a4fa65526a5faa86df42671
+  metadata.gz: c467d226e16135a5214b501c5f8a0add829bdb412e9281d1852e4a1e8cc8c69f
+  data.tar.gz: 712cd43498297e11ea9b0762174ef5cbafd1fa119b3284f530f7e76256a9de2f
 SHA512:
-  metadata.gz: b7899527b37037203171485090dc06297ea793ba4f9b0f3d5090bbfca1a375e1a159656250b6dff1359d24637e6a013b38ab8317674941399cc7f7a13e6f006b
-  data.tar.gz: e2c1d1dac6a9bef4c8c99decc1e7aee33633a5dfd1e48440954a255abaf655f3e27c476ec77c6c7a903dc62b2a97a80b19a5310932a0403b5772b8db914b530e
+  metadata.gz: 4483c4829b41974bfd0465df70bf7926d9177a85111e7af15e0dcf3b0bc0b144d5ae9a000f12712dd3332f3bd7a09c4112b98e7b2a3f518f3691abdff764614b
+  data.tar.gz: 44413f5005605132685f8a8d3d4f3188e984606a3399fbee7367a8fb904d820746f01f0cdcf2d303e4007d2f90bbcd7d1ef614e6c13de9cdea2a2e0f2bcb63f9

data/.github/workflows/release.yml

@@ -15,7 +15,7 @@ jobs:
     name: Build the gem
     runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v7
       - name: Install Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -24,7 +24,7 @@ jobs:
         shell: bash
         run: gem build --verbose *.gemspec
       - name: Upload gem to GitHub cache
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v7
         with:
           name: gem-artifact
           path: '*.gem'
@@ -39,7 +39,7 @@ jobs:
       contents: write # clone repo and create release
     steps:
       - name: Download gem from GitHub cache
-        uses: actions/download-artifact@v5
+        uses: actions/download-artifact@v8
         with:
           name: gem-artifact
       - name: Create Release
@@ -56,7 +56,7 @@ jobs:
       packages: write # publish to rubygems.pkg.github.com
     steps:
       - name: Download gem from GitHub cache
-        uses: actions/download-artifact@v5
+        uses: actions/download-artifact@v8
         with:
           name: gem-artifact
       - name: Publish gem to GitHub packages
@@ -73,10 +73,10 @@ jobs:
       id-token: write # rubygems.org authentication
     steps:
       - name: Download gem from GitHub cache
-        uses: actions/download-artifact@v5
+        uses: actions/download-artifact@v8
         with:
           name: gem-artifact
-      - uses: rubygems/configure-rubygems-credentials@v1.0.0
+      - uses: rubygems/configure-rubygems-credentials@v2.1.0
       - name: Publish gem to rubygems.org
         shell: bash
         run: gem push *.gem
@@ -92,7 +92,7 @@ jobs:
       - release-to-rubygems
     steps:
       - name: Download gem from GitHub cache
-        uses: actions/download-artifact@v5
+        uses: actions/download-artifact@v8
         with:
           name: gem-artifact
       - name: Install Ruby

data/.github/workflows/test.yml

@@ -16,7 +16,7 @@ jobs:
     outputs:
       ruby: ${{ steps.ruby.outputs.versions }}
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v7
       - name: Install Ruby 3.4
         uses: ruby/setup-ruby@v1
         with:
@@ -25,7 +25,7 @@ jobs:
       - name: Run RuboCop
         run: bundle exec rake rubocop
       - id: ruby
-        uses: voxpupuli/ruby-version@v1
+        uses: voxpupuli/ruby-version@v2
 
   test:
     name: "Ruby ${{ matrix.ruby }}"
@@ -36,7 +36,7 @@ jobs:
       matrix:
         ruby: ${{ fromJSON(needs.rubocop_and_matrix.outputs.ruby) }}
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v7
       - name: Setup ruby
         uses: ruby/setup-ruby@v1
         with:

data/.rubocop.yml

@@ -3,6 +3,3 @@ inherit_from: .rubocop_todo.yml
 
 inherit_gem:
   voxpupuli-rubocop: rubocop.yml
-
-AllCops:
-  TargetRubyVersion: 3.2

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [5.1.0](https://github.com/voxpupuli/metadata-json-lint/tree/5.1.0) (2026-08-13)
+
+[Full Changelog](https://github.com/voxpupuli/metadata-json-lint/compare/5.0.0...5.1.0)
+
+**Implemented enhancements:**
+
+- Disable multi\_json deprecation warning [\#186](https://github.com/voxpupuli/metadata-json-lint/pull/186) ([bastelfreak](https://github.com/bastelfreak))
+- Parse whole file and print all errors [\#177](https://github.com/voxpupuli/metadata-json-lint/pull/177) ([bwitt](https://github.com/bwitt))
+- Add Ruby 4.0 support [\#176](https://github.com/voxpupuli/metadata-json-lint/pull/176) ([dependabot[bot]](https://github.com/apps/dependabot))
+
+**Closed issues:**
+
+- Post install message [\#90](https://github.com/voxpupuli/metadata-json-lint/issues/90)
+
 ## [5.0.0](https://github.com/voxpupuli/metadata-json-lint/tree/5.0.0) (2025-08-12)
 
 [Full Changelog](https://github.com/voxpupuli/metadata-json-lint/compare/4.3.0...5.0.0)

data/Gemfile

@@ -4,5 +4,5 @@ gemspec
 
 group :release, optional: true do
   gem 'faraday-retry', '~> 2.1', require: false
-  gem 'github_changelog_generator', '~> 1.16.4', require: false
+  gem 'github_changelog_generator', '~> 1.18.0', require: false
 end

data/lib/metadata-json-lint/schema.rb

@@ -121,6 +121,7 @@ module MetadataJsonLint
     end
 
     def validate(data, options = {})
+      JSON::Validator.use_multi_json = false
       JSON::Validator.register_format_validator('semver', method(:semver_validator))
 
       JSON::Validator.fully_validate(schema, data, options.merge(errors_as_objects: true)).map do |error|

data/lib/metadata_json_lint.rb

@@ -90,26 +90,56 @@ module MetadataJsonLint
     options = options().clone
     # Configuration from rake tasks
     yield options if block_given?
+
+    validate_metadata(metadata, options) do |level, check, message|
+      send(level, check, message)
+    end
+
+    if !@errors.empty? || !@warnings.empty?
+      result = @errors.empty? ? "Warnings found in #{metadata}" : "Errors found in #{metadata}"
+
+      case options[:format]
+      when :json
+        puts JSON.fast_generate(result: result, warnings: @warnings, errors: @errors)
+      else
+        @warnings.each { |warn| puts "(WARN) #{warn}" }
+        @errors.each { |err| puts "(ERROR) #{err}" }
+        puts result
+      end
+
+      return false if !@errors.empty? || (!@warnings.empty? && (options[:fail_on_warnings] == true))
+    end
+
+    true
+  end
+  module_function :parse
+
+  def validate_metadata(metadata, options)
     begin
       f = File.read(metadata)
-    rescue Exception => e
-      abort("Error: Unable to read metadata file: #{e.exception}")
+    rescue StandardError => e
+      yield :error, :file, "Unable to read metadata file: #{e.message.split(' @ ').first}"
+      return
     end
 
-    abort('Error: metadata.json does not have a valid newline at the end') if misses_newline_at_end?(f)
+    yield :error, :file, 'metadata.json does not have a valid newline at the end' if misses_newline_at_end?(f)
 
-    abort('Error: Unable to parse metadata.json: Invalid escape character in string') if contains_invalid_escape?(f)
+    if contains_invalid_escape?(f)
+      yield :error, :file, 'Unable to parse metadata.json: Invalid escape character in string'
+      return
+    end
 
     begin
       parsed = JSON.parse(f)
-    rescue Exception => e
-      abort("Error: Unable to parse metadata.json: #{e.exception}")
+    rescue JSON::ParserError => e
+      yield :error, :file, "Unable to parse metadata.json: #{e.message}"
+      return
     end
 
     # Validate basic structure against JSON schema
     schema_errors = Schema.new.validate(parsed)
     schema_errors.each do |err|
-      error ((err[:field] == 'root') ? :required_fields : err[:field]), err[:message]
+      yield :error, ((err[:field] == 'root') ? :required_fields : err[:field]), err[:message]
     end
 
     validate_dependencies!(parsed['dependencies']) if parsed['dependencies']
@@ -118,7 +148,7 @@ module MetadataJsonLint
     # From: https://docs.puppetlabs.com/puppet/latest/reference/modules_publishing.html#write-a-metadatajson-file
     deprecated_fields = %w[types checksum]
     deprecated_fields.each do |field|
-      error :deprecated_fields, "Deprecated field '#{field}' found in metadata.json." unless parsed[field].nil?
+      yield :error, :deprecated_fields, "Deprecated field '#{field}' found in metadata.json." unless parsed[field].nil?
     end
 
     # The nested 'requirements' name of 'pe' is deprecated as well.
@@ -128,29 +158,12 @@ module MetadataJsonLint
     # Shoulds/recommendations
     # From: https://docs.puppetlabs.com/puppet/latest/reference/modules_publishing.html#write-a-metadatajson-file
     #
-    if options[:strict_license] && !parsed['license'].nil? && !SpdxLicenses.exist?(parsed['license']) && parsed['license'] != 'proprietary'
-      msg = "License identifier #{parsed['license']} is not in the SPDX list: http://spdx.org/licenses/"
-      warn(:license, msg)
-    end
-
-    if !@errors.empty? || !@warnings.empty?
-      result = @errors.empty? ? "Warnings found in #{metadata}" : "Errors found in #{metadata}"
-
-      case options[:format]
-      when :json
-        puts JSON.fast_generate(result: result, warnings: @warnings, errors: @errors)
-      else
-        @warnings.each { |warn| puts "(WARN) #{warn}" }
-        @errors.each { |err| puts "(ERROR) #{err}" }
-        puts result
-      end
+    return unless options[:strict_license] && !parsed['license'].nil? && !SpdxLicenses.exist?(parsed['license']) && parsed['license'] != 'proprietary'
 
-      return false if !@errors.empty? || (!@warnings.empty? && (options[:fail_on_warnings] == true))
-    end
-
-    true
+    msg = "License identifier #{parsed['license']} is not in the SPDX list: http://spdx.org/licenses/"
+    yield :warn, :license, msg
   end
-  module_function :parse
+  module_function :validate_metadata
 
   def validate_requirements_unique(requirements)
     names = requirements.map { |x| x['name'] }

data/metadata-json-lint.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'metadata-json-lint'
-  s.version     = '5.0.0'
+  s.version     = '5.1.0'
   s.summary     = 'metadata-json-lint /path/to/metadata.json'
   s.description = 'Utility to verify Puppet metadata.json files'
   s.authors     = ['Vox Pupuli']
@@ -14,10 +14,10 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 3.2.0'
 
-  s.add_dependency 'json-schema', '>= 2.8', '< 7.0'
+  s.add_dependency 'json-schema', '~> 6.2'
   s.add_dependency 'semantic_puppet', '~> 1.0'
   s.add_dependency 'spdx-licenses', '~> 1.0'
   s.add_development_dependency 'rake', '~> 13.0', '>= 13.0.6'
   s.add_development_dependency 'rspec', '~> 3.12'
-  s.add_development_dependency 'voxpupuli-rubocop', '~> 4.2.0'
+  s.add_development_dependency 'voxpupuli-rubocop', '~> 5.2.0'
 end

data/tests/bad_license/expected

@@ -1 +1 @@
-License identifier Unknown-1.0 is not in the SPDX list: http://spdx.org/licenses/
+(WARN) license: License identifier Unknown-1.0 is not in the SPDX list: http://spdx.org/licenses/

data/tests/broken/expected

@@ -1 +1 @@
-Error: Unable to parse metadata.json: 
+(ERROR) file: Unable to parse metadata.json: 

data/tests/duplicate-dep/expected

@@ -1 +1 @@
-Duplicate dependencies on puppetlabs/stdlib
+(WARN) dependencies: Duplicate dependencies on puppetlabs/stdlib

data/tests/duplicate-requirement/expected

@@ -1 +1 @@
-Duplicate entries in the 'requirements' list with the name 'puppet'
+(ERROR) requirements: Duplicate entries in the 'requirements' list with the name 'puppet'

data/tests/invalid_escape_char/expected

@@ -1 +1 @@
-Error: Unable to parse metadata.json: Invalid escape character in string
+(ERROR) file: Unable to parse metadata.json: Invalid escape character in string

data/tests/missing_newline/expected

@@ -1 +1 @@
-Error: metadata.json does not have a valid newline at the end
+(ERROR) file: metadata.json does not have a valid newline at the end

data/tests/missing_version_requirement/expected

@@ -1 +1 @@
-Dependency puppetlabs/stdlib has an open ended dependency version requirement
+(WARN) dependencies: Dependency puppetlabs/stdlib has an open ended dependency version requirement

data/tests/multiple_problems/expected

@@ -1,3 +1,3 @@
-Required field 'license' not found in metadata.json.
-Required field 'summary' not found in metadata.json.
-Deprecated field 'types' found in metadata.json.
+(ERROR) required_fields: The file did not contain a required property of 'license'
+(ERROR) required_fields: The file did not contain a required property of 'summary'
+(ERROR) deprecated_fields: Deprecated field 'types' found in metadata.json.

data/tests/no_files/expected

@@ -1 +1 @@
-Error: Unable to read metadata file: No such file or directory
+(ERROR) file: Unable to read metadata file: No such file or directory

data/tests/open_ended_dependency/expected

@@ -1 +1 @@
-Dependency puppetlabs/stdlib has an open ended dependency version requirement >= 3.2.0
+(WARN) dependencies: Dependency puppetlabs/stdlib has an open ended dependency version requirement >= 3.2.0

data/tests/rake_global_options/expected

@@ -1 +1 @@
-License identifier invalid_license is not in the SPDX list: http://spdx.org/licenses/
+(WARN) license: License identifier invalid_license is not in the SPDX list: http://spdx.org/licenses/

data/tests/requirements_eol_version/expected

@@ -1,2 +1 @@
-(WARN) requirements: 3.2.0 is no longer supported. Minimum supported version is 4.10.0(WARN) requirement: 3.2.0 is no longer supported. Minimum supported version is 4.10.0
-Warnings found in metadata.json
+(WARN) requirement: 3.2.0 is no longer supported. Minimum supported version is 4.10.0

data/tests/types/expected

@@ -1 +1 @@
-Deprecated field 'types' found in metadata.json.
+(ERROR) deprecated_fields: Deprecated field 'types' found in metadata.json.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metadata-json-lint
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Vox Pupuli
@@ -13,22 +13,16 @@ dependencies:
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.8'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.8'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: semantic_puppet
   requirement: !ruby/object:Gem::Requirement
@@ -97,14 +91,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 5.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 5.2.0
 description: Utility to verify Puppet metadata.json files
 email: voxpupuli@groups.io
 executables:
@@ -228,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.16
 specification_version: 4
 summary: metadata-json-lint /path/to/metadata.json
 test_files: []