Components

[timwis]

This pull request involves a complete refactor of the javascript architecture. Previously, JKAN used a router-like configuration to determine page page it was on, and then executed logic for that particular page. Now JKAN looks for a list of components on any page and initializes each component class (see index.js), passing it its container element and any shared global variables. Components are configured through data-xxx="" attributes on the element (where configuration is necessary). This allows components to be reused on any page.

My hope is that this is easier to dive into and more reusable. Thoughts @pezholio @themightychris?

Might be easier to view by looking at the branch.

EDIT: I've also documented it on the Architecture wiki page.

Closes #78 and closes #85 and closes #66

[pezholio]

Ah, smart. Also makes things a lot more DRY too. I think I might've struggled with this a bit more initially - JS isn't my first language, and I think the MVC-ish nature of the router approach meant it made sense to me. That said, if this was documented, I'd be able to dive into this easily 👍

[timwis]

Thanks @pezholio - I just took a stab at documenting it in the wiki.

[timwis]

Pinging @JJediny @abhinemani @Floppy as other folks who've dove into JKAN's code base. Do you also feel this makes sense? Any reason not to merge?

[themightychris]

Some docs outlining what the runtime flow is and how a developer would find where the code for something is and how to add components would be a great help, reading the code only have me a partial fuzzy picture of it. I wouldn't hold off merging for that though it's not a regression over what was before

[timwis]

@themightychris did you see this?
https://github.com/timwis/jkan/wiki/Architecture

[themightychris]

I did not, that's perfect! (and as a side note I'm a proponent of versioning docs alongside the code they document so it's never fuzzy what versions of docs and code go together)

[JJediny]

After taking a look at the file changes/wiki/thread i see no reason not to pull. The more abstracted the JS is from Jekyll the easier it will be to reuse components else where so +1...

Without knowing the full effect, is there any functionality lost?

[timwis]

Thanks for the feedback guys. and @JJediny nope, no functionality lost.