puppet-lint-array_formatting-check 0.9.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c130a6b549e23b5a62141163214c8dc669e2ec4cf4e2969773a853bf490d60e7
-  data.tar.gz: d4233449808f9190aa3683639a99586ad89417280c370c256262d8af40a3e8aa
+  metadata.gz: 253a737a788c7d2d46e0452562fa67d5177f096204039fb294f98633c5435b70
+  data.tar.gz: 44a81890888cd86b28cd8ba156b311f2e370b6a02f6a5ba3a1d8db74e87652aa
 SHA512:
-  metadata.gz: fee2c7bccde0fcf12cd2e1187556cc5ba2531ce7063f266da5fc309de07e01236f5d9e696991d3af19e824b54b2b7892a9e4c44b8f9a21f0b7379a086c876805
-  data.tar.gz: 6e198fc7fa4705566971abe7a486af1653cf43e3c85ffb0794c61e003528655358a444b64f727cbf5cf7da67a6bbf46571b4524d3b4aa1d7794406d1e7d41f70
+  metadata.gz: 927806a62b811ac503f789a3f9a7eca73307bf162dc16c42eb78f5368983732dcf3ebf1d9df8c7aec2261a2b374c032e09c9364c85871732415a14f48e97f8a5
+  data.tar.gz: 13c068cb3b5a180d3f0c42dc799686343bed9eae54c450e4ed8d307859f21efb50ac8ce2ed343070032bb2bd73a7d0746807cb20db8726e42754e98a9dec9a20

data/README.md

@@ -1,5 +1,7 @@
 # puppet-lint array formatting check
 
