rubocop-wait_for 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2838e7a28daeb2b42c69f22aa9a355d4c1b8121a20418a34f0c4e32eb0f92c0f
+  data.tar.gz: 49c4575ac16e5ac806c04ec6d7233dde8e1b714afa4a4cc7f1244b35fddbcdd2
+SHA512:
+  metadata.gz: fc900f5b918bf09c8677f3536bba3afd463477439976779622cb9924fb51189871648e0d834c9b30962e56323683ed54d513dd8810abb0fac58d51e563c11ff1
+  data.tar.gz: 3481d3386f03e303c75c443995af1d9ad025f4016b8a3e48e110dd0b3c03475bd075f62a03e0e20813ec81c79022a022f682144ba71b4362eb9bcb7900c03379

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,21 @@
+plugins:
+  - rubocop-internal_affairs
+  - rubocop-packaging
+  - rubocop-rake
+  - rubocop-rspec
+  - rubocop-wait_for
+
+AllCops:
+  NewCops: enable
+
+Naming/FileName:
+  Exclude:
+    - lib/rubocop-wait_for.rb
+
+Style/FormatStringToken:
+  Exclude:
+    - spec/**/*
+
+WaitFor/ConditionMet:
+  Exclude:
+    - lib/rubocop/cop/wait_for/condition_met.rb

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-07-07
+
+- Initial release.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Yaroslav
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,102 @@
+# RuboCop WaitFor
+
+## Installation
+
+Just install the `rubocop-wait_for` gem
+
+```bash
+gem install rubocop-wait_for
+```
+
+or if you use bundler put this in your `Gemfile`
+
+```ruby
+gem 'rubocop-wait_for', require: false
+```
+
+## Usage
+
+You need to tell RuboCop to load the WaitFor extension. There are two
+ways to do this:
+
+### RuboCop configuration file
+
+Put this into your `.rubocop.yml`.
+
+```yaml
+plugins:
+  - rubocop-other-extension
+  - rubocop-wait_for
+```
+
+Now you can run `rubocop` and it will automatically load the RuboCop WaitFor
+cops together with the standard cops.
+
+> [!NOTE]
+> The plugin system is supported in RuboCop 1.72+. In earlier versions, use `require` instead of `plugins`.
+
+### Command line
+
+```bash
+rubocop --plugin rubocop-wait_for
+```
+
+### Rake task
+
+```ruby
+RuboCop::RakeTask.new do |task|
+  task.plugins << 'rubocop-wait_for'
+end
+```
+
+## Purpose
+
+`rubocop-wait_for` introduces the `WaitFor/ConditionMet` cop, which scans source comments for wait-for directives:
+
+```ruby
+# wait-for Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.4.0')
+some_code_to_remove_once_ruby34_is_in_use()
+```
+
+> [!NOTE]
+>
+> Use can alias 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.
+
+This enables workflows like:
+
+- Automatically flagging feature-flagged code once the feature is launched.
+
+- Alerting when temporary code should be deleted (e.g. after a given date or version).
+
+- Monitoring environment-specific conditions in CI pipelines.
+
+> [!WARNING]
+> All the code found after the directive is passed directly to `Kernel.eval`. Use with caution.
+
+### Caveats
+
+1. Missing dependencies
+
+   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()
+   ```
+
+2. Caching
+
+   Since `rubocop-wait_for` depends on RuboCop’s caching mechanism, offenses might not be reported until the cache is invalidated — for instance for dynamic conditions like time-based checks.
+
+   You can force cache invalidation by passing `RUBOCOP_WAIT_FOR_CHECK_ALL=1` environment variable:
+
+   ```shell
+   RUBOCOP_WAIT_FOR_CHECK_ALL=1 bundle exec rubocop --only WaitFor/ConditionMet
+   ```
+
+## License
+
+`rubocop-wait_for` is MIT licensed. [See the accompanying file](LICENSE) for
+the full text.

data/Rakefile

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+task default: %i[spec]
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc 'Generate a new cop with a template'
+task :new_cop, [:cop] do |_task, args|
+  require 'rubocop'
+
+  cop_name = args.fetch(:cop) do
+    warn 'usage: bundle exec rake new_cop[Department/Name]'
+    exit!
+  end
+
+  generator = RuboCop::Cop::Generator.new(cop_name)
+
+  generator.write_source
+  generator.write_spec
+  generator.inject_require(root_file_path: 'lib/rubocop/cop/wait_for_cops.rb')
+  generator.inject_config(config_file_path: 'config/default.yml')
+
+  puts generator.todo
+end

data/config/default.yml

@@ -0,0 +1,6 @@
+# Write it!
+
+WaitFor/ConditionMet:
+  Description: 'TODO: Write a description of the cop.'
+  Enabled: pending
+  VersionAdded: '<<next>>'

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module WaitFor
+      # Evaluates annotated comments that specify a runtime condition and
+      # registers an offense once the condition evaluates to true.
+      #
+      # It is designed to support use cases such as removing temporary code once a
+      # feature flag is enabled, a deprecation deadline is reached, or some
+      # environment-dependent behavior becomes active.
+      #
+      # @example
+      #   # bad
+      #   # Assuming RUBY_VERSION is '3.4.4'
+      #   # wait-for Gem::Version.new(RUBY_VERSION) >= '3.4.0'
+      #   some_code_to_update_upon_upgrading_to_ruby34
+      #
+      #   # good
+      #   # Assuming RUBY_VERSION is '3.3.8'
+      #   # wait-for Gem::Version.new(RUBY_VERSION) >= '3.4.0'
+      #   some_code_to_update_upon_upgrading_to_ruby34
+      class ConditionMet < Base
+        DIRECTIVE_PATTERN = /#\s*(?:rubocop[:\-])?wait-for\s+(.+)/.freeze
+        private_constant(*constants(false))
+
+        MSG = 'condition has been met.'
+
+        def external_dependency_checksum
+          Time.now.to_i.to_s if ENV['RUBOCOP_WAIT_FOR_CHECK_ALL'] == '1'
+        end
+
+        def on_new_investigation
+          return if processed_source.buffer.source.empty?
+
+          processed_source.comments.each do |comment|
+            next unless (condition = DIRECTIVE_PATTERN.match(comment.text))
+
+            result = evaluate_condition(condition.captures[0])
+
+            add_offense(comment) if result == true
+          end
+        end
+
+        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}"
+
+          false
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/wait_for_cops.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'wait_for/condition_met'

data/lib/rubocop/wait_for/plugin.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'lint_roller'
+
+module RuboCop
+  module WaitFor
+    # A plugin that integrates rubocop-wait_for with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-wait_for',
+          version: VERSION,
+          homepage: 'https://github.com/viralpraxis/rubocop-wait_for',
+          description: 'A RuboCop extension for tracking code that depends on runtime conditions.'
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: Pathname.new(__dir__).join('../../../config/default.yml')
+        )
+      end
+    end
+  end
+end

data/lib/rubocop/wait_for/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module WaitFor
+    VERSION = '0.1.0'
+  end
+end

data/lib/rubocop/wait_for.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'wait_for/version'
+
+module RuboCop
+  module WaitFor
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/lib/rubocop-wait_for.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+require_relative 'rubocop/wait_for'
+require_relative 'rubocop/wait_for/version'
+require_relative 'rubocop/wait_for/plugin'
+
+require_relative 'rubocop/cop/wait_for_cops'

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-wait_for
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yaroslav Kurbatov
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lint_roller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: |-
+  Provides a custom RuboCop cop that flags annotated code once a specified runtime condition becomes true.
+  Useful for enforcing cleanup of temporary code paths,
+  such as feature toggles, deprecations, or environment-based logic.
+email:
+- iaroslav2k@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- Rakefile
+- config/default.yml
+- lib/rubocop-wait_for.rb
+- lib/rubocop/cop/wait_for/condition_met.rb
+- lib/rubocop/cop/wait_for_cops.rb
+- lib/rubocop/wait_for.rb
+- lib/rubocop/wait_for/plugin.rb
+- lib/rubocop/wait_for/version.rb
+homepage: https://github.com/viralpraxis/rubocop-wait_for
+licenses: []
+metadata:
+  homepage_uri: https://github.com/viralpraxis/rubocop-wait_for
+  source_code_uri: https://github.com/viralpraxis/rubocop-wait_for
+  changelog_uri: https://github.cohm/viralpraxis/rubocop-wait_for/blob/main/CHANGELOG.md
+  default_lint_roller_plugin: RuboCop::WaitFor::Plugin
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: A RuboCop extension for tracking code that depends on runtime conditions.
+test_files: []