Merge branch 'main' into space_before_arrow

Author: gerases

.github/workflows/ci.yml

@@ -1,11 +1,17 @@
 name: "ci"
 
 on:
+  push:
+    branches:
+      - "main"
   pull_request:
     branches:
       - "main"
   workflow_dispatch:
 
+env:
+  CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
 jobs:
 
   spec:
@@ -19,6 +25,7 @@ jobs:
     uses: "puppetlabs/cat-github-actions/.github/workflows/gem_ci.yml@main"
     secrets: "inherit"
     with:
+      rake_task: "spec:coverage"
       ruby_version: ${{ matrix.ruby_version }}
 
   acceptance:

.github/workflows/mend.yml

@@ -1,9 +1,10 @@
 name: "mend"
 
 on:
-  pull_request:
-    branches:
-      - "main"
+  pull_request_target:
+    types:
+      - opened
+      - synchronize
   schedule:
     - cron: "0 0 * * *"
   workflow_dispatch:

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-09-12 15:54:37 UTC using RuboCop version 1.48.1.
+# on 2024-01-22 14:59:34 UTC using RuboCop version 1.50.2.
 # 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
@@ -50,7 +50,7 @@ Metrics/BlockLength:
 Metrics/BlockNesting:
   Max: 5
 
-# Offense count: 7
+# Offense count: 8
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
   Max: 387
@@ -92,7 +92,7 @@ Performance/CollectionLiteralInLoop:
     - 'lib/puppet-lint/plugins/check_resources/ensure_first_param.rb'
     - 'lib/puppet-lint/plugins/check_whitespace/trailing_whitespace.rb'
 
-# Offense count: 408
+# Offense count: 409
 # Configuration parameters: Prefixes, AllowedPatterns.
 # Prefixes: when, with, without
 RSpec/ContextWording:
@@ -108,7 +108,7 @@ RSpec/DescribeClass:
 RSpec/ExampleLength:
   Max: 148
 
-# Offense count: 138
+# Offense count: 119
 RSpec/MultipleExpectations:
   Max: 137
 

CHANGELOG.md

@@ -5,12 +5,29 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org).
 
-## [v5.0.0](https://github.com/puppetlabs/puppet-lint/tree/v5.0.0) - 2023-10-18
+## [v4.2.4](https://github.com/puppetlabs/puppet-lint/tree/v4.2.4) - 2024-02-09
 
