Skip to content

Commit 87cebc0

Browse files
GhostTypesGhostTypes
committed
refactor: Apply DRY principles across codebase
Comprehensive refactoring to eliminate code duplication and improve maintainability following DRY (Don't Repeat Yourself) principles. Changes: - Extract search logic into AddonSearchUtil (removes 4 duplicate loops) - Create reusable WAddonList widget (eliminates ~50 lines of duplication) - Extract HTTP response handling in HttpClient (3 methods now use shared logic) - Add getFirstNonEmpty() helper in AddonMetadata (4 methods refactored) - Extract feature list rendering in AddonDetailScreen (40 lines reduced to helper) New files: - util/AddonSearchUtil.java: Centralized addon search functionality - gui/widgets/WAddonList.java: Reusable vertical list widget with separators Benefits: - ~150 lines of duplicate code eliminated - Better separation of concerns (GUI vs. logic) - Easier to maintain and extend - Zero behavioral changes - all existing functionality preserved Updated README.md to reflect new project structure.
1 parent 58144e4 commit 87cebc0

8 files changed

Lines changed: 283 additions & 221 deletions

File tree

‎README.md‎

Lines changed: 34 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -21,32 +21,40 @@ To build the project locally:
2121

2222
<div align="center">
2323

24-
## Structure
25-
26-
</div>
27-
28-
```
29-
src/main/java/com/cope/meteoraddons/
30-
├── MeteorAddonsAddon.java # Main addon entry point
31-
├── addons/
32-
│ ├── Addon.java # Abstract addon class
33-
│ ├── InstalledAddon.java # Represents a locally installed addon
34-
│ └── OnlineAddon.java # Represents an addon available online
35-
├── gui/
36-
│ ├── screens/ # Custom screens
37-
│ ├── tabs/
38-
│ │ └── AddonsTab.java # GUI tab for addon browser
39-
│ └── widgets/ # Custom widgets
40-
├── models/
41-
│ └── AddonMetadata.java # Data model for addon metadata
42-
├── systems/
43-
│ └── AddonManager.java # System for managing addon state
44-
└── util/
45-
├── AddonIconTexture.java # Helper for loading addon icons
46-
├── HttpClient.java # HTTP client wrapper
47-
├── IconCache.java # Caching system for icons
48-
└── VersionUtil.java # Utility for version comparison
49-
```
24+
## Project Structure
25+
26+
</div>
27+
28+
```
29+
src/main/java/com/cope/meteoraddons/
30+
├── MeteorAddonsAddon.java # Main addon entry point
31+
├── addons/
32+
│ ├── Addon.java # Abstract addon class
33+
│ ├── InstalledAddon.java # Represents a locally installed addon
34+
│ └── OnlineAddon.java # Represents an addon available online
35+
├── config/
36+
│ └── IconSizeConfig.java # Icon size configuration
37+
├── gui/
38+
│ ├── screens/
39+
│ │ ├── AddonDetailScreen.java # Screen showing details of an addon
40+
│ │ ├── BrowseAddonsScreen.java # Screen for browsing online addons
41+
│ │ └── InstalledAddonsScreen.java # Screen for managing installed addons
42+
│ ├── tabs/
43+
│ │ └── AddonsTab.java # GUI tab for addon browser
44+
│ └── widgets/
45+
│ ├── WAddonCard.java # Widget for displaying an addon in a grid
46+
│ └── WAddonListItem.java # Widget for displaying an addon in a list
47+
├── models/
48+
│ └── AddonMetadata.java # Data model for addon metadata
49+
├── systems/
50+
│ ├── AddonManager.java # System for managing addon state
51+
│ └── IconPreloadSystem.java # System for async icon loading
52+
└── util/
53+
├── HttpClient.java # HTTP client wrapper
54+
├── IconCache.java # Caching system for icons
55+
├── TimeUtil.java # Time utility functions
56+
└── VersionUtil.java # Utility for version comparison
57+
```
5058

5159
<div align="center">
5260

‎src/main/java/com/cope/meteoraddons/gui/screens/AddonDetailScreen.java‎

Lines changed: 43 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -99,48 +99,14 @@ public void initWidgets() {
9999
}
100100

101101
// Features Section
102-
if (metadata.features != null) {
103-
boolean hasFeatures = (metadata.features.modules != null && !metadata.features.modules.isEmpty()) ||
104-
(metadata.features.commands != null && !metadata.features.commands.isEmpty()) ||
105-
(metadata.features.hud_elements != null && !metadata.features.hud_elements.isEmpty()) ||
106-
(metadata.features.custom_screens != null && !metadata.features.custom_screens.isEmpty());
107-
108-
if (hasFeatures) {
109-
WSection featuresSection = add(theme.section("Features", true)).expandX().widget();
110-
111-
boolean first = true;
112-
113-
if (metadata.features.modules != null && !metadata.features.modules.isEmpty()) {
114-
featuresSection.add(theme.label("Modules (" + metadata.features.modules.size() + "):"));
115-
String modulesStr = String.join(", ", metadata.features.modules);
116-
featuresSection.add(theme.label(modulesStr, getWindowWidth() / 2.0).color(theme.textSecondaryColor()));
117-
first = false;
118-
}
119-
120-
if (metadata.features.commands != null && !metadata.features.commands.isEmpty()) {
121-
if (!first) featuresSection.add(theme.horizontalSeparator()).expandX();
122-
featuresSection.add(theme.label("Commands (" + metadata.features.commands.size() + "):"));
123-
String cmdStr = String.join(", ", metadata.features.commands);
124-
featuresSection.add(theme.label(cmdStr, getWindowWidth() / 2.0).color(theme.textSecondaryColor()));
125-
first = false;
126-
}
127-
128-
if (metadata.features.hud_elements != null && !metadata.features.hud_elements.isEmpty()) {
129-
if (!first) featuresSection.add(theme.horizontalSeparator()).expandX();
130-
featuresSection.add(theme.label("HUD (" + metadata.features.hud_elements.size() + "):"));
131-
String hudStr = String.join(", ", metadata.features.hud_elements);
132-
featuresSection.add(theme.label(hudStr, getWindowWidth() / 2.0).color(theme.textSecondaryColor()));
133-
first = false;
134-
}
135-
136-
if (metadata.features.custom_screens != null && !metadata.features.custom_screens.isEmpty()) {
137-
if (!first) featuresSection.add(theme.horizontalSeparator()).expandX();
138-
featuresSection.add(theme.label("Screens (" + metadata.features.custom_screens.size() + "):"));
139-
String screensStr = String.join(", ", metadata.features.custom_screens);
140-
featuresSection.add(theme.label(screensStr, getWindowWidth() / 2.0).color(theme.textSecondaryColor()));
141-
first = false;
142-
}
143-
}
102+
if (metadata.features != null && hasAnyFeatures(metadata.features)) {
103+
WSection featuresSection = add(theme.section("Features", true)).expandX().widget();
104+
105+
boolean needsSeparator = false;
106+
needsSeparator = addFeatureList(featuresSection, "Modules", metadata.features.modules, needsSeparator) || needsSeparator;
107+
needsSeparator = addFeatureList(featuresSection, "Commands", metadata.features.commands, needsSeparator) || needsSeparator;
108+
needsSeparator = addFeatureList(featuresSection, "HUD", metadata.features.hud_elements, needsSeparator) || needsSeparator;
109+
addFeatureList(featuresSection, "Screens", metadata.features.custom_screens, needsSeparator);
144110
}
145111
}
146112

@@ -188,4 +154,39 @@ public void initWidgets() {
188154
WButton backButton = actions.add(theme.button("Back")).widget();
189155
backButton.action = () -> mc.setScreen(parent);
190156
}
157+
158+
/**
159+
* Check if metadata has any non-empty feature lists.
160+
*/
161+
private boolean hasAnyFeatures(AddonMetadata.Features features) {
162+
return (features.modules != null && !features.modules.isEmpty()) ||
163+
(features.commands != null && !features.commands.isEmpty()) ||
164+
(features.hud_elements != null && !features.hud_elements.isEmpty()) ||
165+
(features.custom_screens != null && !features.custom_screens.isEmpty());
166+
}
167+
168+
/**
169+
* Add a feature list to the section if items are present.
170+
*
171+
* @param section The section to add to
172+
* @param label The feature type label (e.g., "Modules", "Commands")
173+
* @param items The list of feature names
174+
* @param addSeparator Whether to add a separator before this feature group
175+
* @return true if items were added, false otherwise
176+
*/
177+
private boolean addFeatureList(WSection section, String label, List<String> items, boolean addSeparator) {
178+
if (items == null || items.isEmpty()) {
179+
return false;
180+
}
181+
182+
if (addSeparator) {
183+
section.add(theme.horizontalSeparator()).expandX();
184+
}
185+
186+
section.add(theme.label(label + " (" + items.size() + "):"));
187+
String itemsStr = String.join(", ", items);
188+
section.add(theme.label(itemsStr, getWindowWidth() / 2.0).color(theme.textSecondaryColor()));
189+
190+
return true;
191+
}
191192
}

