smart_todo 1.9.1 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d203126f1877df2db5e717ea31690fc81f42efe1da8c3286ac619e946f6bd75
-  data.tar.gz: cd9e9bbc4ab3a93db418d16296a9c634f55b571ad5dfe159ed8b25b6ec37cc22
+  metadata.gz: eed299ced3a12723ccf8cb775ea33b3ce784b1c05c18ced890b3c8b184c0124e
+  data.tar.gz: a2e1ff5973fb8b1b7b40ee700a56acbee6c6c30df0c23e16e8c9505fe24af8ba
 SHA512:
-  metadata.gz: 89fc8bb08ed5ea7be2590b8bcfc38bd2e5cc75e2da96c200b70a4a7308a77b2ab2592d8190433d1d9a97e649e20f2bc6a965fb48161223e9b3d9d93e32ae4c30
-  data.tar.gz: cc43abab984dfb7bfd1c97fdcfb0ea7bf045522ee328f46527fb15cfe899e64bd62ead2f63a9a5135f881a4ad757d84948aea23f7a89271e314241a5d8d3e9cf
+  metadata.gz: a36e6f20daabc1e3cdd74d8c5b63fd6284e0581de67b769dbeea5c97948f438cddefae166cf8c260d11237e6fbb22beeab9e0da1b0c069277f10c7d4ac1468ba
+  data.tar.gz: e020e58592618dd6567d8031dfe4c5c8c77bc7ccb372d7de2060c98f13ef072eaf31a01e16d2e9bc07118ea8553b2d716c95df19a0aed105b45baea1c6bf2406

data/.github/workflows/build.yml

@@ -15,7 +15,7 @@ jobs:
         version: [3.0, 3.1, 3.2, 3.3]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Ruby ${{ matrix.version }}
         uses: ruby/setup-ruby@v1
         with:

data/.github/workflows/rubocop.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smart_todo (1.9.1)
+    smart_todo (1.10.0)
       prism (~> 1.0)
 
 GEM
@@ -9,44 +9,47 @@ GEM
   specs:
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
-    ast (2.4.2)
+    ast (2.4.3)
     bigdecimal (3.1.9)
     crack (1.0.0)
       bigdecimal
       rexml
     hashdiff (1.1.2)
-    json (2.7.1)
-    language_server-protocol (3.17.0.3)
-    minitest (5.25.4)
-    parallel (1.24.0)
-    parser (3.3.0.5)
+    json (2.10.2)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    minitest (5.25.5)
+    parallel (1.26.3)
+    parser (3.3.7.3)
       ast (~> 2.4.1)
       racc
-    prism (1.0.0)
+    prism (1.4.0)
     public_suffix (6.0.1)
-    racc (1.7.3)
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.9.0)
-    rexml (3.4.0)
-    rubocop (1.62.1)
+    rake (13.2.1)
+    regexp_parser (2.10.0)
+    rexml (3.4.1)
+    rubocop (1.74.0)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.2)
-      parser (>= 3.3.0.4)
-    rubocop-shopify (2.14.0)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.42.0)
+      parser (>= 3.3.7.2)
+    rubocop-shopify (2.15.1)
       rubocop (~> 1.51)
     ruby-progressbar (1.13.0)
