metadata-json-lint 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 392e39d697c2b5355eebedd010f8a80b575db099a6865a66f82397c387733969
-  data.tar.gz: 7dbcb7bce5b9ddf5e20bf0f0fc91f854c0dacd81d097dff585f1aef2b442fb77
+  metadata.gz: b60ce6545987408a2b495837f6817aec37c8caf185ed8d607ecc2067421e4604
+  data.tar.gz: b945326563aa3db151f3c11dc52bb8a3aca36920d541dc3a23a2ed1bb0c85ee3
 SHA512:
-  metadata.gz: e9e4de4ab6f67f70575b5e73be16871d4f629f3d0e1954c5ee7a6f42859bc2b63bc8eef9028b6591fd0780ad49d506a07b55b16774b32b54792ac063ef8f6814
-  data.tar.gz: 240dbbc7fa193e30197704e3313cebb07617999053ff53caf5860cc7c17efa16bfd24a2b15fd87d53c22e34ac1e4e23651d9a48750cb2ab3b5fc382cb56fab7c
+  metadata.gz: 6248271c94ffdaa61d9236884c01af123114f14850885f09d7699ebeaa639f262fc476834781b80c6ae413ef434b8cec269368f63a54681f8c39ad178a1a640f
+  data.tar.gz: 61690474cee73b0fc0f14a32dd9c87d3a82ea682a3754e695acc4c87d261093f531ad0407a95d91d68d317ba8c5cd409bb9d80ff8c995a90d40b35240fe7cdb6

data/.github/workflows/release.yml

@@ -11,10 +11,10 @@ jobs:
     if: github.repository_owner == 'voxpupuli'
     steps:
       - uses: actions/checkout@v4
-      - name: Install Ruby 3.3
+      - name: Install Ruby 3.4
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.3'
+          ruby-version: '3.4'
         env:
           BUNDLE_WITHOUT: release
       - name: Build gem

data/.github/workflows/test.yml

@@ -10,49 +10,45 @@ env:
   BUNDLE_WITHOUT: release
 
 jobs:
-  rubocop:
+  rubocop_and_matrix:
     runs-on: ubuntu-latest
+    outputs:
+      ruby: ${{ steps.ruby.outputs.versions }}
     steps:
       - uses: actions/checkout@v4
-      - name: Install Ruby ${{ matrix.ruby }}
+      - name: Install Ruby 3.4
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: "3.3"
+          ruby-version: '3.4'
           bundler-cache: true
-      - name: Run Rubocop
+      - name: Run RuboCop
         run: bundle exec rake rubocop
-  rspec:
+      - id: ruby
+        uses: voxpupuli/ruby-version@v1
+
+  test:
+    name: "Ruby ${{ matrix.ruby }}"
     runs-on: ubuntu-latest
+    needs: rubocop_and_matrix
     strategy:
+      fail-fast: false
       matrix:
-        include:
-          - ruby: "2.7"
-          - ruby: "3.0"
-          - ruby: "3.1"
-            coverage: "yes"
-          - ruby: "3.2"
-          - ruby: "3.3"
-    env:
-      COVERAGE: ${{ matrix.coverage }}
-      # https://github.com/rubygems/rubygems/issues/5234#issuecomment-1003773622
-      RUBYOPT: '--disable-did_you_mean'
-    name: RSpec - Ruby ${{ matrix.ruby }}
+        ruby: ${{ fromJSON(needs.rubocop_and_matrix.outputs.ruby) }}
     steps:
       - uses: actions/checkout@v4
-      - name: Install Ruby ${{ matrix.ruby }}
+      - name: Setup ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
-      - name: spec tests
+      - name: Run tests
         run: bundle exec rake test
-      - name: Verify gem builds
+      - name: Build the gem
         run: gem build --strict --verbose *.gemspec
 
   tests:
     needs:
