puppet-lint-unquoted_string-check 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ea22a3b0a227e64b12ee46c8b12f9337c01f4ac
-  data.tar.gz: 69ec7bce2e2a708ec184fb28ad98ddc2db8eb9d7
+  metadata.gz: a0f287edbcd2db83abe8c1764f5982f402c91a09
+  data.tar.gz: ad677f9fee5fb6ce5d0879f20e9b63a281f569ab
 SHA512:
-  metadata.gz: 3168c4df9279fbfe9e30257cbaf8f1c8ba4749cef7382efd26ebaf41c80c4a93c8144fc69e9afb7ff915a34b6d98057c54118145afe64f00d57b31c4f02174b6
-  data.tar.gz: cb8efc59e01b978ccd5032918e9b702dc2b8004f979d86bd4b99751b4414965e29c29aceedb81b153cfddf6df503a4b7d5017c32e12cdc24a8ec060ae0f08db9
+  metadata.gz: 3b5768b1bab4cbfc8a4ca9653996ccabe8e76313a4c7224e4763026d286896125cb12b00b5ae5b0193109b983868dc14eb3b9912b51cabbb445fd80b05427b44
+  data.tar.gz: 6747989bffe6e7873e6084f2748d54c3c16a7c548a307648da9ce7aad91bc81363f68acca89dcd4b703b3f80eb7f55fd85e7d6ce060fb29a942ea875d2e0f91c

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

@@ -1,131 +1,87 @@
 require 'pp'
 
-PuppetLint.new_check(:unquoted_string_in_case) do
-
-  def check
-    case_indexes = []
-
-    tokens.each_index do |token_idx|
-      if tokens[token_idx].type == :CASE
-        depth = 0
-        tokens[(token_idx + 1)..-1].each_index do |case_token_idx|
-          idx = case_token_idx + token_idx + 1
-          if tokens[idx].type == :LBRACE
-            depth += 1
-          elsif tokens[idx].type == :RBRACE
-            depth -= 1
-            if depth == 0
-              case_indexes << {:start => token_idx, :end => idx}
-              break
-            end
+def type_indexes(type)
+  type_indexes = []
+  tokens.each_index do |token_idx|
+    if tokens[token_idx].type == type
+      depth = 0
+      tokens[(token_idx + 1)..-1].each_index do |case_token_idx|
+        idx = case_token_idx + token_idx + 1
+        if tokens[idx].type == :LBRACE
+          depth += 1
+        elsif tokens[idx].type == :RBRACE
+          depth -= 1
+          if depth == 0
+            type_indexes << {:start => token_idx, :end => idx}
+            break
           end
         end
       end
     end
+  end
+  type_indexes
+end
 
-    case_indexes.each do |kase|
-      case_tokens = tokens[kase[:start]..kase[:end]]
-
-      if case_tokens.index { |r| r.next_token.type == :COLON && (r.type == :NAME || r.type == :CLASSREF) }
-        notify :warning, {
-          :message => 'expected quoted string in case',
-          :line    => case_tokens.first.line,
-          :column  => case_tokens.first.column,
-        }
-      end
-    end
-  end 
-
-  def fix(problem)
-    case_indexes = []
-
-    tokens.each_index do |token_idx|
-      if tokens[token_idx].type == :CASE
-        depth = 0
-        tokens[(token_idx + 1)..-1].each_index do |case_token_idx|
-          idx = case_token_idx + token_idx + 1
-          if tokens[idx].type == :LBRACE
-            depth += 1
-          elsif tokens[idx].type == :RBRACE
-            depth -= 1
-            if depth == 0
-              case_indexes << {:start => token_idx, :end => idx}
-              break
-            end
-          end
+def tokens_to_fix(type_tokens, sep_type)
+  tokens_to_fix = []
+  type_tokens.index do |r|
+    if r.type == sep_type
+      s = r.prev_token
+      while s.type != :NEWLINE
+        if s.type == :NAME || s.type == :CLASSREF
+          tokens_to_fix << s
         end
+        s = s.prev_token
       end
     end
+  end
+  tokens_to_fix
+end
 
-    case_indexes.each do |kase|
-      case_tokens = tokens[kase[:start]..kase[:end]]
+def act_on_tokens(type, sep_type, &block)
+  type_indexes(type).each do |kase|
+    case_tokens = tokens[kase[:start]..kase[:end]]
 
-      case_tokens.index { |r| r.type = :SSTRING if r.type == :NAME || r.type == :CLASSREF }
+    tokens_to_fix(case_tokens, sep_type).each do |r|
+      block.call(r)
     end
   end
 end
 
-PuppetLint.new_check(:unquoted_string_in_selector) do
+PuppetLint.new_check(:unquoted_string_in_case) do
 
   def check
-    qmark_indexes = []
+    act_on_tokens(:CASE, :COLON) do |r|
+      notify :warning, {
+        :message => 'unquoted string in case',
+        :line    => r.line,
+        :column  => r.column,
+      }
+    end
+  end 
 
