acook/remedy

View on GitHub

Showing 4 of 4 total issues

Class Key has 24 methods (exceeds 20 allowed). Consider refactoring.
Open

  class Key

    def initialize character_sequence
      @character_sequence = character_sequence
    end
Severity: Minor
Found in lib/remedy/key.rb - About 2 hrs to fix

    Method alternate_names has 33 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        def alternate_names
          {
            control_a: :start_of_heading,
            control_b: :start_of_text,
            control_c: :end_of_transmission,
    Severity: Minor
    Found in lib/remedy/characters.rb - About 1 hr to fix

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

          def raw_get
            Console.raw do
              input = STDIN.getc.chr
      
              if input == "\e" then
      Severity: Minor
      Found in lib/remedy/keyboard.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 loop has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

          def loop
            Keyboard.raise_on_control_c!
      
            super do
              print " -- #{message}" if message
      Severity: Minor
      Found in lib/remedy/interaction.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