puppet-lint-manifest_whitespace-check 0.2.9 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fc583d9842a6466e61e1f6f2f9403f8fc5cb8e0958fafa9f5bd5f5fc80696ca
-  data.tar.gz: d4ab05139da0cc924d211d1f1b48fe78126bf44d554f8fa43ec01c13d1025daf
+  metadata.gz: 215ee20a337d9fd2655e3ffaff1416e3e3cdf4051310c355d7d87922640d1e41
+  data.tar.gz: 8f57c74447f4e3ec1e6d8e730b17b960e668eba3dc1242f826b81a90eb6a3381
 SHA512:
-  metadata.gz: ed6e8917d9cb0cb98fc3f4d1be0ff82c15f7328b8dbd0fda51a156eb6ca9546dbb5af389321da9a3b16308fdc3870280c5dd48457344b90d09fb3ce177938e17
-  data.tar.gz: f9fe4bf529999d65acf13efaa4cea04410714cf6f122e2986b82c3eca6c9ad28dc8369b2cf937547e3e464a6bccf5544e90500b0e1528e16aad57ec6a111e929
+  metadata.gz: 230cd0afb84fe91efeeb98cc150de18a4083158b5b8d038a1f6773c842b053fe9dc95f6ac3a106f505112a23f9be91b1669755bc5744f186841588d426655a5e
+  data.tar.gz: 354d4c00d7b2884fe70dca02a56115e7ec2c4cd7dab6c4f4969520855a4a9e008c727fa322e7fb2559a5bb1a30cf69f28acda6f48a659de0087f2473af41dffa

data/README.md

@@ -1,5 +1,12 @@
 # puppet-lint manifest whitespace check
 
