Rubocop fixes, update to rubocop todo

Author: tuxmea

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2026-02-04 04:17:01 UTC using RuboCop version 1.81.7.
+# on 2026-02-04 09:34:48 UTC using RuboCop version 1.81.7.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -12,20 +12,6 @@ Gemspec/RequiredRubyVersion:
   Exclude:
     - 'puppet_docs.gemspec'
 
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: RequireParenthesesForMethodChains.
-Lint/AmbiguousRange:
-  Exclude:
-    - 'lib/puppet_docs/auto_redirects.rb'
-
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: AllowSafeAssignment.
-Lint/AssignmentInCondition:
-  Exclude:
-    - 'source/_plugins/partial.rb'
-
 # Offense count: 4
 # Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches, IgnoreDuplicateElseBranch.
 Lint/DuplicateBranch:
@@ -39,12 +25,6 @@ Lint/MixedRegexpCaptureTypes:
   Exclude:
     - 'source/_plugins/partial.rb'
 
-# Offense count: 2
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Lint/NonAtomicFileOperation:
-  Exclude:
-    - 'Rakefile'
-
 # Offense count: 1
 # Configuration parameters: AllowComments, AllowNil.
 Lint/SuppressedException:
@@ -103,32 +83,6 @@ Performance/CollectionLiteralInLoop:
     - 'lib/puppet_references/puppet/type.rb'
     - 'lib/puppet_references/version_tables/data/pe.rb'
 
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: SafeMultiline.
-Performance/DeletePrefix:
-  Exclude:
-    - 'lib/puppet_docs/config.rb'
-
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Performance/Detect:
-  Exclude:
-    - 'source/_plugins/markdown_blocks.rb'
-
-# Offense count: 2
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Performance/MapCompact:
-  Exclude:
-    - 'lib/puppet_docs/config.rb'
-    - 'lib/puppet_docs/versions.rb'
-
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Performance/StringInclude:
-  Exclude:
-    - 'lib/puppet_references/version_tables/data/pe.rb'
-
 # Offense count: 11
 # This cop supports safe autocorrection (--autocorrect).
 Rake/Desc:
@@ -140,71 +94,22 @@ Rake/MethodDefinitionInTask:
   Exclude:
     - 'Rakefile'
 
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle, EnforcedStyleForClasses, EnforcedStyleForModules.
-# SupportedStyles: nested, compact
-# SupportedStylesForClasses: ~, nested, compact
-# SupportedStylesForModules: ~, nested, compact
-Style/ClassAndModuleChildren:
-  Exclude:
-    - 'source/_plugins/sitemap_generator.rb'
-
 # Offense count: 3
 Style/ClassVars:
   Exclude:
     - 'lib/puppet_references/puppet/strings.rb'
 
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Style/CombinableLoops:
-  Exclude:
-    - 'lib/puppet_docs/config.rb'
-
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Style/CommentedKeyword:
-  Exclude:
-    - 'lib/puppet_references/util.rb'
-
 # Offense count: 43
 # Configuration parameters: AllowedConstants.
 Style/Documentation:
   Enabled: false
 
-# Offense count: 57
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: always, always_true, never
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
 # Offense count: 5
 # Configuration parameters: AllowedVariables.
 Style/GlobalVars:
   Exclude:
     - 'util/bbedit_tools/Markdown_with_kramdown.rb'
 
-# Offense count: 3
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: AllowSplatArgument.
-Style/HashConversion:
-  Exclude:
-    - 'lib/puppet_references/version_tables/data/agent.rb'
-    - 'lib/puppet_references/version_tables/data/pe.rb'
-
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Style/HashTransformKeys:
-  Exclude:
-    - 'lib/puppet_references/util.rb'
-
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Style/HashTransformValues:
-  Exclude:
-    - 'lib/puppet_docs/config.rb'
-
 # Offense count: 8
 # This cop supports safe autocorrection (--autocorrect).
 Style/IfUnlessModifier:
@@ -215,21 +120,6 @@ Style/IfUnlessModifier:
     - 'lib/puppet_references/version_tables/data/agent.rb'
     - 'lib/puppet_references/version_tables/data/pe.rb'
 
-# Offense count: 3
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: InverseMethods, InverseBlocks.
-Style/InverseMethods:
-  Exclude:
-    - 'lib/puppet_docs/config.rb'
-    - 'lib/puppet_references/puppet/man.rb'
-    - 'source/_plugins/limited_preview_hook.rb'
-
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Style/MinMaxComparison:
-  Exclude:
-    - 'source/_plugins/sitemap_generator.rb'
-
 # Offense count: 1
 Style/MixinUsage:
   Exclude:
