pdk 2.3.0 → 2.4.0

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')
-
-    option nil, :description, _('A short description of the purpose of the task'), argument: :required
-
-    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,
-      )
-
-      task_name = args[0]
-
-      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
-
-      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)
-    end
-  end
-end
+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')
+
+    option nil, :description, _('A short description of the purpose of the task'), argument: :required
+
+    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,
+      )
+
+      task_name = args[0]
+
+      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
+
+      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)
+    end
+  end
+end

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

@@ -1,52 +1,52 @@
-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 }
-      end
-    end
-  end
-end
+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 }
+      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')
-
-    run do |opts, args, _cmd|
-      PDK::CLI::Util.ensure_in_module!
-
-      transport_name = args[0]
-
-      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
-
-      require 'pdk/generate/transport'
-
-      updates = PDK::Generate::Transport.new(PDK.context, transport_name, opts).run
-      PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
-    end
-  end
-end
+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')
+
+    run do |opts, args, _cmd|
+      PDK::CLI::Util.ensure_in_module!
+
+      transport_name = args[0]
+
+      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
+
+      require 'pdk/generate/transport'
+
+      updates = PDK::Generate::Transport.new(PDK.context, transport_name, opts).run
+      PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
+    end
+  end
+end

data/lib/pdk/cli/new.rb

@@ -1,21 +1,21 @@
-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
-
-  @new_cmd.add_command Cri::Command.new_basic_help
-end
-
-require 'pdk/cli/new/class'
-require 'pdk/cli/new/defined_type'
-require 'pdk/cli/new/module'
-require 'pdk/cli/new/provider'
-require 'pdk/cli/new/task'
-require 'pdk/cli/new/test'
-require 'pdk/cli/new/transport'
-require 'pdk/cli/new/fact'
-require 'pdk/cli/new/function'
+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
+
+  @new_cmd.add_command Cri::Command.new_basic_help
+end
+
+require 'pdk/cli/new/class'
+require 'pdk/cli/new/defined_type'
+require 'pdk/cli/new/module'
+require 'pdk/cli/new/provider'
+require 'pdk/cli/new/task'
+require 'pdk/cli/new/test'
+require 'pdk/cli/new/transport'
+require 'pdk/cli/new/fact'
+require 'pdk/cli/new/function'

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

@@ -1,39 +1,39 @@
-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')
-
-    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
-
-    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
-
-      Release.prepare_interview(opts) unless opts[:force]
-
-      Release.send_analytics("release #{cmd.name}", opts)
-
-      release = PDK::Module::Release.new(nil, opts)
-
-      Release.module_compatibility_checks!(release, opts)
-
-      release.run
-    end
-  end
-end
+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')
+
+    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
+
+    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
+
+      Release.prepare_interview(opts) unless opts[:force]
+
+      Release.send_analytics("release #{cmd.name}", opts)
+
+      release = PDK::Module::Release.new(nil, opts)
+
+      Release.module_compatibility_checks!(release, opts)
+
+      release.run
+    end
+  end
+end

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

@@ -1,50 +1,50 @@
-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
-
-      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
+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
+
+      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