puppet-syntax 4.1.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45c8f3b9275ea2f9c7cccb72c2b930a15079ff0618ee55d62d8b3d393ec3f8a1
-  data.tar.gz: 11d6e05a07d6932b9180a9e09eb1e5c7cf47b209c7c935bd4d5635e51ce11bba
+  metadata.gz: fa1f289751fd476cf68888ea7332859a070fd13da470cb62e1d3c71d8afc1291
+  data.tar.gz: 44a4d1f9652ef9b40d1ee6318321073d2a46d393aa4b043aa4bab225db542a2f
 SHA512:
-  metadata.gz: 87e65a0f0e244ee179926e7e9b3904a5f0c77b87b6789a24f98efa18e78a8345312b434c5fbd051c92b9332572b19346a0bddad3623c341b6d9479ec6f55e094
-  data.tar.gz: 2bfd3fae9730595def3f1892a753279a7a081ab9ba4f09f8dafc1c798e7aaf67c469886c1fca22a994274d02343a9d838d90a02c56f16dd0c4b65099c28a9404
+  metadata.gz: eb28b604491202ead9128626b736462b5aa16761fce9437f45e3d890aecfdaf6737c3d4b823c14864c84b07f425ab642859408dd210fb31d91f81ed6e38db9c8
+  data.tar.gz: 8830caf03c537c2a229a2686ea5fbfe729d6a73525d1078a27f0b1c0317d13bc81802415ffd3004fa9486486d9df2d9c52bf0d5f941079a83b43a0b30632c76c

data/.github/workflows/test.yml

@@ -9,10 +9,12 @@ env:
   BUNDLE_WITHOUT: development:release
 
 jobs:
-  rubocop:
+  rubocop_and_matrix:
     env:
       BUNDLE_WITHOUT: release
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
+    outputs:
+      ruby: ${{ steps.ruby.outputs.versions }}
     steps:
       - uses: actions/checkout@v4
       - name: Install Ruby ${{ matrix.ruby }}
@@ -22,16 +24,16 @@ jobs:
           bundler-cache: true
       - name: Run Rubocop
         run: bundle exec rake rubocop
+      - id: ruby
+        uses: voxpupuli/ruby-version@v1
+
   test:
     runs-on: ubuntu-latest
+    needs: rubocop_and_matrix
     strategy:
       fail-fast: false
       matrix:
-        ruby:
-          - "3.2"
-          - "3.1"
-          - "3.0"
-          - "2.7"
+        ruby: ${{ fromJSON(needs.rubocop_and_matrix.outputs.ruby) }}
         puppet:
           - "~> 8.0"
           - "~> 7.0"
@@ -62,7 +64,7 @@ jobs:
 
   tests:
     needs:
-      - rubocop
+      - rubocop_and_matrix
       - test
     runs-on: ubuntu-latest
     name: Test suite

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-03-08 16:09:27 UTC using RuboCop version 1.61.0.
+# on 2025-05-09 08:19:08 UTC using RuboCop version 1.67.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -29,19 +29,13 @@ Lint/SuppressedException:
   Exclude:
     - 'Rakefile'
 
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: AutoCorrect.
-Lint/UselessAssignment:
-  Exclude:
-    - 'lib/puppet-syntax/templates.rb'
-
 # Offense count: 4
 # Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, CheckDefinitionPathHierarchyRoots, Regex, IgnoreExecutableScripts, AllowedAcronyms.
 # CheckDefinitionPathHierarchyRoots: lib, spec, test, src
 # AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
 Naming/FileName:
   Exclude:
+    - 'Rakefile.rb'
     - 'lib/puppet-syntax.rb'
     - 'lib/puppet-syntax/tasks/puppet-syntax.rb'
     - 'spec/puppet-syntax/tasks/puppet-syntax_spec.rb'
@@ -86,21 +80,11 @@ RSpec/DescribedClass:
 # Offense count: 7
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
-  Max: 16
-
-# Offense count: 4
-# Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly.
-# Include: **/*_spec*rb*, **/spec/**/*
-RSpec/FilePath:
-  Exclude:
-    - 'spec/puppet-syntax/hiera_spec.rb'
-    - 'spec/puppet-syntax/manifests_spec.rb'
-    - 'spec/puppet-syntax/templates_spec.rb'
-    - 'spec/puppet-syntax_spec.rb'
+  Max: 17
 
 # Offense count: 29
 RSpec/MultipleExpectations:
