pdk 2.7.1 → 3.0.0

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

@@ -1,51 +1,53 @@
-module PDK::CLI
-  @new_define_cmd = @new_cmd.define_command do
-    name 'test'
-    usage 'test [options] <name>'
-    summary 'Create a new test for the object named <name>'
-    flag :u, :unit, 'Create a new unit test.'
-    PDK::CLI.puppet_version_options(self)
-    PDK::CLI.puppet_dev_option(self)
-
-    run do |opts, args, _cmd|
-      require 'pdk/util/puppet_strings'
-      require 'pdk/util/bundler'
-
-      PDK::CLI::Util.validate_puppet_version_opts(opts)
-      PDK::CLI::Util.ensure_in_module!(
-        message: 'Tests can only be created from inside a valid module directory.',
-        log_level: :info,
-      )
-
-      object_name = args[0]
-
-      if object_name.nil? || object_name.empty?
-        puts command.help
-        exit 1
-      end
-
-      unless opts[:unit]
-        # At a future time, we'll replace this conditional with an interactive
-        # question to choose the test type.
-        PDK.logger.info 'Test type not specified, assuming unit.'
-        opts[:unit] = true
-      end
-
-      puppet_env = PDK::CLI::Util.puppet_from_opts_or_env(opts)
-      PDK::Util::RubyVersion.use(puppet_env[:ruby_version])
-      PDK::Util::Bundler.ensure_bundle!(puppet_env[:gemset])
-
-      begin
-        generator, obj = PDK::Util::PuppetStrings.find_object(object_name)
-
-        PDK::CLI::Util.analytics_screen_view('new_test', opts)
-
-        updates = generator.new(PDK.context, obj['name'], opts.merge(spec_only: true)).run
-        PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
-      rescue PDK::Util::PuppetStrings::NoObjectError
-        raise PDK::CLI::ExitWithError, 'Unable to find anything called "%{object}" to generate unit tests for.' % { object: object_name }
-      rescue PDK::Util::PuppetStrings::NoGeneratorError => e
-        raise PDK::CLI::ExitWithError, 'PDK does not support generating unit tests for "%{object_type}" objects.' % { object_type: e.message }
+module PDK
+  module CLI
+    @new_define_cmd = @new_cmd.define_command do
+      name 'test'
+      usage 'test [options] <name>'
+      summary 'Create a new test for the object named <name>'
+      flag :u, :unit, 'Create a new unit test.'
+      PDK::CLI.puppet_version_options(self)
+      PDK::CLI.puppet_dev_option(self)
+
+      run do |opts, args, _cmd|
+        require 'pdk/util/puppet_strings'
+        require 'pdk/util/bundler'
+
+        PDK::CLI::Util.validate_puppet_version_opts(opts)
+        PDK::CLI::Util.ensure_in_module!(
+          message: 'Tests can only be created from inside a valid module directory.',
+          log_level: :info
+        )
+
+        object_name = args[0]
+
+        if object_name.nil? || object_name.empty?
+          puts command.help
+          exit 1
+        end
+
+        unless opts[:unit]
+          # At a future time, we'll replace this conditional with an interactive
+          # question to choose the test type.
+          PDK.logger.info 'Test type not specified, assuming unit.'
+          opts[:unit] = true
+        end
+
+        puppet_env = PDK::CLI::Util.puppet_from_opts_or_env(opts)
+        PDK::Util::RubyVersion.use(puppet_env[:ruby_version])
+        PDK::Util::Bundler.ensure_bundle!(puppet_env[:gemset])
+
+        begin
+          generator, obj = PDK::Util::PuppetStrings.find_object(object_name)
+
+          PDK::CLI::Util.analytics_screen_view('new_test', opts)
+
+          updates = generator.new(PDK.context, obj['name'], opts.merge(spec_only: true)).run
+          PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
+        rescue PDK::Util::PuppetStrings::NoObjectError
+          raise PDK::CLI::ExitWithError, format('Unable to find anything called "%{object}" to generate unit tests for.', object: object_name)
+        rescue PDK::Util::PuppetStrings::NoGeneratorError => e
+          raise PDK::CLI::ExitWithError, format('PDK does not support generating unit tests for "%{object_type}" objects.', object_type: e.message)
+        end
       end
     end
   end

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

