pdk 2.3.0 → 2.4.0

data/lib/pdk/analytics/client/noop.rb

@@ -1,25 +1,25 @@
-require 'pdk'
-
-module PDK
-  module Analytics
-    module Client
-      class Noop
-        attr_reader :logger
-
-        def initialize(opts)
-          @logger = opts[:logger]
-        end
-
-        def screen_view(screen, **_kwargs)
-          logger.debug "Skipping submission of '#{screen}' screenview because analytics is disabled"
-        end
-
-        def event(category, action, **_kwargs)
-          logger.debug "Skipping submission of '#{category} #{action}' event because analytics is disabled"
-        end
-
-        def finish; end
-      end
-    end
-  end
-end
+require 'pdk'
+
+module PDK
+  module Analytics
+    module Client
+      class Noop
+        attr_reader :logger
+
+        def initialize(opts)
+          @logger = opts[:logger]
+        end
+
+        def screen_view(screen, **_kwargs)
+          logger.debug "Skipping submission of '#{screen}' screenview because analytics is disabled"
+        end
+
+        def event(category, action, **_kwargs)
+          logger.debug "Skipping submission of '#{category} #{action}' event because analytics is disabled"
+        end
+
+        def finish; end
+      end
+    end
+  end
+end

data/lib/pdk/analytics/util.rb

@@ -1,19 +1,19 @@
-require 'pdk'
-
-module PDK
-  module Analytics
-    module Util
-      def self.fetch_os_async
-        require 'concurrent/configuration'
-        require 'concurrent/future'
-
-        Concurrent::Future.execute(executor: :io) do
-          require 'facter'
-          os = Facter.value('os')
-
-          os.nil? ? 'unknown' : "#{os['name']} #{os.fetch('release', {}).fetch('major', '')}".strip
-        end
-      end
-    end
-  end
-end
+require 'pdk'
+
+module PDK
+  module Analytics
+    module Util
+      def self.fetch_os_async
+        require 'concurrent/configuration'
+        require 'concurrent/future'
+
+        Concurrent::Future.execute(executor: :io) do
+          require 'facter'
+          os = Facter.value('os')
+
+          os.nil? ? 'unknown' : "#{os['name']} #{os.fetch('release', {}).fetch('major', '')}".strip
+        end
+      end
+    end
+  end
+end

data/lib/pdk/analytics.rb

@@ -1,30 +1,30 @@
-require 'pdk'
-
-autoload :Logger, 'logger'
-
-module PDK
-  module Analytics
-    autoload :Util, 'pdk/analytics/util'
-
-    module Client
-      autoload :Noop, 'pdk/analytics/client/noop'
-      autoload :GoogleAnalytics, 'pdk/analytics/client/google_analytics'
-    end
-
-    def self.build_client(opts = {})
-      opts[:logger] ||= ::Logger.new(STDERR)
-      opts[:client] ||= :noop
-
-      if opts[:disabled]
-        opts[:logger].debug 'Analytics opt-out is set, analytics will be disabled'
-        opts[:client] = :noop
-      end
-
-      client_const = opts[:client].to_s.split('_').map(&:capitalize).join
-      PDK::Analytics::Client.const_get(client_const).new(opts)
-    rescue StandardError => e
-      opts[:logger].debug "Failed to initialize analytics client, analytics will be disabled: #{e}"
-      PDK::Analytics::Client::Noop.new(opts)
-    end
-  end
-end
+require 'pdk'
+
+autoload :Logger, 'logger'
+
+module PDK
+  module Analytics
+    autoload :Util, 'pdk/analytics/util'
+
+    module Client
+      autoload :Noop, 'pdk/analytics/client/noop'
+      autoload :GoogleAnalytics, 'pdk/analytics/client/google_analytics'
+    end
+
+    def self.build_client(opts = {})
+      opts[:logger] ||= ::Logger.new(STDERR)
+      opts[:client] ||= :noop
+
+      if opts[:disabled]
+        opts[:logger].debug 'Analytics opt-out is set, analytics will be disabled'
+        opts[:client] = :noop
+      end
+
+      client_const = opts[:client].to_s.split('_').map(&:capitalize).join
+      PDK::Analytics::Client.const_get(client_const).new(opts)
+    rescue StandardError => e
+      opts[:logger].debug "Failed to initialize analytics client, analytics will be disabled: #{e}"
+      PDK::Analytics::Client::Noop.new(opts)
+    end
+  end
+end

data/lib/pdk/answer_file.rb

