pdk 2.6.1 → 2.7.0

data/lib/pdk/generate/module.rb

@@ -7,15 +7,13 @@ module PDK
         require 'pdk/cli/util/option_validator'
 
         unless PDK::CLI::Util::OptionValidator.valid_module_name?(opts[:module_name])
-          error_msg = _(
-            "'%{module_name}' is not a valid module name.\n" \
-            'Module names must begin with a lowercase letter and can only include lowercase letters, digits, and underscores.',
-          ) % { module_name: opts[:module_name] }
+          error_msg = "'%{module_name}' is not a valid module name.\n" \
+                      'Module names must begin with a lowercase letter and can only include lowercase letters, digits, and underscores.' % { module_name: opts[:module_name] }
           raise PDK::CLI::ExitWithError, error_msg
         end
 
         target_dir = PDK::Util::Filesystem.expand_path(opts[:target_dir])
-        raise PDK::CLI::ExitWithError, _("The destination directory '%{dir}' already exists") % { dir: target_dir } if PDK::Util::Filesystem.exist?(target_dir)
+        raise PDK::CLI::ExitWithError, "The destination directory '%{dir}' already exists" % { dir: target_dir } if PDK::Util::Filesystem.exist?(target_dir)
       end
 
       def self.invoke(opts = {})
@@ -35,7 +33,7 @@ module PDK
           PDK::Util::Filesystem.write_file(test_file, 'This file was created by the Puppet Development Kit to test if this folder was writable, you can safely remove this file.')
           PDK::Util::Filesystem.rm_f(test_file)
         rescue Errno::EACCES
