Sign upLogin

Bnei-Baruch/mdb

View on GitHub
Star
api/autoname.go

Summary

Maintainability
F
3 days
Test Coverage

File autoname.go has 742 lines of code (exceeds 500 allowed). Consider refactoring.
Open

package api

import (
    _ "embed"
    "encoding/json"
Severity: Minor
Found in api/autoname.go - About 7 hrs to fix

    Method LessonPartDescriber.DescribeContentUnit has a Cognitive Complexity of 65 (exceeds 20 allowed). Consider refactoring.
    Open

    func (d LessonPartDescriber) DescribeContentUnit(exec boil.Executor,
    cu *models.ContentUnit,
    metadata CITMetadata) ([]*models.ContentUnitI18n, error) {

    var err error
    Severity: Minor
    Found in api/autoname.go - About 7 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

    Method LessonPartDescriber.DescribeContentUnit has 93 lines of code (exceeds 50 allowed). Consider refactoring.
    Open

    func (d LessonPartDescriber) DescribeContentUnit(exec boil.Executor,
    cu *models.ContentUnit,
    metadata CITMetadata) ([]*models.ContentUnitI18n, error) {

    var err error
    Severity: Major
    Found in api/autoname.go - About 2 hrs to fix

      Function nameByTagUID has a Cognitive Complexity of 27 (exceeds 20 allowed). Consider refactoring.
      Open

      func nameByTagUID(exec boil.Executor, uid string, cNumber *int) (map[string]string, error) {

    // check constant names first
    for i := range TAGS_WITH_CONST_NAMES {
        if uid == TAGS_WITH_CONST_NAMES[i] {
      Severity: Minor
      Found in api/autoname.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

      Method LessonPartDescriber.DescribeContentUnit has 10 return statements (exceeds 4 allowed).
      Open

      func (d LessonPartDescriber) DescribeContentUnit(exec boil.Executor,
    cu *models.ContentUnit,
    metadata CITMetadata) ([]*models.ContentUnitI18n, error) {

    var err error
      Severity: Major
      Found in api/autoname.go - About 1 hr to fix

        Avoid deeply nested control flow statements.
        Open

                        if err != nil {
                    return nil, errors.Wrap(err, "Name by source")
                }
        Severity: Major
        Found in api/autoname.go - About 45 mins to fix

          Avoid deeply nested control flow statements.
          Open

                          if err != nil {
                    return nil, errors.Wrap(err, "Get I18ns")
                }
          Severity: Major
          Found in api/autoname.go - About 45 mins to fix

            Avoid deeply nested control flow statements.
            Open

                            if cNumber != nil {
                    for k, v := range names {
                        names[k] = fmt.Sprintf("%s %d", v, *cNumber)
                    }
                }
            Severity: Major
            Found in api/autoname.go - About 45 mins to fix

              Function nameByTagUID has 6 return statements (exceeds 4 allowed).
              Open

              func nameByTagUID(exec boil.Executor, uid string, cNumber *int) (map[string]string, error) {

    // check constant names first
    for i := range TAGS_WITH_CONST_NAMES {
        if uid == TAGS_WITH_CONST_NAMES[i] {
              Severity: Major
              Found in api/autoname.go - About 40 mins to fix

                Function nameBySourceUID has 5 return statements (exceeds 4 allowed).
                Open

                func nameBySourceUID(exec boil.Executor, uid string) (map[string]string, error) {
    s, err := FindSourceByUID(exec, uid)
    if err != nil {
        return nil, errors.Wrapf(err, "Find source in DB")
    }
                Severity: Major
                Found in api/autoname.go - About 35 mins to fix

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

                  func makeCI18ns(id int64, names map[string]string) []*models.CollectionI18n {
    i18ns := make([]*models.CollectionI18n, 0)
    for k, v := range names {
        i18n := &models.CollectionI18n{
            CollectionID: id,
                  Severity: Minor
                  Found in api/autoname.go and 1 other location - About 45 mins to fix
                  api/autoname.go on lines 496..507

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

                  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

                  func makeCUI18ns(id int64, names map[string]string) []*models.ContentUnitI18n {
    i18ns := make([]*models.ContentUnitI18n, 0)
    for k, v := range names {
        i18n := &models.ContentUnitI18n{
            ContentUnitID: id,
                  Severity: Minor
                  Found in api/autoname.go and 1 other location - About 45 mins to fix
                  api/autoname.go on lines 483..494

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

                  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