smart_todo 1.6.0 → 1.8.0

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.8.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.8.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-07-18 00:00:00.000000000 Z
+date: 2024-06-26 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
@@ -97,6 +97,7 @@ files:
 - ".github/workflows/rubocop.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- ".ruby-version"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -104,25 +105,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 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.16
+rubygems_version: 3.5.13
 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