@@ -1,27 +1,27 @@
-module PDK::CLI
-  @new_transport_cmd = @new_cmd.define_command do
-    name 'transport'
-    usage 'transport [options] <name>'
-    summary '[experimental] Create a new ruby transport named <name> using given options'
+module PDK
+  module CLI
+    @new_transport_cmd = @new_cmd.define_command do
+      name 'transport'
+      usage 'transport [options] <name>'
+      summary '[experimental] Create a new ruby transport 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!
 
-      transport_name = args[0]
+        transport_name = args[0]
 
-      if transport_name.nil? || transport_name.empty?
-        puts command.help
-        exit 1
-      end
+        if transport_name.nil? || transport_name.empty?
+          puts command.help
+          exit 1
+        end
 
-      unless Util::OptionValidator.valid_transport_name?(transport_name)
-        raise PDK::CLI::ExitWithError, "'%{name}' is not a valid transport name" % { name: transport_name }
-      end
+        raise PDK::CLI::ExitWithError, format("'%{name}' is not a valid transport name", name: transport_name) unless Util::OptionValidator.valid_transport_name?(transport_name)
 
-      require 'pdk/generate/transport'
+        require 'pdk/generate/transport'
 
-      updates = PDK::Generate::Transport.new(PDK.context, transport_name, opts).run
-      PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
+        updates = PDK::Generate::Transport.new(PDK.context, transport_name, opts).run
+        PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
+      end
     end
   end
 end

data/lib/pdk/cli/new.rb

@@ -1,13 +1,15 @@
-module PDK::CLI
-  @new_cmd = @base_cmd.define_command do
-    name 'new'
-    usage 'new <thing> [options]'
-    summary 'create a new module, etc.'
-    description 'Creates a new <thing> using relevant options.'
-    default_subcommand 'help'
-  end
+module PDK
+  module CLI
+    @new_cmd = @base_cmd.define_command do
+      name 'new'
+      usage 'new <thing> [options]'
+      summary 'create a new module, etc.'
+      description 'Creates a new <thing> using relevant options.'
+      default_subcommand 'help'
+    end
 
-  @new_cmd.add_command Cri::Command.new_basic_help
+    @new_cmd.add_command Cri::Command.new_basic_help
+  end
 end
 
 require 'pdk/cli/new/class'

data/lib/pdk/cli/release/prep.rb

@@ -1,39 +1,41 @@
 require 'pdk/cli/release'
 
-module PDK::CLI
-  @release_prep_cmd = @release_cmd.define_command do
-    name 'prep'
-    usage 'prep [options]'
-    summary '(Experimental) Performs all the pre-release checks to ensure module is ready to be released'
+module PDK
+  module CLI
+    @release_prep_cmd = @release_cmd.define_command do
+      name 'prep'
+      usage 'prep [options]'
+      summary '(Experimental) Performs all the pre-release checks to ensure module is ready to be released'
 
-    flag nil, :force,                'Prepare the module automatically, with no prompts.'
-    flag nil, :'skip-validation',    'Skips the module validation check.'
-    flag nil, :'skip-changelog',     'Skips the automatic changelog generation.'
-    flag nil, :'skip-dependency',    'Skips the module dependency check.'
-    flag nil, :'skip-documentation', 'Skips the documentation update.'
+      flag nil, :force,                'Prepare the module automatically, with no prompts.'
+      flag nil, :'skip-validation',    'Skips the module validation check.'
+      flag nil, :'skip-changelog',     'Skips the automatic changelog generation.'
+      flag nil, :'skip-dependency',    'Skips the module dependency check.'
+      flag nil, :'skip-documentation', 'Skips the documentation update.'
 
-    option nil, :version, 'Update the module to the specified version prior to release. When not specified, the new version will be computed from the Changelog where possible.',
-           argument: :required
+      option nil, :version, 'Update the module to the specified version prior to release. When not specified, the new version will be computed from the Changelog where possible.',
+             argument: :required
 
-    run do |opts, _args, cmd|
-      # Make sure build is being run in a valid module directory with a metadata.json
-      PDK::CLI::Util.ensure_in_module!(
-        message:   "`pdk release #{cmd.name}` can only be run from inside a valid module with a metadata.json.",
-        log_level: :info,
-      )
+      run do |opts, _args, cmd|
+        # Make sure build is being run in a valid module directory with a metadata.json
+        PDK::CLI::Util.ensure_in_module!(
+          message: "`pdk release #{cmd.name}` can only be run from inside a valid module with a metadata.json.",
+          log_level: :info
+        )
 
-      opts[:'skip-build'] = true
-      opts[:'skip-publish'] = true
+        opts[:'skip-build'] = true
+        opts[:'skip-publish'] = true
 
