puppet-lint-trailing_comma-check 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '018a77724925ca0bef3850617c749c009d3b83ae767eda4e87baf88de6f4cd80'
-  data.tar.gz: ddc25465f0676f38b5d3c16640f811431bbf2864fbb2d2cb8c5027b906fcf17c
+  metadata.gz: 0e7a6a8ff103202893357daa1664954b496e65143f3aa7503f6079c92c9315c0
+  data.tar.gz: 1e61f4bb4b7d5c51624cdbd4085bd78d1d50d7afd84df5f37e0ff5657618411c
 SHA512:
-  metadata.gz: 4fb19ce04aba821d695bf8590d31ae62f94511ec6caf2abe8c9f3937cc15974f40e90f3ab30f27cb8208eff7ea3ba3e149b8e15be7b6c635b2a03f03c385c510
-  data.tar.gz: 0a2d39ccf3301764ed941a043ca4656cb083e3675a3b21f33d64f6621764f3c6441c86a87a30f4226606b1c3ba3fa6b9d3e0fd1c3d808e81189cf234d9b0bc88
+  metadata.gz: b4f0c05f6c2d99f8c586940ea50eb54004fbbaf58ea5094ac6567c5ba0cabe4d26130c479ca7018abcb65ffdf62f484b37bc27617ea7a9e65665bc8537ab3d5e
+  data.tar.gz: d32d65600370ab35154ba97e3d94b20b5125e5cac6cd17add0bc71255a017a85b449bdc5f881686f6b3981acdf7ab7cdc89cea4edc18086c708df41db36b19ed

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file.
 
