macgregor/alexandria

View on GitHub

Showing 263 of 263 total issues

Method setAttributes has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
Open

        @Override
        public void setAttributes(Node node, AttributablePart part, Attributes attributes) {
            /*
            Jive syntax language options:
            None,

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 execute has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
Open

    public void execute(Batch<T> batch, Task<T> task, AfterBatch<T> after) throws BatchProcessException {
        try {
            for (T t : batch.collect(context)) {
                try {
                    task.execute(context, t);

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 findParentPlace has a Cognitive Complexity of 20 (exceeds 5 allowed). Consider refactoring.
Open

    public void findParentPlace(Config.DocumentMetadata metadata) throws IOException {
        log.debug(String.format("Jive parent place detected, attempting to retrieve from remote."));

        String parentPlaceUrl = context.getExtraPropertiesForDocument(metadata).get(JIVE_PARENT_URI);
        String parentPlaceName = JiveUtils.jiveParentPlaceName(parentPlaceUrl);

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

File JiveRemote.java has 268 lines of code (exceeds 250 allowed). Consider refactoring.
Open

package com.github.macgregor.alexandria.remotes;

import com.github.macgregor.alexandria.Config;
import com.github.macgregor.alexandria.Context;
import com.github.macgregor.alexandria.exceptions.AlexandriaException;

    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);
    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);
    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

    File RemoteDocument.java has 257 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    package com.github.macgregor.alexandria.remotes;
    
    import com.fasterxml.jackson.core.JsonFactory;
    import com.fasterxml.jackson.databind.JavaType;
    import com.fasterxml.jackson.databind.JsonNode;

      Method sync has 49 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          protected void sync() throws AlexandriaException {
              BatchProcess<Config.DocumentMetadata> batchProcess = new BatchProcess<>(context);
              batchProcess.execute(context -> context.config().metadata().get(), (context, metadata) -> {
                  log.debug(String.format("Syncing %s with remote.", metadata.sourceFileName()));
                  remote.validateDocumentMetadata(metadata);

        Method execute has 45 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            public void execute(Batch<T> batch, Task<T> task, AfterBatch<T> after) throws BatchProcessException {
                try {
                    for (T t : batch.collect(context)) {
                        try {
                            task.execute(context, t);

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

                          case CREATE:
                              if(Resources.fileContentsAreBlank(metadata.sourcePath().toString())){
                                  log.info(String.format("%s has no contents, not creating on remote", metadata.sourceFileName()));
                              } else{
                                  remote.create(metadata);
          alexandria-core/src/main/java/com/github/macgregor/alexandria/AlexandriaSync.java on lines 132..141

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

          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

                          case UPDATE:
                              if(Resources.fileContentsAreBlank(metadata.sourcePath().toString())){
                                  log.info(String.format("%s has no contents, not updating on remote", metadata.sourceFileName()));
                              } else {
                                  remote.update(metadata);
          alexandria-core/src/main/java/com/github/macgregor/alexandria/AlexandriaSync.java on lines 122..131

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

          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

          Method setAttributes has 36 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

                  @Override
                  public void setAttributes(Node node, AttributablePart part, Attributes attributes) {
                      /*
                      Jive syntax language options:
                      None,

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

                public T post(T t) throws HttpException {
                    Request request = null;
                    try {
                        request = Requests.requestBuilder(route(), headers)
                                .post(requestBody(t))
            alexandria-core/src/main/java/com/github/macgregor/alexandria/remotes/RemoteDocument.java on lines 149..167

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

            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 T put(T t) throws HttpException {
                    Request request = null;
                    try {
                        request = Requests.requestBuilder(route(), headers)
                                .put(requestBody(t))
            alexandria-core/src/main/java/com/github/macgregor/alexandria/remotes/RemoteDocument.java on lines 183..202

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

            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

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

                protected static Config.DocumentMetadata updateMetadata(Config.DocumentMetadata metadata, JiveData.JiveContent content) {
                    metadata.createdOn(Optional.ofNullable(content.published));
                    metadata.lastUpdated(Optional.ofNullable(content.updated));
            
                    if(content.resources != null && content.resources.containsKey("html")){

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

                public void findParentPlace(Config.DocumentMetadata metadata) throws IOException {
                    log.debug(String.format("Jive parent place detected, attempting to retrieve from remote."));
            
                    String parentPlaceUrl = context.getExtraPropertiesForDocument(metadata).get(JIVE_PARENT_URI);
                    String parentPlaceName = JiveUtils.jiveParentPlaceName(parentPlaceUrl);

              Method doRequest has 32 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                  protected Response doRequest(Request request) throws HttpException {
                      log.debug(request.toString());
                      if(request.body() != null) {
                          try {
                              log.debug(Requests.bodyToString(request));

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

                        protected Iterator<T> nextPage() {
                            RemoteDocument remoteDocument = requestBuilder
                                    .queryParameter(requestBuilder.pageSizeRequestParameter, pageSize.toString())
                                    .queryParameter(requestBuilder.pageOffsetRequestParameter, offset.toString())
                                    .build();

                  Method doRequest has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
                  Open

                      protected Response doRequest(Request request) throws HttpException {
                          log.debug(request.toString());
                          if(request.body() != null) {
                              try {
                                  log.debug(Requests.bodyToString(request));

                  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 render has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
                  Open

                          private void render(FencedCodeBlock node, NodeRendererContext context, HtmlWriter html) {
                              html.line();
                              html.srcPosWithTrailingEOL(node.getChars()).withAttr().tag("pre").openPre();
                  
                              BasedSequence info = node.getInfo();

                  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

                  Severity
                  Category
                  Status
                  Source
                  Language