puppet-lint-strict_indent-check 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef74dd23e7f707cb92230b999f833b102a5069be9857a88e1500809ad57a8c20
-  data.tar.gz: 5b4f48f0408cb5161c4d1cec7144c703399aa88d35fb319c7c2fe78e2e164075
+  metadata.gz: a813e32484645b3159a5cc786e1e1df8bb9ce13b7e72de92603836f8d88876d7
+  data.tar.gz: 812be78bb5e2d3eed4b37013d7a9ae2b4587d139ea8e1de1b95413b63b38a81a
 SHA512:
-  metadata.gz: da47ec5cabfbb07a0b9cf4e50d2700f8a1f355791b950260b0dd8784d84a3569c2bd9bcb6dcd289ad431c298291f397e1f4218444ba1469dad828c0f9aadbc3d
-  data.tar.gz: 90719145ab8fab866bacb471091bb4d8710b08a0c3627b18a3740bd0c92572ea584bb433de5fb765f4cfb55a03ccee42b8c6f65746d30b96ba5aa4ad897d199d
+  metadata.gz: f5d01a03406cfc9ff251e77b46059e31811346ffd6140c89e1920019f42b1a2590302b284399cc874053127a3645ac72cec725d7ad51bb5a76ede4992c0a8f3a
+  data.tar.gz: 0143dc2fc1d985646be7f22904ea3cd52dce21918c8829d69dfbc178a517af2784516120063ea5b45e2d02ee6a2335e2ae90d74de774302bd4479580c06ab40b

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file.
 
