pdk 2.7.1 → 3.0.0

data/lib/pdk/cli/exec/interactive_command.rb

@@ -4,6 +4,7 @@ module PDK
   module CLI
     module Exec
       class InteractiveCommand < Command
+        # rubocop :disable Lint/MissingSuper
         def initialize(*argv)
           @argv = argv
 
@@ -13,6 +14,7 @@ module PDK
           # Extra environment vars to add to base set.
           @environment = {}
         end
+        # rubocop :enable Lint/MissingSuper
 
         def register_spinner(_spinner, _opts = {})
           raise 'This method is not implemented for PDK::CLI::Exec::InteractiveCommand'
@@ -42,9 +44,7 @@ module PDK
           if [:module, :pwd].include?(context)
             mod_root = PDK::Util.module_root
 
-            unless mod_root
-              raise PDK::CLI::FatalError, 'Current working directory is not part of a module. (No metadata.json was found.)'
-            end
+            raise PDK::CLI::FatalError, 'Current working directory is not part of a module. (No metadata.json was found.)' unless mod_root
 
             unless context == :pwd || Dir.pwd == mod_root
               orig_workdir = Dir.pwd
@@ -61,7 +61,7 @@ module PDK
             stdout: nil,
             stderr: nil,
             exit_code: result[:exit_code],
-            duration: result[:duration],
+            duration: result[:duration]
           }
         ensure
           Dir.chdir(orig_workdir) if orig_workdir
@@ -72,7 +72,7 @@ module PDK
         # TODO: debug logging
         def run_process!
           command_string = argv.join(' ')
-          PDK.logger.debug("Executing '%{command}' interactively" % { command: command_string })
+          PDK.logger.debug(format("Executing '%{command}' interactively", command: command_string))
 
           if context == :module
             PDK.logger.debug('Command environment:')
@@ -88,13 +88,8 @@ module PDK
           exit_code = child_status.exitstatus
           duration = Time.now - start_time
 
-          PDK.logger.debug("Execution of '%{command}' complete (duration: \
-                              %{duration_in_seconds}s; exit code: %{exit_code})" %
-                              {
-                                command: command_string,
-                                exit_code: exit_code,
-                                duration_in_seconds: duration,
-                              })
+          PDK.logger.debug(format("Execution of '%{command}' complete (duration: \
+                              %{duration_in_seconds}s; exit code: %{exit_code})", command: command_string, exit_code: exit_code, duration_in_seconds: duration))
 
           { exit_code: exit_code, duration: duration }
         end

data/lib/pdk/cli/exec.rb

@@ -33,9 +33,7 @@ module PDK
       def self.ensure_bin_present!(bin_path, bin_name)
         require 'tty-which'
 
-        message = 'Unable to find `%{name}`. Check that it is installed and try again.' % {
-          name: bin_name,
-        }
+        message = format('Unable to find `%{name}`. Check that it is installed and try again.', name: bin_name)
 
         raise PDK::CLI::FatalError, message unless TTY::Which.exist?(bin_path)
       end
@@ -59,9 +57,7 @@ module PDK
         require 'pdk/util'
 
         unless PDK::Util.package_install?
-          PDK.logger.debug("PDK package installation not found. Trying '%{fallback}' from the system PATH instead." % {
-            fallback: fallback,
-          })
+          PDK.logger.debug(format("PDK package installation not found. Trying '%{fallback}' from the system PATH instead.", fallback: fallback))
           return fallback
         end
 
@@ -69,14 +65,11 @@ module PDK
 
         require 'pdk/util/filesystem'
         unless PDK::Util::Filesystem.exist?(vendored_bin_full_path)
-          PDK.logger.debug("Could not find '%{vendored_bin}' in PDK package. Trying '%{fallback}' from the system PATH instead." % {
-            fallback: fallback,
-            vendored_bin: vendored_bin_full_path,
-          })
+          PDK.logger.debug(format("Could not find '%{vendored_bin}' in PDK package. Trying '%{fallback}' from the system PATH instead.", fallback: fallback, vendored_bin: vendored_bin_full_path))
           return fallback
         end
 