+## [2.0.0](https://github.com/voxpupuli/puppet-lint-trailing_comma-check/tree/2.0.0) (2023-04-21)
+
+[Full Changelog](https://github.com/voxpupuli/puppet-lint-trailing_comma-check/compare/1.0.0...2.0.0)
+
+**Breaking changes:**
+
+- Drop Ruby \< 2.7; Add RuboCop [\#33](https://github.com/voxpupuli/puppet-lint-trailing_comma-check/pull/33) ([bastelfreak](https://github.com/bastelfreak))
+
 ## [1.0.0](https://github.com/voxpupuli/puppet-lint-trailing_comma-check/tree/1.0.0) (2022-11-29)
 
 [Full Changelog](https://github.com/voxpupuli/puppet-lint-trailing_comma-check/compare/0.4.3...1.0.0)

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

@@ -1,86 +1,87 @@
 PuppetLint.new_check(:trailing_comma) do
   def array_indexes
-    @array_indexes ||= Proc.new do
+    @array_indexes ||= proc do
       arrays = []
       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
-
-          # Ignore resource references
-          next if token.prev_code_token && \
-            token.prev_code_token.type == :CLASSREF
-
-          # Ignore data types
-          next if token.prev_code_token && \
-            token.prev_code_token.type == :TYPE
-
-          arrays << {
-            :start  => token_idx,
-            :end    => real_idx,
-            :tokens => tokens[token_idx..real_idx],
-          }
+        next unless 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
+
+        # Ignore resource references
+        next if token.prev_code_token &&
+                token.prev_code_token.type == :CLASSREF
+
+        # Ignore data types
+        next if token.prev_code_token &&
+                token.prev_code_token.type == :TYPE
+
+        arrays << {
+          start: token_idx,
+          end: real_idx,
+          tokens: tokens[token_idx..real_idx],
+        }
       end
       arrays
     end.call
   end
 
   def hash_indexes
-    @hash_indexes ||= Proc.new do
+    @hash_indexes ||= proc do
       hashes = []
       tokens.each_with_index do |token, token_idx|
         next unless token.prev_code_token
-        next unless [:EQUALS, :ISEQUAL, :FARROW, :LPAREN].include? token.prev_code_token.type
-        if token.type == :LBRACE
-          level = 0
-          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
-
-            level += 1 if cur_token.type == :LBRACE
-            level -= 1 if cur_token.type == :RBRACE
-            break if level < 0
-          end
-
-          hashes << {
-            :start  => token_idx,
-            :end    => real_idx,
-            :tokens => tokens[token_idx..real_idx],
-          }
+        next unless %i[EQUALS ISEQUAL FARROW LPAREN].include? token.prev_code_token.type
+
+        next unless token.type == :LBRACE
+
+        level = 0
+        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
+
+          level += 1 if cur_token.type == :LBRACE
+          level -= 1 if cur_token.type == :RBRACE
+          break if level < 0
         end
+
+        hashes << {
+          start: token_idx,
+          end: real_idx,
+          tokens: tokens[token_idx..real_idx],
+        }
       end
       hashes
     end.call
   end
 
   def defaults_indexes
-    @defaults_indexes ||= Proc.new do
+    @defaults_indexes ||= proc do
       defaults = []
       tokens.each_with_index do |token, token_idx|
-        if token.type == :CLASSREF && token.next_code_token && \
-          token.next_code_token.type == :LBRACE && \
-          token.prev_code_token && \
-          # Ensure that we aren't matching a function return type:
-          token.prev_code_token.type != :RSHIFT && \
-          # Or a conditional matching a type:
-          ! [:MATCH, :NOMATCH].include?(token.prev_code_token.type)
-          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
-
-          defaults << {
-            :start  => token_idx,
-            :end    => real_idx,
-            :tokens => tokens[token_idx..real_idx],
-          }
+        next unless token.type == :CLASSREF && token.next_code_token &&
+                    token.next_code_token.type == :LBRACE &&
+                    token.prev_code_token &&
+                    # Ensure that we aren't matching a function return type:
+                    token.prev_code_token.type != :RSHIFT &&
+                    # Or a conditional matching a type:
+                    !%i[MATCH NOMATCH].include?(token.prev_code_token.type)
+
+        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
+
+        defaults << {
+          start: token_idx,
+          end: real_idx,
+          tokens: tokens[token_idx..real_idx],
+        }
       end
       defaults
     end.call
@@ -92,21 +93,19 @@ PuppetLint.new_check(:trailing_comma) do
     # If we get a token indicating the end of a HEREDOC, backtrack
     # until we find HEREDOC_OPEN. That is the line which should
     # be examined for the comma.
-    if lbo_token && [:HEREDOC, :HEREDOC_POST].include?(lbo_token.type)
-      while lbo_token && lbo_token.type != :HEREDOC_OPEN do
-        lbo_token = lbo_token.prev_code_token
-      end
+    if lbo_token && %i[HEREDOC HEREDOC_POST].include?(lbo_token.type)
+      lbo_token = lbo_token.prev_code_token while lbo_token && lbo_token.type != :HEREDOC_OPEN
     end
 
-    if lbo_token && lbo_token.type != except_type && \
-                    elem[:tokens][-1].type != :SEMIC && \
-                    lbo_token.type != :COMMA && \
-                    lbo_token.next_token.type == :NEWLINE
+    if lbo_token && lbo_token.type != except_type &&
+       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,
+        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
@@ -138,7 +137,7 @@ PuppetLint.new_check(:trailing_comma) do
       :COMMA,
       ',',
       problem[:token].line,
-      problem[:token].column
+      problem[:token].column,
     )
 
     idx = tokens.index(problem[:token])

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

@@ -1,11 +1,11 @@
 require 'spec_helper'
 
 describe 'trailing_comma' do
-  let (:msg) { 'missing trailing comma after last element' }
+  let(:msg) { 'missing trailing comma after last element' }
 
   context 'with fix disabled' do
     context 'trailing comma present' do
-      let (:code) {
+      let(:code) do
         <<-EOS
         class { '::apache':
           timeout => '100',
@@ -82,15 +82,15 @@ describe 'trailing_comma' do
           'c',
         ],
         EOS
-      }
+      end
 
-      it 'should not detect any problems' do
+      it 'does not detect any problems' do
         expect(problems).to have(0).problems
       end
     end
 
     context 'trailing comma absent' do
-      let (:code) {
+      let(:code) do
         <<-EOS
         class { '::apache':
           timeout => '100',
@@ -152,13 +152,13 @@ describe 'trailing_comma' do
           'c'
         ]
         EOS
-      }
+      end
 
-      it 'should detect 7 problems' do
+      it 'detects 7 problems' do
         expect(problems).to have(7).problems
       end
 
-      it 'should create warnings' do
+      it 'creates warnings' do
         expect(problems).to contain_warning(msg).on_line(8).in_column(24)
         expect(problems).to contain_warning(msg).on_line(15).in_column(27)
         expect(problems).to contain_warning(msg).on_line(29).in_column(18)
@@ -171,7 +171,7 @@ describe 'trailing_comma' do
 
     context 'with heredoc' do
       context 'with trailing comma' do
-        let(:code) {
+        let(:code) do
           <<-EOS
           file { '/tmp/test.txt':
             ensure  => 'file',
@@ -190,15 +190,15 @@ describe 'trailing_comma' do
               | FRAGMENT
           }
           EOS
-        }
+        end
 
-        it 'should not detect any problems' do
+        it 'does not detect any problems' do
           expect(problems).to have(0).problems
         end
       end
 
       context 'without trailing comma' do
-        let(:code) {
+        let(:code) do
           <<-EOS
           file { '/tmp/test.txt':
             ensure  => 'file',
@@ -217,13 +217,13 @@ describe 'trailing_comma' do
               | FRAGMENT
           }
           EOS
-        }
+        end
 
-        it 'should detect a problem' do
+        it 'detects a problem' do
           expect(problems).to have(2).problems
         end
 
-        it 'should create a warning' do
+        it 'creates a warning' do
           expect(problems).to contain_warning(msg).on_line(3).in_column(30)
           expect(problems).to contain_warning(msg).on_line(11).in_column(37)
         end
@@ -241,7 +241,7 @@ describe 'trailing_comma' do
     end
 
     context 'trailing comma present' do
-      let (:code) {
+      let(:code) do
         <<-EOS
         class { '::apache':
           timeout => '100',
@@ -303,19 +303,19 @@ describe 'trailing_comma' do
           'c',
         ],
         EOS
-      }
+      end
 
-      it 'should not detect any problems' do
+      it 'does not detect any problems' do
         expect(problems).to have(0).problems
       end
 
-      it 'should not modify the manifest' do
+      it 'does not modify the manifest' do
         expect(manifest).to eq(code)
       end
     end
 
     context 'trailing comma absent' do
-      let (:code) {
+      let(:code) do
         <<-EOS
         class { '::apache':
           timeout => '100',
@@ -377,13 +377,13 @@ describe 'trailing_comma' do
           'c'
         ]
         EOS
-      }
+      end
 
-      it 'should detect 7 problems' do
+      it 'detects 7 problems' do
         expect(problems).to have(7).problems
       end
 
-      it 'should create a warning' do
+      it 'creates a warning' do
         expect(problems).to contain_fixed(msg).on_line(8).in_column(24)
         expect(problems).to contain_fixed(msg).on_line(15).in_column(27)
         expect(problems).to contain_fixed(msg).on_line(29).in_column(18)
@@ -393,9 +393,9 @@ describe 'trailing_comma' do
         expect(problems).to contain_fixed(msg).on_line(58).in_column(14)
       end
 
-      it 'should add trailing commas' do
+      it 'adds trailing commas' do
         expect(manifest).to eq(
-          <<-EOS
+          <<-EOS,
         class { '::apache':
           timeout => '100',
           docroot => '/var/www',
@@ -462,7 +462,7 @@ describe 'trailing_comma' do
 
     context 'with heredoc' do
       context 'with trailing comma' do
-        let(:code) {
+        let(:code) do
           <<-EOS
           file { '/tmp/test.txt':
             ensure  => 'file',
@@ -481,19 +481,19 @@ describe 'trailing_comma' do
               | FRAGMENT
           }
           EOS
-        }
+        end
 
-        it 'should not detect any problems' do
+        it 'does not detect any problems' do
           expect(problems).to have(0).problems
         end
 
-        it 'should not modify the manifest' do
+        it 'does not modify the manifest' do
           expect(manifest).to eq(code)
         end
       end
 
       context 'without trailing comma' do
-        let(:code) {
+        let(:code) do
           <<-EOS
           file { '/tmp/test.txt':
             ensure  => 'file',
@@ -512,20 +512,20 @@ describe 'trailing_comma' do
               | FRAGMENT
           }
           EOS
-        }
+        end
 
-        it 'should detect a problem' do
+        it 'detects a problem' do
           expect(problems).to have(2).problems
         end
 
-        it 'should create a warning' do
+        it 'creates a warning' do
           expect(problems).to contain_fixed(msg).on_line(3).in_column(30)
           expect(problems).to contain_fixed(msg).on_line(11).in_column(37)
         end
 
-        it 'should add trailing commas' do
+        it 'adds trailing commas' do
           expect(manifest).to eq(
-            <<-EOS
+            <<-EOS,
           file { '/tmp/test.txt':
             ensure  => 'file',
             content => @(EOT),

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-trailing_comma-check
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.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,90 +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: 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'
-- !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'
+        version: '5'
 description: "    A puppet-lint plugin to check for missing trailing commas.\n"
 email: voxpupuli@groups.io
 executables: []
@@ -124,7 +54,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -135,6 +65,4 @@ rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: A puppet-lint plugin to check for missing trailing commas.
-test_files:
-- spec/puppet-lint/plugins/check_trailing_comma/check_trailing_comma_spec.rb
-- spec/spec_helper.rb
+test_files: []