Change MELD graph traversal key names blackList/whiteList

oerc-music / meld-testing-ssi3

Testing framework for MELD, developed as part of SSI3 project for exploring development of sustainable software for digital humanities research.

BSD 3-Clause "New" or "Revised" License

1 stars 0 forks source link

Change MELD graph traversal key names blackList/whiteList #1

Open gklyne opened 4 years ago

gklyne commented 4 years ago

Changing names of blackList/whiteList in meld core codebase (dev branch), as these have unfortunate connotations for some.

E.g. use:

Plan:

[x] propose new names; e.g. followProperties / ignoreProperties
[ ] discuss new name choices with team
[ ] apply name changes to codebase
[ ] see if anything breaks

Ideally, this would be done with a test suite in place, but discussions indicate that the name change needs to be done sooner rather than later, so we may just have to push ahead.

gklyne commented 3 years ago

I'm proposing the following name changes:

- objectPrefixWhitelist    -> expandObjectPrefix
- objectUriWhitelist       -> expandObjectUri
- objectTypeWhitelist      -> expandObjectType
- objectPrefixBlacklist    -> ignoreObjectPrefix
- objectUriBlacklist       -> ignoreObjectUri
- objectTypeBlacklist      -> ignoreObjectType
- propertyPrefixWhitelist  -> followPropertyPrefix
- propertyUriWhitelist     -> followPropertyUri
- propertyPrefixBlacklist  -> ignorePpropertyPrefix
- propertyUriBlacklist     -> ignorePropertyUri

gklyne commented 3 years ago

Comment received from @musicog (via Slack):

I would be careful with "expand" since its meaning is overloaded in jsonld-world. Maybe "include"? "fetch"? (both of those are overloaded in more general javascript as well, of course...)

gklyne commented 3 years ago

Proposing "extend" instead of "expand".

(Work-in-progress PR at https://github.com/oerc-music/meld-clients-core/pull/16)