smart_todo 1.9.0 → 1.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 170d33c5c9e48fbfe0ee1507a0f3f2ead41a6c931f25730205e62451cabe4eec
-  data.tar.gz: 1f549b5af2613e3ea18cb42e00c01c97edf2d0f48ccf0b25d47a4695798ce945
+  metadata.gz: beb68e6ca2807c8c2fb782fb34109d5abe45f3e306cab7ad2f34b211f6a250aa
+  data.tar.gz: cc9978ba39c42bf194de59836c945197d066537187e34285857758bfcaf63ed5
 SHA512:
-  metadata.gz: f51affefbc4906000a4e767d8d610f609e627a51258ae249b186e231e67e531d165fa03a0a7385e50b7ef8d96ea3f990c7cc98f42cb1519f2d94f82f24c54e72
-  data.tar.gz: a4d608772b81419a7c5d46a14b11ed4b862ce5f22c67c39d64dca9b1aa8c54a88e6e5256c5527ca5b9bb940dd9c5fd565ca9cca42566383b1f27c9c1ee692d61
+  metadata.gz: 580080fabbbcc83ad8f372e56b5d4c2238688fc4617edd1501ac3032ddd61497db9e9c2a648f7a7b32acdda27790fa63fe0eb5c5c08d8b97c2e72116f2868f92
+  data.tar.gz: 6593132b64a848caa0205518b8c2124d04e6099b225af92e18ff997b5d204c1518c70c556280b766f3d6ea639bf9d4b44460152230f37baeda08f49f707bc889

data/.github/dependabot.yml

@@ -0,0 +1,20 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    labels:
+      - "dependencies"
+    groups:
+      minor-and-patch:
+        update-types:
+          - "minor"
+          - "patch"
+    open-pull-requests-limit: 100
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    labels:
+      - "dependencies"

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,51 +1,56 @@
 PATH
   remote: .
   specs:
-    smart_todo (1.9.0)
+    smart_todo (1.9.2)
       prism (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.2)
-    crack (0.4.5)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.3)
+    bigdecimal (3.1.9)
+    crack (1.0.0)
+      bigdecimal
       rexml
-    hashdiff (1.0.1)
-    json (2.7.1)
-    language_server-protocol (3.17.0.3)
-    minitest (5.14.4)
-    parallel (1.24.0)
-    parser (3.3.0.5)
+    hashdiff (1.1.2)
+    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)
-    public_suffix (4.0.6)
-    racc (1.7.3)
+    prism (1.4.0)
+    public_suffix (6.0.1)
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.9.0)
-    rexml (3.2.6)
-    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.11.2)
-      addressable (>= 2.3.6)
+    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/dispatchers/slack.rb

@@ -35,15 +35,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 +60,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.0"
+  VERSION = "1.9.2"
 end

data/lib/smart_todo_cop.rb

@@ -9,13 +9,13 @@ module RuboCop
       # This Cop does not run by default. It should be added to the RuboCop host's configuration file.
       #
       # @see https://rubocop.readthedocs.io/en/latest/extensions/#loading-extensions
-      class SmartTodoCop < Cop
+      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}"
 
         # @param processed_source [RuboCop::ProcessedSource]
         # @return [void]
-        def investigate(processed_source)
+        def on_new_investigation
           processed_source.comments.each do |comment|
             next unless /^#\sTODO/.match?(comment.text)
 
@@ -27,6 +27,8 @@ module RuboCop
               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}")
             end
           end
         end
@@ -52,6 +54,12 @@ module RuboCop
         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
       end
     end
   end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: smart_todo
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.9.2
 platform: ruby
 authors:
 - Shopify
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-29 00:00:00.000000000 Z
+date: 2025-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prism
@@ -92,6 +91,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".devcontainer/devcontainer.json"
+- ".github/dependabot.yml"
 - ".github/workflows/build.yml"
 - ".github/workflows/cla.yml"
 - ".github/workflows/rubocop.yml"
@@ -133,7 +133,6 @@ metadata:
   source_code_uri: https://github.com/shopify/smart_todo
   changelog_uri: https://github.com/shopify/smart_todo/releases
   allowed_push_host: https://rubygems.org
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -148,8 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
-signing_key:
+rubygems_version: 3.6.6
 specification_version: 4
 summary: Enhance todo's comments in your codebase.
 test_files: []