-          raise PDK::CLI::FatalError, _("You do not have permission to write to '%{parent_dir}'") % {
+          raise PDK::CLI::FatalError, "You do not have permission to write to '%{parent_dir}'" % {
             parent_dir: parent_dir,
           }
         end
@@ -47,14 +45,12 @@ module PDK
         template_uri = PDK::Util::TemplateURI.new(opts)
 
         if template_uri.default? && template_uri.default_ref?
-          PDK.logger.info _('Using the default template-url and template-ref.')
+          PDK.logger.info 'Using the default template-url and template-ref.'
         else
-          PDK.logger.info _(
-            "Using the %{method} template-url and template-ref '%{template_uri}'." % {
-              method: opts.key?(:'template-url') ? _('specified') : _('saved'),
+          PDK.logger.info "Using the %{method} template-url and template-ref '%{template_uri}'." % {
+            method: opts.key?(:'template-url') ? 'specified' : 'saved',
               template_uri: template_uri.metadata_format,
-            },
-          )
+          }
         end
 
         begin
@@ -99,16 +95,14 @@ module PDK
               end
             end
 
-            PDK.logger.info _("Module '%{name}' generated at path '%{path}'.") % {
+            PDK.logger.info "Module '%{name}' generated at path '%{path}'." % {
               name: opts[:module_name],
               path: target_dir,
             }
-            PDK.logger.info _(
-              "In your module directory, add classes with the 'pdk new class' command.",
-            )
+            PDK.logger.info "In your module directory, add classes with the 'pdk new class' command."
           end
         rescue Errno::EACCES => e
-          raise PDK::CLI::FatalError, _("Failed to move '%{source}' to '%{target}': %{message}") % {
+          raise PDK::CLI::FatalError, "Failed to move '%{source}' to '%{target}': %{message}" % {
             source:  temp_target_dir,
             target:  target_dir,
             message: e.message,
@@ -124,7 +118,7 @@ module PDK
         login_clean = 'username' if login_clean.empty?
 
         if login_clean != login
-          PDK.logger.debug _('Your username is not a valid Forge username. Proceeding with the username %{username}. You can fix this later in metadata.json.') % {
+          PDK.logger.debug 'Your username is not a valid Forge username. Proceeding with the username %{username}. You can fix this later in metadata.json.' % {
             username: login_clean,
           }
         end
@@ -162,7 +156,7 @@ module PDK
           begin
             PDK::Util::Filesystem.mkdir_p(dir)
           rescue SystemCallError => e
-            raise PDK::CLI::FatalError, _("Unable to create directory '%{dir}': %{message}") % {
+            raise PDK::CLI::FatalError, "Unable to create directory '%{dir}': %{message}" % {
               dir:     dir,
               message: e.message,
             }
@@ -177,49 +171,49 @@ module PDK
         questions = [
           {
             name:             'module_name',
-            question:         _('If you have a name for your module, add it here.'),
-            help:             _('This is the name that will be associated with your module, it should be relevant to the modules content.'),
+            question:         'If you have a name for your module, add it here.',
+            help:             'This is the name that will be associated with your module, it should be relevant to the modules content.',
             required:         true,
             validate_pattern: %r{\A[a-z][a-z0-9_]*\Z}i,
-            validate_message: _('Module names must begin with a lowercase letter and can only include lowercase letters, numbers, and underscores.'),
+            validate_message: 'Module names must begin with a lowercase letter and can only include lowercase letters, numbers, and underscores.',
           },
           {
             name:             'forge_username',
-            question:         _('If you have a Puppet Forge username, add it here.'),
-            help:             _('We can use this to upload your module to the Forge when it\'s complete.'),
+            question:         'If you have a Puppet Forge username, add it here.',
+            help:             'We can use this to upload your module to the Forge when it\'s complete.',
             required:         true,
             validate_pattern: %r{\A[a-z0-9]+\Z}i,
-            validate_message: _('Forge usernames can only contain lowercase letters and numbers'),
+            validate_message: 'Forge usernames can only contain lowercase letters and numbers',
             default:          opts[:username],
           },
           {
             name:             'version',
-            question:         _('What version is this module?'),
-            help:             _('Puppet uses Semantic Versioning (semver.org) to version modules.'),
+            question:         'What version is this module?',
+            help:             'Puppet uses Semantic Versioning (semver.org) to version modules.',
             required:         true,
-            validate_pattern: %r{\A[0-9]+\.[0-9]+\.[0-9]+},
-            validate_message: _('Semantic Version numbers must be in the form MAJOR.MINOR.PATCH'),
+            validate_pattern: %r{\A[0-9]+\.[0-9]+\.[0-9]+}i,
+            validate_message: 'Semantic Version numbers must be in the form MAJOR.MINOR.PATCH',
             default:          metadata.data['version'],
             forge_only:       true,
           },
           {
             name:     'author',
-            question: _('Who wrote this module?'),
-            help:     _('This is used to credit the module\'s author.'),
+            question: 'Who wrote this module?',
+            help:     'This is used to credit the module\'s author.',
             required: true,
             default:  metadata.data['author'],
           },
           {
             name:     'license',
-            question: _('What license does this module code fall under?'),
-            help:     _('This should be an identifier from https://spdx.org/licenses/. Common values are "Apache-2.0", "MIT", or "proprietary".'),
+            question: 'What license does this module code fall under?',
+            help:     'This should be an identifier from https://spdx.org/licenses/. Common values are "Apache-2.0", "MIT", or "proprietary".',
             required: true,
             default:  metadata.data['license'],
           },
           {
             name:     'operatingsystem_support',
-            question: _('What operating systems does this module support?'),
-            help:     _('Use the up and down keys to move between the choices, space to select and enter to continue.'),
+            question: 'What operating systems does this module support?',
+            help:     'Use the up and down keys to move between the choices, space to select and enter to continue.',
             required: true,
             type:     :multi_select,
             choices:  PDK::Module::Metadata::OPERATING_SYSTEMS,
@@ -230,31 +224,31 @@ module PDK
           },
           {
             name:       'summary',
-            question:   _('Summarize the purpose of this module in a single sentence.'),
-            help:       _('This helps other Puppet users understand what the module does.'),
+            question:   'Summarize the purpose of this module in a single sentence.',
+            help:       'This helps other Puppet users understand what the module does.',
             required:   true,
             default:    metadata.data['summary'],
             forge_only: true,
           },
           {
             name:       'source',
-            question:   _('If there is a source code repository for this module, enter the URL here.'),
-            help:       _('Skip this if no repository exists yet. You can update this later in the metadata.json.'),
+            question:   'If there is a source code repository for this module, enter the URL here.',
+            help:       'Skip this if no repository exists yet. You can update this later in the metadata.json.',
             required:   true,
             default:    metadata.data['source'],
             forge_only: true,
           },
           {
             name:       'project_page',
-            question:   _('If there is a URL where others can learn more about this module, enter it here.'),
-            help:       _('Optional. You can update this later in the metadata.json.'),
+            question:   'If there is a URL where others can learn more about this module, enter it here.',
+            help:       'Optional. You can update this later in the metadata.json.',
             default:    metadata.data['project_page'],
             forge_only: true,
           },
           {
             name:       'issues_url',
-            question:   _('If there is a public issue tracker for this module, enter its URL here.'),
-            help:       _('Optional. You can update this later in the metadata.json.'),
+            question:   'If there is a public issue tracker for this module, enter its URL here.',
+            help:       'Optional. You can update this later in the metadata.json.',
             default:    metadata.data['issues_url'],
             forge_only: true,
           },
@@ -281,31 +275,25 @@ module PDK
         interview.add_questions(questions)
 
         if PDK::Util::Filesystem.file?('metadata.json')
-          puts _(
-            "\nWe need to update the metadata.json file for this module, so we\'re going to ask you %{count} " \
-            "questions.\n",
-          ) % {
-            count: interview.num_questions,
-          }
+          puts "\nWe need to update the metadata.json file for this module, so we\'re going to ask you %{count} " \
+               "questions.\n" % {
+                 count: interview.num_questions,
+               }
         else
-          puts _(
-            "\nWe need to create the metadata.json file for this module, so we\'re going to ask you %{count} " \
-            "questions.\n",
-          ) % {
-            count: interview.num_questions,
-          }
+          puts "\nWe need to create the metadata.json file for this module, so we\'re going to ask you %{count} " \
+               "questions.\n" % {
+                 count: interview.num_questions,
+               }
         end
 
-        puts _(
-          'If the question is not applicable to this module, accept the default option ' \
-          'shown after each question. You can modify any answers at any time by manually updating ' \
-          "the metadata.json file.\n\n",
-        )
+        puts 'If the question is not applicable to this module, accept the default option ' \
+             'shown after each question. You can modify any answers at any time by manually updating ' \
+             "the metadata.json file.\n\n"
 
         answers = interview.run
 
         if answers.nil?
-          PDK.logger.info _('No answers given, interview cancelled.')
+          PDK.logger.info 'No answers given, interview cancelled.'
           exit 0
         end
 
@@ -331,13 +319,13 @@ module PDK
           require 'pdk/cli/util'
 
           continue = PDK::CLI::Util.prompt_for_yes(
-            _('Metadata will be generated based on this information, continue?'),
+            'Metadata will be generated based on this information, continue?',
             prompt:         prompt,
-            cancel_message: _('Interview cancelled; exiting.'),
+            cancel_message: 'Interview cancelled; exiting.',
           )
 
           unless continue
-            PDK.logger.info _('Process cancelled; exiting.')
+            PDK.logger.info 'Process cancelled; exiting.'
             exit 0
           end
         end

data/lib/pdk/generate/puppet_object.rb

@@ -21,7 +21,7 @@ module PDK
       # @param object_name [String] The name of the object.
       # @param options [Hash{Symbol => Object}]
       def initialize(context, object_name, options)
-        raise ArgumentError, _('Expected PDK::Context::AbstractContext but got \'%{klass}\' for context') % { klass: context.class } unless context.is_a?(PDK::Context::AbstractContext)
+        raise ArgumentError, 'Expected PDK::Context::AbstractContext but got \'%{klass}\' for context' % { klass: context.class } unless context.is_a?(PDK::Context::AbstractContext)
         @context = context
         @options = options
         @object_name = object_name
@@ -61,7 +61,7 @@ module PDK
       # @return [void]
       # @abstract
       def check_preconditions
-        raise ArgumentError, _('Expected a module context but got %{context_name}') % { context_name: context.display_name } unless context.is_a?(PDK::Context::Module)
+        raise ArgumentError, 'Expected a module context but got %{context_name}' % { context_name: context.display_name } unless context.is_a?(PDK::Context::Module)
       end
 
       # Check the preconditions of this template group, behaving as a predicate rather than raising an exception.
@@ -122,7 +122,7 @@ module PDK
       def stage_change(relative_dest_path, content, update_manager)
         absolute_file_path = File.join(context.root_path, relative_dest_path)
         if PDK::Util::Filesystem.exist?(absolute_file_path)
-          raise PDK::CLI::ExitWithError, _("Unable to generate %{object_type}; '%{file}' already exists.") % {
+          raise PDK::CLI::ExitWithError, "Unable to generate %{object_type}; '%{file}' already exists." % {
             file:        absolute_file_path,
             object_type: spec_only? ? 'unit test' : friendly_name,
           }
@@ -160,7 +160,7 @@ module PDK
 
         templates.each do |template|
           if template[:uri].nil?
-            PDK.logger.debug(_('No %{dir_type} template found; trying next template directory.') % { dir_type: template[:type] })
+            PDK.logger.debug('No %{dir_type} template found; trying next template directory.' % { dir_type: template[:type] })
             next
           end
 
@@ -170,9 +170,9 @@ module PDK
               # TODO: refactor to a search-and-execute form instead
               return # work is done # rubocop:disable Lint/NonLocalExitFromIterator
             elsif template[:allow_fallback]
-              PDK.logger.debug(_('Unable to find a %{type} template in %{url}; trying next template directory.') % { type: friendly_name, url: template[:uri] })
+              PDK.logger.debug('Unable to find a %{type} template in %{url}; trying next template directory.' % { type: friendly_name, url: template[:uri] })
             else
-              raise PDK::CLI::FatalError, _('Unable to find the %{type} template in %{url}.') % { type: friendly_name, url: template[:uri] }
+              raise PDK::CLI::FatalError, 'Unable to find the %{type} template in %{url}.' % { type: friendly_name, url: template[:uri] }
             end
           end
         end

data/lib/pdk/generate/task.rb

@@ -28,7 +28,7 @@ module PDK
       def check_preconditions
         super
 
-        error = _("A task named '%{name}' already exists in this module; defined in %{file}")
+        error = "A task named '%{name}' already exists in this module; defined in %{file}"
         allowed_extensions = %w[.md .conf]
 
         PDK::Util::Filesystem.glob(File.join(context.root_path, 'tasks', task_name + '.*')).each do |file|

data/lib/pdk/module/build.rb

@@ -126,10 +126,8 @@ module PDK
           PDK::Util::Filesystem.cp(path, dest_path, preserve: true)
         end
       rescue ArgumentError => e
-        raise PDK::CLI::ExitWithError, _(
-          '%{message} Rename the file or exclude it from the package ' \
-          'by adding it to the .pdkignore file in your module.',
-        ) % { message: e.message }
+        raise PDK::CLI::ExitWithError, '%{message} Rename the file or exclude it from the package ' \
+                                       'by adding it to the .pdkignore file in your module.' % { message: e.message }
       end
 
       # Check if the given path matches one of the patterns listed in the
@@ -156,7 +154,7 @@ module PDK
         symlink_path = Pathname.new(path)
         module_path = Pathname.new(module_dir)
 
-        PDK.logger.warn _('Symlinks in modules are not supported and will not be included in the package. Please investigate symlink %{from} -> %{to}.') % {
+        PDK.logger.warn 'Symlinks in modules are not supported and will not be included in the package. Please investigate symlink %{from} -> %{to}.' % {
           from: symlink_path.relative_path_from(module_path),
           to:   symlink_path.realpath.relative_path_from(module_path),
         }
@@ -183,7 +181,7 @@ module PDK
       # @return [nil]
       def validate_ustar_path!(path)
         if path.bytesize > 256
-          raise ArgumentError, _("The path '%{path}' is longer than 256 bytes.") % {
+          raise ArgumentError, "The path '%{path}' is longer than 256 bytes." % {
             path: path,
           }
         end
@@ -207,11 +205,10 @@ module PDK
 
         return unless path.bytesize > 100 || prefix.bytesize > 155
 
-        raise ArgumentError, _(
-          "'%{path}' could not be split at a directory separator into two " \
-          'parts, the first having a maximum length of 155 bytes and the ' \
-          'second having a maximum length of 100 bytes.',
-        ) % { path: path }
+        raise ArgumentError,
+              "'%{path}' could not be split at a directory separator into two " \
+              'parts, the first having a maximum length of 155 bytes and the ' \
+              'second having a maximum length of 100 bytes.' % { path: path }
       end
 
       # Checks if the path contains any non-ASCII characters.
@@ -229,10 +226,8 @@ module PDK
       def validate_path_encoding!(path)
         return unless path =~ %r{[^\x00-\x7F]}
 
-        raise ArgumentError, _(
-          "'%{path}' can only include ASCII characters in its path or " \
-          'filename in order to be compatible with a wide range of hosts.',
-        ) % { path: path }
+        raise ArgumentError, "'%{path}' can only include ASCII characters in its path or " \
+                             'filename in order to be compatible with a wide range of hosts.' % { path: path }
       end
 
       # Creates a gzip compressed tarball of the build directory.
@@ -263,7 +258,7 @@ module PDK
               entry_meta[:mode] = orig_mode | min_mode
 
               if entry_meta[:mode] != orig_mode
-                PDK.logger.debug(_('Updated permissions of packaged \'%{entry}\' to %{new_mode}') % {
+                PDK.logger.debug('Updated permissions of packaged \'%{entry}\' to %{new_mode}' % {
                   entry: entry,
                   new_mode: (entry_meta[:mode] & 0o7777).to_s(8),
                 })

data/lib/pdk/module/convert.rb

@@ -30,7 +30,7 @@ module PDK
           else
             require 'pdk/report'
 
-            PDK::Report.default_target.puts(_('No changes required.'))
+            PDK::Report.default_target.puts('No changes required.')
           end
 
           return
@@ -45,12 +45,10 @@ module PDK
         unless force?
           require 'pdk/cli/util'
 
-          PDK.logger.info _(
-            'Module conversion is a potentially destructive action. ' \
-            'Ensure that you have committed your module to a version control ' \
-            'system or have a backup, and review the changes above before continuing.',
-          )
-          continue = PDK::CLI::Util.prompt_for_yes(_('Do you want to continue and make these changes to your module?'))
+          PDK.logger.info 'Module conversion is a potentially destructive action. ' \
+                          'Ensure that you have committed your module to a version control ' \
+                          'system or have a backup, and review the changes above before continuing.'
+          continue = PDK::CLI::Util.prompt_for_yes('Do you want to continue and make these changes to your module?')
           return unless continue
         end
 
@@ -128,7 +126,7 @@ module PDK
           update_manager.sync_changes!
           print_summary
         else
-          PDK::Report.default_target.puts(_('No test changes required.'))
+          PDK::Report.default_target.puts('No test changes required.')
         end
       end
 
@@ -155,7 +153,7 @@ module PDK
             absolute_file_path = File.join(module_dir, relative_file_path)
             case file_status
             when :unmanage
-              PDK.logger.debug(_("skipping '%{path}'") % { path: absolute_file_path })
+              PDK.logger.debug("skipping '%{path}'" % { path: absolute_file_path })
             when :delete
               update_manager.remove_file(absolute_file_path)
             when :init
@@ -194,7 +192,7 @@ module PDK
 
         if PDK::Util::Filesystem.file?(metadata_path)
           unless PDK::Util::Filesystem.readable?(metadata_path)
-            raise PDK::CLI::ExitWithError, _('Unable to update module metadata; %{path} exists but it is not readable.') % {
+            raise PDK::CLI::ExitWithError, 'Unable to update module metadata; %{path} exists but it is not readable.' % {
               path: metadata_path,
             }
           end
@@ -210,7 +208,7 @@ module PDK
             metadata = PDK::Generate::Module.prepare_metadata(options) unless options[:noop]
           end
         elsif PDK::Util::Filesystem.exist?(metadata_path)
-          raise PDK::CLI::ExitWithError, _('Unable to update module metadata; %{path} exists but it is not a file.') % {
+          raise PDK::CLI::ExitWithError, 'Unable to update module metadata; %{path} exists but it is not a file.' % {
             path: metadata_path,
           }
         else
@@ -255,20 +253,20 @@ module PDK
         summary.keys.each do |category|
           next if summary[category].empty?
 
-          PDK::Report.default_target.puts(_("\n%{banner}") % { banner: generate_banner("Files to be #{category}", 40) })
+          PDK::Report.default_target.puts("\n%{banner}" % { banner: generate_banner("Files to be #{category}", 40) })
           PDK::Report.default_target.puts(summary[category])
           footer = true
         end
 
-        PDK::Report.default_target.puts(_("\n%{banner}") % { banner: generate_banner('', 40) }) if footer
+        PDK::Report.default_target.puts("\n%{banner}" % { banner: generate_banner('', 40) }) if footer
       end
 
       def print_result(banner_text)
         require 'pdk/report'
 
-        PDK::Report.default_target.puts(_("\n%{banner}") % { banner: generate_banner(banner_text, 40) })
+        PDK::Report.default_target.puts("\n%{banner}" % { banner: generate_banner(banner_text, 40) })
         summary_to_print = summary.map { |k, v| "#{v.length} files #{k}" unless v.empty? }.compact
-        PDK::Report.default_target.puts(_("\n%{summary}\n\n") % { summary: "#{summary_to_print.join(', ')}." })
+        PDK::Report.default_target.puts("\n%{summary}\n\n" % { summary: "#{summary_to_print.join(', ')}." })
       end
 
       def full_report(path)
@@ -277,7 +275,7 @@ module PDK
         report = ["/* Report generated by PDK at #{Time.now} */"]
         report.concat(update_manager.changes[:modified].map { |_, diff| "\n\n\n#{diff}" })
         PDK::Util::Filesystem.write_file(path, report.join)
-        PDK::Report.default_target.puts(_("\nYou can find a report of differences in %{path}.\n\n") % { path: path })
+        PDK::Report.default_target.puts("\nYou can find a report of differences in %{path}.\n\n" % { path: path })
       end
 
       def generate_banner(text, width = 80)

data/lib/pdk/module/metadata.rb

@@ -92,22 +92,22 @@ module PDK
 
       def self.from_file(metadata_json_path)
         if metadata_json_path.nil?
-          raise ArgumentError, _('Cannot read metadata from file: no path to file was given.')
+          raise ArgumentError, 'Cannot read metadata from file: no path to file was given.'
         end
 
         unless PDK::Util::Filesystem.file?(metadata_json_path)
-          raise ArgumentError, _("'%{file}' does not exist or is not a file.") % { file: metadata_json_path }
+          raise ArgumentError, "'%{file}' does not exist or is not a file." % { file: metadata_json_path }
         end
 
         unless PDK::Util::Filesystem.readable?(metadata_json_path)
-          raise ArgumentError, _("Unable to open '%{file}' for reading.") % { file: metadata_json_path }
+          raise ArgumentError, "Unable to open '%{file}' for reading." % { file: metadata_json_path }
         end
 
         require 'json'
         begin
           data = JSON.parse(PDK::Util::Filesystem.read_file(metadata_json_path))
         rescue JSON::JSONError => e
-          raise ArgumentError, _('Invalid JSON in metadata.json: %{msg}') % { msg: e.message }
+          raise ArgumentError, 'Invalid JSON in metadata.json: %{msg}' % { msg: e.message }
         end
 
         require 'pdk/util'
@@ -144,9 +144,9 @@ module PDK
 
       def validate_puppet_version_requirement!
         msgs = {
-          no_reqs:       _('Module metadata does not contain any requirements.'),
-          no_puppet_req: _('Module metadata does not contain a "puppet" requirement.'),
-          no_puppet_ver: _('The "puppet" requirement in module metadata does not specify a "version_requirement".'),
+          no_reqs:       'Module metadata does not contain any requirements.',
+          no_puppet_req: 'Module metadata does not contain a "puppet" requirement.',
+          no_puppet_ver: 'The "puppet" requirement in module metadata does not specify a "version_requirement".',
         }
 
         raise ArgumentError, msgs[:no_reqs] unless @data.key?('requirements')
@@ -186,16 +186,16 @@ module PDK
 
         err = case modname
               when nil, '', :namespace_missing
-                _('Field must be a dash-separated user name and module name.')
+                'Field must be a dash-separated user name and module name.'
               when %r{[^a-z0-9_]}i
-                _('Module name must contain only alphanumeric or underscore characters.')
+                'Module name must contain only alphanumeric or underscore characters.'
               when %r{^[^a-z]}i
-                _('Module name must begin with a letter.')
+                'Module name must begin with a letter.'
               else
-                _('Namespace must contain only alphanumeric characters.')
+                'Namespace must contain only alphanumeric characters.'
               end
 
-        raise ArgumentError, _("Invalid 'name' field in metadata.json: %{err}") % { err: err }
+        raise ArgumentError, "Invalid 'name' field in metadata.json: %{err}" % { err: err }
       end
     end
   end