ClusterLabs/hawk

View on GitHub
hawk/app/controllers/cib_controller.rb

Summary

Maintainability
B
6 hrs
Test Coverage

Assignment Branch Condition size for ops is too high. [51.58/15]
Open

  def ops
    invars = params[:id].split(",", 2)
    if invars.length == 1
      rsc = invars[0]
      node = "*"

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

Assignment Branch Condition size for show is too high. [24.21/15]
Open

  def show
    respond_to do |format|
      format.html
      format.json do
        render json: current_cib.status()

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

Assignment Branch Condition size for apply is too high. [24.82/15]
Open

  def apply
    if request.post?
      out, err, rc = Invoker.instance.crm_configure("cib commit #{current_cib.id}")
      if rc != 0
        Rails.logger.debug "apply fail: #{err}, #{current_cib.id}"

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

Method has too many lines. [38/30]
Open

  def ops
    invars = params[:id].split(",", 2)
    if invars.length == 1
      rsc = invars[0]
      node = "*"

This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.

Method ops has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
Open

  def ops
    invars = params[:id].split(",", 2)
    if invars.length == 1
      rsc = invars[0]
      node = "*"
Severity: Minor
Found in hawk/app/controllers/cib_controller.rb - About 2 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

Cyclomatic complexity for ops is too high. [9/6]
Open

  def ops
    invars = params[:id].split(",", 2)
    if invars.length == 1
      rsc = invars[0]
      node = "*"

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.

Perceived complexity for ops is too high. [10/7]
Open

  def ops
    invars = params[:id].split(",", 2)
    if invars.length == 1
      rsc = invars[0]
      node = "*"

This cop tries to produce a complexity score that's a measure of the complexity the reader experiences when looking at a method. For that reason it considers when nodes as something that doesn't add as much complexity as an if or a &&. Except if it's one of those special case/when constructs where there's no expression after case. Then the cop treats it as an if/elsif/elsif... and lets all the when nodes count. In contrast to the CyclomaticComplexity cop, this cop considers else nodes as adding complexity.

Example:

def my_method                   # 1
  if cond                       # 1
    case var                    # 2 (0.8 + 4 * 0.2, rounded)
    when 1 then func_one
    when 2 then func_two
    when 3 then func_three
    when 4..10 then func_other
    end
  else                          # 1
    do_something until a && b   # 2
  end                           # ===
end                             # 7 complexity points

Method ops has 38 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  def ops
    invars = params[:id].split(",", 2)
    if invars.length == 1
      rsc = invars[0]
      node = "*"
Severity: Minor
Found in hawk/app/controllers/cib_controller.rb - About 1 hr to fix

    Method show has 27 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      def show
        respond_to do |format|
          format.html
          format.json do
            render json: current_cib.status()
    Severity: Minor
    Found in hawk/app/controllers/cib_controller.rb - About 1 hr to fix

      Similar blocks of code found in 6 locations. Consider refactoring.
      Open

        rescue ArgumentError => e
          respond_to do |format|
            format.json do
              render json: { errors: [e.message] }, status: :not_found
            end
      Severity: Minor
      Found in hawk/app/controllers/cib_controller.rb and 5 other locations - About 20 mins to fix
      hawk/app/controllers/cib_controller.rb on lines 25..39
      hawk/app/controllers/cib_controller.rb on lines 32..39
      hawk/app/controllers/configs_controller.rb on lines 39..60
      hawk/app/controllers/configs_controller.rb on lines 46..60
      hawk/app/controllers/configs_controller.rb on lines 53..60

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

      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

      Similar blocks of code found in 6 locations. Consider refactoring.
      Open

        rescue SecurityError => e
          respond_to do |format|
            format.json do
              render json: { errors: [e.message] }, status: :forbidden
            end
      Severity: Minor
      Found in hawk/app/controllers/cib_controller.rb and 5 other locations - About 20 mins to fix
      hawk/app/controllers/cib_controller.rb on lines 18..39
      hawk/app/controllers/cib_controller.rb on lines 32..39
      hawk/app/controllers/configs_controller.rb on lines 39..60
      hawk/app/controllers/configs_controller.rb on lines 46..60
      hawk/app/controllers/configs_controller.rb on lines 53..60

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

      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

      Similar blocks of code found in 6 locations. Consider refactoring.
      Open

        rescue RuntimeError => e
          respond_to do |format|
            format.json do
              render json: { errors: [e.message] }, status: :internal_server_error
            end
      Severity: Minor
      Found in hawk/app/controllers/cib_controller.rb and 5 other locations - About 20 mins to fix
      hawk/app/controllers/cib_controller.rb on lines 18..39
      hawk/app/controllers/cib_controller.rb on lines 25..39
      hawk/app/controllers/configs_controller.rb on lines 39..60
      hawk/app/controllers/configs_controller.rb on lines 46..60
      hawk/app/controllers/configs_controller.rb on lines 53..60

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

      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

      Do not use parentheses for method calls with no arguments.
      Open

              render json: current_cib.status()

      This cop checks for unwanted parentheses in parameterless method calls.

      Example:

      # bad
      object.some_method()
      
      # good
      object.some_method

      Favor a normal unless-statement over a modifier clause in a multiline statement.
      Open

            info[:children].each do |child|
              ret.concat related(child[:id])
            end unless info[:children].nil?

      Checks for uses of if/unless modifiers with multiple-lines bodies.

      Example:

      # bad
      {
        result: 'this should not happen'
      } unless cond
      
      # good
      { result: 'ok' } if cond

      There are no issues that match your filters.

      Category
      Status