librarian-puppet 5.1.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba4f67ad2636c73bc1518abdf5e8830f1825aeba7b901a6da47979bcaeb5a6a7
-  data.tar.gz: b43000021593835a648e2021762ee09b6f860162b22149f724faf697c6cdaadb
+  metadata.gz: 9b2add44d823f709ce7dea9d14d6a9cd8df605f7b6098be361e4cb79450acc86
+  data.tar.gz: 7d02b688210f4152448290cb0666465301852fb2d01d01aa1d5e48e73ad73f37
 SHA512:
-  metadata.gz: 1306cd3266b6587d4077a66b8f2282b400ffce1ee1eaa87844e261c9f9e9b39926776ea2c76d5d89d7c11958cc9c367fafbb4b9d7be0eb5375795cc2f05eab62
-  data.tar.gz: 805bb0d66ec1df38c5d9a268dbed29d04d0fbe597e5a6ccfc0502c048287c7bfe537687cc0adf44a1fac77e577069d0e7f9c2c58643300f99ea6b208838466fc
+  metadata.gz: f68988df53f966dcb0ca39cc1471e9bc16dfdb5d185ac58be9b6331350525a61c5bd2898ce7f5be3a5bb499cbacf7e5f109ab5946176b2bdaa1ed3f25259b170
+  data.tar.gz: 6d1ec041c030d2ccb2831475e088125bb44a0578d689612eef7bdcafae6449fc1c6e56039c8216711d48a5f5bd9ab4b33c4da77ac8434fded18f8bcddd7f2b60

data/bin/librarian-puppet

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-lib = File.expand_path('../../lib', __FILE__)
+lib = File.expand_path('../lib', __dir__)
 $:.unshift(lib) unless $:.include?(lib)
 
 require 'librarian/puppet/cli'

data/lib/librarian/puppet/action/install.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require 'librarian/action/install'
 
 module Librarian
   module Puppet
     module Action
       class Install < Librarian::Action::Install
-
         private
 
         def create_install_path
@@ -19,7 +20,6 @@ module Librarian
         def check_specfile
           # don't fail if Puppetfile doesn't exist as we'll use metadata.json
         end
-
       end
     end
   end

data/lib/librarian/puppet/action/resolve.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'librarian/action/resolve'
 require 'librarian/puppet/resolver'
 
@@ -9,17 +11,18 @@ module Librarian
 
         def run
           super
-          manifests = environment.lock.manifests.select{ |m| m.name }
-          dupes = manifests.group_by{ |m| module_name(m.name) }.select { |k, v| v.size > 1 }
-          dupes.each do |k,v|
-            warn("Dependency on module '#{k}' is fullfilled by multiple modules and only one will be used: #{v.map{|m|m.name}}")
+          manifests = environment.lock.manifests.select { |m| m.name }
+          dupes = manifests.group_by { |m| module_name(m.name) }.select { |_k, v| v.size > 1 }
+          dupes.each do |k, v|
+            warn("Dependency on module '#{k}' is fullfilled by multiple modules and only one will be used: #{v.map do |m|
+              m.name
+            end}")
           end
         end
 
         def resolver
           Resolver.new(environment)
         end
-
       end
     end
   end

data/lib/librarian/puppet/action.rb

@@ -1,2 +1,4 @@
-require "librarian/puppet/action/install"
-require "librarian/puppet/action/resolve"
+# frozen_string_literal: true
+
+require 'librarian/puppet/action/install'
+require 'librarian/puppet/action/resolve'

data/lib/librarian/puppet/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'librarian/helpers'
 
 require 'librarian/cli'
@@ -18,79 +20,73 @@ module Librarian
       include Particularity
       extend Particularity
 
-      source_root Pathname.new(__FILE__).dirname.join("templates")
+      source_root Pathname.new(__FILE__).dirname.join('templates')
 
       def init
         copy_file environment.specfile_name
 
-        if File.exist? ".gitignore"
-          gitignore = File.read('.gitignore').split("\n")
-        else
-          gitignore = []
-        end
+        gitignore = if File.exist? '.gitignore'
+                      File.read('.gitignore').split("\n")
+                    else
+                      []
+                    end
 
-        gitignore << ".tmp/" unless gitignore.include? ".tmp/"
-        gitignore << "modules/" unless gitignore.include? "modules/"
+        gitignore << '.tmp/' unless gitignore.include? '.tmp/'
+        gitignore << 'modules/' unless gitignore.include? 'modules/'
 
