Merge pull request #22 from ksss/fix-mismatchname

Fix mismatch name if includes new line

Author: ksss

lib/rubocop/cop/yard/helper.rb

@@ -75,6 +75,17 @@ def styled_string(types_explainer)
         def inline_comment?(comment)
           !comment_line?(comment.source_range.source_line)
         end
+
+        def build_docstring(preceding_lines)
+          comment_texts = preceding_lines.map { |l| l.text.gsub(/\A#/, '') }
+          minimum_space = comment_texts.map { |t| t.index(/[^\s]/) }.min
+          yard_docstring = comment_texts.map { |t| t[minimum_space..-1] }.join("\n")
+          begin
+            ::YARD::DocstringParser.new.parse(yard_docstring)
+          rescue
+            nil
+          end
+        end
       end
     end
   end

lib/rubocop/cop/yard/meaningless_tag.rb

@@ -20,6 +20,7 @@ module YARD
       #   # good
       #   CONST = 1
       class MeaninglessTag < Base
+        include YARD::Helper
         include RangeHelp
         include DocumentationComment
         extend AutoCorrector
@@ -34,8 +35,9 @@ def check(node)
           preceding_lines = preceding_lines(node)
           return false unless preceding_comment?(node, preceding_lines.last)
 
-          yard_docstring = preceding_lines.map { |line| line.text.gsub(/\A#\s*/, '') }.join("\n")
-          docstring = ::YARD::DocstringParser.new.parse(yard_docstring)
+          docstring = build_docstring(preceding_lines)
+          return false unless docstring
+
           docstring.tags.each do |tag|
             next unless tag.tag_name == 'param' || tag.tag_name == 'option'
 

lib/rubocop/cop/yard/mismatch_name.rb

@@ -28,12 +28,8 @@ def on_def(node)
           preceding_lines = preceding_lines(node)
           return false unless preceding_comment?(node, preceding_lines.last)
 
-          yard_docstring = preceding_lines.map { |line| line.text.gsub(/\A#\s*/, '') }.join("\n")
-          docstring = begin
-            ::YARD::DocstringParser.new.parse(yard_docstring)
-          rescue
-            return false
-          end
+          docstring = build_docstring(preceding_lines)
+          return false unless docstring
 
           return false if include_overload_tag?(docstring)
 

smoke/generated/mismatch_name.json

@@ -129,12 +129,12 @@
           "corrected": false,
           "correctable": false,
           "location": {
-            "start_line": 47,
+            "start_line": 52,
             "start_column": 18,
-            "last_line": 47,
+            "last_line": 52,
             "last_column": 25,
             "length": 8,
-            "line": 47,
+            "line": 52,
             "column": 18
           }
         }

smoke/generated/mismatch_name_correct.rb

@@ -44,6 +44,11 @@ def delegate(arg, ...)
 
   def empty_doc(arg)
   end
+
+  # @param [String]
+  #   arg doc
+  def returned(arg)
+  end
 end
 
 # https://github.com/ksss/rubocop-yard/issues/18

smoke/mismatch_name.rb

@@ -40,6 +40,11 @@ def delegate(arg, ...)
 
   def empty_doc(arg)
   end
+
+  # @param [String]
+  #   arg doc
+  def returned(arg)
+  end
 end
 
 # https://github.com/ksss/rubocop-yard/issues/18