puppetlabs_spec_helper 2.16.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77cf85ee1cb6e0c063fc70b7633745f22e1a74db5dd004addd055b11a3b2d3aa
-  data.tar.gz: 509b75a40c8e4041dbdd73a2f01bed57f141ebd0c44d695551ed3aa554e67d3f
+  metadata.gz: ef65ff61efb2a4ba220a726fd2ac309dc077a37ba9a2a2951430cebdd449b3c3
+  data.tar.gz: e079aa402cc3c638d7fb0f9dae179afb884a894ba20334ce781289523177446c
 SHA512:
-  metadata.gz: 2c6b745e80ddc0b9d2bad8f902f9155252cf5d8503f8cc1052b3a1f8dc647646701a36145dff46b17bdeaff04e53a32d2927401faf619bfec3ac0fa61212adad
-  data.tar.gz: 5fb4f21feb106e531d3b5112494fba80e3deab0775d16bcbf559133cccd06259e3ad5e69d9dd055f4024282c299be9b1aceb38d7d7e5be2074a4a808531dbb64
+  metadata.gz: 616b63b83dafabafeb3d6ece228f76d94f21ac01266093100fd8fa2c75b14a99c8e2fa5ba3bff1a6e0203a4321486fa2e3133aeb7edc35541d139e31ce1495b3
+  data.tar.gz: cb0399bf3984b9bab34d202819493c1829cabf6050f9f2d19ada65a41aaa268e7901e62382c77dfbaf948bff8bd944d42c80d25941a366115fdf79e67e9c5f93

data/.rubocop.yml

@@ -2,7 +2,7 @@ require: rubocop-rspec
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.1
+  TargetRubyVersion: 2.4
   # let dependabot find the rough spots for us
   NewCops: enable
   Exclude:
@@ -16,10 +16,6 @@ AllCops:
     - package-testing/vendor/**/*
     - package-testing/vendor/**/.*
 
-Layout/HeredocIndentation:
-  Description: The `squiggly` style would be preferable, but is only available from ruby 2.3. We'll enable this when we can.
-  Enabled: False
-
 # Metrics, excludes complexity and sizing metrics for now, as ruby's defaults are very strict
 Metrics/AbcSize:
   Enabled: False
@@ -36,7 +32,7 @@ Metrics/ClassLength:
 Metrics/CyclomaticComplexity:
   Enabled: False
 
-Layout/LineLength:
+Metrics/LineLength:
   Description: People have wide screens, use them.
   Max: 200
 
@@ -147,10 +143,6 @@ Style/SymbolArray:
 Layout/EndOfLine:
   EnforcedStyle: lf
 
-RSpec/FactoryBot/CreateList:
-  Description: produces lots of errors (not violations) with out code
-  Enabled: false
-
 Style/AccessModifierDeclarations:
   EnforcedStyle: inline
 

data/.rubocop_todo.yml

@@ -1,28 +1,19 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-11-16 16:15:06 +0000 using RuboCop version 0.57.2.
+# on 2021-02-09 10:30:38 +0000 using RuboCop version 0.57.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
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 2
+# Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyleAlignWith, AutoCorrect, Severity.
 # SupportedStylesAlignWith: keyword, variable, start_of_line
 Layout/EndAlignment:
   Exclude:
-    - 'lib/puppetlabs_spec_helper/rake_tasks.rb'
     - 'spec/watchr.rb'
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: auto_detection, squiggly, active_support, powerpack, unindent
-Layout/IndentHeredoc:
-  Exclude:
-    - 'lib/puppetlabs_spec_helper/rake_tasks.rb'
-
 # Offense count: 4
 # Configuration parameters: AllowSafeAssignment.
 Lint/AssignmentInCondition:
@@ -38,10 +29,9 @@ Lint/HandleExceptions:
     - 'lib/puppetlabs_spec_helper/puppetlabs_spec/files.rb'
     - 'lib/puppetlabs_spec_helper/rake_tasks.rb'
 
-# Offense count: 2
+# Offense count: 1
 Lint/UselessAssignment:
   Exclude:
-    - 'lib/puppetlabs_spec_helper/puppet_spec_helper.rb'
     - 'lib/puppetlabs_spec_helper/puppetlabs_spec/puppet_internals.rb'
 
 # Offense count: 2

data/.travis.yml

@@ -4,30 +4,20 @@ language: ruby
 cache: bundler
 before_install: bundle -v
 script: bundle exec rake
-matrix:
+jobs:
   fast_finish: true
   include:
   - rvm: '2.7'
