Sign upLogin

pstuifzand/ekster

View on GitHub
Star
pkg/jf2/simplify.go

Summary

Maintainability
D
1 day
Test Coverage

Function simplifyToItem has a Cognitive Complexity of 57 (exceeds 20 allowed). Consider refactoring.
Open

func simplifyToItem(itemType string, item map[string][]interface{}, author microsub.Card) microsub.Item {
    var feedItem microsub.Item

    if itemType == "cite" {
        itemType = "entry"
Severity: Minor
Found in pkg/jf2/simplify.go - About 6 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 simplifyToItem has 69 lines of code (exceeds 50 allowed). Consider refactoring.
Open

func simplifyToItem(itemType string, item map[string][]interface{}, author microsub.Card) microsub.Item {
    var feedItem microsub.Item

    if itemType == "cite" {
        itemType = "entry"
Severity: Minor
Found in pkg/jf2/simplify.go - About 1 hr to fix

Function CleanHTML has a Cognitive Complexity of 29 (exceeds 20 allowed). Consider refactoring.
Open

func CleanHTML(s string) (string, error) {
    doc, err := html.Parse(strings.NewReader(s))

    if err != nil {
        return "", err
Severity: Minor
Found in pkg/jf2/simplify.go - 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

Avoid deeply nested control flow statements.
Open

    } else if key == "photo" {
        return &item.Photo
    } else if key == "category" {
        return &item.Category
    }
Severity: Major
Found in pkg/jf2/simplify.go - About 45 mins to fix

Function itemPtr has 7 return statements (exceeds 4 allowed).
Open

func itemPtr(item *microsub.Item, key string) *[]string {
    if key == "bookmark-of" {
        return &item.BookmarkOf
    } else if key == "repost-of" {
        return &item.RepostOf
Severity: Major
Found in pkg/jf2/simplify.go - About 45 mins to fix

TODO found
Open

                        // TODO: perhaps use name
Severity: Minor
Found in pkg/jf2/simplify.go by fixme

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

        if arr, ok := vk.([]interface{}); ok {
            if p, ok := arr[0].(string); ok {
                switch ik {
                case "name":
                    card.Name = p
Severity: Major
Found in pkg/jf2/simplify.go and 1 other location - About 1 hr to fix
pkg/jf2/simplify.go on lines 328..351

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

    for ik, vk := range microformat.Properties {
        if p, ok := vk[0].(string); ok {
            switch ik {
            case "name":
                card.Name = p
Severity: Major
Found in pkg/jf2/simplify.go and 1 other location - About 1 hr to fix
pkg/jf2/simplify.go on lines 279..302

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