koraktor/mavanagaiata

View on GitHub
src/main/java/com/github/koraktor/mavanagaiata/git/MailMap.java

Summary

Maintainability
B
4 hrs
Test Coverage
A
94%

Method parseMailMap has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
Open

    void parseMailMap(File mailMap) throws IOException {
        try (BufferedReader mailMapReader = new BufferedReader(new FileReader(mailMap))) {
            String line;
            while ((line = mailMapReader.readLine()) != null) {
                line = line.trim();
Severity: Minor
Found in src/main/java/com/github/koraktor/mavanagaiata/git/MailMap.java - About 1 hr 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

Method parseMailMap has 31 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    void parseMailMap(File mailMap) throws IOException {
        try (BufferedReader mailMapReader = new BufferedReader(new FileReader(mailMap))) {
            String line;
            while ((line = mailMapReader.readLine()) != null) {
                line = line.trim();
Severity: Minor
Found in src/main/java/com/github/koraktor/mavanagaiata/git/MailMap.java - About 1 hr to fix

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

        String getCanonicalName(String name, String mail) {
            if (mailToNameMap.containsKey(mail)) {
                return mailToNameMap.get(mail);
            }
    
    
    src/main/java/com/github/koraktor/mavanagaiata/git/MailMap.java on lines 88..103

    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 79.

    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

        String getCanonicalMail(String name, String mail) {
            if (mailToMailMap.containsKey(mail)) {
                return mailToMailMap.get(mail);
            }
    
    
    src/main/java/com/github/koraktor/mavanagaiata/git/MailMap.java on lines 112..127

    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 79.

    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

    Avoid instantiating new objects inside loops
    Open

                        Map.Entry<String, String> properNameAndMail = new AbstractMap.SimpleEntry<>(lineMatcher.group(1), lineMatcher.group(2));

    AvoidInstantiatingObjectsInLoops

    Since: PMD 2.2

    Priority: Medium

    Categories: Style

    Remediation Points: 50000

    New objects created within loops should be checked to see if they can created outside them and reused.

    Example:

    public class Something {
     public static void main( String as[] ) {
     for (int i = 0; i < 10; i++) {
     Foo f = new Foo(); // Avoid this whenever you can it's really expensive
     }
     }
    }

    Avoid instantiating new objects inside loops
    Open

                        Map.Entry<String, String> commitNameAndMail = new AbstractMap.SimpleEntry<>(lineMatcher.group(3), lineMatcher.group(4));

    AvoidInstantiatingObjectsInLoops

    Since: PMD 2.2

    Priority: Medium

    Categories: Style

    Remediation Points: 50000

    New objects created within loops should be checked to see if they can created outside them and reused.

    Example:

    public class Something {
     public static void main( String as[] ) {
     for (int i = 0; i < 10; i++) {
     Foo f = new Foo(); // Avoid this whenever you can it's really expensive
     }
     }
    }

    Avoid excessively long variable names like mailToNameAndMailMap
    Open

        Map<String, Map.Entry<String, String>> mailToNameAndMailMap;

    LongVariable

    Since: PMD 0.3

    Priority: Medium

    Categories: Style

    Remediation Points: 50000

    Fields, formal arguments, or local variable names that are too long can make the code difficult to follow.

    Example:

    public class Something {
     int reallyLongIntName = -3; // VIOLATION - Field
     public static void main( String argumentsList[] ) { // VIOLATION - Formal
     int otherReallyLongName = -5; // VIOLATION - Local
     for (int interestingIntIndex = 0; // VIOLATION - For
     interestingIntIndex < 10;
     interestingIntIndex ++ ) {
     }
    }

    Avoid excessively long variable names like MAIL_TO_NAME_AND_MAIL_PATTERN
    Open

        private static final Pattern MAIL_TO_NAME_AND_MAIL_PATTERN;

    LongVariable

    Since: PMD 0.3

    Priority: Medium

    Categories: Style

    Remediation Points: 50000

    Fields, formal arguments, or local variable names that are too long can make the code difficult to follow.

    Example:

    public class Something {
     int reallyLongIntName = -3; // VIOLATION - Field
     public static void main( String argumentsList[] ) { // VIOLATION - Formal
     int otherReallyLongName = -5; // VIOLATION - Local
     for (int interestingIntIndex = 0; // VIOLATION - For
     interestingIntIndex < 10;
     interestingIntIndex ++ ) {
     }
    }

    Avoid excessively long variable names like NAME_AND_MAIL_TO_NAME_AND_MAIL_PATTERN
    Open

        private static final Pattern NAME_AND_MAIL_TO_NAME_AND_MAIL_PATTERN;

    LongVariable

    Since: PMD 0.3

    Priority: Medium

    Categories: Style

    Remediation Points: 50000

    Fields, formal arguments, or local variable names that are too long can make the code difficult to follow.

    Example:

    public class Something {
     int reallyLongIntName = -3; // VIOLATION - Field
     public static void main( String argumentsList[] ) { // VIOLATION - Formal
     int otherReallyLongName = -5; // VIOLATION - Local
     for (int interestingIntIndex = 0; // VIOLATION - For
     interestingIntIndex < 10;
     interestingIntIndex ++ ) {
     }
    }

    Avoid excessively long variable names like nameAndMailToNameAndMailMap
    Open

        Map<Map.Entry<String, String>, Map.Entry<String, String>> nameAndMailToNameAndMailMap;

    LongVariable

    Since: PMD 0.3

    Priority: Medium

    Categories: Style

    Remediation Points: 50000

    Fields, formal arguments, or local variable names that are too long can make the code difficult to follow.

    Example:

    public class Something {
     int reallyLongIntName = -3; // VIOLATION - Field
     public static void main( String argumentsList[] ) { // VIOLATION - Formal
     int otherReallyLongName = -5; // VIOLATION - Local
     for (int interestingIntIndex = 0; // VIOLATION - For
     interestingIntIndex < 10;
     interestingIntIndex ++ ) {
     }
    }

    Avoid excessively long variable names like MAIL_TO_MAIL_PATTERN
    Open

        private static final Pattern MAIL_TO_MAIL_PATTERN;

    LongVariable

    Since: PMD 0.3

    Priority: Medium

    Categories: Style

    Remediation Points: 50000

    Fields, formal arguments, or local variable names that are too long can make the code difficult to follow.

    Example:

    public class Something {
     int reallyLongIntName = -3; // VIOLATION - Field
     public static void main( String argumentsList[] ) { // VIOLATION - Formal
     int otherReallyLongName = -5; // VIOLATION - Local
     for (int interestingIntIndex = 0; // VIOLATION - For
     interestingIntIndex < 10;
     interestingIntIndex ++ ) {
     }
    }

    Avoid instantiating new objects inside loops
    Open

                        Map.Entry<String, String> properNameAndMail = new AbstractMap.SimpleEntry<>(lineMatcher.group(1), lineMatcher.group(2));

    AvoidInstantiatingObjectsInLoops

    Since: PMD 2.2

    Priority: Medium

    Categories: Style

    Remediation Points: 50000

    New objects created within loops should be checked to see if they can created outside them and reused.

    Example:

    public class Something {
     public static void main( String as[] ) {
     for (int i = 0; i < 10; i++) {
     Foo f = new Foo(); // Avoid this whenever you can it's really expensive
     }
     }
    }

    Avoid excessively long variable names like MAIL_TO_NAME_PATTERN
    Open

        private static final Pattern MAIL_TO_NAME_PATTERN;

    LongVariable

    Since: PMD 0.3

    Priority: Medium

    Categories: Style

    Remediation Points: 50000

    Fields, formal arguments, or local variable names that are too long can make the code difficult to follow.

    Example:

    public class Something {
     int reallyLongIntName = -3; // VIOLATION - Field
     public static void main( String argumentsList[] ) { // VIOLATION - Formal
     int otherReallyLongName = -5; // VIOLATION - Local
     for (int interestingIntIndex = 0; // VIOLATION - For
     interestingIntIndex < 10;
     interestingIntIndex ++ ) {
     }
    }

    There are no issues that match your filters.

    Category
    Status