Merge pull request #1137 from amomchilov/migrate-to-requires_gem-api

Migrate `TargetRailsVersion` to the new `requires_gem` RuboCop API
rubocop · Apr 9, 2024 · 891de22 · 891de22
2 parents 0cd57a8 + 4e1eca3
commit 891de22
Show file tree

Hide file tree

Showing 3 changed files with 61 additions and 33 deletions.
diff --git a/changelog/change_migrate_to_requires_gem_api.md b/changelog/change_migrate_to_requires_gem_api.md
@@ -0,0 +1 @@
+* [#1137](https://github.com/rubocop/rubocop-rails/pull/1137): Migrate to `TargetRailsVersion` the new [`requires_gem` API](https://github.com/rubocop/rubocop/pull/12186). ([@amomchilov][])
diff --git a/lib/rubocop/cop/mixin/target_rails_version.rb b/lib/rubocop/cop/mixin/target_rails_version.rb
@@ -4,13 +4,40 @@ module RuboCop
   module Cop
     # Common functionality for checking target rails version.
     module TargetRailsVersion
+      # Informs the base RuboCop gem that it the Rails version is checked via `requires_gem` API,
+      # without needing to call this `#support_target_rails_version` method.
+      USES_REQUIRES_GEM_API = true
+
       def minimum_target_rails_version(version)
-        @minimum_target_rails_version = version
+        if respond_to?(:requires_gem)
+          case version
+          when Integer, Float then requires_gem(TARGET_GEM_NAME, ">= #{version}")
+          when String then requires_gem(TARGET_GEM_NAME, version)
+          end
+        else
+          # Fallback path for previous versions of RuboCop which don't support the `requires_gem` API yet.
+          @minimum_target_rails_version = version
+        end
       end
 
       def support_target_rails_version?(version)
-        @minimum_target_rails_version <= version
+        if respond_to?(:requires_gem)
+          return false unless gem_requirements
+
+          gem_requirement = gem_requirements[TARGET_GEM_NAME]
+          return true unless gem_requirement # If we have no requirement, then we support all versions
+
+          gem_requirement.satisfied_by?(Gem::Version.new(version))
+        else
+          # Fallback path for previous versions of RuboCop which don't support the `requires_gem` API yet.
+          @minimum_target_rails_version <= version
+        end
       end
+
+      # Look for `railties` instead of `rails`, to support apps that only use a subset of `rails`
+      # See https://github.com/rubocop/rubocop/pull/11289
+      TARGET_GEM_NAME = 'railties'
+      private_constant :TARGET_GEM_NAME
     end
   end
 end
diff --git a/spec/rubocop/config_spec.rb b/spec/rubocop/config_spec.rb
@@ -61,20 +61,20 @@
                   remote: https://rubygems.org/
                   specs:
                     actionmailer (4.1.0)
-                    actionpack (= 4.1.0)
-                    actionview (= 4.1.0)
-                    mail (~> 2.5.4)
-                  rails (4.1.0)
-                    actionmailer (= 4.1.0)
-                    actionpack (= 4.1.0)
-                    actionview (= 4.1.0)
-                    activemodel (= 4.1.0)
-                    activerecord (= 4.1.0)
-                    activesupport (= 4.1.0)
-                    bundler (>= 1.3.0, < 2.0)
-                    railties (= 4.1.0)
-                    sprockets-rails (~> 2.0)
-                  railties (4.1.0)
+                    actionpack (4.1.0)
+                    actionview (4.1.0)
+                    mail (2.5.4)
+                    rails (4.1.0)
+                      actionmailer (= 4.1.0)
+                      actionpack (= 4.1.0)
+                      actionview (= 4.1.0)
+                      activemodel (= 4.1.0)
+                      activerecord (= 4.1.0)
+                      activesupport (= 4.1.0)
+                      bundler (>= 1.3.0, < 2.0)
+                      railties (= 4.1.0)
+                      sprockets-rails (~> 2.0)
+                    railties (4.1.0)
 
                 PLATFORMS
                   ruby
@@ -96,20 +96,20 @@
                   remote: https://rubygems.org/
                   specs:
                     actionmailer (4.1.0)
-                    actionpack (= 4.1.0)
-                    actionview (= 4.1.0)
-                    mail (~> 2.5.4)
-                  rails (400.33.22)
-                    actionmailer (= 4.1.0)
-                    actionpack (= 4.1.0)
-                    actionview (= 4.1.0)
-                    activemodel (= 4.1.0)
-                    activerecord (= 4.1.0)
-                    activesupport (= 4.1.0)
-                    bundler (>= 1.3.0, < 2.0)
-                    railties (= 4.1.0)
-                    sprockets-rails (~> 2.0)
-                  railties (400.33.22)
+                    actionpack (4.1.0)
+                    actionview (4.1.0)
+                    mail (2.5.4)
+                    rails (400.33.22)
+                      actionmailer (= 4.1.0)
+                      actionpack (= 4.1.0)
+                      actionview (= 4.1.0)
+                      activemodel (= 4.1.0)
+                      activerecord (= 4.1.0)
+                      activesupport (= 4.1.0)
+                      bundler (>= 1.3.0, < 2.0)
+                      railties (= 4.1.0)
+                      sprockets-rails (~> 2.0)
+                    railties (400.33.22)
 
                 PLATFORMS
                   ruby
@@ -131,9 +131,9 @@
                   remote: https://rubygems.org/
                   specs:
                     actionmailer (4.1.0)
-                    actionpack (= 4.1.0)
-                    actionview (= 4.1.0)
-                    mail (~> 2.5.4)
+                    actionpack (4.1.0)
+                    actionview (4.1.0)
+                    mail (2.5.4)
 
                 PLATFORMS
                   ruby