metadata-json-lint 0.0.2 → 0.0.3

data/bin/metadata-json-lint

@@ -1,17 +1,8 @@
 #!/usr/bin/env ruby
 
-
 lib = File.expand_path('../../lib', __FILE__)
 $:.unshift(lib) unless $:.include?(lib)
 
-require "json"
 require "metadata_json_lint"
-#require "MetadataJsonLint"
-
-if ARGV[0].nil?
-  abort("Error: Must provide a metadata.json file to parse")
-end
-
-metadata = ARGV[0]
 
-MetadataJsonLint.parse(metadata)
+MetadataJsonLint.run

data/lib/metadata_json_lint.rb

@@ -1,14 +1,43 @@
-#!/usr/bin/env ruby
+require 'json'
+require 'spdx-licenses'
+require 'optparse'
 
 module MetadataJsonLint
-  def MetadataJsonLint.parse(metadata)
+  def run
+    options = {
+      :fail_on_warnings => true,
+      :strict_license   => true
+    }
 
+    OptionParser.new do |opts|
+      opts.banner = "Usage: metadata-json-lint [options] metadata.json"
+
+      opts.on("--[no-]strict-license", "Don't fail on strict license check") do |v|
+        options[:strict_license] = v
+      end
+
+      opts.on("--[no-]fail-on-warnings", "Fail on any warnings") do |v|
+        options[:fail_on_warnings] = v
+      end
+    end.parse!
+
+    @options = options
+
+    if ARGV[0].nil?
+      abort("Error: Must provide a metadata.json file to parse")
+    end
+
+    MetadataJsonLint.parse(ARGV.first)
+  end
+  module_function :run
+
+  def parse(metadata)
     f = File.read(metadata)
 
     begin
       parsed = JSON.parse(f)
-    rescue
-      abort("Error: Unable to parse json. There is a syntax error somewhere.")
+    rescue Exception => e
+      abort("Error: Unable to parse metadata.json: #{e.exception}")
     end
 
     # Fields required to be in metadata.json
@@ -24,7 +53,15 @@ module MetadataJsonLint
       end
     end
 
-
+    deps = parsed['dependencies']
+    dep_names = []
+    deps.each do |dep|
+      if dep_names.include?(dep['name'])
+        puts "Error: duplicate dependencies on #{dep['name']}"
+        error_state = true
+      end
+      dep_names << dep['name']
+    end
 
     # Deprecated fields
     # From: https://docs.puppetlabs.com/puppet/latest/reference/modules_publishing.html#write-a-metadatajson-file
@@ -38,10 +75,22 @@ module MetadataJsonLint
       end
     end
 
+    # Shoulds/recommendations
+    # From: https://docs.puppetlabs.com/puppet/latest/reference/modules_publishing.html#write-a-metadatajson-file
+
+    if !parsed['license'].nil? && !SpdxLicenses.exist?(parsed['license'])
+      puts "Warning: License identifier #{parsed['license']} is not in the SPDX list: http://spdx.org/licenses/"
+      error_state = true if @options[:strict_license]
+    end
 
     if error_state
-      abort("Errors found in metadata.json")
+      if @options[:fail_on_warnings] == true
+        abort("Errors found in #{metadata}")
+      else
+        puts "Errors found in #{metadata}"
+      end
     end
 
   end
+  module_function :parse
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metadata-json-lint
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,10 +10,42 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-06 00:00:00.000000000 Z
-dependencies: []
+date: 2014-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spdx-licenses
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Utility to verify Puppet metadata.json files
-email: krum.spencer@gmail.com
+email: nibz@spencerkrum.com
 executables:
 - metadata-json-lint
 extensions: []
@@ -21,9 +53,9 @@ extra_rdoc_files: []
 files:
 - bin/metadata-json-lint
 - lib/metadata_json_lint.rb
-homepage: http://github.com/nibalizer/metadata-json-lint.rb
+homepage: http://github.com/nibalizer/metadata-json-lint
 licenses:
-- Apache 2
+- Apache-2.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -47,3 +79,4 @@ signing_key:
 specification_version: 3
 summary: metadata-json-lint /path/to/metadata.json
 test_files: []
+has_rdoc: