smart_todo 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f43df881f5ab5894069683abbe3d09571232a896a429d0d2795d57e8102e42dc
-  data.tar.gz: 070dc363e6e1aa44e605e1fe53126bfc613af23985cfc7cdb48a145fe93362e0
+  metadata.gz: 8e7fe4f3876be333b1df4dcd44d965e57a0725e65900f96a518bd6a49d608165
+  data.tar.gz: 02b5370dfc45cc2337d973db79a3a6bddccb8ae295d2ec529eebbb166247873b
 SHA512:
-  metadata.gz: 69d9f4f170b854769a3141a41135c25463b2839274be7a6cea062b2d524fa5cee37e64c0a134f9de10944b9fce9e3580ed8f3b5ca4c8a8101528c3f9691a1c36
-  data.tar.gz: c5b66f439a2176728ca2f8ef4297fceeaa6d9f08c1ba190d4a255b8e3164264262536681d34a9cab4a9837c2455e75ecdf1dd9dc6b7b8b9877e37ef026719c01
+  metadata.gz: b1bcacca903ebeb350b7abbb8af580de31904bae313c08aac9ffd53351ea8d13897bda85d6ede9e12971dcf5fa3f5a68b2ebb1f71bcbfddd443c34e6ee6c65fc
+  data.tar.gz: 970874dccc0323c3b009ec22a083c5096172390fe7c34bb698958cd9e89deb958f5be69dc26145c945a1aac7d740875656ea8a9eb0372dfecbd7ca04745a0a2a

data/.github/workflows/build.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.version }}
+    strategy:
+      matrix:
+        version: [2.5, 2.6, 2.7, 3.0]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.version }}
+          bundler-cache: true
+      - name: Run Tests
+        run: |
+          bundle exec rake test
+

data/.github/workflows/rubocop.yml

@@ -0,0 +1,22 @@
+name: RuboCop
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 3.0
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0
+        bundler-cache: true
+    - name: Install gems
+      run: |
+        bundle config path vendor/bundle
+        bundle config set without 'default development test'
+        bundle install --jobs 4 --retry 3
+    - name: Run RuboCop
+      run: bundle exec rubocop --parallel

data/.rubocop.yml

@@ -1,7 +1,7 @@
-inherit_from:
-  - http://shopify.github.io/ruby-style-guide/rubocop.yml
+inherit_gem:
+  rubocop-shopify: rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 3.0
   Exclude:
     - vendor/**/*

data/Gemfile

@@ -6,6 +6,6 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gemspec
 
-group :development do
-  gem 'rubocop', '~> 0.71'
+group :rubocop do
+  gem "rubocop-shopify", require: false
 end

data/Gemfile.lock

@@ -1,36 +1,43 @@
 PATH
   remote: .
   specs:
-    smart_todo (1.2.0)
+    smart_todo (1.3.0)
+      rexml
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
-    ast (2.4.0)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    hashdiff (0.4.0)
-    jaro_winkler (1.5.3)
-    minitest (5.11.3)
-    parallel (1.17.0)
-    parser (2.6.3.0)
-      ast (~> 2.4.0)
-    public_suffix (3.1.1)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    crack (0.4.5)
+      rexml
+    hashdiff (1.0.1)
+    minitest (5.14.4)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
     rainbow (3.0.0)
