puppet-lint 5.0.0 → 5.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f8119856eb91c58047532aa02757d8b4904120ad6401a3af2b385a1a40aa321
-  data.tar.gz: 870ad4f57b3c1dfcf40207af7a84d5afc18ec388bb520e362e6d8bafbd647205
+  metadata.gz: 52a7cadacf8d637032f1ffb76f773566a7f3be3cd9a19fd1fbdbac69c2a68204
+  data.tar.gz: 9d8272950c1abfb41d078bec0c0909a9ae8d8ff66a01019f7908319baf651152
 SHA512:
-  metadata.gz: 76294db75e44acc05da97c12f26f5dae32d358e4b0e254c92bda9a0d3f9948d0e07b2d6a6e615e238457214ea85f22e2d499e15184ad1b747665d63d667bdc80
-  data.tar.gz: 5d2402a687836436ceb7a63d7510d28acb6e594a399d2904cc2a2215d14971b006642cfb8a89365833af5a7307c08e44759e980870bd75e828944920e5149bc3
+  metadata.gz: f84a46b9cc61045fd3239f1e00aeda2d6d5ed1c7f68035782763be817b0d696fa829364610ea94389485f05ccf289745a8a58ead975504c2626a431747034272
+  data.tar.gz: 3a75d2e340d8753dc9ec901b8dd183c20847bc70101c08d435ecceb2d956214c8f6704c7fa81072758b3b31fd8fcc8bd79b8c83adc3b61a5a6d34a651feb341a

data/lib/puppet-lint/bin.rb

@@ -90,9 +90,7 @@ class PuppetLint::Bin
 
         return_val = 1 if l.errors? || (l.warnings? && PuppetLint.configuration.fail_on_warnings)
 
-        next unless PuppetLint.configuration.fix && l.problems.none? { |r| r[:check] == :syntax }
-
-        File.binwrite(f, l.manifest)
+        l.write_fixes if PuppetLint.configuration.fix
       end
 
       if PuppetLint.configuration.sarif

data/lib/puppet-lint/checkplugin.rb

@@ -55,7 +55,9 @@ class PuppetLint::CheckPlugin
   #
   # Returns an Array of PuppetLint::Lexer::Token objects.
   def tokens
-    PuppetLint::Data.tokens
+    # When called from a plugins `check` method, the tokens array returned should be a (shallow) copy
+    called_from_check = (caller_locations(1..1).first.base_label == 'check')
+    PuppetLint::Data.tokens(duplicate: called_from_check)
   end
 
   def add_token(index, token)

data/lib/puppet-lint/data.rb

@@ -38,37 +38,14 @@ class PuppetLint::Data
       @defaults_indexes = nil
     end
 
-    # @api private
-    def ruby1?
-      @ruby1 = RbConfig::CONFIG['MAJOR'] == '1' if @ruby1.nil?
-      @ruby1
-    end
-
     # Get the tokenised manifest.
     #
+    # @param duplicate [Boolean] if true, returns a duplicate of the token array.
     # @return [Array[PuppetLint::Lexer::Token]]
     #
     # @api public
