Class: Uniword::Accessibility::Rules::DocumentTitleRule

Inherits:
AccessibilityRule show all
Defined in:
lib/uniword/accessibility/rules/document_title_rule.rb

Overview

Document Title Rule - WCAG 2.4.2 Page Titled

Responsibility: Check that document has a descriptive title Single Responsibility: Document title validation only

WCAG 2.4.2 Level A: Pages must have titles that describe topic or purpose

Instance Attribute Summary

Attributes inherited from AccessibilityRule

#config, #level, #rule_id, #wcag_criterion

Instance Method Summary collapse

Methods inherited from AccessibilityRule

#enabled?, #initialize

Constructor Details

This class inherits a constructor from Uniword::Accessibility::AccessibilityRule

Instance Method Details

#check(document) ⇒ Array<AccessibilityViolation>

Check document title

Parameters:

  • document (Document) —

    Document to check

Returns:



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/uniword/accessibility/rules/document_title_rule.rb', line 17

def check(document)
  violations = []

  title = extract_title(document)

  # Check if title exists
  if @config[:require_title] && (title.nil? || title.strip.empty?)
    violations << create_violation(
      message: "Document missing title",
      element: document,
      severity: @config[:severity] || :error,
      suggestion: @config[:suggestion] ||
        "Document must have a descriptive title",
    )
    return violations
  end

  # Check minimum title length
  if title && @config[:min_title_length] && (title.length < @config[:min_title_length])
    violations << create_violation(
      message: "Document title too short (#{title.length} chars)",
      element: document,
      severity: :warning,
      suggestion: "Title should be descriptive (min #{@config[:min_title_length]} chars)",
    )
  end

  violations
end