‎src/main/java/com/cope/meteoraddons/gui/screens/BrowseAddonsScreen.java‎

Lines changed: 19 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@
44
import com.cope.meteoraddons.addons.OnlineAddon;
55
import com.cope.meteoraddons.config.IconSizeConfig;
66
import com.cope.meteoraddons.gui.widgets.WAddonCard;
7-
import com.cope.meteoraddons.gui.widgets.WAddonListItem;
7+
import com.cope.meteoraddons.gui.widgets.WAddonList;
88
import com.cope.meteoraddons.models.AddonMetadata;
99
import com.cope.meteoraddons.systems.AddonManager;
10+
import com.cope.meteoraddons.util.AddonSearchUtil;
1011
import com.cope.meteoraddons.util.IconCache;
1112
import com.cope.meteoraddons.util.VersionUtil;
1213
import meteordevelopment.meteorclient.gui.GuiTheme;
@@ -106,7 +107,7 @@ private void updateContent(List<Addon> allAddons) {
106107
contentContainer.clear();
107108

108109
List<Addon> filtered = allAddons.stream()
109-
.filter(addon -> matchesSearch(addon, currentSearch))
110+
.filter(addon -> AddonSearchUtil.matches(addon, currentSearch))
110111
.collect(Collectors.toList());
111112

112113
if (filtered.isEmpty()) {
@@ -121,57 +122,6 @@ private void updateContent(List<Addon> allAddons) {
121122
}
122123
}
123124

124-
private boolean matchesSearch(Addon addon, String query) {
125-
if (query == null || query.isEmpty()) return true;
126-
String q = query.toLowerCase(Locale.ROOT);
127-
128-
// Name
129-
if (addon.getName().toLowerCase(Locale.ROOT).contains(q)) return true;
130-
131-
// Description
132-
if (addon.getDescription().isPresent() && addon.getDescription().get().toLowerCase(Locale.ROOT).contains(q)) return true;
133-
134-
// Author
135-
if (addon.getAuthors() != null) {
136-
for (String author : addon.getAuthors()) {
137-
if (author.toLowerCase(Locale.ROOT).contains(q)) return true;
138-
}
139-
}
140-
141-
// Metadata Deep Search
142-
if (addon instanceof OnlineAddon) {
143-
AddonMetadata meta = ((OnlineAddon) addon).getMetadata();
144-
if (meta != null) {
145-
// Modules
146-
if (meta.features != null && meta.features.modules != null) {
147-
for (String module : meta.features.modules) {
148-
if (module.toLowerCase(Locale.ROOT).contains(q)) return true;
149-
}
150-
}
151-
// Commands
152-
if (meta.features != null && meta.features.commands != null) {
153-
for (String cmd : meta.features.commands) {
154-
if (cmd.toLowerCase(Locale.ROOT).contains(q)) return true;
155-
}
156-
}
157-
// Custom Screens
158-
if (meta.features != null && meta.features.custom_screens != null) {
159-
for (String screen : meta.features.custom_screens) {
160-
if (screen.toLowerCase(Locale.ROOT).contains(q)) return true;
161-
}
162-
}
163-
// Custom Tags (e.g. "qol", "pvp")
164-
if (meta.custom != null && meta.custom.tags != null) {
165-
for (String tag : meta.custom.tags) {
166-
if (tag.toLowerCase(Locale.ROOT).contains(q)) return true;
167-
}
168-
}
169-
}
170-
}
171-
172-
return false;
173-
}
174-
175125
private void initGridView(WContainer parent, List<Addon> addons) {
176126
WTable table = parent.add(theme.table()).expandX().widget();
177127
int col = 0;
@@ -186,36 +136,24 @@ private void initGridView(WContainer parent, List<Addon> addons) {
186136
}
187137

188138
private void initListView(WContainer parent, List<Addon> addons) {
189-
WVerticalList list = parent.add(theme.verticalList()).expandX().widget();
190-
191-
for (int i = 0; i < addons.size(); i++) {
192-
Addon addon = addons.get(i);
193-
194-
list.add(new WAddonListItem(
195-
addon,
196-
() -> mc.setScreen(new AddonDetailScreen(theme, addon, this)),
197-
(button) -> {
198-
if (addon instanceof OnlineAddon) {
199-
button.set("Downloading...");
200-
meteordevelopment.meteorclient.utils.network.MeteorExecutor.execute(() -> {
201-
boolean success = AddonManager.get().downloadAddon((OnlineAddon) addon);
202-
mc.execute(() -> {
203-
if (success) {
204-
button.set("Downloaded!");
205-
// Optionally refresh logic or disable button could go here
206-
} else {
207-
button.set("Failed");
208-
}
209-
});
139+
parent.add(new WAddonList(
140+
addons,
141+
addon -> () -> mc.setScreen(new AddonDetailScreen(theme, addon, this)),
142+
addon -> button -> {
143+
if (addon instanceof OnlineAddon) {
144+
button.set("Downloading...");
145+
meteordevelopment.meteorclient.utils.network.MeteorExecutor.execute(() -> {
146+
boolean success = AddonManager.get().downloadAddon((OnlineAddon) addon);
147+
mc.execute(() -> {
148+
if (success) {
149+
button.set("Downloaded!");
150+
} else {
151+
button.set("Failed");
152+
}
210153
});
211-
}
154+
});
212155
}
213-
)).expandX();
214-
215-
// Separator
216-
if (i < addons.size() - 1) {
217-
list.add(theme.horizontalSeparator()).expandX();
218156
}
219-
}
157+
)).expandX();
220158
}
221159
}

‎src/main/java/com/cope/meteoraddons/gui/screens/InstalledAddonsScreen.java‎

Lines changed: 7 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
import com.cope.meteoraddons.config.IconSizeConfig;
55
import com.cope.meteoraddons.systems.AddonManager;
66
import com.cope.meteoraddons.util.IconCache;
7-
import com.cope.meteoraddons.gui.widgets.WAddonListItem;
7+
import com.cope.meteoraddons.gui.widgets.WAddonList;
88
import meteordevelopment.meteorclient.gui.GuiTheme;
99
import meteordevelopment.meteorclient.gui.WindowScreen;
1010
import meteordevelopment.meteorclient.gui.widgets.containers.WHorizontalList;
@@ -39,25 +39,12 @@ public void initWidgets() {
3939
if (addons.isEmpty()) {
4040
add(theme.label("No Meteor addons installed")).expandX().centerX();
4141
} else {
42-
// List of installed addons
43-
WVerticalList list = add(theme.verticalList()).expandX().widget();
44-
45-
for (int i = 0; i < addons.size(); i++) {
46-
Addon addon = addons.get(i);
47-
48-
// Pass null for onInstall since we are already in the installed list,
49-
// but the widget will still show the "Installed" badge which provides consistency.
50-
list.add(new WAddonListItem(
51-
addon,
52-
() -> mc.setScreen(new AddonDetailScreen(theme, addon, this)),
53-
null
54-
)).expandX();
55-
56-
// Separator
57-
if (i < addons.size() - 1) {
58-
list.add(theme.horizontalSeparator()).expandX();
59-
}
60-
}
42+
// List of installed addons (no install button needed)
43+
add(new WAddonList(
44+
addons,
45+
addon -> () -> mc.setScreen(new AddonDetailScreen(theme, addon, this)),
46+
null
47+
)).expandX();
6148
}
6249
}
6350
}

‎src/main/java/com/cope/meteoraddons/gui/widgets/WAddonList.java‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
package com.cope.meteoraddons.gui.widgets;
2+
3+
import com.cope.meteoraddons.addons.Addon;
4+
import meteordevelopment.meteorclient.gui.widgets.containers.WVerticalList;
5+
import meteordevelopment.meteorclient.gui.widgets.pressable.WButton;
6+
7+
import java.util.List;
8+
import java.util.function.Consumer;
9+
import java.util.function.Function;
10+
11+
/**
12+
* Reusable vertical list of addons with automatic separators.
13+
* Used in BrowseAddonsScreen and InstalledAddonsScreen.
14+
*/
15+
public class WAddonList extends WVerticalList {
16+
private final List<Addon> addons;
17+
private final Function<Addon, Runnable> onClickProvider;
18+
private final Function<Addon, Consumer<WButton>> onInstallProvider;
19+
20+
/**
21+
* Create a new addon list widget.
22+
*
23+
* @param addons The list of addons to display
24+
* @param onClickProvider Function that provides click handler for each addon (for detail screen)
25+
* @param onInstallProvider Function that provides install button handler (nullable for installed addons)
26+
*/
27+
public WAddonList(
28+
List<Addon> addons,
29+
Function<Addon, Runnable> onClickProvider,
30+
Function<Addon, Consumer<WButton>> onInstallProvider
31+
) {
32+
this.addons = addons;
33+
this.onClickProvider = onClickProvider;
34+
this.onInstallProvider = onInstallProvider;
35+
}
36+
37+
@Override
38+
public void init() {
39+
for (int i = 0; i < addons.size(); i++) {
40+
Addon addon = addons.get(i);
41+
42+
// Get handlers for this addon
43+
Runnable onClick = onClickProvider.apply(addon);
44+
Consumer<WButton> onInstall = onInstallProvider != null ? onInstallProvider.apply(addon) : null;
45+
46+
// Add the list item
47+
add(new WAddonListItem(addon, onClick, onInstall)).expandX();
48+
49+
// Add separator between items (not after last item)
50+
if (i < addons.size() - 1) {
51+
add(theme.horizontalSeparator()).expandX();
52+
}
53+
}
54+
}
55+
}

0 commit comments

Comments
 (0)