cyberark/conjur-api-ruby

View on GitHub
lib/conjur/api/policies.rb

Summary

Maintainability
A
0 mins
Test Coverage
A
100%

Conjur::API#load_policy has 4 parameters
Open

    def load_policy id, policy, account: Conjur.configuration.account, method: POLICY_METHOD_POST
Severity: Minor
Found in lib/conjur/api/policies.rb by reek

A Long Parameter List occurs when a method has a lot of parameters.

Example

Given

class Dummy
  def long_list(foo,bar,baz,fling,flung)
    puts foo,bar,baz,fling,flung
  end
end

Reek would report the following warning:

test.rb -- 1 warning:
  [2]:Dummy#long_list has 5 parameters (LongParameterList)

A common solution to this problem would be the introduction of parameter objects.

Conjur::API has no descriptive comment
Open

  class API
Severity: Minor
Found in lib/conjur/api/policies.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

There are no issues that match your filters.

Category
Status