smart_todo 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c17d1471d893e5a764dda2fa9adcfc73049b5c5a45d6678feca40104879065fc
-  data.tar.gz: 85411f13bc189f060372e90a72fc1a545cd0030b6f67cf0fd75f1ff97dbeb755
+  metadata.gz: 7bbca316fba93242bc5ea22479579407ed9ce3ed93a6bd618978223f96f0626d
+  data.tar.gz: c91cf35475f5a32da647f6ed649ac7d50d85a929908aa29f1768a9b1d6db75da
 SHA512:
-  metadata.gz: bfe190ce26c9b3e65aea86f3d23e40a400c14edcac8c465b361341ac00a7ab7d59498c9c3edda92d7e180659cad96240148bce26dc3a1db77a92ee2e03575204
-  data.tar.gz: f1c0386fbb5346a74c3f9c0c3b6228a9af29a810241793a5f44db5cbe7d7873c24e9dda987b65aff0d4984193be3652bec472431a48407badb2eb7610da506d6
+  metadata.gz: 1668111d5578d6c64f2ff7df6071f9ede6ccc4aeb01bf1c5cdccea8d514cf29caad0b2b576bb3bb60eaaaa309f44b723e066c62b39b50ab17e418372a29c4dad
+  data.tar.gz: 25636e700c032b2bc0509791f8884f9e9f6cb78ae09103db503d69739e48507c07c8a8fc6579f4f441c1f08caf09f19274ad19061305b9ad9b82efc5c41e9711

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    smart_todo (1.6.0)
-      rexml
+    smart_todo (1.7.0)
+      prism (~> 0.15)
 
 GEM
   remote: https://rubygems.org/
@@ -19,6 +19,7 @@ GEM
     parser (3.2.2.3)
       ast (~> 2.4.1)
       racc
+    prism (0.17.0)
     public_suffix (4.0.6)
     racc (1.7.0)
     rainbow (3.1.1)

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/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

