RubyCritic v5.0 (Support for Ruby 4.0) (#556)

* Changes needed for Ruby 4.0.0

* Test with Ruby 4.0 too

* Patch FakeFS

* Add a note about Ruby 4.0

* Apply patch by @faisal

* Remove irb and bump dependency on fakefs

* undef :path

* Additional changes for 5.0 (Ruby 4 support) branch (#566)

* Update version, and version compatibility, for 5.0 release.

* run mdl with Ruby 4

# Conflicts:
#	CHANGELOG.md

* Fixed up changelog

- restored notes and one change that got dropped in rebasing
- split out the changelog to include 4.12 release we haven't done yet

* Require ostruct, because Ruby 4.0 no longer bundles it.

* [CHANGE] Update byebug dependency, for Ruby 4.0 compatibility fixes

* Small fix to avoid unnecessary strictness in comparison

---------

Co-authored-by: Faisal N Jawdat <faisal@users.noreply.github.com>

Author: etagwerker

.github/workflows/main.yml

@@ -31,6 +31,7 @@ jobs:
           - '3.2'
           - '3.3'
           - '3.4'
+          - '4.0'
         experimental: [false]
         include:
           - ruby-version: 'ruby-head'
@@ -61,6 +62,7 @@ jobs:
           - '3.2'
           - '3.3'
           - '3.4'
+          - '4.0'
         experimental: [false]
         include:
           - ruby-version: 'ruby-head'
@@ -91,6 +93,7 @@ jobs:
           - '3.2'
           - '3.3'
           - '3.4'
+          - '4.0'
         experimental: [false]
         include:
           - ruby-version: 'ruby-head'
@@ -121,6 +124,7 @@ jobs:
           - '3.2'
           - '3.3'
           - '3.4'
+          - '4.0'
         experimental: [false]
         include:
           - ruby-version: 'ruby-head'
@@ -149,7 +153,7 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.4'
+          ruby-version: '4.0'
           bundler-cache: true
           cache-version: 1
         continue-on-error: ${{ matrix.experimental }}

CHANGELOG.md

@@ -1,14 +1,23 @@
-# main [(unreleased)](https://github.com/whitesmith/rubycritic/compare/v4.11.0...main)
+# main [(unreleased)](https://github.com/whitesmith/rubycritic/compare/v4.12.0...main)
 
 * [CHANGE] ...
 * [BUGFIX] ...
 * [CHORE] ...
 * [FEATURE] ...
 
-* [CHORE] Sorted cops in .rubocop.yml to make it easier for maintainers to add or modify cop settings, and unified duplicate Metrics/MethodLength settings. (by [@faisal][])
-* [CHORE] Updated README with last supported Ruby versions for the older as well as the latest releases of Rubycritic/Ruby (by [@faisal][])
+* [CHORE] Bump byebug dependency (by [@faisal][])
+* [CHORE] Bump mdl and mocha dependencies (by [@faisal][])
+* [CHORE] Bump minitest dependency, and add minitest-mock dependency (by [@faisal][])
+* [CHORE] Bump fakefs dependency, and drop irb dependency (by [@faisal][])
+* [CHORE] In RubyCritic::Generator::Html::Line, require cgi/escape rather than cgi, as the latter is removed from Ruby 4.0 (by [@faisal][])
+* [CHORE] Run Markdown linting in CI using Ruby 4.0 (by [@faisal][])
+* [CHANGE] Sorted cops in .rubocop.yml to make it easier for maintainers to add or modify cop settings, and unified duplicate Metrics/MethodLength settings. (by [@faisal][])
 * [CHANGE] Drop support for Ruby 3.1.x and JRuby 9.4 (by [@faisal][])
 * [CHANGE] Add CI support for JRuby 10.0 (by [@faisal][])
+* [CHORE] Start testing library with Ruby 4.0 (by [@etagwerker][])
+
+# v4.12.0 / 2026-01-01 [(commits)](https://github.com/whitesmith/rubycritic/compare/v4.11.0...v4.12.0)
+
 * [CHANGE] Bump cucumber dependency (by [@faisal][])
 * [BUGFIX] Fixed regression in compatibility with Flog 4.9.0 (by [@faisal][])
 * [CHANGE] Bump mocha dependency (by [@faisal][])

README.md

@@ -246,7 +246,7 @@ RubyCritic is supporting Ruby versions:
 | 2.6 | [v4.7.0](https://github.com/whitesmith/rubycritic/tree/v4.7.0) |
 | 2.7 | [v4.9.1](https://github.com/whitesmith/rubycritic/tree/v4.9.1) |
 | 3.0 | [v4.9.2](https://github.com/whitesmith/rubycritic/tree/v4.9.1) |
-| 3.1 | [v4.11.0](https://github.com/whitesmith/rubycritic/tree/v4.11.0) |
+| 3.1 | [v4.12.0](https://github.com/whitesmith/rubycritic/tree/v4.12.0) |
 | 3.2 | latest |
 | 3.3 | latest |
 | 3.4 | latest |

features/step_definitions/rubycritic_steps.rb

@@ -21,7 +21,7 @@
 end
 
 Then(/^it reports the current version$/) do
-  expect(last_command_started).to have_output("RubyCritic #{RubyCritic::VERSION}\n")
+  expect(last_command_started).to have_output(an_output_string_including("RubyCritic #{RubyCritic::VERSION}"))
 end
 
 Then(/^it reports the error ['"](.*)['"]$/) do |string|

lib/rubycritic/analysers/smells/reek.rb

@@ -10,7 +10,10 @@ class ReekSmells
       include Colorize
 
       def initialize(analysed_modules)
-        @analysed_modules = analysed_modules.reject { Reek.configuration.path_excluded?(_1.pathname) }
+        @analysed_modules = analysed_modules.reject do |mod|
+          path_string = mod.pathname.to_s
+          Reek.configuration.path_excluded?(Pathname.new(path_string))
+        end
       end
 
       def run

lib/rubycritic/generators/html/line.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'cgi'
+require 'cgi/escape'
 require 'rubycritic/generators/html/base'
 
 module RubyCritic

lib/rubycritic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyCritic
-  VERSION = '4.12.0'
+  VERSION = '5.0.0'
 end

rubycritic.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'flay', '~> 2.13'
   spec.add_dependency 'flog', '~> 4.7'
   spec.add_dependency 'launchy', '>= 2.5.2'
+  spec.add_dependency 'ostruct'
   spec.add_dependency 'parser', '>= 3.3.0.5'
   spec.add_dependency 'prism', '>= 1.6.0'
   spec.add_dependency 'rainbow', '~> 3.1.1'
@@ -50,18 +51,16 @@ Gem::Specification.new do |spec|
     spec.add_development_dependency 'jar-dependencies', '~> 0.5.5'
     spec.add_development_dependency 'pry-debugger-jruby'
   else
-    spec.add_development_dependency 'byebug', '~> 12.0', '>= 10.0'
+    spec.add_development_dependency 'byebug', '~> 13.0', '>= 10.0'
   end
   spec.add_development_dependency 'cucumber', '~> 10.2.0', '>= 10.1.0'
   spec.add_development_dependency 'diff-lcs', '~> 1.3'
-  spec.add_development_dependency 'fakefs', '~> 3.0.0'
-  spec.add_development_dependency 'irb'
+  spec.add_development_dependency 'fakefs', '~> 3.2.0'
   spec.add_development_dependency 'mdl', '~> 0.15.0', '>= 0.12.0'
   spec.add_development_dependency 'minitest', '~> 6.0.0'
   spec.add_development_dependency 'minitest-around', '~> 0.6.0'
   spec.add_development_dependency 'minitest-mock'
   spec.add_development_dependency 'mocha', '~> 3.0.0'
-  spec.add_development_dependency 'ostruct'
   spec.add_development_dependency 'rake', '~> 13.3.0', '>= 11.0.0'
   spec.add_development_dependency 'rdoc'
   spec.add_development_dependency 'rexml', '>= 3.2.0'

test/fakefs_helper.rb

@@ -24,3 +24,16 @@ def home(user = Etc.getlogin)
   end
 end
 FakeFS::Dir.singleton_class.prepend(FakeFSPatch)
+
+# Patch FakeFS::Pathname to include the path method for Ruby 4.0.0 compatibility
+# This is needed because Reek's configuration internally calls Pathname#== which
+# requires the path method to be present
+module FakeFS
+  class Pathname
+    undef :path
+
+    def path
+      to_s
+    end
+  end
+end