IndentationBear: Ignore doc comments

This adds a new implementation to ignore all
the doc comments from IndentationBear since
doc comments are not supossed to follow indentation.

Closes coala#644

bears/general/IndentationBear.py

@@ -2,6 +2,8 @@
 from coalib.bears.LocalBear import LocalBear
 from coalib.bearlib import deprecate_settings
 from coalib.bearlib.languages.LanguageDefinition import LanguageDefinition
+from coalib.bearlib.languages.documentation.DocBaseClass import (
+    DocBaseClass)
 from coalib.bearlib.spacing.SpacingHelper import SpacingHelper
 from coalib.results.SourceRange import SourceRange
 from coalib.results.Result import Result, RESULT_SEVERITY
@@ -11,7 +13,7 @@
 from bears.general.AnnotationBear import AnnotationBear
 
 
-class IndentationBear(LocalBear):
+class IndentationBear(DocBaseClass, LocalBear):
 
     AUTHORS = {'The coala developers'}
     AUTHORS_EMAILS = {'[email protected]'}
@@ -25,6 +27,7 @@ def run(self,
             file,
             dependency_results: dict,
             language: str,
+            docstyle: str = None,
             use_spaces: bool = True,
             indent_size: int = SpacingHelper.DEFAULT_TAB_WIDTH,
             coalang_dir: str = None,
@@ -58,6 +61,10 @@ def run(self,
             Results given by the AnnotationBear.
         :param language:
             Language to be used for indentation.
+        :param docstyle:
+            The docstyle to use. For example ``default`` or
+            ``doxygen``. Docstyles are language dependent, meaning
+            not every language is supported by a certain docstyle.
         :param use_spaces:
             Insert spaces instead of tabs for indentation.
         :param indent_size:
@@ -66,6 +73,10 @@ def run(self,
             Full path of external directory containing the coalang
             file for language.
         """
+        doc_comments = []
+        if docstyle:
+            doc_comments = self.extract(file, language, docstyle)
+
         lang_settings_dict = LanguageDefinition(
             language, coalang_dir=coalang_dir)
         annotation_dict = dependency_results[AnnotationBear.name][0].contents
@@ -118,6 +129,10 @@ def run(self,
         if new_file != list(file):
             wholediff = Diff.from_string_arrays(file, new_file)
             for diff in wholediff.split_diff():
+                if any(gt_eq(diff.range(filename).start, string.range.start)
+                       and lt_eq(diff.range(filename).end, string.range.end)
+                       for string in doc_comments):
+                    continue
                 yield Result(
                     self,
                     'The indentation could be changed to improve readability.',

tests/general/IndentationBearTest.py

@@ -291,3 +291,13 @@ def test_invalid_specifiers(self):
         valid_file = ('This is a valid specifier: # A comment\n',
                       '\tand so it indents\n')
         self.verify_bear(valid_file)
+
+    def test_ignore_doc_comments(self):
+        test_file = ('"""\n',
+                     ' This is not properly indented\n',
+                     '    but still should be valid.\n',
+                     '"""')
+        self.verify_bear(invalid_file=test_file)
+        self.section.append(Setting('language', 'python'))
+        self.section.append(Setting('docstyle', 'doxygen'))
+        self.verify_bear(valid_file=test_file)