smart_todo 1.3.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc3a4665a0110180692321fbdd788be8df4155de16bf75b2967f4c330a759e72
-  data.tar.gz: 414a198aa06035126890b002f6552779c73d9f6f84eeeaa904ba2132daa7d4d9
+  metadata.gz: 4daea874da20235bc9b20d315058644bafb73e78b14c6c266f6252f4b346bcf1
+  data.tar.gz: feb305070b73a03e2481515a914cca2fcaad264f3871cd65e242bf58ccb3612f
 SHA512:
-  metadata.gz: 8e0c57b0849a90cd1be9699d264167e7286d622eb42e02cc7dd13231ab41d76d815a455a65571f3890dda7c79dc0228692b0c72c37c50337826df137d0c0f0df
-  data.tar.gz: a62b94332abe655cb418d0238eaa24e86db0e48b109877b8192265a244795624a2188cffeb0be429f0204683394b992ce73a0932efc322b4c3ba589cadcd0af4
+  metadata.gz: 7fcba36662ce881114aafa3f5bba320d767c3e299a1d9d91f06a505107815d631c008ed87a1e853d1bb2766c1e9bdce756125ccc9c5ed65917264f962da62814
+  data.tar.gz: 981c7785a6c5e4d2805d004f6ec1411a953ec9d68005314bc8fe52bf1deb5f6c036a73ea4a08cf3346a120f765971c4fbb0049bdc4ebf97c867bf7e14f7690b8

data/.devcontainer/devcontainer.json

@@ -0,0 +1,25 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/ruby
+{
+	"name": "Ruby",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/ruby:0-3-bullseye",
+	"features": {
+		"ghcr.io/devcontainers/features/github-cli:1": {}
+	},
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": "bundle install",
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

data/.github/workflows/build.yml

@@ -12,7 +12,7 @@ jobs:
     name: Ruby ${{ matrix.version }}
     strategy:
       matrix:
-        version: [2.5, 2.6, 2.7, 3.0]
+        version: [3.0, 3.1, 3.2]
 
     steps:
       - uses: actions/checkout@v2
@@ -24,4 +24,3 @@ jobs:
       - name: Run Tests
         run: |
           bundle exec rake test
-

data/.github/workflows/cla.yml

@@ -0,0 +1,22 @@
+name: Contributor License Agreement (CLA)
+
+on:
+  pull_request_target:
+    types: [opened, synchronize]
+  issue_comment:
+    types: [created]
+
+jobs:
+  cla:
+    runs-on: ubuntu-latest
+    if: |
+      (github.event.issue.pull_request 
+        && !github.event.issue.pull_request.merged_at
+        && contains(github.event.comment.body, 'signed')
+      ) 
+      || (github.event.pull_request && !github.event.pull_request.merged)
+    steps:
+      - uses: Shopify/shopify-cla-action@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          cla-token: ${{ secrets.CLA_TOKEN }}

data/.rubocop.yml

@@ -3,5 +3,7 @@ inherit_gem:
 
 AllCops:
   TargetRubyVersion: 3.0
+  NewCops: disable
+  SuggestExtensions: false
   Exclude:
     - vendor/**/*

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smart_todo (1.3.1)
+    smart_todo (1.5.0)
       rexml
 
 GEM
@@ -13,30 +13,34 @@ GEM
     crack (0.4.5)
       rexml
     hashdiff (1.0.1)
+    json (2.6.3)
     minitest (5.14.4)
-    parallel (1.21.0)
-    parser (3.0.2.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
     public_suffix (4.0.6)
-    rainbow (3.0.0)
+    racc (1.7.0)
+    rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.1.1)
+    regexp_parser (2.8.1)
     rexml (3.2.5)
-    rubocop (1.23.0)
+    rubocop (1.52.1)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.13.0)
-      parser (>= 3.0.1.1)
-    rubocop-shopify (2.3.0)
-      rubocop (~> 1.22)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.1.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-shopify (2.14.0)
+      rubocop (~> 1.51)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
     webmock (3.11.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Shopify
+Copyright (c) 2019-present 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

data/bin/rubocop

@@ -9,8 +9,10 @@
 #
 
 require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path(
+  "../../Gemfile",
+  Pathname.new(__FILE__).realpath,
+)
 
 bundle_binstub = File.expand_path("../bundle", __FILE__)
 

data/exe/smart_todo

@@ -9,4 +9,4 @@ if ENV["ENABLE_SMART_TODO"] && !ARGV.include?("--dispatcher")
   ARGV << "--dispatcher" << "slack"
 end
 
-SmartTodo::CLI.new.run
+exit SmartTodo::CLI.new.run

data/lib/smart_todo/cli.rb

@@ -9,21 +9,35 @@ module SmartTodo
   class CLI
     def initialize
       @options = {}
+      @errors = []
     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
+          $stdout.print(".")
+          $stdout.flush
+        end
+      end
+
+      if @errors.empty?
+        0
+      else
+        $stderr.puts "There were errors while checking for TODOs:\n"
+
+        @errors.each do |error|
+          $stderr.puts error
         end
+
+        1
       end
     end
 
@@ -71,8 +85,17 @@ module SmartTodo
         event_message = nil
         event_met = todo_node.metadata.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}: " \
+            "#{e.message}"
+
+          @errors << message
+
+          nil
         end
 
+        @errors.concat(todo_node.metadata.errors)
+
         dispatcher.new(event_message, todo_node, file, @options).dispatch if event_met
       end
     end

data/lib/smart_todo/dispatchers/base.rb

@@ -3,29 +3,31 @@
 module SmartTodo
   module Dispatchers
     class Base
-      # Factory pattern to retrive the right dispatcher class.
-      #
-      # @param dispatcher [String]
-      #
-      # @return [Class]
-      def self.class_for(dispatcher)
-        case dispatcher
-        when "slack"
-          Slack
-        when nil, "output"
-          Output
+      class << self
+        # Factory pattern to retrieve the right dispatcher class.
+        #
+        # @param dispatcher [String]
+        #
+        # @return [Class]
+        def class_for(dispatcher)
+          case dispatcher
+          when "slack"
+            Slack
+          when nil, "output"
+            Output
+          end
         end
-      end
 
-      # Subclasses should define what options from the CLI they need in order
-      # to properly deliver the message. For instance the Slack dispatcher
-      # requires an API key.
-      #
-      # @param _options [Hash]
-      #
-      # @return void
-      def self.validate_options!(_options)
-        raise(NotImplemetedError, "subclass responsability")
+        # Subclasses should define what options from the CLI they need in order
+        # to properly deliver the message. For instance the Slack dispatcher
+        # requires an API key.
+        #
+        # @param _options [Hash]
+        #
+        # @return void
+        def validate_options!(_options)
+          raise(NotImplemetedError, "subclass responsability")
+        end
       end
 
       # @param event_message [String] the success message associated

data/lib/smart_todo/dispatchers/output.rb

@@ -4,7 +4,9 @@ module SmartTodo
   module Dispatchers
     # A simple dispatcher that will output the reminder.
     class Output < Base
-      def self.validate_options!(_); end
+      class << self
+        def validate_options!(_); end
+      end
 
       # @return void
       def dispatch

data/lib/smart_todo/dispatchers/slack.rb

@@ -5,10 +5,12 @@ module SmartTodo
     # Dispatcher that sends TODO reminders on Slack. Assignees can be either individual
     # (using the associated slack email address) or a channel.
     class Slack < Base
-      def self.validate_options!(options)
-        options[:slack_token] ||= ENV.fetch("SMART_TODO_SLACK_TOKEN") { raise(ArgumentError, "Missing :slack_token") }
+      class << self
+        def validate_options!(options)
+          options[:slack_token] ||= ENV.fetch("SMART_TODO_SLACK_TOKEN") { raise(ArgumentError, "Missing :slack_token") }
 
-        options.fetch(:fallback_channel) { raise(ArgumentError, "Missing :fallback_channel") }
+          options.fetch(:fallback_channel) { raise(ArgumentError, "Missing :fallback_channel") }
+        end
       end
 
       # Make a Slack API call to dispatch the message to each assignee
@@ -35,7 +37,7 @@ module SmartTodo
 
         client.post_message(user.dig("user", "id"), slack_message(user, assignee))
       rescue SlackClient::Error => error
-        if ["users_not_found", "channel_not_found"].include?(error.error_code)
+        if ["users_not_found", "channel_not_found", "is_archived"].include?(error.error_code)
           user = { "user" => { "id" => @options[:fallback_channel] }, "fallback" => true }
         else
           raise(error)

data/lib/smart_todo/events/date.rb

@@ -6,20 +6,22 @@ module SmartTodo
   module Events
     # An event that check if the passed date is passed
     class Date
-      # @param on_date [String] a string parsable by Time.parse
-      # @return [String, false]
-      def self.met?(on_date)
-        if Time.now >= Time.parse(on_date)
-          message(on_date)
-        else
-          false
+      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
-      end
 
