Layout/CommentIndentation

mhashizume · mhashizume · commit cca38069f348 · 2023-12-19T13:00:25.000-08:00
This commit enables the Rubocop Layout/CommentIndentation cop.
diff --git a/.rubocop_todo.yml b/.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: AllowForAlignment.
-Layout/CommentIndentation:
-  Enabled: false
-
 # This cop supports safe auto-correction (--auto-correct).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: leading, trailing
diff --git a/lib/puppet/application/script.rb b/lib/puppet/application/script.rb
@@ -248,7 +248,7 @@ def setup
     # installed where a settings catalog have already been applied...
     # This saves 1/5th of the startup time
 
-#    Puppet.settings.use :main, :agent, :ssl
+    #    Puppet.settings.use :main, :agent, :ssl
 
     # When running a script, the catalog is not relevant, and neither is caching of it
     Puppet::Resource::Catalog.indirection.cache_class = nil
diff --git a/lib/puppet/defaults.rb b/lib/puppet/defaults.rb
@@ -1273,7 +1273,7 @@ def self.initialize_default_settings!(settings)
     }
   )
 
-  # Define the config default.
+    # Define the config default.
 
     settings.define_settings(:application,
       :config_file_name => {
@@ -2054,7 +2054,7 @@ def self.initialize_default_settings!(settings)
     }
   )
 
