puppet-check 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5c74c1af6aee54ad5dcfd3eeefa459ed9fd5eaaafdc847f346a8e3674ffb362
-  data.tar.gz: c11db9238470434a489608d62360d12fe1ff10dda29627a05cdded940785b992
+  metadata.gz: 1a0fcb7ee7b05692747da7d0449b6bd442c3078311c0bcbd2e25bd56e491decd
+  data.tar.gz: 6ef3744b4c7a008c2a3042fd41b9bddc5f3dd236322180a8ff8cbc51df870b87
 SHA512:
-  metadata.gz: 12416f0a0d2d2615c467645cb238e0b14be8f42c9172e5adf7acf3bfbdddbdae1d5b08ccd2a967dcb7b6af41a8149f2e30e22ed5d0db97c5f05e586e384c4a61
-  data.tar.gz: 053f4f90842f2d71ccbc82a3b05cd5ef1347af5399686fc3ed4a7cbf824baeee63ad412c1d6261f3640929bdcba789db7e2fe46d7f3e529cf3cd6b1c8b9690d8
+  metadata.gz: 8bdf3f7e6ba85fa4917329314f7f87382940b5e039a49891eb8d789aa57861d0e91b9f63b0d2a738523ffe1fb056e30842005d0f1bc06312859420ac9df1986e
+  data.tar.gz: 01f4cd1102f300ffa35b4943c8426b2e91db54b68bfb439489b4f88efce58248abd8839d738681cc2f6c2d55c46241aed13ff455cc2eb059374b3c6589c137b5

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### 2.5.0
+- Minimum Ruby version increased to 3.1.
+- Minimum Puppet-Lint increased to 5.0.
+- Restore ERB validation mock Ruby binding.
+- Update Reek API usage.
+- Ensure `rubocop-rspec` plugin only loaded for spec files.
+
 ### 2.4.0
 - Minimum Ruby version increased to 3.0.
 - Fix `rubocop-performance` inclusion warning.

data/README.md

@@ -331,6 +331,4 @@ To overcome the lack of convenient portability, you could try spinning up the Va
 ## Contributing
 Code should pass all spec tests. New features should involve new spec tests. Adherence to Rubocop and Reek is expected where not overly onerous or where the check is of dubious cost/benefit.
 
-A [Dockerfile](Dockerfile) is provided for easy rake testing. A [Vagrantfile](Vagrantfile) is provided for easy gem building, installation, and post-installation testing.
-
 Please consult the GitHub Project for the current development roadmap.

data/lib/puppet-check/ruby_parser.rb

@@ -10,7 +10,6 @@ class RubyParser
       require 'json'
       require 'rubocop'
       require 'reek'
-      require 'reek/cli/application'
 
       rubocop_cli = RuboCop::CLI.new
     end
@@ -23,13 +22,16 @@ class RubyParser
     else
       # check ruby style
       if style
+        # add rubocop rspec plugin if the file is a spec
+        rc_args.push('--plugin', 'rubocop-rspec') if file =~ /_spec\.rb$/
+
         # check RuboCop and parse warnings' JSON output
-        rubocop_warnings = Utils.capture_stdout { rubocop_cli.run(rc_args + ['--enable-pending-cops', '--plugin', 'rubocop-performance', '--plugin', 'rubocop-rspec', '--format', 'json', file]) }
+        rubocop_warnings = Utils.capture_stdout { rubocop_cli.run(rc_args + ['--enable-pending-cops', '--plugin', 'rubocop-performance', '--format', 'json', file]) }
         rubocop_offenses = JSON.parse(rubocop_warnings)['files'][0]['offenses'].map { |warning| "#{warning['location']['line']}:#{warning['location']['column']} #{warning['message']}" }
 
-        # check Reek and parse warnings' JSON output
-        reek_warnings = Utils.capture_stdout { Reek::CLI::Application.new(['-f', 'json', file]).execute }
-        reek_offenses = JSON.parse(reek_warnings).map { |warning| "#{warning['lines'].join(',')}: #{warning['context']} #{warning['message']}" }
+        # check Reek using examiner api
+        examiner = Reek::Examiner.new(Pathname.new(file))
+        reek_offenses = examiner.smells.map { |warning| "#{warning.lines.join(',')}: #{warning.context} #{warning.message}" }
 
         # assign warnings from combined offenses
         warnings = rubocop_offenses + reek_offenses
@@ -48,10 +50,7 @@ class RubyParser
     files.each do |file|
       # check ruby template syntax
       begin
-        # need to eventually have this associated with a different binding during each iteration
-        # older usage throws extra warning and mixes with valid warnings confusingly
-        warnings = Utils.capture_stderr { ERB.new(File.read(file), trim_mode: '-').result }
-        # warnings = ERB.new(File.read(file), trim_mode: '-').result(RubyParser.new.bind)
+        warnings = Utils.capture_stderr { ERB.new(File.read(file), trim_mode: '-').result(Object.new.instance_eval { binding }) }
       rescue NameError, TypeError
         # empty out warnings since it would contain an error if this pass triggers
         warnings = ''