@@ -1,12 +1,12 @@
-require 'pdk'
-
-module PDK
-  class AnswerFile
-    # Determine the default path to the answer file.
-    #
-    # @return [String] The path on disk to the default answer file.
-    def self.default_answer_file_path
-      PDK::Util::Filesystem.expand_path(File.join(PDK::Util.cachedir, 'answers.json'))
-    end
-  end
-end
+require 'pdk'
+
+module PDK
+  class AnswerFile
+    # Determine the default path to the answer file.
+    #
+    # @return [String] The path on disk to the default answer file.
+    def self.default_answer_file_path
+      PDK::Util::Filesystem.expand_path(File.join(PDK::Util.cachedir, 'answers.json'))
+    end
+  end
+end

data/lib/pdk/bolt.rb

@@ -1,19 +1,19 @@
-require 'pdk'
-
-module PDK
-  module Bolt
-    # Returns true or false depending on if any of the common files and directories in
-    # a Bolt Project are found in the specified directory. If a directory is not specified,
-    # the current working directory is used.
-    #
-    # @see https://puppet.com/docs/bolt/latest/bolt_project_directories.html
-    #
-    # @return [boolean] True if any bolt specific files or directories are present
-    #
-    def bolt_project_root?(path = Dir.pwd)
-      return true if File.basename(path) == 'Boltdir' && PDK::Util::Filesystem.directory?(path)
-      PDK::Util::Filesystem.file?(File.join(path, 'bolt.yaml'))
-    end
-    module_function :bolt_project_root?
-  end
-end
+require 'pdk'
+
+module PDK
+  module Bolt
+    # Returns true or false depending on if any of the common files and directories in
+    # a Bolt Project are found in the specified directory. If a directory is not specified,
+    # the current working directory is used.
+    #
+    # @see https://puppet.com/docs/bolt/latest/bolt_project_directories.html
+    #
+    # @return [boolean] True if any bolt specific files or directories are present
+    #
+    def bolt_project_root?(path = Dir.pwd)
+      return true if File.basename(path) == 'Boltdir' && PDK::Util::Filesystem.directory?(path)
+      PDK::Util::Filesystem.file?(File.join(path, 'bolt.yaml'))
+    end
+    module_function :bolt_project_root?
+  end
+end

data/lib/pdk/cli/build.rb

