Sign upLogin

piotrmurach/tty-reader

View on GitHub
Star

Showing 16 of 16 total issues

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 Line has 28 methods (exceeds 20 allowed). Consider refactoring.
      Open

          class Line
      ANSI_MATCHER = /(\[)?\033(\[)?[;?\d]*[\dA-Za-z](\])?/

      # The word break characters list used by shell
      DEFAULT_WORD_BREAK_CHARACTERS = " \t\n\"\\'`@$><=|&{("
      Severity: Minor
      Found in lib/tty/reader/line.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 complete_next has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
          Open

                def complete_next(line, direction: :next)
        return if completions.empty?

        previous_suggestion = completions.get
        first_or_last = direction == :previous ? :first? : :last?
          Severity: Minor
          Found in lib/tty/reader/completer.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_char has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
          Open

                def get_char(echo: true, raw: false, nonblock: false)
        mode.raw(raw) do
          mode.echo(echo) do
            if nonblock
              input.wait_readable(TIMEOUT) ? input.getc : nil
          Severity: Minor
          Found in lib/tty/reader/console.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 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

                      @history.replace(line.text) if 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

                Method word_start_pos has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
                Open

                      def word_start_pos(from: @cursor, before: true)
        # move back or forward by one character when at a word boundary
        if word_boundary?
          from = before ? from - 1 : from + 1
        end
                Severity: Minor
                Found in lib/tty/reader/line.rb - About 35 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 []= has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                Open

                      def []=(i, chars)
        edit_mode

        if i.is_a?(Range)
          @text[i] = chars
                Severity: Minor
                Found in lib/tty/reader/line.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

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

                Benchmark.ips do |x|
  x.report("getc") do
    input.rewind
    $stdin.getc
  end
                Severity: Minor
                Found in benchmarks/speed_read_char.rb and 1 other location - About 15 mins to fix
                benchmarks/speed_read_line.rb on lines 13..24

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

                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

                Benchmark.ips do |x|
  x.report("gets") do
    input.rewind
    $stdin.gets
  end
                Severity: Minor
                Found in benchmarks/speed_read_line.rb and 1 other location - About 15 mins to fix
                benchmarks/speed_read_char.rb on lines 13..24

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

                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

                Severity
                Category
                Status
                Source
                Language