puppet-lint-unquoted_string-check 0.2.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d0da62169a6718196034aff4f7ab841c9220fb93
-  data.tar.gz: 3c32f8a9a476915f75eba6df3b042d20cbc68891
+SHA256:
+  metadata.gz: 5056a8e636e2dd9390aa92ac9c848135ad6a978032a18109eba4bf2719acafcb
+  data.tar.gz: f4ce77685a8b3d9048ad2fc40e9cf7e4fd3b6e6352dca6a72b1167592d361565
 SHA512:
-  metadata.gz: 53561bea1d4e76646a010c4d2a1318f87b243658aa029b4bbd86e4dfca4477862560f3f6c6d980167516913d6c35d00c4b355332e2931380bec0dec49a8eb2f6
-  data.tar.gz: ccd89bbf93c121df5ac76816a8f45192ac38c6bfaa5b0dd69840fcea34c4dc76353b344c43098acb518d9b1b3eb6db919d5fba100976424fa594675ca41fbc7d
+  metadata.gz: 3bf2d5f7e2ac07bba5af7e803d07b898a8447710e07b2d531e99601e9408c855aec59f71717642394f05010549149f9b3793823701236934fcbe351e1c279173
+  data.tar.gz: 72ac10a4a2b8af40eafe634b0fac963140e57558c4e2423b9855134da4a1298b53b007635178647c739672e17770b1fa123df926396d704db50ac1909d27d474

data/README.md

@@ -1,4 +1,124 @@
 puppet-lint-unquoted_string-check
 =================================
 
