puppet-lint 4.2.4 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b11b8ac88b45741f4cc6ec8a5eca05da09c52c1064a0bbd89394459981845b6
-  data.tar.gz: ed5b7f181a30f706ca4224a526d29212ed2a7e9fb4d2fea0927e2e2a3e02ae8c
+  metadata.gz: 4f8119856eb91c58047532aa02757d8b4904120ad6401a3af2b385a1a40aa321
+  data.tar.gz: 870ad4f57b3c1dfcf40207af7a84d5afc18ec388bb520e362e6d8bafbd647205
 SHA512:
-  metadata.gz: b79ad1ee950cc2dde1c61dd3adaf0b1900b80c63916d28f6ed5fba99f84ae76608ccfba01e533c6f7014f05b659904dc80ea9631b7ebfef573166a4a930b69ac
-  data.tar.gz: 927256f4add5e6c2fd2e0336ba6244b730223429de681fd73644e0c45df36b8d4237899af8bc2c92b7f3e4b159beedbe8c1071c94e5504178ea7dbfcaeb86d93
+  metadata.gz: 76294db75e44acc05da97c12f26f5dae32d358e4b0e254c92bda9a0d3f9948d0e07b2d6a6e615e238457214ea85f22e2d499e15184ad1b747665d63d667bdc80
+  data.tar.gz: 5d2402a687836436ceb7a63d7510d28acb6e594a399d2904cc2a2215d14971b006642cfb8a89365833af5a7307c08e44759e980870bd75e828944920e5149bc3

data/README.md

@@ -41,6 +41,8 @@ To instruct Lint to automatically fix any issues that it detects, use the `--fix
 puppet-lint --fix /modules
 ```
 
+Note: The auto-fix functionality is available for Puppet manifest files only.
+
 ### Modify which checks to run
 
 Puppet Lint options allow you to modify which checks to run. You can disable any of the checks temporarily or permanently, or you can limit testing to specific checks.
@@ -117,7 +119,7 @@ Any flag that can be specified on the command line can also be specified in the
 Or to specify an allowlist of allowed checks, include a line like:
 
 ```
---only-checks=trailing_whitespace,hard_tabs,duplicate_params,double_quoted_strings,unquoted_file_mode,only_variable_string,variables_not_enclosed,single_quote_string_with_variables,variable_contains_dash,ensure_not_symlink_target,unquoted_resource_title,relative_classname_inclusion,file_mode,resource_reference_without_title_capital,leading_zero,arrow_alignment,variable_is_lowercase,ensure_first_param,resource_reference_without_whitespace,file_ensure,trailing_comma,leading_zero
+--only-checks=trailing_whitespace,hard_tabs,duplicate_params,double_quoted_strings,unquoted_file_mode,only_variable_string,variables_not_enclosed,single_quote_string_with_variables,variable_contains_dash,ensure_not_symlink_target,unquoted_resource_title,relative_classname_inclusion,file_mode,resource_reference_without_title_capital,leading_zero,arrow_alignment,space_before_arrow,variable_is_lowercase,ensure_first_param,resource_reference_without_whitespace,file_ensure,trailing_comma,leading_zero
 ```
 
 Please note that there is an important difference between reading options from the command line and reading options from a configuration file: In the former case the shell interprets one level of quotes. That does not happen in the latter case. So, it would make sense to quote some configuration values on the command line, like so:
