rubocop-wait_for 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08126d86756d0151edd456f62eb9f40ff0089089d06338a6505734b91b8023a3'
-  data.tar.gz: 2995fde28c3e4e50aa26c480a1f7f25c8079cf1cc99b4169487afbc969f07cfe
+  metadata.gz: bc356107f4623b869f2744a7129a6ff2b19e41d5364e6d5f1b01ac635e5015fa
+  data.tar.gz: c3315dc89ad9f8760b67caa07c816c04c62cabd7343c33d4aaf68f0a6163b68f
 SHA512:
-  metadata.gz: 41b98558c352e332cae24e935987f87774e048c91229141d91b21a08f6bee5a4a0ec5193febe90d6d88b393dc7413692e5ac15ed6cf091c310984c83ca2a79c8
-  data.tar.gz: f5909346a3e37c0f8e2391fe3fa889c3e156b32c3e03ddd35caee12359fe1039b268afd67a883ba0d638e7a75b19b566d8d491f035789ae074b9a3c83527bee7
+  metadata.gz: 5fd55f9eb3bfd4efb51a4d9512d64cf956257ac0242604e77afb78cf3082e07b053168c08b5ed354d3499d149d62be1009a77ac50b14e7301c0c360d2e4f93a7
+  data.tar.gz: 57fa72330e959a0821402ab3a30e2a2e5b6cdf7c8e6bfe649ac2bc87ecd290d1ed76b66f1bc84a62d3af001de165ae62f80e2594fad443f4cc899f36f033d96a

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.2.1] - 2025:08-20
+
+- Fix `config/default.yml` configuration. [#6](https://github.com/viralpraxis/rubocop-wait_for/pull/6)
+
+## [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/config/default.yml

@@ -1,6 +1,4 @@
-# Write it!
-
 WaitFor/ConditionMet:
-  Description: 'TODO: Write a description of the cop.'
-  Enabled: pending
-  VersionAdded: '<<next>>'
+  Description: 'Checking if a condition evaluates to true.'
+  Enabled: true
+  VersionAdded: '0.1'

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

@@ -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.1'
+    VERSION = '0.2.1'
   end
 end

metadata

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