smart_todo 1.0.2 → 1.3.1

data/lib/smart_todo/parser/metadata_parser.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'ripper'
+require "ripper"
 
 module SmartTodo
   module Parser
@@ -35,7 +35,7 @@ module SmartTodo
       # @param args [Array]
       # @return [Array, MethodNode]
       def on_method_add_arg(method, args)
-        if method == 'TODO'
+        if method == "TODO"
           args
         else
           MethodNode.new(method, args)
@@ -58,12 +58,12 @@ module SmartTodo
       # @param key [String]
       # @param value [String, Integer, MethodNode]
       def on_assoc_new(key, value)
-        key.tr!(':', '')
+        key.tr!(":", "")
 
         case key
-        when 'on'
+        when "on"
           [:on_todo_event, value]
-        when 'to'
+        when "to"
           [:on_todo_assignee, value]
         else
           [:unknown, value]
@@ -78,10 +78,11 @@ module SmartTodo
     end
 
     class Visitor
-      attr_reader :events, :assignee
+      attr_reader :events, :assignees
 
       def initialize
         @events = []
+        @assignees = []
       end
 
       # Iterate over each tokens returned from the parser and call
@@ -103,13 +104,15 @@ module SmartTodo
       # @param method_node [MethodNode]
       # @return [void]
       def on_todo_event(method_node)
+        return unless method_node.is_a?(MethodNode)
+
         events << method_node
       end
 
       # @param assignee [String]
       # @return [void]
       def on_todo_assignee(assignee)
-        @assignee = assignee
+        @assignees << assignee
       end
     end
   end

data/lib/smart_todo/parser/todo_node.rb

@@ -11,7 +11,7 @@ module SmartTodo
 
       # @param todo [String] the actual Ruby comment
       def initialize(todo)
