puppet-lint-absolute_classname-check 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f8457df6a20dcdc3263f3a9d07c24a46affe2ead023a08da5ae0ed52dc22763
-  data.tar.gz: 34e1a29a81bffae3cdcb73d47837576778d3ca36146d196822e7b59795b06254
+  metadata.gz: d80c6cabf675148fec4eba47d1fe97898c981c5e80694d910357203a19e6ca14
+  data.tar.gz: 64ece9ae2635f02514bd25e6f9d5ed2f80c4f2880d7c0de9bbb6885c0b562b7f
 SHA512:
-  metadata.gz: 8f84c2b01a0d6d5eaa56279b24459889f3e00be262dfb931c9e5ad0f9b9f24bc7b4eeb7c8975d7e66ddea506837828a82b0f8fc1968cf8afb8886f6ff70b9e0c
-  data.tar.gz: 2a804b84105435ff4be5e344e2b9cb95270c7d3ecda64e733cff498eb77f4379988119504b8a7f7a66599af2998c7ef91d1a07b491bfb7b9f6062bc5ac0fa62a
+  metadata.gz: 5a2f19eacda49f7211cd74e60914c0e9f07d76108268cfa918bf80c1eb4a4376838c6c2ef66c84d3c0ba5b4768ff208f5c751078724ca01a3017388cf2c0bf45
+  data.tar.gz: d08fff8a098711dcdda56193c83413196c90c8b228b5e16d91e9c34befe3bc0054c75d979e5827b6e42c3c3a99c83a46f7f3fc849b939525d053f5731252dd78

data/README.md

