piotrmurach/tty-spinner

View on GitHub

Showing 14 of 14 total issues

Class Spinner has 36 methods (exceeds 20 allowed). Consider refactoring.
Open

  class Spinner
    include Formats
    include MonitorMixin

    # @raised when attempting to join dead thread
Severity: Minor
Found in lib/tty/spinner.rb - About 4 hrs to fix

    File spinner.rb has 300 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    require "monitor"
    require "tty-cursor"
    
    require_relative "spinner/version"
    require_relative "spinner/formats"
    Severity: Minor
    Found in lib/tty/spinner.rb - About 3 hrs to fix

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

          class Multi
            include Enumerable
            include MonitorMixin
      
            extend Forwardable
      Severity: Minor
      Found in lib/tty/spinner/multi.rb - About 2 hrs to fix

        File formats.rb has 272 lines of code (exceeds 250 allowed). Consider refactoring.
        Open

        module TTY
          module Formats
            FORMATS = {
              classic: {
                interval: 10,
        Severity: Minor
        Found in lib/tty/spinner/formats.rb - About 2 hrs to fix

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

              def execute_on_line
                if @multispinner
                  @multispinner.synchronize do
                    if @first_run
                      @row ||= @multispinner.next_row
          Severity: Minor
          Found in lib/tty/spinner.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 register has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
          Open

                def register(pattern_or_spinner, **options, &job)
                  observable = options.delete(:observable) { true }
                  spinner = nil
          
                  synchronize do
          Severity: Minor
          Found in lib/tty/spinner/multi.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 auto_spin has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
          Open

              def auto_spin
                CURSOR_LOCK.synchronize do
                  start
                  sleep_time = 1.0 / @interval
          
          
          Severity: Minor
          Found in lib/tty/spinner.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 stop has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
          Open

              def stop(stop_message = "", mark: nil)
                mon_enter
                return if done?
          
                clear_line
          Severity: Minor
          Found in lib/tty/spinner.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 error_handler has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
          Open

                def error_handler
                  proc do
                    if error?
                      @top_spinner.error if @top_spinner
                      @fired ||= emit(:error) # fire once
          Severity: Minor
          Found in lib/tty/spinner/multi.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

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

                def initialize(*args)
                  super()
                  @options = args.last.is_a?(::Hash) ? args.pop : {}
                  message = args.empty? ? nil : args.pop
                  @inset_opts = @options.delete(:style) { DEFAULT_INSET }
          Severity: Minor
          Found in lib/tty/spinner/multi.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

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

                def done_handler
                  proc do
                    if done?
                      @top_spinner.stop if @top_spinner && !error? && !success?
                      emit(:done)
          Severity: Minor
          Found in lib/tty/spinner/multi.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

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

              def write(data, clear_first = false)
                return unless tty? # write only to terminal
          
                execute_on_line do
                  output.print(TTY::Cursor.column(1)) if clear_first
          Severity: Minor
          Found in lib/tty/spinner.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

                dots_6: {
                  interval: 10,
                  frames: %w[⠁ ⠉ ⠙ ⠚ ⠒ ⠂ ⠂ ⠒ ⠲ ⠴ ⠤ ⠄ ⠄ ⠤ ⠴ ⠲ ⠒ ⠂ ⠂ ⠒ ⠚ ⠙ ⠉ ⠁]
                },
          Severity: Minor
          Found in lib/tty/spinner/formats.rb and 1 other location - About 25 mins to fix
          lib/tty/spinner/formats.rb on lines 66..69

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

          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

                dots_7: {
                  interval: 10,
                  frames: %w[⠈ ⠉ ⠋ ⠓ ⠒ ⠐ ⠐ ⠒ ⠖ ⠦ ⠤ ⠠ ⠠ ⠤ ⠦ ⠖ ⠒ ⠐ ⠐ ⠒ ⠓ ⠋ ⠉ ⠈]
                },
          Severity: Minor
          Found in lib/tty/spinner/formats.rb and 1 other location - About 25 mins to fix
          lib/tty/spinner/formats.rb on lines 62..65

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

          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