Sign upLogin

cyberark/conjur-api-ruby

View on GitHub
Star
lib/conjur/cache.rb

Summary

Maintainability
A
0 mins
Test Coverage
A
90%

Conjur declares the class variable '@@cache'
Open

    @@cache = BaseCache.new

    # Sets the global cache. It should implement +fetch_:method+ methods.
    # The easy way to accomplish this is to extend BaseCache.
    def cache= cache
Severity: Minor
Found in lib/conjur/cache.rb by reek

Class variables form part of the global runtime state, and as such make it easy for one part of the system to accidentally or inadvertently depend on another part of the system. So the system becomes more prone to problems where changing something over here breaks something over there. In particular, class variables can make it hard to set up tests (because the context of the test includes all global state).

For a detailed explanation, check out this article

Example

Given

class Dummy
  @@class_variable = :whatever
end

Reek would emit the following warning:

reek test.rb

test.rb -- 1 warning:
  [2]:Dummy declares the class variable @@class_variable (ClassVariable)

Getting rid of the smell

You can use class-instance variable to mitigate the problem (as also suggested in the linked article above):

class Dummy
  @class_variable = :whatever
end

Conjur has no descriptive comment
Open

module Conjur
Severity: Minor
Found in lib/conjur/cache.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::BaseCache#fetch_attributes has unused parameter 'cache_key'
Open

    def fetch_attributes cache_key, &block
Severity: Minor
Found in lib/conjur/cache.rb by reek

Unused Parameter refers to methods with parameters that are unused in scope of the method.

Having unused parameters in a method is code smell because leaving dead code in a method can never improve the method and it makes the code confusing to read.

Example

Given:

class Klass
  def unused_parameters(x,y,z)
    puts x,y # but not z
  end
end

Reek would emit the following warning:

[2]:Klass#unused_parameters has unused parameter 'z' (UnusedParameters)

There are no issues that match your filters.

Category
Status