metadata-json-lint 2.2.0 → 3.0.1

data/README.md

@@ -1,5 +1,12 @@
 # metadata-json-lint
 
+[![License](https://img.shields.io/github/license/voxpupuli/metadata-json-lint.svg)](https://github.com/voxpupuli/metadata-json-lint/blob/master/LICENSE)
+[![Test](https://github.com/voxpupuli/metadata-json-lint/actions/workflows/test.yml/badge.svg)](https://github.com/voxpupuli/metadata-json-lint/actions/workflows/test.yml)
+[![codecov](https://codecov.io/gh/voxpupuli/metadata-json-lint/branch/master/graph/badge.svg)](https://codecov.io/gh/voxpupuli/metadata-json-lint)
+[![Release](https://github.com/voxpupuli/metadata-json-lint/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/metadata-json-lint/actions/workflows/release.yml)
+[![RubyGem Version](https://img.shields.io/gem/v/metadata-json-lint.svg)](https://rubygems.org/gems/metadata-json-lint)
+[![RubyGem Downloads](https://img.shields.io/gem/dt/metadata-json-lint.svg)](https://rubygems.org/gems/metadata-json-lint)
+
 The metadata-json-lint tool validates and lints `metadata.json` files in Puppet modules against style guidelines from the [Puppet Forge module metadata](https://docs.puppet.com/puppet/latest/modules_publishing.html#write-a-metadatajson-file) recommendations.
 
 ## Compatibility
@@ -41,7 +48,7 @@ rake metadata_lint
 To set options for the Rake task, include them when you define the task:
 
 ```ruby
-require 'metadata-json-lint'
+require 'metadata_json_lint'
 task :metadata_lint do
   MetadataJsonLint.parse('metadata.json') do |options|
       options.strict_license = false
@@ -66,3 +73,60 @@ MetadataJsonLint.options.strict_license = false
 ## Contributors
 
 A big thank you to the [contributors](https://github.com/voxpupuli/metadata-json-lint/graphs/contributors).
+
+## Making a new release
+
+How to make a new release?
+
+* update the gemspec file with the desired version
+
+```console
+$ git diff
+diff --git a/metadata-json-lint.gemspec b/metadata-json-lint.gemspec
+index c86668e..6a3ad38 100644
+--- a/metadata-json-lint.gemspec
++++ b/metadata-json-lint.gemspec
+@@ -2,7 +2,7 @@ require 'date'
+
+ Gem::Specification.new do |s|
+   s.name        = 'metadata-json-lint'
+-  s.version     = '2.4.0'
++  s.version     = '2.5.0'
+   s.date        = Date.today.to_s
+   s.summary     = 'metadata-json-lint /path/to/metadata.json'
+   s.description = 'Utility to verify Puppet metadata.json files'
+```
+
+* export a GitHub access token as environment variable:
+
+```console
+export CHANGELOG_GITHUB_TOKEN=*token*
+```
+
+* Install deps and generate the changelog
+
+```console
+$ bundle install --path .vendor/ --jobs=$(nproc) --with release
+$ bundle exec rake changelog
+Found 25 tags
+Fetching tags dates: 25/25
+Sorting tags...
+Received issues: 103
+Pull Request count: 77
+Filtered pull requests: 72
+Filtered issues: 26
+Fetching events for issues and PR: 98
+Fetching closed dates for issues: 98/98
+Fetching SHAs for tags: 25
+Associating PRs with tags: 72/72
+Generating entry...
+Done!
+Generated log placed in ~/metadata-json-lint/CHANGELOG.md
+```
+
+* Check the diff for `CHANGELOG.md`. Does it contain a breaking change but the
+new version is only a minor bump? Does the new release only contains bug fixes?
+Adjust the version properly while honouring semantic versioning. If required,
+regenerate the `CHANGELOG.md`. Afterwards submit it as a PR.
+
+* If it gets approved, merge the PR, create a git tag on that and push it.

data/Rakefile

@@ -2,7 +2,18 @@ desc 'Run all tests'
 task :test => %i[rubocop spec test:acceptance]
 
 require 'rubocop/rake_task'
-RuboCop::RakeTask.new
+RuboCop::RakeTask.new(:rubocop) do |task|
+  # These make the rubocop experience maybe slightly less terrible
+  task.options = ['-D', '-S', '-E']
+
+  # Use Rubocop's Github Actions formatter if possible
+  if ENV['GITHUB_ACTIONS'] == 'true'
+    rubocop_spec = Gem::Specification.find_by_name('rubocop')
+    if Gem::Version.new(rubocop_spec.version) >= Gem::Version.new('1.2')
+      task.formatters << 'github'
+    end
+  end
+end
 
 namespace :test do
   desc 'Acceptance suite under test/ which runs metadata-json-lint against sample files with expected output'
@@ -13,3 +24,17 @@ end
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
+
+begin
+  require 'rubygems'
+  require 'github_changelog_generator/task'
+rescue LoadError # rubocop:disable Lint/HandleExceptions
+else
+  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+    config.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog]
+    config.user = 'voxpupuli'
+    config.project = 'metadata-json-lint'
+    gem_version = Gem::Specification.load("#{config.project}.gemspec").version
+    config.future_release = gem_version
+  end
+end

data/bin/metadata-json-lint

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-lib = File.expand_path('../../lib', __FILE__)
+lib = File.expand_path('../lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'metadata_json_lint'

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

@@ -9,7 +9,6 @@ module MetadataJsonLint
   class Schema
     # Based on https://docs.puppet.com/puppet/latest/modules_metadata.html
     #
-    # rubocop:disable Style/TrailingCommaInLiteral # easier to modify individual lines
     def schema
       {
         '$schema' => 'http://json-schema.org/draft-04/schema#',
@@ -101,7 +100,7 @@ module MetadataJsonLint
           'tags' => {
             'type' => 'array',
             'items' => {
-              'type' => 'string'
+              'type' => 'string',
             },
           },
           'version' => {
@@ -121,7 +120,6 @@ module MetadataJsonLint
         ],
       }
     end
-    # rubocop:enable Style/TrailingCommaInLiteral
 
     def validate(data, options = {})
       JSON::Validator.register_format_validator('semver', method(:semver_validator))
@@ -166,3 +164,4 @@ module MetadataJsonLint
     end
   end
 end
+# rubocop:enable Metrics/ClassLength

data/lib/metadata_json_lint.rb

@@ -137,6 +137,18 @@ module MetadataJsonLint
   end
   module_function :parse
 
+  def validate_requirements_unique(requirements)
+    names = requirements.map { |x| x['name'] }
+    counts = Hash.new(0)
+
+    names.each { |name| counts[name.downcase] += 1 }
+
+    counts.each do |k, v|
+      error :requirements, "Duplicate entries in the 'requirements' list with the name '#{k}'" if v > 1
+    end
+  end
+  module_function :validate_requirements_unique
+
   def validate_requirements!(requirements)
     return unless requirements.is_a?(Array)
 
@@ -154,6 +166,8 @@ module MetadataJsonLint
 
       validate_puppet_ver!(puppet_req) unless puppet_req.instance_variable_get('@requirement').nil?
     end
+
+    validate_requirements_unique(requirements)
   end
   module_function :validate_requirements!
 

data/metadata-json-lint.gemspec

@@ -2,7 +2,7 @@ require 'date'
 
 Gem::Specification.new do |s|
   s.name        = 'metadata-json-lint'
-  s.version     = '2.2.0'
+  s.version     = '3.0.1'
   s.date        = Date.today.to_s
   s.summary     = 'metadata-json-lint /path/to/metadata.json'
   s.description = 'Utility to verify Puppet metadata.json files'
@@ -13,22 +13,15 @@ Gem::Specification.new do |s|
   s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.test_files  = s.files.grep(%r{^(tests|spec)/})
 
-  s.homepage    = 'http://github.com/voxpupuli/metadata-json-lint'
+  s.homepage    = 'https://github.com/voxpupuli/metadata-json-lint'
   s.license     = 'Apache-2.0'
 
-  s.required_ruby_version = '>= 2.0.0'
-  s.add_runtime_dependency 'spdx-licenses', '~> 1.0'
+  s.required_ruby_version = '>= 2.1.0'
   s.add_runtime_dependency 'json-schema', '~> 2.8'
+  s.add_runtime_dependency 'spdx-licenses', '~> 1.0'
   s.add_development_dependency 'pry'
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'semantic_puppet'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rubocop', '~> 0.50.0'
-  s.post_install_message = '
-  ----------------------------------------------------------
-      For the most accurate results, the semantic_puppet
-      gem should be included within your Gemfile if you
-      use Puppet <= 4.8.x
-  ----------------------------------------------------------
-  '.gsub(/^  /, '')
+  s.add_development_dependency 'rubocop', '~> 0.57.2'
+  s.add_development_dependency 'semantic_puppet'
 end

data/spec/spec_helper.rb

@@ -1,3 +1,27 @@
+begin
+  require 'simplecov'
+  require 'simplecov-console'
+  require 'codecov'
+rescue LoadError # rubocop:disable Lint/HandleExceptions
+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/bad_license/Rakefile

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

data/tests/broken/Rakefile

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

data/tests/duplicate-dep/Rakefile

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

data/tests/duplicate-requirement/Rakefile

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

data/tests/duplicate-requirement/expected

@@ -0,0 +1 @@
+Duplicate entries in the 'requirements' list with the name 'puppet'

data/tests/duplicate-requirement/metadata.json

@@ -0,0 +1,87 @@
+{
+  "name": "puppetlabs-postgresql",
+  "version": "3.4.1",
+  "author": "Inkling/Puppet Labs",
+  "summary": "PostgreSQL defined resource types",
+  "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": [
+    {
+      "operatingsystem": "RedHat",
+      "operatingsystemrelease": [
+        "5",
+        "6",
+        "7"
+      ]
+    },
+    {
+      "operatingsystem": "CentOS",
+      "operatingsystemrelease": [
+        "5",
+        "6",
+        "7"
+      ]
+    },
+    {
+      "operatingsystem": "OracleLinux",
+      "operatingsystemrelease": [
+        "5",
+        "6",
+        "7"
+      ]
+    },
+    {
+      "operatingsystem": "Scientific",
+      "operatingsystemrelease": [
+        "5",
+        "6",
+        "7"
+      ]
+    },
+    {
+      "operatingsystem": "Debian",
+      "operatingsystemrelease": [
+        "6",
+        "7"
+      ]
+    },
+    {
+      "operatingsystem": "Ubuntu",
+      "operatingsystemrelease": [
+        "10.04",
+        "12.04",
+        "14.04"
+      ]
+    }
+  ],
+  "requirements": [
+    {
+      "name": "puppet",
+      "version_requirement": "5.5.1"
+    },
+    {
+      "name": "puppet",
+      "version_requirement": "6.11.0"
+    }
+  ],
+  "dependencies": [
+    {
+      "name": "puppetlabs/stdlib",
+      "version_requirement": "4.x"
+    },
+    {
+      "name": "puppetlabs/firewall",
+      "version_requirement": ">= 0.0.4"
+    },
+    {
+      "name": "puppetlabs/apt",
+      "version_requirement": ">=1.1.0 <2.0.0"
+    },
+    {
+      "name": "puppetlabs/concat",
+      "version_requirement": ">= 1.1.0 <2.0.0"
+    }
+  ]
+}

data/tests/json_format/Rakefile

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

data/tests/long_summary/Rakefile

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

data/tests/missing_version_requirement/Rakefile

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

data/tests/mixed_version_syntax/Rakefile

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

data/tests/multiple_problems/Rakefile

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

data/tests/no_dependencies/Rakefile

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

data/tests/no_pe/Rakefile

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

data/tests/no_version_range/Rakefile

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

data/tests/non_array_requirements/Rakefile

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

data/tests/noname/Rakefile

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

data/tests/open_ended_dependency/Rakefile

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

data/tests/perfect/Rakefile

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

data/tests/proprietary/Rakefile

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

data/tests/rake_chaining/Rakefile

@@ -1,4 +1,4 @@
-$LOAD_PATH.unshift(File.expand_path('../../../lib', __FILE__))
+$LOAD_PATH.unshift(File.expand_path('../../lib', __dir__))
 require 'metadata-json-lint/rake_task'
 
 task :test => %i[metadata_lint success]

data/tests/rake_global_options/Rakefile

@@ -1,4 +1,4 @@
-$LOAD_PATH.unshift(File.expand_path('../../../lib', __FILE__))
+$LOAD_PATH.unshift(File.expand_path('../../lib', __dir__))
 require 'metadata-json-lint/rake_task'
 MetadataJsonLint.options.strict_license = false
 MetadataJsonLint.options.fail_on_warnings = false