data/lib/smart_todo/todo.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module SmartTodo
+  class Todo
+    attr_reader :filepath, :comment, :indent
+    attr_reader :events, :assignees, :errors
+
+    def initialize(source, filepath = "-e")
+      @filepath = filepath
+      @comment = +""
+      @indent = source[/^#(\s+)/, 1].length
+
+      @events = []
+      @assignees = []
+      @errors = []
+
+      parse(source[(indent + 1)..])
+    end
+
+    def <<(source)
+      comment << source
+    end
+
+    class CallNode
+      attr_reader :method_name, :arguments, :location
+
+      def initialize(method_name, arguments, location)
+        @arguments = arguments
+        @method_name = method_name
+        @location = location
+      end
+    end
+
+    class Compiler < Prism::Compiler
+      attr_reader :metadata
+
+      def initialize(metadata)
+        super()
+        @metadata = metadata
+      end
+
+      def visit_call_node(node)
+        CallNode.new(node.name, visit_all(node.arguments&.arguments || []), node.location)
+      end
+
+      def visit_integer_node(node)
+        node.value
+      end
+
+      def visit_keyword_hash_node(node)
+        node.elements.each do |element|
+          next unless (key = element.key).is_a?(Prism::SymbolNode)
+
+          case key.unescaped.to_sym
+          when :on
+            value = visit(element.value)
+
+            if value.is_a?(CallNode)
+              if value.arguments.all? { |arg| arg.is_a?(Integer) || arg.is_a?(String) }
+                metadata.events << value
+              else
+                metadata.errors << "Incorrect `:on` event format: #{value.location.slice}"
+              end
+            else
+              metadata.errors << "Incorrect `:on` event format: #{value.inspect}"
+            end
+          when :to
+            metadata.assignees << visit(element.value)
+          end
+        end
+      end
+
+      def visit_string_node(node)
+        node.unescaped
+      end
+    end
+
+    private
+
+    def parse(source)
+      Prism.parse(source).value.statements.body.first.accept(Compiler.new(self))
+    end
+  end
+end

data/lib/smart_todo/version.rb

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

data/lib/smart_todo.rb

@@ -1,25 +1,15 @@
 # frozen_string_literal: true
 
+require "prism"
 require "smart_todo/version"
 require "smart_todo/events"
 
 module SmartTodo
   autoload :SlackClient,              "smart_todo/slack_client"
   autoload :CLI,                      "smart_todo/cli"
-
-  module Parser
-    autoload :CommentParser,          "smart_todo/parser/comment_parser"
-    autoload :TodoNode,               "smart_todo/parser/todo_node"
-    autoload :MetadataParser,         "smart_todo/parser/metadata_parser"
-  end
-
-  module Events
-    autoload :Date,                   "smart_todo/events/date"
-    autoload :GemBump,                "smart_todo/events/gem_bump"
-    autoload :GemRelease,             "smart_todo/events/gem_release"
-    autoload :IssueClose,             "smart_todo/events/issue_close"
-    autoload :RubyVersion,            "smart_todo/events/ruby_version"
-  end
+  autoload :Todo,                     "smart_todo/todo"
+  autoload :CommentParser,            "smart_todo/comment_parser"
+  autoload :HttpClientBuilder,        "smart_todo/http_client_builder"
 
   module Dispatchers
     autoload :Base,                   "smart_todo/dispatchers/base"

data/lib/smart_todo_cop.rb

@@ -17,7 +17,7 @@ module RuboCop
         # @return [void]
         def investigate(processed_source)
           processed_source.comments.each do |comment|
-            next unless /^#\sTODO/ =~ comment.text
+            next unless /^#\sTODO/.match?(comment.text)
 
             metadata = metadata(comment.text)
 
@@ -36,21 +36,21 @@ module RuboCop
         # @param comment [String]
         # @return [SmartTodo::Parser::Visitor]
         def metadata(comment)
-          ::SmartTodo::Parser::MetadataParser.parse(comment.gsub(/^#/, ""))
+          ::SmartTodo::Todo.new(comment)
         end
 
         # @param metadata [SmartTodo::Parser::Visitor]
         # @return [true, false]
         def smart_todo?(metadata)
           metadata.events.any? &&
-            metadata.events.all? { |event| event.is_a?(::SmartTodo::Parser::MethodNode) } &&
+            metadata.events.all? { |event| event.is_a?(::SmartTodo::Todo::CallNode) } &&
             metadata.assignees.any?
         end
 
         # @param metadata [Array<SmartTodo::Parser::MethodNode>]
         # @return [Array<String>]
         def invalid_event_methods(events)
-          events.map(&:method_name).reject { |method| ::SmartTodo::Events.respond_to?(method) }
+          events.map(&:method_name).reject { |method| ::SmartTodo::Events.method_defined?(method) }
         end
       end
     end

data/smart_todo.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.executables   = ["smart_todo"]
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency("rexml")
+  spec.add_runtime_dependency("prism", "~> 0.15")
   spec.add_development_dependency("bundler", ">= 1.17")
   spec.add_development_dependency("minitest", "~> 5.0")
   spec.add_development_dependency("rake", ">= 10.0")

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: smart_todo
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-07-18 00:00:00.000000000 Z
+date: 2023-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rexml
+  name: prism
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.15'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -104,25 +104,21 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/profile
 - bin/rubocop
 - bin/setup
 - dev.yml
 - exe/smart_todo
 - lib/smart_todo.rb
 - lib/smart_todo/cli.rb
+- lib/smart_todo/comment_parser.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_bump.rb
-- lib/smart_todo/events/gem_release.rb
-- lib/smart_todo/events/issue_close.rb
-- lib/smart_todo/events/ruby_version.rb
-- lib/smart_todo/parser/comment_parser.rb
-- lib/smart_todo/parser/metadata_parser.rb
-- lib/smart_todo/parser/todo_node.rb
+- lib/smart_todo/http_client_builder.rb
 - lib/smart_todo/slack_client.rb
+- lib/smart_todo/todo.rb
 - lib/smart_todo/version.rb
 - lib/smart_todo_cop.rb
 - service.yml
@@ -151,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.16
+rubygems_version: 3.4.22
 signing_key: 
 specification_version: 4
 summary: Enhance todo's comments in your codebase.

data/lib/smart_todo/events/date.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-require "time"
-
-module SmartTodo
-  module Events
-    # An event that check if the passed date is passed
-    class Date
-      class << self
-        # @param on_date [String] a string parsable by Time.parse
-        # @return [String, false]
-        def met?(on_date)
-          if Time.now >= Time.parse(on_date)
-            message(on_date)
-          else
-            false
-          end
-        end
-
-        # @param on_date [String]
-        # @return [String]
-        def message(on_date)
-          "We are past the *#{on_date}* due date and your TODO is now ready to be addressed."
-        end
-      end
-    end
-  end
-end

data/lib/smart_todo/events/gem_bump.rb

@@ -1,57 +0,0 @@
-# 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,69 +0,0 @@
-# frozen_string_literal: true
-
-require "net/http"
-require "json"
-
-module SmartTodo
-  module Events
-    # An event that check if a new version of gem has been released on RubyGem
-    # with the expected version specifiers.
-    # This event will make an API call to the RubyGem API
-    class GemRelease
-      # @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
-      #   GemRelease.new('rails', ['6.0'])
-      #
-      # @example Expecting a version in the 5.x.x series
-      #   GemRelease.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?
-        response = client.get("/api/v1/versions/#{@gem_name}.json")
-
-        if response.code_type < Net::HTTPClientError
-          error_message
-        elsif (gem = version_released?(response.body))
-          message(gem["number"])
-        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}* doesn't seem to exist, I can't determine if your TODO is ready to be addressed."
-      end
-
-      # @return [String]
-      def message(version_number)
-        "The gem *#{@gem_name}* was released to version *#{version_number}* and your TODO is now ready to be addressed."
-      end
-
-      private
-
-      # @param gem_versions [String] the response sent from RubyGems
-      # @return [true, false]
-      def version_released?(gem_versions)
-        JSON.parse(gem_versions).find do |gem|
-          @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.use_ssl = true
-        end
-      end
-    end
-  end
-end

data/lib/smart_todo/events/issue_close.rb

@@ -1,113 +0,0 @@
-# frozen_string_literal: true
-
-require "net/http"
-require "json"
-
-module SmartTodo
-  module Events
-    # An event that check if a GitHub Pull Request or Issue is closed.
-    # This event will make an API call to the GitHub API.
-    #
-    # If the Pull Request or Issue is on a private repository, exporting a token
-    # with the `repos` scope in the +SMART_TODO_GITHUB_TOKEN+ environment variable
-    # is required.
-    #
-    # You can also set a per-org or per-repo token by exporting more specific environment variables:
-    # +SMART_TODO_GITHUB_TOKEN__<ORG>+ and +SMART_TODO_GITHUB_TOKEN__<ORG>__<REPO>+
-    # The +<ORG>+ and +<REPO>+ parts should be uppercased and use underscores.
-    # For example, +Shopify/my-repo+ would become +SMART_TODO_GITHUB_TOKEN__SHOPIFY__MY_REPO=...+.
-    class IssueClose
-      TOKEN_ENV = "SMART_TODO_GITHUB_TOKEN"
-
-      # @param organization [String]
-      # @param repo [String]
-      # @param pr_number [String, Integer]
-      def initialize(organization, repo, pr_number, type:)
-        @url = "/repos/#{organization}/#{repo}/#{type}/#{pr_number}"
-        @organization = organization
-        @repo = repo
-        @pr_number = pr_number
-      end
-
-      # @return [String, false]
-      def met?
-        response = client.get(@url, default_headers)
-
-        if response.code_type < Net::HTTPClientError
-          error_message
-        elsif pull_request_closed?(response.body)
-          message
-        else
-          false
-        end
-      end
-
-      # Error message send to Slack in case the Pull Request or Issue couldn't be found.
-      #
-      # @return [String]
-      def error_message
-        <<~EOM
-          I can't retrieve the information from the PR or Issue *#{@pr_number}* in the
-          *#{@organization}/#{@repo}* repository.
-
-          If the repository is a private one, make sure to export the `#{TOKEN_ENV}`
-          environment variable with a correct GitHub token.
-        EOM
-      end
-
-      # @return [String]
-      def message
-        <<~EOM
-          The Pull Request or Issue https://github.com/#{@organization}/#{@repo}/pull/#{@pr_number}
-          is now closed, your TODO is ready to be addressed.
-        EOM
-      end
-
-      private
-
-      # @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.use_ssl = true
-        end
-      end
-
-      # @param pull_request [String] the Pull Request or Issue
-      #   detail sent back from the GitHub API
-      #
-      # @return [true, false]
-      def pull_request_closed?(pull_request)
-        JSON.parse(pull_request)["state"] == "closed"
-      end
-
-      # @return [Hash]
-      def default_headers
-        { "Accept" => "application/vnd.github.v3+json" }.tap do |headers|
-          token = authorization_token
-          headers["Authorization"] = "token #{token}" if token
-        end
-      end
-
-      # @return [String, nil]
-      def authorization_token
-        # Will look in order for:
-        # SMART_TODO_GITHUB_TOKEN__ORG__REPO
-        # SMART_TODO_GITHUB_TOKEN__ORG
-        # SMART_TODO_GITHUB_TOKEN
-        parts = [
-          TOKEN_ENV,
-          @organization.upcase.gsub(/[^A-Z0-9]/, "_"),
-          @repo.upcase.gsub(/[^A-Z0-9]/, "_"),
-        ]
-
-        (parts.size - 1).downto(0).each do |i|
-          key = parts[0..i].join("__")
-          token = ENV[key]
-          return token unless token.nil? || token.empty?
-        end
-
-        nil
-      end
-    end
-  end
-end

data/lib/smart_todo/events/ruby_version.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module SmartTodo
-  module Events
-    # An event that checks the currently installed ruby version.
-    # @example
-    #   RubyVersion.new(['>= 2.3', '< 3'])
-    class RubyVersion
-      def initialize(requirements)
-        @requirements = Gem::Requirement.new(requirements)
-      end
-
-      # @param requirements [Array<String>] a list of version specifiers
-      # @return [String, false]
-      def met?
-        if @requirements.satisfied_by?(Gem::Version.new(installed_ruby_version))
-          message(installed_ruby_version)
-        else
-          false
-        end
-      end
-
-      # @param installed_ruby_version [String], requirements [String]
-      # @return [String]
-      def message(installed_ruby_version)
-        "The currently installed version of Ruby #{installed_ruby_version} is #{@requirements}."
-      end
-
-      private
-
-      def installed_ruby_version
-        RUBY_VERSION
-      end
-    end
-  end
-end

data/lib/smart_todo/parser/comment_parser.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-require "ripper"
-
-module SmartTodo
-  module Parser
-    # This class is used to parse Ruby code and will stop each time
-    # a Ruby comment is encountered. It will detect if a TODO comment
-    # is a Smart Todo and will gather the comments associated to the TODO.
-    class CommentParser < Ripper::Filter
-      def initialize(*)
-        super
-        @node = nil
-      end
-
-      # @param comment [String] the actual Ruby comment
-      # @param data [Array<TodoNode>]
-      # @return [Array<TodoNode>]
-      def on_comment(comment, data)
-        if todo_metadata?(comment)
-          append_existing_node(data)
-          @node = TodoNode.new(comment)
-        elsif todo_comment?(comment)
-          @node << comment
-        else
-          append_existing_node(data)
-          @node = nil
-        end
-
-        data
-      end
-
-      # @param init [Array]
-      # @return [Array<TodoNode>]
-      def parse(init = [])
-        super(init)
-
-        init.tap { append_existing_node(init) }
-      end
-
-      private
-
-      # @param comment [String] the actual Ruby comment
-      # @return [nil, Integer]
-      def todo_metadata?(comment)
-        /^#\sTODO\(/ =~ comment
-      end
-
-      # Check if the comment is associated with the Smart Todo
-      # @param comment [String] the actual Ruby comment
-      # @return [true, false]
-      #
-      # @example When a comment is associated to a SmartTodo
-      #   TODO(on_date(...), to: '...')
-      #     This is an associated comment
-      #
-      # @example When a comment is not associated to a SmartTodo
-      #   TODO(on_date(...), to: '...')
-      #   This is an associated comment (Note the indentation)
-      def todo_comment?(comment)
-        @node&.indented_comment?(comment)
-      end
-
-      # @param data [Array<TodoNode>]
-      # @return [Array<TodoNode>]
-      def append_existing_node(data)
-        data << @node if @node
-      end
-    end
-  end
-end

data/lib/smart_todo/parser/metadata_parser.rb

@@ -1,124 +0,0 @@
-# frozen_string_literal: true
-
-require "ripper"
-
-module SmartTodo
-  module Parser
-    # A MethodNode represent an event associated to a TODO.
-    class MethodNode
-      attr_reader :method_name, :arguments
-
-      # @param method_name [Symbol]
-      # @param arguments [Array<String>]
-      def initialize(method_name, arguments)
-        @arguments = arguments
-        @method_name = method_name
-      end
-    end
-
-    # This class is used to parse the ruby TODO() comment.
-    class MetadataParser < Ripper
-      class << self
-        # @param source [String] the actual Ruby code
-        def parse(source)
-          sexp = new(source).parse
-          Visitor.new.tap { |v| v.process(sexp) }
-        end
-      end
-
-      # @return [Array] an Array of Array
-      #   the first element from each inner array is a token
-      def on_stmts_add(_, data)
-        data
-      end
-
-      # @param method [String] the name of the method
-      #   when the parser hits one.
-      # @param args [Array]
-      # @return [Array, MethodNode]
-      def on_method_add_arg(method, args)
-        if method.start_with?(/TODO\W?/)
-          args
-        else
-          MethodNode.new(method, args)
-        end
-      end
-
-      # @param list [nil, Array]
-      # @param arg [String]
-      # @return [Array]
-      def on_args_add(list, arg)
-        Array(list) << arg
-      end
-
-      # @param string_content [String]
-      # @return [String]
-      def on_string_add(_, string_content)
-        string_content
-      end
-
-      # @param key [String]
-      # @param value [String, Integer, MethodNode]
-      def on_assoc_new(key, value)
-        key.tr!(":", "")
-
-        case key
-        when "on"
-          [:on_todo_event, value]
-        when "to"
-          [:on_todo_assignee, value]
-        else
-          [:unknown, value]
-        end
-      end
-
-      # @param data [Hash]
-      # @return [Hash]
-      def on_bare_assoc_hash(data)
-        data
-      end
-    end
-
-    class Visitor
-      attr_reader :events, :assignees, :errors
-
-      def initialize
-        @events = []
-        @assignees = []
-        @errors = []
-      end
-
-      # Iterate over each tokens returned from the parser and call
-      # the corresponding method
-      #
-      # @param sexp [Array]
-      # @return [void]
-      def process(sexp)
-        return unless sexp
-
-        if sexp[0].is_a?(Array)
-          sexp.each { |node| process(node) }
-        else
-          method, *args = sexp
-          send(method, *args) if method.is_a?(Symbol) && respond_to?(method)
-        end
-      end
-
-      # @param method_node [MethodNode]
-      # @return [void]
-      def on_todo_event(method_node)
-        if method_node.is_a?(MethodNode)
-          events << method_node
-        else
-          errors << "Incorrect `:on` event format: #{method_node}"
-        end
-      end
-
-      # @param assignee [String]
-      # @return [void]
-      def on_todo_assignee(assignee)
-        @assignees << assignee
-      end
-    end
-  end
-end

data/lib/smart_todo/parser/todo_node.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module SmartTodo
-  module Parser
-    # Represents a SmartTodo which includes the associated events
-    # as well as the assignee.
-    class TodoNode
-      DEFAULT_RUBY_INDENTATION = 2
-
-      attr_reader :metadata
-
-      # @param todo [String] the actual Ruby comment
-      def initialize(todo)
-        @metadata = MetadataParser.parse(todo.gsub(/^#/, ""))
-        @comments = []
-        @start = todo.match(/^#(\s+)/)[1].size
-      end
-
-      # Return the associated comment for this TODO
-      #
-      # @return [String]
-      def comment
-        @comments.join
-      end
-
-      # @param comment [String]
-      # @return [void]
-      def <<(comment)
-        @comments << comment.gsub(/^#(\s+)/, "")
-      end
-
-      # Check if the +comment+ is indented two spaces below the
-      # TODO declaration. If yes the comment is considered to be part
-      # of the TODO itself. Otherwise it's just a regular comment.
-      #
-      # @param comment [String]
-      # @return [true, false]
-      def indented_comment?(comment)
-        comment.match(/^#(\s*)/)[1].size - @start == DEFAULT_RUBY_INDENTATION
-      end
-    end
-  end
-end