Reduce code-duplication and make sure no duplicated code is written

Zomis / Games

Many kinds of games, playable in both multiplayer or local play. Replays, spectator mode, and AIs.

https://games.zomis.net

MIT License

17 stars 5 forks source link

Reduce code-duplication and make sure no duplicated code is written #320

Open Zomis opened 1 year ago

Zomis commented 1 year ago

Somehow I can't help but get the feeling that some features are re-invented multiple times.

I think this is because of the different approaches the project has been through:

Action-based
Gameflow
Context
(Started) Entity-Component-System

This in addition to everything related, such as:

Actions (and now also SmartActions), choices, recursive actions, and lots of other things
Event handling

More effort needs to be taken to remove old code. The question then being of course: Which approach is the right one?

Could maybe ArchUnit https://www.archunit.org/use-cases help out with structuring the project better to remove duplicates and make code easier to find?

Zomis commented 1 year ago

This is kinda like https://xkcd.com/927/ but within the same project.

Zomis commented 1 year ago

I had an idea to make all scope-interfaces inherit from some basic Scope marker interfaces:

PrimitiveScope (contains one single val or fun)
CompoundScope (inherits from multiple PrimitiveScopes, meant to be re-used)
UsageScope (for one specific use-case, typically inherits from a single CompoundScope and/or multiple PrimitiveScopes)

All these three inherit from a common Scope interface.

This can also then be asserted using ArchUnit. So far I don't regret this approach.

ArchUnit proves to be very very useful, with rules like:

All classes annotated with @GameMarker should be named *Scope
All classes named *Scope should be assignable to Scope
All classes named *Context should not be interfaces

Zomis commented 1 year ago

A sign of code duplication: I have three different games using some kind of event/trigger-system (Coup, Dungeon Mayhem, and one more which is not yet finished). I have three different implementations of an event/trigger system to be used in games.

Zomis commented 1 year ago

Some known sources of duplicated code:

TestPlays.kt / TestDsl.kt / TestImpl.kt / TestPlaySteps.kt -- these should be rewritten to use GameListeners. See also #102
GameImpl vs. GameFlowImpl
Old Actions vs. New Actions (especially SmartActions)