puppet-lint-nine-check 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3dc35597d6a8c91070d3f0f897ad882a3e0d7f5baa26136c96f3c32de2447487
-  data.tar.gz: d3e419564fb15a1728a7885ea243cd61b03ced9676c49d79f9b59f6216352abb
+  metadata.gz: c4708a12e4b0252d046a69e52f62ca9296daab1e6f0d356a16f712df5d56df5b
+  data.tar.gz: a903c154bc715a5dfd8c21a77eccff6ceb2baaeeaf4412a794d4b6bcea83bf44
 SHA512:
-  metadata.gz: adb7afff9bca164ff1a683528169113bd8066a4ab9b4b8272ea88a71f6ae6b13205ec653484ebb721fbc6af68932a7ae7f1129dee5e6281b6bafcecb0380bd1e
-  data.tar.gz: 1ce9cf998c731e36e11ed2a1c322905151df43c4a99aef80749c8617f29a3f4813486d432aab22d148da12cae5cfa1a4d0d13a28c3fdd3be990483712103bb33
+  metadata.gz: b56ffb029e88553a11a87a9c4f819cb54e985dc19e62e50032f4c5b8c2ab5efce592073405a809ed53d153aa26087fb67bb3e0553789256b16facf196cf33fee
+  data.tar.gz: 677c848e83b23cbc1b2488e922b75a6471e31145a9ac6c7961be63442369cfba9bc3308d8a8b387df76048f5dac936b380fa3305ad885ab719903d947ec87d57

data/lib/puppet-lint/plugins/class_alignment/helper.rb

