rubocop-sane 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46577dac32dde6106d874ce5fa85e7a54a94d589e075b54d281d7b68d9649e19
-  data.tar.gz: 8e1280ecc3bee57ed3cb65924ee86ce9b02c6032e74ee58864989fdf9b4cdac9
+  metadata.gz: dd899cb79b69d5e80e9712f16cff748e59565061964ee199ee948413acadb4ae
+  data.tar.gz: d5199b3b74466a2ad62c7fc0b6c15633e3c07b3e4aa67a9465b65293c51917f3
 SHA512:
-  metadata.gz: 70e429be341dc7b52167483547162dcf4f52a99f278c98782eec989d0a8a061b72f40cd8dfd5d8b9d56cdfd79b9eb3c1934c353e1de29b435f46790b9c1586eb
-  data.tar.gz: 58dc631f79eb2cb9a022359fe0ba690ae55607b927b840113f469f648909f205619d5ef15fd427d88a24ed1ddac43fd7156b0aa7c1576385585951b5228706ea
+  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/empty_line_before_comment.rb

@@ -48,6 +48,7 @@ module RuboCop
         private
 
         def check_comment(comment)
+          return if rubocop_directive?(comment)
           return if inline_comment?(comment)
           return if first_line?(comment)
           return if preceded_by_empty_line?(comment)
@@ -64,6 +65,10 @@ module RuboCop
           end
         end
 
+        def rubocop_directive?(comment)
+          comment.text.match?(/\A#\s*rubocop:(enable|disable|todo)\b/)
+        end
+
         def inline_comment?(comment)
           # Check if there's code before the comment on the same line
           comment_line = processed_source.lines[comment.loc.line - 1]
@@ -106,26 +111,26 @@ module RuboCop
         def block_start_pattern?(line)
           stripped = line.strip
 
-          # Class, module, method definitions
-          return true if stripped.match?(/\A(class|module|def)\s/)
+          # Class, module, method definitions (including decorated methods like `memoize def`)
+          return true if stripped.match?(/\A(class|module)\s/) || stripped.match?(/\bdef\s/)
 
           # Control structures
-          return true if stripped.match?(/\A(if|unless|case|while|until|for|begin)\s/)
-          return true if stripped == "begin"
+          return true if stripped.match?(/\A(if|unless|case|while|until|for|begin)\b/)
 
           # Block openers (do or {)
-          return true if stripped.end_with?(" do", " do |", "\tdo")
-          return true if stripped.match?(/do\s*\|[^|]*\|\s*\z/)
-          return true if stripped.end_with?("{")
-          return true if stripped.match?(/\{\s*\|[^|]*\|\s*\z/)
+          return true if block_opener?(stripped)
 
           # Rescue/ensure/else/elsif/when inside blocks
           return true if stripped.match?(/\A(rescue|ensure|else|elsif|when)\b/)
 
           # Private/protected/public access modifiers
-          return true if stripped.match?(/\A(private|protected|public)\s*\z/)
+          stripped.match?(/\A(private|protected|public)\s*\z/)
+        end
 
-          false
+        def block_opener?(line)
+          line.end_with?(" do", " do |", "\tdo", "{", "[") ||
+            line.match?(/do\s*\|[^|]*\|\s*\z/) ||
+            line.match?(/\{\s*\|[^|]*\|\s*\z/)
         end
       end
     end

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.1.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.1.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