smart_todo 1.6.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c17d1471d893e5a764dda2fa9adcfc73049b5c5a45d6678feca40104879065fc
-  data.tar.gz: 85411f13bc189f060372e90a72fc1a545cd0030b6f67cf0fd75f1ff97dbeb755
+  metadata.gz: a7cac40289c5fb2fdf4bb143ee7cca9b1c74ce41c7e1fa426f7efc17364a2683
+  data.tar.gz: c93946f4131f64068e9c249c760829a33f3e88ae669f322bb00ea0647f68eb20
 SHA512:
-  metadata.gz: bfe190ce26c9b3e65aea86f3d23e40a400c14edcac8c465b361341ac00a7ab7d59498c9c3edda92d7e180659cad96240148bce26dc3a1db77a92ee2e03575204
-  data.tar.gz: f1c0386fbb5346a74c3f9c0c3b6228a9af29a810241793a5f44db5cbe7d7873c24e9dda987b65aff0d4984193be3652bec472431a48407badb2eb7610da506d6
+  metadata.gz: a6a84fd8bd731f7b31fe0033be57a50ba018af724ae29cfa16a4c9a0a96766e6335ee1c1145976002519aff1f69d6a28a3bf220963e42f55c28b051f02c85d80
+  data.tar.gz: 562151dd8c4fc2b8d55d72c004a701ef2c10f01d3e84f632b1a945ee969469e7dffd5473c7f109548ca105175b1a893f1e039a9ee091b3cb8034af7e47116082

data/.github/workflows/build.yml

@@ -12,7 +12,7 @@ jobs:
     name: Ruby ${{ matrix.version }}
     strategy:
       matrix:
-        version: [3.0, 3.1, 3.2]
+        version: [3.0, 3.1, 3.2, 3.3]
 
     steps:
       - uses: actions/checkout@v2

data/.github/workflows/rubocop.yml

@@ -8,10 +8,9 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Ruby 3.0
+    - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.0
         bundler-cache: true
     - name: Install gems
       run: |

data/.rubocop.yml

@@ -2,7 +2,6 @@ inherit_gem:
   rubocop-shopify: rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 3.0
   NewCops: disable
   SuggestExtensions: false
   Exclude:

data/.ruby-version

@@ -0,0 +1 @@
+3.3.0

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    smart_todo (1.6.0)
-      rexml
+    smart_todo (1.8.0)
+      prism (~> 0.15)
 
 GEM
   remote: https://rubygems.org/
@@ -13,34 +13,37 @@ GEM
     crack (0.4.5)
       rexml
     hashdiff (1.0.1)
-    json (2.6.3)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
     minitest (5.14.4)
-    parallel (1.23.0)
-    parser (3.2.2.3)
+    parallel (1.24.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
+    prism (0.17.0)
     public_suffix (4.0.6)
-    racc (1.7.0)
+    racc (1.7.3)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.8.1)
-    rexml (3.2.5)
-    rubocop (1.52.1)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rubocop (1.62.1)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.3)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.29.0)
-      parser (>= 3.2.1.0)
+    rubocop-ast (1.31.2)
+      parser (>= 3.3.0.4)
     rubocop-shopify (2.14.0)
       rubocop (~> 1.51)
     ruby-progressbar (1.13.0)
