Cubed-Development / Modern-Warfare-Cubed

Welcome to the official GitHub Repository for Modern Warfare Cubed!
Apache License 2.0
93 stars 60 forks source link

Lombokify #524

Closed strubium closed 4 days ago

strubium commented 1 week ago

📝 Description

Use lombok where possible

🎯 Goals

❌ Non Goals

🚦 Testing

👍

⏮️ Backwards Compatibility

1.12.2

📖 Added to documentation?

coderabbitai[bot] commented 1 week ago
📝 Walkthrough
📝 Walkthrough ## Walkthrough The pull request introduces multiple changes across various classes in the `com.paneedah.weaponlib` package. The primary focus is on simplifying getter and setter methods using Lombok annotations, which reduces boilerplate code and enhances readability. Several classes have had explicit getter and setter methods removed in favor of Lombok-generated methods. Additionally, some classes have been modified to improve encapsulation and streamline existing functionalities, while a few classes have been deleted due to redundancy. ## Changes | File Path | Change Summary | |---------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------| | `src/main/java/com/paneedah/weaponlib/Tuple.java` | Added `@Getter` and `@Setter` annotations; removed explicit getter/setter methods for `u` and `v`. | | `src/main/java/com/paneedah/weaponlib/Weapon.java` | Added `@Getter` annotations for multiple fields; removed explicit getter methods. | | `src/main/java/com/paneedah/weaponlib/WeaponResourcePack.java` | Simplified `resourceExists` method by removing unnecessary variable. | | `src/main/java/com/paneedah/weaponlib/animation/ModernAnimator.java` | Class deleted. | | `src/main/java/com/paneedah/weaponlib/animation/gui/AnimGUIRenderable.java` | Class deleted. | | `src/main/java/com/paneedah/weaponlib/animation/gui/AnimationGUI.java` | Added `@Getter` for singleton instance; removed `getInstance()` method. | | `src/main/java/com/paneedah/weaponlib/animation/gui/Button.java` | Added `@Getter` and `@Setter`; removed explicit getter/setter methods. | | `src/main/java/com/paneedah/weaponlib/animation/gui/Panel.java` | Added `@Getter` and `@Setter` annotations; removed multiple explicit getter/setter methods. | | `src/main/java/com/paneedah/weaponlib/animation/gui/Slider.java` | Changed `progress` to public with `@Getter` and `@Setter`; removed explicit getter/setter methods. | | `src/main/java/com/paneedah/weaponlib/animation/gui/Textbar.java` | Consolidated variable declarations into a single line. | | `src/main/java/com/paneedah/weaponlib/animation/jim/AnimationSet.java` | Added `@Getter`; removed explicit `getAnimations()` method. | | `src/main/java/com/paneedah/weaponlib/config/BalancePackManager.java` | Added `@Getter` and `@Setter` to inner classes; removed explicit getter/setter methods. | | `src/main/java/com/paneedah/weaponlib/numerical/LerpedValue.java` | Added `@Getter` and `@NoArgsConstructor`; removed explicit no-arg constructor and `getPreviousValue()`. | | `src/main/java/com/paneedah/weaponlib/render/SpriteSheetTools.java` | Added `@Getter` and `@Setter` to `Sprite` inner class; removed explicit getter/setter methods. | | `src/main/java/com/paneedah/weaponlib/vehicle/ICloneable.java` | Class deleted. | | `src/main/java/com/paneedah/weaponlib/WeaponRenderer.java` | Added `@Setter` and `@Getter` to boolean fields; minor change in `getTransitions` method. | | `src/main/java/com/paneedah/weaponlib/ItemMagazine.java` | Added `@Getter` to fields; removed explicit getter methods. | | `src/main/java/com/paneedah/weaponlib/crafting/workbench/GUIButtonCustom.java` | Added `@Getter` to `pageID`; removed explicit `getPageID()` method. | | `src/main/java/com/paneedah/weaponlib/render/ModificationGUI.java` | Updated method call from `getGUIPositions()` to `getGuiPositions()`. | | `src/main/java/com/paneedah/weaponlib/vehicle/network/VehiclePhysSerializer.java` | Added `@Setter` to `solver`; removed explicit `setSolver()` method. | | `src/main/java/com/paneedah/weaponlib/grenade/GrenadeRenderer.java` | Added `@Getter` and `@Setter` to fields; removed explicit getter methods. | | `src/main/java/com/paneedah/weaponlib/animation/Transition.java` | Renamed `evt` to `soundEvent`; added `@Getter` and `@Setter` for various fields. | | `src/main/java/com/paneedah/weaponlib/animation/jim/AnimationData.java` | Added `@Getter` and `@Setter` to fields; updated method names for sound events. | | `src/main/java/com/paneedah/weaponlib/melee/MeleeRenderer.java` | Added `@Getter` and `@Setter` to fields; removed explicit getter methods. | | `src/main/java/com/paneedah/weaponlib/animation/DebugPositioner.java` | Added `@Getter` and `@Setter` to fields; introduced inner class with annotations. | | `src/main/java/com/paneedah/weaponlib/animation/Interpolation.java` | Modified control flow in `interpolate` method for `LINEAR` case. | | `src/main/java/com/paneedah/weaponlib/animation/OpenGLSelectionHelper.java` | Removed `mouseClick` variable; simplified `shouldRender` method. | | `src/main/java/com/paneedah/weaponlib/animation/jim/KeyedAnimation.java` | Updated constructor to use getter methods for accessing `AnimationData`. | | `src/main/java/com/paneedah/weaponlib/animation/jim/SingleAnimation.java` | Updated `bake` method to use getter methods for `bbTransition`. | | `src/main/java/com/paneedah/weaponlib/command/DebugCommand.java` | Changed `isInfiniteAmmo` to private with `@Getter`; removed `compatList`. | | `src/main/java/com/paneedah/weaponlib/CustomArmor.java` | Added `@Getter` to several fields; refactored constructor calls. | | `src/main/java/com/paneedah/weaponlib/vehicle/EntityVehicle.java` | Updated sound handling in `handleGeneralSound` method. | | `src/main/java/com/paneedah/weaponlib/vehicle/EntityVehicleConfiguration.java` | Added `@Getter` to multiple fields; removed explicit getter methods. | | `src/main/java/com/paneedah/weaponlib/animation/MultipartTransition.java` | Renamed `cont` to `context`; added `@Getter` to various fields. | | `src/main/java/com/paneedah/weaponlib/animation/AnimationModeProcessor.java` | Updated fields with `@Setter` and `@Getter`; removed explicit getter/setter methods. | | `src/main/java/com/paneedah/weaponlib/crafting/base/GUIContainerStation.java` | Added `@Setter` and `@Getter` to fields; updated `onSelectNewCrafting` method. | ## Possibly related PRs - **#508**: The changes in this PR involve the use of utility methods for bounding box calculations, which may relate to the overall code structure and efficiency improvements similar to the simplifications made in the `Tuple` class with Lombok annotations. However, there is no direct connection to the specific changes in getter and setter methods in the `Tuple` class. ## Suggested labels `Optimization`, `Productivity` ## Suggested reviewers - Desoroxxx

📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Reviewing files that changed from the base of the PR and between 432583b26c75ce2bfd0eba1dae08700161742358 and 213d5c5d52ee534920c7d3e01eb6e5e25aaea734.
📒 Files selected for processing (2) * `src/main/java/com/paneedah/weaponlib/numerical/LerpedValue.java` (1 hunks) * `src/main/java/com/paneedah/weaponlib/render/SpriteSheetTools.java` (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2) * src/main/java/com/paneedah/weaponlib/numerical/LerpedValue.java * src/main/java/com/paneedah/weaponlib/render/SpriteSheetTools.java

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
github-actions[bot] commented 1 week ago

Qodana for JVM

20578 new problems were found

Inspection name Severity Problems
Unchecked warning 🔶 Warning 10585
Unnecessary 'this' qualifier 🔶 Warning 2489
Deprecated API usage 🔶 Warning 1489
Auto-boxing 🔶 Warning 731
Statement with empty body 🔶 Warning 361
Field can be local 🔶 Warning 313
Lombok @Getter may be used 🔶 Warning 276
Unused assignment 🔶 Warning 128
Auto-unboxing 🔶 Warning 125
Nullability and data flow problems 🔶 Warning 124
Non-constant field with upper-case name 🔶 Warning 114
Redundant local variable 🔶 Warning 101
Javadoc declaration problems 🔶 Warning 99
Lombok @Setter may be used 🔶 Warning 89
Questionable name 🔶 Warning 76
Constant values 🔶 Warning 68
Call to 'printStackTrace()' 🔶 Warning 36
Declaration has problems in Javadoc references 🔶 Warning 27
Possibly lossy implicit cast in compound assignment 🔶 Warning 27
Result of method call ignored 🔶 Warning 18
Deprecated member is still used 🔶 Warning 14
Dynamic regular expression can be replaced by compiled 'Pattern' 🔶 Warning 13
Link specified as plain text 🔶 Warning 13
Condition is covered by further condition 🔶 Warning 12
Mismatched query and update of collection 🔶 Warning 11
'Set' can be replaced with 'EnumSet' 🔶 Warning 11
'size() == 0' can be replaced with 'isEmpty()' 🔶 Warning 11
String concatenation as argument to 'StringBuilder.append()' call 🔶 Warning 8
Class is exposed outside of its visibility scope 🔶 Warning 7
'Map' can be replaced with 'EnumMap' 🔶 Warning 7
Octal integer 🔶 Warning 7
Suspicious collection method call 🔶 Warning 7
Vulnerable imported dependency 🔶 Warning 7
Functional expression can be folded 🔶 Warning 6
Unused import 🔶 Warning 6
Unnecessary unary minus 🔶 Warning 6
Unstable API Usage 🔶 Warning 6
Bulk operation can be used instead of iteration 🔶 Warning 6
Catch block may ignore exception 🔶 Warning 5
Variable is assigned to itself 🔶 Warning 5
Stream API call chain can be simplified 🔶 Warning 5
Dangling Javadoc comment 🔶 Warning 4
Inner class may be 'static' 🔶 Warning 4
Integer division in floating-point context 🔶 Warning 4
Copy of existing static method body 🔶 Warning 4
Manual min/max calculation 🔶 Warning 4
AutoCloseable used without 'try'-with-resources 🔶 Warning 3
Mismatched read and write of array 🔶 Warning 3
Value passed as parameter never read 🔶 Warning 3
Method is identical to its super method 🔶 Warning 3
String concatenation in loop 🔶 Warning 3
Local variable used and declared in different 'switch' branches 🔶 Warning 3
Unnecessary 'continue' statement 🔶 Warning 3
'default' not last case in 'switch' 🔶 Warning 2
Duplicate condition 🔶 Warning 2
Call math rounding with 'int' argument 🔶 Warning 2
@NotNull/@Nullable problems 🔶 Warning 2
Redundant type cast 🔶 Warning 2
Redundant operation on empty container 🔶 Warning 2
Redundant usage of unmodifiable collection wrappers 🔶 Warning 2
Method does not call super method 🔶 Warning 2
Call to 'Arrays.asList()' with too few arguments 🔶 Warning 1
Caught exception is immediately rethrown 🔶 Warning 1
Redundant 'Collection.addAll()' call 🔶 Warning 1
'static' method declared 'final' 🔶 Warning 1
Call to 'toString()' on array 🔶 Warning 1
Infinite recursion 🔶 Warning 1
Method name same as class name 🔶 Warning 1
'protected' member in 'final' class 🔶 Warning 1
String comparison using '==', instead of 'equals()' 🔶 Warning 1
'String.equals()' can be replaced with 'String.isEmpty()' 🔶 Warning 1
Suspicious variable/parameter name combination 🔶 Warning 1
Minimum 'switch' branches 🔶 Warning 1
Unary plus 🔶 Warning 1
Constant values ◽️ Notice 1351
Commented out code ◽️ Notice 1005
Duplicated code fragment ◽️ Notice 679
'if' statement with identical branches or common parts ◽️ Notice 9
Method can be extracted ◽️ Notice 7
Multiple occurrences of the same expression ◽️ Notice 4
Duplicate branches in 'switch' ◽️ Notice 3
Non-strict inequality '>=' or '<=' can be replaced with '==' ◽️ Notice 1

