smart_todo 1.0.0

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_from:
+  - http://shopify.github.io/ruby-style-guide/rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.5

data/.shopify-build/VERSION

@@ -0,0 +1 @@
+v1

data/.shopify-build/smart-todo.yml

@@ -0,0 +1,37 @@
+containers:
+  ruby-2.3:
+    docker: circleci/ruby:2.3
+  ruby-2.4:
+    docker: circleci/ruby:2.4
+  ruby-2.5:
+    docker: circleci/ruby:2.5
+  ruby-2.6:
+    docker: circleci/ruby:2.6
+
+shared:
+  defaults: &defaults
+    timeout: 5m
+    dependencies:
+    - bundler
+    run:
+      - bundle exec rake test
+
+steps:
+- label: ":cop: Ruby style check"
+  timeout: 5m
+  container: ruby-2.5
+  dependencies:
+  - bundler
+  run: bin/rubocop
+- label: ":ruby: Ruby 2.3"
+  container: ruby-2.3
+  <<: *defaults
+- label: ":ruby: Ruby 2.4"
+  container: ruby-2.4
+  <<: *defaults
+- label: ":ruby: Ruby 2.5"
+  container: ruby-2.5
+  <<: *defaults
+- label: ":ruby: Ruby 2.6"
+  container: ruby-2.6
+  <<: *defaults

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at edouard.chin@shopify.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec
+
+group :development do
+  gem 'rubocop', '~> 0.71'
+end

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    smart_todo (1.0.0)
+
+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)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rubocop (0.71.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.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)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  rubocop (~> 0.71)
+  smart_todo!
+  webmock
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+<h3 align="center">
+  <img src="https://user-images.githubusercontent.com/8122246/61341925-b936d180-a848-11e9-95c1-0d2f398c51b1.png?raw=true" width="200">
+</h3>
+
+[![Build status](https://badge.buildkite.com/dc3ed74a08ef4a3f6f13bc37bf6ac19a80c0deb3157dfa7937.svg)](https://buildkite.com/shopify/smart-todo?branch=master)
+
+_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.
+
+Installation
+-----------
+1) Add the gem in your Gemfile.
+```ruby
+group :development do
+  gem 'smart_todo', require: false # No need to require it
+end
+```
+2) Run `bundle install`
+
+
+Summary
+---------
+SmartTodo allows to write TODO comments alongside your code and assign a user to it.
+When the TODO's event is met (i.e. a certain date is reached), the TODO's assignee will get pinged on Slack.
+
+**Without SmartTodo**
+```ruby
+  # TODO: Warning! We need to change the API endpoint on July 1st because the provider
+  # is modifying its API.
+  def api_call
+  end
+```
+
+-------------------
+
+**With SmartTodo**
+```ruby
+  # TODO(on: date('2019-07-01'), to: 'john@example.com')
+  #   The API provider is modifying its endpoint, we need to modify our code.
+  def api_call
+  end
+```
+
+Documentation
+----------------
+Please check out the GitHub [wiki](https://github.com/Shopify/smart_todo/wiki) for documentation and example on how to setup SmartTodo in your project.
+
+License
+--------
+This project is licensed under the terms of the MIT license. See the [LICENSE](LICENSE.txt) file.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task(default: :test)

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "smart_todo"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load(Gem.bin_path("rubocop", "rubocop"))

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dev.yml

@@ -0,0 +1,11 @@
+name: smart-todo
+
+type:
+  - ruby
+
+up:
+  - ruby: 2.5.5
+  - bundler
+
+test:
+  bundle exec rake test

data/exe/smart_todo

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$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)
+end
+
+SmartTodo::CLI.new.run

data/lib/smart_todo/cli.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "optionparser"
+
+module SmartTodo
+  # This class is the entrypoint of the SmartTodo library and is responsible
+  # to retrieve the command line options as well as iterating over each files/directories
+  # to run the +CommentParser+ on.
+  class CLI
+    def initialize
+      @options = {}
+    end
+
+    # @param args [Array<String>]
+    def run(args = ARGV)
+      paths = define_options.parse!(args)
+      validate_options!
+      paths << '.' if paths.empty?
+
+      paths.each do |path|
+        normalize_path(path).each do |file|
+          parse_file(file)
+
+          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
+    # @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') }
+    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|
+          @options[:slack_token] = token
+        end
+        opts.on('--fallback_channel CHANNEL') do |channel|
+          @options[:fallback_channel] = channel
+        end
+      end
+    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)
+      if File.file?(path)
+        [path]
+      else
+        Dir["#{path}/**/*.rb"]
+      end
+    end
+
+    # @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|
+        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
+      end
+    end
+  end
+end

data/lib/smart_todo/dispatcher.rb

@@ -0,0 +1,99 @@
+# 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