orange-cloudfoundry/cf-ops-automation

View on GitHub
lib/tasks/bosh/executor.rb

Summary

Maintainability
A
0 mins
Test Coverage
B
87%

Tasks::Bosh::Executor#rows is controlled by argument 'table'
Open

          table&.dig('Tables')&.first&.dig('Rows') || []
Severity: Minor
Found in lib/tasks/bosh/executor.rb by reek

Control Parameter is a special case of Control Couple

Example

A simple example would be the "quoted" parameter in the following method:

def write(quoted)
  if quoted
    write_quoted @value
  else
    write_unquoted @value
  end
end

Fixing those problems is out of the scope of this document but an easy solution could be to remove the "write" method alltogether and to move the calls to "writequoted" / "writeunquoted" in the initial caller of "write".

Tasks::Bosh::EnvVarMissing has no descriptive comment
Open

    class EnvVarMissing < RuntimeError; end
Severity: Minor
Found in lib/tasks/bosh/executor.rb by reek

Classes and modules are the units of reuse and release. It is therefore considered good practice to annotate every class and module with a brief comment outlining its responsibilities.

Example

Given

class Dummy
  # Do things...
end

Reek would emit the following warning:

test.rb -- 1 warning:
  [1]:Dummy has no descriptive comment (IrresponsibleModule)

Fixing this is simple - just an explaining comment:

# The Dummy class is responsible for ...
class Dummy
  # Do things...
end

Tasks::Bosh has no descriptive comment
Open

  module Bosh
Severity: Minor
Found in lib/tasks/bosh/executor.rb by reek

Classes and modules are the units of reuse and release. It is therefore considered good practice to annotate every class and module with a brief comment outlining its responsibilities.

Example

Given

class Dummy
  # Do things...
end

Reek would emit the following warning:

test.rb -- 1 warning:
  [1]:Dummy has no descriptive comment (IrresponsibleModule)

Fixing this is simple - just an explaining comment:

# The Dummy class is responsible for ...
class Dummy
  # Do things...
end

Tasks::Bosh::BoshCliError has no descriptive comment
Open

    class BoshCliError < RuntimeError; end
Severity: Minor
Found in lib/tasks/bosh/executor.rb by reek

Classes and modules are the units of reuse and release. It is therefore considered good practice to annotate every class and module with a brief comment outlining its responsibilities.

Example

Given

class Dummy
  # Do things...
end

Reek would emit the following warning:

test.rb -- 1 warning:
  [1]:Dummy has no descriptive comment (IrresponsibleModule)

Fixing this is simple - just an explaining comment:

# The Dummy class is responsible for ...
class Dummy
  # Do things...
end

Tasks::Bosh::Executor#handle_bosh_cli_response performs a nil-check
Open

          raise BoshCliError, "Stderr:\n#{stderr}\nStdout:\n#{stdout}" if (!stderr.nil? && !stderr.empty?) || status.exitstatus != 0
Severity: Minor
Found in lib/tasks/bosh/executor.rb by reek

A NilCheck is a type check. Failures of NilCheck violate the "tell, don't ask" principle.

Additionally, type checks often mask bigger problems in your source code like not using OOP and / or polymorphism when you should.

Example

Given

class Klass
  def nil_checker(argument)
    if argument.nil?
      puts "argument isn't nil!"
    end
  end
end

Reek would emit the following warning:

test.rb -- 1 warning:
  [3]:Klass#nil_checker performs a nil-check. (NilCheck)

There are no issues that match your filters.

Category
Status