-        File.open(".gitignore", 'w') do |f|
+        File.open('.gitignore', 'w') do |f|
           f.puts gitignore.join("\n")
         end
       end
 
-      desc "install", "Resolves and installs all of the dependencies you specify."
-      option "quiet", :type => :boolean, :default => false
-      option "verbose", :type => :boolean, :default => false
-      option "line-numbers", :type => :boolean, :default => false
-      option "clean", :type => :boolean, :default => false
-      option "strip-dot-git", :type => :boolean
-      option "path", :type => :string
-      option "destructive", :type => :boolean, :default => false
-      option "local", :type => :boolean, :default => false
-      option "use-v1-api", :type => :boolean, :default => false
+      desc 'install', 'Resolves and installs all of the dependencies you specify.'
+      option 'quiet', type: :boolean, default: false
+      option 'verbose', type: :boolean, default: false
+      option 'line-numbers', type: :boolean, default: false
+      option 'clean', type: :boolean, default: false
+      option 'strip-dot-git', type: :boolean
+      option 'path', type: :string
+      option 'destructive', type: :boolean, default: false
+      option 'local', type: :boolean, default: false
+      option 'use-v1-api', type: :boolean, default: false
       def install
-
         ensure!
-        clean! if options["clean"]
-        unless options["destructive"].nil?
-          environment.config_db.local['destructive'] = options['destructive'].to_s
-        end
-        if options.include?("strip-dot-git")
-          strip_dot_git_val = options["strip-dot-git"] ? "1" : nil
-          environment.config_db.local["install.strip-dot-git"] = strip_dot_git_val
-        end
-        if options.include?("path")
-          environment.config_db.local["path"] = options["path"]
+        clean! if options['clean']
+        environment.config_db.local['destructive'] = options['destructive'].to_s unless options['destructive'].nil?
+        if options.include?('strip-dot-git')
+          strip_dot_git_val = options['strip-dot-git'] ? '1' : nil
+          environment.config_db.local['install.strip-dot-git'] = strip_dot_git_val
         end
+        environment.config_db.local['path'] = options['path'] if options.include?('path')
 
         environment.config_db.local['use-v1-api'] = options['use-v1-api'] ? '1' : nil
         environment.config_db.local['mode'] = options['local'] ? 'local' : nil
 
         resolve!
-        debug { "Install: dependencies resolved"}
+        debug { 'Install: dependencies resolved' }
         install!
       end
 
-      desc "update", "Updates and installs the dependencies you specify."
-      option "verbose", :type => :boolean, :default => false
-      option "line-numbers", :type => :boolean, :default => false
-      option "use-v1-api", :type => :boolean, :default => false
+      desc 'update', 'Updates and installs the dependencies you specify.'
+      option 'verbose', type: :boolean, default: false
+      option 'line-numbers', type: :boolean, default: false
+      option 'use-v1-api', type: :boolean, default: false
       def update(*names)
-
         environment.config_db.local['use-v1-api'] = options['use-v1-api'] ? '1' : nil
 
-        warn("Usage of module/name is deprecated, use module-name") if names.any? {|n| n.include?("/")}
+        warn('Usage of module/name is deprecated, use module-name') if names.any? { |n| n.include?('/') }
         # replace / to - in the module names
-        super(*names.map{|n| normalize_name(n)})
+        super(*names.map { |n| normalize_name(n) })
       end
 
-      desc "package", "Cache the puppet modules in vendor/puppet/cache."
-      option "quiet", :type => :boolean, :default => false
-      option "verbose", :type => :boolean, :default => false
-      option "line-numbers", :type => :boolean, :default => false
-      option "clean", :type => :boolean, :default => false
-      option "strip-dot-git", :type => :boolean
-      option "path", :type => :string
-      option "destructive", :type => :boolean, :default => false
+      desc 'package', 'Cache the puppet modules in vendor/puppet/cache.'
+      option 'quiet', type: :boolean, default: false
+      option 'verbose', type: :boolean, default: false
+      option 'line-numbers', type: :boolean, default: false
+      option 'clean', type: :boolean, default: false
+      option 'strip-dot-git', type: :boolean
+      option 'path', type: :string
+      option 'destructive', type: :boolean, default: false
       def package
         environment.vendor!
         install
@@ -104,10 +100,11 @@ module Librarian
 
       # override the actions to use our own
 
