AnalyzePlatypus/TranslitKit

View on GitHub

Showing 4 of 51 total issues

Method phonemes has a Cognitive Complexity of 29 (exceeds 5 allowed). Consider refactoring.
Open

  def phonemes
        @completed = []

        # For each raw character :
        @hebword.chars.each_with_index do |char,i|
Severity: Minor
Found in lib/phonemizer.rb - About 4 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 phonemes has 31 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  def phonemes
        @completed = []

        # For each raw character :
        @hebword.chars.each_with_index do |char,i|
Severity: Minor
Found in lib/phonemizer.rb - About 1 hr to fix

    Avoid too many return statements within this method.
    Open

            when "ך" then return "כ"
    Severity: Major
    Found in lib/phonemizer.rb - About 30 mins to fix

      Method setup_permuter has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

        def setup_permuter
          @permuter = Permuter.new
      
          # Get the letters of the word
          heb_letters = self.phonemes
      Severity: Minor
      Found in lib/transliterator.rb - 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

      Severity
      Category
      Status
      Source
      Language