@@ -245,6 +247,23 @@ See `puppet-lint --help` for a full list of command line options and checks.
 
 For a complete list of checks, and how to resolve errors on each check, see the Puppet Lint [checks](http://puppet-lint.com/checks/) page.
 
+### YAML Checks
+
+Puppet Lint can check Hiera YAML files for legacy facts.
+
+For example, the following YAML would trigger warnings:
+
+```yaml
+hierarchy:
+  - name: "Legacy Facts Example"
+    paths:
+      - "os/%{facts.hostname}.yaml"
+      - "/var/www/%{::hostname}.yaml"
+      - "%{::bios_vendor}.yaml"
+```
+
+Refer to the [Puppet Core Facts documentation](https://www.puppet.com/docs/puppet/8/core_facts.html) for a complete list of available core facts.
+
 ### Spacing, Indentation, and Whitespace
 
 * Must use two-space soft tabs.
@@ -253,6 +272,7 @@ For a complete list of checks, and how to resolve errors on each check, see the
 * Should not exceed an 140-character line width.
   * An exception has been made for `source => 'puppet://...'` lines as splitting these over multiple lines decreases the readability of the manifests.
 * Should align arrows (`=>`) within blocks of attributes.
+* Should contain at most a single space before an arrows(`=>`) where the parameter block contains exactly one parameter.
 
 ### Quoting
 

data/lib/puppet-lint/bin.rb

@@ -66,7 +66,10 @@ class PuppetLint::Bin
 
       path = path.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR
       path = if File.directory?(path)
-               Dir.glob("#{path}/**/*.pp")
+               Dir.glob([
+                          "#{path}/**/*.pp",
+                          "#{path}/**/*.{yaml,yml}",
+                        ])
              else
                @args
              end

data/lib/puppet-lint/checkplugin.rb

@@ -180,9 +180,9 @@ class PuppetLint::CheckPlugin
   def default_info
     @default_info ||= {
       check: self.class.const_get(:NAME),
-      fullpath: fullpath,
-      path: path,
-      filename: filename
+      fullpath:,
+      path:,
+      filename:
     }
   end
 

data/lib/puppet-lint/checks.rb

@@ -6,6 +6,8 @@ class PuppetLint::Checks
   # Public: Get an Array of problem Hashes.
   attr_accessor :problems
 
+  YAML_COMPATIBLE_CHECKS = [:legacy_facts].freeze
+
   # Public: Initialise a new PuppetLint::Checks object.
   def initialize
     @problems = []
@@ -34,7 +36,7 @@ class PuppetLint::Checks
       problems << {
         kind: :error,
         check: :syntax,
-        message: message,
+        message:,
         line: e.line_no,
         column: e.column,
         fullpath: PuppetLint::Data.fullpath,
@@ -45,23 +47,34 @@ class PuppetLint::Checks
     end
   end
 
-  # Internal: Run the lint checks over the manifest code.
+  # Internal: Run the lint checks over the manifest or YAML code.
   #
   # fileinfo - The path to the file as passed to puppet-lint as a String.
-  # data     - The String manifest code to be checked.
+  # data     - The String manifest or YAML code to be checked.
   #
   # Returns an Array of problem Hashes.
   def run(fileinfo, data)
-    load_data(fileinfo, data)
-
     checks_run = []
-    enabled_checks.each do |check|
-      klass = PuppetLint.configuration.check_object[check].new
-      # FIXME: shadowing #problems
-      problems = klass.run
-      checks_run << [klass, problems]
-    end
+    if File.extname(fileinfo).downcase.match?(%r{\.ya?ml$})
+      PuppetLint::Data.path = fileinfo
+      PuppetLint::Data.manifest_lines = data.split("\n", -1)
 
+      enabled_checks.select { |check| YAML_COMPATIBLE_CHECKS.include?(check) }.each do |check|
+        klass = PuppetLint.configuration.check_object[check].new
+        # FIXME: shadowing #problems
+        problems = klass.run
+        checks_run << [klass, problems]
+      end
+    else
+      load_data(fileinfo, data)
+
+      enabled_checks.each do |check|
+        klass = PuppetLint.configuration.check_object[check].new
+        # FIXME: shadowing #problems
+        problems = klass.run
+        checks_run << [klass, problems]
+      end
+    end
     checks_run.each do |klass, problems|
       if PuppetLint.configuration.fix
         @problems.concat(klass.fix_problems)

data/lib/puppet-lint/configuration.rb

@@ -48,7 +48,7 @@ class PuppetLint::Configuration
   # Signature
   #
   #   <option>=(value)
-  def method_missing(method, *args, &_block)
+  def method_missing(method, *args, &)
     super unless method.to_s =~ %r{^(\w+)=?$}
 
     option = Regexp.last_match(1)

data/lib/puppet-lint/data.rb

@@ -359,7 +359,7 @@ class PuppetLint::Data
                 end: i + j + 1,
                 tokens: tokens[i..(i + j + 1)],
                 param_tokens: param_tokens(tokens[i..(i + j + 1)]),
-                type: type,
+                type:,
                 name_token: token.next_code_token,
                 inherited_token: inherited_class
               }
@@ -386,7 +386,7 @@ class PuppetLint::Data
       @function_indexes ||= begin
         functions = []
         tokens.each_with_index do |token, token_idx|
-          next unless token.type == :NAME
+          next unless token.type == :FUNCTION_NAME
           next unless token_idx.zero? ||
                       (token_idx == 1 && tokens[0].type == :WHITESPACE) ||
                       [:NEWLINE, :INDENT].include?(token.prev_token.type) ||

data/lib/puppet-lint/lexer/string_slurper.rb

@@ -6,12 +6,12 @@ class PuppetLint::Lexer
   class StringSlurper
     attr_accessor :scanner, :results, :interp_stack
 
-    START_INTERP_PATTERN = %r{\$\{}.freeze
-    END_INTERP_PATTERN = %r{\}}.freeze
-    END_STRING_PATTERN = %r{(\A|[^\\])(\\\\)*"}.freeze
-    UNENC_VAR_PATTERN = %r{(\A|[^\\])\$(::)?(\w+(-\w+)*::)*\w+(-\w+)*}.freeze
-    ESC_DQUOTE_PATTERN = %r{\\+"}.freeze
-    LBRACE_PATTERN = %r{\{}.freeze
+    START_INTERP_PATTERN = %r{\$\{}
+    END_INTERP_PATTERN = %r{\}}
+    END_STRING_PATTERN = %r{(\A|[^\\])(\\\\)*"}
+    UNENC_VAR_PATTERN = %r{(\A|[^\\])\$(::)?(\w+(-\w+)*::)*\w+(-\w+)*}
+    ESC_DQUOTE_PATTERN = %r{\\+"}
+    LBRACE_PATTERN = %r{\{}
 
     def initialize(string)
       @scanner = StringScanner.new(string)

data/lib/puppet-lint/lexer/token.rb

@@ -172,9 +172,9 @@ class PuppetLint::Lexer
       return nil unless [:next, :prev].include?(direction)
 
       opts[:skip_blocks] ||= true
-      to_find = Array[*type]
+      to_find = [*type]
 
-      token_iter = send("#{direction}_token".to_sym)
+      token_iter = send(:"#{direction}_token")
       until token_iter.nil?
         return token_iter if to_find.include?(token_iter.type) && (opts[:value].nil? || token_iter.value == opts[:value])
 
@@ -183,18 +183,18 @@ class PuppetLint::Lexer
 
         if opts[:skip_blocks]
           case token_iter.type
-          when "#{opening_token}BRACE".to_sym
-            token_iter = token_iter.send("#{direction}_token_of".to_sym, ["#{closing_token}BRACE".to_sym, opts])
-          when "#{opening_token}BRACK".to_sym
-            token_iter = token_iter.send("#{direction}_token_of".to_sym, ["#{closing_token}BRACK".to_sym, opts])
-          when "#{opening_token}PAREN".to_sym
-            token_iter = token_iter.send("#{direction}_token_of".to_sym, ["#{closing_token}PAREN".to_sym, opts])
+          when :"#{opening_token}BRACE"
+            token_iter = token_iter.send(:"#{direction}_token_of", [:"#{closing_token}BRACE", opts])
+          when :"#{opening_token}BRACK"
+            token_iter = token_iter.send(:"#{direction}_token_of", [:"#{closing_token}BRACK", opts])
+          when :"#{opening_token}PAREN"
+            token_iter = token_iter.send(:"#{direction}_token_of", [:"#{closing_token}PAREN", opts])
           end
         end
 
         return nil if token_iter.nil?
 
-        token_iter = token_iter.send("#{direction}_token".to_sym)
+        token_iter = token_iter.send(:"#{direction}_token")
       end
       nil
     end

data/lib/puppet-lint/lexer.rb

@@ -111,9 +111,9 @@ class PuppetLint::Lexer
   # \p{Zs} == ASCII + Unicode non-linebreaking whitespace
   WHITESPACE_RE = (RUBY_VERSION == '1.8.7') ? %r{[\t\v\f ]} : %r{[\t\v\f\p{Zs}]}
 
-  LINE_END_RE = %r{(?:\r\n|\r|\n)}.freeze
+  LINE_END_RE = %r{(?:\r\n|\r|\n)}
 
-  NAME_RE = %r{\A((?:(?:::)?[_a-z0-9][-\w]*)(?:::[a-z0-9][-\w]*)*)}.freeze
+  NAME_RE = %r{\A((?:(?:::)?[_a-z0-9][-\w]*)(?:::[a-z0-9][-\w]*)*)}
 
   # Internal: An Array of Arrays containing tokens that can be described by
   # a single regular expression.  Each sub-Array contains 2 elements, the
@@ -123,7 +123,44 @@ class PuppetLint::Lexer
     [:WHITESPACE, %r{\A(#{WHITESPACE_RE}+)}],
     # FIXME: Future breaking change, the following :TYPE tokens conflict with
     #        the :TYPE keyword token.
-    [:TYPE, %r{\A(Integer|Float|Boolean|Regexp|String|Array|Hash|Resource|Class|Collection|Scalar|Numeric|CatalogEntry|Data|Tuple|Struct|Optional|NotUndef|Variant|Enum|Pattern|Any|Callable|Type|Runtime|Undef|Default|Sensitive)\b}], # rubocop:disable Layout/LineLength
+    [:TYPE, %r{\A(
+      Any|
+      Array|
+      Binary|
+      Boolean|
+      Callable|
+      CatalogEntry|
+      Class|
+      Collection|
+      Data|
+      Default|
+      Enum|
+      Error|
+      Float|
+      Hash|
+      Integer|
+      Iterable|
+      Iterator|
+      NotUndef|
+      Numeric|
+      Optional|
+      Pattern|
+      Regexp|
+      Resource|
+      RichData|
+      Runtime|
+      Scalar|
+      ScalarData|
+      SemVer|
+      SemVerRange|
+      Sensitive|
+      String|
+      Struct|
+      Tuple|
+      Type|
+      Undef|
+      Variant
+    )\b}x],
     [:CLASSREF, %r{\A(((::){0,1}[A-Z][-\w]*)+)}],
     [:NUMBER, %r{\A\b((?:0[xX][0-9A-Fa-f]+|0?\d+(?:\.\d+)?(?:[eE]-?\d+)?))\b}],
     [:FUNCTION_NAME, %r{#{NAME_RE}(?=\()}],

data/lib/puppet-lint/optparser.rb

@@ -128,6 +128,10 @@ class PuppetLint::OptParser
         PuppetLint.configuration.ignore_paths = paths.split(',')
       end
 
+      opts.on('--top-scope-variables VARS', 'A comma separated list of allowed top scope variables') do |vars|
+        PuppetLint.configuration.top_scope_variables = vars.split(',')
+      end
+
       PuppetLint.configuration.checks.each do |check|
         opts.on("--no-#{check}-check", "Skip the #{check} check.") do
           PuppetLint.configuration.send(:"disable_#{check}")

data/lib/puppet-lint/plugins/check_classes/arrow_on_right_operand_line.rb

@@ -12,7 +12,7 @@ PuppetLint.new_check(:arrow_on_right_operand_line) do
         message: "arrow should be on the right operand's line",
         line: token.line,
         column: token.column,
-        token: token,
+        token:,
         description: 'Test the manifest tokens for chaining arrow that is on the line of the left operand when the right operand is on another line.',
         help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#chaining-arrow-syntax',
       )

data/lib/puppet-lint/plugins/check_comments/slash_comments.rb

@@ -12,7 +12,7 @@ PuppetLint.new_check(:slash_comments) do
         message: '// comment found',
         line: token.line,
         column: token.column,
-        token: token,
+        token:,
         description: 'Check the manifest tokens for any comments started with slashes (//) and record a warning for each instance found.',
         help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#comments',
       )

data/lib/puppet-lint/plugins/check_comments/star_comments.rb

@@ -12,7 +12,7 @@ PuppetLint.new_check(:star_comments) do
         message: '/* */ comment found',
         line: token.line,
         column: token.column,
-        token: token,
+        token:,
         description: 'Check the manifest tokens for any comments encapsulated with slash-asterisks (/* */) and record a warning for each instance found.',
         help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#comments',
       )

data/lib/puppet-lint/plugins/check_nodes/unquoted_node_name.rb

@@ -31,7 +31,7 @@ PuppetLint.new_check(:unquoted_node_name) do
           message: 'unquoted node name found',
           line: token.line,
           column: token.column,
-          token: token,
+          token:,
           description: 'Check the manifest for unquoted node names and record a warning for each instance found.',
           help_uri: nil,
         )

data/lib/puppet-lint/plugins/check_resources/ensure_first_param.rb

@@ -20,7 +20,7 @@ PuppetLint.new_check(:ensure_first_param) do
         message: "ensure found on line but it's not the first attribute",
         line: ensure_token.line,
         column: ensure_token.column,
-        resource: resource,
+        resource:,
         description: 'Check the tokens of each resource instance for an ensure parameter and if ' \
                      'found, check that it is the first parameter listed.  If it is not the first parameter, record a warning.',
         help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#attribute-ordering',

data/lib/puppet-lint/plugins/check_resources/ensure_not_symlink_target.rb

@@ -20,7 +20,7 @@ PuppetLint.new_check(:ensure_not_symlink_target) do
           line: value_token.line,
           column: value_token.column,
           param_token: ensure_token,
-          value_token: value_token,
+          value_token:,
           description: 'Check the tokens of each File resource instance for an ensure parameter and ' \
                        'record a warning if the value of that parameter looks like a symlink target (starts with a \'/\').',
           help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#symbolic-links',

data/lib/puppet-lint/plugins/check_resources/file_mode.rb

@@ -6,7 +6,7 @@
 MSG = 'mode should be represented as a 4 digit octal value or symbolic mode'.freeze
 SYM_RE = '([ugoa]*[-=+][-=+rstwxXugo]*)(,[ugoa]*[-=+][-=+rstwxXugo]*)*'.freeze
 IGNORE_TYPES = Set[:VARIABLE, :UNDEF, :FUNCTION_NAME]
-MODE_RE = %r{\A([0-7]{4}|#{SYM_RE})\Z}.freeze
+MODE_RE = %r{\A([0-7]{4}|#{SYM_RE})\Z}
 
 PuppetLint.new_check(:file_mode) do
   def check

data/lib/puppet-lint/plugins/check_resources/unquoted_resource_title.rb

@@ -12,7 +12,7 @@ PuppetLint.new_check(:unquoted_resource_title) do
         message: 'unquoted resource title',
         line: token.line,
         column: token.column,
-        token: token,
+        token:,
         description: 'Check the manifest tokens for any resource titles / namevars that are not quoted and record a warning for each instance found.',
         help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#resource-names',
       )

data/lib/puppet-lint/plugins/check_strings/double_quoted_strings.rb

@@ -3,7 +3,7 @@
 # each instance found.
 #
 # https://puppet.com/docs/puppet/latest/style_guide.html#quoting
-ESCAPE_CHAR_RE = %r{(\\\$|\\"|\\'|'|\r|\t|\\t|\\s|\n|\\n|\\\\)}.freeze
+ESCAPE_CHAR_RE = %r{(\\\$|\\"|\\'|'|\r|\t|\\t|\\s|\n|\\n|\\\\)}
 
 PuppetLint.new_check(:double_quoted_strings) do
   def check
@@ -18,7 +18,7 @@ PuppetLint.new_check(:double_quoted_strings) do
         message: 'double quoted string containing no variables',
         line: token.line,
         column: token.column,
-        token: token,
+        token:,
         description: 'Check the manifest tokens for any double quoted strings that don\'t ' \
                      'contain any variables or common escape characters and record a warning for each instance found.',
         help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#quoting',

data/lib/puppet-lint/plugins/check_strings/only_variable_string.rb

@@ -27,8 +27,8 @@ PuppetLint.new_check(:only_variable_string) do
               message: 'string containing only a variable',
               line: var_token.line,
               column: var_token.column,
-              start_token: start_token,
-              var_token: var_token,
+              start_token:,
+              var_token:,
               end_token: eos_token,
               description: 'Check the manifest tokens for double quoted strings that contain a single variable only and record a warning for each instance found.',
               help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#quoting',

data/lib/puppet-lint/plugins/check_strings/puppet_url_without_modules.rb

@@ -19,7 +19,7 @@ PuppetLint.new_check(:puppet_url_without_modules) do
         message: 'puppet:// URL without modules/ found',
         line: token.line,
         column: token.column,
-        token: token,
+        token:,
         description: 'Check the manifest tokens for any puppet:// URL strings where the path section doesn\'t start with modules/ and record a warning for each instance found.',
         help_uri: nil,
       )

data/lib/puppet-lint/plugins/check_strings/quoted_booleans.rb

@@ -18,7 +18,7 @@ PuppetLint.new_check(:quoted_booleans) do
         message: 'quoted boolean value found',
         line: token.line,
         column: token.column,
-        token: token,
+        token:,
         description: 'Check the manifest tokens for any double or single quoted strings containing only a boolean value and record a warning for each instance found.',
         help_uri: nil,
       )

data/lib/puppet-lint/plugins/check_strings/variables_not_enclosed.rb

@@ -25,7 +25,7 @@ PuppetLint.new_check(:variables_not_enclosed) do
         message: 'variable not enclosed in {}',
         line: token.line,
         column: token.column,
-        token: token,
+        token:,
         description: 'Check the manifest tokens for any variables in a string that have not been enclosed by braces ({}) and record a warning for each instance found.',
         help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#quoting',
       )

data/lib/puppet-lint/plugins/check_whitespace/hard_tabs.rb

@@ -16,7 +16,7 @@ PuppetLint.new_check(:hard_tabs) do
         message: 'tab character found',
         line: token.line,
         column: token.column,
-        token: token,
+        token:,
         description: 'Check the raw manifest string for lines containing hard tab characters and record an error for each instance found.',
         help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#spacing-indentation-and-whitespace',
       )

data/lib/puppet-lint/plugins/check_whitespace/space_before_arrow.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# Check the manifest tokens for any arrows (=>) that have too much space
+# before them in situations when a given resource has at most one line with
+# such arrows. For example:
+
+# file {
+#   # too much space after "foo"
+#   foo⎵⎵=>⎵'bar'
+# }
+#
+# file {
+#   # too much space after 'bar'
+#   foo⎵=>⎵{ bar⎵⎵=>⎵'baz' }
+# }
+#
+
+# Linting multi-parameter resources like this:
+#
+# package { 'xxx':
+#   foo => 'bar',
+#   bar  => 'baz',
+# }
+#
+# is handled by the "arrow_alignment" plugin.
+
+PuppetLint.new_check(:space_before_arrow) do
+  def check
+    resource_indexes.each do |res_idx|
+      resource_tokens = res_idx[:tokens]
+      resource_tokens.reject! do |token|
+        Set[:COMMENT, :SLASH_COMMENT, :MLCOMMENT].include?(token.type)
+      end
+
+      first_arrow = resource_tokens.index { |r| r.type == :FARROW }
+      last_arrow = resource_tokens.rindex { |r| r.type == :FARROW }
+      next if first_arrow.nil?
+      next if last_arrow.nil?
+
+      # If this is a single line resource, skip it
+      next unless resource_tokens[first_arrow].line == resource_tokens[last_arrow].line
+
+      resource_tokens.select { |token| token.type == :FARROW }.each do |token|
+        prev_token = token.prev_token
+        next unless prev_token
+        next if prev_token.value == ' '
+
+        line = prev_token.line
+        column = prev_token.column
+
+        notify(
+          :warning,
+          message: "there should be a single space before '=>' on line #{line}, column #{column}",
+          line:,
+          column:,
+          token: prev_token,
+        )
+      end
+    end
+  end
+
+  def fix(problem)
+    token = problem[:token]
+
+    if token.type == :WHITESPACE
+      token.value = ' '
+      return
+    end
+
+    add_token(tokens.index(token), PuppetLint::Lexer::Token.new(:WHITESPACE, ' ', 0, 0))
+  end
+end

data/lib/puppet-lint/plugins/check_whitespace/trailing_whitespace.rb

@@ -18,7 +18,7 @@ PuppetLint.new_check(:trailing_whitespace) do
         message: 'trailing whitespace found',
         line: token.line,
         column: token.column,
-        token: token,
+        token:,
         description: 'Check the manifest tokens for lines ending with whitespace and record an error for each instance found.',
         help_uri: 'https://puppet.com/docs/puppet/latest/style_guide.html#spacing-indentation-and-whitespace',
       )

data/lib/puppet-lint/plugins/legacy_facts/legacy_facts.rb

@@ -1,3 +1,5 @@
+require 'yaml'
+
 # Public: A puppet-lint custom check to detect legacy facts.
 #
 # This check will optionally convert from legacy facts like $::operatingsystem
@@ -112,6 +114,51 @@ HASH_KEY_TYPES = Set[
 
 PuppetLint.new_check(:legacy_facts) do
   def check
+    if File.extname(PuppetLint::Data.path).downcase.match?(%r{\.ya?ml$})
+      content = PuppetLint::Data.manifest_lines
+      yaml_content = content.join("\n")
+      data = YAML.safe_load(yaml_content, aliases: true, permitted_classes: [Symbol])
+      search_yaml(data)
+    else
+      check_puppet
+    end
+  end
+
+  def search_yaml(data, path = [])
+    case data
+    when Hash
+      data.each do |k, v|
+        search_value(k.to_s, path)
+        search_yaml(v, path + [k.to_s])
+      end
+    when Array
+      data.each_with_index { |v, i| search_yaml(v, path + [i]) }
+    when String
+      search_value(data, path)
+    end
+  end
+
+  def search_value(value, _path)
+    value.scan(%r{%{(?:(?:::?)?|facts\.)([a-zA-Z0-9_]+)(?!\.[a-zA-Z])}}) do |match|
+      base_fact = match[0].split('.').first
+      next unless EASY_FACTS.include?(base_fact) || UNCONVERTIBLE_FACTS.include?(base_fact) || base_fact.match(Regexp.union(REGEX_FACTS))
+
+      notify :warning, {
+        message: "legacy fact '#{base_fact}'",
+        line: find_line_for_content(value),
+        column: 1
+      }
+    end
+  end
+
+  def find_line_for_content(content)
+    PuppetLint::Data.manifest_lines.each_with_index do |line, index|
+      return index + 1 if line.include?(content)
+    end
+    1
+  end
+
+  def check_puppet
     tokens.select { |x| LEGACY_FACTS_VAR_TYPES.include?(x.type) }.each do |token|
       fact_name = ''
 
@@ -137,8 +184,8 @@ PuppetLint.new_check(:legacy_facts) do
         message: "legacy fact '#{fact_name}'",
         line: token.line,
         column: token.column,
-        token: token,
-        fact_name: fact_name
+        token:,
+        fact_name:
       }
     end
   end

data/lib/puppet-lint/plugins/top_scope_facts/top_scope_facts.rb

@@ -38,7 +38,7 @@ PuppetLint.new_check(:top_scope_facts) do
         message: 'top scope fact instead of facts hash',
         line: token.line,
         column: token.column,
-        token: token
+        token:
       }
     end
   end

data/lib/puppet-lint/plugins.rb

@@ -75,7 +75,7 @@ class PuppetLint::Plugins
   end
 end
 
-Dir[File.expand_path('plugins/**/*.rb', File.dirname(__FILE__))].sort.each do |file|
+Dir[File.expand_path('plugins/**/*.rb', File.dirname(__FILE__))].each do |file|
   require file
 end
 

data/lib/puppet-lint/report/codeclimate.rb

@@ -25,7 +25,7 @@ class PuppetLint::Report
             check_name: message[:check],
             description: message[:message],
             categories: [:Style],
-            severity: severity,
+            severity:,
             location: {
               path: message[:path],
               lines: {

data/lib/puppet-lint/tasks/puppet-lint.rb

@@ -27,7 +27,7 @@ class PuppetLint::RakeTask < Rake::TaskLib
   #
   #   PuppetLint::RakeTask.new
   # rubocop:disable Lint/MissingSuper
-  def initialize(*args, &task_block)
+  def initialize(*args, &)
     @name = args.shift || :lint
     @pattern = DEFAULT_PATTERN
     @with_filename = true
@@ -35,7 +35,7 @@ class PuppetLint::RakeTask < Rake::TaskLib
     @only_checks = []
     @ignore_paths = []
 
-    define(args, &task_block)
+    define(args, &)
   end
 
   def define(args, &task_block)
@@ -65,7 +65,7 @@ class PuppetLint::RakeTask < Rake::TaskLib
 
       ['with_filename', 'fail_on_warnings', 'error_level', 'log_format', 'with_context', 'fix', 'show_ignored', 'relative'].each do |config|
         value = instance_variable_get(:"@#{config}")
-        PuppetLint.configuration.send("#{config}=".to_sym, value) unless value.nil?
+        PuppetLint.configuration.send(:"#{config}=", value) unless value.nil?
       end
 
       @ignore_paths = PuppetLint.configuration.ignore_paths if PuppetLint.configuration.ignore_paths && @ignore_paths.empty?

data/lib/puppet-lint/tasks/release_test.rb

@@ -27,7 +27,7 @@ def run_cmd(message, *cmd)
   [output.strip, status.success?]
 end
 
-def with_puppet_lint_head(&block)
+def with_puppet_lint_head(&)
   print('  Updating Gemfile to use puppet-lint HEAD... ')
 
   buffer = Parser::Source::Buffer.new('Gemfile')
@@ -49,7 +49,7 @@ def with_puppet_lint_head(&block)
 
   puts 'Done'
 
-  Bundler.with_clean_env(&block)
+  Bundler.with_clean_env(&)
 
   run_cmd('Restoring Gemfile', 'git', 'checkout', '--', 'Gemfile')
 end

data/lib/puppet-lint/version.rb

@@ -1,3 +1,3 @@
 class PuppetLint
-  VERSION = '4.2.4'.freeze
+  VERSION = '5.0.0'.freeze
 end

data/lib/puppet-lint.rb

@@ -11,7 +11,6 @@ require 'puppet-lint/data'
 require 'puppet-lint/checks'
 require 'puppet-lint/report/github'
 require 'puppet-lint/bin'
-require 'puppet-lint/monkeypatches'
 
 class PuppetLint::NoCodeError < StandardError; end
 
@@ -250,11 +249,11 @@ class PuppetLint
   #     def check
   #     end
   #   end
-  def self.new_check(name, &block)
+  def self.new_check(name, &)
     class_name = name.to_s.split('_').map(&:capitalize).join
     klass = PuppetLint.const_set(:"Check#{class_name}", Class.new(PuppetLint::CheckPlugin))
     klass.const_set(:NAME, name)
-    klass.class_exec(&block)
+    klass.class_exec(&)
     PuppetLint.configuration.add_check(name, klass)
     PuppetLint::Data.ignore_overrides[name] ||= {}
   end

data/rubocop_baseline.yml

@@ -6,7 +6,7 @@ AllCops:
   NewCops: enable
   ExtraDetails: true
   DisplayStyleGuide: true
-  TargetRubyVersion: '2.7'
+  TargetRubyVersion: '3.1'
   DisplayCopNames: true
   SuggestExtensions: false
   Exclude:
@@ -81,10 +81,3 @@ Style/Documentation:
   - spec/**/*
 Style/WordArray:
   EnforcedStyle: brackets
-####################################################
-# Cops below here due for deprecation
-####################################################
-# ``Rspec/FilePath`` is going to be deprecated in the next major release of rubocop >=3.0.0: see <https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/FilePath>
-# As the new cops are already present, e.g., Rspec/SpecFilePathPathFormat, then disabling this in preparation
-RSpec/FilePath:
-  Enabled: false

data/spec/acceptance/puppet_lint_spec.rb

@@ -43,4 +43,11 @@ describe 'When executing puppet-lint' do
       expect(result[:stdout]).to have_warnings(2)
     end
   end
+
+  context 'with a YAML file provided' do
+    it 'returns zero errors' do
+      result = puppet_lint([File.join(manifest_root, 'parseable.yaml')])
+      expect(result[:stdout]).to have_errors(0)
+    end
+  end
 end

data/spec/fixtures/test/manifests/parseable.yaml

@@ -0,0 +1,3 @@
+---
+heredoc: |
+ contains $

data/spec/fixtures/test/manifests/top_scope_variables.pp

@@ -0,0 +1,4 @@
+# dummy resource to test --top-scope-variables
+define test::top_scope_variables() {
+  notice($::role)
+}

data/spec/spec_helper.rb

@@ -22,6 +22,7 @@ end
 
 require 'puppet-lint'
 require 'rspec/its'
+require 'pp'
 begin
   require 'rspec/json_expectations'
 rescue LoadError, SyntaxError
@@ -33,7 +34,7 @@ module RSpec::LintExampleGroup
     def initialize(method, message)
       @expected_problem = {
         kind: method.to_s.delete_prefix('contain_').to_sym,
-        message: message
+        message:
       }
       @description = ["contain a #{@expected_problem[:kind]}"]
     end
@@ -107,7 +108,7 @@ module RSpec::LintExampleGroup
     end
   end
 
-  def method_missing(method, *args, &block)
+  def method_missing(method, *args, &)
     return HaveProblem.new(method, args.first) if method.to_s.start_with?('contain_')
 
     super

data/spec/unit/puppet-lint/bin_spec.rb

@@ -121,6 +121,18 @@ describe PuppetLint::Bin do
     its(:stdout) { is_expected.to eq('') }
   end
 
+  context 'when passed top scope variables option' do
+    let(:args) do
+      [
+        '--top-scope-variables=role',
+        'spec/fixtures/test/manifests/top_scope_variables.pp',
+      ]
+    end
+
+    its(:exitstatus) { is_expected.to eq(0) }
+    its(:stdout) { is_expected.to eq('') }
+  end
+
   context 'when limited to errors only' do
     let(:args) do
       [

data/spec/unit/puppet-lint/checks_spec.rb

@@ -196,6 +196,55 @@ describe PuppetLint::Checks do
     end
   end
 
+  describe '#run_yaml' do
+    let(:fileinfo) { File.join('path', 'to', 'test.yaml') }
+    let(:data) do
+      <<~EOS
+        ---
+        version: 5
+        defaults:
+          datadir: data
+          data_hash: yaml_data
+        hierarchy:
+          - name: "LEGACY FACT PATH"
+            paths:
+              - "os/%{facts.hostname}.yaml"
+          - name: "osfamily/major release"
+            paths:
+              - "os/%{facts.os.name}/%{facts.os.release.major}.yaml"
+          - name: 'common'
+            path: 'common.yaml'
+      EOS
+    end
+    let(:enabled_checks) { [:legacy_facts] }
+
+    before(:each) do
+      allow(instance).to receive(:enabled_checks).and_return(enabled_checks) # rubocop: disable RSpec/SubjectStub
+      allow(File).to receive(:extname).with(fileinfo).and_return('.yaml')
+    end
+
+    context 'when there are checks enabled' do
+      let(:enabled_checks) { [:legacy_facts] }
+      let(:enabled_check_classes) { enabled_checks.map { |r| PuppetLint.configuration.check_object[r] } }
+      let(:disabled_checks) { PuppetLint.configuration.checks - enabled_checks }
+      let(:disabled_check_classes) { disabled_checks.map { |r| PuppetLint.configuration.check_object[r] } }
+
+      it 'runs the enabled checks' do
+        expect(enabled_check_classes).to all(receive(:new).and_call_original)
+
+        instance.run(fileinfo, data)
+      end
+
+      it 'does not run the disabled checks' do
+        disabled_check_classes.each do |check_class|
+          expect(check_class).not_to receive(:new)
+        end
+
+        instance.run(fileinfo, data)
+      end
+    end
+  end
+
   describe '#enabled_checks' do
     subject(:enabled_checks) { instance.enabled_checks }
 

data/spec/unit/puppet-lint/lexer_spec.rb

@@ -256,7 +256,7 @@ describe PuppetLint::Lexer do
     end
 
     context 'treats a variable named the same as the keyword as a variable' do
-      PuppetLint::Lexer::KEYWORDS.each_key do |keyword|
+      described_class::KEYWORDS.each_key do |keyword|
         context "for '#{keyword}'" do
           let(:segments) do
             [
@@ -1359,6 +1359,14 @@ END
   end
 
   context ':TYPE' do
+    shared_examples 'a type matcher' do |type|
+      it "matches #{type}" do
+        token = lexer.tokenise(type).first
+        expect(token.type).to eq(:TYPE)
+        expect(token.value).to eq(type)
+      end
+    end
+
     it 'matches Data Types' do
       token = lexer.tokenise('Integer').first
       expect(token.type).to eq(:TYPE)
@@ -1378,18 +1386,18 @@ END
     end
 
     describe 'Platform Types' do
-      it 'matches Callable' do
-        token = lexer.tokenise('Callable').first
-        expect(token.type).to eq(:TYPE)
-        expect(token.value).to eq('Callable')
-      end
-
-      it 'matches Sensitive' do
-        token = lexer.tokenise('Sensitive').first
-        expect(token.type).to eq(:TYPE)
-        expect(token.value).to eq('Sensitive')
-      end
-    end
+      it_behaves_like 'a type matcher', 'Callable'
+      it_behaves_like 'a type matcher', 'Sensitive'
+    end
+
+    it_behaves_like 'a type matcher', 'Error'
+    it_behaves_like 'a type matcher', 'Binary'
+    it_behaves_like 'a type matcher', 'Iterable'
+    it_behaves_like 'a type matcher', 'Iterator'
+    it_behaves_like 'a type matcher', 'RichData'
+    it_behaves_like 'a type matcher', 'ScalarData'
+    it_behaves_like 'a type matcher', 'SemVer'
+    it_behaves_like 'a type matcher', 'SemVerRange'
   end
 
   context ':HEREDOC without interpolation' do

data/spec/unit/puppet-lint/plugins/check_whitespace/space_before_arrow_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+
+describe 'space_before_arrow' do
+  let(:msg) { "there should be a single space before '=>' on line %d, column %d" }
+
+  context 'with code that should not trigger any warnings' do
+    context 'resource with multiple parameters on different lines' do
+      let(:code) do
+        <<-END
+          file { 'foo':
+            foo => bar,
+            bar  => buzz,
+          }
+        END
+      end
+
+      it 'does not detect any problems' do
+        expect(problems).to be_empty
+      end
+    end
+
+    context 'resource with single param and normal spacing' do
+      let(:code) do
+        <<-END
+          file { 'foo':
+            foo => bar,
+          }
+        END
+      end
+
+      it 'does not detect any problems' do
+        expect(problems).to be_empty
+      end
+    end
+
+    context 'resource with multiple params and normal spacing' do
+      let(:code) do
+        <<-END
+          file { 'foo':
+            foo => { "bar" => "baz" },
+          }
+        END
+      end
+
+      it 'does not detect any problems' do
+        expect(problems).to be_empty
+      end
+    end
+  end
+
+  context 'resource with a single param and simple value with too much space before arrow' do
+    let(:code) do
+      <<-END
+        file { 'foo':
+          foo  => bar,
+        }
+      END
+    end
+
+    context 'with fix disabled' do
+      it 'detects extra space before arrow' do
+        expect(problems.size).to eq(1)
+      end
+
+      it 'produces 1 warning' do
+        expect(problems).to contain_warning(msg % [2, 14]).on_line(2).in_column(14)
+      end
+    end
+
+    context 'with fix enabled' do
+      before(:each) do
+        PuppetLint.configuration.fix = true
+      end
+
+      after(:each) do
+        PuppetLint.configuration.fix = false
+      end
+
+      it 'detects the problem' do
+        expect(problems.size).to eq(1)
+      end
+
+      it 'fixes the manifest' do
+        expect(problems).to contain_fixed(msg % [2, 14])
+      end
+    end
+  end
+
+  context 'resource with a single param, a hash as value and bad spacing within the hash' do
+    let(:code) do
+      <<-END
+        file { 'foo':
+          foo => { "bar"  => "baz" },
+        }
+      END
+    end
+
+    context 'with fix disabled' do
+      it 'detects extra space before arrow' do
+        expect(problems.size).to eq(1)
+      end
+
+      it 'produces a warning' do
+        expect(problems).to contain_warning(msg % [2, 25]).on_line(2).in_column(25)
+      end
+    end
+
+    context 'with fix enabled' do
+      before(:each) do
+        PuppetLint.configuration.fix = true
+      end
+
+      after(:each) do
+        PuppetLint.configuration.fix = false
+      end
+
+      it 'detects the problem' do
+        expect(problems.size).to eq(1)
+      end
+
+      it 'fixes the manifest' do
+        expect(problems).to contain_fixed(msg % [2, 25])
+      end
+    end
+  end
+end

data/spec/unit/puppet-lint/plugins/legacy_facts/legacy_facts_spec.rb

@@ -129,6 +129,65 @@ describe 'legacy_facts' do
         expect(problems.size).to eq(1)
       end
     end
+
+    context 'YAML file processing' do
+      before(:each) do
+        allow(File).to receive(:extname).and_return('.yaml')
+      end
+
+      context 'with YAML string containing legacy fact' do
+        let(:code) { 'some_key: "%{::osfamily}"' }
+
+        it 'detects a single problem' do
+          expect(problems.size).to eq(1)
+        end
+      end
+
+      context 'with YAML string not containing legacy fact' do
+        let(:code) { 'some_key: "%{facts.os.name}"' }
+
+        it 'does not detect any problems' do
+          expect(problems).to be_empty
+        end
+      end
+
+      context 'with YAML nested structure containing legacy fact' do
+        let(:code) { "nested:\n  value: \"%{::architecture}\"" }
+
+        it 'detects a single problem' do
+          expect(problems.size).to eq(1)
+        end
+      end
+
+      context 'with YAML array containing legacy facts' do
+        let(:code) do
+          [
+            'array:',
+            '  - "%{::processor0}"',
+            '  - "%{::ipaddress_eth0}"',
+          ].join("\n")
+        end
+
+        it 'detects multiple problems' do
+          expect(problems.size).to eq(2)
+        end
+      end
+
+      context 'with YAML alias containing legacy fact' do
+        let(:code) do
+          [
+            'template: &template',
+            '  fact: "%{::osfamily}"',
+            'instance:',
+            '  <<: *template',
+          ].join("\n")
+        end
+
+        it 'detects multiple instances' do
+          expect(problems.size).to eq(2)
+        end
+      end
+    end
   end
 
   context 'with fix enabled' do

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint
 version: !ruby/object:Gem::Version
-  version: 4.2.4
+  version: 5.0.0
 platform: ruby
 authors:
 - Tim Sharpe
 - Puppet, Inc.
 - Community Contributors
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-09 00:00:00.000000000 Z
+date: 2025-09-23 00:00:00.000000000 Z
 dependencies: []
 description: "    Checks your Puppet manifests against the Puppetlabs style guide
   and alerts you to any discrepancies.\n"
@@ -34,7 +34,6 @@ files:
 - lib/puppet-lint/lexer.rb
 - lib/puppet-lint/lexer/string_slurper.rb
 - lib/puppet-lint/lexer/token.rb
-- lib/puppet-lint/monkeypatches.rb
 - lib/puppet-lint/optparser.rb
 - lib/puppet-lint/plugins.rb
 - lib/puppet-lint/plugins/check_classes/arrow_on_right_operand_line.rb
@@ -74,6 +73,7 @@ files:
 - lib/puppet-lint/plugins/check_whitespace/arrow_alignment.rb
 - lib/puppet-lint/plugins/check_whitespace/hard_tabs.rb
 - lib/puppet-lint/plugins/check_whitespace/line_length.rb
+- lib/puppet-lint/plugins/check_whitespace/space_before_arrow.rb
 - lib/puppet-lint/plugins/check_whitespace/trailing_whitespace.rb
 - lib/puppet-lint/plugins/legacy_facts/legacy_facts.rb
 - lib/puppet-lint/plugins/top_scope_facts/top_scope_facts.rb
@@ -94,6 +94,8 @@ files:
 - spec/fixtures/test/manifests/init.pp
 - spec/fixtures/test/manifests/malformed.pp
 - spec/fixtures/test/manifests/mismatched_control_comment.pp
+- spec/fixtures/test/manifests/parseable.yaml
+- spec/fixtures/test/manifests/top_scope_variables.pp
 - spec/fixtures/test/manifests/two_warnings.pp
 - spec/fixtures/test/manifests/unterminated_control_comment.pp
 - spec/fixtures/test/manifests/url_interpolation.pp
@@ -146,6 +148,7 @@ files:
 - spec/unit/puppet-lint/plugins/check_whitespace/80chars_spec.rb
 - spec/unit/puppet-lint/plugins/check_whitespace/arrow_alignment_spec.rb
 - spec/unit/puppet-lint/plugins/check_whitespace/hard_tabs_spec.rb
+- spec/unit/puppet-lint/plugins/check_whitespace/space_before_arrow_spec.rb
 - spec/unit/puppet-lint/plugins/check_whitespace/trailing_whitespace_spec.rb
 - spec/unit/puppet-lint/plugins/legacy_facts/legacy_facts_spec.rb
 - spec/unit/puppet-lint/plugins/top_scope_facts/top_scope_facts_spec.rb
@@ -154,7 +157,7 @@ homepage: https://github.com/puppetlabs/puppet-lint/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -162,15 +165,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.27
+signing_key:
 specification_version: 4
 summary: Ensure your Puppet manifests conform with the Puppetlabs style guide
 test_files: []

data/lib/puppet-lint/monkeypatches.rb

@@ -1,51 +0,0 @@
-begin
-  '%{test}' % { test: 'replaced' } == 'replaced'
-rescue StandardError
-  # monkeypatch String#% into Ruby 1.8.7
-  class String
-    Percent = instance_method(:%) unless defined?(Percent)
-
-    def %(*a, &b)
-      a.flatten!
-
-      string = case a.last
-               when Hash
-                 expand(a.pop)
-               else
-                 self
-               end
-
-      if a.empty?
-        string
-      else
-        Percent.bind_call(string, a, &b)
-      end
-    end
-
-    def expand!(vars = {})
-      loop do
-        changed = false
-        vars.each do |var, value|
-          var = var.to_s
-          var.gsub!(%r{[^a-zA-Z0-9_]}, '')
-          changed = gsub!(%r{%\{#{var}\}}, value.to_s)
-        end
-        break unless changed
-      end
-      self
-    end
-
-    def expand(opts = {})
-      dup.expand!(opts)
-    end
-  end
-end
-
-unless String.respond_to?(:prepend)
-  # monkeypatch String#prepend into Ruby 1.8.7
-  class String
-    def prepend(lead)
-      replace("#{lead}#{self}")
-    end
-  end
-end