-  Max: 10
+  Max: 11
 
 # Offense count: 30
 # Configuration parameters: EnforcedStyle, IgnoreSharedExamples.
@@ -134,12 +118,6 @@ RSpec/SubjectDeclaration:
     - 'spec/puppet-syntax/manifests_spec.rb'
     - 'spec/puppet-syntax/templates_spec.rb'
 
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Rake/Desc:
-  Exclude:
-    - 'Rakefile'
-
 # Offense count: 1
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: EnforcedStyle.
@@ -244,7 +222,7 @@ Style/SymbolProc:
     - 'lib/puppet-syntax/manifests.rb'
     - 'lib/puppet-syntax/templates.rb'
 
-# Offense count: 3
+# Offense count: 4
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
 # URISchemes: http, https

data/CHANGELOG.md

@@ -2,6 +2,33 @@
 
 All notable changes to this project will be documented in this file.
 
+## [v5.0.0](https://github.com/voxpupuli/puppet-syntax/tree/v5.0.0) (2025-05-23)
+
+[Full Changelog](https://github.com/voxpupuli/puppet-syntax/compare/v4.1.1...v5.0.0)
+
+**Breaking changes:**
+
+- Set default exclude paths [\#181](https://github.com/voxpupuli/puppet-syntax/pull/181) ([bastelfreak](https://github.com/bastelfreak))
+- Enable Hiera syntax check [\#167](https://github.com/voxpupuli/puppet-syntax/pull/167) ([bastelfreak](https://github.com/bastelfreak))
+
+**Implemented enhancements:**
+
+- Detect Hiera files that are not valid hashes [\#184](https://github.com/voxpupuli/puppet-syntax/pull/184) ([bastelfreak](https://github.com/bastelfreak))
+- CI: Switch to voxpupuli/ruby-version@v1 & Add Ruby 3.4 support [\#180](https://github.com/voxpupuli/puppet-syntax/pull/180) ([bastelfreak](https://github.com/bastelfreak))
+
+**Merged pull requests:**
+
+- Drop unused pry & rb-readline dev dependencies [\#182](https://github.com/voxpupuli/puppet-syntax/pull/182) ([bastelfreak](https://github.com/bastelfreak))
+- Cleanup Rakefile; remove legacy tasks [\#173](https://github.com/voxpupuli/puppet-syntax/pull/173) ([bastelfreak](https://github.com/bastelfreak))
+
+## [v4.1.1](https://github.com/voxpupuli/puppet-syntax/tree/v4.1.1) (2024-04-04)
+
+[Full Changelog](https://github.com/voxpupuli/puppet-syntax/compare/v4.1.0...v4.1.1)
+
+**Fixed bugs:**
+
+- fix too greedy regular expression [\#171](https://github.com/voxpupuli/puppet-syntax/pull/171) ([tmu-sprd](https://github.com/tmu-sprd))
+
 ## [v4.1.0](https://github.com/voxpupuli/puppet-syntax/tree/v4.1.0) (2024-03-12)
 
 [Full Changelog](https://github.com/voxpupuli/puppet-syntax/compare/v4.0.1...v4.1.0)

data/Gemfile

@@ -20,6 +20,11 @@ gemspec
 # Override gemspec for CI matrix builds.
 # But only if the environment variable is set
 gem 'puppet', *location_for(ENV['PUPPET_VERSION']) if ENV['PUPPET_VERSION']
+# Puppet on Ruby 3.3 / 3.4 has some missing dependencies
+gem 'base64', '~> 0.2' if RUBY_VERSION >= '3.4'
+gem 'getoptlong', '~> 0.2' if RUBY_VERSION >= '3.4'
+gem 'racc', '~> 1.8' if RUBY_VERSION >= '3.3'
+gem 'syslog', '~> 0.3' if RUBY_VERSION >= '3.4'
 
 group :test do
   gem 'rspec'

data/Rakefile

@@ -1,12 +1,6 @@
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new('spec')
 
-task :publish_gem do
-  require 'gem_publisher'
-  gem = GemPublisher.publish_if_updated('puppet-syntax.gemspec', :rubygems)
-  puts "Published #{gem}" if gem
-end
-
 task default: [:spec]
 begin
   require 'github_changelog_generator/task'
@@ -23,12 +17,7 @@ rescue LoadError
 end
 
 begin
-  require 'rubocop/rake_task'
+  require 'voxpupuli/rubocop/rake'
 rescue LoadError
-  # RuboCop is an optional group
-else
-  RuboCop::RakeTask.new(:rubocop) do |task|
-    # These make the rubocop experience maybe slightly less terrible
-    task.options = ['--display-cop-names', '--display-style-guide', '--extra-details']
-  end
+  # the voxpupuli-rubocop gem is optional
 end

data/lib/puppet-syntax/hiera.rb

@@ -92,6 +92,11 @@ module PuppetSyntax
         end
         next unless yamldata
 
+        unless yamldata.is_a?(Hash)
+          errors << "ERROR: #{hiera_file} doesn't contain a valid Hash, datatype is #{yamldata.class}"
+          next
+        end
+
         yamldata.each do |k, v|
           if PuppetSyntax.check_hiera_keys
             key_msg = check_hiera_key(k)
@@ -122,7 +127,7 @@ module PuppetSyntax
     # You can do string concatenation outside of {}:
     # "%{lookup('this_is_ok')}:3306"
     def check_broken_function_call(element)
-      'string after a function call but before `}` in the value' if element.is_a?(String) && /%{.+\('.*'\).+}/.match?(element)
+      'string after a function call but before `}` in the value' if element.is_a?(String) && /%{[^}]+\('[^}]*'\)[^}\s]+}/.match?(element)
     end
 
     # gets a hash or array, returns all keys + values as array

data/lib/puppet-syntax/templates.rb

@@ -69,14 +69,10 @@ module PuppetSyntax
 
       begin
         template = File.read(filename)
-        erb = if RUBY_VERSION >= '2.6'
-                ERB.new(template, trim_mode: '-')
-              else
-                ERB.new(template, trim_mode: '-')
-              end
+        erb = ERB.new(template, trim_mode: '-')
         erb.filename = filename
         erb.result
-      rescue NameError => e
+      rescue NameError
         # This is normal because we don't have the variables that would
         # ordinarily be bound by the parent Puppet manifest.
       rescue TypeError

data/lib/puppet-syntax/version.rb

@@ -1,3 +1,3 @@
 module PuppetSyntax
-  VERSION = '4.1.0'
+  VERSION = '5.0.0'
 end

data/lib/puppet-syntax.rb

@@ -5,7 +5,12 @@ module PuppetSyntax
   autoload :Manifests, 'puppet-syntax/manifests'
   autoload :Templates, 'puppet-syntax/templates'
 
-  @exclude_paths = []
+  @exclude_paths = [
+    'spec/fixtures/**/*',
+    'pkg/**/*',
+    'vendor/**/*',
+    '.vendor/**/*',
+  ]
   @hieradata_paths = [
     '**/data/**/*.*{yaml,yml}',
     'hieradata/**/*.*{yaml,yml}',
@@ -19,8 +24,8 @@ module PuppetSyntax
     '**/templates/**/*.epp',
   ]
   @fail_on_deprecation_notices = true
-  @check_hiera_keys = false
-  @check_hiera_data = false
+  @check_hiera_keys = true
+  @check_hiera_data = true
 
   class << self
     attr_accessor :exclude_paths,

data/puppet-syntax.gemspec

@@ -21,8 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'puppet', '>= 7', '< 9'
   spec.add_dependency 'rake', '~> 13.1'
 
-  spec.add_development_dependency 'pry', '~> 0.14.2'
-  spec.add_development_dependency 'rb-readline', '~> 0.5.5'
-
-  spec.add_development_dependency 'voxpupuli-rubocop', '~> 2.5.0'
+  spec.add_development_dependency 'voxpupuli-rubocop', '~> 3.1.0'
 end

data/spec/fixtures/hiera/hiera_badkey.yaml

@@ -3,6 +3,7 @@ this_is_ok: 0
 this_is_ok::too: 0
 th1s_is_ok::two3: 0
 :eventhis: 0
+this_is_ok::concat_func: "%{lookup('foo')}%{lookup('bar')}"
 
 typical:typo::warning1:   true
 ::notsotypical::warning2: true
@@ -15,3 +16,4 @@ this_is::warning7:
   - "%{lookup('foobar'):3306}"
 this_is::warning8:
   foo: "%{lookup('foobar'):3306}"
+this_is::warning9: "%{lookup('foo'):3306}%{lookup('bar')}"

data/spec/fixtures/hiera/hiera_key_no_value.yaml

@@ -0,0 +1,2 @@
+prometheus::initstyle:sysv
+prometheus::node_exporter::init_style:sysv

data/spec/fixtures/test_module/templates/fail_error.erb

@@ -1,3 +1,3 @@
 This is plain text
-<% This is not valid Ruby %>
+<% This is not valid Ruby( %>
 This is also plain text

data/spec/puppet-syntax/hiera_spec.rb

@@ -21,6 +21,14 @@ describe PuppetSyntax::Hiera do
     expect(res.first).to match(expected)
   end
 
+  it 'returns warnings on malformed keys' do
+    files = fixture_hiera('hiera_key_no_value.yaml')
+    expected = /ERROR: #{files[0]} doesn't contain a valid Hash, datatype is/
+    res = subject.check(files)
+    expect(res.size).to eq 1
+    expect(res.first).to match(expected)
+  end
+
   context 'check_hiera_keys = true' do
     before do
       PuppetSyntax.check_hiera_keys = true
@@ -29,7 +37,7 @@ describe PuppetSyntax::Hiera do
 
     it 'returns warnings for invalid keys' do
       hiera_yaml = 'hiera_badkey.yaml'
-      examples = 8
+      examples = 9
       files = fixture_hiera(hiera_yaml)
       res = subject.check(files)
       (1..examples).each do |n|
@@ -44,6 +52,7 @@ describe PuppetSyntax::Hiera do
       expect(res[5]).to match('Key :this_is::warning6: string after a function call but before `}` in the value')
       expect(res[6]).to match('Key :this_is::warning7: string after a function call but before `}` in the value')
       expect(res[7]).to match('Key :this_is::warning8: string after a function call but before `}` in the value')
+      expect(res[8]).to match('Key :this_is::warning9: string after a function call but before `}` in the value')
     end
 
     it 'returns warnings for bad eyaml values' do

data/spec/puppet-syntax/tasks/puppet-syntax_spec.rb

@@ -9,30 +9,45 @@ known_yaml_subdir = 'spec/fixtures/hiera/data/test/hiera_3.yaml'
 known_eyaml_subdir = 'spec/fixtures/hiera/data/test/hiera_4.eyaml'
 
 describe 'PuppetSyntax rake tasks' do
-  it 'filters directories' do
-    list = PuppetSyntax::RakeTask.new.filelist(['**/lib', known_pp])
-    expect(list.count).to eq 1
-    expect(list).to include(known_pp)
+  describe 'with default excludes' do
+    it 'filters directories' do
+      list = PuppetSyntax::RakeTask.new.filelist(['**/lib', known_pp])
+      expect(list.count).to eq 0
+      expect(list).not_to include(known_pp)
+    end
   end
 
-  it 'generates FileList of manifests relative to Rakefile' do
-    list = PuppetSyntax::RakeTask.new.filelist_manifests
-    expect(list).to include(known_pp)
-    expect(list.count).to eq 9
-  end
+  describe 'with custom excludes' do
+    before do
+      list = PuppetSyntax.exclude_paths
+      PuppetSyntax.exclude_paths = list - ['spec/fixtures/**/*']
+    end
 
-  it 'generates FileList of templates relative to Rakefile' do
-    list = PuppetSyntax::RakeTask.new.filelist_templates
-    expect(list).to include(known_erb)
-    expect(list.count).to eq 9
-  end
+    it 'filters directories' do
+      list = PuppetSyntax::RakeTask.new.filelist(['**/lib', known_pp])
+      expect(list.count).to eq 1
+      expect(list).to include(known_pp)
+    end
+
+    it 'generates FileList of manifests relative to Rakefile' do
+      list = PuppetSyntax::RakeTask.new.filelist_manifests
+      expect(list).to include(known_pp)
+      expect(list.count).to eq 9
+    end
+
+    it 'generates FileList of templates relative to Rakefile' do
+      list = PuppetSyntax::RakeTask.new.filelist_templates
+      expect(list).to include(known_erb)
+      expect(list.count).to eq 9
+    end
 
-  it 'generates FileList of Hiera yaml files relative to Rakefile' do
-    list = PuppetSyntax::RakeTask.new.filelist_hiera_yaml
-    expect(list).to include(known_yaml)
-    expect(list).to include(known_eyaml)
-    expect(list).to include(known_yaml_subdir)
-    expect(list).to include(known_eyaml_subdir)
-    expect(list.count).to eq 4
+    it 'generates FileList of Hiera yaml files relative to Rakefile' do
+      list = PuppetSyntax::RakeTask.new.filelist_hiera_yaml
+      expect(list).to include(known_yaml)
+      expect(list).to include(known_eyaml)
+      expect(list).to include(known_yaml_subdir)
+      expect(list).to include(known_eyaml_subdir)
+      expect(list.count).to eq 4
+    end
   end
 end

data/spec/puppet-syntax/templates_spec.rb

@@ -3,11 +3,8 @@ require 'spec_helper'
 describe PuppetSyntax::Templates do
   let(:subject) { PuppetSyntax::Templates.new }
   let(:conditional_warning_regex) do
-    if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.6.0')
-      /2: warning: found `= literal' in conditional/
-    else
-      /2: warning: found = in conditional/
-    end
+    # ruby 3.4 uses '= ,ruby 2.6 to 3.3 uses `=
+    /2: warning: found [`']= literal' in conditional/
   end
 
   it 'expects an array of files' do
@@ -35,7 +32,7 @@ describe PuppetSyntax::Templates do
     res = subject.check(files)
 
     expect(res[:errors].size).to eq(1)
-    expect(res[:errors][0]).to match(/2: syntax error, unexpected/)
+    expect(res[:errors][0]).to match(/2: syntax error/)
   end
 
   it 'catches Ruby warnings' do
@@ -60,7 +57,7 @@ describe PuppetSyntax::Templates do
 
     expect(res[:warnings].size).to eq(1)
     expect(res[:errors].size).to eq(1)
-    expect(res[:errors][0]).to match(/2: syntax error, unexpected/)
+    expect(res[:errors][0]).to match(/2: syntax error/)
     expect(res[:warnings][0]).to match(conditional_warning_regex)
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-syntax
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Vox Pupuli
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-12 00:00:00.000000000 Z
+date: 2025-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet
@@ -44,48 +44,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.1'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.14.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.14.2
-- !ruby/object:Gem::Dependency
-  name: rb-readline
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.5
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.5
 - !ruby/object:Gem::Dependency
   name: voxpupuli-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 3.1.0
 description: Syntax checks for Puppet manifests and templates
 email:
 - voxpupuli@groups.io
@@ -121,6 +93,7 @@ files:
 - spec/fixtures/hiera/hiera_badkey.yaml
 - spec/fixtures/hiera/hiera_good.yaml
 - spec/fixtures/hiera/hiera_key_empty.yaml
+- spec/fixtures/hiera/hiera_key_no_value.yaml
 - spec/fixtures/test_module/manifests/deprecation_notice.pp
 - spec/fixtures/test_module/manifests/fail_error.pp
 - spec/fixtures/test_module/manifests/fail_warning.pp
@@ -150,7 +123,7 @@ homepage: https://github.com/voxpupuli/puppet-syntax
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -165,8 +138,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key: 
+rubygems_version: 3.3.27
+signing_key:
 specification_version: 4
 summary: Syntax checks for Puppet manifests, templates, and Hiera YAML
 test_files: []