Merge pull request #5 from ksss/support-option

Fix to support `@option` tag

Author: ksss

lib/rubocop/cop/yard/tag_type.rb

@@ -48,11 +48,12 @@ def on_new_investigation
 
         def check(comment)
           docstring = comment.text.gsub(/\A#\s*/, '')
-          check_syntax_error(comment) do
-            ::YARD::DocstringParser.new.parse(docstring).tags.each do |tag|
-              next unless tag.types
+          ::YARD::DocstringParser.new.parse(docstring).tags.each do |tag|
+            types = extract_tag_type(tag)
 
-              ::YARD::Tags::TypesExplainer::Parser.parse(tag.types.join(', ')).each do |types_explainer|
+            check_syntax_error(comment) do
+              types_explainers = ::YARD::Tags::TypesExplainer::Parser.parse(types.join(', '))
+              types_explainers.each do |types_explainer|
                 check_mismatch_collection_type(comment, types_explainer)
               end
             end
@@ -95,12 +96,21 @@ def check_mismatch_collection_type(comment, types_explainer)
           end
         end
 
+        def extract_tag_type(tag)
+          case tag
+          when ::YARD::Tags::OptionTag
+            tag.pair.types
+          else
+            tag.types
+          end
+        end
+
         def inline_comment?(comment)
           !comment_line?(comment.source_range.source_line)
         end
 
         def include_yard_tag?(comment)
-          comment.source.match?(/@(?:param|return|option|raise|yieldparam|yieldreturn)\s+\[.*\]/)
+          comment.source.match?(/@(?:param|return|option|raise|yieldparam|yieldreturn)\s+.*\[.*\]/)
         end
 
         def tag_range_for_comment(comment)

smoke/tag_type.json

@@ -25,12 +25,44 @@
             "line": 2,
             "column": 13
           }
+        },
+        {
+          "severity": "convention",
+          "message": "(SyntaxError) expecting END, got name 'bbb'",
+          "cop_name": "YARD/TagType",
+          "corrected": false,
+          "correctable": false,
+          "location": {
+            "start_line": 3,
+            "start_column": 22,
+            "last_line": 3,
+            "last_column": 29,
+            "length": 8,
+            "line": 3,
+            "column": 22
+          }
+        },
+        {
+          "severity": "convention",
+          "message": "(SyntaxError) invalid character at -",
+          "cop_name": "YARD/TagType",
+          "corrected": false,
+          "correctable": false,
+          "location": {
+            "start_line": 4,
+            "start_column": 14,
+            "last_line": 4,
+            "last_column": 21,
+            "length": 8,
+            "line": 4,
+            "column": 14
+          }
         }
       ]
     }
   ],
   "summary": {
-    "offense_count": 1,
+    "offense_count": 3,
     "target_file_count": 1,
     "inspected_file_count": 1
   }

smoke/tag_type.rb

@@ -1,6 +1,7 @@
 class Foo
   # @param [aaa|bbb] foo
   # @option bar baz [aaa bbb]
+  # @return [aaa-bbb]
   def foo
   end
 end