-      def install!(options = { })
+      def install!(options = {})
         Action::Install.new(environment, options).run
       end
-      def resolve!(options = { })
+
+      def resolve!(options = {})
         Action::Resolve.new(environment, options).run
       end
     end

data/lib/librarian/puppet/dependency.rb

@@ -1,8 +1,8 @@
+# frozen_string_literal: true
+
 module Librarian
   module Puppet
-
     class Dependency < Librarian::Dependency
-
       include Librarian::Puppet::Util
 
       attr_accessor :parent
@@ -10,7 +10,7 @@ module Librarian
 
       def initialize(name, requirement, source, parent = nil)
         # Issue #235 fail if forge source is not defined
-        raise Error, "forge entry is not defined in Puppetfile" if source.instance_of?(Array) && source.empty?
+        raise Error, 'forge entry is not defined in Puppetfile' if source.instance_of?(Array) && source.empty?
 
         self.parent = parent
         super(normalize_name(name), requirement, source)
@@ -19,8 +19,6 @@ module Librarian
       def to_s
         "#{name} (#{requirement}) <#{source}> (from #{parent.nil? ? '<nil>' : parent})"
       end
-
     end
-
   end
 end

data/lib/librarian/puppet/dsl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'librarian/dsl'
 require 'librarian/dsl/target'
 require 'librarian/puppet/source'
@@ -6,18 +8,17 @@ require 'librarian/puppet/dependency'
 module Librarian
   module Puppet
     class Dsl < Librarian::Dsl
-
-      FORGE_URL = "https://forgeapi.puppet.com"
+      FORGE_URL = 'https://forgeapi.puppet.com'
 
       dependency :mod
 
-      source :forge => Source::Forge
-      source :git => Source::Git
-      source :path => Source::Path
-      source :github_tarball => Source::GitHubTarball
+      source forge: Source::Forge
+      source git: Source::Git
+      source path: Source::Path
+      source github_tarball: Source::GitHubTarball
 
       def default_specfile
-        Proc.new do
+        proc do
           forge FORGE_URL
           metadata
         end
@@ -29,8 +30,10 @@ module Librarian
 
       def post_process_target(target)
         # save the default forge defined
-        default_forge = target.sources.select {|s| s.is_a? Librarian::Puppet::Source::Forge}.first
-        Librarian::Puppet::Source::Forge.default = default_forge || Librarian::Puppet::Source::Forge.from_lock_options(environment, :remote => FORGE_URL)
+        default_forge = target.sources.select { |s| s.is_a? Librarian::Puppet::Source::Forge }.first
+        Librarian::Puppet::Source::Forge.default = default_forge || Librarian::Puppet::Source::Forge.from_lock_options(
+          environment, remote: FORGE_URL
+        )
       end
 
       def receiver(target)
@@ -38,15 +41,18 @@ module Librarian
       end
 
       def run(specfile = nil, sources = [])
-        specfile, sources = nil, specfile if specfile.kind_of?(Array) && sources.empty?
+        if specfile.is_a?(Array) && sources.empty?
+          sources = specfile
+          specfile = nil
+        end
 
         Target.new(self).tap do |target|
           target.precache_sources(sources)
-          debug_named_source_cache("Pre-Cached Sources", target)
+          debug_named_source_cache('Pre-Cached Sources', target)
 
           specfile ||= Proc.new if block_given?
 
-          if specfile.kind_of?(Pathname) and !File.exist?(specfile)
+          if specfile.is_a?(Pathname) and !File.exist?(specfile)
             debug { "Specfile #{specfile} not found, using defaults" } unless specfile.nil?
             receiver(target).run(specfile, &default_specfile)
           else
@@ -55,7 +61,7 @@ module Librarian
 
           post_process_target(target)
 
-          debug_named_source_cache("Post-Cached Sources", target)
+          debug_named_source_cache('Post-Cached Sources', target)
         end.to_spec
       end
 
@@ -73,7 +79,7 @@ module Librarian
 
         # save the specfile and call librarian
         def run(specfile = nil)
-          @working_path = specfile.kind_of?(Pathname) ? specfile.parent : Pathname.new(Dir.pwd)
+          @working_path = specfile.is_a?(Pathname) ? specfile.parent : Pathname.new(Dir.pwd)
           @specfile = specfile
           super
         end
@@ -81,9 +87,8 @@ module Librarian
         # implement the 'metadata' syntax for Puppetfile
         def metadata
           f = working_path.join('metadata.json')