+[![License](https://img.shields.io/github/license/voxpupuli/puppet-lint-manifest_whitespace-check.svg)](https://github.com/voxpupuli/puppet-lint-manifest_whitespace-check/blob/master/LICENSE)
+[![Test](https://github.com/voxpupuli/puppet-lint-manifest_whitespace-check/actions/workflows/test.yml/badge.svg)](https://github.com/voxpupuli/puppet-lint-manifest_whitespace-check/actions/workflows/test.yml)
+[![Release](https://github.com/voxpupuli/puppet-lint-manifest_whitespace-check/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/puppet-lint-manifest_whitespace-check/actions/workflows/release.yml)
+[![RubyGem Version](https://img.shields.io/gem/v/puppet-lint-manifest_whitespace-check.svg)](https://rubygems.org/gems/puppet-lint-manifest_whitespace-check)
+[![RubyGem Downloads](https://img.shields.io/gem/dt/puppet-lint-manifest_whitespace-check.svg)](https://rubygems.org/gems/puppet-lint-manifest_whitespace-check)
+[![Donated by Jo Vandeginste](https://img.shields.io/badge/donated%20by-Jo%20Vandeginste-fb7047.svg)](#copyright)
+
 Adds a new puppet-lint check to verify a number of whitespace issues (newlines etc.)
 
 These checks are very opinionated.
@@ -173,3 +180,22 @@ class myclass
   # the body
 }
 ```
+
+## License
+
+This project is licensed unter MIT
+
+## Transfer Notice
+
+This plugin was originally maintained by [Jo Vandeginste](https://github.com/jovandeginste).
+The maintainer preferred that [Vox Pupuli](https://voxpupuli.org/) take ownership of the module for future improvement and maintenance.
+
+## Release information
+
+To make a new release, please do:
+* update the version in the gemspec file
+* Install gems with `bundle install --with release --path .vendor`
+* generate the changelog with `bundle exec rake changelog`
+* Check if the new version matches the closed issues/PRs in the changelog
+* Create a PR with it
+* After it got merged, push a tag. GitHub actions will do the actual release to rubygems and GitHub Packages

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

@@ -9,7 +9,9 @@ PuppetLint.new_check(:manifest_whitespace_closing_brace_before) do
       next unless prev_token && prev_code_token
       next if %i[LBRACE].include?(prev_token.type)
 
-      next if !%i[LBRACE].include?(prev_code_token.type) && (is_single_space(prev_token) && tokens.index(prev_code_token) == tokens.index(brace_token) - 2)
+      if !%i[LBRACE].include?(prev_code_token.type) && (is_single_space(prev_token) && tokens.index(prev_code_token) == tokens.index(brace_token) - 2)
+        next
+      end
 
       next if prev_token.type == :INDENT && (tokens.index(prev_code_token) == tokens.index(brace_token) - 3)
 
@@ -39,7 +41,8 @@ PuppetLint.new_check(:manifest_whitespace_closing_brace_before) do
       next_token = next_token.next_token
     end
 
-    add_token(tokens.index(next_token), new_single_space) if next_token.type == :RBRACE && !%i[LBRACE NEWLINE INDENT].include?(next_token.prev_token.type)
+    add_token(tokens.index(next_token), new_single_space) if next_token.type == :RBRACE && !%i[LBRACE NEWLINE
+                                                                                               INDENT].include?(next_token.prev_token.type)
   end
 end
 

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

@@ -4,15 +4,15 @@ PuppetLint.new_check(:manifest_whitespace_missing_newline_end_of_file) do
   def check
     last_token = tokens.last
 
-    if last_token && last_token.type != :NEWLINE
-      notify(
-        :error,
-        message: 'there should be a single newline at the end of a manifest',
-        line: last_token.line,
-        column: last_token.column,
-        token: last_token,
-      )
-    end
+    return unless last_token && last_token.type != :NEWLINE
+
+    notify(
+      :error,
+      message: 'there should be a single newline at the end of a manifest',
+      line: last_token.line,
+      column: last_token.column,
+      token: last_token,
+    )
   end
 
   def fix(problem)
@@ -25,18 +25,18 @@ PuppetLint.new_check(:manifest_whitespace_double_newline_end_of_file) do
   def check
     last_token = tokens.last
 
-    if last_token && last_token.type == :NEWLINE
-      while last_token.prev_token && last_token.prev_token.type == :NEWLINE
-        notify(
-          :error,
-          message: 'there should be a single newline at the end of a manifest',
-          line: last_token.line,
-          column: last_token.column,
-          token: last_token,
-        )
-
-        last_token = last_token.prev_token
-      end
+    return unless last_token && last_token.type == :NEWLINE
+
+    while last_token.prev_token && last_token.prev_token.type == :NEWLINE
+      notify(
+        :error,
+        message: 'there should be a single newline at the end of a manifest',
+        line: last_token.line,
+        column: last_token.column,
+        token: last_token,
+      )
+
+      last_token = last_token.prev_token
     end
   end
 

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

@@ -11,9 +11,12 @@ PuppetLint.new_check(:manifest_whitespace_opening_brace_before) do
       next if %i[COMMA].include?(prev_code_token.type) && %i[INDENT NEWLINE].include?(prev_token.type)
       next if %i[COMMENT COLON].include?(prev_code_token.type)
 
-      if %i[LPAREN LBRACK LBRACE].include?(prev_code_token.type)
+      if %i[LPAREN LBRACK].include?(prev_code_token.type)
         next if tokens.index(prev_code_token) == tokens.index(brace_token) - 1
         next if tokens[tokens.index(prev_code_token)..tokens.index(brace_token)].collect(&:type).include?(:NEWLINE)
+      elsif %i[LBRACE].include?(prev_code_token.type)
+        next if tokens[tokens.index(prev_code_token)..tokens.index(brace_token)].collect(&:type).include?(:NEWLINE)
+        next if tokens.index(prev_code_token) == tokens.index(brace_token) - 2 && is_single_space(prev_token)
       else
         next unless tokens.index(prev_code_token) != tokens.index(brace_token) - 2 ||
                     !is_single_space(prev_token)
@@ -41,7 +44,7 @@ PuppetLint.new_check(:manifest_whitespace_opening_brace_before) do
       prev_token = prev_token.prev_token
     end
 
-    add_token(tokens.index(token), new_single_space) unless %i[LPAREN LBRACK LBRACE].include?(prev_code_token.type)
+    add_token(tokens.index(token), new_single_space) unless %i[LPAREN LBRACK].include?(prev_code_token.type)
   end
 end
 

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

@@ -47,5 +47,20 @@ describe 'manifest_whitespace_missing_newline_end_of_file' do
         expect(manifest).to eq("class example { }\n")
       end
     end
+
+    context 'inside heredoc' do
+      let(:code) do
+        <<~CODE
+          $value = @("END_OF_HD")
+            SomeData
+          | - END_OF_HD
+          $other_value = 5
+        CODE
+      end
+
+      it 'detects no problems' do
+        expect(problems).to be_empty
+      end
+    end
   end
 end

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

@@ -31,14 +31,100 @@ describe 'manifest_whitespace_opening_brace_before' do
     end
   end
 
+  context 'with an iterator' do
+    let(:code) do
+      <<~CODE
+        $slave_ifnames = $bonds.reduce({}) |$l, $i| {
+          $l + split($i['attached_devices'], /,/).reduce({}) |$sl, $d| { $sl + { $d => $i['identifier'] } }
+        }
+      CODE
+    end
+
+    it 'detects no problems' do
+      expect(problems).to be_empty
+    end
+  end
+
+  context 'with a Hash-returning block' do
+    let(:code) do
+      <<~CODE
+        $result = $value.lest || { {} }
+      CODE
+    end
+
+    it 'detects no problems' do
+      expect(problems).to be_empty
+    end
+  end
+
+  context 'with a Hash-nested Hash' do
+    let(:code) do
+      <<~CODE
+        $result = { foo => {} }
+      CODE
+    end
+
+    it 'detects no problems' do
+      expect(problems).to be_empty
+    end
+  end
+
+  context 'with a Hash-nested Hash with a Hash key' do
+    let(:code) do
+      <<~CODE
+        $result = { { 'a' => 1 } => {} }
+      CODE
+    end
+
+    it 'detects no problems' do
+      expect(problems).to be_empty
+    end
+  end
+
+  context 'with a Hash-nested Hash with an empty Hash key' do
+    let(:code) do
+      <<~CODE
+        $result = { {} => {} }
+      CODE
+    end
+
+    it 'detects no problems' do
+      expect(problems).to be_empty
+    end
+  end
+
+  context 'with a Hash-returning block and no space' do
+    let(:code) do
+      <<~CODE
+        $result = $value.lest || {{} }
+      CODE
+    end
+
+    it 'detects one problems' do
+      expect(problems).to have(1).problem
+    end
+
+    context 'with fix enabled' do
+      before do
+        PuppetLint.configuration.fix = true
+      end
+
+      after do
+        PuppetLint.configuration.fix = false
+      end
+
+      it { expect(manifest).to eq("$result = $value.lest || { {} }\n") }
+    end
+  end
+
   context 'inside, inline with function' do
     let(:code) do
       <<~CODE
         $sssd_config = {
-        ▏ 'sssd' => merge($config, {
-        ▏ ▏ ▏ 'domains'  => $domains,
-        ▏ ▏ ▏ 'services' => 'nss,pam',
-        ▏ }),
+          'sssd' => merge($config, {
+             'domains'  => $domains,
+             'services' => 'nss,pam',
+          }),
         }
       CODE
     end

data/spec/spec_helper.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require 'coveralls'
-Coveralls.wear!
+require 'rspec/collection_matchers'
 
 require 'puppet-lint'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-manifest_whitespace-check
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 1.0.1
 platform: ruby
 authors:
 - Jo Vandeginste
-autorequire: 
+- Vox Pupuli
 bindir: bin
 cert_chain: []
-date: 2023-01-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -16,107 +16,23 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '4'
     - - "<"
       - !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'
-    - - "<"
       - !ruby/object:Gem::Version
         version: '4'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  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: mime-types
-  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'
-- !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'
+        version: '5'
 description: A new check for puppet-lint that validates generic whitespace issues
   in manifests.
-email: jo.vandeginste@kuleuven.be
+email: voxpupuli@groups.io
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -146,12 +62,10 @@ files:
 - spec/puppet-lint/plugins/manifest_whitespace_opening_brace_spec.rb
 - spec/puppet-lint/plugins/manifest_whitespace_opening_bracket_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/kuleuven/puppet-lint-manifest_whitespace-check
+homepage: https://github.com/voxpupuli/puppet-lint-manifest_whitespace-check
 licenses:
 - MIT
-metadata:
-  rubygems_mfa_required: 'true'
-post_install_message: 
+metadata: {}
 rdoc_options: []
 require_paths:
 - lib
@@ -159,15 +73,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A puppet-lint check to validate whitespace in manifests
 test_files: []