-    env: PUPPET_GEM_VERSION='https://github.com/puppetlabs/puppet.git#main' # TODO: change to 7 once it becomes available
+    env: PUPPET_GEM_VERSION='https://github.com/puppetlabs/puppet.git#main'
+  - rvm: '2.7'
+    env: PUPPET_GEM_VERSION='~> 7.0' COVERAGE=yes
   - rvm: '2.6'
     env: PUPPET_GEM_VERSION='~> 6.0' COVERAGE=yes
   - rvm: '2.5'
     env: PUPPET_GEM_VERSION='~> 6.0' COVERAGE=yes
   - rvm: '2.4'
     env: PUPPET_GEM_VERSION='~> 6.0' COVERAGE=yes
-  - rvm: '2.3'
-    env: PUPPET_GEM_VERSION='~> 6.0'
   - rvm: '2.4'
     env: PUPPET_GEM_VERSION='~> 5.0' COVERAGE=yes
-  - rvm: '2.3'
-    env: PUPPET_GEM_VERSION='~> 5.0'
-  - rvm: '2.1'
-    env: PUPPET_GEM_VERSION='~> 5.0'
-  - rvm: '2.4'
-    env: PUPPET_GEM_VERSION='~> 4.0' COVERAGE=yes
-  - rvm: '2.3'
-    env: PUPPET_GEM_VERSION='~> 4.0'
-  - rvm: '2.1'
-    env: PUPPET_GEM_VERSION='~> 4.0'
 notifications:
   email: false

data/CHANGELOG.md

@@ -3,6 +3,16 @@
 All significant changes to this repo will be summarized in this file.
 
 
