metadata-json-lint 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14659a2f1f2f0cdbc342929c70ebe0e808cb01d1
-  data.tar.gz: 7dac64b05c3f98bd37b69982a73178c5cfa436eb
+  metadata.gz: a7b70935754237914b80d9ba45e9d45172e5e34d
+  data.tar.gz: 6f293e3f6f818c64b8407238f0687f400dfa97ca
 SHA512:
-  metadata.gz: a84b3571e974ecdfb133532eedcdbbcea5c4afb483f029ee2e0850b8605bb73acfbdb2af973f4b542a5ba131c05c902083f690f99c1a38889c5419b13ca12f19
-  data.tar.gz: 838914c262be020a5dd3df0837d404068be3eead05c973094bf938efaa7bb78c0c4a6494c323ca6368887250b196e9afdb787eb79aa8891d4db7253fe3be37db
+  metadata.gz: a5677fe621a72e4a80cf85a76c2c11a4be29f98d27bdb0fa79aec331a68173f38ff8d5e48b4392d62a328bd990ad670ee30fd1390245811ef799440fdaaeafef
+  data.tar.gz: 3e2776da0adc039b30c4c4df51f7ffb60b5b233e71faa2cd5b766bdd75387665dc1c65341d1245045a3f288aea54bafc1e131ca1ffc05d772e3621c76ca1420a

data/CHANGELOG.md

