puppet-lint-topscope-variable-check 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0ad23632093e2963ab543f0e674b202023a5c6f959138af1c1f5f9391457f5a
-  data.tar.gz: f1aa73f43b44e3cf0cfbe3ab5751e4ce4b036c95bfb4c12830c3e3fae4572320
+  metadata.gz: 5d8122dcc09b9ab9845447832f3d805ebf35d84a77360f8cb8b1ac5789dd4f1c
+  data.tar.gz: 13c983d895775467a2472517b1edbefa723b6fdfc778ed4a8720d0f2af61f592
 SHA512:
-  metadata.gz: 729764ccad0c21ff5ac08c93d892bf60b9e158c7639f307eaa3eaff6e1d30f21de26a4fdd47b0c2940c451ccbd998f9c6d63c69804c8fdce368bc8bf707079b6
-  data.tar.gz: ebd1ab0074b7c9056c6a66b38160a7b6d9cda7323be9e188343aaf0ac719a48e5fed838a511e8c743b94c4e438b8b633abfe64d1ed42c78d75b9de3fd07bbd75
+  metadata.gz: 05dcff337b51dee7bbfdbad3d049392363944c03b8cc7791df12c1aa8e0b24792158c04264c2b8e6f607f91d7fdc75250378668c8351be983b8bb002098c8082
+  data.tar.gz: 78b06a1c9ca140dab88a5d44578154afb35f8270226788785daf81fe841a62d2f75138f3652441ba20e00d51637d6008070d71971025a78610cc1426b2eac100

data/README.md

@@ -1,7 +1,10 @@
 puppet-lint-topscope-variable-check
 ========================
