RubyGems - puppet-lint-absolute_template_path - Versions diffs - 1.0.1 → 2.0.0 - Mend

puppet-lint-absolute_template_path 1.0.1 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

checksums.yaml +5 -5
data/README.md +2 -0
data/lib/puppet-lint/plugins/absolute_template_path.rb +18 -18
data/spec/puppet-lint/plugins/absolute_template_path_spec.rb +44 -12
data/spec/spec_helper.rb +5 -0
metadata +83 -15

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: af85d198561d667385793e06959464ff6586ee1c
-  data.tar.gz: e8e84e4479283dd2b67f6bec70e541f92fdd7474
+SHA256:
+  metadata.gz: 02a0cdec7239448a8e68128530bfe37d0e08015e2918d2b4c6727cccb030fa7b
+  data.tar.gz: 7fdea9bcf4663a099fdf96e396197d987650e52b186aa08f4acfe6aa2719b8a4
 SHA512:
-  metadata.gz: fcfec278a95babef8f415c1c5a131f4f2800f90e9629ea2b9c8e5daa30b7643834fcbb59b992714824005f34e00328fc6121d7fb7f20acbe917c66f73b5ece3d
-  data.tar.gz: 2dd27e1e2fa00d393e5557e4ca65b15652532b12e3c109254f16cc07db0e572f5dc3493dcda4dcb293b8ff2b102ed8773a95abd5b55e7cfa23e3976a2f41a719
+  metadata.gz: 9acf95528a3d812914e8ee0cd083a2d8d65159e289286612701e4837813dbff0662a3decb71ef3e597972d9f6e3b30e9dd7971e255e8035212d20f7e61e4d1bc
+  data.tar.gz: 7993374239e66964b7c613839e6c0442267f6f84d1d54251363b9af85fc1c4ebcfa4ada566fc603b0065386b7d75805b5912dfcb01f1217732298490494dbebf

data/README.md CHANGED Viewed

@@ -1,5 +1,7 @@
 # puppet-lint absolute template path check
+[![Actions Status](https://github.com/deanwilson/puppet-lint-absolute_template_path-check/workflows/Ruby/badge.svg)](https://github.com/deanwilson/puppet-lint-absolute_template_path-check/actions)
 A new check for puppet-lint that checks template paths are in the
 relative `template('example/template.erb')` form rather than the absolute
 `template('/etc/puppet/modules/example/templates/template.erb')` format.

data/lib/puppet-lint/plugins/absolute_template_path.rb CHANGED Viewed

@@ -1,28 +1,28 @@
 PuppetLint.new_check(:absolute_template_path) do
   def check
     resource_indexes.each do |resource|
-      if resource[:type].value == "file"
-        resource[:param_tokens].select { |param_token|
-          param_token.value == 'content'
-        }.each do |content_token|
+      next unless resource[:type].value == 'file'
-          value_token = content_token.next_code_token.next_code_token
+      content_tokens = resource[:param_tokens].select { |pt| pt.value == 'content' }
-          if value_token.value.start_with? 'template'
-            template_path = value_token.next_code_token.next_code_token.value
+      content_tokens.each do |content_token|
+        value_token = content_token.next_code_token.next_code_token
-            if template_path.start_with? '/'
+        next unless value_token.value.start_with? 'template'
-              notify :warning, {
-                :message     => 'template module paths should be relative, not absolute',
-                :line        => value_token.line,
-                :column      => value_token.column,
-                :param_token => content_token,
-                :value_token => value_token,
-              }
-            end
-          end
-        end
+        template_path = value_token.next_code_token.next_code_token.value
+        next unless template_path.start_with? '/' # skip relative paths
+        # if we made it here it's a file resource with a template parameter
+        # that begins with an absolute path, so raise a lint issue for it.
+        notify :warning, {
+          message:     'template module paths should be relative, not absolute',
+          line:        value_token.line,
+          column:      value_token.column,
+          param_token: content_token,
+          value_token: value_token,
+        }
       end
     end
   end

data/spec/puppet-lint/plugins/absolute_template_path_spec.rb CHANGED Viewed

@@ -1,45 +1,77 @@
 require 'spec_helper'
 describe 'absolute_template_path' do
   let(:msg) { 'template module paths should be relative, not absolute' }
+  context 'when the manifest has no file resources' do
+    let(:code) do
+      <<-TEST_CLASS
+        class no_file_resource {
+          host { 'syslog':
+            ip => '10.10.10.10',
+          }
+        }
+      TEST_CLASS
+    end
+    it 'does not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+  context 'with file resource but no template call' do
+    context 'when the template has a relative module path' do
+      let(:code) do
+        <<-TEST_CLASS
+          class template_tester {
+            file { '/tmp/template':
+              content => 'A static string',
+            }
+          }
+        TEST_CLASS
+      end
+      it 'detects no problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+  end
   context 'with fix disabled' do
-    context 'template with a relative module path' do
+    context 'when the template has a relative module path' do
       let(:code) do
-        <<-EOS
+        <<-TEST_CLASS
           class template_tester {
             file { '/tmp/template':
               content => template('example/template.erb'),
             }
           }
-        EOS
+        TEST_CLASS
       end
-      it 'should not detect any problems' do
+      it 'detects no problems' do
         expect(problems).to have(0).problems
       end
     end
-    context 'template with an absolute module path' do
+    context 'when the template has an absolute module path' do
       let(:code) do
-        <<-EOS
+        <<-TEST_CLASS
           class template_tester {
             file { '/tmp/template':
               content => template('/etc/puppet/modules/example/template.erb'),
             }
           }
-        EOS
+        TEST_CLASS
       end
-      it 'should detect a single problem' do
+      it 'detects a single problem' do
         expect(problems).to have(1).problem
       end
-      it 'should create a warning' do
-         expect(problems).to contain_warning(msg).on_line(3).in_column(26)
+      it 'creates a warning' do
+        expect(problems).to contain_warning(msg).on_line(3).in_column(26)
       end
     end
   end
 end

data/spec/spec_helper.rb CHANGED Viewed

@@ -1,3 +1,8 @@
+require 'simplecov'
+SimpleCov.start do
+  enable_coverage :branch
+end
 require 'puppet-lint'
 PuppetLint::Plugins.load_spec_helper

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-absolute_template_path
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Dean Wilson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-08-21 00:00:00.000000000 Z
+date: 2023-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -19,7 +19,7 @@ dependencies:
         version: '1.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,23 +29,37 @@ dependencies:
         version: '1.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.12.0
 - !ruby/object:Gem::Dependency
-  name: rspec-its
+  name: rspec-collection_matchers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -59,7 +73,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rspec-collection_matchers
+  name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -73,7 +87,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec-json_expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.52.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.52.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -86,6 +128,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.22.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
 description: |2
       A new check for puppet-lint that checks all template paths are in the
       template('example/template.erb') form rather than
@@ -100,7 +170,7 @@ files:
 - lib/puppet-lint/plugins/absolute_template_path.rb
 - spec/puppet-lint/plugins/absolute_template_path_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/deanwilson/puppet-lint-absolute_template_path
+homepage: https://github.com/deanwilson/puppet-lint-absolute_template_path-check
 licenses:
 - MIT
 metadata: {}
@@ -112,19 +182,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.4.8
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: puppet-lint absolute template path check
 test_files:
-- spec/spec_helper.rb
 - spec/puppet-lint/plugins/absolute_template_path_spec.rb
-has_rdoc:
+- spec/spec_helper.rb