+[![Gem Version](https://badge.fury.io/rb/puppet-lint-array_formatting-check.svg)](https://badge.fury.io/rb/puppet-lint-array_formatting-check)
+
 A new check for puppet-lint that ensures array formatting conforms to the [Puppet Style Guide](https://puppet.com/docs/puppet/6.0/style_guide.html#arrays-and-hashes) on arrays; namely that each element should be on a separate line.
 
 It will take an array formatted as
@@ -57,13 +59,13 @@ This plugin provides a new check to `puppet-lint`.
 This check will raise warnings for every element in an array that should be on its own line
 
 ```
-WARNING: expected newline before element
+WARNING: expected newline before element on line 3
 ```
 
-It will also flag instances of extra newlines in arrays
+It will also raise warnings on extra (unnecessary) newlines in arrays
 
 ```
-WARNING: unexpected newline
+WARNING: unexpected newline on line 4
 ```
 
 ### Author

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

@@ -1,3 +1,9 @@
+# frozen_string_literal: true
+
+EXPECTED_NEWLINE_BEFORE_ELEMENT = 'expected newline before element'
+EXPECTED_NEWLINE_BEFORE_CLOSE = 'expected newline before close'
+UNEXPECTED_NEWLINE = 'unexpected newline'
+PARSING_ERROR = 'parsing error'
 PuppetLint.new_check(:array_formatting) do
   def process_array
     # When we arrive here, the @manifest enumerator is "pointing" to
@@ -18,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)
@@ -50,7 +66,7 @@ PuppetLint.new_check(:array_formatting) do
       elsif !prev_token_was_newline && ![:NEWLINE].include?(manifest_array[x].type)
         # We were expecting a newline. :-(
         notify :warning,
-               message: 'expected newline before element',
+               message: EXPECTED_NEWLINE_BEFORE_ELEMENT,
                line: manifest_array[x].line,
                column: manifest_array[x].column,
                token: manifest_array[x]
@@ -59,7 +75,7 @@ PuppetLint.new_check(:array_formatting) do
       elsif prev_token_was_newline && [:NEWLINE].include?(manifest_array[x].type)
         # We got an extra newline. Let's fix that up while we're at it.
         notify :warning,
-               message: 'unexpected newline',
+               message: UNEXPECTED_NEWLINE,
                line: manifest_array[x].line,
                column: manifest_array[x].column,
                token: manifest_array[x]
@@ -68,7 +84,7 @@ PuppetLint.new_check(:array_formatting) do
       else
         # Something has gone horribly wrong.  The truth table says we should never be here.
         notify :error,
-               message: 'parsing error',
+               message: PARSING_ERROR,
                line: manifest_array[x].line,
                column: manifest_array[x].column
       end
@@ -79,9 +95,9 @@ 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',
+             message: EXPECTED_NEWLINE_BEFORE_CLOSE,
              line: token.line,
              column: token.column,
              token: token
@@ -108,16 +124,16 @@ PuppetLint.new_check(:array_formatting) do
   def fix(problem)
     token_index = tokens.find_index(problem[:token])
     case problem[:message]
-    when 'parsing error'
+    when PARSING_ERROR
       # Truth table says we should never get here
       raise PuppetLint::NoFix
-    when 'unexpected newline'
+    when UNEXPECTED_NEWLINE
       # If we delete the INDENT first, we change the index of the offending token,
       # so we need to do the token first, then the INDENT
       tokens.delete_at(token_index)
       # If the previous token is an Indent, we'll want to delete that too
       tokens.delete_at(token_index - 1) if [:INDENT].include?(problem[:token].prev_token.type)
-    when 'expected newline before element', 'expected newline before close'
+    when EXPECTED_NEWLINE_BEFORE_ELEMENT, EXPECTED_NEWLINE_BEFORE_CLOSE
       # If the preceeding token is a whitespace, replace it with a newline instead
       # so that we don't end up with trailing whitespaces
       if %i[WHITESPACE INDENT].include?(problem[:token].prev_token.type)

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

@@ -1,7 +1,5 @@
-# Rubocop has a problem with some of my examples.
-# Since they're Puppet code, inside a ruby file,
-# I'm going to blame different syntaxes.
-# rubocop:disable TrailingCommaInArguments
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'array_formatting' do
@@ -112,7 +110,7 @@ describe 'array_formatting' do
     end
     context 'on code with an array with extra newlines' do
       let(:code) do
-        # rubocop:disable TrailingWhitespace
+        # rubocop:disable Layout/TrailingWhitespace
         <<-ARRAY.gsub(/^ {10}/, '')
           file{[
             '/etc',
@@ -125,7 +123,7 @@ describe 'array_formatting' do
             ensure => directory,
           }
         ARRAY
-        # rubocop:enable TrailingWhitespace
+        # rubocop:enable Layout/TrailingWhitespace
       end
 
       it 'should detect 2 problems' do
@@ -383,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
@@ -540,7 +600,7 @@ describe 'array_formatting' do
     end
     context 'on code with an array with extra newlines' do
       let(:code) do
-        # rubocop:disable TrailingWhitespace
+        # rubocop:disable Layout/TrailingWhitespace
         <<-ARRAY.gsub(/^ {10}/, '')
           file{[
             '/etc',
@@ -553,7 +613,7 @@ describe 'array_formatting' do
             ensure => directory,
           }
         ARRAY
-        # rubocop:enable TrailingWhitespace
+        # rubocop:enable Layout/TrailingWhitespace
       end
 
       it 'should detect 2 problems' do
@@ -1018,6 +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
-# rubocop:enable TrailingCommaInArguments

data/spec/spec_helper.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require 'simplecov'
-SimpleCov.start 'rails' do
+
+SimpleCov.start do
   add_filter '/bin/'
   add_filter '/db/'
   add_filter '/spec/' # for rspec

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-array_formatting-check
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Adam Manzer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-03-21 00:00:00.000000000 Z
+date: 2023-05-12 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.1.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 3.1.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
-- !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-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-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-json_expectations
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '5'
 description: "    A puppet-lint plugin to check that arrays comform to the style guideline
   of having one element per line.\n"
 email: amanzer@gmail.com
@@ -124,13 +40,15 @@ 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
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -138,17 +56,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: A puppet-lint plugin to check array formatting.
-test_files:
-- spec/spec_helper.rb
-- spec/puppet-lint/plugins/check_array_formatting_spec.rb
+test_files: []