@@ -17,6 +17,7 @@ A puppet-lint plugin to check that classes are included by their absolute name.
   * [In a Gemfile](#in-a-gemfile)
 * [Checks](#checks)
   * [Relative class name inclusion](#relative-class-name-inclusion)
+  * [Relative class reference](#relative-classname-reference)
 * [Transfer notice](#transfer-notice)
 * [Release Informaion](#release-information)
 
@@ -66,6 +67,34 @@ Alternatively, if you’re calling puppet-lint via the Rake task, you should ins
 PuppetLint.configuration.send('disable_relative_classname_inclusion')
 ```
 
+### Relative class reference
+
+#### What you have done
+
+```puppet
+Class['::foo'] -> Class['::bar']
+```
+
+#### What you should have done
+
+```puppet
+Class['foo'] -> Class['bar']
+```
+
+#### Disabling the check
+
+To disable this check, you can add `--no-relative_classname_reference-check` to your puppet-lint command line.
+
+```shell
+$ puppet-lint --no-relative_classname_reference-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_relative_classname_reference')
+```
+
 ## Transfer Notice
 
 This plugin was originally authored by [Camptocamp](http://www.camptocamp.com).

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

@@ -40,6 +40,16 @@ PuppetLint.new_check(:relative_classname_inclusion) do
           end
           s = s.next_token
         end
+      elsif token.type == :INHERITS
+        s = token.next_code_token
+        if s.type == :NAME && s.value.start_with?('::')
+          notify :warning, {
+            message: message,
+            line: s.line,
+            column: s.column,
+            token: s
+          }
+        end
       end
     end
   end

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

@@ -0,0 +1,26 @@
+PuppetLint.new_check(:relative_classname_reference) do
+  def check
+    message = 'absolute class name reference'
+
+    tokens.each_with_index do |token, token_idx|
+      if token.type == :TYPE and token.value == 'Class' and token.next_code_token.type == :LBRACK
+        s = token.next_code_token
+        while s.type != :RBRACK
+          if (s.type == :NAME || s.type == :SSTRING) && s.value.start_with?('::')
+            notify :warning, {
+              message: message,
+              line: s.line,
+              column: s.column,
+              token: s
+            }
+          end
+          s = s.next_token
+        end
+      end
+    end
+  end
+
+  def fix(problem)
+    problem[:token].value = problem[:token].value[2..-1]
+  end
+end

data/spec/puppet-lint/plugins/check_absolute_classname/relative_classname_inclusion_spec.rb

@@ -29,11 +29,14 @@ describe 'relative_classname_inclusion' do
         require('::foobar')
         require(foobar(baz))
         require(foobar('baz'))
+
+        class foobar inherits ::baz {
+        }
         EOS
       end
 
-      it 'should detect 11 problems' do
-        expect(problems).to have(11).problems
+      it 'should detect 12 problems' do
+        expect(problems).to have(12).problems
       end
 
       it 'should create warnings' do
@@ -48,6 +51,7 @@ describe 'relative_classname_inclusion' do
         expect(problems).to contain_warning(msg).on_line(15).in_column(17)
         expect(problems).to contain_warning(msg).on_line(19).in_column(17)
         expect(problems).to contain_warning(msg).on_line(20).in_column(17)
+        expect(problems).to contain_warning(msg).on_line(24).in_column(31)
       end
     end
 
@@ -61,6 +65,8 @@ describe 'relative_classname_inclusion' do
         contain(foobar)
         require foobar
         require(foobar)
+        class foobar inherits baz {
+        }
         EOS
       end
 
@@ -136,11 +142,14 @@ describe 'relative_classname_inclusion' do
         require('::foobar')
         require(foobar(baz))
         require(foobar('baz'))
+
+        class foobar inherits ::baz {
+        }
         EOS
       end
 
-      it 'should detect 11 problems' do
-        expect(problems).to have(11).problems
+      it 'should detect 12 problems' do
+        expect(problems).to have(12).problems
       end
 
       it 'should fix the problems' do
@@ -155,6 +164,7 @@ describe 'relative_classname_inclusion' do
         expect(problems).to contain_fixed(msg).on_line(15).in_column(17)
         expect(problems).to contain_fixed(msg).on_line(19).in_column(17)
         expect(problems).to contain_fixed(msg).on_line(20).in_column(17)
+        expect(problems).to contain_fixed(msg).on_line(24).in_column(31)
       end
 
       it 'should should remove colons' do
@@ -182,6 +192,9 @@ describe 'relative_classname_inclusion' do
         require('foobar')
         require(foobar(baz))
         require(foobar('baz'))
+
+        class foobar inherits baz {
+        }
         EOS
         )
       end
@@ -197,6 +210,8 @@ describe 'relative_classname_inclusion' do
         contain(foobar)
         require foobar
         require(foobar)
+        class foobar inherits baz {
+        }
         EOS
       end
 

data/spec/puppet-lint/plugins/check_classname_reference/relative_classname_reference_spec.rb

@@ -0,0 +1,137 @@
+require 'spec_helper'
+
+describe 'relative_classname_reference' do
+  let(:msg) { 'absolute class name reference' }
+
+  context 'with fix disabled' do
+    context 'when absolute names are used' do
+      let(:code) do
+        <<-EOS
+        Class[::foo] -> Class['::bar']
+
+        file { '/path':
+          ensure  => present,
+          require => Class['::foo', '::bar'],
+        }
+
+        file { '/path':
+          ensure  => present,
+          require => [Class[::foo], Class['::bar']],
+        }
+        EOS
+      end
+
+      it 'should detect 6 problems' do
+        expect(problems).to have(6).problems
+      end
+
+      it 'should create warnings' do
+        expect(problems).to contain_warning(msg).on_line(1).in_column(15)
+        expect(problems).to contain_warning(msg).on_line(1).in_column(31)
+        expect(problems).to contain_warning(msg).on_line(5).in_column(28)
+        expect(problems).to contain_warning(msg).on_line(5).in_column(37)
+        expect(problems).to contain_warning(msg).on_line(10).in_column(29)
+        expect(problems).to contain_warning(msg).on_line(10).in_column(43)
+      end
+    end
+
+    context 'when relative names are used' do
+      let(:code) do
+        <<-EOS
+        Class[foo] -> Class['bar']
+        file { '/path':
+          ensure  => present,
+          require => Class['foo', 'bar'],
+        }
+        file { '/path':
+          ensure  => present,
+          require => [Class['foo'], Class['bar']],
+        }
+        EOS
+      end
+
+      it 'should not detect a problem' do
+        expect(problems).to have(0).problems
+      end
+    end
+  end
+
+  context 'with fix enabled' do
+    before do
+      PuppetLint.configuration.fix = true
+    end
+
+    after do
+      PuppetLint.configuration.fix = false
+    end
+
+    context 'when absolute names are used' do
+      let(:code) do
+        <<-EOS
+        Class[::foo] -> Class['::bar']
+
+        file { '/path':
+          ensure  => present,
+          require => Class['::foo', '::bar'],
+        }
+
+        file { '/path':
+          ensure  => present,
+          require => [Class[::foo], Class['::bar']],
+        }
+        EOS
+      end
+
+      it 'should detect 6 problems' do
+        expect(problems).to have(6).problems
+      end
+
+      it 'should fix the problems' do
+        expect(problems).to contain_fixed(msg).on_line(1).in_column(15)
+        expect(problems).to contain_fixed(msg).on_line(1).in_column(31)
+        expect(problems).to contain_fixed(msg).on_line(5).in_column(28)
+        expect(problems).to contain_fixed(msg).on_line(5).in_column(37)
+        expect(problems).to contain_fixed(msg).on_line(10).in_column(29)
+        expect(problems).to contain_fixed(msg).on_line(10).in_column(43)
+      end
+
+      it 'should should remove colons' do
+        expect(manifest).to eq(
+        <<-EOS
+        Class[foo] -> Class['bar']
+
+        file { '/path':
+          ensure  => present,
+          require => Class['foo', 'bar'],
+        }
+
+        file { '/path':
+          ensure  => present,
+          require => [Class[foo], Class['bar']],
+        }
+        EOS
+        )
+      end
+    end
+
+    context 'when relative names are used' do
+      let(:code) do
+        <<-EOS
+        Class[foo] -> Class['bar']
+        file { '/path':
+          ensure  => present,
+          require => Class['foo', 'bar'],
+        }
+        file { '/path':
+          ensure  => present,
+          require => [Class[foo], Class['bar']],
+        }
+        EOS
+      end
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-absolute_classname-check
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-06 00:00:00.000000000 Z
+date: 2020-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -100,8 +100,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: "    A puppet-lint plugin to check that classes are included by their
-  absolute name.\n"
+description: "    A puppet-lint plugin to check that classes are not included or referenced
+  by their absolute name.\n"
 email: voxpupuli@groups.io
 executables: []
 extensions: []
@@ -110,7 +110,9 @@ files:
 - LICENSE
 - README.md
 - lib/puppet-lint/plugins/check_absolute_classname.rb
+- lib/puppet-lint/plugins/check_classname_reference.rb
 - spec/puppet-lint/plugins/check_absolute_classname/relative_classname_inclusion_spec.rb
+- spec/puppet-lint/plugins/check_classname_reference/relative_classname_reference_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/voxpupuli/puppet-lint-absolute_classname-check
 licenses:
@@ -131,12 +133,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
-summary: A puppet-lint plugin to check that classes are included by their absolute
-  name.
+summary: A puppet-lint plugin to check that classes are not included or referenced
+  by their absolute name.
 test_files:
 - spec/spec_helper.rb
+- spec/puppet-lint/plugins/check_classname_reference/relative_classname_reference_spec.rb
 - spec/puppet-lint/plugins/check_absolute_classname/relative_classname_inclusion_spec.rb