-    unicode-display_width (2.5.0)
-    webmock (3.24.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    webmock (3.25.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)

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
@@ -35,15 +36,17 @@ module SmartTodo
       def dispatch_one(assignee)
         user = slack_user_or_channel(assignee)
 
-        client.post_message(user.dig("user", "id"), slack_message(user, assignee))
-      rescue SlackClient::Error => error
-        if ["users_not_found", "channel_not_found", "is_archived"].include?(error.error_code)
-          user = { "user" => { "id" => @options[:fallback_channel] }, "fallback" => true }
-        else
-          raise(error)
-        end
+        return unless user
 
-        client.post_message(user.dig("user", "id"), slack_message(user, assignee))
+        begin
+          client.post_message(user.dig("user", "id"), slack_message(user, assignee))
+        rescue SlackClient::Error => error
+          user = handle_slack_error(error, "Error dispatching message")
+          retry
+        rescue Net::HTTPError => error
+          $stderr.puts "Error dispatching message: #{error.message}"
+          $stderr.puts "Response: #{error.response.body}"
+        end
       end
 
       private
@@ -58,12 +61,25 @@ module SmartTodo
         else
           { "user" => { "id" => assignee } }
         end
+      rescue SlackClient::Error => error
+        handle_slack_error(error, "Error finding user or channel")
+      rescue Net::HTTPError => error
+        $stderr.puts "Error finding user or channel: #{error.message}"
+        $stderr.puts "Response: #{error.response.body}"
       end
 
       # @return [SlackClient] an instance of SlackClient
       def client
         @client ||= SlackClient.new(@options[:slack_token])
       end
+
+      def handle_slack_error(error, message)
+        if ["users_not_found", "channel_not_found", "is_archived"].include?(error.error_code)
+          { "user" => { "id" => @options[:fallback_channel] }, "fallback" => true }
+        else
+          $stderr.puts "#{message}: #{error.message}"
+        end
+      end
     end
   end
 end

data/lib/smart_todo/slack_client.rb

@@ -32,16 +32,17 @@ module SmartTodo
     # Retrieve the Slack ID of a user from his email
     #
     # @param email [String]
+    # @param min_sleep [Integer] - the minimum sleep time in seconds in case of rate limiting
     # @return [Hash]
     #
     # @raise [Net::HTTPError] in case the request to Slack failed
     # @raise [SlackClient::Error] in case Slack returns a { ok: false } in the body
     #
     # @see https://api.slack.com/methods/users.lookupByEmail
-    def lookup_user_by_email(email)
+    def lookup_user_by_email(email, min_sleep = 30)
       headers = default_headers.merge("Content-Type" => "application/x-www-form-urlencoded")
       request = Net::HTTP::Get.new("/api/users.lookupByEmail?email=#{CGI.escape(email)}", headers)
-      dispatch(request)
+      dispatch(request, 5, min_sleep)
     end
 
     # Send a message to a Slack channel or to a user
@@ -63,25 +64,27 @@ module SmartTodo
 
     private
 
-    # @param method [Symbol]
-    # @param endpoint [String]
-    # @param data [String] JSON encoded data when making a POST request
-    # @param headers [Hash]
+    # @param request [Net::HTTPRequest]
+    # @param max_attempts [Integer] - the maximum number of attempts to make
+    # @param min_sleep [Integer] - the minimum sleep time in seconds in case of rate limiting
     #
     # @raise [Net::HTTPError] in case the request to Slack failed
     # @raise [SlackClient::Error] in case Slack returns a { ok: false } in the body
-    def dispatch(request, max_attempts = 5)
+    def dispatch(request, max_attempts = 5, min_sleep = 30)
       response = @client.request(request)
       attempts = 1
 
       while response.is_a?(Net::HTTPTooManyRequests) && attempts < max_attempts
-        sleep([Integer(response["Retry-After"]), 600].min)
+        sleep_time = Integer(response["Retry-After"]).clamp(min_sleep, 120)
+        puts "Rate limited, sleeping for #{sleep_time} seconds"
+        sleep(sleep_time)
         response = @client.request(request)
         attempts += 1
       end
 
       unless response.code_type < Net::HTTPSuccess
-        raise(Net::HTTPError.new("Request to slack failed", response))
+        message = "Request to slack failed #{response.body}, code #{response.code}, attempt #{attempts}"
+        raise(Net::HTTPError.new(message, response))
       end
 
       body = JSON.parse(response.body)

data/lib/smart_todo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SmartTodo
-  VERSION = "1.9.1"
+  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,8 +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
@@ -47,10 +58,93 @@ module RuboCop
             metadata.assignees.any?
         end
 
-        # @param metadata [Array<SmartTodo::Parser::MethodNode>]
+        # @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 invalid_event_methods(events)
-          events.map(&:method_name).reject { |method| ::SmartTodo::Events.method_defined?(method) }
+        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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: smart_todo
 version: !ruby/object:Gem::Version
-  version: 1.9.1
+  version: 1.10.0
 platform: ruby
 authors:
 - Shopify
 bindir: exe
 cert_chain: []
-date: 2025-02-04 00:00:00.000000000 Z
+date: 2025-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prism
@@ -147,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 3.6.6
 specification_version: 4
 summary: Enhance todo's comments in your codebase.
 test_files: []