smart_todo 1.3.0 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e7fe4f3876be333b1df4dcd44d965e57a0725e65900f96a518bd6a49d608165
-  data.tar.gz: 02b5370dfc45cc2337d973db79a3a6bddccb8ae295d2ec529eebbb166247873b
+  metadata.gz: b21d53a3957ea19430b3726fd82fefeceef262330ead8eb9ef1ef087acd29bb4
+  data.tar.gz: 3927e36c7c059e90613ceec82e8d00efc8c7e6ceceb6183d05a5cd59c466086c
 SHA512:
-  metadata.gz: b1bcacca903ebeb350b7abbb8af580de31904bae313c08aac9ffd53351ea8d13897bda85d6ede9e12971dcf5fa3f5a68b2ebb1f71bcbfddd443c34e6ee6c65fc
-  data.tar.gz: 970874dccc0323c3b009ec22a083c5096172390fe7c34bb698958cd9e89deb958f5be69dc26145c945a1aac7d740875656ea8a9eb0372dfecbd7ca04745a0a2a
+  metadata.gz: f92dd70f82426b84d8a651a9963dffbf6b66017c484b25371b68c16495bf2cdb28faba9fdb31a0ab56ffbb5f848f1a877375379c4c94ca946bb16d9630d7d075
+  data.tar.gz: 69aa57c5583a6adba8320783171eeaef3814e9e758c81b3c81bbd455c3d238d72d145be44c5fa6732764d7561beac2c19181f8344462f209346572bb23f6bf3d

data/.github/workflows/build.yml

@@ -2,9 +2,9 @@ name: CI
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 jobs:
   build:

data/.github/workflows/cla.yml

@@ -0,0 +1,22 @@
+name: Contributor License Agreement (CLA)
+
+on:
+  pull_request_target:
+    types: [opened, synchronize]
+  issue_comment:
+    types: [created]
+
+jobs:
+  cla:
+    runs-on: ubuntu-latest
+    if: |
+      (github.event.issue.pull_request 
+        && !github.event.issue.pull_request.merged_at
+        && contains(github.event.comment.body, 'signed')
+      ) 
+      || (github.event.pull_request && !github.event.pull_request.merged)
+    steps:
+      - uses: Shopify/shopify-cla-action@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          cla-token: ${{ secrets.CLA_TOKEN }}

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smart_todo (1.3.0)
+    smart_todo (1.4.3)
       rexml
 
 GEM

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Shopify
+Copyright (c) 2019-present Shopify
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/dev.yml

@@ -4,8 +4,12 @@ type:
   - ruby
 
 up:
-  - ruby: 2.7.4
+  - ruby: 3.0.2
   - bundler
 
+console:
+  desc: 'start a console'
+  run: bin/console
+
 test:
   bundle exec rake test

data/lib/smart_todo/dispatchers/output.rb

@@ -8,7 +8,7 @@ module SmartTodo
 
       # @return void
       def dispatch
-        puts slack_message({})
+        puts slack_message({}, nil)
       end
     end
   end

data/lib/smart_todo/slack_client.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "cgi"
 require "net/http"
 require "json"
 
@@ -37,14 +38,14 @@ module SmartTodo
     # @param email [String]
     # @return [Hash]
     #
-    # @raise [Net::HTTPError] in case the reques to Slack failed
-    # @raise [SlackClient::Error] in case Slack returs a { ok: false } in the body
+    # @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)
       headers = { "Content-Type" => "application/x-www-form-urlencoded" }
 
-      request(:get, "/api/users.lookupByEmail?email=#{email}", nil, headers)
+      request(:get, "/api/users.lookupByEmail?email=#{CGI.escape(email)}", nil, headers)
     end
 
     # Send a message to a Slack channel or to a user
@@ -53,8 +54,8 @@ module SmartTodo
     # @param text [String] The message to send
     # @return [Hash]
     #
-    # @raise [Net::HTTPError] in case the reques to Slack failed
-    # @raise [SlackClient::Error] in case Slack returs a { ok: false } in the body
+    # @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/chat.postMessage
     def post_message(channel, text)
@@ -68,8 +69,8 @@ module SmartTodo
     # @param data [String] JSON encoded data when making a POST request
     # @param headers [Hash]
     #
-    # @raise [Net::HTTPError] in case the reques to Slack failed
-    # @raise [SlackClient::Error] in case Slack returs a { ok: false } in the body
+    # @raise [Net::HTTPError] in case the request to Slack failed
+    # @raise [SlackClient::Error] in case Slack returns a { ok: false } in the body
     def request(method, endpoint, data = nil, headers = {})
       response = case method
       when :post, :patch
@@ -87,8 +88,8 @@ module SmartTodo
     #   (Net::HTTPOK, Net::HTTPNotFound ...)
     # @return [Hash]
     #
-    # @raise [Net::HTTPError] in case the reques to Slack failed
-    # @raise [SlackClient::Error] in case Slack returs a { ok: false } in the body
+    # @raise [Net::HTTPError] in case the request to Slack failed
+    # @raise [SlackClient::Error] in case Slack returns a { ok: false } in the body
     def slack_response!(response)
       raise(Net::HTTPError.new("Request to slack failed", response)) unless response.code_type < Net::HTTPSuccess
       body = JSON.parse(response.body)

data/lib/smart_todo/version.rb

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

data/lib/smart_todo_cop.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "smart_todo/parser/metadata_parser"
+require "smart_todo"
 
 module RuboCop
   module Cop
@@ -10,29 +10,44 @@ module RuboCop
       #
       # @see https://rubocop.readthedocs.io/en/latest/extensions/#loading-extensions
       class SmartTodoCop < Cop
-        MSG = "Don't write regular TODO comments. Write SmartTodo compatible syntax comments." \
-          "For more info please look at https://github.com/shopify/smart_todo"
+        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)
           processed_source.comments.each do |comment|
             next unless /^#\sTODO/ =~ comment.text
-            next if smart_todo?(comment.text)
-
-            add_offense(comment)
+            metadata = metadata(comment.text)
+            if !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}")
+            end
           end
         end
 
+        private
+
         # @param comment [String]
-        # @return [true, false]
-        def smart_todo?(comment)
-          metadata = ::SmartTodo::Parser::MetadataParser.parse(comment.gsub(/^#/, ""))
+        # @return [SmartTodo::Parser::Visitor]
+        def metadata(comment)
+          ::SmartTodo::Parser::MetadataParser.parse(comment.gsub(/^#/, ""))
+        end
 
+        # @param metadata [SmartTodo::Parser::Visitor]
+        # @return [true, false]
+        def smart_todo?(metadata)
           metadata.events.any? &&
             metadata.events.all? { |event| event.is_a?(::SmartTodo::Parser::MethodNode) } &&
             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.respond_to?(method) }
+        end
       end
     end
   end

data/service.yml

@@ -1 +0,0 @@
-classification: library

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_todo
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.3
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-22 00:00:00.000000000 Z
+date: 2023-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rexml
@@ -92,6 +92,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/build.yml"
+- ".github/workflows/cla.yml"
 - ".github/workflows/rubocop.yml"
 - ".gitignore"
 - ".rubocop.yml"
@@ -148,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.20
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: Enhance todo's comments in your codebase.