dependency_checker 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd47b3f349f0a15ba2992970b7e38c5227e2c001c2923e9de00275d95bbd1ea3
-  data.tar.gz: 05aa4dffcaafb836cd296be47fb713f3b58988f1db7c883481103fa4d84b0e43
+  metadata.gz: 79a4284f0fa84b9fbae522c47bc63b806b4806ded5f5d3d4d2d273504fbadf94
+  data.tar.gz: 3235d404eb2c14c0d05e56611c7f7dd8525623989b05501952c8b8ca708d64ef
 SHA512:
-  metadata.gz: '059bb4192c99662c50f3fcde3ee787d166bf46957b37a2d02d2c0bc9438220ecea9a73fc00026e413a89ebaf5946bc910d5e12d5277bb11296600c49d4e40446'
-  data.tar.gz: e29a530b9c3a24e3ef6956bc384c4fad075eec3f47b49e45fd5ea6bfc76081c0f101d9a3d70a35b09d22dd93832845575473f3c876c6265d863fff5264047fb9
+  metadata.gz: 355d20059ecdad7f41134505fe4785758ef35e0c1610865c48c48a908fdca0dae49fe4e0a6fd4fdcdbd87b7c7d589306dc270985cc4a4284e6d003243d480765
+  data.tar.gz: 786cf7645ac33bede20ab1f158fd2a354d96e7eb2450daf5163c717d4b62872f7a5ce20f918848308bdf3aec1555f470e6078d9c70b76e747f1aea91df9ee179

data/README.md