-[![Build Status](https://api.travis-ci.org/sixt/puppet-lint-topscope-variable-check.svg)](https://travis-ci.org/sixt/puppet-lint-topscope-variable-check)
-
+[![License](https://img.shields.io/github/license/voxpupuli/puppet-lint-topscope-variable-check.svg)](https://github.com/voxpupuli/puppet-lint-topscope-variable-check/blob/master/LICENSE)
+[![Test](https://github.com/voxpupuli/puppet-lint-topscope-variable-check/actions/workflows/test.yml/badge.svg)](https://github.com/voxpupuli/puppet-lint-topscope-variable-check/actions/workflows/test.yml)
+[![Release](https://github.com/voxpupuli/puppet-lint-topscope-variable-check/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/puppet-lint-topscope-variable-check/actions/workflows/release.yml)
+[![RubyGem Version](https://img.shields.io/gem/v/puppet-lint-topscope-variable-check.svg)](https://rubygems.org/gems/puppet-lint-topscope-variable-check)
+[![RubyGem Downloads](https://img.shields.io/gem/dt/puppet-lint-topscope-variable-check.svg)](https://rubygems.org/gems/puppet-lint-topscope-variable-check)
 
 A puppet-lint plugin to check that topscope variables in a class do not begin with $::
 
@@ -72,13 +75,22 @@ PuppetLint.configuration.send('disable_topscope_variable')
 ```
 ## Limitations
 
-The fix function of this plugin does not work when the variable is used in a string.
+The fix function of this plugin does not work when the variable is used in a string and hasn't been enclosed with `{}`.
 For example:
 
 ``` puppet
 $foo = "/etc/$::foobar::path/test"
 ```
 
+Note: The [Variables Not Enclosed](http://puppet-lint.com/checks/variables_not_enclosed/) check can fix the missing braces and then the fix from this plugin should work.
+
+## Transfer Notice
+
+This plugin and github repository was originally developed and maintained by [Sixt](https://www.sixt.com/).
+On 2021/11/24 the github project was transferred to [Voxpupuli](https://voxpupuli.org/) for ongoing improvement and maintenance.
+
+Previously: https://github.com/Sixt/puppet-lint-topscope-variable-check
+
 ## License
 ```
 MIT License

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

@@ -3,9 +3,9 @@ PuppetLint.new_check(:topscope_variable) do
     class_list = (class_indexes + defined_type_indexes)
     # do not check if the code is not part of a class
     return if class_list.first.nil?
-    class_name = class_list.first[:name_token].value.split('::').first
+
     tokens.select { |x| x.type == :VARIABLE }.each do |token|
-      next if token.value !~ /^::#{class_name}::/
+      next if token.value !~ /^::[a-z0-9_][a-zA-Z0-9_]+::/
       fixed = token.value.sub(/^::/, '')
       notify(
         :warning,

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

@@ -5,7 +5,7 @@ describe 'topscope_variable' do
   context 'with fix disabled' do
     context 'with correct topscope' do
       let(:code) do
-        <<-PUP.strip_heredoc
+        <<~PUP
           class foo::blub {
             notify { 'foo':
               message => $foo::bar
@@ -21,7 +21,7 @@ describe 'topscope_variable' do
 
     context 'with incorrect topscope' do
       let(:code) do
-        <<-PUP.strip_heredoc
+        <<~PUP
           class foo::blub {
             notify { 'foo':
               message => $::foo::bar
@@ -35,9 +35,25 @@ describe 'topscope_variable' do
       end
     end
 
+    context 'with incorrect topscope from external module' do
+      let(:code) do
+        <<~PUP
+          class profile::foo {
+            notify { 'foo':
+              message => $::some_component_module::bar
+            }
+          }
+        PUP
+      end
+
+      it 'should detect one problem' do
+        expect(problems).to have(1).problem
+      end
+    end
+
     context 'with correct topscope in params' do
       let(:code) do
-        <<-PUP.strip_heredoc
+        <<~PUP
           class foo::blub(
             String $foo = $params::foo
           ) {
@@ -53,7 +69,7 @@ describe 'topscope_variable' do
 
     context 'with incorrect topscope in params' do
       let(:code) do
-        <<-PUP.strip_heredoc
+        <<~PUP
           class foo::blub(
             String $foo = $::foo::params::foo
           ) {
@@ -69,10 +85,10 @@ describe 'topscope_variable' do
 
     context 'with a fact that has been used improperly' do
       let(:code) do
-        <<-PUP.strip_heredoc
+        <<~PUP
           class foo::blub {
             notify { 'foo':
-              message => $blub::bar
+              message => $::operatingsystem
             }
           }
         PUP
@@ -82,6 +98,22 @@ describe 'topscope_variable' do
         expect(problems).to have(0).problem
       end
     end
+
+    context 'with a fact that has been used improperly in params' do
+      let(:code) do
+        <<~PUP
+          class foo::blub(
+            String $foo = $::operatingsystem
+          ) {
+            # ...
+          }
+        PUP
+      end
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problem
+      end
+    end
   end
 
   context 'with fix enabled' do
@@ -95,7 +127,7 @@ describe 'topscope_variable' do
 
     context 'with correct topscope' do
       let(:code) do
-        <<-PUP.strip_heredoc
+        <<~PUP
           class foo::blub {
             notify { 'foo':
               message => $foo::bar
@@ -111,7 +143,7 @@ describe 'topscope_variable' do
 
     context 'with incorrect topscope' do
       let(:code) do
-        <<-PUP.strip_heredoc
+        <<~PUP
           class foo::blub {
             notify { 'foo':
               message => $::foo::bar
@@ -129,7 +161,7 @@ describe 'topscope_variable' do
       end
 
       it 'should remove :: after the $' do
-        expect(manifest).to eq <<-PUP.strip_heredoc
+        expect(manifest).to eq <<~PUP
           class foo::blub {
             notify { 'foo':
               message => $foo::bar
@@ -139,9 +171,39 @@ describe 'topscope_variable' do
       end
     end
 
+    context 'with incorrect topscope from external module' do
+      let(:code) do
+        <<~PUP
+          class profile::foo {
+            notify { 'foo':
+              message => $::some_component_module::bar
+            }
+          }
+        PUP
+      end
+
+      it 'should detect one problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'should fix the problem' do
+        expect(problems).to contain_fixed('use $some_component_module::bar instead of $::some_component_module::bar').on_line(3).in_column(16)
+      end
+
+      it 'should remove :: after the $' do
+        expect(manifest).to eq <<~PUP
+          class profile::foo {
+            notify { 'foo':
+              message => $some_component_module::bar
+            }
+          }
+        PUP
+      end
+    end
+
     context 'with incorrect topscope in quoted variable' do
       let(:code) do
-        <<-PUP.strip_heredoc
+        <<~PUP
           class foo::blub {
             notify { 'foo':
               message => ">${::foo::bar}<"
@@ -155,24 +217,24 @@ describe 'topscope_variable' do
       end
 
       it 'should fix the problem' do
-        expect(problems).to contain_fixed(msg).on_line(3).in_column(19)
-      end
-
-      # it 'should remove :: after the $' do
-      #   expect(manifest).to eq <<-PUP.strip_heredoc
-      #     class foo::blub {
-      #       notify { 'foo':
-      #         message => ">${foo::bar}<"
-      #       }
-      #     }
-      #   PUP
-      # end
+        expect(problems).to contain_fixed(msg).on_line(3).in_column(20)
+      end
+
+      it 'should remove :: after the $' do
+        expect(manifest).to eq <<~PUP
+          class foo::blub {
+            notify { 'foo':
+              message => ">${foo::bar}<"
+            }
+          }
+        PUP
+      end
     end
   end
 
   context 'without a class scope' do
     let(:code) do
-      <<-PUP.strip_heredoc
+      <<~PUP
         include ::foo
       PUP
     end

data/spec/spec_helper.rb

@@ -1,13 +1,29 @@
-require 'coveralls'
-Coveralls.wear!
+# frozen_string_literal: true
 
-require 'puppet-lint'
-PuppetLint::Plugins.load_spec_helper
+begin
+  require 'simplecov'
+  require 'simplecov-console'
+  require 'codecov'
+rescue LoadError
+else
+  SimpleCov.start do
+    track_files 'lib/**/*.rb'
+
+    add_filter '/spec'
 
-# strip left spaces from heredoc
-# this emulates the behaviour of the ~ heredoc from ruby 2.3
-class String
-  def strip_heredoc
-    gsub(/^#{scan(/^\s*/).min_by(&:length)}/, '')
+    enable_coverage :branch
+
+    # do not track vendored files
+    add_filter '/vendor'
+    add_filter '/.vendor'
   end
+
+  SimpleCov.formatters = [
+    SimpleCov::Formatter::Console,
+    SimpleCov::Formatter::Codecov,
+  ]
 end
+
+require 'puppet-lint'
+
+PuppetLint::Plugins.load_spec_helper

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-topscope-variable-check
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
-- Martin Merfort
+- Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-12 00:00:00.000000000 Z
+date: 2022-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -108,9 +94,23 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.58'
+- !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'
 description: "    A puppet-lint plugin to check that topscope variable names don't
   start with ::.\n"
-email: platformengineering@sixt.com
+email: voxpupuli@groups.io
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -120,7 +120,7 @@ files:
 - lib/puppet-lint/plugins/topscope_variable.rb
 - spec/puppet-lint/plugins/topscope_variable_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/Sixt/puppet-lint-topscope-variable-check
+homepage: https://github.com/voxpupuli/puppet-lint-topscope-variable-check
 licenses:
 - MIT
 metadata: {}
@@ -139,11 +139,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: A puppet-lint plugin to check topscope variables.
 test_files:
-- spec/spec_helper.rb
 - spec/puppet-lint/plugins/topscope_variable_spec.rb
+- spec/spec_helper.rb