-    unicode-display_width (2.4.2)
+    unicode-display_width (2.5.0)
     webmock (3.11.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
@@ -58,4 +61,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.2.25
+   2.5.7

data/bin/profile

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "smart_todo"
+
+class NullDispatcher < SmartTodo::Dispatchers::Base
+  class << self
+    def validate_options!(_); end
+  end
+
+  def dispatch
+  end
+end
+
+exit SmartTodo::CLI.new(NullDispatcher).run

data/dev.yml

@@ -4,7 +4,7 @@ type:
   - ruby
 
 up:
-  - ruby: 3.0.2
+  - ruby
   - bundler
 
 console:

data/lib/smart_todo/cli.rb

@@ -1,15 +1,17 @@
 # frozen_string_literal: true
 
 require "optionparser"
+require "etc"
 
 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
+    def initialize(dispatcher = nil)
       @options = {}
       @errors = []
+      @dispatcher = dispatcher
     end
 
     # @param args [Array<String>]
@@ -19,15 +21,18 @@ module SmartTodo
 
       paths << "." if paths.empty?
 
+      comment_parser = CommentParser.new
       paths.each do |path|
-        normalize_path(path).each do |file|
-          parse_file(file)
+        normalize_path(path).each do |filepath|
+          comment_parser.parse_file(filepath)
 
           $stdout.print(".")
           $stdout.flush
         end
       end
 
+      process_dispatches(process_todos(comment_parser.todos))
+
       if @errors.empty?
         0
       else
@@ -79,14 +84,17 @@ module SmartTodo
       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|
+    def process_todos(todos)
+      events = Events.new
+      dispatches = []
+
+      todos.each do |todo|
         event_message = nil
-        event_met = todo_node.metadata.events.find do |event|
-          event_message = Events.public_send(event.method_name, *event.arguments)
+        event_met = todo.events.find do |event|
+          event_message = events.public_send(event.method_name, *event.arguments)
         rescue => e
-          message = "Error while parsing #{file} on event `#{event.method_name}` with arguments #{event.arguments}: " \
+          message = "Error while parsing #{todo.filepath} on event `#{event.method_name}` " \
+            "with arguments #{event.arguments.map(&:inspect)}: " \
             "#{e.message}"
 
           @errors << message
@@ -94,10 +102,36 @@ module SmartTodo
           nil
         end
 
-        @errors.concat(todo_node.metadata.errors)
-
-        dispatcher.new(event_message, todo_node, file, @options).dispatch if event_met
+        @errors.concat(todo.errors)
+        dispatches << [event_message, todo] if event_met
       end
+
+      dispatches
+    end
+
+    def process_dispatches(dispatches)
+      queue = Queue.new
+      dispatches.each { |dispatch| queue << dispatch }
+
+      thread_count = Etc.nprocessors
+      thread_count.times { queue << nil }
+
+      threads =
+        thread_count.times.map do
+          Thread.new do
+            Thread.current.abort_on_exception = true
+
+            loop do
+              dispatch = queue.pop
+              break if dispatch.nil?
+
+              (event_message, todo) = dispatch
+              dispatcher.new(event_message, todo, todo.filepath, @options).dispatch
+            end
+          end
+        end
+
+      threads.each(&:join)
     end
   end
 end

data/lib/smart_todo/comment_parser.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module SmartTodo
+  class CommentParser
+    attr_reader :todos
+
+    def initialize
+      @todos = []
+    end
+
+    if Prism.respond_to?(:parse_comments)
+      def parse(source, filepath = "-e")
+        parse_comments(Prism.parse_comments(source), filepath)
+      end
+
+      def parse_file(filepath)
+        parse_comments(Prism.parse_file_comments(filepath), filepath)
+      end
+    else
+      def parse(source, filepath = "-e")
+        parse_comments(Prism.parse(source, filepath).comments, filepath)
+      end
+
+      def parse_file(filepath)
+        parse_comments(Prism.parse_file(filepath).comments, filepath)
+      end
+    end
+
+    class << self
+      def parse(source)
+        parser = new
+        parser.parse(source)
+        parser.todos
+      end
+    end
+
+    private
+
+    if defined?(Prism::InlineComment)
+      def inline?(comment)
+        comment.is_a?(Prism::InlineComment)
+      end
+    else
+      def inline?(comment)
+        comment.type == :inline
+      end
+    end
+
+    def parse_comments(comments, filepath)
+      current_todo = nil
+
+      comments.each do |comment|
+        next unless inline?(comment)
+
+        source = comment.location.slice
+
+        if source.match?(/^#\sTODO\(/)
+          todos << current_todo if current_todo
+          current_todo = Todo.new(source, filepath)
+        elsif current_todo && (indent = source[/^#(\s*)/, 1].length) && (indent - current_todo.indent == 2)
+          current_todo << "#{source[(indent + 1)..]}\n"
+        else
+          todos << current_todo if current_todo
+          current_todo = nil
+        end
+      end
+
+      todos << current_todo if current_todo
+    end
+  end
+end

data/lib/smart_todo/dispatchers/base.rb

@@ -40,7 +40,7 @@ module SmartTodo
         @todo_node = todo_node
         @options = options
         @file = file
-        @assignees = @todo_node.metadata.assignees
+        @assignees = @todo_node.assignees
       end
 
       # This method gets called when a TODO reminder is expired and needs to be delivered.

data/lib/smart_todo/events.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
+gem("bundler")
+require "bundler"
+require "net/http"
+require "time"
+require "json"
+
 module SmartTodo
   # This module contains all the methods accessible for SmartTodo comments.
   # It is meant to be reopened by the host application in order to define
@@ -10,7 +16,7 @@ module SmartTodo
   #
   # @example Adding a custom event
   #   module SmartTodo
-  #     module Events
+  #     class Events
   #       def trello_card_close(card)
   #         ...
   #       end
@@ -18,33 +24,87 @@ module SmartTodo
   #   end
   #
   #   TODO(on: trello_card_close(381), to: 'john@example.com')
-  module Events
-    extend self
+  #
+  class Events
+    def initialize(now: nil, spec_set: nil, current_ruby_version: nil)
+      @now = now
+      @spec_set = spec_set
+      @rubygems_client = nil
+      @github_client = nil
+      @current_ruby_version = current_ruby_version
+    end
 
     # Check if the +date+ is in the past
     #
-    # @param date [String] a correctly formatted date
+    # @param on_date [String] a string parsable by Time.parse
     # @return [false, String]
-    def date(date)
-      Date.met?(date)
+    def date(on_date)
+      if now >= Time.parse(on_date)
+        "We are past the *#{on_date}* due date and " \
+          "your TODO is now ready to be addressed."
+      else
+        false
+      end
     end
 
     # Check if a new version of +gem_name+ was released with the +requirements+ expected
     #
+    # @example Expecting a specific version
+    #   gem_release('rails', '6.0')
+    #
+    # @example Expecting a version in the 5.x.x series
+    #   gem_release('rails', '> 5.2', '< 6')
+    #
     # @param gem_name [String]
     # @param requirements [Array<String>] a list of version specifiers
     # @return [false, String]
     def gem_release(gem_name, *requirements)
-      GemRelease.new(gem_name, requirements).met?
+      response = rubygems_client.get("/api/v1/versions/#{gem_name}.json")
+
+      if response.code_type < Net::HTTPClientError
+        "The gem *#{gem_name}* doesn't seem to exist, I can't determine if " \
+          "your TODO is ready to be addressed."
+      else
+        requirement = Gem::Requirement.new(requirements)
+        version = JSON.parse(response.body).find { |gem| requirement.satisfied_by?(Gem::Version.new(gem["number"])) }
+
+        if version
+          "The gem *#{gem_name}* was released to version *#{version["number"]}* and " \
+            "your TODO is now ready to be addressed."
+        else
+          false
+        end
+      end
     end
 
     # Check if +gem_name+ was bumped to the +requirements+ expected
     #
+    # @example Expecting a specific version
+    #   gem_bump('rails', '6.0')
+    #
+    # @example Expecting a version in the 5.x.x series
+    #   gem_bump('rails', '> 5.2', '< 6')
+    #
     # @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?
+      specs = spec_set[gem_name]
+
+      if specs.empty?
+        "The gem *#{gem_name}* is not in your dependencies, I can't determine if " \
+          "your TODO is ready to be addressed."
+      else
+        requirement = Gem::Requirement.new(requirements)
+        version = specs.first.version
+
+        if requirement.satisfied_by?(version)
+          "The gem *#{gem_name}* was updated to version *#{version}* and " \
+            "your TODO is now ready to be addressed."
+        else
+          false
+        end
+      end
     end
 
     # Check if the issue +issue_number+ is closed
@@ -54,7 +114,22 @@ 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?
+      headers = github_headers(organization, repo)
+      response = github_client.get("/repos/#{organization}/#{repo}/issues/#{issue_number}", headers)
+
+      if response.code_type < Net::HTTPClientError
+        <<~EOM
+          I can't retrieve the information from the issue *#{issue_number}* in the *#{organization}/#{repo}* repository.
+
+          If the repository is a private one, make sure to export the `#{GITHUB_TOKEN}`
+          environment variable with a correct GitHub token.
+        EOM
+      elsif JSON.parse(response.body)["state"] == "closed"
+        "The issue https://github.com/#{organization}/#{repo}/issues/#{issue_number} is now closed, " \
+          "your TODO is ready to be addressed."
+      else
+        false
+      end
     end
 
     # Check if the pull request +pr_number+ is closed
@@ -64,7 +139,22 @@ 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?
+      headers = github_headers(organization, repo)
+      response = github_client.get("/repos/#{organization}/#{repo}/pulls/#{pr_number}", headers)
+
+      if response.code_type < Net::HTTPClientError
+        <<~EOM
+          I can't retrieve the information from the PR *#{pr_number}* in the *#{organization}/#{repo}* repository.
+
+          If the repository is a private one, make sure to export the `#{GITHUB_TOKEN}`
+          environment variable with a correct GitHub token.
+        EOM
+      elsif JSON.parse(response.body)["state"] == "closed"
+        "The pull request https://github.com/#{organization}/#{repo}/pull/#{pr_number} is now closed, " \
+          "your TODO is ready to be addressed."
+      else
+        false
+      end
     end
 
     # Check if the installed ruby version meets requirements.
@@ -72,7 +162,61 @@ module SmartTodo
     # @param requirements [Array<String>] a list of version specifiers
     # @return [false, String]
     def ruby_version(*requirements)
-      RubyVersion.new(requirements).met?
+      requirement = Gem::Requirement.new(requirements)
+
+      if requirement.satisfied_by?(current_ruby_version)
+        "The currently installed version of Ruby #{current_ruby_version} is #{requirement}."
+      else
+        false
+      end
+    end
+
+    private
+
+    def now
+      @now ||= Time.now
+    end
+
+    def spec_set
+      @spec_set ||= Bundler.load.specs
+    end
+
+    def rubygems_client
+      @rubygems_client ||= HttpClientBuilder.build("rubygems.org")
+    end
+
+    def github_client
+      @github_client ||= HttpClientBuilder.build("api.github.com")
+    end
+
+    def github_headers(organization, repo)
+      headers = { "Accept" => "application/vnd.github.v3+json" }
+
+      token = github_authorization_token(organization, repo)
+      headers["Authorization"] = "token #{token}" if token
+
+      headers
+    end
+
+    GITHUB_TOKEN = "SMART_TODO_GITHUB_TOKEN"
+
+    # @return [String, nil]
+    def github_authorization_token(organization, repo)
+      organization_name = organization.upcase.gsub(/[^A-Z0-9]/, "_")
+      repo_name = repo.upcase.gsub(/[^A-Z0-9]/, "_")
+
+      [
+        "#{GITHUB_TOKEN}__#{organization_name}__#{repo_name}",
+        "#{GITHUB_TOKEN}__#{organization_name}",
+        GITHUB_TOKEN,
+      ].find do |key|
+        token = ENV[key]
+        break token unless token.nil? || token.empty?
+      end
+    end
+
+    def current_ruby_version
+      @current_ruby_version ||= Gem::Version.new(RUBY_VERSION)
     end
   end
 end

data/lib/smart_todo/http_client_builder.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "net/http"
+
+module SmartTodo
+  # @api private
+  class HttpClientBuilder
+    class << self
+      def build(endpoint)
+        Net::HTTP.new(endpoint, Net::HTTP.https_default_port).tap do |client|
+          client.use_ssl = true
+          client.read_timeout = 30
+          client.ssl_timeout = 15
+          client.max_retries = 2
+        end
+      end
+    end
+  end
+end

data/lib/smart_todo/slack_client.rb

@@ -26,11 +26,7 @@ module SmartTodo
     # @param slack_token [String]
     def initialize(slack_token)
       @slack_token = slack_token
-      @client = Net::HTTP.new("slack.com", Net::HTTP.https_default_port).tap do |client|
-        client.use_ssl = true
-        client.read_timeout = 30
-        client.ssl_timeout = 15
-      end
+      @client = HttpClientBuilder.build("slack.com")
     end
 
     # Retrieve the Slack ID of a user from his email
@@ -43,9 +39,9 @@ module SmartTodo
     #
     # @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=#{CGI.escape(email)}", nil, headers)
+      headers = default_headers.merge("Content-Type" => "application/x-www-form-urlencoded")
+      request = Net::HTTP::Get.new("/api/users.lookupByEmail?email=#{CGI.escape(email)}", headers)
+      dispatch(request)
     end
 
     # Send a message to a Slack channel or to a user
@@ -59,7 +55,10 @@ module SmartTodo
     #
     # @see https://api.slack.com/methods/chat.postMessage
     def post_message(channel, text)
-      request(:post, "/api/chat.postMessage", JSON.dump(channel: channel, text: text))
+      headers = default_headers
+      request = Net::HTTP::Post.new("/api/chat.postMessage", headers)
+      request.body = JSON.dump(channel: channel, text: text)
+      dispatch(request)
     end
 
     private
@@ -71,27 +70,19 @@ module SmartTodo
     #
     # @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
-        @client.public_send(method, endpoint, data, default_headers.merge(headers))
-      else
-        @client.public_send(method, endpoint, default_headers.merge(headers))
-      end
+    def dispatch(request, max_attempts = 5)
+      response = @client.request(request)
+      attempts = 1
 
-      slack_response!(response)
-    end
+      while response.is_a?(Net::HTTPTooManyRequests) && attempts < max_attempts
+        sleep([Integer(response["Retry-After"]), 600].min)
+        response = @client.request(request)
+        attempts += 1
+      end
 
-    # Check if the response to Slack was a 200 and the Slack API request was successful
-    #
-    # @param response [Net::HTTPResponse] a net Net::HTTPResponse subclass
-    #   (Net::HTTPOK, Net::HTTPNotFound ...)
-    # @return [Hash]
-    #
-    # @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
+      unless response.code_type < Net::HTTPSuccess
+        raise(Net::HTTPError.new("Request to slack failed", response))
+      end
 
       body = JSON.parse(response.body)