puppet-lint-resource_reference_syntax 1.0.14 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b4d49d1c29ba9ae2d623b28608f0830ed9ad519d
-  data.tar.gz: 05917862e5e238a57adb9ea389f8c5a3e4a15261
+SHA256:
+  metadata.gz: 9c9a6ebde35f12d98df1cce4eca6e732f53066211bd1206b8bbc936abe80d901
+  data.tar.gz: 20a5912273e3c6b3721b0c0a0e080d542bf7b3fc9d4175a33345fd1c8a5a50f0
 SHA512:
-  metadata.gz: 2d534ade50b6749f69bd0dd3e479e6e267ddae29f825ac22428b8a2767d6d9d9392ac825acd179fa66cfc9f69c8efe1d569b6997f85251a1ce2344cf2a971f92
-  data.tar.gz: c3b6eef005b06ba8c833555b3a8117fabe0dc68a0da9cecbb4f9c330116ff9a078535f83f8e2f51ad5466ac897d23af4ddcec159a1dfad7a46709705b3947661
+  metadata.gz: f99e959beb3b512758423243365efe2fa0006c573595111bca0bebc67c652e699e007ba372931cecd2b277dae4f32a16f4c0ba4e2bf6b36a4be806fbc9cff566
+  data.tar.gz: 0f5030dc3ecf4aaba141da1656b4a90feff01721954e8114d28e3bda4ad90f989cb46e60c055daec36e8de8ab0dc27aee978a1d87745ac011d92d3d40629fc76

data/CHANGELOG.md

