dpn-admin/dpn-bagit

View on GitHub

Showing 27 of 27 total issues

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

    def valid?()
      if @cachedValidity == nil
        if @bag.valid? == false
          @validationErrors.push(@bag.errors.full_messages)
        end
Severity: Minor
Found in lib/dpn/bagit/bag.rb - About 5 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 has too many lines. [51/30]
Open

    def valid?()
      if @cachedValidity == nil
        if @bag.valid? == false
          @validationErrors.push(@bag.errors.full_messages)
        end
Severity: Minor
Found in lib/dpn/bagit/bag.rb by rubocop

This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.

Method from_existing has a Cognitive Complexity of 26 (exceeds 5 allowed). Consider refactoring.
Open

    def from_existing(file_location)
      @dpnInfoKeysArrays.each do |key|
        @dpnInfo[key.to_sym] = []
      end

Severity: Minor
Found in lib/dpn/bagit/bag/dpn_info_txt.rb - About 3 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 has too many lines. [46/30]
Open

    def from_existing(file_location)
      @dpnInfoKeysArrays.each do |key|
        @dpnInfo[key.to_sym] = []
      end

Severity: Minor
Found in lib/dpn/bagit/bag/dpn_info_txt.rb by rubocop

This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.

Cyclomatic complexity for valid? is too high. [16/6]
Open

    def valid?()
      if @cachedValidity == nil
        if @bag.valid? == false
          @validationErrors.push(@bag.errors.full_messages)
        end
Severity: Minor
Found in lib/dpn/bagit/bag.rb by rubocop

This cop checks that the cyclomatic complexity of methods is not higher than the configured maximum. The cyclomatic complexity is the number of linearly independent paths through a method. The algorithm counts decision points and adds one.

An if statement (or unless or ?:) increases the complexity by one. An else branch does not, since it doesn't add a decision point. The && operator (or keyword and) can be converted to a nested if statement, and ||/or is shorthand for a sequence of ifs, so they also add one. Loops can be said to have an exit condition, so they add one.

Method valid? has 51 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    def valid?()
      if @cachedValidity == nil
        if @bag.valid? == false
          @validationErrors.push(@bag.errors.full_messages)
        end
Severity: Major
Found in lib/dpn/bagit/bag.rb - About 2 hrs to fix

Cyclomatic complexity for from_existing is too high. [8/6]
Open

    def from_existing(file_location)
      @dpnInfoKeysArrays.each do |key|
        @dpnInfo[key.to_sym] = []
      end

Severity: Minor
Found in lib/dpn/bagit/bag/dpn_info_txt.rb by rubocop

This cop checks that the cyclomatic complexity of methods is not higher than the configured maximum. The cyclomatic complexity is the number of linearly independent paths through a method. The algorithm counts decision points and adds one.

An if statement (or unless or ?:) increases the complexity by one. An else branch does not, since it doesn't add a decision point. The && operator (or keyword and) can be converted to a nested if statement, and ||/or is shorthand for a sequence of ifs, so they also add one. Loops can be said to have an exit condition, so they add one.

Cyclomatic complexity for consistent? is too high. [8/6]
Open

        def consistent?
            (manifest_files|tagmanifest_files).each do |mf|
                # get the algorithm implementation
                readAlgo = /manifest-(.+).txt$/.match(File.basename(mf))[1]
                algo = case readAlgo
Severity: Minor
Found in lib/dpn/bagit/ext/bagit/valid.rb by rubocop

This cop checks that the cyclomatic complexity of methods is not higher than the configured maximum. The cyclomatic complexity is the number of linearly independent paths through a method. The algorithm counts decision points and adds one.

An if statement (or unless or ?:) increases the complexity by one. An else branch does not, since it doesn't add a decision point. The && operator (or keyword and) can be converted to a nested if statement, and ||/or is shorthand for a sequence of ifs, so they also add one. Loops can be said to have an exit condition, so they add one.

Method from_existing has 46 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    def from_existing(file_location)
      @dpnInfoKeysArrays.each do |key|
        @dpnInfo[key.to_sym] = []
      end

Severity: Minor
Found in lib/dpn/bagit/bag/dpn_info_txt.rb - About 1 hr to fix

Method has too many lines. [31/30]
Open

        def consistent?
            (manifest_files|tagmanifest_files).each do |mf|
                # get the algorithm implementation
                readAlgo = /manifest-(.+).txt$/.match(File.basename(mf))[1]
                algo = case readAlgo