@@ -0,0 +1,158 @@
+# https://github.com/anhpt379/puppet-lint-class_alignment-check/blob/961d5457b0b6aa1eb10f3ceb543f90115b572f37/lib/puppet-lint/plugins/check_class_helper.rb
+#
+# Copyright (c) 2011 Tim Sharpe
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+module ClassAlignment
+  class Helper
+    class << self
+      def a_param?(token)
+        if token&.prev_code_token&.type == :EQUALS
+          false
+        elsif token&.prev_code_token&.type == :FARROW
+          false
+        elsif %i[DQPRE DQMID].include?(token&.prev_code_token&.type)
+          false
+        elsif token&.type == :VARIABLE
+          # first var in the class
+          return true if token&.prev_token_of(:CLASS)&.next_token_of(:LPAREN)&.next_token_of(:VARIABLE) == token
+          return true if token&.prev_token_of(:DEFINE)&.next_token_of(:LPAREN)&.next_token_of(:VARIABLE) == token
+
+          count = 0
+          saw_a_comma = false
+          while token&.prev_token
+            token = token.prev_token
+
+            saw_a_comma = true if token.type == :COMMA
+
+            return false if token.type == :EQUALS && count == 0 && saw_a_comma == false
+
+            if %i[RPAREN RBRACK RBRACE].include?(token.type)
+              count -= 1
+            elsif %i[LPAREN LBRACK LBRACE].include?(token.type)
+              count += 1
+            end
+
+            break if %i[CLASS DEFINE].include?(token.type)
+          end
+
+          true if count == 1
+        end
+      end
+
+      def first_on_the_line?(token, type)
+        origin = token
+        while token&.prev_token
+          token = token.prev_token
+
+          break if token.type == :NEWLINE
+        end
+
+        while token&.next_token
+          token = token.next_token
+
+          break if token.type == type
+        end
+
+        origin == token
+      end
+
+      def the_one?(token, character)
+        case character
+        when "="
+          true if token.type == :EQUALS && first_on_the_line?(token, :EQUALS)
+        when "$"
+          true if a_param?(token) && first_on_the_line?(token, :VARIABLE)
+        end
+      end
+
+      def get_the_first_param(token)
+        while token&.prev_code_token
+          token = token.prev_code_token
+          break if token.type == :CLASS
+        end
+
+        while token&.next_code_token
+          token = token.next_code_token
+          return token if token.type == :VARIABLE
+        end
+      end
+
+      def get_prev_code_token(token, character)
+        case character
+        when "="
+          token.prev_code_token
+        when "$"
+          if token.prev_code_token
+            if %i[CLASSREF RBRACK].include?(token.prev_code_token.type)
+              token.prev_code_token
+            elsif token.prev_code_token.type == :LPAREN
+              token
+            elsif token.prev_code_token.type == :COMMA
+              get_the_first_param(token)
+            end
+          end
+        end
+      end
+
+      def get_param_start_token(token)
+        return nil unless a_param?(token)
+
+        case token&.prev_code_token&.type
+
+        # Integer $db_port
+        when :TYPE
+          token.prev_code_token
+
+        when :CLASSREF
+          token.prev_code_token
+
+        # Variant[Undef, Enum['UNSET'], Stdlib::Port] $db_port
+        when :RBRACK
+          count = 0
+          while token&.prev_code_token
+            token = token.prev_code_token
+            case token.type
+            when :RBRACK
+              count += 1
+            when :LBRACK
+              count -= 1
+            end
+
+            break if count.zero?
+          end
+          token.prev_code_token
+
+        else
+          token
+        end
+      end
+
+      def get_prev_param_token(token)
+        while token&.prev_code_token
+          token = token.prev_code_token
+          return token if a_param?(token)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,155 @@
+# https://github.com/anhpt379/puppet-lint-class_alignment-check/blob/b62e5c52568fca00413669df745453ff80c76a91/lib/puppet-lint/plugins/check_class_alignment.rb
+#
+# Copyright (c) 2011 Tim Sharpe
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+# Parameters to classes or defined types must be uniformly indented in two
+# spaces from the title. The equals sign should be aligned.
+#
+# https://puppet.com/docs/puppet/7/style_guide.html#style_guide_classes-param-indentation-alignment
+
+require_relative "class_alignment/helper"
+
+# This function is copied & modified from puppet-lint arrow_alignment check
+# https://github.com/puppetlabs/puppet-lint/blob/020143b705b023946739eb44e7c7d99fcd087527/lib/puppet-lint/plugins/check_whitespace/arrow_alignment.rb#L8
+def check_for(character)
+  # I intentionally didn't rename `arrow` to another name, to keep the code as
+  # similar as the original one, to easier to update in the future.
+  (class_indexes + defined_type_indexes).each do |res_idx|
+    arrow_column = [0]
+    level_idx = 0
+    level_tokens = []
+    param_column = [nil]
+    resource_tokens = res_idx[:param_tokens]
+    next if resource_tokens.nil?
+
+    resource_tokens.reject! do |token|
+      COMMENT_TYPES.include?(token.type)
+    end
+
+    # If this is a single line resource, skip it
+    first_arrow = resource_tokens.index { |r| ClassAlignment::Helper.the_one?(r, character) }
+    last_arrow = resource_tokens.rindex { |r| ClassAlignment::Helper.the_one?(r, character) }
+    next if first_arrow.nil?
+    next if last_arrow.nil?
+    next if resource_tokens[first_arrow].line == resource_tokens[last_arrow].line
+
+    resource_tokens.each do |token|
+      if ClassAlignment::Helper.the_one?(token, character)
+        param_token = ClassAlignment::Helper.get_prev_code_token(token, character)
+        param_token = token if param_token.nil?
+
+        param_length = param_token.to_manifest.length
+
+        param_column[level_idx] = param_token.column if param_column[level_idx].nil?
+
+        if (level_tokens[level_idx] ||= []).any? { |t| t.line == token.line }
+          this_arrow_column = param_column[level_idx] + param_length + 1
+        elsif character == "$" && param_token.type == :VARIABLE
+          this_arrow_column = param_token.column
+        else
+          this_arrow_column = param_token.column + param_token.to_manifest.length
+          this_arrow_column += 1 if param_token.type != :INDENT
+        end
+
+        arrow_column[level_idx] = this_arrow_column if arrow_column[level_idx] < this_arrow_column
+
+        (level_tokens[level_idx] ||= []) << token
+      elsif token == resource_tokens[0]
+        level_idx += 1
+        arrow_column << 0
+        level_tokens[level_idx] ||= []
+        param_column << nil
+      elsif token == resource_tokens[-1]
+        if (level_tokens[level_idx] ||= []).map(&:line).uniq.length > 1
+          level_tokens[level_idx].each do |arrow_tok|
+            next if arrow_tok.column == arrow_column[level_idx] || level_tokens[level_idx].size == 1
+
+            arrows_on_line = level_tokens[level_idx].select { |t| t.line == arrow_tok.line }
+            notify(
+              :warning,
+              message: "indentation of #{character} is not properly aligned (expected in column #{arrow_column[level_idx]}, but found it in column #{arrow_tok.column})",
+              line: arrow_tok.line,
+              column: arrow_tok.column,
+              token: arrow_tok,
+              arrow_column: arrow_column[level_idx],
+              newline: arrows_on_line.index(arrow_tok) != 0,
+              newline_indent: param_column[level_idx] - 1
+            )
+          end
+        end
+        arrow_column[level_idx] = 0
+        level_tokens[level_idx].clear
+        param_column[level_idx] = nil
+        level_idx -= 1
+      end
+    end
+  end
+end
+
+# This function is copied & modified from puppet-lint arrow_alignment fix
+# https://github.com/puppetlabs/puppet-lint/blob/020143b705b023946739eb44e7c7d99fcd087527/lib/puppet-lint/plugins/check_whitespace/arrow_alignment.rb#L94
+def fix_for(problem)
+  raise PuppetLint::NoFix if problem[:newline]
+
+  new_ws_len = if problem[:token].prev_token.type == :WHITESPACE
+    problem[:token].prev_token.to_manifest.length
+  else
+    0
+  end
+  new_ws_len += (problem[:arrow_column] - problem[:token].column)
+
+  if new_ws_len.negative?
+    raise PuppetLint::NoFix if problem[:token].prev_token.type != :INDENT
+
+    new_ws = problem[:token].prev_token.to_manifest[0...new_ws_len]
+    problem[:token].prev_token.value = new_ws
+  else
+    new_ws = " " * new_ws_len
+
+    if problem[:token].prev_token.type == :WHITESPACE
+      problem[:token].prev_token.value = new_ws
+    else
+      index = tokens.index(problem[:token].prev_token)
+      tokens.insert(index + 1, PuppetLint::Lexer::Token.new(:WHITESPACE, new_ws, 0, 0))
+    end
+  end
+end
+
+PuppetLint.new_check(:class_alignment_params) do
+  def check
+    check_for("$")
+  end
+
+  def fix(problem)
+    fix_for(problem)
+  end
+end
+
+PuppetLint.new_check(:class_alignment_equals) do
+  def check
+    check_for("=")
+  end
+
+  def fix(problem)
+    fix_for(problem)
+  end
+end

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

@@ -0,0 +1,108 @@
+# https://github.com/anhpt379/puppet-lint-class_alignment-check/blob/961d5457b0b6aa1eb10f3ceb543f90115b572f37/lib/puppet-lint/plugins/check_class_helper.rb
+#
+# Copyright (c) 2011 Tim Sharpe
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+require_relative "class_alignment/helper"
+
+PuppetLint.new_check(:class_alignment_params_newline) do
+  def check
+    (class_indexes + defined_type_indexes).each do |item|
+      tokens = item[:param_tokens]
+      next if tokens.nil?
+
+      # Skip if line length < 80 chars
+      first_paren = tokens[0]&.prev_token_of(:LPAREN)
+      last_paren = tokens[-1]&.next_token_of(:RPAREN)
+      next if first_paren.nil?
+      next if last_paren.nil?
+      next if first_paren.line == last_paren.line && last_paren.column < 80
+
+      tokens.each do |token|
+        if token == tokens[-1]
+          rparen = token.next_token_of(:RPAREN)
+
+          last_code_token = token
+          while last_code_token&.prev_token
+            break unless %i[WHITESPACE INDENT NEWLINE].include?(last_code_token.type)
+
+            last_code_token = last_code_token.prev_token
+          end
+
+          next if rparen.line != last_code_token.line
+
+          notify(
+            :warning,
+            message: "`)` should be in a new line (expected in line #{token.line + 1}, but found it in line #{token.line})",
+            line: rparen.line,
+            column: rparen.column,
+            token: rparen,
+            newline: true,
+            newline_indent: item[:tokens][0].column - 1
+          )
+        end
+
+        next unless ClassAlignment::Helper.a_param?(token)
+
+        if ClassAlignment::Helper.get_param_start_token(token)&.prev_code_token&.type == :LPAREN
+          next if token.line != ClassAlignment::Helper.get_param_start_token(token).prev_code_token.line
+        elsif token.line != ClassAlignment::Helper.get_prev_param_token(token)&.line
+          next
+        end
+
+        notify(
+          :warning,
+          message: "`#{token.to_manifest}` should be in a new line (expected in line #{token.line + 1}, but found it in line #{token.line})",
+          line: token.line,
+          column: token.column,
+          token: token,
+          newline: true,
+          newline_indent: item[:tokens][0].column + 1
+        )
+      end
+    end
+  end
+
+  def fix(problem)
+    token = problem[:token]
+    token = ClassAlignment::Helper.get_param_start_token(token) if token.type == :VARIABLE
+
+    last_non_whitespace_token = token.prev_token
+    while last_non_whitespace_token&.prev_token
+      break unless %i[WHITESPACE INDENT NEWLINE].include?(last_non_whitespace_token.type)
+
+      last_non_whitespace_token = last_non_whitespace_token.prev_token
+    end
+
+    index = tokens.index(last_non_whitespace_token) + 1
+    tokens.insert(index, PuppetLint::Lexer::Token.new(:NEWLINE, "\n", 0, 0))
+
+    # When there's no space at the beginning of the param
+    # e.g.  class foo($bar="aaa") {}
+    if token.prev_code_token.next_token == token
+      tokens.insert(index + 1, PuppetLint::Lexer::Token.new(:INDENT, " " * problem[:newline_indent], 0, 0))
+
+    elsif %i[WHITESPACE INDENT].include?(token.prev_token.type)
+      token.prev_token.value = " " * problem[:newline_indent]
+    end
+  end
+end