-      - rubocop
-      - rspec
+      - test
     runs-on: ubuntu-latest
     name: Test suite
     steps:

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## [4.2.0](https://github.com/voxpupuli/metadata-json-lint/tree/4.2.0) (2025-01-24)
+
+[Full Changelog](https://github.com/voxpupuli/metadata-json-lint/compare/4.1.0...4.2.0)
+
+**Implemented enhancements:**
+
+- Fail if metadata.json has no proper newline [\#154](https://github.com/voxpupuli/metadata-json-lint/pull/154) ([bastelfreak](https://github.com/bastelfreak))
+- Fail on escape sequences in metadata.json [\#152](https://github.com/voxpupuli/metadata-json-lint/pull/152) ([bastelfreak](https://github.com/bastelfreak))
+- Rake: Use RuboCop tasks from voxpupuli-rubocop [\#150](https://github.com/voxpupuli/metadata-json-lint/pull/150) ([bastelfreak](https://github.com/bastelfreak))
+- Add Ruby 3.4 to CI [\#149](https://github.com/voxpupuli/metadata-json-lint/pull/149) ([bastelfreak](https://github.com/bastelfreak))
+
+**Merged pull requests:**
+
+- CI: Switch to voxpupuli/ruby-version [\#156](https://github.com/voxpupuli/metadata-json-lint/pull/156) ([bastelfreak](https://github.com/bastelfreak))
+- Drop code coverage in testing [\#153](https://github.com/voxpupuli/metadata-json-lint/pull/153) ([ekohl](https://github.com/ekohl))
+- Update voxpupuli-rubocop requirement from ~\> 2.8.0 to ~\> 3.0.0 [\#147](https://github.com/voxpupuli/metadata-json-lint/pull/147) ([dependabot[bot]](https://github.com/apps/dependabot))
+
 ## [4.1.0](https://github.com/voxpupuli/metadata-json-lint/tree/4.1.0) (2024-08-19)
 
 [Full Changelog](https://github.com/voxpupuli/metadata-json-lint/compare/4.0.0...4.1.0)

data/Gemfile

@@ -6,8 +6,3 @@ group :release do
   gem 'faraday-retry', require: false
   gem 'github_changelog_generator', require: false
 end
-
-group :coverage, optional: ENV['COVERAGE'] != 'yes' do
-  gem 'codecov', require: false
-  gem 'simplecov-console', require: false
-end

data/Rakefile

@@ -2,16 +2,9 @@ desc 'Run all tests'
 task test: %i[spec test:acceptance]
 
 begin
-  require 'rubocop/rake_task'
+  require 'voxpupuli/rubocop/rake'
 rescue LoadError
-  # RuboCop is an optional group
-else
-  RuboCop::RakeTask.new(:rubocop) do |task|
-    # These make the rubocop experience maybe slightly less terrible
-    task.options = ['--display-cop-names', '--display-style-guide', '--extra-details']
-    # Use Rubocop's Github Actions formatter if possible
-    task.formatters << 'github' if ENV['GITHUB_ACTIONS'] == 'true'
-  end
+  # the voxpupuli-rubocop gem is optional
 end
 
 namespace :test do

data/lib/metadata_json_lint.rb

@@ -8,6 +8,9 @@ require 'metadata-json-lint/version_requirement'
 
 module MetadataJsonLint
   MIN_PUPPET_VER = '4.10.0'.freeze
+  # Regex looks for:
+  # 1. Invalid escape sequences (\x or incomplete \u)
+  INVALID_ESCAPE_REGEX = %r{\\[^"/bfnrtu]|\\u(?![0-9a-fA-F]{4})}.freeze
 
   def options
     @options ||= Struct.new(
@@ -69,6 +72,16 @@ module MetadataJsonLint
   end
   module_function :run
 
+  def contains_invalid_escape?(content)
+    content.match?(INVALID_ESCAPE_REGEX)
+  end
+  module_function :contains_invalid_escape?
+
+  def misses_newline_at_end?(content)
+    content[-1] != "\n"
+  end
+  module_function :misses_newline_at_end?
+
   def parse(metadata)
     @errors = []
     @warnings = []
@@ -83,6 +96,10 @@ module MetadataJsonLint
       abort("Error: Unable to read metadata file: #{e.exception}")
     end
 
+    abort('Error: 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)
+
     begin
       parsed = JSON.parse(f)
     rescue Exception => e

data/metadata-json-lint.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'metadata-json-lint'
-  s.version     = '4.1.0'
+  s.version     = '4.2.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 = '>= 2.7.0'
 
-  s.add_runtime_dependency 'json-schema', '>= 2.8', '< 6.0'
-  s.add_runtime_dependency 'semantic_puppet', '~> 1.0'
-  s.add_runtime_dependency 'spdx-licenses', '~> 1.0'
+  s.add_dependency 'json-schema', '>= 2.8', '< 6.0'
+  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', '~> 2.8.0'
+  s.add_development_dependency 'voxpupuli-rubocop', '~> 3.0.0'
 end

data/spec/spec_helper.rb

@@ -1,27 +1,3 @@
-begin
-  require 'simplecov'
-  require 'simplecov-console'
-  require 'codecov'
-rescue LoadError
-else
-  SimpleCov.start do
-    track_files 'lib/**/*.rb'
-
-    add_filter '/spec'
-
-    enable_coverage :branch
-
-    # do not track vendored files
-    add_filter '/vendor'
-    add_filter '/.vendor'
-  end
-
-  SimpleCov.formatters = [
-    SimpleCov::Formatter::Console,
-    SimpleCov::Formatter::Codecov,
-  ]
-end
-
 require 'metadata_json_lint'
 
 # This file was generated by the `rspec --init` command

data/tests/invalid_escape_char/Rakefile

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __dir__))
+require 'metadata-json-lint/rake_task'

data/tests/invalid_escape_char/expected

@@ -0,0 +1 @@
+Error: Unable to parse metadata.json: Invalid escape character in string

data/tests/invalid_escape_char/metadata.json

@@ -0,0 +1,16 @@
+{
+  "name": "puppetlabs-postgresql",
+  "version": "3.4.1",
+  "author": "Inkling/Puppet Labs",
+  "summary": "A description with an invalid \( escape sequence",
+  "license": "Apache-2.0",
+  "source": "git://github.com/puppetlabs/puppet-postgresql.git",
+  "project_page": "https://github.com/puppetlabs/puppet-postgresql",
+  "issues_url": "https://github.com/puppetlabs/puppet-postgresql/issues",
+  "operatingsystem_support": [
+  ],
+  "requirements": [
+  ],
+  "dependencies": [
+  ]
+}

data/tests/missing_newline/Rakefile

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __dir__))
+require 'metadata-json-lint/rake_task'

data/tests/missing_newline/expected

@@ -0,0 +1 @@
+Error: metadata.json does not have a valid newline at the end

data/tests/missing_newline/metadata.json

@@ -0,0 +1,16 @@
+{
+  "name": "puppetlabs-postgresql",
+  "version": "3.4.1",
+  "author": "Inkling/Puppet Labs",
+  "summary": "A metadata.json file without a newline at the end",
+  "license": "Apache-2.0",
+  "source": "git://github.com/puppetlabs/puppet-postgresql.git",
+  "project_page": "https://github.com/puppetlabs/puppet-postgresql",
+  "issues_url": "https://github.com/puppetlabs/puppet-postgresql/issues",
+  "operatingsystem_support": [
+  ],
+  "requirements": [
+  ],
+  "dependencies": [
+  ]
+}

data/tests/test.sh

@@ -103,6 +103,12 @@ test "bad_license" $SUCCESS --no-strict-license
 # Run with --no-fail-on-warnings, expect SUCCESS
 test "bad_license" $SUCCESS --no-fail-on-warnings
 
+# Run a broken one, expect FAILURE
+test "invalid_escape_char" $FAILURE
+
+# Run a broken one, expect FAILURE
+test "missing_newline" $FAILURE
+
 # Run a broken one, expect FAILURE
 test "long_summary" $FAILURE
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: metadata-json-lint
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Vox Pupuli
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-19 00:00:00.000000000 Z
+date: 2025-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -98,14 +97,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 3.0.0
 description: Utility to verify Puppet metadata.json files
 email: voxpupuli@groups.io
 executables:
@@ -148,12 +147,18 @@ files:
 - tests/duplicate-requirement/Rakefile
 - tests/duplicate-requirement/expected
 - tests/duplicate-requirement/metadata.json
+- tests/invalid_escape_char/Rakefile
+- tests/invalid_escape_char/expected
+- tests/invalid_escape_char/metadata.json
 - tests/json_format/Rakefile
 - tests/json_format/expected
 - tests/json_format/metadata.json
 - tests/long_summary/Rakefile
 - tests/long_summary/expected
 - tests/long_summary/metadata.json
+- tests/missing_newline/Rakefile
+- tests/missing_newline/expected
+- tests/missing_newline/metadata.json
 - tests/missing_version_requirement/Rakefile
 - tests/missing_version_requirement/expected
 - tests/missing_version_requirement/metadata.json
@@ -208,7 +213,6 @@ homepage: https://github.com/voxpupuli/metadata-json-lint
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -223,8 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: metadata-json-lint /path/to/metadata.json
 test_files: []