-          unless File.exist?(f)
-            raise Error, "Metadata file does not exist: #{f}"
-          end
+          raise Error, "Metadata file does not exist: #{f}" unless File.exist?(f)
+
           begin
             json = JSON.parse(File.read(f))
           rescue JSON::ParserError => e

data/lib/librarian/puppet/environment.rb

@@ -1,14 +1,15 @@
-require "librarian/environment"
-require "librarian/puppet/dsl"
-require "librarian/puppet/source"
-require "librarian/puppet/lockfile"
+# frozen_string_literal: true
+
+require 'librarian/environment'
+require 'librarian/puppet/dsl'
+require 'librarian/puppet/source'
+require 'librarian/puppet/lockfile'
 
 module Librarian
   module Puppet
     class Environment < Librarian::Environment
-
       def adapter_name
-        "puppet"
+        'puppet'
       end
 
       def lockfile
@@ -20,12 +21,12 @@ module Librarian
       end
 
       def tmp_path
-        part = config_db["tmp"] || ".tmp"
+        part = config_db['tmp'] || '.tmp'
         project_path.join(part)
       end
 
       def install_path
-        part = config_db["path"] || "modules"
+        part = config_db['path'] || 'modules'
         project_path.join(part)
       end
 

data/lib/librarian/puppet/extension.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'librarian/puppet/environment'
 require 'librarian/action/base'
 

data/lib/librarian/puppet/lockfile.rb

@@ -1,17 +1,17 @@
+# frozen_string_literal: true
+
 # Extend Lockfile to normalize module names from acme/mod to acme-mod
 module Librarian
   module Puppet
     class Lockfile < Librarian::Lockfile
-
       # Extend the parser to normalize module names in old .lock files, converting / to -
       class Parser < Librarian::Lockfile::Parser
-
         include Librarian::Puppet::Util
 
         def extract_and_parse_sources(lines)
           sources = super
           sources.each do |source|
