orange-cloudfoundry/cf-ops-automation

View on GitHub
scripts/generate-root-deployments.rb

Summary

Maintainability
A
2 hrs
Test Coverage

Assignment Branch Condition size for configure_logging is too high. [16.58/15]
Open

def configure_logging(options)
  secrets_path = options[:secrets_path]
  private_config_file = File.join(secrets_path, 'private-config.yml')
  private_config = {}
  YAML.load_file(private_config_file) || {} if File.exist? private_config_file

This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric

configure_logging has approx 10 statements
Open

def configure_logging(options)
Severity: Minor
Found in scripts/generate-root-deployments.rb by reek

A method with Too Many Statements is any method that has a large number of lines.

Too Many Statements warns about any method that has more than 5 statements. Reek's smell detector for Too Many Statements counts +1 for every simple statement in a method and +1 for every statement within a control structure (if, else, case, when, for, while, until, begin, rescue) but it doesn't count the control structure itself.

So the following method would score +6 in Reek's statement-counting algorithm:

def parse(arg, argv, &error)
  if !(val = arg) and (argv.empty? or /\A-/ =~ (val = argv[0]))
    return nil, block, nil                                         # +1
  end
  opt = (val = parse_arg(val, &error))[1]                          # +2
  val = conv_arg(*val)                                             # +3
  if opt and !arg
    argv.shift                                                     # +4
  else
    val[0] = nil                                                   # +5
  end
  val                                                              # +6
end

(You might argue that the two assigments within the first @if@ should count as statements, and that perhaps the nested assignment should count as +2.)

Method configure_logging has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
Open

def configure_logging(options)
  secrets_path = options[:secrets_path]
  private_config_file = File.join(secrets_path, 'private-config.yml')
  private_config = {}
  YAML.load_file(private_config_file) || {} if File.exist? private_config_file
Severity: Minor
Found in scripts/generate-root-deployments.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

configure_logging doesn't depend on instance state (maybe move it to another class?)
Open

def configure_logging(options)
Severity: Minor
Found in scripts/generate-root-deployments.rb by reek

A Utility Function is any instance method that has no dependency on the state of the instance.

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

def configure_logging(options)
  secrets_path = options[:secrets_path]
  private_config_file = File.join(secrets_path, 'private-config.yml')
  private_config = {}
  YAML.load_file(private_config_file) || {} if File.exist? private_config_file
Severity: Major
Found in scripts/generate-root-deployments.rb and 1 other location - About 1 hr to fix
scripts/generate-depls.rb on lines 6..16

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

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

There are no issues that match your filters.

Category
Status