ClusterLabs/hawk

View on GitHub
hawk/app/models/step.rb

Summary

Maintainability
A
1 hr
Test Coverage

Assignment Branch Condition size for initialize is too high. [22.29/15]
Open

  def initialize(parent, data)
    @parent = parent
    @name = data["name"] || ''
    @shortdesc = data["shortdesc"].strip
    @longdesc = data["longdesc"]
Severity: Minor
Found in hawk/app/models/step.rb by rubocop

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

Cyclomatic complexity for initialize is too high. [7/6]
Open

  def initialize(parent, data)
    @parent = parent
    @name = data["name"] || ''
    @shortdesc = data["shortdesc"].strip
    @longdesc = data["longdesc"]
Severity: Minor
Found in hawk/app/models/step.rb by rubocop

This cop checks that the cyclomatic complexity of methods is not higher than the configured maximum. The cyclomatic complexity is the number of linearly independent paths through a method. The algorithm counts decision points and adds one.

An if statement (or unless or ?:) increases the complexity by one. An else branch does not, since it doesn't add a decision point. The && operator (or keyword and) can be converted to a nested if statement, and ||/or is shorthand for a sequence of ifs, so they also add one. Loops can be said to have an exit condition, so they add one.

Method params_mapping has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

  def params_mapping
    m = {}
    @parameters.each do |param|
      next unless param.advanced
      m[param.id] = {
Severity: Minor
Found in hawk/app/models/step.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 initialize has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

  def initialize(parent, data)
    @parent = parent
    @name = data["name"] || ''
    @shortdesc = data["shortdesc"].strip
    @longdesc = data["longdesc"]
Severity: Minor
Found in hawk/app/models/step.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

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

      m[param.id] = {
        type: param.attrlist_type,
        default: param.example,
        longdesc: param.longdesc.blank? ? param.shortdesc : param.longdesc,
        name: param.name,
Severity: Minor
Found in hawk/app/models/step.rb and 1 other location - About 15 mins to fix
hawk/app/models/step.rb on lines 88..94

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

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

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

      m[param.id] = {
        type: param.attrlist_type,
        default: param.example,
        longdesc: param.longdesc.blank? ? param.shortdesc : param.longdesc,
        name: param.name,
Severity: Minor
Found in hawk/app/models/step.rb and 1 other location - About 15 mins to fix
hawk/app/models/step.rb on lines 102..108

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

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

Use ! instead of not.
Open

    parameters.select { |p| not p.advanced }
Severity: Minor
Found in hawk/app/models/step.rb by rubocop

This cop checks for uses of the keyword not instead of !.

Example:

# bad - parentheses are required because of op precedence
x = (not something)

# good
x = !something

Favor modifier if usage when having a single-line body. Another good alternative is the usage of control flow &&/||.
Open

      if param["type"] == "boolean" && param.key?("example")
Severity: Minor
Found in hawk/app/models/step.rb by rubocop

Checks for if and unless statements that would fit on one line if written as a modifier if/unless. The maximum line length is configured in the Metrics/LineLength cop.

Example:

# bad
if condition
  do_stuff(bar)
end

unless qux.empty?
  Foo.do_something
end

# good
do_stuff(bar) if condition
Foo.do_something unless qux.empty?

Extra empty line detected at class body end.
Open


end
Severity: Minor
Found in hawk/app/models/step.rb by rubocop

This cops checks if empty lines around the bodies of classes match the configuration.

Example: EnforcedStyle: empty_lines

# good

class Foo

  def bar
    # ...
  end

end

Example: EnforcedStyle: emptylinesexcept_namespace

# good

class Foo
  class Bar

    # ...

  end
end

Example: EnforcedStyle: emptylinesspecial

# good
class Foo

  def bar; end

end

Example: EnforcedStyle: noemptylines (default)

# good

class Foo
  def bar
    # ...
  end
end

Pass &:advanced as an argument to select instead of a block.
Open

    parameters.select { |p| p.advanced }
Severity: Minor
Found in hawk/app/models/step.rb by rubocop

Use symbols as procs when possible.

Example:

# bad
something.map { |s| s.upcase }

# good
something.map(&:upcase)

There are no issues that match your filters.

Category
Status