Class: Yard::Lint::Validators::Documentation::TextSubstitution::Validator

Inherits:
Base
  • Object
show all
Defined in:
lib/yard/lint/validators/documentation/text_substitution/validator.rb

Overview

Validates that documentation does not contain forbidden strings. Reports every matching substitution rule on every line independently.

Instance Attribute Summary

Attributes inherited from Base

#config, #selection

Instance Method Summary collapse

Methods inherited from Base

in_process, in_process?, in_process_visibility, #initialize, validator_name

Constructor Details

This class inherits a constructor from Yard::Lint::Validators::Base

Instance Method Details

#in_process_query(object, collector) ⇒ void

This method returns an undefined value.

Parameters:



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/yard/lint/validators/documentation/text_substitution/validator.rb', line 16

def in_process_query(object, collector)
  docstring_text = object.docstring.to_s
  return if docstring_text.empty?

  substitutions = config_or_default('Substitutions')
  return if substitutions.nil? || substitutions.empty?

  violations = find_violations(docstring_text, substitutions)
  return if violations.empty?

  violations.each do |violation|
    collector.puts "#{object.file}:#{object.line}: #{object.title}"
    collector.puts violation[:forbidden]
    collector.puts violation[:replacement]
    collector.puts "#{violation[:line_offset]}|#{violation[:line_text]}"
  end
end