@@ -1,82 +1,82 @@
-module PDK::CLI
-  @build_cmd = @base_cmd.define_command do
-    name 'build'
-    usage _('build [options]')
-    summary _('Builds a package from the module that can be published to the Puppet Forge.')
-
-    option nil, 'target-dir',
-           _('The target directory where you want PDK to write the package.'),
-           argument: :required, default: File.join(Dir.pwd, 'pkg')
-
-    option nil, 'force', _('Skips the prompts and builds the module package.')
-
-    run do |opts, _args, _cmd|
-      require 'pdk/module/build'
-      require 'pdk/module/metadata'
-      require 'pdk/cli/util'
-
-      # Make sure build is being run in a valid module directory with a metadata.json
-      PDK::CLI::Util.ensure_in_module!(
-        message:   _('`pdk build` can only be run from inside a valid module with a metadata.json.'),
-        log_level: :info,
-      )
-
-      PDK::CLI::Util.analytics_screen_view('build', opts)
-
-      module_metadata = PDK::Module::Metadata.from_file('metadata.json')
-
-      # TODO: Ensure forge metadata has been set, or call out to interview
-      #       to set it.
-      #
-      unless module_metadata.forge_ready?
-        if opts[:force]
-          PDK.logger.warn _(
-            'This module is missing the following fields in the metadata.json: %{fields}. ' \
-            'These missing fields may affect the visibility of the module on the Forge.',
-          ) % {
-            fields: module_metadata.missing_fields.join(', '),
-          }
-        else
-          module_metadata.interview_for_forge!
-          module_metadata.write!('metadata.json')
-        end
-      end
-
-      builder = PDK::Module::Build.new(opts)
-
-      unless opts[:force]
-        if builder.package_already_exists?
-          PDK.logger.info _("The file '%{package}' already exists.") % { package: builder.package_file }
-
-          unless PDK::CLI::Util.prompt_for_yes(_('Overwrite?'), default: false)
-            PDK.logger.info _('Build cancelled; exiting.')
-            exit 0
-          end
-        end
-
-        unless builder.module_pdk_compatible?
-          PDK.logger.info _('This module is not compatible with PDK, so PDK can not validate or test this build. ' \
-                            'Unvalidated modules may have errors when uploading to the Forge. ' \
-                            'To make this module PDK compatible and use validate features, cancel the build and run `pdk convert`.')
-
-          unless PDK::CLI::Util.prompt_for_yes(_('Continue build without converting?'))
-            PDK.logger.info _('Build cancelled; exiting.')
-            exit 0
-          end
-        end
-      end
-
-      PDK.logger.info _('Building %{module_name} version %{module_version}') % {
-        module_name:    module_metadata.data['name'],
-        module_version: module_metadata.data['version'],
-      }
-
-      builder.build
-
-      PDK.logger.info _('Build of %{package_name} has completed successfully. Built package can be found here: %{package_path}') % {
-        package_name: module_metadata.data['name'],
-        package_path: builder.package_file,
-      }
-    end
-  end
-end
+module PDK::CLI
+  @build_cmd = @base_cmd.define_command do
+    name 'build'
+    usage _('build [options]')
+    summary _('Builds a package from the module that can be published to the Puppet Forge.')
+
+    option nil, 'target-dir',
+           _('The target directory where you want PDK to write the package.'),
+           argument: :required, default: File.join(Dir.pwd, 'pkg')
+
+    option nil, 'force', _('Skips the prompts and builds the module package.')
+
+    run do |opts, _args, _cmd|
+      require 'pdk/module/build'
+      require 'pdk/module/metadata'
+      require 'pdk/cli/util'
+
+      # Make sure build is being run in a valid module directory with a metadata.json
+      PDK::CLI::Util.ensure_in_module!(
+        message:   _('`pdk build` can only be run from inside a valid module with a metadata.json.'),
+        log_level: :info,
+      )
+
+      PDK::CLI::Util.analytics_screen_view('build', opts)
+
+      module_metadata = PDK::Module::Metadata.from_file('metadata.json')
+
+      # TODO: Ensure forge metadata has been set, or call out to interview
+      #       to set it.
+      #
+      unless module_metadata.forge_ready?
+        if opts[:force]
+          PDK.logger.warn _(
+            'This module is missing the following fields in the metadata.json: %{fields}. ' \
+            'These missing fields may affect the visibility of the module on the Forge.',
+          ) % {
+            fields: module_metadata.missing_fields.join(', '),
+          }
+        else
+          module_metadata.interview_for_forge!
+          module_metadata.write!('metadata.json')
+        end
+      end
+
+      builder = PDK::Module::Build.new(opts)
+
+      unless opts[:force]
+        if builder.package_already_exists?
+          PDK.logger.info _("The file '%{package}' already exists.") % { package: builder.package_file }
+
+          unless PDK::CLI::Util.prompt_for_yes(_('Overwrite?'), default: false)
+            PDK.logger.info _('Build cancelled; exiting.')
+            exit 0
+          end
+        end
+
+        unless builder.module_pdk_compatible?
+          PDK.logger.info _('This module is not compatible with PDK, so PDK can not validate or test this build. ' \
+                            'Unvalidated modules may have errors when uploading to the Forge. ' \
+                            'To make this module PDK compatible and use validate features, cancel the build and run `pdk convert`.')
+
+          unless PDK::CLI::Util.prompt_for_yes(_('Continue build without converting?'))
+            PDK.logger.info _('Build cancelled; exiting.')
+            exit 0
+          end
+        end
+      end
+
+      PDK.logger.info _('Building %{module_name} version %{module_version}') % {
+        module_name:    module_metadata.data['name'],
+        module_version: module_metadata.data['version'],
+      }
+
+      builder.build
+
+      PDK.logger.info _('Build of %{package_name} has completed successfully. Built package can be found here: %{package_path}') % {
+        package_name: module_metadata.data['name'],
+        package_path: builder.package_file,
+      }
+    end
+  end
+end

data/lib/pdk/cli/bundle.rb