-        PDK.logger.debug "Using '%{vendored_bin}' from PDK package." % { vendored_bin: vendored_bin_full_path }
+        PDK.logger.debug format("Using '%{vendored_bin}' from PDK package.", vendored_bin: vendored_bin_full_path)
         vendored_bin_full_path
       end
     end

data/lib/pdk/cli/exec_group.rb

@@ -37,8 +37,8 @@ module PDK
       # @param block [Block] A block of ruby to execute
       #
       # @api private
-      def register(&_block)
-        raise PDK::CLI::FatalError, 'No block registered' unless block_given?
+      def register(&block)
+        raise PDK::CLI::FatalError, 'No block registered' unless block
       end
 
       # The return code of running all registered blocks
@@ -95,6 +95,7 @@ module PDK
       def exit_code
         @threads.each(&:join)
         return 0 if @exit_codes.empty?
+
         @exit_codes.max
       end
     end

data/lib/pdk/cli/get/config.rb

@@ -1,24 +1,26 @@
-module PDK::CLI
-  @get_config_cmd = @get_cmd.define_command do
-    name 'config'
-    usage 'config [name]'
-    summary 'Retrieve the configuration for <name>. If not specified, retrieve all configuration settings'
+module PDK
+  module CLI
+    @get_config_cmd = @get_cmd.define_command do
+      name 'config'
+      usage 'config [name]'
+      summary 'Retrieve the configuration for <name>. If not specified, retrieve all configuration settings'
 
-    run do |_opts, args, _cmd|
-      item_name = args[0]
-      resolved_config = PDK.config.resolve(item_name)
-      # If the user wanted to know a setting but it doesn't exist, raise an error
-      if resolved_config.empty? && !item_name.nil?
-        PDK.logger.error("Configuration item '%{name}' does not exist" % { name: item_name })
-        exit 1
+      run do |_opts, args, _cmd|
+        item_name = args[0]
+        resolved_config = PDK.config.resolve(item_name)
+        # If the user wanted to know a setting but it doesn't exist, raise an error
+        if resolved_config.empty? && !item_name.nil?
+          PDK.logger.error(format("Configuration item '%{name}' does not exist", name: item_name))
+          exit 1
+        end
+        # If the user requested a setting and it's the only one resolved, then just output the value
+        if resolved_config.count == 1 && resolved_config.keys[0] == item_name
+          puts format('%{value}', value: resolved_config.values[0])
+          exit 0
+        end
+        # Otherwise just output everything
+        resolved_config.keys.sort.each { |key| puts format('%{name}=%{value}', name: key, value: resolved_config[key]) }
       end
-      # If the user requested a setting and it's the only one resolved, then just output the value
-      if resolved_config.count == 1 && resolved_config.keys[0] == item_name
-        puts '%{value}' % { value: resolved_config.values[0] }
-        exit 0
-      end
-      # Otherwise just output everything
-      resolved_config.keys.sort.each { |key| puts '%{name}=%{value}' % { name: key, value: resolved_config[key] } }
     end
   end
 end

data/lib/pdk/cli/get.rb

@@ -1,20 +1,22 @@
-module PDK::CLI
-  @get_cmd = @base_cmd.define_command do
-    name 'get'
-    usage 'get [subcommand] [options]'
-    summary 'Retrieve information about the PDK or current project.'
-    default_subcommand 'help'
+module PDK
+  module CLI
+    @get_cmd = @base_cmd.define_command do
+      name 'get'
+      usage 'get [subcommand] [options]'
+      summary 'Retrieve information about the PDK or current project.'
+      default_subcommand 'help'
 
-    run do |_opts, args, _cmd|
-      if args == ['help']
-        PDK::CLI.run(%w[get --help])
-        exit 0
-      end
+      run do |_opts, args, _cmd|
+        if args == ['help']
+          PDK::CLI.run(['get', '--help'])
+          exit 0
+        end
 
-      PDK::CLI.run(%w[get help]) if args.empty?
+        PDK::CLI.run(['get', 'help']) if args.empty?
+      end
     end