+[![License](https://img.shields.io/github/license/voxpupuli/puppet-lint-unquoted_string-check.svg)](https://github.com/voxpupuli/puppet-lint-unquoted_string-check/blob/master/LICENSE)
+[![Test](https://github.com/voxpupuli/puppet-lint-param-docs/actions/workflows/test.yml/badge.svg)](https://github.com/voxpupuli/puppet-lint-param-docs/actions/workflows/test.yml)
+[![Gem Version](https://img.shields.io/gem/v/puppet-lint-unquoted_string-check.svg)](https://rubygems.org/gems/puppet-lint-unquoted_string-check)
+[![RubyGem Downloads](https://img.shields.io/gem/dt/puppet-lint-unquoted_string-check.svg)](https://rubygems.org/gems/puppet-lint-unquoted_string-check)
+[![Donated by Camptocamp](https://img.shields.io/badge/donated%20by-camptocamp-fb7047.svg)](#transfer-notice)
+
 A puppet-lint plugin to check that selectors and case statements cases are quoted.
+
+## Installing
+
+### From the command line
+
+```shell
+$ gem install puppet-lint-unquoted_string-check
+```
+
+### In a Gemfile
+
+```ruby
+gem 'puppet-lint-unquoted_string-check', :require => false
+```
+
+## Checks
+
+### Unquoted string in case
+
+Unquoted strings in case statements are not valid with the future parser.
+
+#### What you have done
+
+```puppet
+case $::osfamily {
+  Debian: { }
+  RedHat: { }
+  default: { }
+}
+```
+
+#### What you should have done
+
+```puppet
+case $::osfamily {
+  'Debian': { }
+  'RedHat': { }
+  default: { }
+}
+```
+
+#### Disabling the check
+
+To disable this check, you can add `--no-unquoted_string_in_case-check` to your puppet-lint command line.
+
+```shell
+$ puppet-lint --no-unquoted_string_in_case-check path/to/file.pp
+```
+
+Alternatively, if you’re calling puppet-lint via the Rake task, you should insert the following line to your `Rakefile`.
+
+```ruby
+PuppetLint.configuration.send('disable_unquoted_string_in_case')
+```
+
+
+### Unquoted string in selector
+
+Unquoted strings in selector statements are not valid with the future parser.
+
+#### What you have done
+
+```puppet
+$foo = $::osfamily ? {
+  Debian => 'bar',
+  RedHat => 'baz',
+  default => 'qux',
+}
+```
+
+#### What you should have done
+
+```puppet
+$foo = $::osfamily ? {
+  'Debian' => 'bar',
+  'RedHat' => 'baz',
+  default  => 'qux',
+}
+```
+
+#### Disabling the check
+
+To disable this check, you can add `--no-unquoted_string_in_selector-check` to your puppet-lint command line.
+
+```shell
+$ puppet-lint --no-unquoted_string_in_selector-check path/to/file.pp
+```
+
+Alternatively, if you’re calling puppet-lint via the Rake task, you should insert the following line to your `Rakefile`.
+
+```ruby
+PuppetLint.configuration.send('disable_unquoted_string_in_selector')
+```
+
+## Transfer Notice
+
+This plugin was originally authored by [Camptocamp](http://www.camptocamp.com).
+The maintainer preferred that Puppet Community take ownership of the module for future improvement and maintenance.
+Existing pull requests and issues were transferred over, please fork and continue to contribute here instead of Camptocamp.
+
+Previously: https://github.com/camptocamp/puppet-lint-unquoted_string-check
+
+## License
+
+This gem is licensed under the Apache-2 license.
+
+## Release information
+
+To make a new release, please do:
+* Update the version in the `puppet-lint-absolute_classname-check.gemspec` file
+* Install gems with `bundle install --with release --path .vendor`
+* generate the changelog with `bundle exec rake changelog`
+* Create a PR with it
+* After it got merged, push a tag. Travis will do the actual release

data/lib/puppet-lint-unquoted-string-check/version.rb

@@ -0,0 +1,4 @@
+class PuppetLintUnquotedStringCheck
+  VERSION = '2.1.0'.freeze
+end
+

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

@@ -5,14 +5,21 @@ def type_indexes(type)
   tokens.each_index do |token_idx|
     if tokens[token_idx].type == type
       depth = 0
+      start = token_idx
       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
+          if depth == 2
+            type_indexes << {:start => start, :end => idx}
+          end
         elsif tokens[idx].type == :RBRACE
+          if depth == 2
+            start = idx
+          end
           depth -= 1
           if depth == 0
-            type_indexes << {:start => token_idx, :end => idx}
+            type_indexes << {:start => start, :end => idx}
             break
           end
         end
@@ -28,8 +35,8 @@ def notify_tokens(type, sep_type, message)
     type_tokens.index do |r|
       if r.type == sep_type
         s = r.prev_token
-        while s.type != :NEWLINE and s.type != :LBRACE
-          if s.type == :NAME || s.type == :CLASSREF
+        while (s.type != :NEWLINE) && (s.type != :LBRACE)
+          if s.type == :NAME || (s.type == :CLASSREF && !s.value.include?('::'))
             notify :warning, {
               :message => message,
               :line    => s.line,
@@ -47,7 +54,7 @@ end
 PuppetLint.new_check(:unquoted_string_in_case) do
   def check
     notify_tokens(:CASE, :COLON, 'unquoted string in case')
-  end 
+  end
 
   def fix(problem)
     problem[:token].type = :SSTRING
@@ -57,7 +64,7 @@ end
 PuppetLint.new_check(:unquoted_string_in_selector) do
   def check
     notify_tokens(:QMARK, :FARROW, 'unquoted string in selector')
-  end 
+  end
 
   def fix(problem)
     problem[:token].type = :SSTRING

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

@@ -141,6 +141,23 @@ describe 'unquoted_string_in_case' do
         expect(problems).to contain_warning(msg).on_line(2).in_column(11)
       end
     end
+
+    context 'Puppet Types in case' do
+      let(:code) do
+        <<-EOS
+        case $value {
+          Integer: { notice('yes int')}
+          Array: { notice('yes array')}
+          'Debian': { notice('this is Sparta')}
+          default: { notice('something else')}
+        }
+        EOS
+      end
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
   end
 
   context 'with fix enabled' do
@@ -353,5 +370,26 @@ describe 'unquoted_string_in_case' do
         )
       end
     end
+
+    context 'Puppet Types in case' do
+      let(:code) do
+        <<-EOS
+        case $value {
+          Integer: { notice('yes int')}
+          Array: { notice('yes array')}
+          'Debian': { notice('this is Sparta')}
+          default: { notice('something else')}
+        }
+        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
   end
 end

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

@@ -51,6 +51,22 @@ describe 'unquoted_string_in_selector' do
         expect(problems).to contain_warning(msg).on_line(2).in_column(11)
       end
     end
+
+    context ':TYPE in case' do
+      let(:code) do
+        <<-PUPPET
+          $listen_socket = $service_bind ? {
+            Undef                   => undef,
+            Stdlib::IP::Address::V6 => "[${service_bind}]:${service_port}",
+            default                 => "${service_bind}:${service_port}",
+          }
+        PUPPET
+      end
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
   end
 
   context 'with fix enabled' do
@@ -145,5 +161,28 @@ describe 'unquoted_string_in_selector' do
         )
       end
     end
+
+    context 'hashes in case' do
+      let(:code) do
+        <<-EOS
+        $postfix_configuration = $configuration ? {
+          'relay'     => {
+            relayhost => '[example.com]:587',
+            satellite => true,
+          },
+          'smarthost' => {
+            smtp_listen       => 'all',
+            master_submission => 'submission inet n - - - - smtpd -o smtpd_tls_security_level=encrypt',
+            mta               => true,
+            relayhost         => 'direct',
+          },
+        }
+        EOS
+      end
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
 require 'puppet-lint'
 
 PuppetLint::Plugins.load_spec_helper

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-unquoted_string-check
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 2.1.0
 platform: ruby
 authors:
-- Camptocamp
+- Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-08 00:00:00.000000000 Z
+date: 2021-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +72,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
+  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: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +114,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |2
-      A puppet-lint plugin to check that selectors and case statements cases are quoted.
-email: mickael.canevet@camptocamp.com
+description: "    A puppet-lint plugin to check that selectors and case statements
+  cases are quoted.\n"
+email: voxpupuli@groups.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- lib/puppet-lint-unquoted-string-check/version.rb
 - lib/puppet-lint/plugins/check_unquoted_string_in_case.rb
 - spec/puppet-lint/plugins/check_unquoted_string_in_case/check_unquoted_string_in_case_spec.rb
 - spec/puppet-lint/plugins/check_unquoted_string_in_case/check_unquoted_string_in_selector_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/camptocamp/puppet-lint-unquoted_string-check
+homepage: https://github.com/puppet-community/puppet-lint-unquoted_string-check
 licenses:
 - Apache-2.0
 metadata: {}
@@ -105,20 +140,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A puppet-lint plugin to check that selectors and case statements cases are
   quoted.
 test_files:
 - spec/spec_helper.rb
-- spec/puppet-lint/plugins/check_unquoted_string_in_case/check_unquoted_string_in_selector_spec.rb
 - spec/puppet-lint/plugins/check_unquoted_string_in_case/check_unquoted_string_in_case_spec.rb
+- spec/puppet-lint/plugins/check_unquoted_string_in_case/check_unquoted_string_in_selector_spec.rb