@@ -1,48 +1,48 @@
-module PDK::CLI
-  @bundle_cmd = @base_cmd.define_command do
-    name 'bundle'
-    usage _('bundle [bundler_options]')
-    summary _('(Experimental) Command pass-through to bundler')
-    description _(<<-EOF
-[experimental] For advanced users, pdk bundle runs arbitrary commands in the bundler environment that pdk manages.
-Careless use of this command can lead to errors that pdk can't help recover from.
-EOF
-                 )
-    skip_option_parsing
-
-    run do |_opts, args, _cmd|
-      require 'pdk/cli/exec/interactive_command'
-      require 'pdk/util/bundler'
-
-      PDK::CLI::Util.ensure_in_module!(
-        message: _('`pdk bundle` can only be run from inside a valid module directory.'),
-      )
-
-      PDK::CLI::Util.validate_puppet_version_opts({})
-
-      screen_view_name = ['bundle']
-      screen_view_name << args[0] if args.size >= 1
-      screen_view_name << args[1] if args.size >= 2 && args[0] == 'exec'
-
-      PDK::CLI::Util.analytics_screen_view(screen_view_name.join('_'))
-
-      # Ensure that the correct Ruby is activated before running command.
-      puppet_env = PDK::CLI::Util.puppet_from_opts_or_env({})
-      PDK::Util::RubyVersion.use(puppet_env[:ruby_version])
-
-      gemfile_env = PDK::Util::Bundler::BundleHelper.gemfile_env(puppet_env[:gemset])
-
-      require 'pdk/cli/exec'
-      require 'pdk/cli/exec/interactive_command'
-
-      command = PDK::CLI::Exec::InteractiveCommand.new(PDK::CLI::Exec.bundle_bin, *args).tap do |c|
-        c.context = :pwd
-        c.update_environment(gemfile_env)
-      end
-
-      result = command.execute!
-
-      exit result[:exit_code]
-    end
-  end
-end
+module PDK::CLI
+  @bundle_cmd = @base_cmd.define_command do
+    name 'bundle'
+    usage _('bundle [bundler_options]')
+    summary _('(Experimental) Command pass-through to bundler')
+    description _(<<-EOF
+[experimental] For advanced users, pdk bundle runs arbitrary commands in the bundler environment that pdk manages.
+Careless use of this command can lead to errors that pdk can't help recover from.
+EOF
+                 )
+    skip_option_parsing
+
+    run do |_opts, args, _cmd|
+      require 'pdk/cli/exec/interactive_command'
+      require 'pdk/util/bundler'
+
+      PDK::CLI::Util.ensure_in_module!(
+        message: _('`pdk bundle` can only be run from inside a valid module directory.'),
+      )
+
+      PDK::CLI::Util.validate_puppet_version_opts({})
+
+      screen_view_name = ['bundle']
+      screen_view_name << args[0] if args.size >= 1
+      screen_view_name << args[1] if args.size >= 2 && args[0] == 'exec'
+
+      PDK::CLI::Util.analytics_screen_view(screen_view_name.join('_'))
+
+      # Ensure that the correct Ruby is activated before running command.
+      puppet_env = PDK::CLI::Util.puppet_from_opts_or_env({})
+      PDK::Util::RubyVersion.use(puppet_env[:ruby_version])
+
+      gemfile_env = PDK::Util::Bundler::BundleHelper.gemfile_env(puppet_env[:gemset])
+
+      require 'pdk/cli/exec'
+      require 'pdk/cli/exec/interactive_command'
+
+      command = PDK::CLI::Exec::InteractiveCommand.new(PDK::CLI::Exec.bundle_bin, *args).tap do |c|
+        c.context = :pwd
+        c.update_environment(gemfile_env)
+      end
+
+      result = command.execute!
+
+      exit result[:exit_code]
+    end
+  end
+end

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

@@ -1,26 +1,26 @@
-module PDK::CLI
-  @config_get_cmd = @config_cmd.define_command do
-    name 'get'
-    usage _('config get [name]')
-    summary _('(Deprecated) Retrieve the configuration for <name>. If not specified, retrieve all configuration settings')
-
-    run do |_opts, args, _cmd|
-      PDK.logger.warn _('The \'pdk config get\' command is deprecated, please use \'pdk get config\' instead.')
-
-      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
-      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
+module PDK::CLI
+  @config_get_cmd = @config_cmd.define_command do
+    name 'get'
+    usage _('config get [name]')
+    summary _('(Deprecated) Retrieve the configuration for <name>. If not specified, retrieve all configuration settings')
+
+    run do |_opts, args, _cmd|
+      PDK.logger.warn _('The \'pdk config get\' command is deprecated, please use \'pdk get config\' instead.')
+
+      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
+      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/config.rb

@@ -1,22 +1,22 @@
-module PDK::CLI
-  @config_cmd = @base_cmd.define_command do
-    name 'config'
-    usage _('config [subcommand] [options]')
-    summary _('(Deprecated) Configure the Puppet Development Kit.')
-    default_subcommand 'help'
-
-    run do |_opts, args, _cmd|
-      PDK.logger.warn _('The \'pdk config\' command is deprecated, please use \'pdk get config\' and \'pdk set config\' instead.')
-
-      if args == ['help']
-        PDK::CLI.run(%w[config --help])
-        exit 0
-      end
-
-      PDK::CLI.run(%w[config help]) if args.empty?
-    end
-  end
-  @config_cmd.add_command Cri::Command.new_basic_help
-end
-
-require 'pdk/cli/config/get'
+module PDK::CLI
+  @config_cmd = @base_cmd.define_command do
+    name 'config'
+    usage _('config [subcommand] [options]')
+    summary _('(Deprecated) Configure the Puppet Development Kit.')
+    default_subcommand 'help'
+
+    run do |_opts, args, _cmd|
+      PDK.logger.warn _('The \'pdk config\' command is deprecated, please use \'pdk get config\' and \'pdk set config\' instead.')
+
+      if args == ['help']
+        PDK::CLI.run(%w[config --help])
+        exit 0
+      end
+
+      PDK::CLI.run(%w[config help]) if args.empty?
+    end
+  end
+  @config_cmd.add_command Cri::Command.new_basic_help
+end
+
+require 'pdk/cli/config/get'