Module: CleoQualityReview::Checks

Defined in:
lib/cleo_quality_review/checks.rb,
lib/cleo_quality_review/checks/flog.rb,
lib/cleo_quality_review/checks/reek.rb,
lib/cleo_quality_review/checks/debride.rb,
lib/cleo_quality_review/checks/fasterer.rb,
lib/cleo_quality_review/checks/registry.rb,
lib/cleo_quality_review/checks/quality_check.rb

Overview

Namespace for bundled quality check implementations.

Defined Under Namespace

Classes: CheckOutput, Debride, Fasterer, Flog, QualityCheck, Reek, Registry

Class Method Summary collapse

Class Method Details

.register(tool_name, tool_class, tool_type:) ⇒ nil

Register a new check for use

Parameters:

  • tool_name (String)
  • tool_class (Class)
  • tool_type (String, Symbol)

Returns:

  • (nil) 


21
22
23
 
# File 'lib/cleo_quality_review/checks.rb', line 21

def register(tool_name, tool_class, tool_type: )
  Registry.register(tool_name.to_s, tool_class, tool_type: tool_type.to_s)
end

.registered?(tool_name) ⇒ Boolean

Has a tool with the given name been registered?

Parameters:

  • tool_name (String)

Returns:

  • (Boolean) 


33
34
35
 
# File 'lib/cleo_quality_review/checks.rb', line 33

def registered?(tool_name)
  Registry.registered?(tool_name)
end

.resolve(tool_names) ⇒ Object 



25
26
27
 
# File 'lib/cleo_quality_review/checks.rb', line 25

def resolve(tool_names)
  Registry.resolve(Array(tool_names))
end