Severity: Minor
Found in lib/dpn/bagit/ext/bagit/valid.rb by rubocop

This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.

Method consistent? has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
Open

        def consistent?
            (manifest_files|tagmanifest_files).each do |mf|
                # get the algorithm implementation
                readAlgo = /manifest-(.+).txt$/.match(File.basename(mf))[1]
                algo = case readAlgo
Severity: Minor
Found in lib/dpn/bagit/ext/bagit/valid.rb - 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 consistent? has 31 lines of code (exceeds 25 allowed). Consider refactoring.
Open

        def consistent?
            (manifest_files|tagmanifest_files).each do |mf|
                # get the algorithm implementation
                readAlgo = /manifest-(.+).txt$/.match(File.basename(mf))[1]
                algo = case readAlgo
Severity: Minor
Found in lib/dpn/bagit/ext/bagit/valid.rb - About 1 hr to fix

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

    def fixity(algorithm)
      if @cachedFixity == nil
        case algorithm
          when :sha256
            digest = Digest::SHA256
Severity: Minor
Found in lib/dpn/bagit/bag.rb - About 35 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.
Open

        @dpnInfo[:rightsObjectIDs].each do |id|
          if uuidValidator.isValid?(id) == false
            @validationErrors.push("#{@settings[:bag][:dpn_info][:rightsObjectIDs][:name]} value of \"#{id}\" is not a valid UUIDv4.")
Severity: Minor
Found in lib/dpn/bagit/bag.rb and 1 other location - About 25 mins to fix
lib/dpn/bagit/bag.rb on lines 135..137

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

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

        @dpnInfo[:interpretiveObjectIDs].each do |id|
          if uuidValidator.isValid?(id) == false
            @validationErrors.push("#{@settings[:bag][:dpn_info][:interpretiveObjectIDs][:name]} value of \"#{id}\" is not a valid UUIDv4.")
Severity: Minor
Found in lib/dpn/bagit/bag.rb and 1 other location - About 25 mins to fix
lib/dpn/bagit/bag.rb on lines 129..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 29.

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

        if uuidValidator.isValid?(@dpnInfo[:firstVersionObjectID]) == false
          @validationErrors.push("#{@settings[:bag][:dpn_info][:firstVersionObjectID][:name]} with value \"#{@dpnInfo[:firstVersionObjectID]}\" is not a valid UUIDv4.")
Severity: Minor
Found in lib/dpn/bagit/bag.rb and 1 other location - About 20 mins to fix
lib/dpn/bagit/bag.rb on lines 121..122

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

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

        if uuidValidator.isValid?(@dpnInfo[:dpnObjectID]) == false
          @validationErrors.push("#{@settings[:bag][:dpn_info][:dpnObjectID][:name]} with value \"#{@dpnInfo[:dpnObjectID]}\" is not a valid UUIDv4.")
Severity: Minor
Found in lib/dpn/bagit/bag.rb and 1 other location - About 20 mins to fix
lib/dpn/bagit/bag.rb on lines 125..126

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

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

end at 25, 4 is not aligned with def at 12, 6.
Open

    end
Severity: Minor
Found in lib/dpn/bagit/bag.rb by rubocop

This cop checks whether the end keywords of method definitions are aligned properly.

Two modes are supported through the EnforcedStyleAlignWith configuration parameter. If it's set to start_of_line (which is the default), the end shall be aligned with the start of the line where the def keyword is. If it's set to def, the end shall be aligned with the def keyword.

Example: EnforcedStyleAlignWith: startofline (default)

# bad

private def foo
            end

# good

private def foo
end

Example: EnforcedStyleAlignWith: def

# bad

private def foo
            end

# good

private def foo
        end

File.exists? is deprecated in favor of File.exist?.
Open

        if File.exists?(@bag.fetch_txt_file) == true
Severity: Minor
Found in lib/dpn/bagit/bag.rb by rubocop

This cop checks for uses of the deprecated class method usages.

Example:

# bad

File.exists?(some_path)

Example:

# good

File.exist?(some_path)

File.exists? is deprecated in favor of File.exist?.
Open

        if File.exists?(@bag.manifest_file("sha256")) == true
Severity: Minor
Found in lib/dpn/bagit/bag.rb by rubocop

This cop checks for uses of the deprecated class method usages.

Example:

# bad

File.exists?(some_path)

Example:

# good

File.exist?(some_path)
Severity
Category
Status
Source
Language