metadata-json-lint 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a7b70935754237914b80d9ba45e9d45172e5e34d
-  data.tar.gz: 6f293e3f6f818c64b8407238f0687f400dfa97ca
+SHA256:
+  metadata.gz: fb2c947e575640401cda92a61f4b092a3670a0eac2c2bb94de66ce03b6d13d9f
+  data.tar.gz: 39c477f21af81c03b70e6e019fe38871d010dd8367561842b67c450d737f9679
 SHA512:
-  metadata.gz: a5677fe621a72e4a80cf85a76c2c11a4be29f98d27bdb0fa79aec331a68173f38ff8d5e48b4392d62a328bd990ad670ee30fd1390245811ef799440fdaaeafef
-  data.tar.gz: 3e2776da0adc039b30c4c4df51f7ffb60b5b233e71faa2cd5b766bdd75387665dc1c65341d1245045a3f288aea54bafc1e131ca1ffc05d772e3621c76ca1420a
+  metadata.gz: 6248827093dbcbde3a6e49beed51c61f40ed8b28b443155f04b062ee24f52790004dcb30567f6eb1f750250e0c9df34c0965de264f0589e851ff9706e72b6f39
+  data.tar.gz: f66771e15322868d43eb8e140f734e710c84a9035f4f47870c095a1af5d06aca12e4b49be94828bce7ea21773989028d7aea8db912782a9cca6212b489de1824

data/CHANGELOG.md

