Rule Linting

[JimRoepcke]

Rule Linting was added to the TextRulesToJSON program. Linting becomes a step of the .rules to .json conversion process.

• better error handling in TextRulesToJSON, support for linting added
• finds rules with obviously invalid predicates (comparing true/false using one of < <= > >=)
• set of accepted RHS questions along with their expected answer type
• set of accepted questions in LHS expressions along with their expected answer type
• check for duplicate rules (rudimentary right now due to Rule's lack of Hashable)

Test coverage needs to improve further.

Example output:

TextRulesToJSON: no fallback rule found for favouritePlayer
TextRulesToJSON: line 1: the answer for favouriteTeam rules must be one of: Capitals, Oilers, Lightning, Canucks
TextRulesToJSON: line 2: lhs question city not found in the linter file
TextRulesToJSON: line 3: lhs question city not found in the linter file
TextRulesToJSON: line 4: firstName may only be compared to one of: Jim, Cheryl, Cyan, Xavier
TextRulesToJSON: line 4: lhs question city not found in the linter file
TextRulesToJSON: line 5: invalid predicate: boolean values are not comparable
TextRulesToJSON: line 5: rhs question shouldnot not found in the linter file
TextRulesToJSON: line 5: type mismatch, firstName should be a string but it is being compared to a bool
TextRulesToJSON: line 6: invalid predicate: boolean values are not comparable
TextRulesToJSON: line 6: rhs question shouldnot not found in the linter file
TextRulesToJSON: line 7: duplicate rule found
TextRulesToJSON: line 7: invalid predicate: boolean values are not comparable
TextRulesToJSON: line 7: rhs question shouldnot not found in the linter file
TextRulesToJSON: line 8: rhs question kid not found in the linter file

This output was produced for this input:

Rules file:

0: true => favouriteTeam = X
10: (firstName = 'Jim' AND lastName = 'Roepcke') OR (city = 'Edmonton') => favouriteTeam = Oilers
10: (firstName = 'Xavier' AND lastName = 'Roepcke') OR (city = 'Tampa Bay') => favouriteTeam = Lightning
10: (firstName = 'Bob' AND lastName = 'Roepcke') OR (city = 'Tampa Bay') => favouriteTeam = Lightning
10: firstName < true => shouldnot = work
10: true < true => shouldnot = workeither
10: true < true => shouldnot = workeither
10: age < 10 => kid = true

Linter specification file:

{
  "lhs": {
    "firstName": ["Jim", "Cheryl", "Cyan", "Xavier"],
    "lastName": "string",
    "age": "int"
  },
  "rhs": {
    "favouriteTeam": ["Capitals", "Oilers", "Lightning", "Canucks"],
    "favouritePlayer": "any"
  }
}

[JimRoepcke]

The next step will be to amend the buddybuild_postclone.sh script in the core-news-shared-configs repo to clone, build and run the TextRulesToJSON program. I'll start on that script on Monday as well as the linter specification json file for our rules file.

[noremac]

Not sure how I've gotten this far without knowing about typeName(of:) :-)

[noremac]

"favoriteTeam"

[noremac]

👍 agreed.