@@ -85,3 +85,6 @@ task :metadata_deps do
   runner.run
 end
 ```
+## License
+
+This codebase is licensed under Apache 2.0. However, the open source dependencies included in this codebase might be subject to other software licenses such as AGPL, GPL2.0, and MIT.

data/bin/dependency-checker

@@ -7,19 +7,23 @@ require 'json'
 
 options = {}
 OptionParser.new do |opts|
-  opts.on('-o module,version', '--override module,version', Array, 'Forge name of module and semantic version to override') do |override|
+  opts.on('-o module,version', '--override module,version', Array,
+          'Forge name of module and semantic version to override') do |override|
     options[:override] = override
   end
 
-  opts.on('-c', '--current', 'Extract override version from metadata.json inside current working directory') do |current_override|
+  opts.on('-c', '--current',
+          'Extract override version from metadata.json inside current working directory') do |current_override|
     options[:current_override] = current_override
   end
 
-  opts.on('-n', '--namespace namespace', 'Check all modules in a given namespace (filter with endorsements).') do |namespace|
+  opts.on('-n', '--namespace namespace',
+          'Check all modules in a given namespace (filter with endorsements).') do |namespace|
     options[:namespace] = namespace
   end
 
-  opts.on('--endorsement endorsement', 'Filter a namespace search by endorsement (supported/approved/partner).') do |endorsement|
+  opts.on('--endorsement endorsement',
+          'Filter a namespace search by endorsement (supported/approved/partner).') do |endorsement|
     raise 'You may only filter by one endorsement at a time' if options[:endorsement]
 
     options[:endorsement] = endorsement
@@ -43,11 +47,13 @@ OptionParser.new do |opts|
     options[:endorsement] = 'partner'
   end
 
-  opts.on('--ft forge_token', '--forge-token forge_token', 'The API token to authenticate the Forge connection with') do |forge_token|
+  opts.on('--ft forge_token', '--forge-token forge_token',
+          'The API token to authenticate the Forge connection with') do |forge_token|
     options[:forge_token] = forge_token
   end
 
-  opts.on('--fh forge_hostname', '--forge-hostname forge_hostname', 'Specify a specific Forge hostname to overwrite the default of https://forgeapi.puppet.com') do |forge_hostname|
+  opts.on('--fh forge_hostname', '--forge-hostname forge_hostname',
+          'Specify a specific Forge hostname to overwrite the default of https://forgeapi.puppet.com') do |forge_hostname|
     raise 'Forge host must be specified in the format https://your-own-api.url/' unless forge_hostname.start_with? 'http'
 
     options[:forge_hostname] = forge_hostname
@@ -64,7 +70,10 @@ OptionParser.new do |opts|
 end.parse!
 
 # Raise error if both :override and :current_override are specified
-raise OptionParser::InvalidOption, 'You can not select both override and current override options' if options[:override] && options[:current_override]
+if options[:override] && options[:current_override]
+  raise OptionParser::InvalidOption,
+        'You can not select both override and current override options'
+end
 
 # If :current_override is specified, retrieve name and version of module in current working directory
 if options[:current_override]
@@ -74,7 +83,10 @@ if options[:current_override]
 
   override_check = metadata_json.is_a?(Hash) && !metadata_json.empty?
   options[:override] = [module_name, module_version] if override_check
-  raise OptionParser::InvalidOption, 'Unable to find local metadata.json in current working directory' unless override_check
+  unless override_check
+    raise OptionParser::InvalidOption,
+          'Unable to find local metadata.json in current working directory'
+  end
 end
 
 # Default :verbose to false

data/lib/dependency_checker/metadata_checker.rb

@@ -4,6 +4,20 @@ require 'semantic_puppet'
 
 # Checks dependencies of passed in metadata and performs checks to verify constraints
 module DependencyChecker
+  # Class for checking metadata in the dependency checker.
+  #
+  # The MetadataChecker class is responsible for performing checks on metadata
+  # files in the context of the dependency checker. It includes methods for
+  # verifying metadata information such as module name, version, and dependencies.
+  #
+  # Example usage:
+  #
+  #   checker = DependencyChecker::MetadataChecker.new
+  #   result = checker.check_metadata(metadata_hash)
+  #   puts result.message if result.failed?
+  #
+  # @author Ewoud Kohl van Wijngaarden <ewoud@kohlvanwijngaarden.nl>
+  # @since 1.0.0
   class MetadataChecker
     def initialize(metadata, forge, updated_module, updated_module_version)
       @metadata = metadata

data/lib/dependency_checker/runner.rb

@@ -35,13 +35,17 @@ module DependencyChecker
       @updated_module, @updated_module_version = override
 
       raise '*Error:* Pass an override in the form `--override module,version`' unless override.size == 2
-      raise "*Error:* Could not find *#{@updated_module}* on Puppet Forge! Ensure updated_module argument is valid." unless check_module_exists(@updated_module)
+      unless check_module_exists(@updated_module)
+        raise "*Error:* Could not find *#{@updated_module}* on Puppet Forge! Ensure updated_module argument is valid."
+      end
       unless SemanticPuppet::Version.valid?(@updated_module_version)
         raise "*Error:* Verify semantic versioning syntax *#{@updated_module_version}* of updated_module_version argument."
       end
 
       puts "Overriding *#{@updated_module}* version with *#{@updated_module_version}*\n\n"
-      puts "The module you are comparing against *#{@updated_module}* is *deprecated*.\n\n" if @forge.check_module_deprecated(@updated_module)
+      return unless @forge.check_module_deprecated(@updated_module)
+
+      puts "The module you are comparing against *#{@updated_module}* is *deprecated*.\n\n"
     end
 
     def run

data/lib/dependency_checker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DependencyChecker
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: dependency_checker
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Ewoud Kohl van Wijngaarden
 - Puppet
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-09 00:00:00.000000000 Z
+date: 2026-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel
@@ -34,7 +34,7 @@ dependencies:
         version: '2.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -44,7 +44,7 @@ dependencies:
         version: '2.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -96,7 +96,8 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/puppetlabs/dependency_checker
-post_install_message: 
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -104,15 +105,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: Check your Puppet metadata dependencies
 test_files: []