-  # Central fact information.
+    # Central fact information.
 
     settings.define_settings(
     :main,
diff --git a/lib/puppet/metatype/manager.rb b/lib/puppet/metatype/manager.rb
@@ -38,8 +38,8 @@ def clear_misses
   # @return [Object] the last returned value from the block.
   def eachtype
     @types.each do |_name, type|
-      # Only consider types that have names
-      #if ! type.parameters.empty? or ! type.validproperties.empty?
+        # Only consider types that have names
+        #if ! type.parameters.empty? or ! type.validproperties.empty?
         yield type
       #end
     end
diff --git a/lib/puppet/parameter/value_collection.rb b/lib/puppet/parameter/value_collection.rb
@@ -121,7 +121,7 @@ def munge(value)
   # @option options [Symbol] :event The event that should be emitted when this value is set.
   # @todo Option :event original comment says "event should be returned...", is "returned" the correct word
   #   to use?
- # @option options [Symbol] :invalidate_refreshes True if a change on this property should invalidate and
+  # @option options [Symbol] :invalidate_refreshes True if a change on this property should invalidate and
   #   remove any scheduled refreshes (from notify or subscribe) targeted at the same resource. For example, if
   #   a change in this property takes into account any changes that a scheduled refresh would have performed,
   #   then the scheduled refresh would be deleted.
diff --git a/lib/puppet/parser/ast.rb b/lib/puppet/parser/ast.rb
@@ -31,9 +31,9 @@ def safeevaluate(scope)
       return self.evaluate(scope)
     rescue Puppet::Pops::Evaluator::PuppetStopIteration => detail
       raise detail
-#      # Only deals with StopIteration from the break() function as a general
-#      # StopIteration is a general runtime problem
-#      raise Puppet::ParseError.new(detail.message, detail.file, detail.line, detail)
+    #      # Only deals with StopIteration from the break() function as a general
+    #      # StopIteration is a general runtime problem
+    #      raise Puppet::ParseError.new(detail.message, detail.file, detail.line, detail)
     rescue Puppet::Error => detail
       raise adderrorcontext(detail)
     rescue => detail
diff --git a/lib/puppet/parser/ast/pops_bridge.rb b/lib/puppet/parser/ast/pops_bridge.rb
@@ -103,7 +103,7 @@ def instantiate(modname)
           nil
         end
       end.flatten().compact() # flatten since node definition may have returned an array
-                              # Compact since 4x definitions are not understood by compiler
+      # Compact since 4x definitions are not understood by compiler
     end
 
     def evaluate(scope)
diff --git a/lib/puppet/parser/functions/require.rb b/lib/puppet/parser/functions/require.rb
@@ -1,5 +1,5 @@
-# frozen_string_literal: true
-# Requires the specified classes
+  # frozen_string_literal: true
+  # Requires the specified classes
 
   Puppet::Parser::Functions::newfunction(
     :require,
diff --git a/lib/puppet/pops/loader/loader_paths.rb b/lib/puppet/pops/loader/loader_paths.rb
@@ -45,14 +45,14 @@ def self.relative_paths_for_type(type, loader)
     result
   end
 
-#  # DO NOT REMOVE YET. needed later? when there is the need to decamel a classname
-#  def de_camel(fq_name)
-#    fq_name.to_s.gsub(/::/, '/').
-#    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-#    gsub(/([a-z\d])([A-Z])/,'\1_\2').
-#    tr("-", "_").
-#    downcase
-#  end
+  #  # DO NOT REMOVE YET. needed later? when there is the need to decamel a classname
+  #  def de_camel(fq_name)
+  #    fq_name.to_s.gsub(/::/, '/').
+  #    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+  #    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+  #    tr("-", "_").
+  #    downcase
+  #  end
 
   class SmartPath
     # Creates SmartPath for the given loader (loader knows how to check for existence etc.)
diff --git a/lib/puppet/pops/loader/static_loader.rb b/lib/puppet/pops/loader/static_loader.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
-  # Static Loader contains constants, basic data types and other types required for the system
-  # to boot.
-  #
+# Static Loader contains constants, basic data types and other types required for the system
+# to boot.
+#
 module Puppet::Pops
 module Loader
 class StaticLoader < Loader
diff --git a/lib/puppet/pops/lookup/explainer.rb b/lib/puppet/pops/lookup/explainer.rb
@@ -2,12 +2,12 @@
 module Puppet::Pops
 module Lookup
 
-# The ExplainNode contains information of a specific node in a tree traversed during
-# lookup. The tree can be traversed using the `parent` and `branches` attributes of
-# each node.
-#
-# Each leaf node contains information about what happened when the leaf of the branch
-# was traversed.
+  # The ExplainNode contains information of a specific node in a tree traversed during
+  # lookup. The tree can be traversed using the `parent` and `branches` attributes of
+  # each node.
+  #
+  # Each leaf node contains information about what happened when the leaf of the branch
+  # was traversed.
   class ExplainNode
     def branches
       @branches ||= []
diff --git a/lib/puppet/pops/model/model_tree_dumper.rb b/lib/puppet/pops/model/model_tree_dumper.rb
@@ -66,7 +66,7 @@ def dump_CollectExpression o
 
   def dump_EppExpression o
     result = ["epp"]
-#    result << ["parameters"] + o.parameters.collect {|p| do_dump(p) } if o.parameters.size() > 0
+    #    result << ["parameters"] + o.parameters.collect {|p| do_dump(p) } if o.parameters.size() > 0
     if o.body
       result << do_dump(o.body)
     else
diff --git a/lib/puppet/pops/resource/resource_type_impl.rb b/lib/puppet/pops/resource/resource_type_impl.rb
@@ -202,16 +202,16 @@ def instantiate_resource(scope, resource)
     # This is what the Puppet::Type implementation does
     # None of this should be needed
 
-      #    # Make sure our parent class has been evaluated, if we have one.
-      #    if parent && !scope.catalog.resource(resource.type, parent)
-      #      parent_type(scope).ensure_in_catalog(scope)
-      #    end
+    #    # Make sure our parent class has been evaluated, if we have one.
+    #    if parent && !scope.catalog.resource(resource.type, parent)
+    #      parent_type(scope).ensure_in_catalog(scope)
+    #    end
 
     # This will never happen
 
-      #    if ['Class', 'Node'].include? resource.type
-      #      scope.catalog.tag(*resource.tags)
-      #    end
+    #    if ['Class', 'Node'].include? resource.type
+    #      scope.catalog.tag(*resource.tags)
+    #    end
   end
 
   # Being isomorphic in puppet means that the resource is managing a state
diff --git a/lib/puppet/pops/types/p_object_type.rb b/lib/puppet/pops/types/p_object_type.rb
@@ -485,7 +485,7 @@ def write(value, serializer)
     writer.write(self, value, serializer)
   end
 
-    # @api private
+  # @api private
   def create_new_function
     impl_class = implementation_class
     return impl_class.create_new_function(self) if impl_class.respond_to?(:create_new_function)
diff --git a/lib/puppet/pops/types/string_converter.rb b/lib/puppet/pops/types/string_converter.rb
@@ -497,7 +497,7 @@ def convert(value, string_formats = :default)
 
     case string_formats
     when :default
-     # do nothing, use default formats
+    # do nothing, use default formats
 
     when Hash
       # Convert and validate user input
@@ -511,14 +511,14 @@ def convert(value, string_formats = :default)
     _convert(value_type, value, options, DEFAULT_INDENTATION)
   end
 
-#  # A method only used for manual debugging as the default output of the formatting rules is
-#  # very hard to read otherwise.
-#  #
-#  # @api private
-#  def dump_string_formats(f, indent = 1)
-#     return f.to_s unless f.is_a?(Hash)
-#     "{#{f.map {|k,v| "#{k.to_s} => #{dump_string_formats(v,indent+1)}"}.join(",\n#{'  '*indent}  ")}}"
-#  end
+  #  # A method only used for manual debugging as the default output of the formatting rules is
+  #  # very hard to read otherwise.
+  #  #
+  #  # @api private
+  #  def dump_string_formats(f, indent = 1)
+  #     return f.to_s unless f.is_a?(Hash)
+  #     "{#{f.map {|k,v| "#{k.to_s} => #{dump_string_formats(v,indent+1)}"}.join(",\n#{'  '*indent}  ")}}"
+  #  end
 
   def _convert(val_type, value, format_map, indentation)
     @string_visitor.visit_this_3(self, val_type, value, format_map, indentation)
diff --git a/lib/puppet/pops/types/type_parser.rb b/lib/puppet/pops/types/type_parser.rb
@@ -197,7 +197,7 @@ def self.type_map
         'typealias'    => TypeFactory.type_alias,
         'typereference' => TypeFactory.type_reference,
         'typeset'      => TypeFactory.type_set,
-         # A generic callable as opposed to one that does not accept arguments
+        # A generic callable as opposed to one that does not accept arguments
         'callable'     => TypeFactory.all_callables,
         'semver'       => TypeFactory.sem_ver,
         'semverrange'  => TypeFactory.sem_ver_range,
diff --git a/lib/puppet/pops/validation.rb b/lib/puppet/pops/validation.rb
@@ -438,7 +438,7 @@ def prune(&block)
           @error_count -= 1
         when :warning
           @warning_count -= 1
-        # there is not ignore_count
+          # there is not ignore_count
         end
       end
       removed.empty? ? nil : removed
diff --git a/lib/puppet/provider/nameservice/directoryservice.rb b/lib/puppet/provider/nameservice/directoryservice.rb
@@ -96,7 +96,7 @@ def self.get_ds_path
   def self.list_all_present
     # rubocop:disable Naming/MemoizedInstanceVariableName
     @all_present ||= begin
-    # rubocop:enable Naming/MemoizedInstanceVariableName
+      # rubocop:enable Naming/MemoizedInstanceVariableName
       # JJM: List all objects of this Puppet::Type already present on the system.
       begin
         dscl_output = execute(get_exec_preamble("-list"))
diff --git a/lib/puppet/provider/service/debian.rb b/lib/puppet/provider/service/debian.rb
@@ -68,9 +68,9 @@ def enable
   end
 
   def statuscmd
-      # /usr/sbin/service provides an abstraction layer which is able to query services
-      # independent of the init system used.
-      # See https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=775795
+    # /usr/sbin/service provides an abstraction layer which is able to query services
+    # independent of the init system used.
+    # See https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=775795
     (@resource[:hasstatus] == :true) && [command(:service), @resource[:name], "status"]
   end
 end
diff --git a/lib/puppet/provider/user/directoryservice.rb b/lib/puppet/provider/user/directoryservice.rb
@@ -6,9 +6,9 @@
 Puppet::Type.type(:user).provide :directoryservice do
   desc "User management on OS X."
 
-##                   ##
-## Provider Settings ##
-##                   ##
+  ##                   ##
+  ## Provider Settings ##
+  ##                   ##
 
   # Provider command declarations
   commands :uuidgen      => '/usr/bin/uuidgen'
@@ -34,9 +34,9 @@
   #provider can set the user's shell
   has_feature :manages_shell
 
-##               ##
-## Class Methods ##
-##               ##
+  ##               ##
+  ## Class Methods ##
+  ##               ##
 
   # This method exists to map the dscl values to the correct Puppet
   # properties. This stays relatively consistent, but who knows what
@@ -240,9 +240,9 @@ def self.get_sha1(guid)
   end
 
 
-##                   ##
-## Ensurable Methods ##
-##                   ##
+  ##                   ##
+  ## Ensurable Methods ##
+  ##                   ##
 
   def exists?
     begin
@@ -322,9 +322,9 @@ def delete
     dscl '.', '-delete', "/Users/#{@resource.name}"
   end
 
-##                       ##
-## Getter/Setter Methods ##
-##                       ##
+  ##                       ##
+  ## Getter/Setter Methods ##
+  ##                       ##
 
   # In the setter method we're only going to take action on groups for which
   # the user is not currently a member.
diff --git a/lib/puppet/settings.rb b/lib/puppet/settings.rb
@@ -1094,7 +1094,7 @@ def to_config
 
 }.gsub(/^/, "# ")
 
-#         Add a section heading that matches our name.
+    #         Add a section heading that matches our name.
     str += "[#{preferred_run_mode}]\n"
     eachsection do |section|
       persection(section) do |obj|
diff --git a/lib/puppet/type/resources.rb b/lib/puppet/type/resources.rb
@@ -90,8 +90,8 @@
   end
 
   WINDOWS_SYSTEM_SID_REGEXES =
-      # Administrator, Guest, Domain Admins, Schema Admins, Enterprise Admins.
-      # https://support.microsoft.com/en-us/help/243330/well-known-security-identifiers-in-windows-operating-systems
+    # Administrator, Guest, Domain Admins, Schema Admins, Enterprise Admins.
+    # https://support.microsoft.com/en-us/help/243330/well-known-security-identifiers-in-windows-operating-systems
     [/S-1-5-21.+-500/, /S-1-5-21.+-501/, /S-1-5-21.+-512/, /S-1-5-21.+-518/,
      /S-1-5-21.+-519/]
 
diff --git a/lib/puppet/util/command_line/trollop.rb b/lib/puppet/util/command_line/trollop.rb
@@ -463,7 +463,7 @@ def parse_date_parameter param, arg #:nodoc:
   ## Print the help message to +stream+.
   def educate stream=$stdout
     width # just calculate it now; otherwise we have to be careful not to
-          # call this unless the cursor's at the beginning of a line.
+    # call this unless the cursor's at the beginning of a line.
 
     left = {}
     @specs.each do |name, spec|
diff --git a/lib/puppet/util/tagging.rb b/lib/puppet/util/tagging.rb
@@ -20,7 +20,7 @@ def tag(*ary)
         # not seen before, so now we test if it is valid
         if valid_tag?(name)
           if split_qualified_tags?
-          # avoid adding twice by first testing if the string contains '::'
+            # avoid adding twice by first testing if the string contains '::'
             @tags.merge(name.split('::')) if name.include?('::')
           end
         else
diff --git a/lib/puppet/util/windows/daemon.rb b/lib/puppet/util/windows/daemon.rb
@@ -121,7 +121,7 @@ class Daemon
           dwState = SERVICE_PAUSED
         when SERVICE_CONTROL_CONTINUE
           dwState = SERVICE_RUNNING
-        #else
+          #else
           # TODO: Handle other control codes? Retain the current state?
         end
 

Original file line number	Diff line number	Diff line change
`@@ -1273,7 +1273,7 @@ def self.initialize_default_settings!(settings)`
`1273`	`1273`	`}`
`1274`	`1274`	`)`
`1275`	`1275`
`1276`		`- # Define the config default.`
	`1276`	`+ # Define the config default.`
`1277`	`1277`
`1278`	`1278`	`settings.define_settings(:application,`
`1279`	`1279`	`:config_file_name => {`
`@@ -2054,7 +2054,7 @@ def self.initialize_default_settings!(settings)`
`2054`	`2054`	`}`
`2055`	`2055`	`)`
`2056`	`2056`
`2057`		`- # Central fact information.`
	`2057`	`+ # Central fact information.`
`2058`	`2058`
`2059`	`2059`	`settings.define_settings(`
`2060`	`2060`	`:main,`