@@ -0,0 +1,112 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [1.2.0](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/tree/1.2.0) (2022-11-29)
+
+[Full Changelog](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/compare/1.1.0...1.2.0)
+
+**Implemented enhancements:**
+
+- puppet-lint: Allow 3.x [\#24](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/pull/24) ([bastelfreak](https://github.com/bastelfreak))
+
+**Merged pull requests:**
+
+- cleanup README.md/gemspec [\#21](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/pull/21) ([bastelfreak](https://github.com/bastelfreak))
+
+## [1.1.0](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/tree/1.1.0) (2020-04-14)
+
+[Full Changelog](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/compare/1.0.14...1.1.0)
+
+**Implemented enhancements:**
+
+- Break out quoted refs check and add fix [\#16](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/pull/16) ([danzilio](https://github.com/danzilio))
+
+**Closed issues:**
+
+- Doesn't detect spaces when using chaining arrows syntax \("Class \['A'\] -\> Class \['B'\]"\) [\#14](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/issues/14)
+
+**Merged pull requests:**
+
+- Remove ruby 1.9 from testing, add ruby 2.5 [\#17](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/pull/17) ([tuxmea](https://github.com/tuxmea))
+
+## [1.0.14](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/tree/1.0.14) (2018-01-04)
+
+[Full Changelog](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/compare/1.0.13...1.0.14)
+
+## [1.0.13](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/tree/1.0.13) (2018-01-03)
+
+[Full Changelog](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/compare/1.0.12...1.0.13)
+
+## [1.0.12](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/tree/1.0.12) (2018-01-03)
+
+[Full Changelog](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/compare/1.0.11...1.0.12)
+
+**Closed issues:**
+
+- false resource\_reference\_without\_whitespace on resource collection [\#15](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/issues/15)
+- resource\_reference\_without\_whitespace error on resource collection [\#9](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/issues/9)
+
+## [1.0.11](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/tree/1.0.11) (2017-12-30)
+
+[Full Changelog](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/compare/1.0.10...1.0.11)
+
+**Merged pull requests:**
+
+- release 1.0.10 [\#13](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/pull/13) ([tuxmea](https://github.com/tuxmea))
+
+## [1.0.10](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/tree/1.0.10) (2016-11-17)
+
+[Full Changelog](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/compare/1.0.8...1.0.10)
+
+**Closed issues:**
+
+- False positive for require [\#10](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/issues/10)
+
+**Merged pull requests:**
+
+- Restrict checking to the matched parameter only [\#12](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/pull/12) ([cbowman0](https://github.com/cbowman0))
+- Improve message for resources missing quotes [\#11](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/pull/11) ([domcleal](https://github.com/domcleal))
+- add travis with voxpupili key [\#8](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/pull/8) ([tuxmea](https://github.com/tuxmea))
+- Release 1.0.9 [\#7](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/pull/7) ([bastelfreak](https://github.com/bastelfreak))
+
+## [1.0.8](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/tree/1.0.8) (2016-03-17)
+
+[Full Changelog](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/compare/1.0.7...1.0.8)
+
+**Closed issues:**
+
+- False warning: resource reference with title with capital letter [\#4](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/issues/4)
+- False warning: whitespce between reference type and title [\#3](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/issues/3)
+
+## [1.0.7](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/tree/1.0.7) (2016-03-16)
+
+[Full Changelog](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/compare/1.0.6...1.0.7)
+
+**Merged pull requests:**
+
+- iterate over resource reference arrays [\#5](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/pull/5) ([tuxmea](https://github.com/tuxmea))
+
+## [1.0.6](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/tree/1.0.6) (2016-01-25)
+
+[Full Changelog](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/compare/1.0.5...1.0.6)
+
+**Closed issues:**
+
+- Wrong match when a variable is in the title [\#1](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/issues/1)
+
+**Merged pull requests:**
+
+- Fix wrong match on titles with variables \(fixes \#1\) [\#2](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/pull/2) ([vStone](https://github.com/vStone))
+
+## [1.0.5](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/tree/1.0.5) (2015-11-26)
+
+[Full Changelog](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/compare/1.0.4...1.0.5)
+
+## [1.0.4](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/tree/1.0.4) (2015-10-18)
+
+[Full Changelog](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/compare/5ef5832a944246df5d3e7c781085e3a76357b641...1.0.4)
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/README.md

@@ -1,7 +1,13 @@
 # puppet-lint plugin resource reference check
 
-**Note, this plugin will check for Puppet resource reference syntax which will no 
-longer work with Puppet 4.x.**
+[![License](https://img.shields.io/github/license/voxpupuli/puppet-lint-resource_reference_syntax.svg)](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/blob/master/LICENSE)
+[![Test](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/actions/workflows/test.yml/badge.svg)](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/actions/workflows/test.yml)
+[![Release](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/puppet-lint-resource_reference_syntax/actions/workflows/release.yml)
+[![RubyGem Version](https://img.shields.io/gem/v/puppet-lint-resource_reference_syntax.svg)](https://rubygems.org/gems/puppet-lint-resource_reference_syntax)
+[![RubyGem Downloads](https://img.shields.io/gem/dt/puppet-lint-resource_reference_syntax.svg)](https://rubygems.org/gems/puppet-lint-resource_reference_syntax)
+[![Donated by example42](https://img.shields.io/badge/donated%20by-example42-fb7047.svg)](#transfer-notice)
+
+**Note, this plugin will check for Puppet resource reference syntax which will no longer work with Puppet 4.x.**
 
 ## Installation
 
@@ -55,7 +61,26 @@ The following references are good code for Puppet 4:
 
 ```
   require => Service['apache'],
-  require => Service['apache', 'mysql'], 
+  require => Service['apache', 'mysql'],
   require => [ Service['apache'], Service['mysql'] ],
 ```
 
+## Transfer Notice
+
+This plugin was originally authored by [example42](https://example42.de).
+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.
+
+## License
+
+This gem is licensed under the Apache-2 license.
+
+## 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/resource_reference_with_unquoted_title.rb

@@ -0,0 +1,39 @@
+PuppetLint.new_check(:resource_reference_with_unquoted_title) do
+  def check
+    resource_indexes.each do |resource|
+      resource[:param_tokens].select { |param_token|
+        ['require', 'subscribe', 'notify', 'before', 'consume', 'export'].include? param_token.value
+      }.each do |param_token|
+        value_token = param_token.next_code_token
+        check = value_token.next_token
+        until resource[:param_tokens].include? check or not resource[:tokens].include? check or check.nil?
+          case value_token.next_token.type
+          when :CLASSREF
+            begin
+              if value_token.next_token.next_token.type == :LBRACK
+                check_token = value_token.next_token.next_token.next_token
+                if check_token.type == :NAME
+                  notify :error, {
+                    :message => 'unquoted title in resource reference',
+                    :line    => check_token.line,
+                    :column  => check_token.column,
+                    :token   => check_token,
+                  }
+                end
+              end
+              value_token = value_token.next_token
+              check = value_token.next_token
+            end
+          else
+            value_token = value_token.next_token
+            check = value_token.next_token
+          end
+        end
+      end
+    end
+  end
+
+  def fix(problem)
+    problem[:token].type = :SSTRING
+  end
+end

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

@@ -18,12 +18,6 @@ PuppetLint.new_check(:resource_reference_without_title_capital) do
                     :line    => check_token.line,
                     :column  => check_token.column
                   }
-                elsif check_token.type == :NAME
-                  notify :error, {
-                    :message => 'resource reference with title with missing quotes',
-                    :line    => check_token.line,
-                    :column  => check_token.column
-                  }
                 end
               end
               value_token = value_token.next_token

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

@@ -0,0 +1,207 @@
+require 'spec_helper'
+
+describe 'resource_reference_with_unquoted_title' do
+  let(:msg) { 'unquoted title in resource reference' }
+
+  context 'with fix disabled' do
+    context 'quoted resource ref on single line resource' do
+      let(:code) { "file { 'foo': require => File['bar'] }" }
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context 'unquoted resource ref on single line resource' do
+      let(:code) { "file { 'foo': require => File[bar] }" }
+
+      it 'should only detect a single problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'should raise an error' do
+        expect(problems).to contain_error(msg).on_line(1).in_column(31)
+      end
+    end
+
+
+    context 'quoted resource ref on multi line resource' do
+      let(:code) do
+        <<-END
+          file { 'foo':
+            require => File['bar'],
+          }
+        END
+      end
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context 'unquoted resource ref on multi line resource' do
+      let(:code) do
+        <<-END
+          file { 'foo':
+            require => File[bar]
+          }
+        END
+      end
+
+      it 'should only detect a single problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'should raise an error' do
+        expect(problems).to contain_error(msg).on_line(2).in_column(29)
+      end
+    end
+
+    context 'condensed resources with quoted refs' do
+      let(:code) do
+        <<-END
+          file {
+            'foo':
+              require => File['bar'];
+            'bar':
+              require => File['baz'];
+          }
+        END
+      end
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context 'condensed resources with an unquoted ref' do
+      let(:code) do
+        <<-END
+          file {
+            'foo':
+              require => File[bar];
+            'bar':
+              require => File['baz'];
+          }
+        END
+      end
+
+      it 'should only detect a single problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'should raise an error' do
+        expect(problems).to contain_error(msg).on_line(3).in_column(31)
+      end
+    end
+
+    context 'resource refs with interpolated variables' do
+      let(:code) do
+        <<-END
+          $file = 'bar'
+
+          file { 'foo':
+            require => File[$file]
+          }
+        END
+      end
+
+      it 'should not detect any problems' 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 'unquoted resource ref on single line resource' do
+      let(:code) { "file { 'foo': require => File[bar] }" }
+
+      it 'should only detect a single problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'should fix the manifest' do
+        expect(problems).to contain_fixed(msg).on_line(1).in_column(31)
+      end
+
+      it 'should single quote the resource title' do
+        expect(manifest).to eq("file { 'foo': require => File['bar'] }")
+      end
+    end
+
+    context 'unquoted resource ref on multi line resource' do
+      let(:code) do
+        <<-END
+          file { 'foo':
+            require => File[bar]
+          }
+        END
+      end
+
+      let(:fixed) do
+        <<-END
+          file { 'foo':
+            require => File['bar']
+          }
+        END
+      end
+
+      it 'should only detect a single problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'should fix the manifest' do
+        expect(problems).to contain_fixed(msg).on_line(2).in_column(29)
+      end
+
+      it 'should single quote the resource ref' do
+        expect(manifest).to eq(fixed)
+      end
+    end
+
+    context 'condensed resources with an unquoted ref' do
+      let(:code) do
+        <<-END
+          file {
+            'foo':
+              require => File[bar];
+            'bar':
+              require => File['baz'];
+          }
+        END
+      end
+
+      let(:fixed) do
+        <<-END
+          file {
+            'foo':
+              require => File['bar'];
+            'bar':
+              require => File['baz'];
+          }
+        END
+      end
+
+      it 'should only detect a single problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'should fix the manifest' do
+        expect(problems).to contain_fixed(msg).on_line(3).in_column(31)
+      end
+
+      it 'should single quote the resource title' do
+        expect(manifest).to eq(fixed)
+      end
+    end
+  end
+end

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

@@ -99,19 +99,6 @@ describe 'resource_reference_without_title_capital' do
     end
   end
 
-  context 'resource reference with title without quotes' do
-    let(:msg) { 'resource reference with title with missing quotes' }
-    let(:code) { "file { 'foo': ensure => file, notify => Title[one],}" }
-
-    it 'should only detect a single problem' do
-      expect(problems).to have(1).problem
-    end
-
-    it 'should create an error' do
-      expect(problems).to contain_error(msg).on_line(1)
-    end
-  end
-
   context 'stay within the parameter context' do
     let(:code) { "file { 'foo': ensure => file, notify => Title['One'],} $var = [ Exec[runsomething] ]" }
 

data/spec/spec_helper.rb

@@ -1,3 +1,29 @@
+# frozen_string_literal: true
+
+begin
+  require 'simplecov'
+  require 'simplecov-console'
+  require 'codecov'
+rescue LoadError
+else
+  SimpleCov.start do
+    track_files 'lib/**/*.rb'
+
+    add_filter '/spec'
+
+    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-resource_reference_syntax
 version: !ruby/object:Gem::Version
-  version: 1.0.14
+  version: 1.2.0
 platform: ruby
 authors:
-- Martin Alfke
+- Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-04 00:00:00.000000000 Z
+date: 2022-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -19,7 +19,7 @@ dependencies:
         version: '1.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '1.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -76,50 +76,53 @@ dependencies:
   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: 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: |2
-      Extends puppet-lint to ensure that the reference syntax follows Puppet 4 style
-email: ma@example42.com
+description: "    Extends puppet-lint to ensure that the reference syntax follows
+  Puppet 4 style\n"
+email: voxpupuli@groups.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
+- CHANGELOG.md
 - LICENSE
 - README.md
 - lib/puppet-lint/plugins/resource_reference_chain_without_whitespace.rb
+- lib/puppet-lint/plugins/resource_reference_with_unquoted_title.rb
 - lib/puppet-lint/plugins/resource_reference_without_title_capital.rb
 - lib/puppet-lint/plugins/resource_reference_without_whitespace.rb
 - spec/puppet-lint/plugins/resource_reference_chain_without_whitespace_spec.rb
+- spec/puppet-lint/plugins/resource_reference_with_unquoted_title_spec.rb
 - spec/puppet-lint/plugins/resource_reference_without_title_capital_spec.rb
 - spec/puppet-lint/plugins/resource_reference_without_whitespace_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/voxpupuli/puppet-lint-resource_reference_syntax
 licenses:
-- APL2
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -136,13 +139,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: puppet-lint reference_syntax check
 test_files:
 - spec/puppet-lint/plugins/resource_reference_chain_without_whitespace_spec.rb
+- spec/puppet-lint/plugins/resource_reference_with_unquoted_title_spec.rb
 - spec/puppet-lint/plugins/resource_reference_without_title_capital_spec.rb
 - spec/puppet-lint/plugins/resource_reference_without_whitespace_spec.rb
 - spec/spec_helper.rb