QutBioacoustics/baw-audio-tools

View on GitHub
lib/baw-audio-tools/spectrogram.rb

Summary

Maintainability
C
1 day
Test Coverage

Method modify has a Cognitive Complexity of 38 (exceeds 5 allowed). Consider refactoring.
Open

    def modify(source, target, modify_parameters = {})
      fail ArgumentError, "Target is not a png file: : #{target}" unless target.match(/\.png/)
      fail ArgumentError, "Source is not a wav file: : #{source}" unless source.match(/\.wav/)
      fail Exceptions::FileNotFoundError, "Source does not exist: #{source}" unless File.exists? source
      fail Exceptions::FileAlreadyExistsError, "Target exists: #{target}" if File.exists? target
Severity: Minor
Found in lib/baw-audio-tools/spectrogram.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 modify has 44 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    def modify(source, target, modify_parameters = {})
      fail ArgumentError, "Target is not a png file: : #{target}" unless target.match(/\.png/)
      fail ArgumentError, "Source is not a wav file: : #{source}" unless source.match(/\.wav/)
      fail Exceptions::FileNotFoundError, "Source does not exist: #{source}" unless File.exists? source
      fail Exceptions::FileAlreadyExistsError, "Target exists: #{target}" if File.exists? target
Severity: Minor
Found in lib/baw-audio-tools/spectrogram.rb - About 1 hr to fix

    Method from_executables has 5 arguments (exceeds 4 allowed). Consider refactoring.
    Open

        def self.from_executables(audio_master, im_convert_exe, im_identify_exe, spectrogram_defaults, temp_dir)
    Severity: Minor
    Found in lib/baw-audio-tools/spectrogram.rb - About 35 mins to fix

      There are no issues that match your filters.

      Category
      Status