[MGNLUI-5283] Possible renaming of some DS definitions Created: 12/Jul/19  Updated: 05/Mar/21  Resolved: 05/Mar/21

Status: Closed
Project: Magnolia UI
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Neutral
Reporter: Ashraf Khamis Assignee: Aleksandr Pchelintcev
Resolution: Won't Fix Votes: 0
Labels: Datasource, content-app, new-UI-framework, new-data-binding
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Documentation update required:
Yes
Date of First Response:
Epic Link: UI framework: basic features
Sprint: later

 Description   

Right now, we have the following content app implementations that use data source definition where we appear to switch between the singular and plural forms of the data source names across fully qualified class names, component section IDs and component implementations:

Notification data source

  • <id>datasource-notifications</id>
  • <implementation>info.magnolia.admincentral.apps.notifications.*Notification*PropertySetFactory</implementation>
  • <implementation>info.magnolia.admincentral.apps.notifications.*Notification*ItemResolver</implementation>
  • <implementation>info.magnolia.admincentral.apps.notifications.*Notification*StatusBar</implementation>
  • <implementation>info.magnolia.admincentral.apps.notifications.*Notification*ListPresenter</implementation>
  • info.magnolia.admincentral.apps.notifications.*Notification*DataSourceDefinition

Tasks data source

  • <id>datasource-tasks</id>
  • <implementation>info.magnolia.task.app.*Tasks*PropertySetFactory</implementation>
  • <implementation>info.magnolia.task.app.*Tasks*ItemResolver</implementation>
  • <implementation>info.magnolia.task.app.*Tasks*StatusBar</implementation>
  • <implementation>info.magnolia.task.app.*Task*ListPresenter</implementation>
  • info.magnolia.task.app.*Tasks*DataSourceDefinition

Definitions data source

  • <id>datasource-definitions</id>
  • <implementation>info.magnolia.definitions.app.data.*Definition*ItemResolver</implementation>
  • <implementation>info.magnolia.definitions.app.data.*Definition*StatusBar</implementation>
  • <implementation>info.magnolia.definitions.app.overview.tree.*Definitions*TreePresenter</implementation>

Possible solution:

To achieve consistency, we either pluralize them all (Notifications, Tasks and Definitions) to bring them in line with their app names (Notifications app, Tasks app and Definitions app) or we singularize them all (Notification, Task and Definition) to bring them in line with other data source names (option list data source, enum data source, JCR data source and registry data source).



 Comments   
Comment by Roman Kovařík [ 05/Mar/21 ]

Closing this as at this late state of the framework it would require a lot of deprecation and referencing, possibly making the code even more cluttered.

Generated at Mon Feb 12 09:25:00 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.