QutBioacoustics/baw-audio-tools

View on GitHub

Showing 57 of 57 total issues

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

    def arg_offsets(start_offset, end_offset)
      # Cuts portions out of the audio. Any number of positions may be given; audio is not sent
      # to the output until the first position is reached. The effect then alternates between
      # copying and discarding audio at each position.

Severity: Major
Found in lib/baw-audio-tools/audio_sox.rb and 1 other location - About 1 hr to fix
lib/baw-audio-tools/audio_shntool.rb on lines 59..77

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

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

    def arg_offsets(start_offset, end_offset)
      cmd_arg = ''

      unless start_offset.blank?
        start_offset_formatted = Time.at(start_offset.to_f).utc.strftime('%H:%M:%S.%2N')
Severity: Major
Found in lib/baw-audio-tools/audio_shntool.rb and 1 other location - About 1 hr to fix
lib/baw-audio-tools/audio_sox.rb on lines 150..185

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

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

    def modify_command(source, source_info, target, start_offset = nil, end_offset = nil)
      fail ArgumentError, "Source is not a mp3 file: #{source}" unless source.match(/\.mp3$/)
      fail ArgumentError, "Target is not a mp3 file: : #{target}" unless target.match(/\.mp3$/)
      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/audio_mp3splt.rb - 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

Method clipping_check has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
Open

    def clipping_check(source, info_flattened)
      # check for clipping, zero signal
      # only if duration less than 4 minutes
      four_minutes_in_sec = 4.0 * 60.0
      if (info_flattened[:media_type] == 'audio/wav' ||
Severity: Minor
Found in lib/baw-audio-tools/audio_base.rb - 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

Method modify_command has 7 arguments (exceeds 4 allowed). Consider refactoring.
Open

    def modify_command(source, source_info, target, start_offset = nil, end_offset = nil, channel = nil, sample_rate = nil)
Severity: Major
Found in lib/baw-audio-tools/audio_ffmpeg.rb - About 50 mins to fix

    Method modify_command has 7 arguments (exceeds 4 allowed). Consider refactoring.
    Open

        def modify_command(source, source_info, target, start_offset = nil, end_offset = nil, channel = nil, sample_rate = nil)
    Severity: Major
    Found in lib/baw-audio-tools/audio_sox.rb - About 50 mins to fix

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

          def check_for_errors(execute_msg)
            stdout = execute_msg[:stdout]
            stderr = execute_msg[:stderr]
            if !stderr.blank? && stderr.include?(ERROR_CANNOT_OPEN)
              fail Exceptions::FileCorruptError, "sox could not open the file.\n\t#{execute_msg[:execute_msg]}"
      Severity: Minor
      Found in lib/baw-audio-tools/audio_sox.rb and 1 other location - About 50 mins to fix
      lib/baw-audio-tools/image_image_magick.rb on lines 33..41

      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

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

          def check_for_errors(execute_msg)
            stdout = execute_msg[:stdout]
            stderr = execute_msg[:stderr]
            if !stderr.blank? && stderr.include?(ERROR_UNABLE_TO_OPEN)
              fail Exceptions::FileCorruptError, "Image magick could not open the file.\n\t#{execute_msg[:execute_msg]}"
      Severity: Minor
      Found in lib/baw-audio-tools/image_image_magick.rb and 1 other location - About 50 mins to fix
      lib/baw-audio-tools/audio_sox.rb on lines 37..45

      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

      Method command has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Open

          def command(source, source_info, target,
                      width = 1800, height = 280,
                      colour_bg = 'efefefff', colour_fg = '00000000',
                      scale = :linear,
                      db_min = -48, db_max = 0)
      Severity: Minor
      Found in lib/baw-audio-tools/audio_waveform.rb - About 45 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

      Method modify_command has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Open

          def modify_command(source, source_info, target, start_offset = nil, end_offset = nil, channel = nil, sample_rate = nil)
            fail ArgumentError, "Source is not a wav file: #{source}" unless source.match(/\.wav$/)
            fail ArgumentError, "Target is not a wav file: : #{target}" unless target.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/audio_sox.rb - About 45 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

      Method modify_command has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Open

          def modify_command(source, target)
            fail ArgumentError, "Source is not a wac file: #{source}" unless source.match(/\.wac$/)
            fail ArgumentError, "Target is not a wav file: : #{target}" unless target.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/audio_wac2wav.rb - About 45 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

      Method audio_tool_segment has 6 arguments (exceeds 4 allowed). Consider refactoring.
      Open

          def audio_tool_segment(extension, audio_tool_method, source, source_info, target, modify_parameters)
      Severity: Minor
      Found in lib/baw-audio-tools/audio_base.rb - About 45 mins to fix

        Method arg_scale has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

            def arg_scale(scale)
              # -d [ --db-scale ] use logarithmic (e.g. decibel) scale instead of linear scale
              cmd_arg = ''
              all_scale_options = AudioWaveform.scale_options.join(', ')
        
        
        Severity: Minor
        Found in lib/baw-audio-tools/audio_waveform.rb - About 45 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

        Method spectrogram_command has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

            def spectrogram_command(source, source_info, target, start_offset = nil, end_offset = nil, channel = nil, sample_rate = nil,
                                    window = nil, window_function = nil, colour = nil)
              fail ArgumentError, "Source is not a wav file: #{source}" unless source.match(/\.wav$/)
              fail ArgumentError, "Target is not a png file: : #{target}" unless target.match(/\.png/)
              fail Exceptions::FileNotFoundError, "Source does not exist: #{source}" unless File.exists? source
        Severity: Minor
        Found in lib/baw-audio-tools/audio_sox.rb - About 45 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

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

            def read_to_stream(stdout, stderr, output, error, options)
        Severity: Minor
        Found in lib/baw-audio-tools/run_external_program.rb - About 35 mins to fix

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

              def self.from_executables(audio_defaults, logger, temp_dir, timeout_sec, opts = {})
          Severity: Minor
          Found in lib/baw-audio-tools/audio_base.rb - About 35 mins to fix

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

                def modify_command(source, source_info, target, start_offset = nil, end_offset = nil)
            Severity: Minor
            Found in lib/baw-audio-tools/audio_mp3splt.rb - About 35 mins 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

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

                    def modify_wavpack(source, source_info, target, start_offset, end_offset)
                Severity: Minor
                Found in lib/baw-audio-tools/audio_base.rb - About 35 mins to fix

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

                      def modify_command(source, source_info, target, start_offset = nil, end_offset = nil)
                  Severity: Minor
                  Found in lib/baw-audio-tools/audio_wavpack.rb - About 35 mins to fix
                    Severity
                    Category
                    Status
                    Source
                    Language