Improving code quality with SonarCloud #5

sutheo17 · 2024-05-17T14:40:39Z

I have fixed the high severity cases of reliability and maintainability according to SonarCloud. They did prove to be real concerns, so I made the changes accordingly. This included the following changes:

RCIR -> reduce complexity, increase readability

Cisterns.java

Random object initialized once in the class
Removed unused line

Game.java

Closed the input / output streams with a finally block
NotifyAll renamed to NotifyAllTimePassed to avoid confusion with Object.notifyAll
Settings method have been made static
Round method refactored to RCIR

added several sub-methods
Random object initialized once in the class

GameView.java

x variable renamed to x_cord in order not to mistake with Component.x
y variable renamed to x_cord in order not to mistake with Component.y
a constant string literal have been added to the mountain image's path

Mountains.java

added an explanatory comment to the SetStorage method

Pipe.java

Path method refactored to reduce complexity and to increase readability
ChangePipe method refactored to RCIR

removed unnecessary nesting
Random object initialized once in the class

PipeView.java

PaintComponent method refactored to RCIR

removed unnecessary lines
added sub-methods

Player.java

a constant string literal have been added containing an error message which pops up when a player in unable to move
Move method refactored to RCIR

added sub-methods
MoveToElement method refactored to RCIR

added sub-methods
removed unused codes
added TODO functionality

TableView.java

added context to unused methods with comments
KeyPressed method refactored to RCIR

added sub-methods
removed unnecessary nesting
simplified if-else cases

View.java

x variable renamed to x_cord in order not to mistake with Component.x
y variable renamed to x_cord in order not to mistake with Component.y
added an explanatory comment to the unused methods

A Random object should be only initialized once for better efficiency and randomness.

Commented out program logic should not persist inside the finished code.

Try-with-resource pattern added.

A Random object should be only initialized once for better efficiency and randomness.

A Random object should be only initialized once for better efficiency and randomness. I also fixed a typo where I left the out the class type in Pipe.java.

It has been renamed to NotifyAllTimePassed to prevent confusion with Object.noifyAll method.

If there would be multiple threads, this is the safe way.

It was too complex, too long and was overwhelming. I have added several assistant method to fix this problem.

To avoid confusion with a filed of Component class.

To we don't have to duplicate its path in the methods.

Explaining why the method is empty.

It was too complex, too long and was overwhelming. I have added several assistant method to fix this problem.

To improve readability and to reduce the complexity of the method.

It has been to complex, several assistant methods have been added. I also added an error message constant to reduce code duplication.

Readability improvid, it was too complex, so I made several helper methods to fix this issue.

I also added comments to the unused methods.

It was too long and was to confusing. I added several sub-methods and also removed unnecessary nesting.

string -> String (Java) Too much C# lately. Also added const keyword.

Too much C# as I have said.

Fixed the Maven build errors. There were several small bugifixes.

sonarcloud · 2024-05-17T15:04:57Z

Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 80%)

See analysis details on SonarCloud

gerencsermate

I checked the changes, everything seems fine.

gerencsermate · 2024-05-17T16:16:02Z

Drumakomi_sivatag/src/main/java/Game.java

-                    }
-                }catch (NumberFormatException e){System.out.println("Rossz parametert adtal meg");}
+    // Végigmegyünk az összes játékoson, és feldolgozzuk a körüket mint Szabotőr
+    for (int i = 0; i < NumberOfPlayers; i++) {


Much easier to read this code

sutheo17 · 2024-05-17T16:18:55Z

@gerencsermate have reviewed my work. I will merge this branch into main.

Sütheö István added 18 commits May 17, 2024 12:46

Random object initialization

5cd0766

A Random object should be only initialized once for better efficiency and randomness.

Removed unused lined

791303f

Commented out program logic should not persist inside the finished code.

Streams closed after use

97a0b2e

Try-with-resource pattern added.

Random object initialization 2

4eefbe8

A Random object should be only initialized once for better efficiency and randomness.

Random object initialization 3 + typo fix

df723a9

A Random object should be only initialized once for better efficiency and randomness. I also fixed a typo where I left the out the class type in Pipe.java.

NotifyAll method renamed.

49be043

It has been renamed to NotifyAllTimePassed to prevent confusion with Object.noifyAll method.

Settings method made static

3a0cfcb

If there would be multiple threads, this is the safe way.

Round method refactored

a450a3e

It was too complex, too long and was overwhelming. I have added several assistant method to fix this problem.

Field name changed.

0ea9ec0

To avoid confusion with a filed of Component class.

Added constant for Mountain image path

0d6deec

To we don't have to duplicate its path in the methods.

Added comment to SetStorage method

fcede80

Explaining why the method is empty.

Path method refactored

d0de081

It was too complex, too long and was overwhelming. I have added several assistant method to fix this problem.

ChangePipe method refactored.

fde0e5c

It was too complex, too long and was overwhelming. I have added several assistant method to fix this problem.

Move method refactored

0cca1cb

To improve readability and to reduce the complexity of the method.

MoveToElement refactored

a758fbc

It has been to complex, several assistant methods have been added. I also added an error message constant to reduce code duplication.

keyPressed method refactored

a9a5986

Readability improvid, it was too complex, so I made several helper methods to fix this issue.

Renamed filed to avoid confusion

da03227

I also added comments to the unused methods.

PaintComponent method refactored

8bdcb57

It was too long and was to confusing. I added several sub-methods and also removed unnecessary nesting.

sutheo17 requested a review from gerencsermate May 17, 2024 14:40

sutheo17 self-assigned this May 17, 2024

sutheo17 linked an issue May 17, 2024 that may be closed by this pull request

Improving code quality with SonarCloud #2

Closed

Sütheö István added 3 commits May 17, 2024 16:45

Types fixed / const added to literals

5787b5e

string -> String (Java) Too much C# lately. Also added const keyword.

Const changed to final

3ee4ae0

Too much C# as I have said.

Fixed compilation errors

bd18ba8

Fixed the Maven build errors. There were several small bugifixes.

gerencsermate reviewed May 17, 2024

View reviewed changes

sutheo17 merged commit 041534c into main May 17, 2024
1 of 2 checks passed

sutheo17 added the enhancement New feature or request label May 21, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improving code quality with SonarCloud #5

Improving code quality with SonarCloud #5

sutheo17 commented May 17, 2024

sonarcloud bot commented May 17, 2024 •

edited

Loading

gerencsermate left a comment

gerencsermate May 17, 2024

sutheo17 commented May 17, 2024

Improving code quality with SonarCloud #5

Improving code quality with SonarCloud #5

Conversation

sutheo17 commented May 17, 2024

Cisterns.java

Game.java

GameView.java

Mountains.java

Pipe.java

PipeView.java

Player.java

TableView.java

View.java

sonarcloud bot commented May 17, 2024 • edited Loading

Quality Gate failed

gerencsermate left a comment

Choose a reason for hiding this comment

gerencsermate May 17, 2024

Choose a reason for hiding this comment

sutheo17 commented May 17, 2024

sonarcloud bot commented May 17, 2024 •

edited

Loading