puppet-lint-array_formatting-check 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08713cd7bf32fe3f2f529c4138c3f9243122fec74123b46ca92364a1f904df91'
-  data.tar.gz: a1cec828ab3bb0a6a2251ad3e49b35e21a7161739295d86af80532f52361ad88
+  metadata.gz: 253a737a788c7d2d46e0452562fa67d5177f096204039fb294f98633c5435b70
+  data.tar.gz: 44a81890888cd86b28cd8ba156b311f2e370b6a02f6a5ba3a1d8db74e87652aa
 SHA512:
-  metadata.gz: a9650c19207b107d1d98ec6ffb169605b34c03af8169b85a2618935e688ca5af522c3d45bb9532dc70c7c9e781ab799294e3811594def2205d2f714d47304260
-  data.tar.gz: a658f6274cdfc3e481cc34c26f728f780e9a1e79f89fc5de8f3bb20285a74d468f9666b66c65209fd80cdd1e3015f28525612c4425205cefe520615910faa2b6
+  metadata.gz: 927806a62b811ac503f789a3f9a7eca73307bf162dc16c42eb78f5368983732dcf3ebf1d9df8c7aec2261a2b374c032e09c9364c85871732415a14f48e97f8a5
+  data.tar.gz: 13c068cb3b5a180d3f0c42dc799686343bed9eae54c450e4ed8d307859f21efb50ac8ce2ed343070032bb2bd73a7d0746807cb20db8726e42754e98a9dec9a20

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

@@ -24,9 +24,19 @@ PuppetLint.new_check(:array_formatting) do
         # Recursively process this nested array.
         # Store return so we know if the child array was processed or not.
         len_of_nested_array = process_array
-      # If we encounter something _other_ than COMMA, WHITESPACE, or INDENT, push it.
-      # These don't include NEWLINE(s), which is what we need to keep track of.
-      elsif !%i[COMMA WHITESPACE INDENT].include?(token.type)
+      # If we encounter a DQPRE, we need to scan ahead until we find the matching DQPOST
+      elsif [:DQPRE].include?(token.type)
+        # Tight loop until we find a DQPOST, or a Nil in case of an unterminated string
+        until [:DQPOST].include?(token.type) || token.nil?
+          # Advance.  We're still looking for that DQPOST
+          token = @manifest.next
+        end
+        # Store the DQPOST
+        manifest_array.push token
+      # We're really only keeping track of array *items* here for the sake of the length calculation.
+      # We're going to ignore everything that doesn't count as an *item*, like commas, comments, and whitespaces
+      # We need to push NEWLINE(s) though because there might be too many
+      elsif !%i[COMMA COMMENT WHITESPACE INDENT].include?(token.type)
         manifest_array.push token
       end
       # Advance.  (We're still looking for that RBRACK)
@@ -85,7 +95,7 @@ PuppetLint.new_check(:array_formatting) do
     # If the last token (not including the RBRACK) wasn't a newline, throw a warning.
     # Since we previously used token to scan forward to the ],
     # token is already pointing to the offending ].
-    if !prev_token_was_newline # rubocop:disable NegatedIf "I find this clearer than `unless prev_token_was_newline`"
+    if !prev_token_was_newline # rubocop:disable Style/NegatedIf "I find this clearer than `unless prev_token_was_newline`"
       notify :warning,
              message: EXPECTED_NEWLINE_BEFORE_CLOSE,
              line: token.line,

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'array_formatting' do
+  let(:msg) { 'expected newline before element' }
+  let(:msg_end) { 'expected newline before close' }
+  let(:msg_newline) { 'unexpected newline' }
+
+  context 'with fix disabled' do
+    context 'on code with an empty array' do
+      let(:code) { '$services = []' }
+
+      it 'should detect no problem' do
+        expect(problems).to have(0).problems
+      end
+    end
+  end
+  context 'with fix enabled' do
+    before do
+      PuppetLint.configuration.fix = true
+    end
+
+    after do
+      PuppetLint.configuration.fix = false
+    end
+    context 'on code with an empty array' do
+      let(:code) { '$services = []' }
+
+      it 'should detect no problem' do
+        expect(problems).to have(0).problems
+      end
+
+      it 'should not modify the manifest' do
+        expect(manifest).to eq(code)
+      end
+    end
+  end
+end

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

@@ -381,6 +381,68 @@ describe 'array_formatting' do
         expect(problems).to contain_warning(msg_end).on_line(14).in_column(42)
       end
     end
