funkygao/cp-ddd-framework

View on GitHub
dddplus-visualization/src/main/java/io/github/dddplus/ast/view/PlantUmlRenderer.java

Summary

Maintainability
F
3 days
Test Coverage

File PlantUmlRenderer.java has 473 lines of code (exceeds 250 allowed). Consider refactoring.
Open

/*
 * Copyright DDDplus Authors.
 *
 * Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
 */

    Method writeClazzDefinition has a Cognitive Complexity of 35 (exceeds 5 allowed). Consider refactoring.
    Open

        private PlantUmlRenderer writeClazzDefinition(KeyModelEntry keyModelEntry, boolean isAggregateRoot) {
            append("class ").append(keyModelEntry.getClassName());
            if (isAggregateRoot) {
                if (keyModelEntry.hasJavadoc()) {
                    append(String.format(" <<(R,#FF7700) %s>> ", keyModelEntry.getJavadoc()));

    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

    PlantUmlRenderer has 35 methods (exceeds 20 allowed). Consider refactoring.
    Open

    public class PlantUmlRenderer implements IModelRenderer<PlantUmlRenderer> {
        /**
         * Direction to render the plantuml.
         */
        public enum Direction {

      Method writeClazzDefinition has 79 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private PlantUmlRenderer writeClazzDefinition(KeyModelEntry keyModelEntry, boolean isAggregateRoot) {
              append("class ").append(keyModelEntry.getClassName());
              if (isAggregateRoot) {
                  if (keyModelEntry.hasJavadoc()) {
                      append(String.format(" <<(R,#FF7700) %s>> ", keyModelEntry.getJavadoc()));

        Method append has a Cognitive Complexity of 20 (exceeds 5 allowed). Consider refactoring.
        Open

            private void append(KeyFlowEntry entry, KeyModelEntry keyModelEntry) {
                if (entry.isAsync()) {
                    append(" {abstract} ");
                }
                if (entry.isPolymorphism()) {

        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 append has 33 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            private void append(KeyFlowEntry entry, KeyModelEntry keyModelEntry) {
                if (entry.isAsync()) {
                    append(" {abstract} ");
                }
                if (entry.isPolymorphism()) {

          Method writeKeyUsecaseClazzDefinition has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
          Open

              private PlantUmlRenderer writeKeyUsecaseClazzDefinition(String actor) {
                  append("class ").append(actor);
                  String actorJavadoc = model.getKeyUsecaseReport().actorJavadoc(actor);
                  if (actorJavadoc != null && !actorJavadoc.isEmpty()) {
                      append(String.format(" <<(C,#9197DB) %s>> ", actorJavadoc));

          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

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

                          if (entry.produceEvent()) {
                              append(MessageFormat.format(COLOR_TMPL_OPEN, COLOR_BEHAVIOR_PRODUCE_EVENT));
                              append(" -> ").append(entry.displayEvents()).append(SPACE);
                              append(COLOR_TMPL_CLOSE);
                          }
          dddplus-visualization/src/main/java/io/github/dddplus/ast/view/PlantUmlRenderer.java on lines 368..372

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

          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

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

                  if (entry.produceEvent()) {
                      append(MessageFormat.format(COLOR_TMPL_OPEN, COLOR_BEHAVIOR_PRODUCE_EVENT));
                      append(" -> ").append(entry.displayEvents()).append(SPACE);
                      append(COLOR_TMPL_CLOSE);
                  }
          dddplus-visualization/src/main/java/io/github/dddplus/ast/view/PlantUmlRenderer.java on lines 311..315

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

          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