puppet-lint 2.5.0 → 3.0.0

data/lib/puppet-lint/checkplugin.rb

@@ -41,7 +41,7 @@ class PuppetLint::CheckPlugin
       begin
         fix(problem)
         problem[:kind] = :fixed
-      rescue PuppetLint::NoFix # rubocop:disable Lint/HandleExceptions
+      rescue PuppetLint::NoFix
         # noop
       end
     end
@@ -105,6 +105,38 @@ class PuppetLint::CheckPlugin
     PuppetLint::Data.node_indexes
   end
 
+  # Public: Provides positional information for any array definitions in the
+  # tokens array to the check plugins.
+  #
+  # Returns an array of hashes containing the position information.
+  def array_indexes
+    PuppetLint::Data.array_indexes
+  end
+
+  # Public: Provides positional information for any hash definitions in the
+  # tokens array to the check plugins.
+  #
+  # Returns an array of hashes containing the position information.
+  def hash_indexes
+    PuppetLint::Data.hash_indexes
+  end
+
+  # Public: Provides positional information for any default definitions in the
+  # tokens array to the check plugins.
+  #
+  # Returns an Array of Hashes containing the position information.
+  def defaults_indexes
+    PuppetLint::Data.defaults_indexes
+  end
+
+  # Public: Provides positional information for any function definition in the
+  # tokens array to the check plugins.
+  #
+  # Returns an Array of Hashes containing the position information.
+  def function_indexes
+    PuppetLint::Data.function_indexes
+  end
+
   # Public: Provides the expanded path of the file being analysed to check
   # plugins.
   #
@@ -147,10 +179,10 @@ class PuppetLint::CheckPlugin
   # Returns a Hash of default problem information.
   def default_info
     @default_info ||= {
-      :check      => self.class.const_get('NAME'),
-      :fullpath   => fullpath,
-      :path       => path,
-      :filename   => filename,
+      check: self.class.const_get('NAME'),
+      fullpath: fullpath,
+      path: path,
+      filename: filename,
     }
   end
 
@@ -158,10 +190,12 @@ class PuppetLint::CheckPlugin
   #
   # kind    - The Symbol problem type (:warning or :error).
   # problem - A Hash containing the attributes of the problem
-  #   :message - The String message describing the problem.
-  #   :line    - The Integer line number of the location of the problem.
-  #   :column  - The Integer column number of the location of the problem.
-  #   :check   - The Symbol name of the check that detected the problem.
+  #   :message      - The String message describing the problem.
+  #   :line         - The Integer line number of the location of the problem.
+  #   :column       - The Integer column number of the location of the problem.
+  #   :check        - The Symbol name of the check that detected the problem.
+  #   :description  - The description of the check that detected the problem.
+  #   :help_uri     - The help web page of the check that detected the problem.
   #
   # Returns nothing.
   def notify(kind, problem)

data/lib/puppet-lint/checks.rb

@@ -32,14 +32,14 @@ class PuppetLint::Checks
                 end
 
       problems << {
-        :kind     => :error,
-        :check    => :syntax,
-        :message  => message,
-        :line     => e.line_no,
-        :column   => e.column,
-        :fullpath => PuppetLint::Data.fullpath,
-        :path     => PuppetLint::Data.path,
-        :filename => PuppetLint::Data.filename,
+        kind: :error,
+        check: :syntax,
+        message: message,
+        line: e.line_no,
+        column: e.column,
+        fullpath: PuppetLint::Data.fullpath,
+        path: PuppetLint::Data.path,
+        filename: PuppetLint::Data.filename,
       }
       PuppetLint::Data.tokens = []
     end
@@ -73,14 +73,14 @@ class PuppetLint::Checks
     @problems
   rescue PuppetLint::SyntaxError => e
     @problems << {
-      :kind     => :error,
-      :check    => :syntax,
-      :message  => 'Syntax error',
-      :fullpath => File.expand_path(fileinfo, ENV['PWD']),
-      :filename => File.basename(fileinfo),
-      :path     => fileinfo,
-      :line     => e.token.line,
-      :column   => e.token.column,
+      kind: :error,
+      check: :syntax,
+      message: 'Syntax error',
+      fullpath: File.expand_path(fileinfo, ENV['PWD']),
+      filename: File.basename(fileinfo),
+      path: fileinfo,
+      line: e.token.line,
+      column: e.token.column,
     }
 
     @problems

