rubocop-sane 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bdd1696e7b903bed1518dd449a1187a1551d877a5a479e7d53c4a04be014039
-  data.tar.gz: ef30ea5fc869a96828e02253e41437bad4906f99f713c1b5919c58c9a7c27e80
+  metadata.gz: dd899cb79b69d5e80e9712f16cff748e59565061964ee199ee948413acadb4ae
+  data.tar.gz: d5199b3b74466a2ad62c7fc0b6c15633e3c07b3e4aa67a9465b65293c51917f3
 SHA512:
-  metadata.gz: 9b108fd043e227b5d78526ac3f3a6b21b1e36701958ee2f9fc4537b98779bb380680cbd7d400282fba3a3f8b51dac4066033f299312bc3402df4f41fa49d54e2
-  data.tar.gz: c87f908957513184b4c36e1b0f0ad1f2204a50f98525ab800c9d3313b0b1a00a22f12d93d22f704c9c6e36f30e84f6a3f9fd51fd353ece856d4aedd383ae68c8
+  metadata.gz: f0a243dbd2dab34f2907cf9dd18abf84226ff2cc70992ca7a84faa04a700c8be0c307b07767a7df073a5d52a05d4d21f3aa4868b9acb06c464d84c05a4723a46
+  data.tar.gz: 403df07bdb9611e535edf8aa868c84bd80c7c62c643380d7e9f1dfc0d2c4a102969c83a2f42ee0f7f7b0cf5f45ec235850de31a2e9cac3a03e91006aaa9e06c1

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.3.0] - 2025-12-20
+
+- Add `Sane/OutdatedComments` cop
+
+## [0.2.0] - 2025-12-20
+
+- Add `Sane/NoMethodCallAfterEnd` cop
+- Improve `Sane/EmptyLineBeforeComment` cop
+
 ## [0.1.0] - 2025-12-19
 
 - Initial release

data/config/default.yml

@@ -31,3 +31,8 @@ Sane/NoMethodCallAfterEnd:
   Description: "Prohibits calling methods directly after `end`."
   Enabled: true
   VersionAdded: "0.1.0"
+
+Sane/OutdatedComments:
+  Description: "Detects TODO/NOTE/FIXME comments with dates in the past."
+  Enabled: true
+  VersionAdded: "0.2.0"

data/lib/rubocop/cop/sane/outdated_comments.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "date"
+
+module RuboCop
+  module Cop
+    module Sane
+      # Detects TODO/NOTE/FIXME comments with dates that are in the past.
+      #
+      # This cop helps ensure that dated comments are reviewed when their
+      # target date has passed.
+      #
+      # @example
+      #   # bad (when date is in the past)
+      #   # TODO[2024-01-01]: Remove this after migration
+      #   # NOTE[2023-06-15]: Temporary workaround
+      #   # FIXME[2024-03-01]: Fix this bug
+      #
+      #   # good (when date is in the future or today)
+      #   # TODO[2025-12-31]: Remove this after migration
+      #
+      class OutdatedComments < Base
+        COMMENT_PATTERN = /^#\s*(NOTE|TODO|FIXME)\[(\d{4}-\d{2}-\d{2})\]:/i
+        MSG = "Review or remove this outdated comment dated %<date>s"
+
+        def on_new_investigation
+          return unless processed_source.valid_syntax?
+
+          processed_source.comments.each do |comment|
+            check_comment(comment)
+          end
+        end
+
+        private
+
+        def check_comment(comment)
+          match = comment.text.match(COMMENT_PATTERN)
+          return unless match
+
+          date_str = match[2]
+          parsed_date = Date.parse(date_str)
+
+          return if parsed_date >= Date.today
+
+          message = format(MSG, date: date_str)
+          add_offense(comment.source_range, severity: :warning, message:)
+        rescue Date::Error
+          # Invalid date format, ignore
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/sane_cops.rb

@@ -5,3 +5,4 @@ require_relative "sane/conditional_assignment_allow_ternary"
 require_relative "sane/empty_line_before_comment"
 require_relative "sane/empty_lines_around_multiline_block"
 require_relative "sane/no_method_call_after_end"
+require_relative "sane/outdated_comments"

data/lib/rubocop/sane/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Sane
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-sane
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Kodkod
@@ -67,6 +67,7 @@ files:
 - lib/rubocop/cop/sane/empty_line_before_comment.rb
 - lib/rubocop/cop/sane/empty_lines_around_multiline_block.rb
 - lib/rubocop/cop/sane/no_method_call_after_end.rb
+- lib/rubocop/cop/sane/outdated_comments.rb
 - lib/rubocop/cop/sane_cops.rb
 - lib/rubocop/sane.rb
 - lib/rubocop/sane/plugin.rb