Support tokenized JSON Reference URIs

[whitlockjc]

Imagine your JSON document has i18n tokens in its JSON Reference URIs. It would be nice to be able to either pre-process a JSON Reference prior to generating its metadata via #getRefDetails/#findRefs and/or post-process the JSON Reference metadata after the fact to alter the metadata. While i18n is one example, any situation where you have dynamic URIs could benefit from this.

/cc @brettz9

[whitlockjc]

I could probably just get this done in 2.0.0. It won't hurt to push the release another day.

[brettz9]

Totally up to you... Your description looks good, though if you are implementing, I'm wondering whether your "post-process" idea involve altering the meta-data so the resolutions can immediately resume (as though the JSON reference had been well-formed in the first place). I guess I'm hoping for a "mid-process" capability to avoid repeating traversal of the JSON if that would be doable. But again, no need from my perspective to make it into this release.

[whitlockjc]

The idea of pre-processing is to do token replacement and such while post-processing might be some sort of failure recovery thing. As for "mid-process"...I'm not sure what you mean. We only process the document once every, even if you call APIs more than once. :)

[brettz9]

I just mean to avoid needing to both find all of the references once to do the variable substitution, and then searching the document again to find the fixed references to do the resolving.

[whitlockjc]

I think with pre-processing and/or post-processing, you could do it at one time.

[whitlockjc]

Well, the way I see implementing it.

[brettz9]

Ok, cool

[whitlockjc]

Let me know what you think. Here is the gist of it:

• options.refPreProcessor allows you to pre-process a JSON Reference like object prior to #isRef being called on it.
• options.refPostProcessor allows you to post-process a JSON Reference like object prior to options.filter and other filtering being ran against it

Neither of these functions modify the provided document. Feel free to look at the API documentation and tests to see how it works.

[brettz9]

Looks perfect, thanks very much!

[whitlockjc]

Do you have any time to play with the new APIs/options to give them a sanity check? Even if you just look over the API documentation that would be a huge help. If not, no biggie. I'll release tomorrow.

[brettz9]

Yeah, I looked over the docs, tests, and new code and it looks great from what I can see. (I also ran the tests which are working on my machine too.) Just don't forget the package.json and bower.json bumps before the tagged release...