smart_todo 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4a658f8acb049243c04ca03be1c3cf4eacd84a648955c6bc0625f9c497ffbe5
-  data.tar.gz: 49258142b68fc748a054bb36a3c207b16bb010709a21e935a28fe4bdb379cf02
+  metadata.gz: a61dfef2e6101321b34f154e8143441b3f28502709b26cb2db504fe83251ba1a
+  data.tar.gz: 3f12eef19063ed2f8585b56be3b483f1312dc44a7c96cc93931c8ae89a4ac7c5
 SHA512:
-  metadata.gz: da4d883a649e9c090eabd1415a778503d272ad36baf505688a126bc37e6b010f78a72e3da27ad0b28706ae015f48c41115e3644b68b3c590f1e69918d1b32b39
-  data.tar.gz: 7ff862bbc35a507e220dd40aca07b1b7719e5e47270456652c4c4bf39a7cf9634ef0132379bb2f5e52038b9eafa6e5fab22f2f26948f172907577dde573f271a
+  metadata.gz: 25d629887ac69968359d5bd26a15736adebad37c881eeec2c5b05432be1a05fca0d69cf9c978c638b7033e9deffcc2f24111fee307359325f70c07d6905d6b04
+  data.tar.gz: 7a5472d3ad8d69187ccc5d46975b1f3ac0368886259c1f42d2303c4a0e8cb6f4de34a33f08b12d205ddde13f8ba5184a423eba95dece54335f0e7ed405861a15

data/CHANGELOG.md

@@ -6,6 +6,33 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.1.0] - 2019-09-06
+### Fixed
+- Fixed the SmartTodo cop to add an offense in case a SmartTodo has a wrong event.
+  ```ruby
+  # Bad
+  #
+  # TODO(on '2019-08-08')
+  ```
+
+### Added
+- SmartTodo will now use the fallback channel in case a todo has a channel
+  assignee that doesn't exist.
+- Added a new `Output` dispatcher which will just output the expired event.
+  By default SmartTodo will now output expired todo in the terminal instead
+  of not running at all.
+
+  Users should now pass a `--dispatcher` to the CLI to let SmartTodo through
+  which dispatcher the message should be send.
+
+  ```sh
+    bin/smart_todo --dispatcher 'slack'
+  ```
+
+  For backward compatibility reasons, the dispacher used will be Slack, in
+  case you have the `ENABLE_SMART_TODO` environment set. This will be removed
+  in the next major version.
+
 ## [1.0.2] - 2019-08-09
 ### Fixed
 - Fixed the SmartTodo cop to add an offense in case a SmartTodo has no assignee.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smart_todo (1.0.2)
+    smart_todo (1.1.0)
 
 GEM
   remote: https://rubygems.org/

data/exe/smart_todo

@@ -5,10 +5,8 @@ $LOAD_PATH.unshift("#{__dir__}/../lib")
 
 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

@@ -27,13 +27,11 @@ module SmartTodo
       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
@@ -46,9 +44,17 @@ module SmartTodo
         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)
@@ -67,7 +73,7 @@ module SmartTodo
           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,92 @@
+# 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
+        @assignee = @todo_node.metadata.assignee
+      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
+      # @return [String]
+      def slack_message(user)
+        header = if user.key?('fallback')
+          unexisting_user
+        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
+      #
+      # @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."
+      end
+
+      # @param user [Hash]
+      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({})
+      end
+    end
+  end
+end

data/lib/smart_todo/dispatchers/slack.rb

@@ -0,0 +1,61 @@
+# 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 the user or channel
+      #
+      # @raise [SlackClient::Error] in case the Slack API returns an error
+      #   other than `users_not_found`
+      #
+      # @return [Hash] the Slack response
+      def dispatch
+        user = slack_user_or_channel
+
+        client.post_message(user.dig('user', 'id'), slack_message(user))
+      rescue SlackClient::Error => error
+        if %w(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))
+      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
+        if email?
+          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
+
+      # 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/version.rb

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

