Class: DocGuard::AssessDocumentationRelevance::Process

Inherits:
Object
  • Object
show all
Defined in:
lib/doc_guard/assess_documentation_relevance/process.rb

Overview

Main orchestration class that assesses whether documentation is still relevant based on digests of referenced files.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: ::DocGuard::Config.new) ⇒ Process

Initializes the process with the given configuration.

Parameters:



19
20
21
 
# File 'lib/doc_guard/assess_documentation_relevance/process.rb', line 19

def initialize(config: ::DocGuard::Config.new)
  @config = config
end

Class Method Details

.run(config: ::DocGuard::Config.new) ⇒ void

This method returns an undefined value.

Entry point to run the relevance assessment process.

Parameters:

  • config (DocGuard::Config) (defaults to: ::DocGuard::Config.new) —

    Optional configuration.



12
13
14
 
# File 'lib/doc_guard/assess_documentation_relevance/process.rb', line 12

def self.run(config: ::DocGuard::Config.new)
  new(config: config).call
end

Instance Method Details

#call ⇒ void

This method returns an undefined value.

Executes the full relevance assessment pipeline.



26
27
28
29
30
31
32
33
34
 
# File 'lib/doc_guard/assess_documentation_relevance/process.rb', line 26

def call
  tracked_files = load_tracked_files
  stored_digests = load_stored_digests
  current_digests = calculate_current_digests(tracked_files)
  mismatches = compare_digests(stored_digests, current_digests)
  assessment = assess_relevance(tracked_files, mismatches)

  report_assessment(assessment)
end