+## [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)
+
+**Breaking changes:**
+
+- Drop Ruby \< 2.7; Add RuboCop [\#34](https://github.com/voxpupuli/puppet-lint-strict_indent-check/pull/34) ([bastelfreak](https://github.com/bastelfreak))
+
 ## [2.1.0](https://github.com/voxpupuli/puppet-lint-strict_indent-check/tree/2.1.0) (2022-11-29)
 
 [Full Changelog](https://github.com/voxpupuli/puppet-lint-strict_indent-check/compare/2.0.8...2.1.0)

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

@@ -1,30 +1,30 @@
 # Public: Check the manifest tokens for correct indent levels and
 # record a warning for each instance found.
 
-PuppetLint.new_check(:'strict_indent') do
+PuppetLint.new_check(:strict_indent) do
   def match(tokens)
     opening_token = {
-      :RBRACE => :LBRACE,
-      :RBRACK => :LBRACK,
-      :RPAREN => :LPAREN,
-      :HEREDOC => :HEREDOC_OPEN,
-      :HEREDOC_POST => :HEREDOC_OPEN,
+      RBRACE: :LBRACE,
+      RBRACK: :LBRACK,
+      RPAREN: :LPAREN,
+      HEREDOC: :HEREDOC_OPEN,
+      HEREDOC_POST: :HEREDOC_OPEN,
     }
     open = {
-      :LBRACE => [],
-      :LBRACK => [],
-      :LPAREN => [],
-      :HEREDOC_OPEN => [],
+      LBRACE: [],
+      LBRACK: [],
+      LPAREN: [],
+      HEREDOC_OPEN: [],
     }
 
     matches = {}
 
     tokens.each do |token|
-      if [:LBRACE, :LBRACK, :LPAREN, :HEREDOC_OPEN].include?(token.type)
+      if %i[LBRACE LBRACK LPAREN HEREDOC_OPEN].include?(token.type)
         open[token.type] << token
-      elsif [:RBRACE, :RBRACK, :RPAREN, :HEREDOC, :HEREDOC_POST].include?(token.type)
+      elsif %i[RBRACE RBRACK RPAREN HEREDOC HEREDOC_POST].include?(token.type)
         match = open[opening_token[token.type]].pop
-        if not match.nil?
+        unless match.nil?
           matches[token] = match
           matches[match] = token
         end
@@ -41,26 +41,23 @@ PuppetLint.new_check(:'strict_indent') do
 
     matches = match(tokens)
 
-    tokens.select { |token|
+    tokens.select do |token|
       token.type == :NEWLINE
-    }.reject { |token|
+    end.reject do |token|
       # ignore newline at end of code
       token.next_token.nil?
-    }.each do |token|
+    end.each do |token|
       temp_indent = 0
 
       # indent for open groups in the previous line
       open_groups = 0
       prev_token = token.prev_token
-      while not prev_token.nil? and prev_token.type != :NEWLINE
-        if prev_token.type == :HEREDOC_OPEN
-          temp_indent += 1
-        end
-        if [:LBRACE, :LBRACK, :LPAREN].include?(prev_token.type)
-          if 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
-          end
+      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
         end
         prev_token = prev_token.prev_token
       end
@@ -68,7 +65,7 @@ PuppetLint.new_check(:'strict_indent') do
 
       # reset prev_token to last non-whitespace token on previous line
       prev_token = token.prev_token
-      while not prev_token.nil? and (prev_token.type == :WHITESPACE or prev_token.type == :COMMENT)
+      while !prev_token.nil? and (prev_token.type == :WHITESPACE or prev_token.type == :COMMENT)
         prev_token = prev_token.prev_token
       end
 
@@ -88,7 +85,7 @@ PuppetLint.new_check(:'strict_indent') do
           end
         end
       when :SEMIC
-        if not colon_indent.nil?
+        unless colon_indent.nil?
           # only unindent for a semicolon when we've indented for a colon
           colon_indent = nil
           indent -= 1
@@ -99,18 +96,16 @@ PuppetLint.new_check(:'strict_indent') do
 
       # unindent for closing brackets in the current line
       next_token = token.next_token
-      while not next_token.nil? and next_token.type != :NEWLINE
-        if [:RBRACE, :RBRACK, :RPAREN].include?(next_token.type)
-          if not matches[next_token].nil? and matches[next_token].line < next_token.line
+      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
             indent -= 1
           end
-          if next_token.type == :RBRACE and not colon_indent.nil?
-            if not 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
+          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
         end
         next_token = next_token.next_token
@@ -119,9 +114,9 @@ PuppetLint.new_check(:'strict_indent') do
       # obviously we have a problem
       if indent < 0
         notify :error, {
-          :message => 'Error calculating indent. Please file an issue at https://github.com/relud/puppet-lint-indent-check/issues',
-          :line    => token.next_token.line,
-          :column  => token.next_token.column,
+          message: 'Error calculating indent. Please file an issue at https://github.com/relud/puppet-lint-indent-check/issues',
+          line: token.next_token.line,
+          column: token.next_token.column,
         }
         # stop parsing indent
         break
@@ -129,43 +124,43 @@ PuppetLint.new_check(:'strict_indent') do
 
       # get actual indent
       actual = 0
-      if token.next_token.type == :INDENT
-        actual = token.next_token.value.length
-      elsif !token.prev_token.nil? and token.prev_token.type == :HEREDOC
-        actual = token.prev_token.value.split("\n").last.length
-      elsif !token.prev_token.nil? and token.prev_token.type == :HEREDOC_OPEN
-        actual = next_token.prev_token.value.split("\n").last.length
-      else
-        actual = 0
-      end
+      actual = if token.next_token.type == :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
+               else
+                 0
+               end
 
       # expected indent
       expected = (indent + temp_indent) * chars_per_indent
 
       # oh no! incorrect indent!
-      if actual != expected
-        # no one cares if blank lines and comments are indented correctly
-        if not [:COMMENT, :NEWLINE].include?(token.next_token.type)
-          notify :warning, {
-            :message => "indent should be #{expected} chars and is #{actual}",
-            :line    => token.next_token.line,
-            :column  => token.next_token.column,
-            :token   => token.next_token,
-            :indent  => expected,
-          }
-        end
-      end
+      next unless actual != expected
+
+      # no one cares if blank lines and comments are indented correctly
+      next if %i[COMMENT NEWLINE].include?(token.next_token.type)
+
+      notify :warning, {
+        message: "indent should be #{expected} chars and is #{actual}",
+        line: token.next_token.line,
+        column: token.next_token.column,
+        token: token.next_token,
+        indent: expected,
+      }
     end
   end
 
   def fix(problem)
     char_for_indent = ' '
-    if [:INDENT,:WHITESPACE].include?(problem[:token].type)
+    if %i[INDENT WHITESPACE].include?(problem[:token].type)
       problem[:token].value = char_for_indent * problem[:indent]
     else
       tokens.insert(
         tokens.find_index(problem[:token]),
-        PuppetLint::Lexer::Token.new(:INDENT, char_for_indent * problem[:indent], problem[:line], problem[:column])
+        PuppetLint::Lexer::Token.new(:INDENT, char_for_indent * problem[:indent], problem[:line], problem[:column]),
       )
     end
   end

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

@@ -3,18 +3,18 @@ require 'spec_helper'
 describe 'strict_indent' do
   before do
     # disable all other checks
-    PuppetLint.configuration.checks.reject{ |check|
+    PuppetLint.configuration.checks.reject do |check|
       check == :indent
-    }.each do |check|
+    end.each do |check|
       PuppetLint.configuration.send("disable_#{check}")
     end
   end
 
   after do
     # re-enable other checks
-    PuppetLint.configuration.checks.reject{ |check|
+    PuppetLint.configuration.checks.reject do |check|
       check == :indent
-    }.each do |check|
+    end.each do |check|
       PuppetLint.configuration.send("enable_#{check}")
     end
   end
@@ -24,7 +24,7 @@ describe 'strict_indent' do
       context manifest do
         let(:code) { File.read(manifest) }
 
-        it 'should detect no problems' do
+        it 'detects no problems' do
           expect(problems).to have(0).problems
         end
       end
@@ -34,7 +34,7 @@ describe 'strict_indent' do
       context manifest do
         let(:code) { File.read(manifest) }
 
-        it 'should detect problems' do
+        it 'detects problems' do
           expect(problems).to have(1).problems
         end
       end
@@ -42,7 +42,7 @@ describe 'strict_indent' do
   end
 
   context 'comment after resource title.' do
-    let(:code) {
+    let(:code) do
       <<-EOF.gsub(/^ {8}/, '')
         class (
         ) {
@@ -52,15 +52,15 @@ describe 'strict_indent' do
           }
         }
       EOF
-    }
+    end
 
-    it 'should detect 0 problems' do
+    it 'detects 0 problems' do
       expect(problems).to have(0).problems
     end
   end
 
   context 'invalid array indent' do
-    let(:code) {
+    let(:code) do
       <<-EOF.gsub(/^ {8}/, '')
         class (
         ) {
@@ -71,22 +71,22 @@ describe 'strict_indent' do
           }
         }
       EOF
-    }
+    end
 