+    @get_cmd.add_command Cri::Command.new_basic_help
   end
-  @get_cmd.add_command Cri::Command.new_basic_help
 end
 
 require 'pdk/cli/get/config'

data/lib/pdk/cli/new/class.rb

@@ -1,32 +1,32 @@
-module PDK::CLI
-  @new_class_cmd = @new_cmd.define_command do
-    name 'class'
-    usage 'class [options] <class_name>'
-    summary 'Create a new class named <class_name> using given options'
+module PDK
+  module CLI
+    @new_class_cmd = @new_cmd.define_command do
+      name 'class'
+      usage 'class [options] <class_name>'
+      summary 'Create a new class named <class_name> using given options'
 
-    run do |opts, args, _cmd|
-      require 'pdk/generate/puppet_class'
+      run do |opts, args, _cmd|
+        require 'pdk/generate/puppet_class'
 
-      PDK::CLI::Util.ensure_in_module!(
-        message:   'Classes can only be created from inside a valid module directory.',
-        log_level: :info,
-      )
+        PDK::CLI::Util.ensure_in_module!(
+          message: 'Classes can only be created from inside a valid module directory.',
+          log_level: :info
+        )
 
-      class_name = args[0]
+        class_name = args[0]
 
-      if class_name.nil? || class_name.empty?
-        puts command.help
-        exit 1
-      end
+        if class_name.nil? || class_name.empty?
+          puts command.help
+          exit 1
+        end
 
-      unless Util::OptionValidator.valid_class_name?(class_name)
-        raise PDK::CLI::ExitWithError, "'%{name}' is not a valid class name" % { name: class_name }
-      end
+        raise PDK::CLI::ExitWithError, format("'%{name}' is not a valid class name", name: class_name) unless Util::OptionValidator.valid_class_name?(class_name)
 
-      PDK::CLI::Util.analytics_screen_view('new_class', opts)
+        PDK::CLI::Util.analytics_screen_view('new_class', opts)
 
-      updates = PDK::Generate::PuppetClass.new(PDK.context, class_name, opts).run
-      PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
+        updates = PDK::Generate::PuppetClass.new(PDK.context, class_name, opts).run
+        PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
+      end
     end
   end
 end

data/lib/pdk/cli/new/defined_type.rb

@@ -1,32 +1,32 @@
-module PDK::CLI
-  @new_define_cmd = @new_cmd.define_command do
-    name 'defined_type'
-    usage 'defined_type [options] <name>'
-    summary 'Create a new defined type named <name> using given options'
+module PDK
+  module CLI
+    @new_define_cmd = @new_cmd.define_command do
+      name 'defined_type'
+      usage 'defined_type [options] <name>'
+      summary 'Create a new defined type named <name> using given options'
 
-    run do |opts, args, _cmd|
-      PDK::CLI::Util.ensure_in_module!(
-        message: 'Defined types can only be created from inside a valid module directory.',
-        log_level: :info,
-      )
+      run do |opts, args, _cmd|
+        PDK::CLI::Util.ensure_in_module!(
+          message: 'Defined types can only be created from inside a valid module directory.',
+          log_level: :info
+        )
 
-      defined_type_name = args[0]
+        defined_type_name = args[0]
 
-      if defined_type_name.nil? || defined_type_name.empty?
-        puts command.help
-        exit 1
-      end
+        if defined_type_name.nil? || defined_type_name.empty?
+          puts command.help
+          exit 1
+        end
 
-      unless Util::OptionValidator.valid_defined_type_name?(defined_type_name)
-        raise PDK::CLI::ExitWithError, "'%{name}' is not a valid defined type name" % { name: defined_type_name }
-      end
+        raise PDK::CLI::ExitWithError, format("'%{name}' is not a valid defined type name", name: defined_type_name) unless Util::OptionValidator.valid_defined_type_name?(defined_type_name)
 
-      PDK::CLI::Util.analytics_screen_view('new_defined_type', opts)
+        PDK::CLI::Util.analytics_screen_view('new_defined_type', opts)
 