-    tokens.each_index do |token_idx|
-      if tokens[token_idx].type == :QMARK
-        depth = 0
-        tokens[(token_idx + 1)..-1].each_index do |case_token_idx|
-          idx = case_token_idx + token_idx + 1
-          if tokens[idx].type == :LBRACE
-            depth += 1
-          elsif tokens[idx].type == :RBRACE
-            depth -= 1
-            if depth == 0
-              qmark_indexes << {:start => token_idx, :end => idx}
-              break
-            end
-          end
-        end
-      end
+  def fix(problem)
+    act_on_tokens(:CASE, :COLON) do |r|
+      r.type = :SSTRING
     end
+  end
+end
 
-    qmark_indexes.each do |kase|
-      qmark_tokens = tokens[kase[:start]..kase[:end]]
+PuppetLint.new_check(:unquoted_string_in_selector) do
 
-      if qmark_tokens.index { |r| r.type == :NAME || r.type == :CLASSREF }
-        notify :warning, {
-          :message => 'expected quoted string in selector',
-          :line    => qmark_tokens.first.line,
-          :column  => qmark_tokens.first.column,
-        }
-      end
+  def check
+    act_on_tokens(:QMARK, :FARROW) do |r|
+      notify :warning, {
+        :message => 'unquoted string in selector',
+        :line    => r.line,
+        :column  => r.column,
+      }
     end
   end 
 
   def fix(problem)
-    qmark_indexes = []
-
-    tokens.each_index do |token_idx|
-      if tokens[token_idx].type == :QMARK
-        depth = 0
-        tokens[(token_idx + 1)..-1].each_index do |case_token_idx|
-          idx = case_token_idx + token_idx + 1
-          if tokens[idx].type == :LBRACE
-            depth += 1
-          elsif tokens[idx].type == :RBRACE
-            depth -= 1
-            if depth == 0
-              qmark_indexes << {:start => token_idx, :end => idx}
-              break
-            end
-          end
-        end
-      end
-    end
-
-    qmark_indexes.each do |kase|
-      qmark_tokens = tokens[kase[:start]..kase[:end]]
-
-      qmark_tokens.index { |r| r.type = :SSTRING if r.type == :NAME || r.type == :CLASSREF }
+    act_on_tokens(:QMARK, :FARROW) do |r|
+      r.type = :SSTRING
     end
   end
 end

data/spec/puppet-lint/plugins/check_unquoted_string_in_case/check_unquoted_string_in_case_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe 'unquoted_string_in_case' do
-  let(:msg) { 'expected quoted string in case' }
+  let(:msg) { 'unquoted string in case' }
 
   context 'with fix disabled' do
     context 'quoted case' do
@@ -11,6 +11,9 @@ describe 'unquoted_string_in_case' do
           'Solaris': {
             $rootgroup = 'wheel'
           }
+          'RedHat','Debian': {
+            $rootgroup = 'wheel'
+          }
           /(Darwin|FreeBSD)/: {
             $rootgroup = 'wheel'
           }
@@ -80,6 +83,18 @@ describe 'unquoted_string_in_case' do
           solaris: {
             $rootgroup = 'wheel'
           }
+          redhat,debian: {
+            include ::foo
+          }
+          redhat, debian: {
+            Foo { bar => 'baz' }
+          }
+          'redhat',debian: {
+            $rootgroup = wheel
+          }
+          redhat,'debian': {
+            $rootgroup = 'wheel'
+          }
           /(Darwin|FreeBSD)/: {
             $rootgroup = 'wheel'
           }
@@ -91,7 +106,17 @@ describe 'unquoted_string_in_case' do
       end
 
       it 'should create a warning' do
-        expect(problems).to contain_warning(msg).on_line(1).in_column(9)
+        expect(problems).to have(7).problems
+      end
+
+      it 'should create a warning' do
+        expect(problems).to contain_warning(msg).on_line(2).in_column(11)
+        expect(problems).to contain_warning(msg).on_line(5).in_column(11)
+        expect(problems).to contain_warning(msg).on_line(5).in_column(18)
+        expect(problems).to contain_warning(msg).on_line(8).in_column(11)
+        expect(problems).to contain_warning(msg).on_line(8).in_column(19)
+        expect(problems).to contain_warning(msg).on_line(11).in_column(20)
+        expect(problems).to contain_warning(msg).on_line(14).in_column(11)
       end
     end
 
@@ -113,7 +138,7 @@ describe 'unquoted_string_in_case' do
       end
 
       it 'should create a warning' do
-        expect(problems).to contain_warning(msg).on_line(1).in_column(9)
+        expect(problems).to contain_warning(msg).on_line(2).in_column(11)
       end
     end
   end
@@ -134,6 +159,9 @@ describe 'unquoted_string_in_case' do
           'Solaris': {
             $rootgroup = 'wheel'
           }
+          'RedHat','Debian': {
+            $rootgroup = 'wheel'
+          }
           /(Darwin|FreeBSD)/: {
             $rootgroup = 'wheel'
           }
@@ -153,6 +181,61 @@ describe 'unquoted_string_in_case' do
       end
     end
 