-        @metadata = MetadataParser.parse(todo.gsub(/^#/, ''))
+        @metadata = MetadataParser.parse(todo.gsub(/^#/, ""))
         @comments = []
         @start = todo.match(/^#(\s+)/)[1].size
       end
@@ -26,7 +26,7 @@ module SmartTodo
       # @param comment [String]
       # @return [void]
       def <<(comment)
-        @comments << comment.gsub(/^#(\s+)/, '')
+        @comments << comment.gsub(/^#(\s+)/, "")
       end
 
       # Check if the +comment+ is indented two spaces below the
@@ -36,7 +36,7 @@ module SmartTodo
       # @param comment [String]
       # @return [true, false]
       def indented_comment?(comment)
-        comment.match(/^#(\s+)/)[1].size - @start == DEFAULT_RUBY_INDENTATION
+        comment.match(/^#(\s*)/)[1].size - @start == DEFAULT_RUBY_INDENTATION
       end
     end
   end

data/lib/smart_todo/slack_client.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require 'net/http'
-require 'json'
+require "cgi"
+require "net/http"
+require "json"
 
 module SmartTodo
   # A simple client around the Slack API.
@@ -16,7 +17,7 @@ module SmartTodo
 
       # @param response_body [Hash] the parsed response body from Slack
       def initialize(response_body)
-        @error_code = response_body['error']
+        @error_code = response_body["error"]
 
         super("Response body: #{response_body}")
       end
@@ -25,7 +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 = 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
@@ -37,14 +38,14 @@ module SmartTodo
     # @param email [String]
     # @return [Hash]
     #
-    # @raise [Net::HTTPError] in case the reques to Slack failed
-    # @raise [SlackClient::Error] in case Slack returs a { ok: false } in the body
+    # @raise [Net::HTTPError] in case the request to Slack failed
+    # @raise [SlackClient::Error] in case Slack returns a { ok: false } in the body
     #
     # @see https://api.slack.com/methods/users.lookupByEmail
     def lookup_user_by_email(email)
-      headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+      headers = { "Content-Type" => "application/x-www-form-urlencoded" }
 
-      request(:get, "/api/users.lookupByEmail?email=#{email}", nil, headers)
+      request(:get, "/api/users.lookupByEmail?email=#{CGI.escape(email)}", nil, headers)
     end
 
     # Send a message to a Slack channel or to a user
@@ -53,12 +54,12 @@ module SmartTodo
     # @param text [String] The message to send
     # @return [Hash]
     #
-    # @raise [Net::HTTPError] in case the reques to Slack failed
-    # @raise [SlackClient::Error] in case Slack returs a { ok: false } in the body
+    # @raise [Net::HTTPError] in case the request to Slack failed
+    # @raise [SlackClient::Error] in case Slack returns a { ok: false } in the body
     #
     # @see https://api.slack.com/methods/chat.postMessage
     def post_message(channel, text)
-      request(:post, '/api/chat.postMessage', JSON.dump(channel: channel, text: text))
+      request(:post, "/api/chat.postMessage", JSON.dump(channel: channel, text: text))
     end
 
     private
@@ -68,8 +69,8 @@ module SmartTodo
     # @param data [String] JSON encoded data when making a POST request
     # @param headers [Hash]
     #
-    # @raise [Net::HTTPError] in case the reques to Slack failed
-    # @raise [SlackClient::Error] in case Slack returs a { ok: false } in the body
+    # @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
@@ -87,13 +88,13 @@ module SmartTodo
     #   (Net::HTTPOK, Net::HTTPNotFound ...)
     # @return [Hash]
     #
-    # @raise [Net::HTTPError] in case the reques to Slack failed
-    # @raise [SlackClient::Error] in case Slack returs a { ok: false } in the body
+    # @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
+      raise(Net::HTTPError.new("Request to slack failed", response)) unless response.code_type < Net::HTTPSuccess
       body = JSON.parse(response.body)
 
-      if body['ok']
+      if body["ok"]
         body
       else
         raise(Error, body)
@@ -105,8 +106,8 @@ module SmartTodo
     # @return [Hash]
     def default_headers
       {
-        'Content-Type' => 'application/json; charset=utf8',
-        'Authorization' => "Bearer #{@slack_token}",
+        "Content-Type" => "application/json; charset=utf8",
+        "Authorization" => "Bearer #{@slack_token}",
       }
     end
   end

data/lib/smart_todo/version.rb

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

data/lib/smart_todo.rb

@@ -4,19 +4,25 @@ require "smart_todo/version"
 require "smart_todo/events"
 
 module SmartTodo
-  autoload :SlackClient,              'smart_todo/slack_client'
-  autoload :CLI,                      'smart_todo/cli'
-  autoload :Dispatcher,               'smart_todo/dispatcher'
+  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'
+    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 :GemRelease,             'smart_todo/events/gem_release'
-    autoload :IssueClose,             'smart_todo/events/issue_close'
+    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"
+  end
+
+  module Dispatchers
+    autoload :Base,                   "smart_todo/dispatchers/base"
+    autoload :Slack,                  "smart_todo/dispatchers/slack"
+    autoload :Output,                 "smart_todo/dispatchers/output"
   end
 end

data/lib/smart_todo_cop.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'smart_todo/parser/metadata_parser'
+require "smart_todo/parser/metadata_parser"
 
 module RuboCop
   module Cop
@@ -11,7 +11,7 @@ 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"
+          "For more info please look at https://github.com/shopify/smart_todo"
 
         # @param processed_source [RuboCop::ProcessedSource]
         # @return [void]
@@ -27,9 +27,11 @@ module RuboCop
         # @param comment [String]
         # @return [true, false]
         def smart_todo?(comment)
-          metadata = ::SmartTodo::Parser::MetadataParser.parse(comment.gsub(/^#/, ''))
+          metadata = ::SmartTodo::Parser::MetadataParser.parse(comment.gsub(/^#/, ""))
 
-          metadata.events.any? && metadata.assignee
+          metadata.events.any? &&
+            metadata.events.all? { |event| event.is_a?(::SmartTodo::Parser::MethodNode) } &&
+            metadata.assignees.any?
         end
       end
     end

data/service.yml

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

data/smart_todo.gemspec

@@ -21,18 +21,19 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = spec.homepage + "/blob/master/CHANGELOG.md"
+  spec.metadata["changelog_uri"] = spec.homepage + "/releases"
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
-  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+  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
   spec.bindir        = "exe"
-  spec.executables   = ['smart_todo']
+  spec.executables   = ["smart_todo"]
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency("bundler", "~> 1.17")
-  spec.add_development_dependency("rake", "~> 10.0")
+  spec.add_runtime_dependency("rexml")
+  spec.add_development_dependency("bundler", ">= 1.17")
   spec.add_development_dependency("minitest", "~> 5.0")
+  spec.add_development_dependency("rake", ">= 10.0")
   spec.add_development_dependency("webmock")
-  spec.add_development_dependency("rubocop")
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: smart_todo
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.3.1
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-09 00:00:00.000000000 Z
+date: 2021-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rexml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -53,21 +53,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -91,11 +91,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
+- ".github/workflows/rubocop.yml"
 - ".gitignore"
-- ".rubocop-http---shopify-github-io-ruby-style-guide-rubocop-yml"
 - ".rubocop.yml"
-- ".travis.yml"
-- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -109,9 +108,12 @@ files:
 - exe/smart_todo
 - lib/smart_todo.rb
 - lib/smart_todo/cli.rb
-- lib/smart_todo/dispatcher.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/parser/comment_parser.rb
@@ -120,6 +122,7 @@ files:
 - lib/smart_todo/slack_client.rb
 - lib/smart_todo/version.rb
 - lib/smart_todo_cop.rb
+- service.yml
 - shipit.rubygems.yml
 - smart_todo.gemspec
 homepage: https://github.com/shopify/smart_todo
@@ -128,7 +131,8 @@ licenses:
 metadata:
   homepage_uri: https://github.com/shopify/smart_todo
   source_code_uri: https://github.com/shopify/smart_todo
-  changelog_uri: https://github.com/shopify/smart_todo/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/shopify/smart_todo/releases
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -144,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.20
 signing_key: 
 specification_version: 4
 summary: Enhance todo's comments in your codebase.