Moving the component sources to own Java packages

[lfryc]

I have refactored all component related sources to respective packages.

Right now we have separated those under single package org.richfaces.ui where each logical group has its own subpackage:

https://github.com/richfaces/richfaces5/tree/bab225acc9ef7dd7b64f01c565c69c36a8d7b707/framework/src/main/java/org/richfaces/ui

----

The problem I can see now is the number of source files which are in these group packages:

For example:

• ui.ajax -> 52 sources https://github.com/richfaces/richfaces5/tree/bab225acc9ef7dd7b64f01c565c69c36a8d7b707/framework/src/main/java/org/richfaces/ui/ajax
• ui.input -> 45 sources https://github.com/richfaces/richfaces5/tree/bab225acc9ef7dd7b64f01c565c69c36a8d7b707/framework/src/main/java/org/richfaces/ui/input
• ui.output -> 55 sources https://github.com/richfaces/richfaces5/tree/bab225acc9ef7dd7b64f01c565c69c36a8d7b707/framework/src/main/java/org/richfaces/ui/output
• ui.iteration -> 105 sources https://github.com/richfaces/richfaces5/tree/bab225acc9ef7dd7b64f01c565c69c36a8d7b707/framework/src/main/java/org/richfaces/ui/iteration

This is quite scary, you can try it yourself how it is possible to browser this hierarchy.

----

What we want to achieve ideally:

• users wants
  • no future changes of package structure [so that they can consider that as API]
    • => as we do it now, it will stick forever
• contributors wants
  • dive easily into component sources [so that they have clear mapping between the component and its sources]
    • => all relevant sources together (shared impl in ui.common/utils)

----

Options:

1. Diverge some more obvious logical groups

ui.toggleable
ui.tree
...

The disadvantage of this principle is that we doesn't have to elimiate the issue completely - e.g. tables are still in the ui.iteration, and they have lot of sources.

2. Move the component sources to packages called by component name

ui.ajax
ui.dataTable
ui.extendedDataTable

This is the option which is most accessible to contributors - in order to see a source code of a component, one needs to enter org.richfaces.ui and he see (almost) all relevant sources.

The problem is with number of packages - this way we will end up with ~80 packages (per component).

3. Structure the ui.group sub-packages

ui.core.ajax
ui.iteration.dataTable
ui.iteration.extendedDataTable

This is the combination of previous concepts, which is not so obvious for contributors (in which group is my component located?),

but it keeps balance of complexity and number of packages.

[lfryc]

Btw here is how the flat package list might look in a case of "(2) package per component": https://github.com/richfaces/qa/tree/master/metamer/application/src/main/webapp/components

Some might be collapsed into one obviously: panelMenu -> panelMenu, panelMenuItem, panelMenuGroup

[bleathem]

The direction we were headed with the ui factoring was package-per-comopnent, with comopnent packages collected by family.  We stopped with the package-per-family setup, as it was only really the iteration family package that was oversized.

The problem I see with 2) (ommitting the family parent-package) is where to put the shared classes.  Select comopnents for instance share a lot of parent and helper classes.

If we want to pursue this (and keep in mind we don't have to have the API finalized for 5.0.0.Alpha1) then I'd suggest taking the current family-based packages and subdividing them into component based packaes (still under the family package), with shared code located in the family package itself.

Brian

[lfryc]

Yeah, that's what I see as most appropriate as well.

[lfryc]

The "fresh" feel of refactored packages...

• ui.ajax  https://github.com/richfaces/richfaces5/tree/RF-12900-package-structure/framework/src/main/java/org/richfaces/ui/ajax
• ui.input https://github.com/richfaces/richfaces5/tree/RF-12900-package-structure/framework/src/main/java/org/richfaces/ui/input
• ui.output https://github.com/richfaces/richfaces5/tree/RF-12900-package-structure/framework/src/main/java/org/richfaces/ui/output
• ui.iteration https://github.com/richfaces/richfaces5/tree/RF-12900-package-structure/framework/src/main/java/org/richfaces/ui/iteration