-      Release.prepare_interview(opts) unless opts[:force]
+        Release.prepare_interview(opts) unless opts[:force]
 
-      Release.send_analytics("release #{cmd.name}", opts)
+        Release.send_analytics("release #{cmd.name}", opts)
 
-      release = PDK::Module::Release.new(nil, opts)
+        release = PDK::Module::Release.new(nil, opts)
 
-      Release.module_compatibility_checks!(release, opts)
+        Release.module_compatibility_checks!(release, opts)
 
-      release.run
+        release.run
+      end
     end
   end
 end

data/lib/pdk/cli/release/publish.rb

@@ -1,46 +1,48 @@
 require 'pdk/cli/release'
 
-module PDK::CLI
-  @release_publish_cmd = @release_cmd.define_command do
-    name 'publish'
-    usage 'publish [options] <tarball>'
-    summary '(Experimental) Publishes the module <tarball> to the Forge.'
-
-    flag nil, :force,                'Publish the module automatically, with no prompts.'
-
-    option nil, :'forge-upload-url', 'Set forge upload url path.',
-           argument: :required, default: 'https://forgeapi.puppetlabs.com/v3/releases'
-
-    option nil, :'forge-token', 'Set Forge API token (you may also set via environment variable PDK_FORGE_TOKEN)', argument: :required
-
-    run do |opts, _args, cmd|
-      # Make sure build is being run in a valid module directory with a metadata.json
-      PDK::CLI::Util.ensure_in_module!(
-        message:   "`pdk release #{cmd.name}` can only be run from inside a valid module with a metadata.json.",
-        log_level: :info,
-      )
-
-      opts[:'skip-validation'] = true
-      opts[:'skip-changelog'] = true
-      opts[:'skip-dependency'] = true
-      opts[:'skip-documentation'] = true
-      opts[:'skip-build'] = true
-      opts[:'skip-versionset'] = true
-      opts[:force] = true unless PDK::CLI::Util.interactive?
-      opts[:'forge-token'] ||= PDK::Util::Env['PDK_FORGE_TOKEN']
-
-      if opts[:'forge-token'].nil? || opts[:'forge-token'].empty?
-        PDK.logger.error 'You must supply a Forge API token either via `--forge-token` option or PDK_FORGE_TOKEN environment variable.'
-        exit 1
-      end
+module PDK
+  module CLI
+    @release_publish_cmd = @release_cmd.define_command do
+      name 'publish'
+      usage 'publish [options] <tarball>'
+      summary '(Experimental) Publishes the module <tarball> to the Forge.'
+
+      flag nil, :force,                'Publish the module automatically, with no prompts.'
+
+      option nil, :'forge-upload-url', 'Set forge upload url path.',
+             argument: :required, default: 'https://forgeapi.puppetlabs.com/v3/releases'
+
+      option nil, :'forge-token', 'Set Forge API token (you may also set via environment variable PDK_FORGE_TOKEN)', argument: :required
 
-      Release.prepare_publish_interview(TTY::Prompt.new(help_color: :cyan), opts) unless opts[:force]
+      run do |opts, _args, cmd|
+        # Make sure build is being run in a valid module directory with a metadata.json
+        PDK::CLI::Util.ensure_in_module!(
+          message: "`pdk release #{cmd.name}` can only be run from inside a valid module with a metadata.json.",
+          log_level: :info
+        )
 
-      Release.send_analytics("release #{cmd.name}", opts)
+        opts[:'skip-validation'] = true
+        opts[:'skip-changelog'] = true
+        opts[:'skip-dependency'] = true
+        opts[:'skip-documentation'] = true
+        opts[:'skip-build'] = true
+        opts[:'skip-versionset'] = true
+        opts[:force] = true unless PDK::CLI::Util.interactive?
+        opts[:'forge-token'] ||= PDK::Util::Env['PDK_FORGE_TOKEN']
 
-      release = PDK::Module::Release.new(nil, opts)
+        if opts[:'forge-token'].nil? || opts[:'forge-token'].empty?
+          PDK.logger.error 'You must supply a Forge API token either via `--forge-token` option or PDK_FORGE_TOKEN environment variable.'
+          exit 1
+        end
 
-      release.run
+        Release.prepare_publish_interview(TTY::Prompt.new(help_color: :cyan), opts) unless opts[:force]
+
+        Release.send_analytics("release #{cmd.name}", opts)
+
+        release = PDK::Module::Release.new(nil, opts)
+
+        release.run
+      end
     end
   end
 end