AEM ACS Commons - Component Design Paradigm Idea about acs-aem-commons

[justinedelson]

Could this also go in the contributing document? Something like:

Code in ACS AEM Commons must be designed for reuse and extensibility. Specifically:

• Java Code
  ** Only export necessary API
  ** Exported abstract classes should follow guidlines from http://checkstyle.sourceforge.net/config_design.html#DesignForExtension
  ** Exported non-abstract classes should generally be final
• AEM Components
  ** Make liberal use of "partial" scripts to decompose componet scripts to allow extending components to override sections of the component's HTML.
  ** Partial scripts should be in a 'partials' folder.

[justinedelson]

Regarding your questions, I don't think there's a good way to put hard-and-fast rules about what the right level of decomposition is. It's a judgement call. I'm not sure why there would be code duplication per se.

[davidjgonzalez]

Sure - but we should agree this is a good idea first and there isnt a better way to tackle the problem.

I've never done this on any "real-life" use case, since most customer components don't have the use-case of being overlayed/copy-downed.

Agree its judgement calls all the way down - but guidelines are helpful!

If each partial is responsible for rendering its content or placeholder for its content, might be a good approach, BUT you could end up w multiple placeholders for a component (ala OOTB text and image). Ill have to check if ComponentHelper has a good way of handling this use case (i really like ComponentHelper.printEditBlockOrNothing(..)).

Just trying to think of ways to avoid the entire copy/down which is ugly and (should be) unnecessary; itd be a shame for someone to need to muck around w your nice audio.jsp code!!

Either way, this approach can be applied post-release-1 without breaking anything.

[justinedelson]

Decomposition is definitely a good idea :)

[davidjgonzalez]

kk - ill try to POC/write something up around this to supplement the CONTRIBUTING doc; IME a clear example goes along way for others.

Anyhow - no immediate rush -- nice part is this is very backwards compatible.

[badvision]

IMHO, Core Components might be along the same lines. Does ACS Commons need to focus on that, or would it be more productive to have an ACS fork of core components and direct our efforts there?

[davidjgonzalez]

Closing as the new HTL + Sling Model abstraction supersedes. Some good ideas, but closing as to not confuse.