Class: Uniword::Lint::Engine

Inherits:

Object

• Object
• Uniword::Lint::Engine

Defined in:

lib/uniword/lint/engine.rb

Overview

Walks the document with each rule and aggregates findings.

Instance Method Summary

• #initialize(document:, ruleset:) ⇒ Engine constructor

  A new instance of Engine.

• #run ⇒ Result

Constructor Details

#initialize(document:, ruleset:) ⇒ Engine

Returns a new instance of Engine.

Parameters:

• document (Wordprocessingml::DocumentRoot)
• ruleset (Ruleset, Array<Rule>) —

  rules to apply

# File 'lib/uniword/lint/engine.rb', line 9

def initialize(document:, ruleset:)
  @document = document
  @ruleset = wrap_ruleset(ruleset)
end

Instance Method Details

#run ⇒ Result

Returns:

• (Result)

# File 'lib/uniword/lint/engine.rb', line 15

def run
  result = Result.new
  @ruleset.rules.each do |rule|
    rule.check(@document) { |finding| result.add(finding) }
  end
  result
end