APTrust/dart

View on GitHub
bagit/validator.js

Summary

Maintainability
C
1 day
Test Coverage

File validator.js has 441 lines of code (exceeds 250 allowed). Consider refactoring.
Invalid

const { BagItFile } = require('./bagit_file');
const { Constants } = require('../core/constants');
const { Context } = require('../core/context');
const crypto = require('crypto');
const EventEmitter = require('events');
Severity: Minor
Found in bagit/validator.js - About 6 hrs to fix

    Validator has 31 functions (exceeds 20 allowed). Consider refactoring.
    Invalid

    class Validator extends EventEmitter {
    
        /**
         * Constructs a new BagIt validator.
         *
    Severity: Minor
    Found in bagit/validator.js - About 3 hrs to fix

      Function _validateSerialization has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
      Open

          _validateSerialization() {
              var validFormat = true;
              if (!this.disableSerializationCheck) {
                  var checkSerializationFormat = true;
                  var bagIsDirectory = fs.statSync(this.pathToBag).isDirectory();
      Severity: Minor
      Found in bagit/validator.js - About 2 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 _validateAllowedTagFiles has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
      Open

          _validateAllowedTagFiles() {
              let allowed = this.profile.tagFilesAllowed || [];
              let tagFiles = this.tagFiles();
              for (let file of tagFiles) {
                  if (file.relDestPath == 'bagit.txt') {
      Severity: Minor
      Found in bagit/validator.js - 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

      Function _validateTagsInFile has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
      Open

          _validateTagsInFile(filename, tagFile) {
              var requiredTags = this.profile.tagsGroupedByFile();
              for (var tagDef of requiredTags[filename]) {
                  var parsedTagValues = tagFile.keyValueCollection.all(tagDef.tagName);
                  if (parsedTagValues == null) {
      Severity: Minor
      Found in bagit/validator.js - 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

      Function _validatePayloadOxum has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
      Open

          _validatePayloadOxum() {
              //Context.logger.info(`Validator: Validating Payload-Oxum in ${this.pathToBag}`);
              let found = false;
              let bagInfo = this.files["bag-info.txt"];
              if (bagInfo && bagInfo.keyValueCollection) {
      Severity: Minor
      Found in bagit/validator.js - 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

      Function _validateManifestEntries has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
      Open

          _validateManifestEntries(manifestType) {
              var manifests = this.payloadManifests();
              if (manifestType === Constants.TAG_MANIFEST) {
                  manifests = this.tagManifests();
              }
      Severity: Minor
      Found in bagit/validator.js - 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

      Function _validateSerialization has 27 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          _validateSerialization() {
              var validFormat = true;
              if (!this.disableSerializationCheck) {
                  var checkSerializationFormat = true;
                  var bagIsDirectory = fs.statSync(this.pathToBag).isDirectory();
      Severity: Minor
      Found in bagit/validator.js - About 1 hr to fix

        Function _validatePayloadOxum has 26 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            _validatePayloadOxum() {
                //Context.logger.info(`Validator: Validating Payload-Oxum in ${this.pathToBag}`);
                let found = false;
                let bagInfo = this.files["bag-info.txt"];
                if (bagInfo && bagInfo.keyValueCollection) {
        Severity: Minor
        Found in bagit/validator.js - About 1 hr to fix

          Function _readEntry has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
          Open

              _readEntry(entry) {
                  let validator = this;
                  if (entry.fileStat.isFile()) {
                      var bagItFile = this._addBagItFile(entry);
                      if (Context.slowMotionDelay > 0) {
          Severity: Minor
          Found in bagit/validator.js - About 55 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

          Function _validateNoExtraneousPayloadFiles has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
          Open

              _validateNoExtraneousPayloadFiles() {
                  //Context.logger.info(`Validator: Looking for extraneous payload files in ${this.pathToBag}`);
                  for(var manifest of this.payloadManifests()) {
                      for (var f of this.payloadFiles()) {
                          if (!manifest.keyValueCollection.first(f.relDestPath)) {
          Severity: Minor
          Found in bagit/validator.js - 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

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

                  if (!this._validateSerialization()) {
                      this.emit('error', this.errors.join(' '));
                      this.emit('end')
                      return;
                  }
          Severity: Minor
          Found in bagit/validator.js and 1 other location - About 50 mins to fix
          bagit/validator.js on lines 280..284

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

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

                  if (!this._validateProfile()) {
                      this.emit('error', this.errors.join(' '));
                      this.emit('end');
                      return;
                  }
          Severity: Minor
          Found in bagit/validator.js and 1 other location - About 50 mins to fix
          bagit/validator.js on lines 285..289

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

          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 4 locations. Consider refactoring.
          Invalid

              tagFiles() {
                  return Object.values(this.files).filter(f => f.isTagFile());
              }
          Severity: Major
          Found in bagit/validator.js and 3 other locations - About 35 mins to fix
          bagit/validator.js on lines 207..209
          bagit/validator.js on lines 216..218
          bagit/validator.js on lines 234..236

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

          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 4 locations. Consider refactoring.
          Invalid

              tagManifests() {
                  return Object.values(this.files).filter(f => f.isTagManifest());
              }
          Severity: Major
          Found in bagit/validator.js and 3 other locations - About 35 mins to fix
          bagit/validator.js on lines 207..209
          bagit/validator.js on lines 216..218
          bagit/validator.js on lines 225..227

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

          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 4 locations. Consider refactoring.
          Invalid

              payloadManifests() {
                  return Object.values(this.files).filter(f => f.isPayloadManifest());
              }
          Severity: Major
          Found in bagit/validator.js and 3 other locations - About 35 mins to fix
          bagit/validator.js on lines 207..209
          bagit/validator.js on lines 225..227
          bagit/validator.js on lines 234..236

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

          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 4 locations. Consider refactoring.
          Invalid

              payloadFiles() {
                  return Object.values(this.files).filter(f => f.isPayloadFile());
              }
          Severity: Major
          Found in bagit/validator.js and 3 other locations - About 35 mins to fix
          bagit/validator.js on lines 216..218
          bagit/validator.js on lines 225..227
          bagit/validator.js on lines 234..236

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

          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