shynixn / astraledit Goto Github PK

Can i have this issue?

Refactor the 'angles' command (#4)

Refactor the 'upsidedown' command (#4)

Refactor the 'join' command

Pls

Refactor the 'auto-follow' command

As stated in #4

Refactor the 'render' command as stated in #4

Refactor the 'join' command (#4)

Refactor the 'flip' command as listed in #4

#4

Refactor the 'rotate' command #4

I would like to do this task

Refactor the 'clear' command (#4)

Refactor the 'undo' command (#4)

As stated in #4

Refactor the 'place' command as stated in #4

Hacktoberfest 2018

+Thanks for already over 21 completed tasks!

This project has not been active for about a year and would need some love from fellow developers. If you are a OpenSource contributor, you have found a project which provides explained and easy tasks for you :)

Guidlines

Required Knowledge

• Java or Kotlin developer
• Common knowledge about the Bukkit API

Code/Style/Architecture

• Please use the existing layout of the project and avoid creating packages.
• Keep consistency over the whole project.

Getting started

• Look for a task below which you would like to do
• Create a new issue with the task name and label Hacktoberfest
• Fork and clone the repository to your local pc
• Use the contributing description on the README to setup required dependencies in order to build the project.
• Work on it :)
• Submit a pull request when you are done to initiate a reviewing process

Tasks

Open Tasks

It is highly recommend to create a new issue on this project with the task name for example "refactor the 'render' command" to avoid duplicate task pull requests.

• There are some code smells in AstralEdit which should be removed in order to achieve clean code.

• Remove the SimpleCommandExecutor class as only 1 statement is actually used of the inherited classes. Move this registration statement to the related constructor.

• There should not be Utils classes in a good project. AstralEdit does not require the RefelectionUtils class as using the required reflection for each use case is a way better.

• Replace calls to the ReflectionUtils with actual reflection. Remove the ReflectionUtils class in the end.

• The SelectionController should have one single function called cleanResources(Player player) to clear all allocated resources of the given player.

• The implementation should call clearSelection and clearOperation.

• Refactor the SelectionListener by removing the inheritance SimpleListener and adding the interface Listener. The parameter of the class should only be a SelectionController which is used in the onPlayerQuitEvent to call clearResources

• Register the listener in the AstralEditPlugin class and delete the SimpleListener class

• There are commands implemented in the commands package using the AstralEdit.INSTANCE api or even worse the SelectionManager class directly like passing them as parameter. This is not a good coding style as an interface, in this case the SelectionController, should be used instead.
  How to complete this task:

• Replace all references to the AstralEdit.INSTANCE and SelectionManager with references to the SelectionController.
• If the SelectionController does not offer the same functions from the SelectionManager add them to the interface.

Completed Tasks

The commandexecutor SelectionCommandExecutor.java is very messy concerning readability of the onPlayerExecuteCommand function. Using the https://en.wikipedia.org/wiki/Command_pattern helps resolving this.

There is already one command called AutoRotateCommand correctly refactored.

Steps:

1. Creating a command class.
2. Moving the validation checks
3. Moving the implementation.

There are many commands which need to get refactored. Each one is a single task.

• Refactor the 'render' command

• Refactor the 'join' command

• Refactor the 'tear' command

• Refactor the 'place' command

• Refactor the 'clear' command

• Refactor the 'mirror' command

• Refactor the 'flip' command

• Refactor the 'upsidedown' command

• Refactor the 'undo' command

• Refactor the 'hide' command

• Refactor the 'show' command

• Refactor the 'angles' command

• Refactor the 'rotate' command

• Refactor the 'convertToBlocks' command

• Refactor the 'convertToRender' command

• Refactor the 'teleport' command

• Refactor the 'auto-follow' command

• Refactor both 'move' commands

• Remove the Metrics.java class and replace it with the maven dependency of https://bstats.org/getting-started. The dependency should also be shaded into the final jar file and correctly relocated like it is in this project. https://github.com/Shynixn/BlockBall/blob/master/blockball-bukkit-plugin/pom.xml

• Refactor the AstralEditApi.java to a Singleton by using public static final AstralEditApi INSTANCE = new AstralEditApi(); This project already uses this correctly. https://github.com/Shynixn/StructureBlockLib/blob/master/structureblocklib-bukkit-api/src/main/java/com/github/shynixn/structureblocklib/bukkit/api/StructureBlockApi.java

• A wise man once said that Utils classes should not exist in a good project. He was right and so the UpdateUtils class needs to be refactored.
  How to complete this task:

• Create a package called service in the bukkit-api project below the entity package and create a new class called UpdateService
• The only method should be called checkForUpdates() which returns a CompletableFuture$Boolean$.
• Put a new class UpdateServiceImpl in the service package of the bukkit-plugin project and refactor the implementation from the UpdateUtils class to the new UpdateServiceImpl. The UpdateServiceImpl should have a constructor taking a plugin instance for doing a asynchrone webrequest inside.
• Remove the UpdateUtils.class once it is no longer used.

Help

• Use this issue to post questions or join my discord. https://discordapp.com/invite/Y27tx8Y

Refactor the 'tear' command (#4)

Refactor the 'show' command (#4)

Refactor the 'hide' command (#4)