smart_todo 1.9.2 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: beb68e6ca2807c8c2fb782fb34109d5abe45f3e306cab7ad2f34b211f6a250aa
-  data.tar.gz: cc9978ba39c42bf194de59836c945197d066537187e34285857758bfcaf63ed5
+  metadata.gz: eed299ced3a12723ccf8cb775ea33b3ce784b1c05c18ced890b3c8b184c0124e
+  data.tar.gz: a2e1ff5973fb8b1b7b40ee700a56acbee6c6c30df0c23e16e8c9505fe24af8ba
 SHA512:
-  metadata.gz: 580080fabbbcc83ad8f372e56b5d4c2238688fc4617edd1501ac3032ddd61497db9e9c2a648f7a7b32acdda27790fa63fe0eb5c5c08d8b97c2e72116f2868f92
-  data.tar.gz: 6593132b64a848caa0205518b8c2124d04e6099b225af92e18ff997b5d204c1518c70c556280b766f3d6ea639bf9d4b44460152230f37baeda08f49f707bc889
+  metadata.gz: a36e6f20daabc1e3cdd74d8c5b63fd6284e0581de67b769dbeea5c97948f438cddefae166cf8c260d11237e6fbb22beeab9e0da1b0c069277f10c7d4ac1468ba
+  data.tar.gz: e020e58592618dd6567d8031dfe4c5c8c77bc7ccb372d7de2060c98f13ef072eaf31a01e16d2e9bc07118ea8553b2d716c95df19a0aed105b45baea1c6bf2406

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smart_todo (1.9.2)
+    smart_todo (1.10.0)
       prism (~> 1.0)
 
 GEM

data/lib/smart_todo/cli.rb

@@ -66,6 +66,9 @@ module SmartTodo
         opts.on("--dispatcher DISPATCHER") do |dispatcher|
           @options[:dispatcher] = dispatcher
         end
+        opts.on("--repo [REPO]", "Repository name to include in notifications") do |repo|
+          @options[:repo] = repo || File.basename(Dir.pwd)
+        end
       end
     end
 

data/lib/smart_todo/comment_parser.rb

@@ -2,6 +2,9 @@
 
 module SmartTodo
   class CommentParser
+    SUPPORTED_TAGS = ["TODO", "FIXME", "OPTIMIZE"].freeze
+    TAG_PATTERN = /^#\s(#{SUPPORTED_TAGS.join("|")})\(/
+
     attr_reader :todos
 
     def initialize
@@ -54,7 +57,7 @@ module SmartTodo
 
         source = comment.location.slice
 
