johnbellone/consul-replicate-cookbook

View on GitHub

Showing 7 of 7 total issues

Method default_archive_checksum has a Cognitive Complexity of 35 (exceeds 5 allowed). Consider refactoring.
Open

      def self.default_archive_checksum(node, resource)
        tag = node['kernel']['machine'] =~ /x86_64/ ? 'amd64' : node['kernel']['machine']
        case [node['os'], tag].join('-')
        when 'darwin-i386'
          case resource.version
Severity: Minor
Found in libraries/consul_replicate_installation_archive.rb - About 5 hrs 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 default_archive_checksum has 82 lines of code (exceeds 25 allowed). Consider refactoring.
Open

      def self.default_archive_checksum(node, resource)
        tag = node['kernel']['machine'] =~ /x86_64/ ? 'amd64' : node['kernel']['machine']
        case [node['os'], tag].join('-')
        when 'darwin-i386'
          case resource.version
Severity: Major
Found in libraries/consul_replicate_installation_archive.rb - About 3 hrs to fix

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

          def variables
            {
              consul: consul,
              retry: self.retry,
              max_stale: max_stale,
    Severity: Minor
    Found in libraries/consul_replicate_config.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 variables has 30 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

          def variables
            {
              consul: consul,
              retry: self.retry,
              max_stale: max_stale,
    Severity: Minor
    Found in libraries/consul_replicate_config.rb - About 1 hr to fix

      Prefer annotated tokens (like %<foo>s</foo>) over template tokens (like %{foo}).
      Open

              "https://releases.hashicorp.com/consul-replicate/%{version}/%{basename}" # rubocop:disable Style/StringLiterals

      Use a consistent style for named format string tokens.

      Note: unannotated style cop only works for strings which are passed as arguments to those methods: sprintf, format, %. The reason is that unannotated format is very similar to encoded URLs or Date/Time formatting strings.

      Example: EnforcedStyle: annotated (default)

      # bad
      format('%{greeting}', greeting: 'Hello')
      format('%s', 'Hello')
      
      # good
      format('%<greeting>s', greeting: 'Hello')</greeting>

      Example: EnforcedStyle: template

      # bad
      format('%<greeting>s', greeting: 'Hello')
      format('%s', 'Hello')
      
      # good
      format('%{greeting}', greeting: 'Hello')</greeting>

      Example: EnforcedStyle: unannotated

      # bad
      format('%<greeting>s', greeting: 'Hello')
      format('%{greeting}', 'Hello')
      
      # good
      format('%s', 'Hello')</greeting>

      Favor format over String#%.
      Open

              url = options[:archive_url] % {version: options[:version], basename: options[:archive_basename]}

      This cop enforces the use of a single string formatting utility. Valid options include Kernel#format, Kernel#sprintf and String#%.

      The detection of String#% cannot be implemented in a reliable manner for all cases, so only two scenarios are considered - if the first argument is a string literal and if the second argument is an array literal.

      Example: EnforcedStyle: format(default)

      # bad
      puts sprintf('%10s', 'hoge')
      puts '%10s' % 'hoge'
      
      # good
      puts format('%10s', 'hoge')

      Example: EnforcedStyle: sprintf

      # bad
      puts format('%10s', 'hoge')
      puts '%10s' % 'hoge'
      
      # good
      puts sprintf('%10s', 'hoge')

      Example: EnforcedStyle: percent

      # bad
      puts format('%10s', 'hoge')
      puts sprintf('%10s', 'hoge')
      
      # good
      puts '%10s' % 'hoge'

      Prefer annotated tokens (like %<foo>s</foo>) over template tokens (like %{foo}).
      Open

              "https://releases.hashicorp.com/consul-replicate/%{version}/%{basename}" # rubocop:disable Style/StringLiterals

      Use a consistent style for named format string tokens.

      Note: unannotated style cop only works for strings which are passed as arguments to those methods: sprintf, format, %. The reason is that unannotated format is very similar to encoded URLs or Date/Time formatting strings.

      Example: EnforcedStyle: annotated (default)

      # bad
      format('%{greeting}', greeting: 'Hello')
      format('%s', 'Hello')
      
      # good
      format('%<greeting>s', greeting: 'Hello')</greeting>

      Example: EnforcedStyle: template

      # bad
      format('%<greeting>s', greeting: 'Hello')
      format('%s', 'Hello')
      
      # good
      format('%{greeting}', greeting: 'Hello')</greeting>

      Example: EnforcedStyle: unannotated

      # bad
      format('%<greeting>s', greeting: 'Hello')
      format('%{greeting}', 'Hello')
      
      # good
      format('%s', 'Hello')</greeting>
      Severity
      Category
      Status
      Source
      Language