Layout/LeadingCommentSpace

This commit enables the Rubocop Layout/LeadingCommentSpace cop and
addresses all offenses.

Author: mhashizume

.rubocop_todo.yml

@@ -22,11 +22,6 @@ I18n/GetText/DecorateStringFormattingUsingPercent:
 I18n/RailsI18n/DecorateString:
   Enabled: false
 
-# This cop supports safe auto-correction (--auto-correct).
-# Configuration parameters: AllowDoxygenCommentStyle, AllowGemfileRubyComment.
-Layout/LeadingCommentSpace:
-  Enabled: false
-
 # This cop supports safe auto-correction (--auto-correct).
 Layout/LeadingEmptyLines:
   Exclude:

lib/hiera/puppet_function.rb

@@ -62,7 +62,7 @@ def hiera_block2(scope, key, override, &default_block)
 
   def lookup(scope, key, default, has_default, override, &default_block)
     unless Puppet[:strict] == :off
-      #TRANSLATORS 'lookup' is a puppet function and should not be translated
+      # TRANSLATORS 'lookup' is a puppet function and should not be translated
       message = _("The function '%{class_name}' is deprecated in favor of using 'lookup'.") % { class_name: self.class.name }
       message += ' '+ _("See https://puppet.com/docs/puppet/%{minor_version}/deprecated_language.html") %
           { minor_version: Puppet.minor_version }

lib/puppet/application/agent.rb

@@ -400,7 +400,7 @@ def run_command
   end
 
   def log_config
-    #skip also config reading and parsing if debug is not enabled
+    # skip also config reading and parsing if debug is not enabled
     return unless Puppet::Util::Log.sendlevel?(:debug)
 
     Puppet.settings.stringify_settings(:agent, :all).each_pair do |k,v|

lib/puppet/configurer.rb

@@ -4,7 +4,7 @@
 require 'timeout'
 require_relative '../puppet/util'
 require 'securerandom'
-#require 'puppet/parser/script_compiler'
+# require 'puppet/parser/script_compiler'
 require_relative '../puppet/pops/evaluator/deferred_resolver'
 
 class Puppet::Configurer
@@ -330,7 +330,7 @@ def run(options = {})
             raise Puppet::Error, detail
           end
         else
-          #TRANSLATORS 'server_list' is the name of a setting and should not be translated
+          # TRANSLATORS 'server_list' is the name of a setting and should not be translated
           Puppet.debug _("Selected puppet server from the `server_list` setting: %{server}:%{port}") % { server: server, port: port }
           report.server_used = "#{server}:#{port}"
         end
@@ -559,7 +559,7 @@ def find_functional_server
       Puppet.debug(_("Puppet server %{host}:%{port} is unavailable: %{code} %{reason}") %
                    { host: e.response.url.host, port: e.response.url.port, code: e.response.code, reason: e.response.reason })
     rescue => detail
-      #TRANSLATORS 'server_list' is the name of a setting and should not be translated
+      # TRANSLATORS 'server_list' is the name of a setting and should not be translated
       Puppet.debug _("Unable to connect to server from server_list setting: %{detail}") % {detail: detail}
     end
     [nil, nil]

lib/puppet/configurer/fact_handler.rb

@@ -34,7 +34,7 @@ def facts_for_uploading
   end
 
   def encode_facts(facts)
-    #facts = find_facts
+    # facts = find_facts
 
     # NOTE: :facts specified as parameters are URI encoded here,
     # then  encoded for a second time depending on their length:

lib/puppet/daemon.rb

@@ -173,7 +173,7 @@ def run_event_loop
     end
 
     signal_loop = Puppet::Scheduler.create_job(SIGNAL_CHECK_INTERVAL) do
-      while method = @signals.shift #rubocop:disable Lint/AssignmentInCondition
+      while method = @signals.shift # rubocop:disable Lint/AssignmentInCondition
         Puppet.notice "Processing #{method}"
         send(method)
       end

lib/puppet/etc.rb

@@ -70,7 +70,7 @@ def endpwent
       ::Etc.endpwent
     end
 
-    #effectively equivalent to IO#rewind of /etc/passwd
+    # effectively equivalent to IO#rewind of /etc/passwd
     def setpwent
       ::Etc.setpwent
     end
@@ -116,7 +116,7 @@ def group
 
       setgrent
       begin
-        while cur_group = getgrent #rubocop:disable Lint/AssignmentInCondition
+        while cur_group = getgrent # rubocop:disable Lint/AssignmentInCondition
           yield cur_group
         end
       ensure

lib/puppet/face/config.rb

@@ -17,7 +17,7 @@
   DEFAULT_SECTION_MARKER = Object.new
   DEFAULT_SECTION = "main"
   option "--section " + _("SECTION_NAME") do