+    context 'quoted case containing :NAME' do
+      let(:code) do
+        <<-EOS
+        case $osfamily {
+          'Solaris': {
+            include ::foo
+          }
+          /(Darwin|FreeBSD)/: {
+            include bar
+          }
+          default: {
+            $rootgroup = 'root'
+          }
+        }
+        EOS
+      end
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+
+      it 'should not modify the manifest' do
+        expect(manifest).to eq(code)
+      end
+    end
+
+    context 'quoted case containing :CLASSREF' do
+      let(:code) do
+        <<-EOS
+        case $osfamily {
+          'Solaris': {
+            Foo {
+              bar => 'baz',
+            }
+          }
+          /(Darwin|FreeBSD)/: {
+            $rootgroup = 'wheel'
+            include bar
+          }
+          default: {
+            $rootgroup = 'root'
+          }
+        }
+        EOS
+      end
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+
+      it 'should not modify the manifest' do
+        expect(manifest).to eq(code)
+      end
+    end
+
     context ':NAME in case' do
       let(:code) do
         <<-EOS
@@ -160,6 +243,18 @@ describe 'unquoted_string_in_case' do
           solaris: {
             $rootgroup = 'wheel'
           }
+          redhat,debian: {
+            include ::foo
+          }
+          redhat, debian: {
+            Foo { bar => 'baz' }
+          }
+          'redhat',debian: {
+            $rootgroup = wheel
+          }
+          redhat,'debian': {
+            $rootgroup = 'wheel'
+          }
           /(Darwin|FreeBSD)/: {
             $rootgroup = 'wheel'
           }
@@ -171,11 +266,17 @@ describe 'unquoted_string_in_case' do
       end
 
       it 'should only detect a single problem' do
-        expect(problems).to have(1).problem
+        expect(problems).to have(7).problem
       end
 
       it 'should fix the problem' do
-        expect(problems).to contain_fixed(msg).on_line(1).in_column(9)
+        expect(problems).to contain_fixed(msg).on_line(2).in_column(11)
+        expect(problems).to contain_fixed(msg).on_line(5).in_column(11)
+        expect(problems).to contain_fixed(msg).on_line(5).in_column(18)
+        expect(problems).to contain_fixed(msg).on_line(8).in_column(11)
+        expect(problems).to contain_fixed(msg).on_line(8).in_column(19)
+        expect(problems).to contain_fixed(msg).on_line(11).in_column(20)
+        expect(problems).to contain_fixed(msg).on_line(14).in_column(11)
       end
 
       it 'should quote the case statement' do
@@ -185,6 +286,18 @@ describe 'unquoted_string_in_case' do
           'solaris': {
             $rootgroup = 'wheel'
           }
+          'redhat','debian': {
+            include ::foo
+          }
+          'redhat', 'debian': {
+            Foo { bar => 'baz' }
+          }
+          'redhat','debian': {
+            $rootgroup = wheel
+          }
+          'redhat','debian': {
+            $rootgroup = 'wheel'
+          }
           /(Darwin|FreeBSD)/: {
             $rootgroup = 'wheel'
           }
@@ -219,7 +332,7 @@ describe 'unquoted_string_in_case' do
       end
 
       it 'should fix the problem' do
-        expect(problems).to contain_fixed(msg).on_line(1).in_column(9)
+        expect(problems).to contain_fixed(msg).on_line(2).in_column(11)
       end
 
       it 'should quote the case statement' do

data/spec/puppet-lint/plugins/check_unquoted_string_in_case/check_unquoted_string_in_selector_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe 'unquoted_string_in_selector' do
-  let(:msg) { 'expected quoted string in selector' }
+  let(:msg) { 'unquoted string in selector' }
 
   context 'with fix disabled' do
     context 'quoted case' do
@@ -32,7 +32,7 @@ describe 'unquoted_string_in_selector' do
       end
 
       it 'should create a warning' do
-        expect(problems).to contain_warning(msg).on_line(1).in_column(32)
+        expect(problems).to contain_warning(msg).on_line(2).in_column(11)
       end
     end
 
@@ -48,7 +48,7 @@ describe 'unquoted_string_in_selector' do
       end
 
       it 'should create a warning' do
-        expect(problems).to contain_warning(msg).on_line(1).in_column(32)
+        expect(problems).to contain_warning(msg).on_line(2).in_column(11)
       end
     end
   end
@@ -98,7 +98,7 @@ describe 'unquoted_string_in_selector' do
       end
 
       it 'should fix the problem' do
-        expect(problems).to contain_fixed(msg).on_line(1).in_column(32)
+        expect(problems).to contain_fixed(msg).on_line(2).in_column(11)
       end
 
       it 'should quote the case statement' do
@@ -130,7 +130,7 @@ describe 'unquoted_string_in_selector' do
       end
 
       it 'should fix the problem' do
-        expect(problems).to contain_fixed(msg).on_line(1).in_column(32)
+        expect(problems).to contain_fixed(msg).on_line(2).in_column(11)
       end
 
       it 'should quote the case statement' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-unquoted_string-check
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Mickaël Canévet