-[Full Changelog](https://github.com/puppetlabs/puppet-lint/compare/v4.2.1...v5.0.0)
+[Full Changelog](https://github.com/puppetlabs/puppet-lint/compare/v4.2.3...v4.2.4)
 
-### Changed
-- (CAT-1248) Update Published Name and Owner [#158](https://github.com/puppetlabs/puppet-lint/pull/158) ([david22swan](https://github.com/david22swan))
+### Fixed
+
+- (GH-189) - invalid fact correction for top scope structured fact [#190](https://github.com/puppetlabs/puppet-lint/pull/190) ([jordanbreen28](https://github.com/jordanbreen28))
+
+## [v4.2.3](https://github.com/puppetlabs/puppet-lint/tree/v4.2.3) - 2023-11-22
+
+[Full Changelog](https://github.com/puppetlabs/puppet-lint/compare/v4.2.2...v4.2.3)
+
+### Fixed
+
+- (maint) - Update redundant description [#179](https://github.com/puppetlabs/puppet-lint/pull/179) ([jordanbreen28](https://github.com/jordanbreen28))
+
+## [v4.2.2](https://github.com/puppetlabs/puppet-lint/tree/v4.2.2) - 2023-11-21
+
+[Full Changelog](https://github.com/puppetlabs/puppet-lint/compare/v4.2.1...v4.2.2)
+
+### Fixed
+
+- Use better yardoc tags [#172](https://github.com/puppetlabs/puppet-lint/pull/172) ([ekohl](https://github.com/ekohl))
 
 ## [v4.2.1](https://github.com/puppetlabs/puppet-lint/tree/v4.2.1) - 2023-10-09
 

Gemfile

@@ -10,8 +10,8 @@ group :test do
   gem 'json'
 
   gem 'rspec-json_expectations', '~> 1.4'
-
-  gem 'simplecov', :require => false if ENV['COVERAGE'] == 'yes'
+  gem 'simplecov', :require => false
+  gem 'simplecov-console', :require => false
 end
 
 group :acceptance do
@@ -29,7 +29,7 @@ group :development do
 end
 
 group :rubocop do
-    gem 'rubocop', '~> 1.48.1', require: false
+    gem 'rubocop', '~> 1.50.0', require: false
     gem 'rubocop-rspec', '~> 2.19', require: false
     gem 'rubocop-performance', '~> 1.16', require: false
 end

Rakefile

@@ -27,6 +27,14 @@ rescue LoadError
   # Gem not present
 end
 
+namespace :spec do
+  desc 'Run RSpec code examples with coverage collection'
+  task :coverage do
+      ENV['COVERAGE'] = 'yes'
+      Rake::Task['spec'].execute
+  end
+end
+
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.exclude_pattern = 'spec/acceptance/**/*_spec.rb'
 end

lib/puppet-lint.rb

@@ -252,7 +252,7 @@ def print_problems
   #   end
   def self.new_check(name, &block)
     class_name = name.to_s.split('_').map(&:capitalize).join
-    klass = PuppetLint.const_set("Check#{class_name}", Class.new(PuppetLint::CheckPlugin))
+    klass = PuppetLint.const_set(:"Check#{class_name}", Class.new(PuppetLint::CheckPlugin))
     klass.const_set(:NAME, name)
     klass.class_exec(&block)
     PuppetLint.configuration.add_check(name, klass)

lib/puppet-lint/checks.rb

@@ -121,7 +121,7 @@ def run(fileinfo, data)
   # Returns an Array of String check names.
   def enabled_checks
     @enabled_checks ||= PuppetLint.configuration.checks.select do |check|
-      PuppetLint.configuration.send("#{check}_enabled?")
+      PuppetLint.configuration.send(:"#{check}_enabled?")
     end
   end
 

lib/puppet-lint/configuration.rb

@@ -17,21 +17,21 @@ def self.add_check(check)
     # Public: Determine if the named check is enabled.
     #
     # Returns true if the check is enabled, otherwise return false.
-    define_method("#{check}_enabled?") do
+    define_method(:"#{check}_enabled?") do
       settings["#{check}_disabled"] != true
     end
 
     # Public: Disable the named check.
     #
     # Returns nothing.
-    define_method("disable_#{check}") do
+    define_method(:"disable_#{check}") do
       settings["#{check}_disabled"] = true
     end
 
     # Public: Enable the named check.
     #
     # Returns nothing.
-    define_method("enable_#{check}") do
+    define_method(:"enable_#{check}") do
       settings["#{check}_disabled"] = false
     end
   end
@@ -92,7 +92,7 @@ def self.add_option(option)
     # value - The value to set the option to.
     #
     # Returns nothing.
-    define_method("#{option}=") do |value|
+    define_method(:"#{option}=") do |value|
       settings[option] = value
     end
 

lib/puppet-lint/optparser.rb

@@ -117,9 +117,9 @@ def self.build(args = [])
         enable_checks = checks.split(',').map(&:to_sym)
         PuppetLint.configuration.checks.each do |check|
           if enable_checks.include?(check)
-            PuppetLint.configuration.send("enable_#{check}")
+            PuppetLint.configuration.send(:"enable_#{check}")
           else
-            PuppetLint.configuration.send("disable_#{check}")
+            PuppetLint.configuration.send(:"disable_#{check}")
           end
         end
       end
@@ -130,13 +130,13 @@ def self.build(args = [])
 
       PuppetLint.configuration.checks.each do |check|
         opts.on("--no-#{check}-check", "Skip the #{check} check.") do
-          PuppetLint.configuration.send("disable_#{check}")
+          PuppetLint.configuration.send(:"disable_#{check}")
         end
 
-        next if PuppetLint.configuration.send("#{check}_enabled?")
+        next if PuppetLint.configuration.send(:"#{check}_enabled?")
 
         opts.on("--#{check}-check", "Enable the #{check} check.") do
-          PuppetLint.configuration.send("enable_#{check}")
+          PuppetLint.configuration.send(:"enable_#{check}")
         end
       end
     end

lib/puppet-lint/plugins/top_scope_facts/top_scope_facts.rb

@@ -44,6 +44,14 @@ def check
   end
 
   def fix(problem)
-    problem[:token].value = "facts['" + problem[:token].value.sub(%r{^::}, '') + "']"
+    problem[:token].value.sub!(%r{^::}, '')
+    # checks if the fact is a top level structured fact e.g. ::my_structured_fact['foo']['bar']
+    if %r{\[.*}.match?(problem[:token].value)
+      fact_name = problem[:token].value.sub(%r{\[.*}, '')
+      nested_facts = problem[:token].value.scan(%r{\[.*}).first
+      problem[:token].value = "facts['" + fact_name + "']" + nested_facts
+    else
+      problem[:token].value = "facts['" + problem[:token].value + "']"
+    end
   end
 end

lib/puppet-lint/tasks/puppet-lint.rb

@@ -52,19 +52,19 @@ def define(args, &task_block)
         enable_checks = Array(@only_checks).map(&:to_sym)
         PuppetLint.configuration.checks.each do |check|
           if enable_checks.include?(check)
-            PuppetLint.configuration.send("enable_#{check}")
+            PuppetLint.configuration.send(:"enable_#{check}")
           else
-            PuppetLint.configuration.send("disable_#{check}")
+            PuppetLint.configuration.send(:"disable_#{check}")
           end
         end
       end
 
       Array(@disable_checks).each do |check|
-        PuppetLint.configuration.send("disable_#{check}")
+        PuppetLint.configuration.send(:"disable_#{check}")
       end
 
       ['with_filename', 'fail_on_warnings', 'error_level', 'log_format', 'with_context', 'fix', 'show_ignored', 'relative'].each do |config|
-        value = instance_variable_get("@#{config}")
+        value = instance_variable_get(:"@#{config}")
         PuppetLint.configuration.send("#{config}=".to_sym, value) unless value.nil?
       end
 

lib/puppet-lint/version.rb

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

puppet-lint.gemspec

@@ -2,7 +2,7 @@ $LOAD_PATH.push(File.expand_path('lib', __dir__))
 require 'puppet-lint/version'
 
 Gem::Specification.new do |spec|
-  spec.name = 'puppetlabs-puppet-lint'
+  spec.name = 'puppet-lint'
   spec.version = PuppetLint::VERSION.dup
   spec.homepage = 'https://github.com/puppetlabs/puppet-lint/'
   spec.summary = 'Ensure your Puppet manifests conform with the Puppetlabs style guide'
@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
     'Community Contributors',
   ]
   spec.email = [
+    'tim@sharpe.id.au',
     'modules-team@puppet.com',
   ]
   spec.license = 'MIT'

spec/spec_helper.rb

@@ -1,12 +1,22 @@
 # Disable GitHub Actions reporting since it breaks the test suite
 ENV.delete('GITHUB_ACTION')
 
-if ENV['COVERAGE'] == 'yes' && RUBY_VERSION.start_with?('2.7.')
-  require 'simplecov'
-  SimpleCov.start do
-    add_filter('/spec/')
-    add_filter('/vendor/')
-    add_group('Checks', 'lib/puppet-lint/plugins')
+if ENV['COVERAGE'] == 'yes'
+  begin
+    require 'simplecov'
+    require 'simplecov-console'
+    SimpleCov.formatters = [
+      SimpleCov::Formatter::HTMLFormatter,
+      SimpleCov::Formatter::Console,
+    ]
+
+    SimpleCov.start do
+      add_filter('/spec/')
+      add_filter('/vendor/')
+      add_group('Checks', 'lib/puppet-lint/plugins')
+    end
+  rescue LoadError
+    raise 'Add the simplecov & simplecov-console gems to Gemfile to enable this task'
   end
 end
 

spec/unit/puppet-lint/plugins/top_scope_facts/top_scope_facts_spec.rb

@@ -102,6 +102,18 @@
       end
     end
 
+    context 'top scope structured fact not present on allowlist' do
+      let(:code) { "$::my_structured_fact['foo']['test']" }
+
+      it 'detects a problem' do
+        expect(problems).to contain_fixed('top scope fact instead of facts hash').on_line(1).in_column(1)
+      end
+
+      it 'fixes the problem' do
+        expect(manifest).to eq("$facts['my_structured_fact']['foo']['test']")
+      end
+    end
+
     context 'top scope $::trusted hash' do
       let(:code) { "$::trusted['certname']" }