metadata_json_deps 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a7a5bc8b50fa0665c13ff641af0c71eb6a7b8d968712b0f5e1ded9aa97e09d4
-  data.tar.gz: 240b09bfb0f276ad80aade880427ebd242adb17a3dc7f49d185c01b513af9f33
+  metadata.gz: 376a5a0f5181d0d6095b02fd5eb968c8acc887c8f85c1127c80d3fd622ed4a14
+  data.tar.gz: 2a8978e1c706f98b80a82c04e9bc4cb5721d72026ab7089b044d0981e1db16c7
 SHA512:
-  metadata.gz: 62f244b8ad184507bfe491620ce0441fe94f3cd1df6dd152fa3f3deca5d9ad32c2eb069d6c0b002cd79dc2fd0379776a285a212c8bb482773350f938dcab313c
-  data.tar.gz: 0acedb635823a5e5b7c25e29a2c192e237af76739fa6afb7688b593baeba0d89f253b4dd6c5f06992ed609cc9cdd98c2ef396d7681437b9fcdfbe98c740f48ee
+  metadata.gz: d7a981df5b61c4ff15f7f016ce4f90ad5045f47c3556db8d686c6cd5ada2eff218daa240507f73c071f249c255bae1c39073ba04a675bb4426158ca3f9b56b68
+  data.tar.gz: 28fabc4c9c1cfe758875314d137117a7c7b437d39f15e94b160469f2a7fade2a3a59eba9eaa39e4d5f71e054d9aa1df9b760f3c1a7a63db860fbb27d9c0dcdb4

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2017-2021 Ewoud Kohl van Wijngaarden
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -4,18 +4,18 @@ The metadata-json-deps tool validates dependencies in `metadata.json` files in P
 
 ## Compatibility
 
-metadata-json-deps is compatible with Ruby versions 2.0.0 and newer.
+metadata-json-deps is compatible with Ruby versions 2.4.0 and newer.
 
 ## Installation
 
 via `gem` command:
 ``` shell
-gem install metadata-json-deps
+gem install metadata_json_deps
 ```
 
 via Gemfile:
 ``` ruby
-gem 'metadata-json-deps'
+gem 'metadata_json_deps'
 ```
 
 ## Usage
@@ -40,8 +40,10 @@ You can also integrate `metadata-json-deps` checks into your tests using a Rake
 
 ```ruby
 require 'metadata_json_deps'
+
+desc 'Run metadata-json-deps'
 task :metadata_deps do
   files = FileList['modules/*/metadata.json']
-  PuppetMetadataChecker::Runner.run(files)
+  MetadataJsonDeps::run(files)
 end
 ```

data/bin/generate-fixtures-yaml

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'metadata_json_deps'
+
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{opts.program_name} metadata"
+end
+
+parser.parse!
+if ARGV.empty?
+  puts parser.help
+  exit 1
+end
+
+MetadataJsonDeps.build_fixtures(ARGV.first)

data/bin/metadata-json-deps

@@ -5,9 +5,7 @@ require 'metadata_json_deps'
 
 options = {}
 OptionParser.new do |opts|
-  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
-    options[:verbose] = v
-  end
-end.parse!
+  opts.on("-v", "--[no-]verbose", "Run verbosely")
+end.parse!(into: options)
 
-MetadataJsonDeps::Runner.run(ARGV, options[:verbose])
+MetadataJsonDeps.run(ARGV, options[:verbose])

data/lib/metadata_json_deps.rb

@@ -1,5 +1,71 @@
+require 'puppet_forge'
+require 'puppet_metadata'
+
 module MetadataJsonDeps
-  autoload :ForgeVersions, 'metadata_json_deps/forge_versions'
-  autoload :MetadataChecker, 'metadata_json_deps/metadata_checker'
-  autoload :Runner, 'metadata_json_deps/runner'
+  class ForgeVersions
+    def initialize(cache = {})
+      @cache = cache
+    end
+
+    def get_module(name)
+      name = PuppetForge::V3.normalize_name(name)
+      @cache[name] ||= PuppetForge::Module.find(name)
+    end
+  end
+
+  def self.build_fixtures(filename)
+    require 'yaml'
+
+    result = {}
+
+    dependencies = PuppetMetadata.read(filename).dependencies
+    if dependencies.any?
+      forge = ForgeVersions.new
+
+      repositories = {}
+      result['fixtures'] = {'repositories' => repositories}
+
+      dependencies.each do |dependency, _constraint|
+        mod = forge.get_module(dependency)
+        # TODO: The forge should expose the source URL directly
+        repositories[mod.name] = mod.current_release.metadata[:source]
+      end
+    end
+
+    puts result.to_yaml
+  end
+
+  def self.run(filenames, verbose = false)
+    forge = ForgeVersions.new
+
+    filenames.each do |filename|
+      puts "Checking #{filename}"
+      metadata = PuppetMetadata.read(filename)
+
+      metadata.dependencies.map do |dependency, constraint|
+        mod = forge.get_module(dependency)
+
+        if mod.deprecated_at
+          if mod.superseded_by
+            puts "  #{dependency} was superseded by #{mod.superseded_by[:slug]}"
+          elsif mod.deprecated_for
+            puts "  #{dependency} was deprecated: #{mod.deprecated_for}"
+          else
+            puts "  #{dependency} was deprecated"
+          end
+        else
+          current = mod.current_release.version
+
+          if metadata.satisfies_dependency?(dependency, current)
+            if verbose
+              puts "  #{dependency} (#{constraint}) matches #{current}"
+            end
+          else
+            puts "  #{dependency} (#{constraint}) doesn't match #{current}"
+          end
+        end
+      end
+    end
+  rescue Interrupt
+  end
 end

