smart_todo 1.0.2 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4a658f8acb049243c04ca03be1c3cf4eacd84a648955c6bc0625f9c497ffbe5
-  data.tar.gz: 49258142b68fc748a054bb36a3c207b16bb010709a21e935a28fe4bdb379cf02
+  metadata.gz: dc3a4665a0110180692321fbdd788be8df4155de16bf75b2967f4c330a759e72
+  data.tar.gz: 414a198aa06035126890b002f6552779c73d9f6f84eeeaa904ba2132daa7d4d9
 SHA512:
-  metadata.gz: da4d883a649e9c090eabd1415a778503d272ad36baf505688a126bc37e6b010f78a72e3da27ad0b28706ae015f48c41115e3644b68b3c590f1e69918d1b32b39
-  data.tar.gz: 7ff862bbc35a507e220dd40aca07b1b7719e5e47270456652c4c4bf39a7cf9634ef0132379bb2f5e52038b9eafa6e5fab22f2f26948f172907577dde573f271a
+  metadata.gz: 8e0c57b0849a90cd1be9699d264167e7286d622eb42e02cc7dd13231ab41d76d815a455a65571f3890dda7c79dc0228692b0c72c37c50337826df137d0c0f0df
+  data.tar.gz: a62b94332abe655cb418d0238eaa24e86db0e48b109877b8192265a244795624a2188cffeb0be429f0204683394b992ce73a0932efc322b4c3ba589cadcd0af4

data/.github/workflows/build.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+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.0.2)
+    smart_todo (1.3.1)
+      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,8 +4,12 @@ type:
   - ruby
 
 up:
-  - ruby: 2.5.5
+  - ruby: 3.0.2
   - bundler
 
+console:
+  desc: 'start a console'
+  run: bin/console
+
 test:
   bundle exec rake test

data/exe/smart_todo

@@ -3,12 +3,10 @@
 
 $LOAD_PATH.unshift("#{__dir__}/../lib")
 
-require 'smart_todo'
+require "smart_todo"
 
-unless ENV['ENABLE_SMART_TODO']
-  puts 'Not running SmartTodo since the ENABLE_SMART_TODO ENV is not set'
-
-  exit(0)
+if ENV["ENABLE_SMART_TODO"] && !ARGV.include?("--dispatcher")
+  ARGV << "--dispatcher" << "slack"
 end
 
 SmartTodo::CLI.new.run

data/lib/smart_todo/cli.rb

@@ -15,40 +15,46 @@ 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
     end
 
-    # @raise [ArgumentError] if the +slack_token+ or the +fallback_channel+
-    #   options are not passed to the command line
+    # @raise [ArgumentError] In case an option needed by a dispatcher wasn't provided.
+    #
     # @return [void]
     def validate_options!
-      @options[:slack_token] ||= ENV.fetch('SMART_TODO_SLACK_TOKEN') { raise(ArgumentError, 'Missing :slack_token') }
-
-      @options.fetch(:fallback_channel) { raise(ArgumentError, 'Missing :fallback_channel') }
+      dispatcher.validate_options!(@options)
     end
 
     # @return [OptionParser] an instance of OptionParser
     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|
+          @options[:dispatcher] = dispatcher
+        end
       end
     end
 
+    # @return [Class] a Dispatchers::Base subclass
+    def dispatcher
+      @dispatcher ||= Dispatchers::Base.class_for(@options[:dispatcher])
+    end
+
     # @param path [String] a path to a file or directory
     # @return [Array<String>] all the directories the parser should run on
     def normalize_path(path)
@@ -61,13 +67,13 @@ 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)
         end
 
-        Dispatcher.new(event_message, todo_node, file, @options).dispatch if event_met
+        dispatcher.new(event_message, todo_node, file, @options).dispatch if event_met
       end
     end
   end