@@ -79,8 +78,7 @@ class RubyParser
 
     files.each do |file|
       # check librarian puppet syntax
-      # prevents ruby code from actually executing the input ruby file
-      catch(:good) { instance_eval("BEGIN {throw :good}; #{File.read(file)} # BEGIN {throw :good}; ruby_file_content", file) }
+      RubyVM::InstructionSequence.compile_file(file)
     rescue SyntaxError, LoadError, ArgumentError => err
       PuppetCheck.files[:errors][file] = err.to_s.gsub("#{file}:", '').split("\n")
     # check librarian puppet style
@@ -95,9 +93,4 @@ class RubyParser
       PuppetCheck.files[:clean].push(file.to_s)
     end
   end
-
-  # potentially for unique erb bindings
-  def bind
-    binding
-  end
 end

data/puppet-check.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = 'puppet-check'
-  spec.version       = '2.4.0'
+  spec.version       = '2.5.0'
   spec.authors       = ['Matt Schuchard']
   spec.description   = 'Puppet Check is a gem that provides a comprehensive, streamlined, and efficient analysis of the syntax, style, and validity of your entire Puppet code and data.'
   spec.summary       = 'A streamlined comprehensive set of checks for your entire Puppet code and data'
@@ -11,9 +11,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |file| File.basename(file) }
   spec.require_paths = Dir['lib']
 
-  spec.required_ruby_version = '>= 3.0.0'
+  spec.required_ruby_version = '>= 3.1.0'
   spec.add_dependency 'puppet', '>= 5.5', '< 9'
-  spec.add_dependency 'puppet-lint', '~> 4.0'
+  spec.add_dependency 'puppet-lint', '~> 5.0'
   spec.add_dependency 'reek', '~> 6.0'
   spec.add_dependency 'rubocop', '~> 1.72'
   spec.add_dependency 'rubocop-performance', '~> 1.0'

data/spec/puppet-check/cli_spec.rb

@@ -5,7 +5,7 @@ describe PuppetCheck::CLI do
   context '.run' do
     it 'targets the current working directory if no paths were specified' do
       expect { PuppetCheck::CLI.run(%w[--fail-on-warnings]) }.not_to raise_exception
-      expect(PuppetCheck.files[:clean].length).to eql(30)
+      expect(PuppetCheck.files[:clean].length).to eql(29)
       if ci_env
         expect(PuppetCheck.files[:ignored].length).to eql(8)
       else

data/spec/puppet-check/ruby_parser_spec.rb

@@ -24,7 +24,7 @@ describe RubyParser do
       expect(PuppetCheck.files[:errors]).to eql({})
       expect(PuppetCheck.files[:warnings].keys).to eql(["#{fixtures_dir}lib/style.rb"])
       unless ci_env
-        expect(PuppetCheck.files[:warnings]["#{fixtures_dir}lib/style.rb"].join("\n")).to match(/Useless assignment.*\n.*Use the new.*\n.*Do not introduce.*\n.*Prefer single.*\n.*Remove unnecessary empty.*\n.*Source code comment is empty.*\n.*is a writable attribute.*\n.*Issue has no descriptive comment/)
+        expect(PuppetCheck.files[:warnings]["#{fixtures_dir}lib/style.rb"].length).to eql(8)
       else
         expect(PuppetCheck.files[:warnings]["#{fixtures_dir}lib/style.rb"].join("\n")).to match(/Useless assignment.*\n.*Use the new.*\n.*Do not introduce.*\n.*Prefer single.*\n.*Remove unnecessary empty.*\n.*Source code comment is empty/)
       end

data/spec/puppet_check_spec.rb

@@ -72,6 +72,7 @@ describe PuppetCheck do
     before(:each) { Dir.chdir(fixtures_dir) }
 
     let(:no_files) { PuppetCheck.send(:parse_paths, %w[foo bar baz]) }
+    let(:mixed_files) { PuppetCheck.send(:parse_paths, %w[foo lib/good.rb]) }
     let(:file) { PuppetCheck.send(:parse_paths, ['lib/good.rb']) }
     let(:dir) { PuppetCheck.send(:parse_paths, ['.']) }
     let(:multi_dir) { PuppetCheck.send(:parse_paths, %w[hieradata lib manifests]) }
@@ -81,6 +82,11 @@ describe PuppetCheck do
       expect { no_files }.to raise_error(RuntimeError, 'puppet-check: no files found in supplied paths \'foo, bar, baz\'.')
     end
 
+    it 'warns on invalid path and correctly parses a valid file path' do
+      expect { mixed_files }.to output("puppet-check: foo is not a directory, file, or symlink, and will not be considered during parsing\n").to_stderr
+      expect(mixed_files[0]).to eql('lib/good.rb')
+    end
+
     it 'correctly parses one file and returns it' do
       expect(file[0]).to eql('lib/good.rb')
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-check
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Matt Schuchard
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-18 00:00:00.000000000 Z
+date: 2026-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
@@ -221,7 +221,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="