data/lib/puppet-lint/configuration.rb

@@ -1,157 +1,157 @@
-class PuppetLint
-  # Public: A singleton class to store the running configuration of
-  # puppet-lint.
-  class Configuration
-    # Internal: Add helper methods for a new check to the
-    # PuppetLint::Configuration object.
-    #
-    # check - The String name of the check.
-    #
-    # Returns nothing.
-    #
-    # Signature
-    #
-    #   <check>_enabled?
-    #   disable_<check>
-    #   enable_<check>
-    def self.add_check(check)
-      # Public: Determine if the named check is enabled.
-      #
-      # Returns true if the check is enabled, otherwise return false.
-      define_method("#{check}_enabled?") do
-        settings["#{check}_disabled"] == true ? false : true
-      end
-
-      # Public: Disable the named check.
-      #
-      # Returns nothing.
-      define_method("disable_#{check}") do
-        settings["#{check}_disabled"] = true
-      end
-
-      # Public: Enable the named check.
-      #
-      # Returns nothing.
-      define_method("enable_#{check}") do
-        settings["#{check}_disabled"] = false
-      end
+# Public: A singleton class to store the running configuration of
+# puppet-lint.
+class PuppetLint::Configuration
+  # Internal: Add helper methods for a new check to the
+  # PuppetLint::Configuration object.
+  #
+  # check - The String name of the check.
+  #
+  # Returns nothing.
+  #
+  # Signature
+  #
+  #   <check>_enabled?
+  #   disable_<check>
+  #   enable_<check>
+  def self.add_check(check)
+    # Public: Determine if the named check is enabled.
+    #
+    # Returns true if the check is enabled, otherwise return false.
+    define_method("#{check}_enabled?") do
+      settings["#{check}_disabled"] == true ? false : true
     end
 
-    # Public: Catch situations where options are being set for the first time
-    # and create the necessary methods to get & set the option in the future.
-    #
-    # args   - An Array of values to set the option to.
-    # method - The String name of the option.
-    # block  - Unused.
+    # Public: Disable the named check.
     #
     # Returns nothing.
-    #
-    # Signature
-    #
-    #   <option>=(value)
-    def method_missing(method, *args, &_block)
-      super unless method.to_s =~ %r{^(\w+)=?$}
-
-      option = Regexp.last_match(1)
-      add_option(option.to_s) if settings[option].nil?
-      settings[option] = args[0] unless args.empty?
+    define_method("disable_#{check}") do
+      settings["#{check}_disabled"] = true
     end
 
-    def respond_to_missing?(method, *)
-      method.to_s =~ %r{^\w+=?$} || super
-    end
-
-    # Internal: Add options to the PuppetLint::Configuration object from inside
-    # the class.
-    #
-    # option - The String name of the option.
+    # Public: Enable the named check.
     #
     # Returns nothing.
-    #
-    # Signature
-    #
-    #   <option>
-    #   <option>=(value)
-    def add_option(option)
-      self.class.add_option(option)
+    define_method("enable_#{check}") do
+      settings["#{check}_disabled"] = false
     end
+  end
 
-    # Public: Add an option to the PuppetLint::Configuration object from
-    # outside the class.
-    #
-    # option - The String name of the option.
-    #
-    # Returns nothing.
-    #
-    # Signature
-    #
-    #   <option>
-    #   <option>=(value)
-    def self.add_option(option)
-      # Public: Set the value of the named option.
-      #
-      # value - The value to set the option to.
-      #
-      # Returns nothing.
-      define_method("#{option}=") do |value|
-        settings[option] = value
-      end
+  # Public: Catch situations where options are being set for the first time
+  # and create the necessary methods to get & set the option in the future.
+  #
+  # args   - An Array of values to set the option to.
+  # method - The String name of the option.
+  # block  - Unused.
+  #
+  # Returns nothing.
+  #
+  # Signature
+  #
+  #   <option>=(value)
+  def method_missing(method, *args, &_block)
+    super unless method.to_s =~ %r{^(\w+)=?$}
 
