Merge pull request #13 from voxpupuli/ruby32

Require Ruby 3.2 or newer

Author: bastelfreak

.github/workflows/ci.yml

@@ -56,10 +56,14 @@ jobs:
         run: bundle exec rake acceptance
 
   tests:
+    if: always()
     needs:
       - rubocop_and_matrix
       - test
     runs-on: ubuntu-24.04
     name: Test suite
     steps:
-      - run: echo Test suite completed
+      - name: Decide whether the needed jobs succeeded or failed
+        uses: re-actors/alls-green@release/v1
+        with:
+          jobs: ${{ toJSON(needs) }}

.rubocop.yml

@@ -19,3 +19,6 @@ Style/ClassAndModuleChildren:
 
 Style/SpecialGlobalVars:
   Enabled: false
+
+AllCops:
+  TargetRubyVersion: 3.2

.rubocop_todo.yml

@@ -1,11 +1,18 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --no-auto-gen-timestamp`
-# using RuboCop version 1.75.8.
+# using RuboCop version 1.79.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: 3
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: RequireParenthesesForMethodChains.
+Lint/AmbiguousRange:
+  Exclude:
+    - 'lib/openvox-strings/yard/parsers/puppet/statement.rb'
+
 # Offense count: 1
 Lint/CopDirectiveSyntax:
   Exclude:
@@ -16,12 +23,6 @@ Lint/MixedRegexpCaptureTypes:
   Exclude:
     - 'Gemfile'
 
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Lint/RedundantCopDisableDirective:
-  Exclude:
-    - 'lib/puppet/face/strings.rb'
-
 # Offense count: 2
 Naming/AccessorMethodName:
   Exclude:
@@ -52,6 +53,27 @@ Naming/MethodParameterName:
     - 'lib/openvox-strings/yard/handlers/ruby/data_type_handler.rb'
     - 'lib/openvox-strings/yard/parsers/puppet/parser.rb'
 
+# Offense count: 3
+# Configuration parameters: Mode, AllowedMethods, AllowedPatterns, AllowBangMethods, WaywardPredicates.
+# AllowedMethods: call
+# WaywardPredicates: nonzero?
+Naming/PredicateMethod:
+  Exclude:
+    - 'lib/openvox-strings/markdown/resource_type.rb'
+    - 'lib/openvox-strings/yard/parsers/json/task_statement.rb'
+    - 'lib/openvox-strings/yard/parsers/puppet/statement.rb'
+
+# Offense count: 1
+# Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros, UseSorbetSigs.
+# NamePrefix: is_, has_, have_, does_
+# ForbiddenPrefixes: is_, has_, have_, does_
+# AllowedMethods: is_a?
+# MethodDefinitionMacros: define_method, define_singleton_method
+Naming/PredicatePrefix:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/openvox-strings/yard/tags/overload_tag.rb'
+
 # Offense count: 4
 # Configuration parameters: MinSize.
 Performance/CollectionLiteralInLoop:
@@ -94,10 +116,6 @@ RSpec/ExpectInHook:
   Exclude:
     - 'spec/unit/openvox-strings/json_spec.rb'
 
-# Offense count: 91
-RSpec/MultipleExpectations:
-  Max: 64
-
 # Offense count: 5
 # Configuration parameters: AllowedGroups.
 RSpec/NestedGroups:
@@ -114,33 +132,27 @@ RSpec/RepeatedExampleGroupDescription:
 RSpec/SpecFilePathFormat:
   Enabled: false
 
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-Rake/Desc:
-  Exclude:
-    - 'Rakefile'
-
 # Offense count: 1
 Style/ClassVars:
   Exclude:
     - 'lib/openvox-strings/yard/templates/default/layout/html/setup.rb'
 
+# Offense count: 6
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/CollectionQuerying:
+  Exclude:
+    - 'lib/openvox-strings/yard/handlers/ruby/function_handler.rb'
+    - 'lib/openvox-strings/yard/handlers/ruby/provider_handler.rb'
+    - 'lib/openvox-strings/yard/handlers/ruby/rsapi_handler.rb'
+    - 'lib/openvox-strings/yard/handlers/ruby/type_base.rb'
+
 # Offense count: 3
 # This cop supports unsafe autocorrection (--autocorrect-all).
 Style/CombinableLoops:
   Exclude:
     - 'lib/openvox-strings/markdown.rb'
     - 'lib/openvox-strings/yard/handlers/ruby/data_type_handler.rb'
 
-# Offense count: 2
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: literals, strict
-Style/MutableConstant:
-  Exclude:
-    - 'lib/openvox-strings/yard/handlers/ruby/base.rb'
-    - 'lib/openvox-strings/yard/parsers/puppet/statement.rb'
-
 # Offense count: 20
 # Configuration parameters: AllowedMethods.
 # AllowedMethods: respond_to_missing?
@@ -160,27 +172,6 @@ Style/OptionalBooleanParameter:
     - 'lib/openvox-strings/yard/handlers/ruby/data_type_handler.rb'
     - 'lib/openvox-strings/yard/handlers/ruby/function_handler.rb'
 
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-Style/RedundantParentheses:
-  Exclude:
-    - 'lib/openvox-strings/yard/handlers/puppet/function_handler.rb'
-    - 'lib/openvox-strings/yard/tags/overload_tag.rb'
-
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-Style/RedundantRegexpEscape:
-  Exclude:
-    - 'Gemfile'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, AllowInnerSlashes.
-# SupportedStyles: slashes, percent_r, mixed
-Style/RegexpLiteral:
-  Exclude:
-    - 'Gemfile'
-
 # Offense count: 2
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: ConvertCodeThatCanStartToReturnNil, AllowedMethods, MaxChainLength.
@@ -189,68 +180,3 @@ Style/SafeNavigation:
   Exclude:
     - 'lib/openvox-strings/yard/handlers/puppet/function_handler.rb'
     - 'lib/openvox-strings/yard/handlers/ruby/function_handler.rb'
-
-# Offense count: 3
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
-# SupportedStyles: single_quotes, double_quotes
-Style/StringLiterals:
-  Exclude:
-    - 'Gemfile'
-    - 'Rakefile'
-
-# Offense count: 6
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, AllowSafeAssignment.
-# SupportedStyles: require_parentheses, require_no_parentheses, require_parentheses_when_complex
-Style/TernaryParentheses:
-  Exclude:
-    - 'lib/openvox-strings/tasks/generate.rb'
-    - 'lib/openvox-strings/yard/templates/default/layout/html/setup.rb'
-    - 'lib/openvox-strings/yard/templates/default/tags/setup.rb'
-    - 'lib/puppet/face/strings.rb'
-    - 'spec/spec_helper.rb'
-
-# Offense count: 17
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyleForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, no_comma
-Style/TrailingCommaInArguments:
-  Exclude:
-    - 'lib/openvox-strings/yard.rb'
-    - 'lib/openvox-strings/yard/code_objects/type.rb'
-    - 'lib/openvox-strings/yard/handlers/ruby/function_handler.rb'
-    - 'lib/puppet/face/strings.rb'
-    - 'spec/unit/openvox-strings/yard/handlers/puppet/class_handler_spec.rb'
-    - 'spec/unit/openvox-strings/yard/handlers/puppet/function_handler_spec.rb'
-    - 'spec/unit/openvox-strings/yard/handlers/ruby/function_handler_spec.rb'
-
-# Offense count: 16
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyleForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, diff_comma, no_comma
-Style/TrailingCommaInArrayLiteral:
-  Exclude:
-    - 'lib/openvox-strings/markdown.rb'
-    - 'lib/openvox-strings/yard/templates/default/layout/html/setup.rb'
-    - 'spec/acceptance/generate_json_spec.rb'
-    - 'spec/acceptance/running_strings_generate_spec.rb'
-    - 'spec/unit/openvox-strings/yard/code_objects/task_spec.rb'
-    - 'spec/unit/openvox-strings/yard/handlers/ruby/data_type_handler_spec.rb'
-    - 'spec/unit/openvox-strings/yard/parsers/puppet/parser_spec.rb'
-
-# Offense count: 30
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyleForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, diff_comma, no_comma
-Style/TrailingCommaInHashLiteral:
-  Exclude:
-    - 'lib/openvox-strings/describe.rb'
-    - 'lib/openvox-strings/json.rb'
-    - 'lib/openvox-strings/tasks/generate.rb'
-    - 'lib/openvox-strings/tasks/validate.rb'
-    - 'lib/openvox-strings/yard/code_objects/data_type.rb'
-    - 'lib/openvox-strings/yard/code_objects/task.rb'
-    - 'lib/openvox-strings/yard/templates/default/layout/html/setup.rb'
-    - 'spec/acceptance/generate_json_spec.rb'
-    - 'spec/unit/openvox-strings/yard/code_objects/task_spec.rb'

Gemfile

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-source ENV['GEM_SOURCE'] || "https://rubygems.org"
+source ENV['GEM_SOURCE'] || 'https://rubygems.org'
 
 gemspec
 
 def location_for(place_or_version, fake_version = nil)
-  git_url_regex = %r{\A(?<url>(https?|git)[:@][^#]*)(#(?<branch>.*))?}
-  file_url_regex = %r{\Afile:\/\/(?<path>.*)}
+  git_url_regex = /\A(?<url>(https?|git)[:@][^#]*)(#(?<branch>.*))?/
+  file_url_regex = %r{\Afile://(?<path>.*)}
 
   if place_or_version && (git_url = place_or_version.match(git_url_regex))
     [fake_version, { git: git_url[:url], branch: git_url[:branch], require: false }].compact
@@ -31,10 +31,6 @@ group :development do
   gem 'redcarpet'
 end
 
-group :rubocop do
-  gem 'voxpupuli-rubocop', '~> 3.1.0'
-end
-
 # https://github.com/OpenVoxProject/puppet/issues/90
 gem 'syslog', '~> 0.3' if RUBY_VERSION >= '3.4'
 

Rakefile

@@ -3,14 +3,17 @@
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec) do |t|
-  t.exclude_pattern = "spec/acceptance/**/*.rb"
+  t.exclude_pattern = 'spec/acceptance/**/*.rb'
 end
 
 RSpec::Core::RakeTask.new(:acceptance) do |t|
-  t.pattern = "spec/unit/**/*.rb"
+  t.pattern = 'spec/unit/**/*.rb'
 end
 
+desc 'run unit tests'
 task :spec
+
+desc 'run acceptance tests'
 task :acceptance
 
 # Add our own tasks

lib/openvox-strings.rb

@@ -79,10 +79,10 @@ def self.render_describe(describe_types, list = false, show_providers = true, li
 
   # Runs the YARD documentation server.
   # @param [Array<String>] args The arguments to YARD.
-  def self.run_server(*args)
+  def self.run_server(*)
     require 'openvox-strings/yard'
     OpenvoxStrings::Yard.setup!
 
-    YARD::CLI::Server.run(*args)
+    YARD::CLI::Server.run(*)
   end
 end

lib/openvox-strings/describe.rb

@@ -15,7 +15,7 @@ def self.render(describe_types = [], list_types = false, show_type_providers = t
     document = {
       defined_types: YARD::Registry.all(:puppet_defined_type).sort_by!(&:name).map!(&:to_hash),
       resource_types: YARD::Registry.all(:puppet_type).sort_by!(&:name).map!(&:to_hash),
-      providers: YARD::Registry.all(:puppet_provider).sort_by!(&:name).map!(&:to_hash)
+      providers: YARD::Registry.all(:puppet_provider).sort_by!(&:name).map!(&:to_hash),
     }
     # if --list flag passed, produce a summarized list of types
     if list_types

lib/openvox-strings/json.rb

@@ -17,7 +17,7 @@ def self.render(file = nil)
       providers: YARD::Registry.all(:puppet_provider).sort_by!(&:name).map!(&:to_hash),
       puppet_functions: YARD::Registry.all(:puppet_function).sort_by!(&:name).map!(&:to_hash),
       puppet_tasks: YARD::Registry.all(:puppet_task).sort_by!(&:name).map!(&:to_hash),
-      puppet_plans: YARD::Registry.all(:puppet_plan).sort_by!(&:name).map!(&:to_hash)
+      puppet_plans: YARD::Registry.all(:puppet_plan).sort_by!(&:name).map!(&:to_hash),
       # TODO: Need Ruby documentation?
     }
 

lib/openvox-strings/markdown.rb

@@ -23,7 +23,7 @@ def self.groups
       OpenvoxStrings::Markdown::Function,
       OpenvoxStrings::Markdown::DataType,
       OpenvoxStrings::Markdown::PuppetTask,
-      OpenvoxStrings::Markdown::PuppetPlan
+      OpenvoxStrings::Markdown::PuppetPlan,
     ]
   end
 
@@ -33,7 +33,7 @@ def self.generate
     output = [
       "# Reference\n\n",
       "<!-- DO NOT EDIT: This document was generated by Puppet Strings -->\n\n",
-      "## Table of Contents\n\n"
+      "## Table of Contents\n\n",
     ]
 
     # Create table of contents

lib/openvox-strings/tasks/generate.rb

@@ -13,7 +13,7 @@
     options = {
       debug: args[:debug] == 'true',
       backtrace: args[:backtrace] == 'true',
-      markup: args[:markup] || 'markdown'
+      markup: args[:markup] || 'markdown',
     }
 
     raise('Error: Both JSON and Markdown output have been selected. Please select one.') if args[:json] == 'true' && args[:markdown] == 'true'
@@ -33,7 +33,7 @@ def parse_format_option(args, options, format)
       options[format] = !(args[format] == 'false' || args[format].empty?)
       return unless options[format]
 
-      options[:path] = args[format] == 'true' ? nil : args[format]
+      options[:path] = (args[format] == 'true') ? nil : args[format]
     end
     # rubocop:enable Style/PreferredHashMethods