-      require 'pdk/generate/defined_type'
+        require 'pdk/generate/defined_type'
 
-      updates = PDK::Generate::DefinedType.new(PDK.context, defined_type_name, opts).run
-      PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
+        updates = PDK::Generate::DefinedType.new(PDK.context, defined_type_name, opts).run
+        PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
+      end
     end
   end
 end

data/lib/pdk/cli/new/fact.rb

@@ -1,29 +1,29 @@
-module PDK::CLI
-  @new_fact_cmd = @new_cmd.define_command do
-    name 'fact'
-    usage 'fact [options] <name>'
-    summary 'Create a new custom fact named <name> using given options'
+module PDK
+  module CLI
+    @new_fact_cmd = @new_cmd.define_command do
+      name 'fact'
+      usage 'fact [options] <name>'
+      summary 'Create a new custom fact named <name> using given options'
 
-    run do |opts, args, _cmd|
-      PDK::CLI::Util.ensure_in_module!
+      run do |opts, args, _cmd|
+        PDK::CLI::Util.ensure_in_module!
 
-      fact_name = args[0]
+        fact_name = args[0]
 
-      if fact_name.nil? || fact_name.empty?
-        puts command.help
-        exit 1
-      end
+        if fact_name.nil? || fact_name.empty?
+          puts command.help
+          exit 1
+        end
 
-      unless Util::OptionValidator.valid_fact_name?(fact_name)
-        raise PDK::CLI::ExitWithError, "'%{name}' is not a valid fact name" % { name: fact_name }
-      end
+        raise PDK::CLI::ExitWithError, format("'%{name}' is not a valid fact name", name: fact_name) unless Util::OptionValidator.valid_fact_name?(fact_name)
 
-      PDK::CLI::Util.analytics_screen_view('new_fact', opts)
+        PDK::CLI::Util.analytics_screen_view('new_fact', opts)
 
-      require 'pdk/generate/fact'
+        require 'pdk/generate/fact'
 
-      updates = PDK::Generate::Fact.new(PDK.context, fact_name, opts).run
-      PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
+        updates = PDK::Generate::Fact.new(PDK.context, fact_name, opts).run
+        PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
+      end
     end
   end
 end

data/lib/pdk/cli/new/function.rb

@@ -1,29 +1,29 @@
-module PDK::CLI
-  @new_function_cmd = @new_cmd.define_command do
-    name 'function'
-    usage 'function [options] <name>'
-    summary 'Create a new function named <name> using given options'
-    option :t, :type, 'The function type, (native or v4)', argument: :required, default: 'native'
+module PDK
+  module CLI
+    @new_function_cmd = @new_cmd.define_command do
+      name 'function'
+      usage 'function [options] <name>'
+      summary 'Create a new function named <name> using given options'
+      option :t, :type, 'The function type, (native or v4)', argument: :required, default: 'native'
 
-    run do |opts, args, _cmd|
-      PDK::CLI::Util.ensure_in_module!
+      run do |opts, args, _cmd|
+        PDK::CLI::Util.ensure_in_module!
 
-      function_name = args[0]
+        function_name = args[0]
 
-      if function_name.nil? || function_name.empty?
-        puts command.help
-        exit 1
-      end
+        if function_name.nil? || function_name.empty?
+          puts command.help
+          exit 1
+        end
 
-      unless Util::OptionValidator.valid_function_name?(function_name)
-        raise PDK::CLI::ExitWithError, "'%{name}' is not a valid function name" % { name: function_name }
-      end
+        raise PDK::CLI::ExitWithError, format("'%{name}' is not a valid function name", name: function_name) unless Util::OptionValidator.valid_function_name?(function_name)
 
-      PDK::CLI::Util.analytics_screen_view('new_function', opts)
+        PDK::CLI::Util.analytics_screen_view('new_function', opts)
 
-      require 'pdk/generate/function'
-      updates = PDK::Generate::Function.new(PDK.context, function_name, opts).run
-      PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
+        require 'pdk/generate/function'
+        updates = PDK::Generate::Function.new(PDK.context, function_name, opts).run
+        PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
+      end
     end
   end
 end