metadata

@@ -1,63 +1,103 @@
 --- !ruby/object:Gem::Specification
 name: metadata_json_deps
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ewoud Kohl van Wijngaarden
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-12-27 00:00:00.000000000 Z
+date: 2022-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet_forge
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
-  name: semantic_puppet
+  name: puppet_metadata
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2'
   type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '13.0'
 description: Verify all your dependencies allow the latest versions on Puppet Forge
 email: ewoud+rubygems@kohlvanwijngaarden.nl
 executables:
+- generate-fixtures-yaml
 - metadata-json-deps
 extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- LICENSE
 - README.md
+- bin/generate-fixtures-yaml
 - bin/metadata-json-deps
 - lib/metadata_json_deps.rb
-- lib/metadata_json_deps/forge_versions.rb
-- lib/metadata_json_deps/metadata_checker.rb
-- lib/metadata_json_deps/runner.rb
 homepage: https://github.com/ekohl/metadata_json_deps
 licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/ekohl/metadata_json_deps
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -65,16 +105,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Check your Puppet metadata dependencies
 test_files: []

data/lib/metadata_json_deps/forge_versions.rb

@@ -1,31 +0,0 @@
-require 'puppet_forge'
-require 'semantic_puppet'
-
-module MetadataJsonDeps
-  class ForgeVersions
-    def initialize(cache = {})
-      @cache = cache
-    end
-
-    def get_current_version(name)
-      name = name.sub('/', '-')
-      version = @cache[name]
-
-      unless version
-        @cache[name] = version = get_version(get_mod(name))
-      end
-
-      version
-    end
-
-    private
-
-    def get_mod(name)
-      PuppetForge::Module.find(name)
-    end
-
-    def get_version(mod)
-      SemanticPuppet::Version.parse(mod.current_release.version)
-    end
-  end
-end

data/lib/metadata_json_deps/metadata_checker.rb

@@ -1,26 +0,0 @@
-require 'semantic_puppet'
-
-module MetadataJsonDeps
-  class MetadataChecker
-    def initialize(metadata, forge)
-      @metadata = metadata
-      @forge = forge
-    end
-
-    def module_dependencies
-      return [] unless @metadata['dependencies']
-
-      @metadata['dependencies'].map do |dep|
-        constraint = dep['version_requirement'] || '>= 0'
-        [dep['name'], SemanticPuppet::VersionRange.parse(constraint)]
-      end
-    end
-
-    def dependencies
-      module_dependencies.map do |dependency, constraint|
-        current = @forge.get_current_version(dependency)
-        [dependency, constraint, current, constraint.include?(current)]
-      end
-    end
-  end
-end

data/lib/metadata_json_deps/runner.rb

@@ -1,32 +0,0 @@
-require 'json'
-
-module MetadataJsonDeps
-  class Runner
-    def initialize(filenames, verbose)
-      @filenames = filenames
-      @verbose = verbose
-      @forge = MetadataJsonDeps::ForgeVersions.new
-    end
-
-    def run
-      @filenames.each do |filename|
-        puts "Checking #{filename}"
-        checker = MetadataJsonDeps::MetadataChecker.new(JSON.parse(File.read(filename)), @forge)
-        checker.dependencies.each do |dependency, constraint, current, satisfied|
-          if satisfied
-            if @verbose
-              puts "  #{dependency} (#{constraint}) matches #{current}"
-            end
-          else
-            puts "  #{dependency} (#{constraint}) doesn't match #{current}"
-          end
-        end
-      end
-    rescue Interrupt
-    end
-
-    def self.run(filenames, verbose = false)
-      self.new(filenames, verbose).run
-    end
-  end
-end