Sign upLogin

cyberark/conjur-api-ruby

View on GitHub
Star
lib/conjur/build_object.rb

Summary

Maintainability
A
0 mins
Test Coverage
A
100%

Conjur::BuildObject has no descriptive comment
Open

  module BuildObject
Severity: Minor
Found in lib/conjur/build_object.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

Conjur::BuildObject::ClassMethods has no descriptive comment
Open

    module ClassMethods
Severity: Minor
Found in lib/conjur/build_object.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

Conjur::BuildObject::ClassMethods#find_class doesn't depend on instance state (maybe move it to another class?)
Open

      def find_class class_name, default_class
Severity: Minor
Found in lib/conjur/build_object.rb by reek

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

There are no issues that match your filters.

Category
Status