☁️ View the detailed Qodana report

Detected 18 dependencies # Third-party software list This page lists the third-party software dependencies used in Modern Warfare Cubed | Dependency | Version | Licenses | |-------------------------------------------------------------------------|---------------|--------------------------------------------------------------------------------------------------------------------------------------------| | [commons-codec](http://commons.apache.org/proper/commons-codec/) | 1.10 | [Apache-2.0](http://www.apache.org/licenses/) | | [commons-compress](http://commons.apache.org/proper/commons-compress/) | 1.8.1 | [Apache-2.0](http://www.apache.org/licenses/) | | [commons-io](http://commons.apache.org/proper/commons-io/) | 2.5 | [Apache-2.0](http://www.apache.org/licenses/) | | [commons-lang3](http://commons.apache.org/proper/commons-lang/) | 3.5 | [Apache-2.0](http://www.apache.org/licenses/) | | [commons-logging](http://commons.apache.org/proper/commons-logging/) | 1.1.3 | [Apache-2.0](http://www.apache.org/licenses/) | | groovyscript | 1.2.0-hotfix1 | [MIT](http://opensource.org/licenses/mit-license.php) | | [httpclient](http://hc.apache.org/httpcomponents-client) | 4.3.3 | [Apache-2.0](http://www.apache.org/licenses/) | | [httpcore](http://hc.apache.org/httpcomponents-core-ga) | 4.3.2 | [Apache-2.0](http://www.apache.org/licenses/)
[CC-BY-2.5](http://creativecommons.org/licenses/by/2.5/) | | icu4j-core-mojang | 51.2 | [IBM-ICU](http://source.icu-project.org/repos/icu/icu/trunk/license.html) | | [java-objc-bridge](https://github.com/shannah/Java-Objective-C-Bridge) | 1.0.0 | [Apache-2.0](http://www.apache.org/licenses/) | | jline | 3.5.1 | [BSD-3-Clause](http://www.opensource.org/licenses/BSD-3-Clause) | | [jopt-simple](http://pholser.github.io/jopt-simple) | 5.0.3 | [MIT](http://opensource.org/licenses/mit-license.php) | | log4j-api | 2.17.1 | [Apache-2.0](http://www.apache.org/licenses/) | | log4j-core | 2.17.1 | [Apache-2.0](http://www.apache.org/licenses/) | | lombok | 1.18.32 | BSD-3-CLAUSE-NO-TRADEMARK
[MIT](http://opensource.org/licenses/mit-license.php) | | maven-artifact | 3.5.3 | [Apache-2.0](http://www.apache.org/licenses/) | | plexus-utils | 3.1.0 | [Apache-2.0](http://www.apache.org/licenses/) | | vecmath | 1.5.2 | [GPL-2.0-only](http://www.gnu.org/licenses/gpl-2.0.html)
[ORACLE-OPENJDK-EXCEPTION-2.0](http://openjdk.java.net/legal/gplv2+ce.html) |
Contact Qodana team Contact us at [qodana-support@jetbrains.com](mailto:qodana-support@jetbrains.com) - Or via our issue tracker: https://jb.gg/qodana-issue - Or share your feedback: https://jb.gg/qodana-discussions