@@ -255,57 +145,16 @@ Style/OptionalBooleanParameter:
   Exclude:
     - 'lib/puppet_references/puppet/strings.rb'
 
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle, AllowedCompactTypes.
-# SupportedStyles: compact, exploded
-Style/RaiseArgs:
-  Exclude:
-    - 'source/_plugins/partial.rb'
-
-# Offense count: 2
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Style/RedundantInterpolation:
-  Exclude:
-    - 'Rakefile'
-    - 'lib/puppet_references/puppet/man.rb'
-
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Style/RedundantSort:
-  Exclude:
-    - 'lib/puppet_references/version_tables/data/agent.rb'
-
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: ConvertCodeThatCanStartToReturnNil, AllowedMethods, MaxChainLength.
-# AllowedMethods: present?, blank?, presence, try, try!
-Style/SafeNavigation:
-  Exclude:
-    - 'source/_plugins/partial.rb'
-
-# Offense count: 3
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Style/SlicingWithRange:
-  Exclude:
-    - 'lib/puppet_docs/auto_redirects.rb'
-    - 'lib/puppet_references/repo.rb'
-    - 'source/_plugins/partial.rb'
-
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: RequireEnglish.
-# SupportedStyles: use_perl_names, use_english_names, use_builtin_english_names
-Style/SpecialGlobalVars:
-  EnforcedStyle: use_perl_names
-
-# Offense count: 64
+# Offense count: 5
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: Mode.
 Style/StringConcatenation:
-  Enabled: false
+  Exclude:
+    - 'lib/puppet_references/puppet/functions.rb'
+    - 'lib/puppet_references/puppet/type_strings.rb'
+    - 'util/bbedit_tools/Markdown_with_kramdown.rb'
 
-# Offense count: 45
+# Offense count: 41
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
 # URISchemes: http, https

Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org/'
 gemspec name: 'puppet_docs'
 

Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'bundler/setup'
 require 'rake'
@@ -60,7 +62,7 @@ task :preview, :filename do |_t, args|
   end
 
   # Make sure we have a stash_directory
-  FileUtils.mkdir(STASH_DIR) unless File.exist?(STASH_DIR)
+  FileUtils.mkdir_p(STASH_DIR)
 
   # Directories and files we have to have for a good live preview
   required_dirs = ['_config.yml', '_includes', '_plugins', 'files', 'favicon.ico', '_layouts', 'images']
@@ -108,7 +110,7 @@ end
 desc 'Move all stashed directories back into the source directory, ready for site generation. '
 task :unpreview do
   puts "\n*** Putting back the stashed files, removing the preview directory."
-  FileUtils.mv Dir.glob("#{STASH_DIR}/*"), "#{SOURCE_DIR}"
+  FileUtils.mv Dir.glob("#{STASH_DIR}/*"), SOURCE_DIR.to_s
   FileUtils.rm_rf(PREVIEW_DIR)
   puts "\n*** Done.\n\n"
 end

config.ru

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 
 module Rack
@@ -13,7 +15,7 @@ module Rack
       return @app.call(env) if stat.file?
 
       if stat.directory?
-        index = Pathname.new(path) + 'index.html'
+        index = "#{Pathname.new(path)}index.html"
         return list_directory(path_info, path, script_name) unless index.readable?
 
         env['PATH_INFO'] = env['PATH_INFO'].sub(%r{/?$}, '/index.html')
@@ -35,7 +37,7 @@ module Rack
       return @app.call(@env) if @stat.file?
 
       if @stat.directory?
-        index = Pathname.new(@path) + 'index.html'
+        index = "#{Pathname.new(@path)}index.html"
         return list_directory(@path_info, @path, @script_name) unless index.readable?
 
         @env['PATH_INFO'] = @env['PATH_INFO'].sub(%r{/?$}, '/index.html')
@@ -50,4 +52,4 @@ end
 
 puts '>>> Serving at http://localhost:9292'
 
-run Rack::DirectoryWithIndexes.new(Pathname.new(__FILE__).parent + 'output')
+run Rack::DirectoryWithIndexes.new("#{Pathname.new(__FILE__).parent}output")

config/deploy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 set :application, 'docs.puppet.com'
 set :repository, 'git://github.com/puppetlabs/puppet-docs.git'
 set :user, 'docsdeploy'
@@ -33,7 +35,7 @@
     Rake::Task['check_build_version'].invoke
     puts "DEPLOYING TO: #{domain}"
 
-    stage_dir = deploy_to + '/stage'
+    stage_dir = "#{deploy_to}/stage"
 
     sh "rsync -crlpv --delete --force output/ #{domain}:#{stage_dir}/"
 

lib/puppet_docs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 
 module PuppetDocs

lib/puppet_docs/auto_redirects.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 
 module PuppetDocs
@@ -45,7 +47,7 @@ def self.generate(config, redirects_yaml)
           at_baseurl = config['document_version_index'][doc][at_version]
           at_index = config['document_version_order'][doc].index(at_baseurl)
           new_versions = [latest] + config['document_version_order'][doc][0..at_index]
-          old_versions = config['document_version_order'][doc][at_index + 1..-1]
+          old_versions = config['document_version_order'][doc][(at_index + 1)..]
 
           generated_rewrites = if forward_only
                                  [
@@ -62,7 +64,7 @@ def self.generate(config, redirects_yaml)
       end
 
       # Return a string ready to append to the nginx config file:
-      redirect_lines.join("\n") + "\n"
+      "#{redirect_lines.join("\n")}\n"
     end
 
     # Normalize string-or-array into normal array, and strip leading ./ or /