grempe/tss-rb

View on GitHub
lib/tss/cli_common.rb

Summary

Maintainability
A
1 hr
Test Coverage

Method exit_if_binary! has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
Open

      def exit_if_binary!(str)
        str.each_byte { |c|
          # OK, 9 (TAB), 10 (CR), 13 (LF), >=32 for normal ASCII
          # Usage of anything other than 10, 13, and 32-126 ASCII decimal codes
          # looks as though contents are binary and not standard text.
Severity: Minor
Found in lib/tss/cli_common.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

Consider simplifying this complex logical expression.
Open

          if c < 9 || (c > 10 && c < 13) || (c > 13 && c < 32) || c == 127
            err('STDIN secret appears to contain binary data.')
            exit(1)
          end
Severity: Major
Found in lib/tss/cli_common.rb - About 40 mins to fix

    Missing magic comment # frozen_string_literal: true.
    Open

    require 'thor'
    Severity: Minor
    Found in lib/tss/cli_common.rb by rubocop

    This cop is designed to help upgrade to Ruby 3.0. It will add the comment # frozen_string_literal: true to the top of files to enable frozen string literals. Frozen string literals may be default in Ruby 3.0. The comment will be added below a shebang and encoding comment. The frozen string literal comment is only valid in Ruby 2.3+.

    Example: EnforcedStyle: when_needed (default)

    # The `when_needed` style will add the frozen string literal comment
    # to files only when the `TargetRubyVersion` is set to 2.3+.
    # bad
    module Foo
      # ...
    end
    
    # good
    # frozen_string_literal: true
    
    module Foo
      # ...
    end

    Example: EnforcedStyle: always

    # The `always` style will always add the frozen string literal comment
    # to a file, regardless of the Ruby version or if `freeze` or `<<` are
    # called on a string literal.
    # bad
    module Bar
      # ...
    end
    
    # good
    # frozen_string_literal: true
    
    module Bar
      # ...
    end

    Example: EnforcedStyle: never

    # The `never` will enforce that the frozen string literal comment does
    # not exist in a file.
    # bad
    # frozen_string_literal: true
    
    module Baz
      # ...
    end
    
    # good
    module Baz
      # ...
    end

    There are no issues that match your filters.

    Category
    Status