Bug solving sprint

.coafile

@@ -35,5 +35,7 @@ max_lines_per_file = 1000
 enabled = False
 bears = KeywordBear
 
-ci_keywords, keywords_case_insensitive = \#TODO, \# TODO, \#FIXME, \# FIXME
+# Note that the ci_keywords and cs_keywords are only used here because coala
+# 0.8.x (current stable release) needs them.
+ci_keywords, keywords = \#TODO, \# TODO, \#FIXME, \# FIXME
 cs_keywords =

Gemfile

@@ -5,3 +5,4 @@ gem "rubocop"
 gem "sqlint"
 gem 'scss_lint', require: false# require flag is necessary https://github.com/brigade/scss-lint#installation
 gem "reek"
+gem "puppet-lint"

bears/configfiles/PuppetLintBear.py

@@ -0,0 +1,26 @@
+from coalib.bearlib.abstractions.Linter import linter
+from coalib.bears.requirements.GemRequirement import GemRequirement
+
+
+@linter(executable='puppet-lint',
+        output_format='regex',
+        output_regex=r'(?P<line>\d+):(?P<column>\d+):'
+                     r'(?P<severity>warning|error):(?P<message>.+)')
+class PuppetLintBear:
+    '''
+    Check and correct puppet configuration files using ``puppet-lint``.
+
+    See <http://puppet-lint.com/> for details about the tool.
+    '''
+
+    LANGUAGES = {"Puppet"}
+    REQUIREMENTS = {GemRequirement('puppet-lint', '2')}
+    AUTHORS = {'The coala developers'}
+    AUTHORS_EMAILS = {'[email protected]'}
+    LICENSE = 'AGPL-3.0'
+    CAN_FIX = {'Syntax'}
+
+    @staticmethod
+    def create_arguments(filename, file, config_file):
+        return ('--log-format', "%{line}:%{column}:%{kind}:%{message}",
+                filename)

bears/css/CSSLintBear.py

@@ -13,7 +13,7 @@ class CSSLintBear:
     problems or inefficiencies.
     """
     LANGUAGES = {"CSS"}
-    REQUIREMENTS = {NpmRequirement('csslint', '0')}
+    REQUIREMENTS = {NpmRequirement('csslint', '1')}
     AUTHORS = {'The coala developers'}
     AUTHORS_EMAILS = {'[email protected]'}
     LICENSE = 'AGPL-3.0'

bears/general/KeywordBear.py

@@ -1,3 +1,5 @@
+import re
+
 from coalib.bearlib import deprecate_settings
 from coalib.bears.LocalBear import LocalBear
 from coalib.results.Result import RESULT_SEVERITY, Result
@@ -10,53 +12,28 @@ class KeywordBear(LocalBear):
     LICENSE = 'AGPL-3.0'
     CAN_DETECT = {'Documentation'}
 
-    @deprecate_settings(keywords_case_sensitive='cs_keywords')
-    def run(self,
-            filename,
-            file,
-            keywords_case_insensitive: list,
-            keywords_case_sensitive: list=()):
+    @deprecate_settings(keywords='ci_keywords')
+    def run(self, filename, file, keywords: list):
         '''
         Checks the code files for given keywords.
 
-        :param keywords_case_insensitive:
+        :param keywords:
             A list of keywords to search for (case insensitive).
             Usual examples are TODO and FIXME.
-        :param keywords_case_sensitive:
-            A list of keywords to search for (case sensitive).
         '''
-        results = list()
-
-        for i in range(len(keywords_case_insensitive)):
-            keywords_case_insensitive[i] = keywords_case_insensitive[i].lower()
+        keywords_regex = re.compile(
+            '(' + '|'.join(re.escape(key) for key in keywords) + ')',
+            re.IGNORECASE)
 
         for line_number, line in enumerate(file):
-            for keyword in keywords_case_sensitive:
-                results += self.check_line_for_keyword(line,
-                                                       filename,
-                                                       line_number,
-                                                       keyword)
-
-            for keyword in keywords_case_insensitive:
-                results += self.check_line_for_keyword(line.lower(),
-                                                       filename,
-                                                       line_number,
-                                                       keyword)
-
-        return results
-
-    def check_line_for_keyword(self, line, filename, line_number, keyword):
-        pos = line.find(keyword)
-        if pos != -1:
-            return [Result.from_values(
-                origin=self,
-                message="The line contains the keyword `{}`."
-                        .format(keyword),
-                file=filename,
-                line=line_number+1,
-                column=pos+1,
-                end_line=line_number+1,
-                end_column=pos+len(keyword)+1,
-                severity=RESULT_SEVERITY.INFO)]
-
-        return []
+            for keyword in keywords_regex.finditer(line):
+                yield Result.from_values(
+                    origin=self,
+                    message="The line contains the keyword '{}'."
+                            .format(keyword.group()),
+                    file=filename,
+                    line=line_number + 1,
+                    column=keyword.start() + 1,
+                    end_line=line_number + 1,
+                    end_column=keyword.end() + 1,
+                    severity=RESULT_SEVERITY.INFO)

bears/js/ESLintBear.py

@@ -17,7 +17,7 @@ class ESLintBear:
     """
 
     LANGUAGES = {"JavaScript", "JSX"}
-    REQUIREMENTS = {NpmRequirement('eslint', '2')}
+    REQUIREMENTS = {NpmRequirement('eslint', '3')}
     AUTHORS = {'The coala developers'}
     AUTHORS_EMAILS = {'[email protected]'}
     LICENSE = 'AGPL-3.0'
@@ -48,7 +48,7 @@ def generate_config(filename, file):
         return '{"extends": "eslint:recommended"}'
 
     def process_output(self, output, filename, file):
-        if not file:
+        if not file or not output:
             return
 
         output = json.loads(output)

bears/js/JSHintBear.py

@@ -42,7 +42,11 @@ class JSHintBear:
     CAN_DETECT = {'Formatting', 'Syntax', 'Complexity', 'Unused Code'}
 
     @staticmethod
-    @deprecate_settings(cyclomatic_complexity='maxcomplexity',
+    @deprecate_settings(es_version='use_es6_syntax',
+                        javascript_strictness=(
+                            "allow_global_strict",
+                            lambda x: "global" if x else True),
+                        cyclomatic_complexity='maxcomplexity',
                         allow_unused_variables=('prohibit_unused', negate),
                         max_parameters='maxparams',
                         allow_missing_semicolon='allow_missing_semicol',
@@ -89,20 +93,19 @@ def generate_config(filename, file,
                         allow_debugger: bool=False,
                         allow_assignment_comparisions: bool=False,
                         allow_eval: bool=False,
-                        allow_global_strict: bool=False,
                         allow_increment: bool=False,
                         allow_proto: bool=False,
                         allow_scripturls: bool=False,
                         allow_singleton: bool=False,
                         allow_this_statements: bool=False,
                         allow_with_statements: bool=False,
                         use_mozilla_extension: bool=False,
+                        javascript_strictness: bool_or_str=True,
                         allow_noyield: bool=False,
                         allow_eqnull: bool=False,
                         allow_last_semicolon: bool=False,
                         allow_func_in_loop: bool=False,
                         allow_expr_in_assignments: bool=False,
-                        use_es6_syntax: bool=False,
                         use_es3_array: bool=False,
                         environment_mootools: bool=False,
                         environment_couch: bool=False,
@@ -132,7 +135,7 @@ def generate_config(filename, file,
                         allow_variable_shadowing: bool_or_str=False,
                         allow_unused_variables: bool_or_str=False,
                         allow_latedef: bool_or_str=False,
-                        es_version: int=5,
+                        es_version: bool_or_int=5,
                         jshint_config: str=""):
         """
         :param allow_bitwise_operators:
@@ -184,9 +187,6 @@ def generate_config(filename, file,
         :param allow_eval:
             This options suppresses warnings about the use of ``eval``
             function.
-        :param allow_global_strict:
-            This option suppresses warnings about the use of global strict
-            mode.
         :param allow_increment:
             This option suppresses warnings about the use of unary increment
             and decrement operators.
@@ -209,6 +209,14 @@ def generate_config(filename, file,
         :param use_mozilla_extension:
             This options tells JSHint that your code uses Mozilla JavaScript
             extensions.
+        :param javascript_strictness:
+            Determines what sort of strictness to use in the JavaScript code.
+            The possible options are:
+
+            - "global" - there must be a ``"use strict";`` at global level
+            - "implied" - lint the code as if there is a ``"use strict";``
+            - "False" - disable warnings about strict mode
+            - "True" - there must be a ``"use strict";`` at function level
         :param allow_noyield:
             This option suppresses warnings about generator functions with no
             ``yield`` statement in them.
@@ -225,8 +233,6 @@ def generate_config(filename, file,
         :param use_es3_array:
             This option tells JSHintBear ES3 array elision elements, or empty
             elements are used.
-        :param use_es3_array:
-            This option tells JSHint ECMAScript 6 specific syntax is used.
         :param environment_mootools:
             This option defines globals exposed by the Mootools.
         :param environment_couch:
@@ -308,6 +314,12 @@ def generate_config(filename, file,
             This option is used to specify the ECMAScript version to which the
             code must adhere to.
         """
+        # Assume that when es_version is bool, it is intended for the
+        # deprecated use_es6_version
+        if es_version is True:
+            es_version = 6
+        elif es_version is False:
+            es_version = 5
         if not jshint_config:
             options = {"bitwise": not allow_bitwise_operators,
                        "freeze": not allow_prototype_overwrite,
@@ -329,7 +341,7 @@ def generate_config(filename, file,
                        "debug": allow_debugger,
                        "boss": allow_assignment_comparisions,
                        "evil": allow_eval,
-                       "globalstrict": allow_global_strict,
+                       "strict": javascript_strictness,
                        "plusplus": allow_increment,
                        "proto": allow_proto,
                        "scripturl": allow_scripturls,
@@ -342,7 +354,6 @@ def generate_config(filename, file,
                        "lastsemic": allow_last_semicolon,
                        "loopfunc": allow_func_in_loop,
                        "expr": allow_expr_in_assignments,
-                       "esnext": use_es6_syntax,
                        "elision": use_es3_array,
                        "mootools": environment_mootools,
                        "couch": environment_couch,

bears/markdown/MarkdownBear.py

@@ -17,7 +17,7 @@ class MarkdownBear:
     """
 
     LANGUAGES = {"Markdown"}
-    REQUIREMENTS = {NpmRequirement('remark', '3')}
+    REQUIREMENTS = {NpmRequirement('remark-cli', '2')}
     AUTHORS = {'The coala developers'}
     AUTHORS_EMAILS = {'[email protected]'}
     LICENSE = 'AGPL-3.0'

bears/natural_language/AlexBear.py

@@ -1,3 +1,6 @@
+import subprocess
+import sys
+
 from coalib.bearlib.abstractions.Linter import linter
 from coalib.bears.requirements.NpmRequirement import NpmRequirement
 
@@ -13,11 +16,35 @@ class AlexBear:
     writing.
     """
     LANGUAGES = {"Natural Language"}
-    REQUIREMENTS = {NpmRequirement('alex', '2')}
+    REQUIREMENTS = {NpmRequirement('alex', '3')}
     AUTHORS = {'The coala developers'}
     AUTHORS_EMAILS = {'[email protected]'}
     LICENSE = 'AGPL-3.0'
 
+    @classmethod
+    def check_prerequisites(cls):
+        parent_prereqs = super().check_prerequisites()
+        if parent_prereqs is not True:  # pragma: no cover
+            return parent_prereqs
+
+        incorrect_pkg_msg = (
+            "Please ensure that the package that has been installed is the "
+            "one to 'Catch insensitive, inconsiderate writing'. This can be "
+            "verified by running `alex --help` and seeing what it does.")
+        try:
+            output = subprocess.check_output(("alex", "--help"),
+                                             stderr=subprocess.STDOUT)
+        except (OSError, subprocess.CalledProcessError):
+            return ("The `alex` package could not be verified. " +
+                    incorrect_pkg_msg)
+        else:
+            output = output.decode(sys.getfilesystemencoding())
+            if "Catch insensitive, inconsiderate writing" in output:
+                return True
+            else:
+                return ("The `alex` package that's been installed seems to "
+                        "be incorrect. " + incorrect_pkg_msg)
+
     @staticmethod
     def create_arguments(filename, file, config_file):
         return filename,

bears/natural_language/SpellCheckBear.py

@@ -0,0 +1,24 @@
+from coalib.bearlib.abstractions.Linter import linter
+from coalib.bears.requirements.PipRequirement import PipRequirement
+
+
+@linter(executable='scspell',
+        use_stderr=True,
+        output_format='regex',
+        output_regex=r'(?P<filename>.*):(?P<line>.\d*):\s*(?P<message>.*)')
+class SpellCheckBear:
+    """
+    Lints files to check for incorrect spellings using ``scspell``.
+
+    See <https://pypi.python.org/pypi/scspell> for more information.
+    """
+    LANGUAGES = {"Natural Language"}
+    REQUIREMENTS = {PipRequirement('scspell3k', '2.0')}
+    AUTHORS = {'The coala developers'}
+    AUTHORS_EMAILS = {'[email protected]'}
+    LICENSE = 'AGPL-3.0'
+    CAN_DETECT = {'Spelling'}
+
+    @staticmethod
+    def create_arguments(filename, file, config_file):
+        return '--report-only', filename

bears/python/YapfBear.py

@@ -44,7 +44,8 @@ def run(self, filename, file,
             split_before_logical_operator: bool=False,
             split_before_named_assigns: bool=True,
             use_spaces: bool=True,
-            based_on_style: str='pep8'):
+            based_on_style: str='pep8',
+            prefer_line_break_after_opening_bracket: bool=True):
         """
         :param max_line_length:
             Maximum number of characters for a line.
@@ -112,6 +113,9 @@ def run(self, filename, file,
             Uses spaces for indentation.
         :param based_on_style:
             The formatting style to be used as reference.
+        :param prefer_line_break_after_opening_bracket:
+            If True, splitting right after a open bracket will not be
+            preferred.
         """
         if not file:
             # Yapf cannot handle zero-byte files well, and adds a redundent
@@ -141,14 +145,28 @@ def run(self, filename, file,
 space_between_ending_comma_and_closing_bracket= \
 {space_between_ending_comma_and_closing_bracket}
 """
-        options += 'use_tabs = ' + str(not use_spaces)
+        options += 'use_tabs = ' + str(not use_spaces) + "\n"
+        options += ('split_penalty_after_opening_bracket = ' +
+                    ('30' if prefer_line_break_after_opening_bracket
+                     else '0') + "\n")
         options = options.format(**locals())
 
-        with prepare_file(options.splitlines(keepends=True),
-                          None) as (file_, fname):
-            corrected = FormatFile(filename,
-                                   style_config=fname,
-                                   verify=False)[0].splitlines(True)
+        try:
+            with prepare_file(options.splitlines(keepends=True),
+                              None) as (file_, fname):
+                corrected = FormatFile(filename,
+                                       style_config=fname,
+                                       verify=False)[0].splitlines(True)
+        except SyntaxError as err:
+            if isinstance(err, IndentationError):
+                error_type = "indentation errors (" + err.args[0] + ')'
+            else:
+                error_type = "syntax errors"
+            yield Result.from_values(
+                self,
+                "The code cannot be parsed due to {0}.".format(error_type),
+                filename, line=err.lineno, column=err.offset)
+            return
         diffs = Diff.from_string_arrays(file, corrected).split_diff()
         for diff in diffs:
             yield Result(self,