Merge pull request #146 from ekohl/rubocop

Introduce RuboCop and fix various cops

Author: bastelfreak

.github/dependabot.yml

@@ -1,8 +1,17 @@
 version: 2
 updates:
+# raise PRs for gem updates
 - package-ecosystem: bundler
   directory: "/"
   schedule:
     interval: daily
-    time: "04:00"
+    time: "13:00"
+  open-pull-requests-limit: 10
+
+# Maintain dependencies for GitHub Actions
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "13:00"
   open-pull-requests-limit: 10

.github/workflows/test.yml

@@ -1,13 +1,28 @@
 name: Test
 
 on:
-  - pull_request
-  - push
+  pull_request: {}
+  push:
+    branches:
+      - master
 
 env:
   BUNDLE_WITHOUT: release
 
 jobs:
+  rubocop:
+    env:
+      BUNDLE_WITHOUT: release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.0"
+          bundler-cache: true
+      - name: Run Rubocop
+        run: bundle exec rake rubocop
   test:
     runs-on: ubuntu-latest
     strategy:

.rubocop.yml

@@ -0,0 +1,37 @@
+---
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: '2.4'
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: True
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: True
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArguments:
+  Enabled: True
+  EnforcedStyleForMultiline: comma
+
+Metrics:
+  Enabled: false
+
+Style:
+  Enabled: false
+
+Layout:
+  Enabled: false
+
+# To match the gem name
+Naming/FileName:
+  Exclude:
+    - 'lib/rspec-puppet-facts.rb'

.rubocop_todo.yml

@@ -0,0 +1,68 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2023-03-17 10:58:25 UTC using RuboCop version 1.12.1.
+# 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: 32
+# Configuration parameters: Prefixes.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Exclude:
+    - 'spec/rspec_puppet_facts_spec.rb'
+
+# Offense count: 7
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 13
+
+# Offense count: 1
+RSpec/ExpectInHook:
+  Exclude:
+    - 'spec/rspec_puppet_facts_spec.rb'
+
+# Offense count: 20
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: single_line_only, single_statement_only, disallow
+RSpec/ImplicitSubject:
+  Exclude:
+    - 'spec/rspec_puppet_facts_spec.rb'
+
+# Offense count: 4
+RSpec/LeakyConstantDeclaration:
+  Exclude:
+    - 'spec/rspec_puppet_facts_spec.rb'
+
+# Offense count: 7
+# Configuration parameters: .
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+# Offense count: 4
+RSpec/MultipleExpectations:
+  Max: 2
+
+# Offense count: 46
+# Configuration parameters: IgnoreSharedExamples.
+RSpec/NamedSubject:
+  Exclude:
+    - 'spec/rspec_puppet_facts_spec.rb'
+
+# Offense count: 14
+RSpec/NestedGroups:
+  Max: 6
+
+# Offense count: 1
+RSpec/StubbedMock:
+  Exclude:
+    - 'spec/rspec_puppet_facts_spec.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Rake/Desc:
+  Exclude:
+    - 'Rakefile'

Gemfile

@@ -2,17 +2,13 @@ source ENV['GEM_SOURCE'] || 'https://rubygems.org'
 
 gemspec
 
-if facterversion = ENV['FACTER_GEM_VERSION']
-  gem 'facter', facterversion, :require => false
-else
-  gem 'facter', :require => false
-end
+gem 'facter', ENV['FACTER_GEM_VERSION'], :require => false
 
 group :release do
   gem 'github_changelog_generator', require: false
 end
 
 group :coverage, optional: ENV['COVERAGE']!='yes' do
-  gem 'simplecov-console', :require => false
   gem 'codecov', :require => false
+  gem 'simplecov-console', :require => false
 end

Rakefile

@@ -8,6 +8,7 @@ begin
     RSpec::Core::RakeTask.new(:spec)
     YARD::Rake::YardocTask.new
 rescue LoadError
+  # yard is optional
 end
 
 desc 'Produce Commit history since last tag'
@@ -60,4 +61,20 @@ begin
     config.future_release = gem_version
   end
 rescue LoadError
+  # Changelog generator is optional
+end
+
+begin
+  require 'rubocop/rake_task'
+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']
+    # Use Rubocop's Github Actions formatter if possible
+    if ENV['GITHUB_ACTIONS'] == 'true'
+      task.formatters << 'github'
+    end
+  end
 end

lib/rspec-puppet-facts.rb

@@ -56,7 +56,7 @@ def on_supported_os(opts = {})
   #
   # @api private
   def on_supported_os_implementation(opts = {})
-    unless (facterversion = opts[:facterversion]) =~ /\A\d+\.\d+(?:\.\d+)*\z/
+    unless /\A\d+\.\d+(?:\.\d+)*\z/.match?((facterversion = opts[:facterversion]))
       raise ArgumentError, ":facterversion must be in the format 'n.n' or " \
         "'n.n.n' (n is numeric), not '#{facterversion}'"
     end
@@ -68,19 +68,20 @@ def on_supported_os_implementation(opts = {})
           opts[:hardwaremodels].each do |hardwaremodel|
 
             os_release_filter = "/^#{Regexp.escape(operatingsystemmajrelease.split(' ')[0])}/"
-            if os_sup['operatingsystem'] =~ /BSD/i
+            case os_sup['operatingsystem']
+            when /BSD/i
               hardwaremodel = 'amd64'
-            elsif os_sup['operatingsystem'] =~ /Solaris/i
+            when /Solaris/i
               hardwaremodel = 'i86pc'
-            elsif os_sup['operatingsystem'] =~ /AIX/i
+            when /AIX/i
               hardwaremodel = '/^IBM,.*/'
               os_release_filter = if operatingsystemmajrelease =~ /\A(\d+)\.(\d+)\Z/
                                     "/^#{$~[1]}#{$~[2]}00-/"
                                   else
                                     "/^#{operatingsystemmajrelease}-/"
                                   end
-            elsif os_sup['operatingsystem'] =~ /Windows/i
-              hardwaremodel = facterversion =~ /^[12]\./ ? 'x64' : 'x86_64'
+            when /Windows/i
+              hardwaremodel = /^[12]\./.match?(facterversion) ? 'x64' : 'x86_64'
               os_sup['operatingsystem'] = os_sup['operatingsystem'].downcase
               operatingsystemmajrelease = operatingsystemmajrelease[/\A(?:Server )?(.+)/i, 1]
 
@@ -90,7 +91,7 @@ def on_supported_os_implementation(opts = {})
               if operatingsystemmajrelease == '2016' && Puppet::Util::Package.versioncmp(facterversion, '3.4') < 0
                 os_release_filter = '/^10\\.0\\./'
               end
-            elsif os_sup['operatingsystem'] =~ /Amazon/i
+            when /Amazon/i
               # Tighten the regex for Amazon Linux 2 so that we don't pick up Amazon Linux 2016 or 2017 facts
               os_release_filter = "/^2$/" if operatingsystemmajrelease == '2'
             end

rspec-puppet-facts.gemspec

@@ -24,7 +24,13 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'yard'
-  s.add_runtime_dependency 'puppet'
+
+  s.add_development_dependency 'rubocop', '~> 1.12.0'
+  s.add_development_dependency 'rubocop-performance'
+  s.add_development_dependency 'rubocop-rake'
+  s.add_development_dependency 'rubocop-rspec'
+
   s.add_runtime_dependency 'facter'
   s.add_runtime_dependency 'facterdb', '>= 0.5.0'
+  s.add_runtime_dependency 'puppet'
 end