-      # @param on_date [String]
-      # @return [String]
-      def self.message(on_date)
-        "We are past the *#{on_date}* due date and your TODO is now ready to be addressed."
+        # @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

data/lib/smart_todo/parser/metadata_parser.rb

@@ -18,10 +18,12 @@ module SmartTodo
 
     # This class is used to parse the ruby TODO() comment.
     class MetadataParser < Ripper
-      # @param source [String] the actual Ruby code
-      def self.parse(source)
-        sexp = new(source).parse
-        Visitor.new.tap { |v| v.process(sexp) }
+      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
@@ -78,11 +80,12 @@ module SmartTodo
     end
 
     class Visitor
-      attr_reader :events, :assignees
+      attr_reader :events, :assignees, :errors
 
       def initialize
         @events = []
         @assignees = []
+        @errors = []
       end
 
       # Iterate over each tokens returned from the parser and call
@@ -104,9 +107,11 @@ module SmartTodo
       # @param method_node [MethodNode]
       # @return [void]
       def on_todo_event(method_node)
-        return unless method_node.is_a?(MethodNode)
-
-        events << method_node
+        if method_node.is_a?(MethodNode)
+          events << method_node
+        else
+          errors << "Incorrect `:on` event format: #{method_node}"
+        end
       end
 
       # @param assignee [String]

data/lib/smart_todo/slack_client.rb

@@ -82,7 +82,7 @@ module SmartTodo
       slack_response!(response)
     end
 
-    # Chech if the response to Slack was a 200 and the Slack API request was successful
+    # 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 ...)
@@ -92,6 +92,7 @@ module SmartTodo
     # @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
+
       body = JSON.parse(response.body)
 
       if body["ok"]

data/lib/smart_todo/version.rb

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

data/lib/smart_todo_cop.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "smart_todo/parser/metadata_parser"
+require "smart_todo"
 
 module RuboCop
   module Cop
@@ -10,29 +10,48 @@ module RuboCop
       #
       # @see https://rubocop.readthedocs.io/en/latest/extensions/#loading-extensions
       class SmartTodoCop < Cop
-        MSG = "Don't write regular TODO comments. Write SmartTodo compatible syntax comments." \
-          "For more info please look at https://github.com/shopify/smart_todo"
+        HELP = "For more info please look at https://github.com/Shopify/smart_todo/wiki/Syntax"
+        MSG = "Don't write regular TODO comments. Write SmartTodo compatible syntax comments. #{HELP}"
 
         # @param processed_source [RuboCop::ProcessedSource]
         # @return [void]
         def investigate(processed_source)
           processed_source.comments.each do |comment|
             next unless /^#\sTODO/ =~ comment.text
-            next if smart_todo?(comment.text)
 
-            add_offense(comment)
+            metadata = metadata(comment.text)
+
+            if metadata.errors.any?
+              add_offense(comment, message: "Invalid TODO format: #{metadata.errors.join(", ")}. #{HELP}")
+            elsif !smart_todo?(metadata)
+              add_offense(comment)
+            elsif (methods = invalid_event_methods(metadata.events)).any?
+              add_offense(comment, message: "Invalid event method(s): #{methods.join(", ")}. #{HELP}")
+            end
           end
         end
 
+        private
+
         # @param comment [String]
-        # @return [true, false]
-        def smart_todo?(comment)
-          metadata = ::SmartTodo::Parser::MetadataParser.parse(comment.gsub(/^#/, ""))
+        # @return [SmartTodo::Parser::Visitor]
+        def metadata(comment)
+          ::SmartTodo::Parser::MetadataParser.parse(comment.gsub(/^#/, ""))
+        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.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) }
+        end
       end
     end
   end

data/service.yml

@@ -1 +0,0 @@
-classification: library

data/smart_todo.gemspec

@@ -24,6 +24,8 @@ Gem::Specification.new do |spec|
   spec.metadata["changelog_uri"] = spec.homepage + "/releases"
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
+  spec.required_ruby_version = ">= 3.0.0"
+
   spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
     %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_todo
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-23 00:00:00.000000000 Z
+date: 2023-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rexml
@@ -91,7 +91,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".devcontainer/devcontainer.json"
 - ".github/workflows/build.yml"
+- ".github/workflows/cla.yml"
 - ".github/workflows/rubocop.yml"
 - ".gitignore"
 - ".rubocop.yml"
@@ -141,14 +143,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.20
+rubygems_version: 3.4.13
 signing_key: 
 specification_version: 4
 summary: Enhance todo's comments in your codebase.