-      # Public: Get the value of the named option.
-      #
-      # Returns the value of the option.
-      define_method(option) do
-        settings[option]
-      end
-    end
+    option = Regexp.last_match(1)
+    add_option(option.to_s) if settings[option].nil?
+    settings[option] = args[0] unless args.empty?
+  end
 
-    # Internal: Register a new check.
-    #
-    # check - The String name of the check
-    # klass - The Class containing the check logic.
+  def respond_to_missing?(method, *)
+    method.to_s =~ %r{^\w+=?$} || super
+  end
+
+  # Internal: Add options to the PuppetLint::Configuration object from inside
+  # the class.
+  #
+  # option - The String name of the option.
+  #
+  # Returns nothing.
+  #
+  # Signature
+  #
+  #   <option>
+  #   <option>=(value)
+  def add_option(option)
+    self.class.add_option(option)
+  end
+
+  # Public: Add an option to the PuppetLint::Configuration object from
+  # outside the class.
+  #
+  # option - The String name of the option.
+  #
+  # Returns nothing.
+  #
+  # Signature
+  #
+  #   <option>
+  #   <option>=(value)
+  def self.add_option(option)
+    # Public: Set the value of the named option.
+    #
+    # value - The value to set the option to.
     #
     # Returns nothing.
-    def add_check(check, klass)
-      self.class.add_check(check)
-      check_object[check] = klass
+    define_method("#{option}=") do |value|
+      settings[option] = value
     end
 
-    # Internal: Access the internal storage for settings.
+    # Public: Get the value of the named option.
     #
-    # Returns a Hash containing all the settings.
-    def settings
-      @settings ||= {}
+    # Returns the value of the option.
+    define_method(option) do
+      settings[option]
     end
+  end
 
-    # Internal: Access the internal storage for check method blocks.
-    #
-    # Returns a Hash containing all the check blocks.
-    def check_object
-      @check_object ||= {}
-    end
+  # Internal: Register a new check.
+  #
+  # check - The String name of the check
+  # klass - The Class containing the check logic.
+  #
+  # Returns nothing.
+  def add_check(check, klass)
+    self.class.add_check(check)
+    check_object[check] = klass
+  end
 
-    # Public: Get a list of all the defined checks.
-    #
-    # Returns an Array of String check names.
-    def checks
-      check_object.keys
-    end
+  # Internal: Access the internal storage for settings.
+  #
+  # Returns a Hash containing all the settings.
+  def settings
+    @settings ||= {}
+  end
 
-    # Public: Clear the PuppetLint::Configuration storage and set some sane
-    # default values.
-    #
-    # Returns nothing.
-    def defaults
-      settings.clear
-      self.with_filename = false
-      self.fail_on_warnings = false
-      self.error_level = :all
-      self.log_format = ''
-      self.with_context = false
-      self.fix = false
-      self.json = false
-      self.show_ignored = false
-      self.ignore_paths = ['vendor/**/*.pp']
-    end
+  # Internal: Access the internal storage for check method blocks.
+  #
+  # Returns a Hash containing all the check blocks.
+  def check_object
+    @check_object ||= {}
+  end
+
+  # Public: Get a list of all the defined checks.
+  #
+  # Returns an Array of String check names.
+  def checks
+    check_object.keys
+  end
+
+  # Public: Clear the PuppetLint::Configuration storage and set some sane
+  # default values.
+  #
+  # Returns nothing.
+  def defaults
+    settings.clear
+    self.with_filename = false
+    self.fail_on_warnings = false
+    self.error_level = :all
+    self.log_format = ''
+    self.with_context = false
+    self.fix = false
+    self.json = false
+    self.sarif = false
+    self.show_ignored = false
+    self.ignore_paths = ['vendor/**/*.pp']
+    self.github_actions = ENV.key?('GITHUB_ACTION')
   end
 end

data/lib/puppet-lint/data.rb

@@ -143,7 +143,7 @@ class PuppetLint::Data
               end
               title_array_tokens = tokens[(array_start_idx + 1)..(token_idx - 2)]
               result += title_array_tokens.select do |token|
-                { :STRING => true, :NAME => true }.include?(token.type)
+                { STRING: true, NAME: true }.include?(token.type)
               end
             else
               next_token = tokens[token_idx].next_code_token