data/lib/pdk/cli/new/module.rb

@@ -1,52 +1,54 @@
-module PDK::CLI
-  @new_module_cmd = @new_cmd.define_command do
-    name 'module'
-    usage 'module [options] [module_name] [target_dir]'
-    summary 'Create a new module named [module_name] using given options'
+module PDK
+  module CLI
+    @new_module_cmd = @new_cmd.define_command do
+      name 'module'
+      usage 'module [options] [module_name] [target_dir]'
+      summary 'Create a new module named [module_name] using given options'
 
-    PDK::CLI.template_url_option(self)
-    PDK::CLI.template_ref_option(self)
-    PDK::CLI.skip_interview_option(self)
-    PDK::CLI.full_interview_option(self)
+      PDK::CLI.template_url_option(self)
+      PDK::CLI.template_ref_option(self)
+      PDK::CLI.skip_interview_option(self)
+      PDK::CLI.full_interview_option(self)
 
-    option nil, 'license', 'Specifies the license this module is written under. ' \
-      "This should be a identifier from https://spdx.org/licenses/. Common values are 'Apache-2.0', 'MIT', or 'proprietary'.", argument: :required
-    option nil, 'skip-bundle-install', 'Do not automatically run `bundle install` after creating the module.', hidden: true
+      option nil, 'license', 'Specifies the license this module is written under. ' \
+                             "This should be a identifier from https://spdx.org/licenses/. Common values are 'Apache-2.0', 'MIT', or 'proprietary'.", argument: :required
+      option nil, 'skip-bundle-install', 'Do not automatically run `bundle install` after creating the module.', hidden: true
 
-    run do |opts, args, _cmd|
-      require 'pdk/generate/module'
+      run do |opts, args, _cmd|
+        require 'pdk/generate/module'
 
-      module_name = args[0]
-      target_dir = args[1]
+        module_name = args[0]
+        target_dir = args[1]
 
-      PDK::CLI::Util.validate_template_opts(opts)
+        PDK::CLI::Util.validate_template_opts(opts)
 
-      PDK::CLI::Util.analytics_screen_view('new_module', opts)
+        PDK::CLI::Util.analytics_screen_view('new_module', opts)
 
-      if opts[:'skip-interview'] && opts[:'full-interview']
-        PDK.logger.info 'Ignoring --full-interview and continuing with --skip-interview.'
-        opts[:'full-interview'] = false
-      end
-
-      if module_name.nil? || module_name.empty?
-        if opts[:'skip-interview']
-          raise PDK::CLI::ExitWithError,
-                'You must specify a module name on the command line when running ' \
-                'with --skip-interview.'
+        if opts[:'skip-interview'] && opts[:'full-interview']
+          PDK.logger.info 'Ignoring --full-interview and continuing with --skip-interview.'
+          opts[:'full-interview'] = false
         end
-      else
-        module_name_parts = module_name.split('-', 2)
-        if module_name_parts.size > 1
-          opts[:username] = module_name_parts[0]
-          opts[:module_name] = module_name_parts[1]
+
+        if module_name.nil? || module_name.empty?
+          if opts[:'skip-interview']
+            raise PDK::CLI::ExitWithError,
+                  'You must specify a module name on the command line when running ' \
+                  'with --skip-interview.'
+          end
         else
-          opts[:module_name] = module_name
+          module_name_parts = module_name.split('-', 2)
+          if module_name_parts.size > 1
+            opts[:username] = module_name_parts[0]
+            opts[:module_name] = module_name_parts[1]
+          else
+            opts[:module_name] = module_name
+          end
+          opts[:target_dir] = target_dir.nil? ? opts[:module_name] : target_dir
         end
-        opts[:target_dir] = target_dir.nil? ? opts[:module_name] : target_dir
-      end
 
-      PDK.logger.info('Creating new module: %{modname}' % { modname: module_name })
-      PDK::Generate::Module.invoke(opts)
+        PDK.logger.info(format('Creating new module: %{modname}', modname: module_name))
+        PDK::Generate::Module.invoke(opts)
+      end
     end
   end
 end

