Sign upLogin

mwielgoszewski/doorman

View on GitHub
Star
doorman/rules.py

Summary

Maintainability
B
4 hrs
Test Coverage

Function parse_query has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
Open

    def parse_query(self, query, alerters=None, rule_id=None):
        """
        Parse a query output from jQuery.QueryBuilder.
        """
        def parse_condition(d):
Severity: Minor
Found in doorman/rules.py - About 2 hrs to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Function make_condition has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

    def make_condition(self, klass, *args, **kwargs):
        """
        Memoizing constructor for conditions.  Uses the input config as the cache key.
        """
        # Calculate the memoization key.  We do this by creating a 3-tuple of
Severity: Minor
Found in doorman/rules.py - About 35 mins to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Avoid too many return statements within this function.
Open

                return obj
Severity: Major
Found in doorman/rules.py - About 30 mins to fix

    Function local_run has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

        def local_run(self, input):
        # If we have a 'column_name', we should use that to extract the value
        # from the input's columns.  Otherwise, we have a whitelist of what we
        # can get from the input.
        if self.column_name is not None:
    Severity: Minor
    Found in doorman/rules.py - About 25 mins to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Similar blocks of code found in 2 locations. Consider refactoring.
    Open

        def __init__(self, key, expected, **kwargs):
        # Pre-compile the 'expected' value - the regex.
        expected = re.compile(expected)
        super(MatchesRegexCondition, self).__init__(key, expected, **kwargs)
    Severity: Minor
    Found in doorman/rules.py and 1 other location - About 30 mins to fix
    doorman/rules.py on lines 342..345

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 36.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Similar blocks of code found in 2 locations. Consider refactoring.
    Open

        def __init__(self, key, expected, **kwargs):
        # Pre-compile the 'expected' value - the regex.
        expected = re.compile(expected)
        super(NotMatchesRegexCondition, self).__init__(key, expected, **kwargs)
    Severity: Minor
    Found in doorman/rules.py and 1 other location - About 30 mins to fix
    doorman/rules.py on lines 332..335

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 36.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Blank line contains whitespace
    Open
    Severity: Minor
    Found in doorman/rules.py by pep8

    Trailing whitespace is superfluous.

    The warning returned varies on whether the line itself is blank,
for easier filtering for those who want to indent their blank lines.

Okay: spam(1)\n#
W291: spam(1) \n#
W293: class Foo(object):\n    \n    bang = 12

    Blank line contains whitespace
    Open
    Severity: Minor
    Found in doorman/rules.py by pep8

    Trailing whitespace is superfluous.

    The warning returned varies on whether the line itself is blank,
for easier filtering for those who want to indent their blank lines.

Okay: spam(1)\n#
W291: spam(1) \n#
W293: class Foo(object):\n    \n    bang = 12

    Blank line contains whitespace
    Open
    Severity: Minor
    Found in doorman/rules.py by pep8

    Trailing whitespace is superfluous.

    The warning returned varies on whether the line itself is blank,
for easier filtering for those who want to indent their blank lines.

Okay: spam(1)\n#
W291: spam(1) \n#
W293: class Foo(object):\n    \n    bang = 12

    Blank line contains whitespace
    Open
    Severity: Minor
    Found in doorman/rules.py by pep8

    Trailing whitespace is superfluous.

    The warning returned varies on whether the line itself is blank,
for easier filtering for those who want to indent their blank lines.

Okay: spam(1)\n#
W291: spam(1) \n#
W293: class Foo(object):\n    \n    bang = 12

    There are no issues that match your filters.

    Category
    Status