data/lib/smart_todo.rb

@@ -6,7 +6,6 @@ require "smart_todo/events"
 module SmartTodo
   autoload :SlackClient,              'smart_todo/slack_client'
   autoload :CLI,                      'smart_todo/cli'
-  autoload :Dispatcher,               'smart_todo/dispatcher'
 
   module Parser
     autoload :CommentParser,          'smart_todo/parser/comment_parser'
@@ -19,4 +18,10 @@ module SmartTodo
     autoload :GemRelease,             'smart_todo/events/gem_release'
     autoload :IssueClose,             'smart_todo/events/issue_close'
   end
+
+  module Dispatchers
+    autoload :Base,                   'smart_todo/dispatchers/base'
+    autoload :Slack,                  'smart_todo/dispatchers/slack'
+    autoload :Output,                 'smart_todo/dispatchers/output'
+  end
 end

data/lib/smart_todo_cop.rb

@@ -29,7 +29,9 @@ module RuboCop
         def smart_todo?(comment)
           metadata = ::SmartTodo::Parser::MetadataParser.parse(comment.gsub(/^#/, ''))
 
-          metadata.events.any? && metadata.assignee
+          metadata.events.any? &&
+            metadata.events.all? { |event| event.is_a?(::SmartTodo::Parser::MethodNode) } &&
+            metadata.assignee
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_todo
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-09 00:00:00.000000000 Z
+date: 2019-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -109,7 +109,9 @@ files:
 - exe/smart_todo
 - lib/smart_todo.rb
 - lib/smart_todo/cli.rb
-- lib/smart_todo/dispatcher.rb
+- lib/smart_todo/dispatchers/base.rb
+- lib/smart_todo/dispatchers/output.rb
+- lib/smart_todo/dispatchers/slack.rb
 - lib/smart_todo/events.rb
 - lib/smart_todo/events/date.rb
 - lib/smart_todo/events/gem_release.rb

data/lib/smart_todo/dispatcher.rb

@@ -1,99 +0,0 @@
-# frozen_string_literal: true
-
-module SmartTodo
-  # The Dispatcher handles the logic to send the Slack message
-  # to the assignee once its TODO came to expiration.
-  class Dispatcher
-    # @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
-      @assignee = @todo_node.metadata.assignee
-    end
-
-    # Make a Slack API call to dispatch the message to the user or channel
-    #
-    # @return [Hash] the Slack response
-    def dispatch
-      user = if email?
-        retrieve_slack_user
-      else
-        { 'user' => { 'id' => @assignee, 'profile' => { 'first_name' => 'Team' } } }
-      end
-
-      client.post_message(user.dig('user', 'id'), slack_message(user))
-    end
-
-    private
-
-    # Retrieve the unique identifier of a Slack user with his email address
-    #
-    # @return [Hash] the Slack response containing the user ID
-    # @raise [SlackClient::Error] in case the Slack API returns an error
-    #   other than `users_not_found`
-    def retrieve_slack_user
-      client.lookup_user_by_email(@assignee)
-    rescue SlackClient::Error => error
-      if error.error_code == 'users_not_found'
-        { 'user' => { 'id' => @options[:fallback_channel] }, 'fallback' => true }
-      else
-        raise(error)
-      end
-    end
-
-    # Prepare the content of the message to send to the TODO assignee
-    #
-    # @param user [Hash] contain information about a user
-    # @return [String]
-    def slack_message(user)
-      header = if user.key?('fallback')
-        unexisting_user
-      else
-        existing_user(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
-    #
-    # @return [String]
-    def unexisting_user
-      "Hello :wave:,\n\n`#{@assignee}` had an assigned TODO but this user doesn't exist on Slack anymore."
-    end
-
-    # @param user [Hash]
-    def existing_user(user)
-      "Hello #{user.dig('user', 'profile', 'first_name')} :wave:,"
-    end
-
-    # @return [SlackClient] an instance of SlackClient
-    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