@@ -5,6 +5,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 2.1.0
+
+### Changes
+* Improve rendering of post\_install message by trimming unnecessary leading
+  spaces [#89](https://github.com/voxpupuli/metadata-json-lint/pull/89)
+* Fail when checking version requirements if the version range is empty
+  [#91](https://github.com/voxpupuli/metadata-json-lint/pull/91)
+* Pin `public_suffix` gem to < 3 for Ruby <= 2.0
+  [#93](https://github.com/voxpupuli/metadata-json-lint/pull/93)
+
+### Fixed
+* Prevent metadata-json-lint from crashing when the `requirements` field does
+  not contain an array
+  [#94](https://github.com/voxpupuli/metadata-json-lint/pull/94)
+* Fix loading of `semantic_puppet` so that it supports using version vendored
+  in Puppet (if available)
+  [#96](https://github.com/voxpupuli/metadata-json-lint/pull/96)
+
 ## 2.0.2
 
 ### Changes

data/Gemfile

@@ -1,3 +1,5 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem 'public_suffix', '< 3' if RUBY_VERSION < '2.1'

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

@@ -0,0 +1,47 @@
+module MetadataJsonLint
+  # Attempts the various methods of loading SemanticPuppet.
+  module SemanticPuppetLoader
+    def try_load
+      try_load_puppet
+      return if defined?(SemanticPuppet)
+
+      try_load_semantic
+      return if defined?(SemanticPuppet)
+
+      try_load_semantic_puppet
+      return if defined?(SemanticPuppet)
+
+      warn 'Could not find semantic_puppet gem, falling back to internal functionality. Version checks may be less robust.'
+    end
+    module_function :try_load
+
+    # Most modern Puppet versions have SemanticPuppet vendored in the proper
+    # namespace and automatically load it at require time.
+    def try_load_puppet
+      require 'puppet'
+    rescue LoadError
+      nil
+    end
+    module_function :try_load_puppet
+
+    # Older Puppet 4.x versions have SemanticPuppet vendored but under the
+    # Semantic namespace and require it on demand, so we need to load it
+    # ourselves and then alias it to SemanticPuppet for convenience.
+    def try_load_semantic
+      require 'semantic'
+      Kernel.const_set('SemanticPuppet', Semantic)
+    rescue LoadError
+      nil
+    end
+    module_function :try_load_semantic
+
+    # If Puppet is not available or is a version that does not have
+    # SemanticPuppet vendored, try to load the external gem.
+    def try_load_semantic_puppet
+      require 'semantic_puppet'
+    rescue LoadError
+      nil
+    end
+    module_function :try_load_semantic_puppet
+  end
+end

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

@@ -7,6 +7,7 @@ module MetadataJsonLint
 
       if defined?(SemanticPuppet::VersionRange)
         @range = SemanticPuppet::VersionRange.parse(requirement)
+        raise ArgumentError, "Range matches no versions: \"#{requirement}\"" if @range == SemanticPuppet::VersionRange::EMPTY_RANGE
       elsif requirement.match(/\A[a-z0-9*.\-^~><=|\t ]*\Z/i).nil?
         raise ArgumentError, "Unparsable version range: \"#{requirement}\""
       end

data/lib/metadata_json_lint.rb

@@ -2,11 +2,8 @@ require 'json'
 require 'spdx-licenses'
 require 'optparse'
 
-begin
-  require 'semantic_puppet'
-rescue LoadError
-  $stderr.puts('Could not find semantic_puppet gem, falling back to internal functionality. Version checks may be less robust.')
-end
+require 'metadata-json-lint/semantic_puppet_loader'
+MetadataJsonLint::SemanticPuppetLoader.try_load
 
 require 'metadata-json-lint/schema'
 require 'metadata-json-lint/version_requirement'
@@ -133,6 +130,8 @@ module MetadataJsonLint
   module_function :parse
 
   def validate_requirements!(requirements)
+    return unless requirements.is_a?(Array)
+
     requirements.each do |requirement|
       if requirement['name'] == 'pe'
         warn :requirements, "The 'pe' requirement is no longer supported by the Forge."
@@ -154,6 +153,8 @@ module MetadataJsonLint
       rescue ArgumentError => e
         # Raised when the version_requirement provided could not be parsed
         error :dependencies, "Invalid 'version_requirement' field in metadata.json: #{e}"
+        # Skip to the next dependency
+        next
       end
       validate_version_requirement!(dep, requirement)
 

data/metadata-json-lint.gemspec

@@ -2,7 +2,7 @@ require 'date'
 
 Gem::Specification.new do |s|
   s.name        = 'metadata-json-lint'
-  s.version     = '2.0.2'
+  s.version     = '2.1.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'
@@ -21,12 +21,12 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'json-schema', '~> 2.8'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rubocop'
+  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(/^  /, '')
 end

data/tests/non_array_requirements/Rakefile

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

data/tests/non_array_requirements/expected

@@ -0,0 +1 @@
+(ERROR) requirements: The property 'requirements' of type string did not match the following type: array

data/tests/non_array_requirements/metadata.json

@@ -0,0 +1,61 @@
+{
+  "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": "aoeu",
+  "dependencies": []
+}

data/tests/test.sh

@@ -141,6 +141,9 @@ test "tags_no_array" $FAILURE
 # Run with json output format
 test "json_format" $FAILURE --format json
 
+# Run against a metadata.json with a string for the requirements
+test "non_array_requirements" $FAILURE
+
 # Test running without specifying file to parse
 cd perfect
 bundle exec metadata-json-lint

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metadata-json-lint
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-01 00:00:00.000000000 Z
+date: 2018-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spdx-licenses
@@ -70,16 +70,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.50.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.50.0
 description: Utility to verify Puppet metadata.json files
 email: voxpupuli@groups.io
 executables:
@@ -100,6 +100,7 @@ files:
 - bin/metadata-json-lint
 - lib/metadata-json-lint/rake_task.rb
 - lib/metadata-json-lint/schema.rb
+- lib/metadata-json-lint/semantic_puppet_loader.rb
 - lib/metadata-json-lint/version_requirement.rb
 - lib/metadata_json_lint.rb
 - metadata-json-lint.gemspec
@@ -138,6 +139,9 @@ files:
 - tests/no_pe/metadata.json
 - tests/no_version_range/Rakefile
 - tests/no_version_range/metadata.json
+- tests/non_array_requirements/Rakefile
+- tests/non_array_requirements/expected
+- tests/non_array_requirements/metadata.json
 - tests/noname/Rakefile
 - tests/noname/expected
 - tests/noname/metadata.json
@@ -169,10 +173,13 @@ homepage: http://github.com/voxpupuli/metadata-json-lint
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: "\n  ----------------------------------------------------------\n
-  \     For the most accurate results, the semantic_puppet\n      gem should be included
-  within your Gemfile if you\n      use Puppet <= 4.8.x\n  ----------------------------------------------------------\n
-  \ "
+post_install_message: |2
+
+  ----------------------------------------------------------
+      For the most accurate results, the semantic_puppet
+      gem should be included within your Gemfile if you
+      use Puppet <= 4.8.x
+  ----------------------------------------------------------
 rdoc_options: []
 require_paths:
 - lib
@@ -188,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.7.5
 signing_key: 
 specification_version: 4
 summary: metadata-json-lint /path/to/metadata.json
@@ -228,6 +235,9 @@ test_files:
 - tests/no_pe/metadata.json
 - tests/no_version_range/Rakefile
 - tests/no_version_range/metadata.json
+- tests/non_array_requirements/Rakefile
+- tests/non_array_requirements/expected
+- tests/non_array_requirements/metadata.json
 - tests/noname/Rakefile
 - tests/noname/expected
 - tests/noname/metadata.json