puppet-lint-trailing_comma-check 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d67395151a03a6376cb6ac21c9858adf686dd1d
-  data.tar.gz: 890f46cdc36f8aa114432dce26631230e4a24c19
+  metadata.gz: 7d68ac60631084104f565a115f14a8492d2e41d8
+  data.tar.gz: cfa1c09748146e3cd158cd08f58e705c685e07a8
 SHA512:
-  metadata.gz: c9b0dcb07ff05ec38da689d4beb941c86d988744732df2126f7a3019469c00a38b6e38341d1064912d757959131fb0ff535d741a8cab2ec7c7c171ae7df23abb
-  data.tar.gz: 423bb368b8afbf50eef5bca8f6562ad1c627c6c5044d3e4e61ec29c481859212c0382037409b877a206d98ef8a0e0c7940f43076d727d7b6b4266c74167f7422
+  metadata.gz: 23415bfa426889069025182ef393b769a0eb9926f0115466d6aebae0ea7e81ce244f517bea03e9557d4066343017855291064f5ba2babed3bf06c36236d0d782
+  data.tar.gz: ae3f3b49374e58d5a5b4453f8b47db53e795c6f2c307f54aa2aaedf49119dd30c425461487e28f6b9892c2635de9cfe18d4f4aa78578fba0ea43580ec4d644a0

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

@@ -1,19 +1,75 @@
 PuppetLint.new_check(:trailing_comma) do
+  def array_indexes
+    results = []
+    tokens.each_with_index do |token, token_idx|
+      if token.type == :LBRACK
+        real_idx = 0
+        tokens[token_idx+1..-1].each_with_index do |cur_token, cur_token_idx|
+          real_idx = token_idx + 1 + cur_token_idx
+          break if cur_token.type == :RBRACK
+        end
+
+        results << {
+          :start  => token_idx,
+          :end    => real_idx,
+          :tokens => tokens[token_idx..real_idx],
+        }
+      end
+    end
+    results
+  end
+
+  def defaults_indexes
+    results = []
+    tokens.each_with_index do |token, token_idx|
+      if token.type == :CLASSREF && token.next_code_token && \
+         token.next_code_token.type == :LBRACE
+        real_idx = 0
+
+        tokens[token_idx+1..-1].each_with_index do |cur_token, cur_token_idx|
+          real_idx = token_idx + 1 + cur_token_idx
+          break if cur_token.type == :RBRACE
+        end
+
+        results << {
+          :start  => token_idx,
+          :end    => real_idx,
+          :tokens => tokens[token_idx..real_idx],
+        }
+      end
+    end
+    results
+  end
+
+  def check_elem(elem)
+    lbo_token = elem[:tokens][-1].prev_code_token
+    if lbo_token && lbo_token.type != :COLON && \
+                    elem[:tokens][-1].type != :SEMIC && \
+                    lbo_token.type != :COMMA && \
+                    lbo_token.next_token.type == :NEWLINE
+      notify :warning, {
+        :message => 'missing trailing comma after last element',
+        :line    => lbo_token.next_token.line,
+        :column  => lbo_token.next_token.column,
+        :token   => lbo_token.next_token,
+      }
+    end
+  end
+
   def check
     # Resource and class declarations
     resource_indexes.each do |resource|
-      lbo_token = resource[:tokens][-1].prev_code_token
-      if lbo_token && lbo_token.type != :COLON && \
-                      resource[:tokens][-1].type != :SEMIC && \
-                      lbo_token.type != :COMMA && \
-                      lbo_token.next_token.type == :NEWLINE
-        notify :warning, {
-          :message => 'missing trailing comma after last parameter',
-          :line    => lbo_token.next_token.line,
-          :column  => lbo_token.next_token.column,
-          :token   => lbo_token.next_token,
-        }
-      end
+      check_elem(resource)
+    end
+
+    # Arrays
+    array_indexes.each do |array|
+      check_elem(array)
+    end
+
+    # Defaults
+    defaults_indexes.each do |defaults|
+      check_elem(defaults)
     end
   end
 

data/spec/puppet-lint/plugins/check_trailing_comma/check_trailing_comma_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe 'trailing_comma' do
-  let (:msg) { 'missing trailing comma after last parameter' }
+  let (:msg) { 'missing trailing comma after last element' }
 
   context 'with fix disabled' do
     context 'trailing comma present' do
@@ -26,6 +26,19 @@ describe 'trailing_comma' do
         }
 
         resources { 'sshkey': purge => true }
+
+        user { 'elmo':
+          groups => [
+            'foo',
+            'bar',
+            ],
+          groupss => ['baz', 'qux'],
+        }
+
+        File {
+          owner => root,
+          group => '0',
+        }
         EOS
       }
 
@@ -56,16 +69,31 @@ describe 'trailing_comma' do
         }
 
         resources { 'sshkey': purge => true }
+
+        user { 'elmo':
+          groups  => [
+            'foo',
+            'bar'
+            ],
+          groupss => ['baz', 'qux'],
+        }
+
+        File {
+          owner => root,
+          group => '0'
+        }
         EOS
       }
 
-      it 'should detect a single problem' do
-        expect(problems).to have(2).problems
+      it 'should detect 4 problems' do
+        expect(problems).to have(4).problems
       end
 
-      it 'should create a warning' do
+      it 'should create warnings' do
         expect(problems).to contain_warning(msg).on_line(3).in_column(32)
         expect(problems).to contain_warning(msg).on_line(10).in_column(27)
+        expect(problems).to contain_warning(msg).on_line(24).in_column(18)
+        expect(problems).to contain_warning(msg).on_line(31).in_column(23)
       end
     end
   end
@@ -101,6 +129,19 @@ describe 'trailing_comma' do
         }
 
         resources { 'sshkey': purge => true }
+
+        user { 'elmo':
+          groups => [
+            'foo',
+            'bar',
+            ],
+          groupss => ['baz', 'qux'],
+        }
+
+        File {
+          owner => root,
+          group => '0',
+        }
         EOS
       }
 
@@ -135,16 +176,31 @@ describe 'trailing_comma' do
         }
 
         resources { 'sshkey': purge => true }
+
+        user { 'elmo':
+          groups => [
+            'foo',
+            'bar'
+            ],
+          groupss => ['baz', 'qux'],
+        }
+
+        File {
+          owner => root,
+          group => '0'
+        }
         EOS
       }
 
-      it 'should detect a single problem' do
-        expect(problems).to have(2).problems
+      it 'should detect 4 problems' do
+        expect(problems).to have(4).problems
       end
 
       it 'should create a warning' do
         expect(problems).to contain_fixed(msg).on_line(3).in_column(32)
         expect(problems).to contain_fixed(msg).on_line(10).in_column(27)
+        expect(problems).to contain_fixed(msg).on_line(24).in_column(18)
+        expect(problems).to contain_fixed(msg).on_line(31).in_column(23)
       end
 
       it 'should add trailing commas' do
@@ -169,6 +225,19 @@ describe 'trailing_comma' do
         }
 
         resources { 'sshkey': purge => true }
+
+        user { 'elmo':
+          groups => [
+            'foo',
+            'bar',
+            ],
+          groupss => ['baz', 'qux'],
+        }
+
+        File {
+          owner => root,
+          group => '0',
+        }
           EOS
         )
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-trailing_comma-check
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Camptocamp