@@ -180,11 +180,11 @@ class PuppetLint::Data
           marker = rel_end_idx + start_idx
 
           result << {
-            :start        => start_idx + 1,
-            :end          => marker,
-            :tokens       => tokens[start_idx..marker],
-            :type         => find_resource_type_token(start_idx),
-            :param_tokens => find_resource_param_tokens(tokens[start_idx..marker]),
+            start: start_idx + 1,
+            end: marker,
+            tokens: tokens[start_idx..marker],
+            type: find_resource_type_token(start_idx),
+            param_tokens: find_resource_param_tokens(tokens[start_idx..marker]),
           }
         end
         result
@@ -310,13 +310,13 @@ class PuppetLint::Data
             if brace_depth.zero? && !in_params
               if token.next_code_token.type != :LBRACE
                 result << {
-                  :start           => i,
-                  :end             => i + j + 1,
-                  :tokens          => tokens[i..(i + j + 1)],
-                  :param_tokens    => param_tokens(tokens[i..(i + j + 1)]),
-                  :type            => type,
-                  :name_token      => token.next_code_token,
-                  :inherited_token => inherited_class,
+                  start: i,
+                  end: i + j + 1,
+                  tokens: tokens[i..(i + j + 1)],
+                  param_tokens: param_tokens(tokens[i..(i + j + 1)]),
+                  type: type,
+                  name_token: token.next_code_token,
+                  inherited_token: inherited_class,
                 }
                 break
               end
@@ -367,9 +367,9 @@ class PuppetLint::Data
           end
 
           functions << {
-            :start  => token_idx,
-            :end    => real_idx,
-            :tokens => tokens[token_idx..real_idx],
+            start: token_idx,
+            end: real_idx,
+            tokens: tokens[token_idx..real_idx],
           }
         end
         functions
@@ -403,9 +403,9 @@ class PuppetLint::Data
                   token.prev_code_token.type == :CLASSREF
 
           arrays << {
-            :start  => token_idx,
-            :end    => real_idx,
-            :tokens => tokens[token_idx..real_idx],
+            start: token_idx,
+            end: real_idx,
+            tokens: tokens[token_idx..real_idx],
           }
         end
         arrays
@@ -441,9 +441,9 @@ class PuppetLint::Data
           end
 
           hashes << {
-            :start  => token_idx,
-            :end    => real_idx,
-            :tokens => tokens[token_idx..real_idx],
+            start: token_idx,
+            end: real_idx,
+            tokens: tokens[token_idx..real_idx],
           }
         end
         hashes
@@ -475,9 +475,9 @@ class PuppetLint::Data
           end
 
           defaults << {
-            :start  => token_idx,
-            :end    => real_idx,
-            :tokens => tokens[token_idx..real_idx],
+            start: token_idx,
+            end: real_idx,
+            tokens: tokens[token_idx..real_idx],
           }
         end
         defaults
@@ -561,7 +561,7 @@ class PuppetLint::Data
 
         comment_words = token.value.strip.split(%r{\s+})
         comment_words.each_with_index do |word, i|
-          if word =~ %r{\Alint\:(ignore|endignore)}
+          if %r{\Alint\:(ignore|endignore)}.match?(word)
             comment_data << word
           else
             # Once we reach the first non-controlcomment word, assume the rest
@@ -591,7 +591,7 @@ class PuppetLint::Data
             if top_override.nil?
               # TODO: refactor to provide a way to expose problems from
               # PuppetLint::Data via the normal problem reporting mechanism.
-              puts "WARNING: lint:endignore comment with no opening lint:ignore:<check> comment found on line #{token.line}"
+              $stderr.puts "WARNING: lint:endignore comment with no opening lint:ignore:<check> comment found on line #{token.line}"
             else
               top_override.each do |start|
                 next if start.nil?
@@ -607,7 +607,7 @@ class PuppetLint::Data
       end
 
       stack.each do |control|
-        puts "WARNING: lint:ignore:#{control[0][2]} comment on line #{control[0][0]} with no closing lint:endignore comment"
+        $stderr.puts "WARNING: lint:ignore:#{control[0][2]} comment on line #{control[0][0]} with no closing lint:endignore comment"
       end
     end
   end