-    it 'should detect 1 problems' do
+    it 'detects 1 problems' do
       expect(problems).to have(1).problems
     end
   end
 
   context 'blank line at beginning of file' do
-    let(:code) {
+    let(:code) do
       <<-EOF.gsub(/^ {8}/, '')
 
         class () {}
       EOF
-    }
+    end
 
-    it 'should detect 0 problems' do
+    it 'detects 0 problems' do
       expect(problems).to have(0).problems
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-strict_indent-check
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-29 00:00:00.000000000 Z
+date: 2023-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -16,104 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rspec-its
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rspec-collection_matchers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rspec-json_expectations
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 description: "    Extends puppet-lint to ensure that your manifests follow a strict
   indentation pattern.\n"
 email: voxpupuli@groups.io
@@ -134,7 +50,7 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/voxpupuli/puppet-lint-strict_indent-check
 licenses:
-- Mozilla 2.0
+- MPL-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -144,7 +60,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -155,11 +71,4 @@ rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: puppet-lint strict indent check
-test_files:
-- spec/fixtures/fail/1.pp
-- spec/fixtures/fail/heredoc_extra.pp
-- spec/fixtures/fail/heredoc_unsuficient.pp
-- spec/fixtures/pass/1.pp
-- spec/fixtures/pass/heredoc.pp
-- spec/puppet-lint/plugins/check_strict_indent_spec.rb
-- spec/spec_helper.rb
+test_files: []