Sign upLogin

piotrmurach/tty-reader

View on GitHub
Star
lib/tty/reader.rb

Summary

Maintainability
F
3 days
Test Coverage

Method read_line has a Cognitive Complexity of 86 (exceeds 5 allowed). Consider refactoring.
Open

    def read_line(prompt = "", value: "", echo: true, raw: true,
                  nonblock: false, exit_keys: nil)
      line = Line.new(value, prompt: prompt)
      screen_width = TTY::Screen.width
      history_in_use = false
Severity: Minor
Found in lib/tty/reader.rb - About 1 day 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_line has 93 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    def read_line(prompt = "", value: "", echo: true, raw: true,
                  nonblock: false, exit_keys: nil)
      line = Line.new(value, prompt: prompt)
      screen_width = TTY::Screen.width
      history_in_use = false
Severity: Major
Found in lib/tty/reader.rb - About 3 hrs to fix

    File reader.rb has 312 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    require "tty-cursor"
require "tty-screen"
require "wisper"

require_relative "reader/completer"
    Severity: Minor
    Found in lib/tty/reader.rb - About 3 hrs to fix

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

        class Reader
    include Wisper::Publisher

    # Key codes
    BACKSPACE = 8
      Severity: Minor
      Found in lib/tty/reader.rb - About 2 hrs to fix

        Method read_multiline has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
        Open

            def read_multiline(prompt = "", value: "", echo: true, raw: true,
                       nonblock: false, exit_keys: EXIT_KEYS)
      lines = []
      stop = false
      clear_value = !value.to_s.empty?
        Severity: Minor
        Found in lib/tty/reader.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 get_codes has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
        Open

            def get_codes(echo: true, raw: false, nonblock: false, codes: [])
      char = console.get_char(echo: echo, raw: raw, nonblock: nonblock)
      handle_interrupt if console.keys[char] == :ctrl_c
      return if char.nil?
        Severity: Minor
        Found in lib/tty/reader.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

        Avoid deeply nested control flow statements.
        Open

                elsif key_name == :down
          @history.replace(line.text) if history_in_use
          if history_next?
            line.replace(history_next)
          elsif history_in_use
        Severity: Major
        Found in lib/tty/reader.rb - About 45 mins to fix

          Avoid deeply nested control flow statements.
          Open

                    if history_previous?
            line.replace(history_previous(skip: !history_in_use))
            history_in_use = true
          end
          Severity: Major
          Found in lib/tty/reader.rb - About 45 mins to fix

            Avoid deeply nested control flow statements.
            Open

                      @history.replace(line.text) if history_in_use
            Severity: Major
            Found in lib/tty/reader.rb - About 45 mins to fix

              There are no issues that match your filters.

              Category
              Status