data/lib/smart_todo/dispatchers/base.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module SmartTodo
+  module Dispatchers
+    class Base
+      # Factory pattern to retrive the right dispatcher class.
+      #
+      # @param dispatcher [String]
+      #
+      # @return [Class]
+      def self.class_for(dispatcher)
+        case dispatcher
+        when "slack"
+          Slack
+        when nil, "output"
+          Output
+        end
+      end
+
+      # Subclasses should define what options from the CLI they need in order
+      # to properly deliver the message. For instance the Slack dispatcher
+      # requires an API key.
+      #
+      # @param _options [Hash]
+      #
+      # @return void
+      def self.validate_options!(_options)
+        raise(NotImplemetedError, "subclass responsability")
+      end
+
+      # @param event_message [String] the success message associated
+      #   a specific event
+      # @param todo_node [SmartTodo::Parser::TodoNode]
+      # @param file [String] the file containing the TODO
+      # @param options [Hash]
+      def initialize(event_message, todo_node, file, options)
+        @event_message = event_message
+        @todo_node = todo_node
+        @options = options
+        @file = file
+        @assignees = @todo_node.metadata.assignees
+      end
+
+      # This method gets called when a TODO reminder is expired and needs to be delivered.
+      # Dispatchers should implement this method to deliver the message where they need.
+      #
+      # @return void
+      def dispatch
+        raise(NotImplemetedError, "subclass responsability")
+      end
+
+      private
+
+      # 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, assignee)
+        header = if user.key?("fallback")
+          unexisting_user(assignee)
+        else
+          existing_user
+        end
+
+        <<~EOM
+          #{header}
+
+          You have an assigned TODO in the `#{@file}` file.
+          #{@event_message}
+
+          Here is the associated comment on your TODO:
+
+          ```
+          #{@todo_node.comment.strip}
+          ```
+        EOM
+      end
+
+      # Message in case a TODO's assignee doesn't exist in the Slack organization
+      #
+      # @param user [Hash]
+      # @return [String]
+      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
+
+      # Hello message for user actually existing in the organization
+      def existing_user
+        "Hello :wave:,"
+      end
+    end
+  end
+end

data/lib/smart_todo/dispatchers/output.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SmartTodo
+  module Dispatchers
+    # A simple dispatcher that will output the reminder.
+    class Output < Base
+      def self.validate_options!(_); end
+
+      # @return void
+      def dispatch
+        puts slack_message({}, nil)
+      end
+    end
+  end
+end

data/lib/smart_todo/dispatchers/slack.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module SmartTodo
+  module Dispatchers
+    # Dispatcher that sends TODO reminders on Slack. Assignees can be either individual
+    # (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.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
+      #
+      # @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_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"].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, assignee))
+      end
+
+      private
+
+      # Returns a formatted hash containing either the user id of a slack user or
+      # 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(assignee)
+        if assignee.include?("@")
+          client.lookup_user_by_email(assignee)
+        else
+          { "user" => { "id" => assignee } }
+        end
+      end
+
+      # @return [SlackClient] an instance of SlackClient
+      def client
+        @client ||= SlackClient.new(@options[:slack_token])
+      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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+gem("bundler")
+require "bundler"
+
+module SmartTodo
+  module Events
+    # An event that compare the version of a gem specified in your Gemfile.lock
+    # with the expected version specifiers.
+    class GemBump
+      # @param gem_name [String]
+      # @param requirements [Array] a list of version specifiers.
+      #   The specifiers are the same as the one used in Gemfiles or Gemspecs
+      #
+      # @example Expecting a specific version
+      #   GemBump.new('rails', ['6.0'])
+      #
+      # @example Expecting a version in the 5.x.x series
+      #   GemBump.new('rails', ['> 5.2', '< 6'])
+      def initialize(gem_name, requirements)
+        @gem_name = gem_name
+        @requirements = Gem::Requirement.new(requirements)
+      end
+
+      # @return [String, false]
+      def met?
+        return error_message if spec_set[@gem_name].empty?
+
+        installed_version = spec_set[@gem_name].first.version
+        if @requirements.satisfied_by?(installed_version)
+          message(installed_version)
+        else
+          false
+        end
+      end
+
+      # Error message send to Slack in case a gem couldn't be found
+      #
+      # @return [String]
+      def error_message
+        "The gem *#{@gem_name}* is not in your dependencies, I can't determine if your TODO is ready to be addressed."
+      end
+
+      # @return [String]
+      def message(version_number)
+        "The gem *#{@gem_name}* was updated to version *#{version_number}* and your TODO is now ready to be addressed."
+      end
+
+      private
+
+      # @return [Bundler::SpecSet] an instance of Bundler::SpecSet
+      def spec_set
+        @spec_set ||= Bundler.load.specs
+      end
+    end
+  end
+end

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

@@ -38,6 +38,15 @@ module SmartTodo
       GemRelease.new(gem_name, requirements).met?
     end
 
+    # Check if +gem_name+ was bumped to the +requirements+ expected
+    #
+    # @param gem_name [String]
+    # @param requirements [Array<String>] a list of version specifiers
+    # @return [false, String]
+    def gem_bump(gem_name, *requirements)
+      GemBump.new(gem_name, requirements).met?
+    end
+
     # Check if the issue +issue_number+ is closed
     #
     # @param organization [String] the GitHub organization name
@@ -45,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
@@ -55,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