brewster1134/cli_miami

View on GitHub
lib/cli_miami.rb

Summary

Maintainability
A
2 hrs
Test Coverage

Method get_options has 37 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  def self.get_options user_options = {}
    # lookup preset if passed in as a symbol, or as a :preset key in an options hash
    if user_options.is_a? Hash
      user_options.deep_symbolize_keys!
      options = @@presets[user_options.delete(:preset)] || {}
Severity: Minor
Found in lib/cli_miami.rb - About 1 hr to fix

    Method get_options has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

      def self.get_options user_options = {}
        # lookup preset if passed in as a symbol, or as a :preset key in an options hash
        if user_options.is_a? Hash
          user_options.deep_symbolize_keys!
          options = @@presets[user_options.delete(:preset)] || {}
    Severity: Minor
    Found in lib/cli_miami.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

    %w-literals should be delimited by [ and ].
    Open

      BOOLEAN_TRUE_VALUES = %w(true t yes y).freeze
    Severity: Minor
    Found in lib/cli_miami.rb by rubocop

    This cop enforces the consistent usage of %-literal delimiters.

    Specify the 'default' key to set all preferred delimiters at once. You can continue to specify individual preferred delimiters to override the default.

    Example:

    # Style/PercentLiteralDelimiters:
    #   PreferredDelimiters:
    #     default: '[]'
    #     '%i':    '()'
    
    # good
    %w[alpha beta] + %i(gamma delta)
    
    # bad
    %W(alpha #{beta})
    
    # bad
    %I(alpha beta)

    Use %i or %I for an array of symbols.
    Open

          style: [:bold, :underline]
    Severity: Minor
    Found in lib/cli_miami.rb by rubocop

    This cop can check for array literals made up of symbols that are not using the %i() syntax.

    Alternatively, it checks for symbol arrays using the %i() syntax on projects which do not want to use that syntax.

    Configuration option: MinSize If set, arrays with fewer elements than this value will not trigger the cop. For example, a MinSize of3` will not enforce a style on an array of 2 or fewer elements.

    Example: EnforcedStyle: percent (default)

    # good
    %i[foo bar baz]
    
    # bad
    [:foo, :bar, :baz]

    Example: EnforcedStyle: brackets

    # good
    [:foo, :bar, :baz]
    
    # bad
    %i[foo bar baz]

    Use %i or %I for an array of symbols.
    Open

          style: [:bold, :underline]
    Severity: Minor
    Found in lib/cli_miami.rb by rubocop

    This cop can check for array literals made up of symbols that are not using the %i() syntax.

    Alternatively, it checks for symbol arrays using the %i() syntax on projects which do not want to use that syntax.

    Configuration option: MinSize If set, arrays with fewer elements than this value will not trigger the cop. For example, a MinSize of3` will not enforce a style on an array of 2 or fewer elements.

    Example: EnforcedStyle: percent (default)

    # good
    %i[foo bar baz]
    
    # bad
    [:foo, :bar, :baz]

    Example: EnforcedStyle: brackets

    # good
    [:foo, :bar, :baz]
    
    # bad
    %i[foo bar baz]

    %w-literals should be delimited by [ and ].
    Open

      BOOLEAN_FALSE_VALUES = %w(false f no n).freeze
    Severity: Minor
    Found in lib/cli_miami.rb by rubocop

    This cop enforces the consistent usage of %-literal delimiters.

    Specify the 'default' key to set all preferred delimiters at once. You can continue to specify individual preferred delimiters to override the default.

    Example:

    # Style/PercentLiteralDelimiters:
    #   PreferredDelimiters:
    #     default: '[]'
    #     '%i':    '()'
    
    # good
    %w[alpha beta] + %i(gamma delta)
    
    # bad
    %W(alpha #{beta})
    
    # bad
    %I(alpha beta)

    There are no issues that match your filters.

    Category
    Status