-            source[:manifests] = Hash[source[:manifests].map do |name,manifest|
+            source[:manifests] = Hash[source[:manifests].map do |name, manifest|
               [normalize_name(name), manifest]
             end]
           end
@@ -23,13 +23,15 @@ module Librarian
           class << manifests_index
             include Librarian::Puppet::Util
             alias_method :old_lookup, :[]
-            define_method(:[]) { |k| self.old_lookup(normalize_name(k)) }
+            define_method(:[]) { |k| old_lookup(normalize_name(k)) }
           end
           dependencies = []
-          while lines.first =~ /^ {2}([\w\-\/]+)(?: \((.*)\))?$/
+          while lines.first =~ %r{^ {2}([\w\-/]+)(?: \((.*)\))?$}
             lines.shift
-            name, requirement = $1, $2.split(/,\s*/)
-            dependencies << environment.dsl_class.dependency_type.new(name, requirement, manifests_index[name].source, 'lockfile')
+            name = ::Regexp.last_match(1)
+            requirement = ::Regexp.last_match(2).split(/,\s*/)
+            dependencies << environment.dsl_class.dependency_type.new(name, requirement, manifests_index[name].source,
+                                                                      'lockfile')
           end
           dependencies
         end
@@ -41,12 +43,12 @@ module Librarian
             source = source_type.from_lock_options(environment, source_ast[:options])
             source_ast[:manifests].each do |manifest_name, manifest_ast|
               manifests[manifest_name] = ManifestPlaceholder.new(
-                  source,
-                  manifest_name,
-                  manifest_ast[:version],
-                  manifest_ast[:dependencies].map do |k, v|
-                    environment.dsl_class.dependency_type.new(k, v, nil, manifest_name)
-                  end
+                source,
+                manifest_name,
+                manifest_ast[:version],
+                manifest_ast[:dependencies].map do |k, v|
+                  environment.dsl_class.dependency_type.new(k, v, nil, manifest_name)
+                end,
               )
             end
           end
@@ -56,7 +58,7 @@ module Librarian
         def compile(sources_ast)
           manifests = compile_placeholder_manifests(sources_ast)
           manifests = manifests.map do |name, manifest|
-            dependencies = manifest.dependencies.map do |d|
+            manifest.dependencies.map do |d|
               environment.dsl_class.dependency_type.new(d.name, d.requirement, manifests[d.name].source, name)
             end
             real = Manifest.new(manifest.source, manifest.name)
@@ -66,13 +68,11 @@ module Librarian
           end
           ManifestSet.sort(manifests)
         end
-
       end
 
       def load(string)
         Parser.new(environment).parse(string)
       end
-
     end
   end
 end

data/lib/librarian/puppet/resolver.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 require 'librarian/resolver'
 
 module Librarian
   module Puppet
     class Resolver < Librarian::Resolver
-
       class Implementation < Librarian::Resolver::Implementation
         def sourced_dependency_for(dependency)
           return dependency if dependency.source
@@ -14,7 +15,7 @@ module Librarian
       end
 
       def implementation(spec)
-        Implementation.new(self, spec, :cyclic => cyclic)
+        Implementation.new(self, spec, cyclic: cyclic)
       end
     end
   end

data/lib/librarian/puppet/source/forge/repo.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'open-uri'
 require 'librarian/puppet/util'
@@ -12,11 +14,12 @@ module Librarian
 
           def versions
             return @versions if @versions
+
             @versions = get_versions
             if @versions.empty?
               info { "No versions found for module #{name}" }
             else
-              debug { "  Module #{name} found versions: #{@versions.join(", ")}" }
+              debug { "  Module #{name} found versions: #{@versions.join(', ')}" }
             end
             @versions
           end
@@ -49,24 +52,19 @@ module Librarian
               raise Error, "Could not find a local copy of #{name} at #{version}."
             end
 
-            if environment.vendor?
-              vendor_cache(name, version) unless vendored?(name, version)
-            end
+            vendor_cache(name, version) if environment.vendor? && !vendored?(name, version)
 
             cache_version_unpacked! version
 
-            if install_path.exist? && rsync? != true
-              install_path.rmtree
-            end
+            install_path.rmtree if install_path.exist? && rsync? != true
 
             unpacked_path = version_unpacked_cache_path(version).join(module_name(name))
 
             unless unpacked_path.exist?
               raise Error, "#{unpacked_path} does not exist, something went wrong. Try removing it manually"
-            else
-              cp_r(unpacked_path, install_path)
             end
 
+            cp_r(unpacked_path, install_path)
           end
 
           def cache_version_unpacked!(version)
@@ -79,9 +77,13 @@ module Librarian
 
             module_repository = source.uri.to_s
 
-            command = %W{puppet module install --version #{version} --target-dir}
-            command.push(*[path.to_s, "--module_repository", module_repository, "--modulepath", path.to_s, "--module_working_dir", path.to_s, "--ignore-dependencies", target])
-            debug { "Executing puppet module install for #{name} #{version}: #{command.join(" ").gsub(module_repository, source.to_s)}" }
+            command = %W[puppet module install --version #{version} --target-dir]
+            command.push(path.to_s, '--module_repository', module_repository, '--modulepath', path.to_s,
+                         '--module_working_dir', path.to_s, '--ignore-dependencies', target)
+            debug do
+              "Executing puppet module install for #{name} #{version}: #{command.join(' ').gsub(module_repository,
+                                                                                                source.to_s)}"
+            end
 
             begin
               Librarian::Posix.run!(command)
@@ -89,24 +91,24 @@ module Librarian
               # Rollback the directory if the puppet module had an error
               begin
                 path.unlink
-              rescue => u
+              rescue StandardError => u
                 debug("Unable to rollback path #{path}: #{u}")
               end
-              tar = Dir[File.join(path.to_s, "**/*.tar.gz")]
-              msg = ""
+              tar = Dir[File.join(path.to_s, '**/*.tar.gz')]
+              msg = ''
               if e.message =~ /Unexpected EOF in archive/ and !tar.empty?
                 file = tar.first
                 msg = " (looks like an incomplete download of #{file})"
               end
-              raise Error, "Error executing puppet module install#{msg}. Check that this command succeeds:\n#{command.join(" ")}\nError:\n#{e.message}"
+              raise Error,
+                    "Error executing puppet module install#{msg}. Check that this command succeeds:\n#{command.join(' ')}\nError:\n#{e.message}"
             end
-
           end
 
           def vendor_cache(name, version)
             url = url(name, version)
             path = vendored_path(name, version).to_s
-            debug { "Downloading #{url} into #{path}"}
+            debug { "Downloading #{url} into #{path}" }
             environment.vendor!
             File.open(path, 'wb') do |f|
               URI.open(url, 'rb') do |input|
@@ -114,7 +116,6 @@ module Librarian
               end
             end
           end
-
         end
       end
     end