-    default_to { DEFAULT_SECTION_MARKER } #Sentinel object for default detection during commands
+    default_to { DEFAULT_SECTION_MARKER } # Sentinel object for default detection during commands
     summary _("The section of the configuration file to interact with.")
     description <<-EOT
       The section of the puppet.conf configuration file to interact with.
@@ -100,9 +100,9 @@ def warn_default_section(section_name)
     messages = []
     messages << _("No section specified; defaulting to '%{section_name}'.") %
       { section_name: section_name }
-    #TRANSLATORS '--section' is a command line option and should not be translated
+    # TRANSLATORS '--section' is a command line option and should not be translated
     messages << _("Set the config section by using the `--section` flag.")
-    #TRANSLATORS `puppet config --section user print foo` is a command line example and should not be translated
+    # TRANSLATORS `puppet config --section user print foo` is a command line example and should not be translated
     messages << _("For example, `puppet config --section user print foo`.")
     messages << _("For more information, see https://puppet.com/docs/puppet/latest/configuration.html")
 
@@ -201,7 +201,7 @@ def report_section_and_environment(section_name, environment_name)
   action(:delete) do
     summary _("Delete a Puppet setting.")
     arguments _("<setting>")
-    #TRANSLATORS 'main' is a specific section name and should not be translated
+    # TRANSLATORS 'main' is a specific section name and should not be translated
     description "Deletes a setting from the specified section. (The default is the section 'main')."
     notes <<-'EOT'
       By default, this action deletes the configuration setting from the 'main'
@@ -257,7 +257,7 @@ def report_section_and_environment(section_name, environment_name)
           end
         end
       else
-        #TRANSLATORS the 'puppet.conf' is a specific file and should not be translated
+        # TRANSLATORS the 'puppet.conf' is a specific file and should not be translated
         Puppet.warning(_("The puppet.conf file does not exist %{puppet_conf}") % { puppet_conf: path })
       end
       nil

lib/puppet/face/help.rb

@@ -42,7 +42,7 @@
       end
 
       if args.length > 2
-        #TRANSLATORS 'puppet help' is a command line and should not be translated
+        # TRANSLATORS 'puppet help' is a command line and should not be translated
         raise ArgumentError, _("The 'puppet help' command takes two (optional) arguments: a subcommand and an action")
       end
 
@@ -52,7 +52,7 @@
           version = options[:version]
         else
           if args.length == 0
-            #TRANSLATORS '--version' is a command line option and should not be translated
+            # TRANSLATORS '--version' is a command line option and should not be translated
             raise ArgumentError, _("Supplying a '--version' only makes sense when a Faces subcommand is given")
           end
         end
@@ -211,7 +211,7 @@ def horribly_extract_summary_from(appname)
     # depends on the implementation coincidence of how our pages are
     # formatted.  If we can't match the pattern we expect we return the empty
     # string to ensure we don't blow up in the summary. --daniel 2011-04-11
-    while line = help.shift do #rubocop:disable Lint/AssignmentInCondition
+    while line = help.shift do # rubocop:disable Lint/AssignmentInCondition
       md = /^puppet-#{appname}\([^\)]+\) -- (.*)$/.match(line)
       if md
         return md[1]
@@ -222,15 +222,15 @@ def horribly_extract_summary_from(appname)
   # This should absolutely be a private method, but for some reason it appears
   #  that you can't use the 'private' keyword inside of a Face definition.
   #  See #14205.
-  #private :horribly_extract_summary_from
+  # private :horribly_extract_summary_from
 
   def exclude_from_docs?(appname)
     %w{face_base indirection_base report status}.include? appname
   end
   # This should absolutely be a private method, but for some reason it appears
   #  that you can't use the 'private' keyword inside of a Face definition.
   #  See #14205.
-  #private :exclude_from_docs?
+  # private :exclude_from_docs?
 
   def is_face_app?(appname)
     clazz = Puppet::Application.find(appname)
@@ -240,5 +240,5 @@ def is_face_app?(appname)
   # This should probably be a private method, but for some reason it appears
   #  that you can't use the 'private' keyword inside of a Face definition.
   #  See #14205.
-  #private :is_face_app?
+  # private :is_face_app?
 end

lib/puppet/face/node.rb

@@ -19,7 +19,7 @@
   find = get_action(:find)
   find.summary _("Retrieve a node object.")
   find.arguments _("<host>")
-  #TRANSLATORS the following are specific names and should not be translated `classes`, `environment`, `expiration`, `name`, `parameters`, Puppet::Node
+  # TRANSLATORS the following are specific names and should not be translated `classes`, `environment`, `expiration`, `name`, `parameters`, Puppet::Node
   find.returns _(<<-'EOT')
     A hash containing the node's `classes`, `environment`, `expiration`, `name`,
     `parameters` (its facts, combined with any ENC-set parameters), and `time`.