+    context 'on a string with a properly formatted multidimensional hash (Issue #18)' do
+      let(:code) do
+        <<-CODE.gsub(/^ {10}/, '')
+          Apt::Source["yubihsm-${facts['os']['distro']['codename']}"],
+        CODE
+      end
+      it 'should detect no problem' do
+        expect(problems).to have(0).problems
+      end
+    end
+    context 'on a code snippet with a properly formatted multidimensional hash (Issue #18)' do
+      let(:code) do
+        <<-CODE.gsub(/^ {10}/, '')
+        package { $packages:
+          ensure  => $version,
+          require => [
+            Class['apt::update'],
+            Apt::Source["yubihsm-${facts['os']['distro']['codename']}"],
+          ],
+        }
+        CODE
+      end
+      it 'should detect no problem' do
+        expect(problems).to have(0).problems
+      end
+    end
+    context 'on a string with a properly formatted variable (Issue #19)' do
+      let(:code) do
+        <<-CODE.gsub(/^ {10}/, '')
+        file { [
+            "${root_dir}/index.txt",
+            "${root_dir}/index.txt.attr"
+          ]:
+            ensure => file,
+            owner => 0,
+            group => 0,
+            mode => '0400',
+        }
+        CODE
+      end
+      it 'should detect no problem' do
+        expect(problems).to have(0).problems
+      end
+    end
+    context 'on an array with comments after some values (Issue #20)' do
+      let(:code) do
+        <<-CODE.gsub(/^ {10}/, '')
+        proxy_set_header   => [
+          'Host $http_host:8043',
+          'X-Real-IP $remote_addr',
+          'X-Forwarded-For $proxy_add_x_forwarded_for',
+          'Cookie $http_cookie',
+          'X-Forwarded-Proto $scheme',
+          'Upgrade $http_upgrade',  #websockets
+          'Connection "Upgrade"',  #websockets
+        ],
+        CODE
+      end
+      it 'should detect no problem' do
+        expect(problems).to have(0).problems
+      end
+    end
   end
   context 'with fix enabled' do
     before do
@@ -1016,5 +1078,83 @@ describe 'array_formatting' do
         )
       end
     end
+    context 'on a string with a properly formatted multidimensional hash (Issue #18)' do
+      let(:code) do
+        <<-CODE.gsub(/^ {10}/, '')
+          Apt::Source["yubihsm-${facts['os']['distro']['codename']}"],
+        CODE
+      end
+      it 'should detect no problem' do
+        expect(problems).to have(0).problems
+      end
+
+      it 'should not modify the manifest' do
+        expect(manifest).to eq(code)
+      end
+    end
+    context 'on a code snippet with a properly formatted multidimensional hash (Issue #18)' do
+      let(:code) do
+        <<-CODE.gsub(/^ {10}/, '')
+        package { $packages:
+          ensure  => $version,
+          require => [
+            Class['apt::update'],
+            Apt::Source["yubihsm-${facts['os']['distro']['codename']}"],
+          ],
+        }
+        CODE
+      end
+      it 'should detect no problem' do
+        expect(problems).to have(0).problems
+      end
+
+      it 'should not modify the manifest' do
+        expect(manifest).to eq(code)
+      end
+    end
+    context 'on a string with a properly formatted variable (Issue #19)' do
+      let(:code) do
+        <<-CODE.gsub(/^ {10}/, '')
+        file { [
+            "${root_dir}/index.txt",
+            "${root_dir}/index.txt.attr"
+          ]:
+            ensure => file,
+            owner => 0,
+            group => 0,
+            mode => '0400',
+        }
+        CODE
+      end
+      it 'should detect no problem' do
+        expect(problems).to have(0).problems
+      end
+
+      it 'should not modify the manifest' do
+        expect(manifest).to eq(code)
+      end
+    end
+    context 'on an array with comments after some values (Issue #20)' do
+      let(:code) do
+        <<-CODE.gsub(/^ {10}/, '')
+        proxy_set_header   => [
+          'Host $http_host:8043',
+          'X-Real-IP $remote_addr',
+          'X-Forwarded-For $proxy_add_x_forwarded_for',
+          'Cookie $http_cookie',
+          'X-Forwarded-Proto $scheme',
+          'Upgrade $http_upgrade',  #websockets
+          'Connection "Upgrade"',  #websockets
+        ],
+        CODE
+      end
+      it 'should detect no problem' do
+        expect(problems).to have(0).problems
+      end
+
+      it 'should not modify the manifest' do
+        expect(manifest).to eq(code)
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-array_formatting-check
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Adam Manzer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-03 00:00:00.000000000 Z
+date: 2023-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -40,6 +40,7 @@ files:
 - LICENSE
 - README.md
 - lib/puppet-lint/plugins/check_array_formatting.rb
+- spec/puppet-lint/plugins/check_array_formatting_selected_spec.rb
 - spec/puppet-lint/plugins/check_array_formatting_spec.rb
 - spec/spec_helper.rb
 homepage: https://gitlab.com/amanzer/puppet-lint-array_formatting-check