-        if source.match?(/^#\sTODO\(/)
+        if source.match?(TAG_PATTERN)
           todos << current_todo if current_todo
           current_todo = Todo.new(source, filepath)
         elsif current_todo && (indent = source[/^#(\s*)/, 1].length) && (indent - current_todo.indent == 2)

data/lib/smart_todo/dispatchers/base.rb

@@ -68,7 +68,7 @@ module SmartTodo
         <<~EOM
           #{header}
 
-          You have an assigned TODO in the `#{@file}` file.
+          You have an assigned TODO in the `#{@file}` file#{repo}.
           #{@event_message}
 
           Here is the associated comment on your TODO:
@@ -91,6 +91,15 @@ module SmartTodo
       def existing_user
         "Hello :wave:,"
       end
+
+      def repo
+        repo = @options[:repo]
+        return unless repo
+
+        unless repo.empty?
+          " in repository `#{repo}`"
+        end
+      end
     end
   end
 end

data/lib/smart_todo/dispatchers/slack.rb

@@ -7,7 +7,8 @@ module SmartTodo
     class Slack < Base
       class << self
         def validate_options!(options)
-          options[:slack_token] ||= ENV.fetch("SMART_TODO_SLACK_TOKEN") { raise(ArgumentError, "Missing :slack_token") }
+          options[:slack_token] ||= ENV.fetch("SMART_TODO_SLACK_TOKEN", "")
+          raise(ArgumentError, "Missing :slack_token") if options[:slack_token].empty?
 
           options.fetch(:fallback_channel) { raise(ArgumentError, "Missing :fallback_channel") }
         end

data/lib/smart_todo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SmartTodo
-  VERSION = "1.9.2"
+  VERSION = "1.10.0"
 end

data/lib/smart_todo_cop.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "smart_todo"
+require "date"
 
 module RuboCop
   module Cop
@@ -12,12 +13,20 @@ module RuboCop
       class SmartTodoCop < Base
         HELP = "For more info please look at https://github.com/Shopify/smart_todo/wiki/Syntax"
         MSG = "Don't write regular TODO comments. Write SmartTodo compatible syntax comments. #{HELP}"
+        INVESTIGATED_TAGS = ::SmartTodo::CommentParser::SUPPORTED_TAGS +
+          ::SmartTodo::CommentParser::SUPPORTED_TAGS.map(&:downcase)
+        TODO_PATTERN = /^#\s@?(#{INVESTIGATED_TAGS.join("|")})\b/
 
         # @param processed_source [RuboCop::ProcessedSource]
         # @return [void]
         def on_new_investigation
           processed_source.comments.each do |comment|
-            next unless /^#\sTODO/.match?(comment.text)
+            next unless (match = TODO_PATTERN.match(comment.text))
+
+            if match[1] != match[1].upcase
+              add_offense(comment)
+              next
+            end
 
             metadata = metadata(comment.text)
 
@@ -25,10 +34,10 @@ module RuboCop
               add_offense(comment, message: "Invalid TODO format: #{metadata.errors.join(", ")}. #{HELP}")
             elsif !smart_todo?(metadata)
               add_offense(comment)
-            elsif (methods = invalid_event_methods(metadata.events)).any?
-              add_offense(comment, message: "Invalid event method(s): #{methods.join(", ")}. #{HELP}")
             elsif invalid_assignees(metadata.assignees).any?
               add_offense(comment, message: "Invalid event assignee. This method only accepts strings. #{HELP}")
+            elsif (invalid_events = validate_events(metadata.events)).any?
+              add_offense(comment, message: "#{invalid_events.join(". ")}. #{HELP}")
             end
           end
         end
@@ -49,17 +58,94 @@ module RuboCop
             metadata.assignees.any?
         end
 
-        # @param metadata [Array<SmartTodo::Parser::MethodNode>]
-        # @return [Array<String>]
-        def invalid_event_methods(events)
-          events.map(&:method_name).reject { |method| ::SmartTodo::Events.method_defined?(method) }
-        end
-
         # @param assignees [Array]
         # @return [Array]
         def invalid_assignees(assignees)
           assignees.reject { |assignee| assignee.is_a?(String) }
         end
+
+        # @param events [Array<SmartTodo::Todo::CallNode>]
+        # @return [Array<String>]
+        def validate_events(events)
+          invalid_methods = events.map(&:method_name).reject { |method| ::SmartTodo::Events.method_defined?(method) }
+          return ["Invalid event method(s): #{invalid_methods.join(", ")}"] if invalid_methods.any?
+
+          events.map do |event|
+            send(validate_method(event.method_name), event.arguments)
+          end.compact
+        end
+
+        # @param event_type [Symbol]
+        # @return [String]
+        def validate_method(event_type)
+          "validate_#{event_type}_args"
+        end
+
+        # @param args [Array]
+        # @return [String, nil] Returns error message if date is invalid, nil if valid
+        def validate_date_args(args)
+          date = args.first
+          Date.parse(date)
+          nil
+        rescue ArgumentError, TypeError
+          "Invalid date format: #{date}"
+        end
+
+        # @param args [Array]
+        # @return [String, nil] Returns error message if arguments are invalid, nil if valid
+        def validate_issue_close_args(args)
+          validate_fixed_arity_args(args, 3, "issue_close", ["organization", "repo", "issue_number"])
+        end
+
+        # @param args [Array]
+        # @return [String, nil] Returns error message if arguments are invalid, nil if valid
+        def validate_pull_request_close_args(args)
+          validate_fixed_arity_args(args, 3, "pull_request_close", ["organization", "repo", "pr_number"])
+        end
+
+        # @param args [Array]
+        # @return [String, nil] Returns error message if arguments are invalid, nil if valid
+        def validate_gem_release_args(args)
+          validate_gem_args(args, "gem_release")
+        end
+
+        # @param args [Array]
+        # @return [String, nil] Returns error message if arguments are invalid, nil if valid
+        def validate_gem_bump_args(args)
+          validate_gem_args(args, "gem_bump")
+        end
+
+        # @param args [Array]
+        # @return [String, nil] Returns error message if arguments are invalid, nil if valid
+        def validate_ruby_version_args(args)
+          if args.empty?
+            "Invalid ruby_version event: Expected at least 1 argument (version requirement), got 0"
+          elsif !args.all? { |arg| arg.is_a?(String) }
+            "Invalid ruby_version event: Version requirements must be strings"
+          end
+        end
+
+        # Helper method for validating fixed arity events
+        def validate_fixed_arity_args(args, expected_count, event_name, arg_names)
+          if args.size != expected_count
+            message = "Invalid #{event_name} event: Expected #{expected_count} arguments "
+            message += "(#{arg_names.join(", ")}), got #{args.size}"
+            message
+          elsif !args.all? { |arg| arg.is_a?(String) }
+            "Invalid #{event_name} event: Arguments must be strings"
+          end
+        end
+
+        # Helper method for validating gem-related events
+        def validate_gem_args(args, event_name)
+          if args.empty?
+            "Invalid #{event_name} event: Expected at least 1 argument (gem_name), got 0"
+          elsif !args[0].is_a?(String)
+            "Invalid #{event_name} event: First argument (gem_name) must be a string"
+          elsif args.size > 1 && !args[1..].all? { |arg| arg.is_a?(String) }
+            "Invalid #{event_name} event: Version requirements must be strings"
+          end
+        end
       end
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: smart_todo
 version: !ruby/object:Gem::Version
-  version: 1.9.2
+  version: 1.10.0
 platform: ruby
 authors:
 - Shopify
 bindir: exe
 cert_chain: []
-date: 2025-03-31 00:00:00.000000000 Z
+date: 2025-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prism