@@ -5,6 +5,15 @@ 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.0.2
+
+### Changes
+* Make SemanticPuppet completely optional and remove dependency on Puppet [#86](https://github.com/voxpupuli/metadata-json-lint/pull/86)
+* Only log open dependency warning with --strict-dependencies [#78](https://github.com/voxpupuli/metadata-json-lint/pull/78)
+
+### Fixed
+* Fix readme for gemfile usage [#84](https://github.com/voxpupuli/metadata-json-lint/pull/84)
+
 ## 2.0.1
 
 ### Changes

data/README.md

@@ -30,7 +30,7 @@ gem install metadata-json-lint semantic_puppet
 via Gemfile:
 ``` ruby
 gem 'metadata-json-lint'
-gem 'semantic_puppet
+gem 'semantic_puppet'
 ```
 
 ## Usage

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

@@ -141,10 +141,28 @@ module MetadataJsonLint
 
     private
 
+    def semver_full_regex
+      @semver_full_regex ||= begin
+        # Version string matching regexes
+        numeric = '(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)' # Major . Minor . Patch
+        pre     = '(?:-([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?' # Prerelease
+        build   = '(?:\+([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?' # Build
+        full    = numeric + pre + build
+
+        /\A#{full}\Z/
+      end
+    end
+
     def semver_validator(value)
-      SemanticPuppet::Version.parse(value)
-    rescue SemanticPuppet::Version::ValidationFailure => e
-      raise JSON::Schema::CustomFormatError, "must be a valid semantic version: #{e.message}"
+      if defined?(SemanticPuppet::Version)
+        begin
+          SemanticPuppet::Version.parse(value)
+        rescue SemanticPuppet::Version::ValidationFailure => e
+          raise JSON::Schema::CustomFormatError, "must be a valid semantic version: #{e.message}"
+        end
+      elsif value.match(semver_full_regex).nil?
+        raise JSON::Schema::CustomFormatError, "must be a valid semantic version: Unable to parse '#{value}' as a semantic version identifier"
+      end
     end
   end
 end

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

@@ -1,13 +1,15 @@
-require 'puppet'
-require 'semantic_puppet' unless Puppet.version >= '4.9.0'
-
 module MetadataJsonLint
   # Parses a string module version requirement with semantic_puppet and
   # provides methods to analyse it for lint warnings
   class VersionRequirement
     def initialize(requirement)
       @requirement = requirement
-      @range = SemanticPuppet::VersionRange.parse(requirement)
+
+      if defined?(SemanticPuppet::VersionRange)
+        @range = SemanticPuppet::VersionRange.parse(requirement)
+      elsif requirement.match(/\A[a-z0-9*.\-^~><=|\t ]*\Z/i).nil?
+        raise ArgumentError, "Unparsable version range: \"#{requirement}\""
+      end
     end
 
     # Whether the range uses a comparison operator (e.g. >=) with a wildcard
@@ -26,7 +28,22 @@ module MetadataJsonLint
     end
 
     def open_ended?
-      @range.end == SemanticPuppet::Version::MAX
+      if range
+        range.end == SemanticPuppet::Version::MAX
+      else
+        # Empty requirement strings are open-ended.
+        return true if requirement.strip.empty?
+
+        # Strip superfluous whitespace.
+        range_set = requirement.gsub(/([><=~^])(?:\s+|\s*v)/, '\1')
+
+        # Split on logical OR
+        ranges = range_set.split(/\s*\|\|\s*/)
+
+        # Returns true if any range includes a '>' but not a corresponding '<'
+        # which should be the only way to declare an open-ended range.
+        ranges.select { |r| r.include?('>') }.any? { |r| !r.include?('<') }
+      end
     end
 
     private

data/lib/metadata_json_lint.rb

@@ -2,6 +2,12 @@ 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/schema'
 require 'metadata-json-lint/version_requirement'
 
@@ -164,10 +170,10 @@ module MetadataJsonLint
   def validate_version_requirement!(dep, requirement)
     # Open ended dependency
     # From: https://docs.puppet.com/puppet/latest/reference/modules_metadata.html#best-practice-set-an-upper-bound-for-dependencies
-    if requirement.open_ended?
+    if options[:strict_dependencies] && requirement.open_ended?
       msg = "Dependency #{dep['name']} has an open " \
         "ended dependency version requirement #{dep['version_requirement']}"
-      options[:strict_dependencies] == true ? error(:dependencies, msg) : warn(:dependencies, msg)
+      warn(:dependencies, msg)
     end
 
     # Mixing operator and wildcard version syntax

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.1'
+  s.version     = '2.0.2'
   s.date        = Date.today.to_s
   s.summary     = 'metadata-json-lint /path/to/metadata.json'
   s.description = 'Utility to verify Puppet metadata.json files'
@@ -19,14 +19,14 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.0.0'
   s.add_runtime_dependency 'spdx-licenses', '~> 1.0'
   s.add_runtime_dependency 'json-schema', '~> 2.8'
-  s.add_runtime_dependency 'puppet', '>= 4.7.0', '< 6.0.0'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'rubocop'
   s.post_install_message = '
-  -------------------------------------------------
-      semantic_puppet must be installed within
-      your Gemfile if you use Puppet <= 4.8.x!!
-  -------------------------------------------------
+  ----------------------------------------------------------
+      For the most accurate results, the semantic_puppet
+      gem should be included within your Gemfile if you
+      use Puppet <= 4.8.x
+  ----------------------------------------------------------
   '
 end

data/tests/test.sh

@@ -112,15 +112,19 @@ test "mixed_version_syntax" $FAILURE
 # Run one with empty dependencies array, expect SUCCESS
 test "no_dependencies" $SUCCESS
 
-# Run one with open ended dependency, expect SUCCESS
-test "open_ended_dependency" $SUCCESS --no-fail-on-warnings
+# Run one with open ended dependency, expect SUCCESS as strict deps is off by default
+test "open_ended_dependency" $SUCCESS
 # Run one with open ended dependency and --strict-dependencies, expect FAILURE
 test "open_ended_dependency" $FAILURE --strict-dependencies
+# Run one with open ended dependency and --strict-dependencies, but pass on warnings, expect SUCCESS
+test "open_ended_dependency" $SUCCESS --strict-dependencies --no-fail-on-warnings
 
 # Run one with missing version_requirement and --no-strict-dependency, expect SUCCESS
-test "missing_version_requirement" $SUCCESS --no-fail-on-warnings
+test "missing_version_requirement" $SUCCESS
 # Run one with open ended dependency and --strict-dependencies, expect FAILURE
 test "missing_version_requirement" $FAILURE --strict-dependencies
+# Run one with open ended dependency and --strict-dependencies, but pass on warnings, expect SUCCESS
+test "missing_version_requirement" $SUCCESS --strict-dependencies --no-fail-on-warnings
 
 # Run test for "proprietary"-licensed modules, expect SUCCESS
 test "proprietary" $SUCCESS

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metadata-json-lint
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-30 00:00:00.000000000 Z
+date: 2017-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spdx-licenses
@@ -38,26 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.8'
-- !ruby/object:Gem::Dependency
-  name: puppet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.7.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 6.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.7.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -189,8 +169,9 @@ homepage: http://github.com/voxpupuli/metadata-json-lint
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: "\n  -------------------------------------------------\n      semantic_puppet
-  must be installed within\n      your Gemfile if you use Puppet <= 4.8.x!!\n  -------------------------------------------------\n
+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
   \ "
 rdoc_options: []
 require_paths: