Sign upLogin

macgregor/alexandria

View on GitHub
Star
alexandria-core/src/main/java/com/github/macgregor/alexandria/Context.java

Summary

Maintainability
B
5 hrs
Test Coverage

Method isIndexed has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

    public Optional<Config.DocumentMetadata> isIndexed(Path path){
        Path absolutePath = Resources.absolutePath(configPath().getParent(), path);
        if(config.metadata().isPresent()){
            for(Config.DocumentMetadata metadata : config.metadata().get()){
                if(metadata.sourcePath().equals(absolutePath)){
Severity: Minor
Found in alexandria-core/src/main/java/com/github/macgregor/alexandria/Context.java - 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

Rename "remote" which hides the field declared at line 66.
Open

        Remote remote = Reflection.create(config().remote().clazz());
Severity: Major
Found in alexandria-core/src/main/java/com/github/macgregor/alexandria/Context.java by sonar-java

Overriding or shadowing a variable declared in an outer scope can strongly impact the readability, and therefore the maintainability, of a piece of code. Further, it could lead maintainers to introduce bugs because they think they're using one variable but are really using another.

Noncompliant Code Example

class Foo {
  public int myField;

  public void doSomething() {
    int myField = 0;
    ...
  }
}

See

Provide the parametrized type for this generic.
Open

        List<String> tags = new ArrayList();
Severity: Major
Found in alexandria-core/src/main/java/com/github/macgregor/alexandria/Context.java by sonar-java

Generic types shouldn't be used raw (without type parameters) in variable declarations or return values. Doing so bypasses generic type checking, and defers the catch of unsafe code to runtime.

Noncompliant Code Example

List myList; // Noncompliant
Set mySet; // Noncompliant

Compliant Solution

List<String> myList;
Set<? extends Number> mySet;

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

    public Context makePathsRelative(){
        if( configPath != null){
            projectBase = Resources.relativeTo(configPath.getParent(), projectBase);
            outputPath = Optional.ofNullable(Resources.relativeTo(configPath.getParent(), outputPath.orElse(null)));
            searchPath = (List<Path>) Resources.relativeTo(configPath.getParent(), searchPath);
Severity: Major
Found in alexandria-core/src/main/java/com/github/macgregor/alexandria/Context.java and 1 other location - About 2 hrs to fix
alexandria-core/src/main/java/com/github/macgregor/alexandria/Context.java on lines 176..193

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

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

    public Context makePathsAbsolute(){
        if( configPath != null){
            projectBase = Resources.absolutePath(configPath.getParent(), projectBase);
            outputPath = Optional.ofNullable(Resources.absolutePath(configPath.getParent(), outputPath.orElse(null)));
            searchPath = (List<Path>) Resources.absolutePath(configPath.getParent(), searchPath);
Severity: Major
Found in alexandria-core/src/main/java/com/github/macgregor/alexandria/Context.java and 1 other location - About 2 hrs to fix
alexandria-core/src/main/java/com/github/macgregor/alexandria/Context.java on lines 200..217

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

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

There are no issues that match your filters.

Category
Status