rubocop-wait_for 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2838e7a28daeb2b42c69f22aa9a355d4c1b8121a20418a34f0c4e32eb0f92c0f
-  data.tar.gz: 49c4575ac16e5ac806c04ec6d7233dde8e1b714afa4a4cc7f1244b35fddbcdd2
+  metadata.gz: 23ddd9507b68778bdaa0eeb610b0329012cec58a31f09daed27299b9c12d516a
+  data.tar.gz: ef6c94d9f0610586aab0c989905d8605fef4213a2fd4c66085a793003f65739c
 SHA512:
-  metadata.gz: fc900f5b918bf09c8677f3536bba3afd463477439976779622cb9924fb51189871648e0d834c9b30962e56323683ed54d513dd8810abb0fac58d51e563c11ff1
-  data.tar.gz: 3481d3386f03e303c75c443995af1d9ad025f4016b8a3e48e110dd0b3c03475bd075f62a03e0e20813ec81c79022a022f682144ba71b4362eb9bcb7900c03379
+  metadata.gz: 7b1fbbc872062f81acae711cc4a9eb0509c7b905e0062c261b236dc990b447ca4b94df8dc3fef148dba1e7b36ee9f384d39617f7dea50cb33b45bece2da46b37
+  data.tar.gz: c0534dcae8cb5d69d78de13a42b820137641d532d7931a79d7d2d11444834258c08b45238038a4bd951a459a903d51053cbc2281e6d570c055cbb77b1f45828f

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.2.0] - 2025-08-13
+
+- Add support for statically evaluated gem version requirements. [#4](https://github.com/viralpraxis/rubocop-wait_for/pull/4)
+
 ## [0.1.0] - 2025-07-07
 
 - Initial release.

data/README.md

@@ -60,7 +60,7 @@ some_code_to_remove_once_ruby34_is_in_use()
 
 > [!NOTE]
 >
-> Use can alias use an alias `rubocop-wait-for <code>`
+> Use can use an alias `# rubocop-wait-for <code>`
 
 If the condition inside the comment evaluates to `true` at the time of linting, RuboCop registers an offense.
 
@@ -75,6 +75,24 @@ This enables workflows like:
 > [!WARNING]
 > All the code found after the directive is passed directly to `Kernel.eval`. Use with caution.
 
+Another situation this cop might be useful in is checking gem version.
+
+You can achieve it by using a special form of the magic comment:
+
+```ruby
+# wait-for gem-version rails '>= 8.1'
+```
+
+This condition evaluates to `true` when the detected Rails version is at least `8.1`.
+
+Note that gem versions are determined statically using RuboCop’s [built-in feature](https://docs.rubocop.org/rubocop/development.html#limit-by-ruby-or-gem-versions).
+
+You can also use multiple version requirements:
+
+```ruby
+# wait-for gem-version rails '>= 8.1' '< 8.4'
+```
+
 ### Caveats
 
 1. Missing dependencies
@@ -82,8 +100,8 @@ This enables workflows like:
    RuboCop does not automatically load project dependencies from your `Gemfile.lock`. If your condition relies on gems like Rails, you may need to require them manually:
 
    ```ruby
-   # wait-for require 'rails/gem_version'; Rails.gem_version >= Gem::Version.new('9.0.0')
-   some_code_to_remove_once_rails90_is_in_use()
+   # wait-for require 'rails'; defined?(::Rails.some_new_feature) != nil
+   some_code_to_remove_once_new_rails_feature_is_available()
    ```
 
 2. Caching

data/lib/rubocop/cop/wait_for/condition_met.rb

@@ -24,7 +24,7 @@ module RuboCop
         DIRECTIVE_PATTERN = /#\s*(?:rubocop[:\-])?wait-for\s+(.+)/.freeze
         private_constant(*constants(false))
 
-        MSG = 'condition has been met.'
+        MSG = 'Condition has been met.'
 
         def external_dependency_checksum
           Time.now.to_i.to_s if ENV['RUBOCOP_WAIT_FOR_CHECK_ALL'] == '1'
@@ -45,11 +45,38 @@ module RuboCop
         private
 
         def evaluate_condition(condition)
-          Kernel.eval(condition) # rubocop:disable Security/Eval
-        rescue Exception => e # rubocop:disable Lint/RescueException
-          Kernel.warn "#{self.class.name}: Encountered exception during evaluating condition: #{e.message}"
+          if (gem_condition = gem_version_condition(condition))
+            gem_version_requirement_met?(gem_condition)
+          else
+            begin
+              Kernel.eval(condition) # rubocop:disable Security/Eval
+            rescue Exception => e # rubocop:disable Lint/RescueException
+              Kernel.warn "#{self.class.name}: Encountered exception during evaluating condition: #{e.message}"
 
-          false
+              false
+            end
+          end
+        end
+
+        def gem_version_condition(condition)
+          unless (match_data = /\Agem-version\s+([a-zA-Z0-9_-]+)\s+((?:['"][^'"]+['"]\s*)+)\z/i.match(condition.strip))
+            return
+          end
+
+          {
+            gem_name: match_data[1],
+            requirements: Gem::Requirement.new(match_data[2].scan(/['"]([^'"]+)['"]/).flatten)
+          }
+        end
+
+        def gem_version_requirement_met?(gem_version_requirement)
+          all_gem_versions_in_target = @config.gem_versions_in_target
+          return false unless all_gem_versions_in_target
+
+          gem_version_in_target = all_gem_versions_in_target[gem_version_requirement.fetch(:gem_name)]
+          return false unless gem_version_in_target
+
+          gem_version_requirement.fetch(:requirements).satisfied_by?(gem_version_in_target)
         end
       end
     end

data/lib/rubocop/wait_for/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module WaitFor
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/lib/rubocop/wait_for.rb

@@ -3,8 +3,5 @@
 require_relative 'wait_for/version'
 
 module RuboCop
-  module WaitFor
-    class Error < StandardError; end
-    # Your code goes here...
-  end
+  module WaitFor; end # rubocop:disable Style/Documentation
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-wait_for
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yaroslav Kurbatov