Class: Uniword::Validation::Rules::ThemeCompletenessRule

Inherits:
Base
  • Object
show all
Defined in:
lib/uniword/validation/rules/theme_completeness_rule.rb

Overview

Validates theme fmtScheme has minimum required content.

DOC-102: fmtScheme style lists must have minimum element counts Validity rule: R3

Constant Summary collapse

A_NS = 
"http://schemas.openxmlformats.org/drawingml/2006/main"
MINIMUM_COUNTS = 
{
  "fillStyleLst" => 2,
  "lnStyleLst" => 3,
  "effectStyleLst" => 3,
  "bgFillStyleLst" => 2,
}.freeze

Instance Method Summary collapse

Instance Method Details

#applicable?(context) ⇒ Boolean

Returns:

  • (Boolean) 


28
29
30
 
# File 'lib/uniword/validation/rules/theme_completeness_rule.rb', line 28

def applicable?(context)
  context.part_exists?("word/theme/theme1.xml")
end

#category ⇒ Object 



25
 
# File 'lib/uniword/validation/rules/theme_completeness_rule.rb', line 25

def category = :theme

#check(context) ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/uniword/validation/rules/theme_completeness_rule.rb', line 32

def check(context)
  issues = []
  doc = context.part("word/theme/theme1.xml")
  return issues unless doc

  fmt = doc.root.at_xpath(".//a:fmtScheme", "a" => A_NS)
  unless fmt
    issues << issue(
      "Theme missing <a:fmtScheme> element",
      part: "word/theme/theme1.xml",
    )
    return issues
  end

  MINIMUM_COUNTS.each do |list_name, minimum|
    list = fmt.at_xpath("a:#{list_name}", "a" => A_NS)
    unless list
      issues << issue(
        "Theme fmtScheme missing <a:#{list_name}> element",
        part: "word/theme/theme1.xml",
      )
      next
    end

    count = list.children.select(&:element?).count
    next if count >= minimum

    issues << issue(
      "Theme <a:#{list_name}> has #{count} elements, " \
      "minimum #{minimum} required",
      part: "word/theme/theme1.xml",
      suggestion: "Add #{minimum - count} more elements to <a:#{list_name}>.",
    )
  end

  issues
end

#code ⇒ Object 



22
 
# File 'lib/uniword/validation/rules/theme_completeness_rule.rb', line 22

def code = "DOC-102"

#description ⇒ Object 



24
 
# File 'lib/uniword/validation/rules/theme_completeness_rule.rb', line 24

def description = "Theme fmtScheme must have minimum content in each style list"

#severity ⇒ Object 



26
 
# File 'lib/uniword/validation/rules/theme_completeness_rule.rb', line 26

def severity = "error"

#validity_rule ⇒ Object 



23
 
# File 'lib/uniword/validation/rules/theme_completeness_rule.rb', line 23

def validity_rule = "R3"