Modify privacy level of information within a Ruleset

[hayfield]

A function and variable were public properties of a Ruleset when they didn't need to be.

The variable was something that could become inconsistent with the rules attribute.
The function acted on this variable in a manner that shouldn't ever need doing outside Ruleset initialisation.

This also documents the attribute that a Ruleset has.

This came about in the writing up of #245 to determine the information required to determine Ruleset equality.

[dalepotter]

Is there a use case for a user to validate a custom ruleset against the schema? How are we suggesting this is done? Check before using the json string to instantiate a ruleset?

[dalepotter]

See comment above...

[hayfield]

Is there a use case for a user to validate a custom ruleset against the schema? How are we suggesting this is done?

Try and instantiate a Ruleset from a string. If it instantiates all is good.

Validating a string against the Ruleset Schema by calling a function on a random instance of the Ruleset class seems... very odd.

[hayfield]

OR (if you want to do things raw)

import json
import jsonschema
import iati.default
import iati.utilites
json.loads(ruleset_str, object_pairs_hook=iati.utilities.dict_raise_on_duplicates)
jsonschema.validate(self.ruleset, iati.default.ruleset_schema())

[dalepotter]

Validating a string against the Ruleset Schema by calling a function on a random instance of the Ruleset class seems... very odd.

Fair enough - so... just testing this: I was expecting a ValueError('The provided Ruleset does not validate against the Ruleset Schema') when I ran this:

>>> import iati
>>> iati.Ruleset('{"json": "test"}')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/Users/dalepotter/Documents/iati.core/iati/rulesets.py", line 87, in __init__
    self._set_rules(ruleset_dict)
  File "/Users/dalepotter/Documents/iati.core/iati/rulesets.py", line 139, in _set_rules
    for rule_type, cases in rule.items():
AttributeError: 'list' object has no attribute 'items'

[hayfield]

That looks like a bug!

[hayfield]

It's a bug with the Ruleset Schema.

It would be expected that a Ruleset is in the format:

{
    "xpath": {
        "dictionary": "of values"
    }
}

As it is, however, the Ruleset Schema does not specify that a Ruleset must be a dictionary of dictionaries. The following is therefore valid:

{
    "xpath": "some random string"
}

This can be fixed by updating patternProperties in the Ruleset Schema to read:

"patternProperties": {
        ".+": {
                "type": "object",
                "properties": {
                        [...]
                }
        }
}

ie. add "type": "object",