-    rake (10.5.0)
-    rubocop (0.71.0)
-      jaro_winkler (~> 1.5.1)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.23.0)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.1)
-    safe_yaml (1.0.5)
-    unicode-display_width (1.6.0)
-    webmock (3.6.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.13.0)
+      parser (>= 3.0.1.1)
+    rubocop-shopify (2.3.0)
+      rubocop (~> 1.22)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+    webmock (3.11.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -39,12 +46,12 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler (>= 1.17)
   minitest (~> 5.0)
-  rake (~> 10.0)
-  rubocop (~> 0.71)
+  rake (>= 10.0)
+  rubocop-shopify
   smart_todo!
   webmock
 
 BUNDLED WITH
-   1.17.3
+   2.2.25

data/README.md

@@ -2,7 +2,7 @@
   <img src="https://user-images.githubusercontent.com/8122246/61341925-b936d180-a848-11e9-95c1-0d2f398c51b1.png?raw=true" width="200">
 </h3>
 
-[![Build Status](https://travis-ci.com/Shopify/smart_todo.svg?branch=master)](https://travis-ci.com/Shopify/smart_todo)
+[![Build Status](https://github.com/Shopify/smart_todo/workflows/CI/badge.svg)](https://github.com/Shopify/smart_todo/actions?query=workflow%3ACI)
 
 _SmartTodo_  is a library designed to assign users on TODO comments written in your codebase and help assignees be reminded when it's time to commit to their TODO.
 

data/dev.yml

@@ -4,7 +4,7 @@ type:
   - ruby
 
 up:
-  - ruby: 2.5.5
+  - ruby: 2.7.4
   - bundler
 
 test:

data/exe/smart_todo

@@ -3,10 +3,10 @@
 
 $LOAD_PATH.unshift("#{__dir__}/../lib")
 
-require 'smart_todo'
+require "smart_todo"
 
-if ENV['ENABLE_SMART_TODO'] && !ARGV.include?('--dispatcher')
-  ARGV << '--dispatcher' << 'slack'
+if ENV["ENABLE_SMART_TODO"] && !ARGV.include?("--dispatcher")
+  ARGV << "--dispatcher" << "slack"
 end
 
 SmartTodo::CLI.new.run

data/lib/smart_todo/cli.rb

@@ -15,13 +15,13 @@ module SmartTodo
     def run(args = ARGV)
       paths = define_options.parse!(args)
       validate_options!
-      paths << '.' if paths.empty?
+      paths << "." if paths.empty?
 
       paths.each do |path|
         normalize_path(path).each do |file|
           parse_file(file)
 
-          STDOUT.print('.')
+          STDOUT.print(".")
           STDOUT.flush
         end
       end
@@ -38,13 +38,13 @@ module SmartTodo
     def define_options
       OptionParser.new do |opts|
         opts.banner = "Usage: smart_todo [options] file_or_path1 file_or_path2 ..."
-        opts.on('--slack_token TOKEN') do |token|
+        opts.on("--slack_token TOKEN") do |token|
           @options[:slack_token] = token
         end
-        opts.on('--fallback_channel CHANNEL') do |channel|
+        opts.on("--fallback_channel CHANNEL") do |channel|
           @options[:fallback_channel] = channel
         end
-        opts.on('--dispatcher DISPATCHER') do |dispatcher|
+        opts.on("--dispatcher DISPATCHER") do |dispatcher|
           @options[:dispatcher] = dispatcher
         end
       end
@@ -67,7 +67,7 @@ module SmartTodo
 
     # @param file [String] a path to a file
     def parse_file(file)
-      Parser::CommentParser.new(File.read(file, encoding: 'UTF-8')).parse.each do |todo_node|
+      Parser::CommentParser.new(File.read(file, encoding: "UTF-8")).parse.each do |todo_node|
         event_message = nil
         event_met = todo_node.metadata.events.find do |event|
           event_message = Events.public_send(event.method_name, *event.arguments)

data/lib/smart_todo/dispatchers/base.rb

@@ -12,7 +12,7 @@ module SmartTodo
         case dispatcher
         when "slack"
           Slack
-        when nil, 'output'
+        when nil, "output"
           Output
         end
       end
@@ -25,7 +25,7 @@ module SmartTodo
       #
       # @return void
       def self.validate_options!(_options)
-        raise(NotImplemetedError, 'subclass responsability')
+        raise(NotImplemetedError, "subclass responsability")
       end
 
       # @param event_message [String] the success message associated
@@ -38,7 +38,7 @@ module SmartTodo
         @todo_node = todo_node
         @options = options
         @file = file
-        @assignee = @todo_node.metadata.assignee
+        @assignees = @todo_node.metadata.assignees
       end
 
       # This method gets called when a TODO reminder is expired and needs to be delivered.
@@ -46,7 +46,7 @@ module SmartTodo
       #
       # @return void
       def dispatch
-        raise(NotImplemetedError, 'subclass responsability')
+        raise(NotImplemetedError, "subclass responsability")
       end
 
       private
@@ -54,10 +54,11 @@ module SmartTodo
       # Prepare the content of the message to send to the TODO assignee
       #
       # @param user [Hash] contain information about a user
+      # @param assignee [String] original string handle the slack message should be sent
       # @return [String]
-      def slack_message(user)
-        header = if user.key?('fallback')
-          unexisting_user
+      def slack_message(user, assignee)
+        header = if user.key?("fallback")
+          unexisting_user(assignee)
         else
           existing_user
         end
@@ -78,12 +79,13 @@ module SmartTodo
 
       # Message in case a TODO's assignee doesn't exist in the Slack organization
       #
+      # @param user [Hash]
       # @return [String]
-      def unexisting_user
-        "Hello :wave:,\n\n`#{@assignee}` had an assigned TODO but this user or channel doesn't exist on Slack anymore."
+      def unexisting_user(assignee)
+        "Hello :wave:,\n\n`#{assignee}` had an assigned TODO but this user or channel doesn't exist on Slack anymore."
       end
 
-      # @param user [Hash]
+      # Hello message for user actually existing in the organization
       def existing_user
         "Hello :wave:,"
       end

data/lib/smart_todo/dispatchers/slack.rb

@@ -6,9 +6,21 @@ module SmartTodo
     # (using the associated slack email address) or a channel.
     class Slack < Base
       def self.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") }
 
-        options.fetch(:fallback_channel) { raise(ArgumentError, 'Missing :fallback_channel') }
+        options.fetch(:fallback_channel) { raise(ArgumentError, "Missing :fallback_channel") }
+      end
+
+      # Make a Slack API call to dispatch the message to each assignee
+      #
+      # @raise [SlackClient::Error] in case the Slack API returns an error
+      #   other than `users_not_found`
+      #
+      # @return [Array] Slack response for each assignee a message was sent to
+      def dispatch
+        @assignees.each do |assignee|
+          dispatch_one(assignee)
+        end
       end
 
       # Make a Slack API call to dispatch the message to the user or channel
@@ -16,19 +28,20 @@ module SmartTodo
       # @raise [SlackClient::Error] in case the Slack API returns an error
       #   other than `users_not_found`
       #
+      # @param [String] the assignee handle string
       # @return [Hash] the Slack response
-      def dispatch
-        user = slack_user_or_channel
+      def dispatch_one(assignee)
+        user = slack_user_or_channel(assignee)
 
-        client.post_message(user.dig('user', 'id'), slack_message(user))
+        client.post_message(user.dig("user", "id"), slack_message(user, assignee))
       rescue SlackClient::Error => error
-        if %w(users_not_found channel_not_found).include?(error.error_code)
-          user = { 'user' => { 'id' => @options[:fallback_channel] }, 'fallback' => true }
+        if ["users_not_found", "channel_not_found"].include?(error.error_code)
+          user = { "user" => { "id" => @options[:fallback_channel] }, "fallback" => true }
         else
           raise(error)
         end
 
-        client.post_message(user.dig('user', 'id'), slack_message(user))
+        client.post_message(user.dig("user", "id"), slack_message(user, assignee))
       end
 
       private
@@ -37,11 +50,11 @@ module SmartTodo
       # the channel the message should be sent to.
       #
       # @return [Hash] a suited hash containing the user ID for a given individual or a slack channel
-      def slack_user_or_channel
-        if email?
-          client.lookup_user_by_email(@assignee)
+      def slack_user_or_channel(assignee)
+        if assignee.include?("@")
+          client.lookup_user_by_email(assignee)
         else
-          { 'user' => { 'id' => @assignee } }
+          { "user" => { "id" => assignee } }
         end
       end
 
@@ -49,13 +62,6 @@ module SmartTodo
       def client
         @client ||= SlackClient.new(@options[:slack_token])
       end
-
-      # Check if the TODO's assignee is a specific user or a channel
-      #
-      # @return [true, false]
-      def email?
-        @assignee.include?("@")
-      end
     end
   end
 end

data/lib/smart_todo/events/date.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'time'
+require "time"
 
 module SmartTodo
   module Events

data/lib/smart_todo/events/gem_bump.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-gem('bundler')
-require 'bundler'
+gem("bundler")
+require "bundler"
 
 module SmartTodo
   module Events

data/lib/smart_todo/events/gem_release.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'net/http'
-require 'json'
+require "net/http"
+require "json"
 
 module SmartTodo
   module Events
@@ -30,7 +30,7 @@ module SmartTodo
         if response.code_type < Net::HTTPClientError
           error_message
         elsif (gem = version_released?(response.body))
-          message(gem['number'])
+          message(gem["number"])
         else
           false
         end
@@ -54,13 +54,13 @@ module SmartTodo
       # @return [true, false]
       def version_released?(gem_versions)
         JSON.parse(gem_versions).find do |gem|
-          @requirements.satisfied_by?(Gem::Version.new(gem['number']))
+          @requirements.satisfied_by?(Gem::Version.new(gem["number"]))
         end
       end
 
       # @return [Net::HTTP] an instance of Net::HTTP
       def client
-        @client ||= Net::HTTP.new('rubygems.org', Net::HTTP.https_default_port).tap do |client|
+        @client ||= Net::HTTP.new("rubygems.org", Net::HTTP.https_default_port).tap do |client|
           client.use_ssl = true
         end
       end

data/lib/smart_todo/events/issue_close.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'net/http'
-require 'json'
+require "net/http"
+require "json"
 
 module SmartTodo
   module Events
@@ -12,7 +12,7 @@ module SmartTodo
     # with the `repos` scope in the +SMART_TODO_GITHUB_TOKEN+ environment variable
     # is required.
     class IssueClose
-      TOKEN_ENV = 'SMART_TODO_GITHUB_TOKEN'
+      TOKEN_ENV = "SMART_TODO_GITHUB_TOKEN"
 
       # @param organization [String]
       # @param repo [String]
@@ -62,7 +62,7 @@ module SmartTodo
 
       # @return [Net::HTTP] an instance of Net::HTTP
       def client
-        @client ||= Net::HTTP.new('api.github.com', Net::HTTP.https_default_port).tap do |client|
+        @client ||= Net::HTTP.new("api.github.com", Net::HTTP.https_default_port).tap do |client|
           client.use_ssl = true
         end
       end
@@ -72,13 +72,13 @@ module SmartTodo
       #
       # @return [true, false]
       def pull_request_closed?(pull_request)
-        JSON.parse(pull_request)['state'] == 'closed'
+        JSON.parse(pull_request)["state"] == "closed"
       end
 
       # @return [Hash]
       def default_headers
-        { 'Accept' => 'application/vnd.github.v3+json' }.tap do |headers|
-          headers['Authorization'] = "token #{ENV[TOKEN_ENV]}" if ENV[TOKEN_ENV]
+        { "Accept" => "application/vnd.github.v3+json" }.tap do |headers|
+          headers["Authorization"] = "token #{ENV[TOKEN_ENV]}" if ENV[TOKEN_ENV]
         end
       end
     end

data/lib/smart_todo/events.rb

@@ -54,7 +54,7 @@ module SmartTodo
     # @param issue_number [String, Integer]
     # @return [false, String]
     def issue_close(organization, repo, issue_number)
-      IssueClose.new(organization, repo, issue_number, type: 'issues').met?
+      IssueClose.new(organization, repo, issue_number, type: "issues").met?
     end
 
     # Check if the pull request +pr_number+ is closed
@@ -64,7 +64,7 @@ module SmartTodo
     # @param pr_number [String, Integer]
     # @return [false, String]
     def pull_request_close(organization, repo, pr_number)
-      IssueClose.new(organization, repo, pr_number, type: 'pulls').met?
+      IssueClose.new(organization, repo, pr_number, type: "pulls").met?
     end
   end
 end

data/lib/smart_todo/parser/comment_parser.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'ripper'
+require "ripper"
 
 module SmartTodo
   module Parser

data/lib/smart_todo/parser/metadata_parser.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'ripper'
+require "ripper"
 
 module SmartTodo
   module Parser
@@ -35,7 +35,7 @@ module SmartTodo
       # @param args [Array]
       # @return [Array, MethodNode]
       def on_method_add_arg(method, args)
-        if method == 'TODO'
+        if method == "TODO"
           args
         else
           MethodNode.new(method, args)
@@ -58,12 +58,12 @@ module SmartTodo
       # @param key [String]
       # @param value [String, Integer, MethodNode]
       def on_assoc_new(key, value)
-        key.tr!(':', '')
+        key.tr!(":", "")
 
         case key
-        when 'on'
+        when "on"
           [:on_todo_event, value]
-        when 'to'
+        when "to"
           [:on_todo_assignee, value]
         else
           [:unknown, value]
@@ -78,10 +78,11 @@ module SmartTodo
     end
 
     class Visitor
-      attr_reader :events, :assignee
+      attr_reader :events, :assignees
 
       def initialize
         @events = []
+        @assignees = []
       end
 
       # Iterate over each tokens returned from the parser and call
@@ -111,7 +112,7 @@ module SmartTodo
       # @param assignee [String]
       # @return [void]
       def on_todo_assignee(assignee)
-        @assignee = assignee
+        @assignees << assignee
       end
     end
   end

data/lib/smart_todo/parser/todo_node.rb

@@ -11,7 +11,7 @@ module SmartTodo
 
       # @param todo [String] the actual Ruby comment
       def initialize(todo)
-        @metadata = MetadataParser.parse(todo.gsub(/^#/, ''))
+        @metadata = MetadataParser.parse(todo.gsub(/^#/, ""))
         @comments = []
         @start = todo.match(/^#(\s+)/)[1].size
       end
@@ -26,7 +26,7 @@ module SmartTodo
       # @param comment [String]
       # @return [void]
       def <<(comment)
-        @comments << comment.gsub(/^#(\s+)/, '')
+        @comments << comment.gsub(/^#(\s+)/, "")
       end
 
       # Check if the +comment+ is indented two spaces below the
@@ -36,7 +36,7 @@ module SmartTodo
       # @param comment [String]
       # @return [true, false]
       def indented_comment?(comment)
-        comment.match(/^#(\s+)/)[1].size - @start == DEFAULT_RUBY_INDENTATION
+        comment.match(/^#(\s*)/)[1].size - @start == DEFAULT_RUBY_INDENTATION
       end
     end
   end