-    def tokens
-      calling_method = if ruby1?
-                         begin
-                           caller[0][%r{`.*'}][1..-2] # rubocop:disable Performance/Caller
-                         rescue NoMethodError
-                           caller[1][%r{`.*'}][1..-2] # rubocop:disable Performance/Caller
-                         end
-                       else
-                         begin
-                           caller(0..0).first[%r{`.*'}][1..-2]
-                         rescue NoMethodError
-                           caller(1..1).first[%r{`.*'}][1..-2]
-                         end
-                       end
-
-      if calling_method == 'check'
-        @tokens.dup
-      else
-        @tokens
-      end
+    def tokens(duplicate: false)
+      duplicate ? @tokens.dup : @tokens
     end
 
     # Add new token.

data/lib/puppet-lint/version.rb

@@ -1,3 +1,3 @@
 class PuppetLint
-  VERSION = '5.0.0'.freeze
+  VERSION = '5.1.1'.freeze
 end

data/lib/puppet-lint.rb

@@ -235,6 +235,42 @@ class PuppetLint
     report(@problems)
   end
 
+  # Public: Write fixes back to the file if this file type supports fixes.
+  #
+  # Returns nothing.
+  def write_fixes
+    return unless should_write_fixes?
+
+    File.binwrite(@path, @manifest)
+  end
+
+  # Internal: Determine if fixes should be written for this file.
+  #
+  # Returns true if all conditions are met for writing fixes, false otherwise.
+  def should_write_fixes?
+    # Don't write if file type doesn't support fixes
+    return false unless supports_fixes?
+
+    # Don't write if there are syntax errors (can't safely fix)
+    return false if @problems&.any? { |r| r[:check] == :syntax }
+
+    # Don't write if there's no manifest content
+    return false if @manifest.nil? || @manifest.empty?
+
+    true
+  end
+
+  # Public: Determine if this file type supports automatic fixes.
+  #
+  # Returns true if fixes are supported for this file type, false otherwise.
+  def supports_fixes?
+    return false if @path.nil?
+
+    # Only .pp files support fixes currently
+    # YAML files and other types may support fixes in the future
+    File.extname(@path).match?(%r{\.pp$}i)
+  end
+
   # Public: Define a new check.
   #
   # name  - A unique name for the check as a Symbol.

data/spec/fixtures/test/manifests/issue_254_overwriting_yaml/class_with_dash.pp

@@ -0,0 +1,3 @@
+class foo-bar {
+  notify { 'hello': }
+}

data/spec/fixtures/test/manifests/issue_254_overwriting_yaml/class_with_dash.yaml

@@ -0,0 +1,7 @@
+---
+classes:
+  foo-bar:
+    parameters: []
+    resources:
+      notify:
+        - title: hello

data/spec/unit/puppet-lint/bin_spec.rb

@@ -615,9 +615,27 @@ describe PuppetLint::Bin do
     end
   end
 
+  context 'when fixing a directory containing both .pp and .yaml files' do
+    let(:args) { ['--fix', 'spec/fixtures/test/manifests/issue_254_overwriting_yaml'] }
+
+    its(:exitstatus) { is_expected.to eq(1) }
+
+    it 'does not overwrite YAML files' do
+      yaml_file = 'spec/fixtures/test/manifests/issue_254_overwriting_yaml/class_with_dash.yaml'
+      original_yaml = File.read(yaml_file)
+
+      bin # Run the command
+
+      yaml_after = File.read(yaml_file)
+      expect(yaml_after).to eq(original_yaml)
+      expect(yaml_after).to include('classes:')
+      expect(yaml_after).not_to include('class foo-bar {')
+    end
+  end
+
   context 'when overriding config file options with command line options' do
     context 'and config file sets "--only-checks=variable_contains_dash"' do
-      around(:context) do |example|
+      around(:each) do |example|
         Dir.mktmpdir do |tmpdir|
           Dir.chdir(tmpdir) do
             File.open('.puppet-lint.rc', 'wb') do |f|

data/spec/unit/puppet-lint/checkplugin_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+class DummyCheckPlugin < PuppetLint::CheckPlugin
+  def check
+    # Since we're calling `tokens` from a `check` method, we should get our own Array object.
+    # If we add an extra token to it, PuppetLint::Data.tokens should remain unchanged.
+    tokens << :extra_token
+  end
+
+  def fix
+    tokens << :fix_token
+  end
+end
+
+describe PuppetLint::CheckPlugin do
+  before(:each) do
+    PuppetLint::Data.tokens = [:token1, :token2, :token3]
+  end
+
+  it 'returns a duplicate of the token array when called from check' do
+    plugin = DummyCheckPlugin.new
+
+    plugin.check
+
+    # Verify that the global token array remains unchanged.
+    expect(PuppetLint::Data.tokens).to eq([:token1, :token2, :token3])
+  end
+
+  it 'other methods can modify the tokens array' do
+    plugin = DummyCheckPlugin.new
+
+    plugin.fix
+
+    expect(PuppetLint::Data.tokens).to eq([:token1, :token2, :token3, :fix_token])
+  end
+end

data/spec/unit/puppet-lint/puppet-lint_spec.rb

@@ -15,4 +15,53 @@ describe PuppetLint do
     linter.run
     expect(linter.manifest).to eq('')
   end
+
+  describe '#supports_fixes?' do
+    context 'with a .pp file' do
+      it 'returns true' do
+        linter.instance_variable_set(:@path, 'test.pp')
+        expect(linter.supports_fixes?).to be true
+      end
+    end
+
+    context 'with a .yaml file' do
+      it 'returns false' do
+        linter.instance_variable_set(:@path, 'test.yaml')
+        expect(linter.supports_fixes?).to be false
+      end
+    end
+
+    context 'with no path set' do
+      it 'returns false' do
+        expect(linter.supports_fixes?).to be false
+      end
+    end
+  end
+
+  describe '#should_write_fixes?' do
+    before(:each) do
+      linter.instance_variable_set(:@path, 'test.pp')
+      linter.instance_variable_set(:@manifest, 'class test { }')
+    end
+
+    context 'when file supports fixes and has no syntax errors' do
+      it 'returns true' do
+        expect(linter.should_write_fixes?).to be true
+      end
+    end
+
+    context 'when file has syntax errors' do
+      it 'returns false' do
+        linter.instance_variable_set(:@problems, [{ check: :syntax }])
+        expect(linter.should_write_fixes?).to be false
+      end
+    end
+
+    context 'when file type does not support fixes' do
+      it 'returns false' do
+        linter.instance_variable_set(:@path, 'test.yaml')
+        expect(linter.should_write_fixes?).to be false
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.1
 platform: ruby
 authors:
 - Tim Sharpe
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-09-23 00:00:00.000000000 Z
+date: 2025-11-06 00:00:00.000000000 Z
 dependencies: []
 description: "    Checks your Puppet manifests against the Puppetlabs style guide
   and alerts you to any discrepancies.\n"
@@ -92,6 +92,8 @@ files:
 - spec/fixtures/test/manifests/ignore_multiple_line.pp
 - spec/fixtures/test/manifests/ignore_reason.pp
 - spec/fixtures/test/manifests/init.pp
+- spec/fixtures/test/manifests/issue_254_overwriting_yaml/class_with_dash.pp
+- spec/fixtures/test/manifests/issue_254_overwriting_yaml/class_with_dash.yaml
 - spec/fixtures/test/manifests/malformed.pp
 - spec/fixtures/test/manifests/mismatched_control_comment.pp
 - spec/fixtures/test/manifests/parseable.yaml
@@ -105,6 +107,7 @@ files:
 - spec/spec_helper_acceptance.rb
 - spec/spec_helper_acceptance_local.rb
 - spec/unit/puppet-lint/bin_spec.rb
+- spec/unit/puppet-lint/checkplugin_spec.rb
 - spec/unit/puppet-lint/checks_spec.rb
 - spec/unit/puppet-lint/configuration_spec.rb
 - spec/unit/puppet-lint/data_spec.rb