data/lib/pdk/cli/new/provider.rb

@@ -1,29 +1,29 @@
-module PDK::CLI
-  @new_provider_cmd = @new_cmd.define_command do
-    name 'provider'
-    usage 'provider [options] <name>'
-    summary '[experimental] Create a new ruby provider named <name> using given options'
+module PDK
+  module CLI
+    @new_provider_cmd = @new_cmd.define_command do
+      name 'provider'
+      usage 'provider [options] <name>'
+      summary '[experimental] Create a new ruby provider named <name> using given options'
 
-    run do |opts, args, _cmd|
-      PDK::CLI::Util.ensure_in_module!
+      run do |opts, args, _cmd|
+        PDK::CLI::Util.ensure_in_module!
 
-      provider_name = args[0]
+        provider_name = args[0]
 
-      if provider_name.nil? || provider_name.empty?
-        puts command.help
-        exit 1
-      end
+        if provider_name.nil? || provider_name.empty?
+          puts command.help
+          exit 1
+        end
 
-      unless Util::OptionValidator.valid_provider_name?(provider_name)
-        raise PDK::CLI::ExitWithError, "'%{name}' is not a valid provider name" % { name: provider_name }
-      end
+        raise PDK::CLI::ExitWithError, format("'%{name}' is not a valid provider name", name: provider_name) unless Util::OptionValidator.valid_provider_name?(provider_name)
 
-      PDK::CLI::Util.analytics_screen_view('new_provider', opts)
+        PDK::CLI::Util.analytics_screen_view('new_provider', opts)
 
-      require 'pdk/generate/provider'
+        require 'pdk/generate/provider'
 
-      updates = PDK::Generate::Provider.new(PDK.context, provider_name, opts).run
-      PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
+        updates = PDK::Generate::Provider.new(PDK.context, provider_name, opts).run
+        PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
+      end
     end
   end
 end

data/lib/pdk/cli/new/task.rb

@@ -1,34 +1,34 @@
-module PDK::CLI
-  @new_task_cmd = @new_cmd.define_command do
-    name 'task'
-    usage 'task [options] <name>'
-    summary 'Create a new task named <name> using given options'
+module PDK
+  module CLI
+    @new_task_cmd = @new_cmd.define_command do
+      name 'task'
+      usage 'task [options] <name>'
+      summary 'Create a new task named <name> using given options'
 
-    option nil, :description, 'A short description of the purpose of the task', argument: :required
+      option nil, :description, 'A short description of the purpose of the task', argument: :required
 
-    run do |opts, args, _cmd|
-      require 'pdk/generate/task'
+      run do |opts, args, _cmd|
+        require 'pdk/generate/task'
 
-      PDK::CLI::Util.ensure_in_module!(
-        message:   'Tasks can only be created from inside a valid module directory.',
-        log_level: :info,
-      )
+        PDK::CLI::Util.ensure_in_module!(
+          message: 'Tasks can only be created from inside a valid module directory.',
+          log_level: :info
+        )
 
-      task_name = args[0]
+        task_name = args[0]
 
-      if task_name.nil? || task_name.empty?
-        puts command.help
-        exit 1
-      end
+        if task_name.nil? || task_name.empty?
+          puts command.help
+          exit 1
+        end
 
-      unless Util::OptionValidator.valid_task_name?(task_name)
-        raise PDK::CLI::ExitWithError, "'%{name}' is not a valid task name" % { name: task_name }
-      end
+        raise PDK::CLI::ExitWithError, format("'%{name}' is not a valid task name", name: task_name) unless Util::OptionValidator.valid_task_name?(task_name)
 
-      PDK::CLI::Util.analytics_screen_view('new_task', opts)
+        PDK::CLI::Util.analytics_screen_view('new_task', opts)
 
-      updates = PDK::Generate::Task.new(PDK.context, task_name, opts).run
-      PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
+        updates = PDK::Generate::Task.new(PDK.context, task_name, opts).run
+        PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
+      end
     end
   end
 end