+## [v3.0.0](https://github.com/puppetlabs/puppetlabs_spec_helper/tree/v3.0.0) (2021-02-10)
+
+[Full Changelog](https://github.com/puppetlabs/puppetlabs_spec_helper/compare/v2.16.0...v3.0.0)
+
+**Implemented enhancements:**
+
+- dropping rubies before 2.4 [\#332](https://github.com/puppetlabs/puppetlabs_spec_helper/pull/332) ([DavidS](https://github.com/DavidS))
+- Remove i18n/gettext task [\#331](https://github.com/puppetlabs/puppetlabs_spec_helper/pull/331) ([DavidS](https://github.com/DavidS))
+- Restructure PuppetLint rake tasks so they can be configurable [\#330](https://github.com/puppetlabs/puppetlabs_spec_helper/pull/330) ([nmaludy](https://github.com/nmaludy))
+
 ## [v2.16.0](https://github.com/puppetlabs/puppetlabs_spec_helper/tree/v2.16.0) (2021-01-18)
 
 [Full Changelog](https://github.com/puppetlabs/puppetlabs_spec_helper/compare/v2.15.0...v2.16.0)
@@ -15,6 +25,7 @@ All significant changes to this repo will be summarized in this file.
 
 **Merged pull requests:**
 
+- Release prep for v2.16.0 [\#329](https://github.com/puppetlabs/puppetlabs_spec_helper/pull/329) ([DavidS](https://github.com/DavidS))
 - Update pathspec requirement from ~\> 0.2.1 to \>= 0.2.1, \< 1.1.0 [\#328](https://github.com/puppetlabs/puppetlabs_spec_helper/pull/328) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
 - Update rubocop requirement from = 0.49 to 0.57.2; prepare for future move to 1.3.1 [\#322](https://github.com/puppetlabs/puppetlabs_spec_helper/pull/322) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
 

data/Gemfile

@@ -22,10 +22,9 @@ gemspec
 def infer_puppet_version
   # Infer the Puppet Gem version based on the Ruby Version
   ruby_ver = Gem::Version.new(RUBY_VERSION.dup)
+  return '~> 7.0' if ruby_ver >= Gem::Version.new('2.7.0')
   return '~> 6.0' if ruby_ver >= Gem::Version.new('2.5.0')
-  return '~> 5.0' if ruby_ver >= Gem::Version.new('2.4.0')
-
-  '~> 4.0'
+  '~> 5.0'
 end
 
 group :development do
@@ -40,10 +39,4 @@ group :development do
   end
 end
 
-# pin some gems for older ruby versions
-gem 'fakefs', '<= 0.13.3' if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.4.0')
-gem 'json_pure', '<=2.0.1' if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.0.0')
-gem 'puppet-syntax', '<= 3' if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.4.0')
-gem 'rack', '~> 1' if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.2.0')
-
 # vim:filetype=ruby

data/lib/puppetlabs_spec_helper/puppet_spec_helper.rb

@@ -47,7 +47,7 @@ require 'puppetlabs_spec_helper/puppetlabs_spec/files'
 # to compatibility mode for older versions of puppet.
 begin
   require 'puppet/test/test_helper'
-rescue LoadError => e
+rescue LoadError
 end
 
 # This is just a utility class to allow us to isolate the various version-specific

data/lib/puppetlabs_spec_helper/puppetlabs_spec/puppet_internals.rb

@@ -12,7 +12,7 @@ module PuppetlabsSpec
     def scope(parts = {})
       RSpec.deprecate('scope', replacement: 'rspec-puppet 2.2.0 provides a scope property')
 
-      if Puppet.version =~ %r{^2\.[67]}
+      if %r{^2\.[67]}.match?(Puppet.version)
         # loadall should only be necessary prior to 3.x
         # Please note, loadall needs to happen first when creating a scope, otherwise
         # you might receive undefined method `function_*' errors
@@ -23,7 +23,7 @@ module PuppetlabsSpec
       scope_parent = parts[:parent] || scope_compiler.topscope
       scope_resource = parts[:resource] || resource(type: :node, title: scope_compiler.node.name)
 
-      scope = if Puppet.version =~ %r{^2\.[67]}
+      scope = if %r{^2\.[67]}.match?(Puppet.version)
                 Puppet::Parser::Scope.new(compiler: scope_compiler)
               else
                 Puppet::Parser::Scope.new(scope_compiler)

data/lib/puppetlabs_spec_helper/rake_tasks.rb

@@ -149,7 +149,7 @@ namespace :build do
       require 'pdk/util'
       require 'pdk/module/build'
 
-      path = PDK::Module::Build.invoke(:force => true, :'target-dir' => File.join(Dir.pwd, 'pkg'))
+      path = PDK::Module::Build.invoke(force: true, 'target-dir': File.join(Dir.pwd, 'pkg'))
       puts "Module built: #{path}"
     rescue LoadError
       _ = `pdk --version`
@@ -172,52 +172,34 @@ require 'puppet-lint/tasks/puppet-lint'
 # Must clear as it will not override the existing puppet-lint rake task since we require to import for
 # the PuppetLint::RakeTask
 Rake::Task[:lint].clear
-# Relative is not able to be set within the context of PuppetLint::RakeTask
+# Utilize PuppetLint global configuration so that these settings can be tweaked by
+# spec_helper.rb in an individual module
 PuppetLint.configuration.relative = true
-PuppetLint::RakeTask.new(:lint) do |config|
-  config.fail_on_warnings = true
-  config.disable_checks = %w[
-    80chars
-    140chars
-    class_inherits_from_params_class
-    class_parameter_defaults
-    disable_autoloader_layout
-    documentation
-    single_quote_string_with_variables
-  ]
-  config.ignore_paths = [
-    '.vendor/**/*.pp',
-    'bundle/**/*.pp',
-    'pkg/**/*.pp',
-    'spec/**/*.pp',
-    'tests/**/*.pp',
-    'types/**/*.pp',
-    'vendor/**/*.pp',
-  ]
+PuppetLint.configuration.ignore_paths ||= []
+PuppetLint.configuration.ignore_paths << '.vendor/**/*.pp'
+PuppetLint.configuration.ignore_paths << 'bundle/**/*.pp'
+PuppetLint.configuration.ignore_paths << 'pkg/**/*.pp'
+PuppetLint.configuration.ignore_paths << 'spec/**/*.pp'
+PuppetLint.configuration.ignore_paths << 'tests/**/*.pp'
+PuppetLint.configuration.ignore_paths << 'types/**/*.pp'
+PuppetLint.configuration.ignore_paths << 'vendor/**/*.pp'
+puppet_lint_disable_checks = %w[
+  80chars
+  140chars
+  class_inherits_from_params_class
+  class_parameter_defaults
+  disable_autoloader_layout
+  documentation
+  single_quote_string_with_variables
+]
+puppet_lint_disable_checks.each do |check|
+  PuppetLint.configuration.send("disable_#{check}")
 end
+PuppetLint::RakeTask.new(:lint)
 
 desc 'Run puppet-lint and fix issues automatically'
 PuppetLint::RakeTask.new(:lint_fix) do |config|
-  config.fail_on_warnings = true
   config.fix = true
-  config.disable_checks = %w[
-    80chars
-    140chars
-    class_inherits_from_params_class
-    class_parameter_defaults
-    disable_autoloader_layout
-    documentation
-    single_quote_string_with_variables
-  ]
-  config.ignore_paths = [
-    '.vendor/**/*.pp',
-    'bundle/**/*.pp',
-    'pkg/**/*.pp',
-    'spec/**/*.pp',
-    'tests/**/*.pp',
-    'types/**/*.pp',
-    'vendor/**/*.pp',
-  ]
 end
 
 require 'puppet-syntax/tasks/puppet-syntax'
@@ -279,7 +261,7 @@ task :compute_dev_version do
   # If the branch is a release branch we append an 'r' into the new_version,
   # this is due to the release branch buildID conflicting with master branch when trying to push to the staging forge.
   # More info can be found at https://tickets.puppetlabs.com/browse/FM-6170
-  new_version = if build = ENV['BUILD_NUMBER'] || ENV['TRAVIS_BUILD_NUMBER']
+  new_version = if build = (ENV['BUILD_NUMBER'] || ENV['TRAVIS_BUILD_NUMBER'])
                   if branch.eql? 'release'
                     '%s-%s%04d-%s' % [version, 'r', build, sha] # legacy support code # rubocop:disable Style/FormatStringToken
                   else
@@ -363,29 +345,6 @@ rescue LoadError
   end
 end
 
-module_dir = Dir.pwd
-locales_dir = File.absolute_path('locales', module_dir)
-# if the task is allowed to run when the module does not have a locales directory,
-# the task is run in the puppet gem instead and creates a POT there.
-puts 'gettext-setup tasks will only be loaded if the locales/ directory is present' if Rake.verbose == true
-if File.exist? locales_dir
-  begin
-    spec = Gem::Specification.find_by_name 'gettext-setup'
-    load "#{spec.gem_dir}/lib/tasks/gettext.rake"
-    # Initialization requires a valid locales directory
-    GettextSetup.initialize(locales_dir)
-    namespace :module do
-      desc 'Runs all tasks to build a modules POT file for internationalization'
-      task :pot_gen do
-        Rake::Task['gettext:pot'].invoke
-        Rake::Task['gettext:metadata_pot'].invoke("#{module_dir}/metadata.json")
-      end
-    end
-  rescue Gem::LoadError
-    puts 'No gettext-setup gem found, skipping GettextSetup config initialization' if Rake.verbose == true
-  end
-end
-
 def create_gch_task(changelog_user = nil, changelog_project = nil, changelog_since_tag = nil, changelog_tag_pattern = 'v%s')
   if Bundler.rubygems.find_name('github_changelog_generator').any?
     # needed a place to hide these methods
@@ -451,18 +410,18 @@ def create_gch_task(changelog_user = nil, changelog_project = nil, changelog_sin
   else
     desc 'Generate a Changelog from GitHub'
     task :changelog do
-      raise <<MESSAGE
-The changelog tasks depends on unreleased features of the github_changelog_generator gem.
-Please manually add it to your .sync.yml for now, and run `pdk update`:
----
-Gemfile:
-  optional:
-    ':development':
-      - gem: 'github_changelog_generator'
-        git: 'https://github.com/skywinder/github-changelog-generator'
-        ref: '20ee04ba1234e9e83eb2ffb5056e23d641c7a018'
-        condition: "Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.2.2')"
-MESSAGE
+      raise <<~MESSAGE
+        The changelog tasks depends on unreleased features of the github_changelog_generator gem.
+        Please manually add it to your .sync.yml for now, and run `pdk update`:
+        ---
+        Gemfile:
+          optional:
+            ':development':
+              - gem: 'github_changelog_generator'
+                git: 'https://github.com/skywinder/github-changelog-generator'
+                ref: '20ee04ba1234e9e83eb2ffb5056e23d641c7a018'
+                condition: "Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.2.2')"
+      MESSAGE
     end
   end
 end

data/lib/puppetlabs_spec_helper/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module PuppetlabsSpecHelper
-  VERSION = '2.16.0'.freeze
+  VERSION = '3.0.0'
 
   # compat for pre-1.2.0 users; deprecated
   module Version

data/puppetlabs_spec_helper.gemspec

@@ -28,7 +28,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'fakefs', ['>= 0.13.3', '< 2']
-  spec.add_development_dependency 'gettext-setup', '~> 0.29'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'puppet'
   spec.add_development_dependency 'rake', ['>= 10.0', '< 14']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppetlabs_spec_helper
 version: !ruby/object:Gem::Version
-  version: 2.16.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Puppet, Inc.
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-18 00:00:00.000000000 Z
+date: 2021-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
@@ -127,20 +127,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
-- !ruby/object:Gem::Dependency
-  name: gettext-setup
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.29'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.29'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement