puppet-lint-strict_indent-check 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a813e32484645b3159a5cc786e1e1df8bb9ce13b7e72de92603836f8d88876d7
-  data.tar.gz: 812be78bb5e2d3eed4b37013d7a9ae2b4587d139ea8e1de1b95413b63b38a81a
+  metadata.gz: 1fb2ac311bc0d30ef09d5975e7160f31fa7ecbb67e8498a7359d6894c6816526
+  data.tar.gz: 66a1bbfc4c9e494a8923d19c18ed1905a58b2645b4d4d6a65844efda0b9e9897
 SHA512:
-  metadata.gz: f5d01a03406cfc9ff251e77b46059e31811346ffd6140c89e1920019f42b1a2590302b284399cc874053127a3645ac72cec725d7ad51bb5a76ede4992c0a8f3a
-  data.tar.gz: 0143dc2fc1d985646be7f22904ea3cd52dce21918c8829d69dfbc178a517af2784516120063ea5b45e2d02ee6a2335e2ae90d74de774302bd4479580c06ab40b
+  metadata.gz: b0ec808b887a1f2459be4d34ce2371210b990ffec3c78a58c4e5ce3c173bea8c267697e18c6d693acbcb4e7b5a0551496fc05d8f5c6762283e530716ad40d0d7
+  data.tar.gz: 493240b21f3ab3a1157851f3cb1377089a9ff60454200b7bf34c68fa22ba747dda05bd16f940254305460df78a276963a5cb31e40e5ae132afc79ebfa05baf6e

data/CHANGELOG.md

@@ -2,6 +2,33 @@
 
 All notable changes to this project will be documented in this file.
 
+## [4.0.0](https://github.com/voxpupuli/puppet-lint-strict_indent-check/tree/4.0.0) (2025-08-06)
+
+[Full Changelog](https://github.com/voxpupuli/puppet-lint-strict_indent-check/compare/3.0.0...4.0.0)
+
+**Breaking changes:**
+
+- Match the indent for a single semicolon with the Puppet documentation [\#48](https://github.com/voxpupuli/puppet-lint-strict_indent-check/pull/48) ([msalway](https://github.com/msalway))
+- Only indent once for doubled brackets [\#44](https://github.com/voxpupuli/puppet-lint-strict_indent-check/pull/44) ([msalway](https://github.com/msalway))
+
+**Fixed bugs:**
+
+- Refactor heredoc indent calculations [\#47](https://github.com/voxpupuli/puppet-lint-strict_indent-check/pull/47) ([msalway](https://github.com/msalway))
+
+**Closed issues:**
+
+- Ruby 3.1 test fails due to double start of SimpleCov [\#45](https://github.com/voxpupuli/puppet-lint-strict_indent-check/issues/45)
+- Test workflow fails [\#41](https://github.com/voxpupuli/puppet-lint-strict_indent-check/issues/41)
+- Extra indent requested with two opens on same line. [\#21](https://github.com/voxpupuli/puppet-lint-strict_indent-check/issues/21)
+- Update indent behaviour when semicolon is on a separate line [\#19](https://github.com/voxpupuli/puppet-lint-strict_indent-check/issues/19)
+
+**Merged pull requests:**
+
+- Update README for recent changes [\#49](https://github.com/voxpupuli/puppet-lint-strict_indent-check/pull/49) ([msalway](https://github.com/msalway))
+- Remove SimpleCov.start as it is done by PuppetLint's spec\_helper [\#46](https://github.com/voxpupuli/puppet-lint-strict_indent-check/pull/46) ([msalway](https://github.com/msalway))
+- fix rubocop [\#42](https://github.com/voxpupuli/puppet-lint-strict_indent-check/pull/42) ([paran1](https://github.com/paran1))
+- Update voxpupuli-rubocop requirement from ~\> 1.1 to ~\> 2.0 [\#36](https://github.com/voxpupuli/puppet-lint-strict_indent-check/pull/36) ([dependabot[bot]](https://github.com/apps/dependabot))
+
 ## [3.0.0](https://github.com/voxpupuli/puppet-lint-strict_indent-check/tree/3.0.0) (2023-04-21)
 
 [Full Changelog](https://github.com/voxpupuli/puppet-lint-strict_indent-check/compare/2.1.0...3.0.0)

data/README.md

@@ -35,12 +35,15 @@ puppet-lint -l chars_per_indent_4.rb puppet-mysql/manifests/init.pp
 
 ## Acceptable Identation
 
-* indent should increase by one step the line after each opened brace (square, curly, paren)
+* indent should increase by one step the line after each opened brace (square, curly, paren).
 * indent should decrease by one step the line of every closed brace.
+* if multiple pairs of braces are opened and closed on the same two lines the indent should only increase once.
 * indent should increase by one step the line after a resource title, unless it already increased due to a bracket.
 * indent should decrease by one step the line after the end of a resource due to semicolon, if it was indented for resource title.
+* if the semicolon is the only element on the line then the indent decreases on the semicolon line instead of the line after.
 * indent should decrease by one step the line of the end of a resource due to right curly brace, if it was indented for resource title, and not ended by a semicolon.
 * indent should increase by one step the line after an equals `=` or farrow `=>` that ends a line, but only for that one line.
+* heredoc contents should be indented by one step.
 
 see `spec/fixtures/pass/` for good indentation examples.
 

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

@@ -7,22 +7,19 @@ PuppetLint.new_check(:strict_indent) do
       RBRACE: :LBRACE,
       RBRACK: :LBRACK,
       RPAREN: :LPAREN,
-      HEREDOC: :HEREDOC_OPEN,
-      HEREDOC_POST: :HEREDOC_OPEN,
     }
     open = {
       LBRACE: [],
       LBRACK: [],
       LPAREN: [],
-      HEREDOC_OPEN: [],
     }
 
     matches = {}
 
     tokens.each do |token|
-      if %i[LBRACE LBRACK LPAREN HEREDOC_OPEN].include?(token.type)
+      if %i[LBRACE LBRACK LPAREN].include?(token.type)
         open[token.type] << token
-      elsif %i[RBRACE RBRACK RPAREN HEREDOC HEREDOC_POST].include?(token.type)
+      elsif %i[RBRACE RBRACK RPAREN].include?(token.type)
         match = open[opening_token[token.type]].pop
         unless match.nil?
           matches[token] = match
@@ -49,15 +46,20 @@ PuppetLint.new_check(:strict_indent) do
     end.each do |token|
       temp_indent = 0
 
+      matched_open_lines = []
       # indent for open groups in the previous line
       open_groups = 0
       prev_token = token.prev_token
       while !prev_token.nil? and prev_token.type != :NEWLINE
         temp_indent += 1 if prev_token.type == :HEREDOC_OPEN
-        if %i[LBRACE LBRACK
-              LPAREN].include?(prev_token.type) && (matches[prev_token].nil? or matches[prev_token].line > prev_token.line)
-          # left braces not matched in the same line increase indent
-          open_groups += 1
+        if %i[LBRACE LBRACK LPAREN].include?(prev_token.type)
+          if matches[prev_token].nil?
+            open_groups += 1
+          elsif matches[prev_token].line > prev_token.line and !matched_open_lines.include?(matches[prev_token].line)
+            # increase indent for left braces not matched in the same line or in a line we have already matched a brace to
+            open_groups += 1
+            matched_open_lines << matches[prev_token].line
+          end
         end
         prev_token = prev_token.prev_token
       end
@@ -96,17 +98,27 @@ PuppetLint.new_check(:strict_indent) do
 
       # unindent for closing brackets in the current line
       next_token = token.next_token
+      matched_close_lines = []
       while !next_token.nil? and next_token.type != :NEWLINE
         if %i[RBRACE RBRACK RPAREN].include?(next_token.type)
-          if !matches[next_token].nil? and matches[next_token].line < next_token.line
-            # right braces matched in a previous line decrease indent
+          if !matches[next_token].nil? and
+             matches[next_token].line < next_token.line and
+             !matched_close_lines.include?(matches[next_token].line)
+            # right braces matched in a previous line decrease indent unless we already matched a brace in the same line
             indent -= 1
+            matched_close_lines << matches[next_token].line
           end
           if next_token.type == :RBRACE and !colon_indent.nil? && (!matches[next_token].nil? and matches[next_token].line < colon_indent)
             # unindent at the end of resources if needed
             indent -= 1
             colon_indent = nil
           end
+        elsif next_token.type == :SEMIC and !colon_indent.nil? and
+              %i[INDENT NEWLINE].include?(next_token.prev_token.type) and
+              (next_token.next_token.nil? or next_token.next_token.type == :NEWLINE)
+          # For a lone semicolon within a block decrement immediately. Use temp_indent because
+          # indent will be decremented in the next line by the prev_token logic above.
+          temp_indent -= 1
         end
         next_token = next_token.next_token
       end
@@ -123,13 +135,31 @@ PuppetLint.new_check(:strict_indent) do
       end
 
       # get actual indent
-      actual = 0
-      actual = if token.next_token.type == :INDENT
+      actual = case token.next_token.type
+               when :INDENT
                  token.next_token.value.length
-               elsif !token.prev_token.nil? and token.prev_token.type == :HEREDOC
-                 token.prev_token.value.split("\n").last.length
-               elsif !token.prev_token.nil? and token.prev_token.type == :HEREDOC_OPEN
-                 next_token.prev_token.value.split("\n").last.length
+               when :HEREDOC
+                 # Lines containing heredocs have no indent token as the indent is consumed by the heredoc token.
+                 # However the last line of the token value is the whitespace before the pipe in the termination line.
+                 # We use the length of this to get the indent.
+                 if token.next_token.value.end_with?("\n")
+                   0
+                 else
+                   token.next_token.value.split("\n").last.length
+                 end
+               when :HEREDOC_PRE
+                 # For interpolated heredocs the pipe whitespace is in the HEREDOC_POST token so we need scan forward
+                 # to this and get its length.
+                 next_token = token.next_token
+                 while !next_token.nil? and next_token.type != :NEWLINE and next_token.type != :HEREDOC_POST
+                   next_token = next_token.next_token
+                 end
+                 if next_token.type == :HEREDOC_POST
+                   next_token.value.split("\n").last.length
+                 else
+                   # Should never get here return zero if we do
+                   0
+                 end
                else
                  0
                end
@@ -149,6 +179,7 @@ PuppetLint.new_check(:strict_indent) do
         column: token.next_token.column,
         token: token.next_token,
         indent: expected,
+        actual: actual,
       }
     end
   end
@@ -157,6 +188,18 @@ PuppetLint.new_check(:strict_indent) do
     char_for_indent = ' '
     if %i[INDENT WHITESPACE].include?(problem[:token].type)
       problem[:token].value = char_for_indent * problem[:indent]
+    elsif problem[:token].type == :HEREDOC
+      change = problem[:indent] - problem[:actual]
+      indent_heredoc(problem[:token], change)
+    elsif problem[:token].type == :HEREDOC_PRE
+      change = problem[:indent] - problem[:actual]
+      indent_heredoc(problem[:token], change)
+      next_token = problem[:token].next_token
+      while !next_token.nil? and next_token.type != :HEREDOC_POST
+        indent_heredoc(next_token, change) if next_token.type == :HEREDOC_MID
+        next_token = next_token.next_token
+      end
+      indent_heredoc(next_token, change) if next_token.type == :HEREDOC_POST
     else
       tokens.insert(
         tokens.find_index(problem[:token]),
@@ -164,4 +207,31 @@ PuppetLint.new_check(:strict_indent) do
       )
     end
   end
+
+  def map_heredoc_lines(value, change, skip)
+    char_for_indent = ' '
+    value.split("\n").map! do |line|
+      if skip or line.empty?
+        skip = false
+        line
+      elsif change < 0
+        line[-change..]
+      else
+        (char_for_indent * change) + line
+      end
+    end.join("\n")
+  end
+
+  def indent_heredoc(token, change)
+    case token.type
+    when :HEREDOC
+      token.raw = map_heredoc_lines(token.raw, change, false)
+    when :HEREDOC_PRE
+      token.value = map_heredoc_lines(token.value, change, false)
+    when :HEREDOC_MID
+      token.value = map_heredoc_lines(token.value, change, true)
+    when :HEREDOC_POST
+      token.raw = map_heredoc_lines(token.raw, change, true)
+    end
+  end
 end

data/spec/fixtures/fail/heredoc_interpolated_extra.pp

@@ -0,0 +1,5 @@
+$variable = @(EOT)
+    This is a multiline
+    with a ${variable}
+    heredoc string
+   | EOT

data/spec/fixtures/fail/heredoc_interpolated_insuficient.pp

@@ -0,0 +1,5 @@
+$variable = @(EOT)
+This is a multiline
+with a ${variable}
+heredoc string
+| EOT

data/spec/fixtures/pass/doubles.pp

@@ -0,0 +1,13 @@
+$content = epp('file.epp',{
+  'options' => '124',
+})
+
+$content = epp(
+  'file.epp',{
+    'options' => '124',
+})
+
+$content = epp('file.epp',{
+    'options' => '124',
+  }
+)

data/spec/fixtures/pass/heredocclass.pp

@@ -0,0 +1,31 @@
+# Tests for heredocs within class
+class 'heredocclass' {
+  file { '/heredoc/file/resource/without/comma':
+    content => @(HERE)
+      This is a here doc
+      with two lines
+      | HERE
+  }
+
+  file { '/heredoc/file/resource/with/comma':
+    content => @(HERE),
+      This is a here doc
+      with two lines
+      | HERE
+  }
+
+  file { '/heredoc/in/function/in/file/resource':
+    content => inlineepp(@(HERE)),
+      This is a here doc
+      with two lines
+      | HERE
+  }
+
+  $variable_with_interpolation = @("EOT")
+    Another example
+    ${variable}
+    with
+    ${variable}
+    with interpolation
+    | EOT
+}

data/spec/fixtures/pass/semicolon.pp

@@ -0,0 +1,15 @@
+file {
+  default:
+    ensure => file,
+    owner  => 'root',
+    group  => 'wheel',
+    mode   => '0600',
+  ;
+  ['ssh_host_dsa_key', 'ssh_host_key', 'ssh_host_rsa_key']:
+    # use all defaults
+  ;
+  ['ssh_config', 'ssh_host_dsa_key.pub', 'ssh_host_key.pub', 'ssh_host_rsa_key.pub', 'sshd_config']:
+    # override mode
+    mode => '0644',
+  ;
+}

data/spec/puppet-lint/plugins/check_strict_indent_spec.rb

@@ -1,4 +1,7 @@
 require 'spec_helper'
+# rubocop:disable Lint/RedundantRequireStatement
+require 'pp'
+# rubocop:enable Lint/RedundantRequireStatement
 
 describe 'strict_indent' do
   before do
@@ -6,7 +9,7 @@ describe 'strict_indent' do
     PuppetLint.configuration.checks.reject do |check|
       check == :indent
     end.each do |check|
-      PuppetLint.configuration.send("disable_#{check}")
+      PuppetLint.configuration.send(:"disable_#{check}")
     end
   end
 
@@ -15,7 +18,7 @@ describe 'strict_indent' do
     PuppetLint.configuration.checks.reject do |check|
       check == :indent
     end.each do |check|
-      PuppetLint.configuration.send("enable_#{check}")
+      PuppetLint.configuration.send(:"enable_#{check}")
     end
   end
 
@@ -90,4 +93,196 @@ describe 'strict_indent' do
       expect(problems).to have(0).problems
     end
   end
+
+  context 'misplaced resource semicolons' do
+    before do
+      PuppetLint.configuration.fix = true
+    end
+
+    after do
+      PuppetLint.configuration.fix = false
+    end
+
+    let(:code) do
+      <<~EOF
+        file {
+          default:
+            ensure => file,
+            owner  => 'root',
+            group  => 'wheel',
+            mode   => '0600',
+            ;
+          ['ssh_host_dsa_key', 'ssh_host_key', 'ssh_host_rsa_key']:
+            # use all defaults
+            ;
+          ['ssh_config', 'ssh_host_dsa_key.pub', 'ssh_host_key.pub', 'ssh_host_rsa_key.pub', 'sshd_config']:
+            # override mode
+            mode => '0644',
+        ;
+        }
+      EOF
+    end
+
+    let(:fixed) do
+      <<~EOF
+        file {
+          default:
+            ensure => file,
+            owner  => 'root',
+            group  => 'wheel',
+            mode   => '0600',
+          ;
+          ['ssh_host_dsa_key', 'ssh_host_key', 'ssh_host_rsa_key']:
+            # use all defaults
+          ;
+          ['ssh_config', 'ssh_host_dsa_key.pub', 'ssh_host_key.pub', 'ssh_host_rsa_key.pub', 'sshd_config']:
+            # override mode
+            mode => '0644',
+          ;
+        }
+      EOF
+    end
+
+    it 'detects three problems' do
+      expect(problems).to have(3).problem
+    end
+
+    it 'fixes the first problem' do
+      expect(problems).to contain_fixed('indent should be 2 chars and is 4').on_line(7).in_column(1)
+    end
+
+    it 'fixes the second problem' do
+      expect(problems).to contain_fixed('indent should be 2 chars and is 4').on_line(10).in_column(1)
+    end
+
+    it 'fixes the third problem' do
+      expect(problems).to contain_fixed('indent should be 2 chars and is 0').on_line(14).in_column(1)
+    end
+
+    it 'moves the semicolons' do
+      expect(manifest).to eq fixed
+    end
+  end
+
+  context 'misaligned heredocs' do
+    before do
+      PuppetLint.configuration.fix = true
+    end
+
+    after do
+      PuppetLint.configuration.fix = false
+    end
+
+    let(:code) do
+      <<~EOF
+        $over_indented = @(HERE)
+            This is a heredoc
+            that has been
+
+            indented 4 spaces
+               and has some
+             internal indenting
+            | HERE
+
+        $under_indented = @(HERE)
+        This is a heredoc
+
+        that has no
+        indent
+          and has some
+         internal indenting
+        | HERE
+
+        $over_indented_interpolated = @("HERE")
+            This is a heredoc
+            with a ${variable}
+            that has been
+
+            indented 4 spaces
+               and has some
+             internal indenting
+            and ${another} variable
+            | HERE
+
+        $under_indented_interpolated = @("HERE")
+         This is a heredoc
+         with a ${variable} with trailing text
+         that has been
+
+         indented 1 space
+             and has some
+               internal indenting
+         and ${another} variable
+         | HERE
+      EOF
+    end
+
+    let(:fixed) do
+      <<~EOF
+        $over_indented = @(HERE)
+          This is a heredoc
+          that has been
+
+          indented 4 spaces
+             and has some
+           internal indenting
+          | HERE
+
+        $under_indented = @(HERE)
+          This is a heredoc
+
+          that has no
+          indent
+            and has some
+           internal indenting
+          | HERE
+
+        $over_indented_interpolated = @("HERE")
+          This is a heredoc
+          with a ${variable}
+          that has been
+
+          indented 4 spaces
+             and has some
+           internal indenting
+          and ${another} variable
+          | HERE
+
+        $under_indented_interpolated = @("HERE")
+          This is a heredoc
+          with a ${variable} with trailing text
+          that has been
+
+          indented 1 space
+              and has some
+                internal indenting
+          and ${another} variable
+          | HERE
+      EOF
+    end
+
+    it 'detects four problems' do
+      expect(problems).to have(4).problem
+    end
+
+    it 'fixes the first problem' do
+      expect(problems).to contain_fixed('indent should be 2 chars and is 4').on_line(2).in_column(1)
+    end
+
+    it 'fixes the second problem' do
+      expect(problems).to contain_fixed('indent should be 2 chars and is 0').on_line(11).in_column(1)
+    end
+
+    it 'fixes the third problem' do
+      expect(problems).to contain_fixed('indent should be 2 chars and is 4').on_line(20).in_column(1)
+    end
+
+    it 'fixes the forth problem' do
+      expect(problems).to contain_fixed('indent should be 2 chars and is 1').on_line(31).in_column(1)
+    end
+
+    it 'moves the heredoc' do
+      expect(manifest).to eq fixed
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,29 +1,6 @@
 # frozen_string_literal: true
 
-begin
-  require 'simplecov'
-  require 'simplecov-console'
-  require 'codecov'
-rescue LoadError
-else
-  SimpleCov.start do
-    track_files 'lib/**/*.rb'
-
-    add_filter '/spec'
-
-    enable_coverage :branch
-
-    # do not track vendored files
-    add_filter '/vendor'
-    add_filter '/.vendor'
-  end
-
-  SimpleCov.formatters = [
-    SimpleCov::Formatter::Console,
-    SimpleCov::Formatter::Codecov,
-  ]
-end
-
 require 'puppet-lint'
+require 'rspec/collection_matchers'
 
 PuppetLint::Plugins.load_spec_helper

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-strict_indent-check
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Vox Pupuli
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-21 00:00:00.000000000 Z
+date: 2025-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -43,16 +43,21 @@ files:
 - lib/puppet-lint/plugins/check_strict_indent.rb
 - spec/fixtures/fail/1.pp
 - spec/fixtures/fail/heredoc_extra.pp
+- spec/fixtures/fail/heredoc_interpolated_extra.pp
+- spec/fixtures/fail/heredoc_interpolated_insuficient.pp
 - spec/fixtures/fail/heredoc_unsuficient.pp
 - spec/fixtures/pass/1.pp
+- spec/fixtures/pass/doubles.pp
 - spec/fixtures/pass/heredoc.pp
+- spec/fixtures/pass/heredocclass.pp
+- spec/fixtures/pass/semicolon.pp
 - spec/puppet-lint/plugins/check_strict_indent_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/voxpupuli/puppet-lint-strict_indent-check
 licenses:
 - MPL-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -68,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.33
-signing_key: 
+signing_key:
 specification_version: 4
 summary: puppet-lint strict indent check
 test_files: []