CodingTests
/
mars-rover-kata
1
0
Fork 0
Code

apply JPMS to user interface module and improve some namings

This commit is contained in:
Xavier Fontanet 2024-06-24 16:28:54 +02:00
parent 0455523ed9
commit 02d849f696
18 changed files with 104 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
mars-station/src/main/java/cat/hack3/codingtests/marsrover/MarsRover.java
View File

@ -13,7 +13,7 @@ public class MarsRover implements RotableRiderRover {
public static class Provider implements RotableRiderRover.Provider {
@Override
public RotableRiderRover provide(PlanetMap map, Direction startingDirection) {
public RotableRiderRover provideWith(PlanetMap map, Direction startingDirection) {
return new MarsRover(map, startingDirection);
}
}

2
mars-station/src/main/java/cat/hack3/codingtests/marsrover/gps/MarsMap.java
View File

@ -29,7 +29,7 @@ public class MarsMap implements PlanetMap {
public static class Provider implements PlanetMap.Provider {
@Override
public PlanetMap provide(int height, int width, Coordinates startingCoordinates, List<Coordinates> obstaclesLocalizations) {
public PlanetMap provideWith(int height, int width, Coordinates startingCoordinates, List<Coordinates> obstaclesLocalizations) {
return new MarsMap(height, width, startingCoordinates, obstaclesLocalizations);
}
}

1
pom.xml
View File

@ -14,7 +14,6 @@
<module>user-interface-console</module>
<module>rover-commands</module>
<module>rover-api</module>
<module>station-plugin</module>
<module>tests-suite</module>
</modules>

2
rover-api/src/main/java/cat/hack3/codingtests/marsrover/api/RotableRiderRover.java
View File

@ -16,6 +16,6 @@ public interface RotableRiderRover {
Direction getCurrentDirection();
interface Provider {
RotableRiderRover provide(PlanetMap map, Direction startingDirection);
RotableRiderRover provideWith(PlanetMap map, Direction startingDirection);
}
}

2
rover-api/src/main/java/cat/hack3/codingtests/marsrover/api/cartography/PlanetMap.java
View File

@ -13,6 +13,6 @@ public interface PlanetMap {
Coordinates getCurrentPosition();
interface Provider {
PlanetMap provide(int height, int width, Coordinates startingCoordinates, List<Coordinates> obstaclesLocalizations);
PlanetMap provideWith(int height, int width, Coordinates startingCoordinates, List<Coordinates> obstaclesLocalizations);
}
}

11
rover-api/src/main/java/cat/hack3/codingtests/marsrover/api/commands/CommandFactory.java
View File

@ -1,11 +0,0 @@
package cat.hack3.codingtests.marsrover.api.commands;
import cat.hack3.codingtests.marsrover.api.RotableRiderRover;
public interface CommandFactory {
RoverCommand createCommand(RoverCommand.Type type);
interface Provider {
CommandFactory provide(RotableRiderRover rover);
}
}

11
rover-api/src/main/java/cat/hack3/codingtests/marsrover/api/commands/RoverCommandFactory.java Normal file
View File

@ -0,0 +1,11 @@
package cat.hack3.codingtests.marsrover.api.commands;
import cat.hack3.codingtests.marsrover.api.RotableRiderRover;
public interface RoverCommandFactory {
RoverCommand create(RoverCommand.Type type);
interface Provider {
RoverCommandFactory provideWith(RotableRiderRover rover);
}
}

14
rover-commands/src/main/java/cat/hack3/codingtests/marsrover/commands/RoverCommandFactory.java → rover-commands/src/main/java/cat/hack3/codingtests/marsrover/commands/RoverCommandFactoryImpl.java
View File

@ -2,25 +2,25 @@ package cat.hack3.codingtests.marsrover.commands;
import cat.hack3.codingtests.marsrover.api.RotableRiderRover;
import cat.hack3.codingtests.marsrover.api.commands.CommandFactory;
import cat.hack3.codingtests.marsrover.api.commands.RoverCommand;
import cat.hack3.codingtests.marsrover.api.commands.RoverCommandFactory;
public class RoverCommandFactory implements CommandFactory {
public class RoverCommandFactoryImpl implements RoverCommandFactory {
private final RotableRiderRover rover;
public static class Provider implements CommandFactory.Provider {
public static class Provider implements RoverCommandFactory.Provider {
@Override
public CommandFactory provide(RotableRiderRover rover) {
return new RoverCommandFactory(rover);
public RoverCommandFactory provideWith(RotableRiderRover rover) {
return new RoverCommandFactoryImpl(rover);
}
}
private RoverCommandFactory(RotableRiderRover rover) {
private RoverCommandFactoryImpl(RotableRiderRover rover) {
this.rover = rover;
}
@Override
public RoverCommand createCommand(RoverCommand.Type type) {
public RoverCommand create(RoverCommand.Type type) {
return switch (type) {
case MOVE_FORWARD -> new MoveForwardCommand(rover);
case MOVE_BACKWARDS -> new MoveBackwardsCommand(rover);

8
rover-commands/src/main/java/module-info.java
View File

@ -1,9 +1,9 @@
import cat.hack3.codingtests.marsrover.api.commands.CommandFactory;
import cat.hack3.codingtests.marsrover.commands.RoverCommandFactory;
import cat.hack3.codingtests.marsrover.api.commands.RoverCommandFactory;
import cat.hack3.codingtests.marsrover.commands.RoverCommandFactoryImpl;
module rover.commands {
requires rover.api;
provides CommandFactory.Provider
with RoverCommandFactory.Provider;
provides RoverCommandFactory.Provider
with RoverCommandFactoryImpl.Provider;
}

6
tests-suite/pom.xml
View File

@ -17,12 +17,6 @@
<version>1.0</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>cat.hack3.codingtests</groupId>
<artifactId>station-plugin</artifactId>
<version>10.0</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>cat.hack3.codingtests</groupId>
<artifactId>rover-commands</artifactId>

25
tests-suite/src/test/java/cat/hack3/codingtests/marsrover/test/CommonTests.java
View File

@ -4,8 +4,8 @@ import cat.hack3.codingtests.marsrover.api.RotableRiderRover;
import cat.hack3.codingtests.marsrover.api.cartography.Coordinates;
import cat.hack3.codingtests.marsrover.api.cartography.Direction;
import cat.hack3.codingtests.marsrover.api.cartography.PlanetMap;
import cat.hack3.codingtests.marsrover.api.commands.CommandFactory;
import cat.hack3.codingtests.marsrover.api.commands.RoverCommand;
import cat.hack3.codingtests.marsrover.api.commands.RoverCommandFactory;
import java.util.List;
import java.util.ServiceLoader;
@ -25,29 +25,28 @@ public class CommonTests {
protected RoverCommand turnRightCommand;
protected void setup() {
int mapWidth = 10;
int mapHeight = 10;
int latitudeStartingPoint = 2;
int longitudeStartingPoint = 3;
var startingCoordinates = Coordinates.of(latitudeStartingPoint, longitudeStartingPoint);
var marsMap = getProviderFor(PlanetMap.Provider.class)
.provide(mapHeight, mapWidth, startingCoordinates, getObstacles());
var marsMap = getImplProviderOf(PlanetMap.Provider.class)
.provideWith(mapHeight, mapWidth, startingCoordinates, getObstacles());
rover = getProviderFor(RotableRiderRover.Provider.class)
.provide(marsMap, CommonTests.STARTING_DIRECTION);
rover = getImplProviderOf(RotableRiderRover.Provider.class)
.provideWith(marsMap, CommonTests.STARTING_DIRECTION);
var commandFactory = getProviderFor(CommandFactory.Provider.class)
.provide(rover);
var commandFactory = getImplProviderOf(RoverCommandFactory.Provider.class)
.provideWith(rover);
moveForwardCommand = commandFactory.createCommand(MOVE_FORWARD);
moveBackwardsCommand = commandFactory.createCommand(MOVE_BACKWARDS);
turnLeftCommand = commandFactory.createCommand(TURN_LEFT);
turnRightCommand = commandFactory.createCommand(TURN_RIGHT);
moveForwardCommand = commandFactory.create(MOVE_FORWARD);
moveBackwardsCommand = commandFactory.create(MOVE_BACKWARDS);
turnLeftCommand = commandFactory.create(TURN_LEFT);
turnRightCommand = commandFactory.create(TURN_RIGHT);
}
private <T> T getProviderFor(Class<T> interfaceProvider) {
private <T> T getImplProviderOf(Class<T> interfaceProvider) {
return ServiceLoader
.load(interfaceProvider)
.findFirst()

4
tests-suite/src/test/java/module-info.java
View File

@ -1,6 +1,6 @@
import cat.hack3.codingtests.marsrover.api.RotableRiderRover;
import cat.hack3.codingtests.marsrover.api.cartography.PlanetMap;
import cat.hack3.codingtests.marsrover.api.commands.CommandFactory;
import cat.hack3.codingtests.marsrover.api.commands.RoverCommandFactory;
module tests.suite {
requires rover.api;
@ -9,7 +9,7 @@ module tests.suite {
uses PlanetMap.Provider;
uses RotableRiderRover.Provider;
uses CommandFactory.Provider;
uses RoverCommandFactory.Provider;
requires org.testng;

34
user-interface-console/pom.xml
View File

@ -10,23 +10,31 @@
<modelVersion>4.0.0</modelVersion>
<artifactId>user-interface-console</artifactId>
<dependencies>
<dependency>
<groupId>cat.hack3.codingtests</groupId>
<artifactId>rover-api</artifactId>
<version>1.0</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>cat.hack3.codingtests</groupId>
<artifactId>mars-station</artifactId>
<version>2.0</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>cat.hack3.codingtests</groupId>
<artifactId>rover-commands</artifactId>
<version>2.0</version>
<scope>compile</scope>
</dependency>
</dependencies>
<properties>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>cat.hack3.codingtests</groupId>
<artifactId>mars-station</artifactId>
<version>2.0</version>
</dependency>
<dependency>
<groupId>cat.hack3.codingtests</groupId>
<artifactId>rover-commands</artifactId>
<version>2.0</version>
</dependency>
</dependencies>
</project>

6
user-interface-console/src/main/java/cat/hack3/codingtests/marsrover/ui/console/ClientCommandInterface.java
View File

@ -1,6 +1,6 @@
package cat.hack3.codingtests.marsrover.ui.console;
import cat.hack3.codingtests.marsrover.RotableRiderRover;
import cat.hack3.codingtests.marsrover.api.RotableRiderRover;
import java.util.Scanner;
@ -26,8 +26,8 @@ public class ClientCommandInterface {
private void start() {
output(PresentationMessage.INTRO);
//RotableRiderRover rover = roverInitializer.autoInitialize();
RotableRiderRover rover = roverInitializer.initializeFromUserInputs();
RotableRiderRover rover = roverInitializer.autoInitialize();
//RotableRiderRover rover = roverInitializer.initializeFromUserInputs();
var commandsPerformer = new RoverCommandsPerformer(reader, rover);
commandsPerformer.acceptCommandsUntilExitSignal();

17
user-interface-console/src/main/java/cat/hack3/codingtests/marsrover/ui/console/RoverCommandsPerformer.java
View File

@ -1,8 +1,8 @@
package cat.hack3.codingtests.marsrover.ui.console;
import cat.hack3.codingtests.marsrover.RotableRiderRover;
import cat.hack3.codingtests.marsrover.api.RotableRiderRover;
import cat.hack3.codingtests.marsrover.api.commands.RoverCommand;
import cat.hack3.codingtests.marsrover.commands.api.RoverCommandFactory;
import cat.hack3.codingtests.marsrover.api.commands.RoverCommandFactory;
import java.util.Scanner;
@ -13,7 +13,6 @@ import static cat.hack3.codingtests.marsrover.ui.console.UICommons.output;
public class RoverCommandsPerformer {
private final Scanner reader;
RoverCommandFactory roverCommandFactory;
private final RoverCommand moveForwardCommand;
private final RoverCommand moveBackwardsCommand;
private final RoverCommand turnLeftCommand;
@ -21,11 +20,13 @@ public class RoverCommandsPerformer {
public RoverCommandsPerformer(Scanner reader, RotableRiderRover rover) {
this.reader = reader;
roverCommandFactory = new RoverCommandFactory(rover);
moveForwardCommand = roverCommandFactory.createCommand(MOVE_FORWARD);
moveBackwardsCommand = roverCommandFactory.createCommand(MOVE_BACKWARDS);
turnLeftCommand = roverCommandFactory.createCommand(TURN_LEFT);
turnRightCommand = roverCommandFactory.createCommand(TURN_RIGHT);
var roverCommandFactory = UICommons
.getImplProviderOf(RoverCommandFactory.Provider.class)
.provideWith(rover);
moveForwardCommand = roverCommandFactory.create(MOVE_FORWARD);
moveBackwardsCommand = roverCommandFactory.create(MOVE_BACKWARDS);
turnLeftCommand = roverCommandFactory.create(TURN_LEFT);
turnRightCommand = roverCommandFactory.create(TURN_RIGHT);
}
public void acceptCommandsUntilExitSignal() {

17
user-interface-console/src/main/java/cat/hack3/codingtests/marsrover/ui/console/RoverInitializer.java
View File

@ -1,10 +1,9 @@
package cat.hack3.codingtests.marsrover.ui.console;
import cat.hack3.codingtests.marsrover.MarsRover;
import cat.hack3.codingtests.marsrover.RotableRiderRover;
import cat.hack3.codingtests.marsrover.api.RotableRiderRover;
import cat.hack3.codingtests.marsrover.api.cartography.Coordinates;
import cat.hack3.codingtests.marsrover.api.cartography.Direction;
import cat.hack3.codingtests.marsrover.gps.MarsMap;
import cat.hack3.codingtests.marsrover.api.cartography.PlanetMap;
import java.util.InputMismatchException;
import java.util.List;
@ -36,7 +35,7 @@ public class RoverInitializer {
Direction startingDirection = directionRetriever.retrieveDirection();
RotableRiderRover rover = deployRover(mapHeight, mapWidth, latitudeStartingPoint, longitudeStartingPoint, startingDirection);
RotableRiderRover rover = deployRover(mapHeight, mapWidth, latitudeStartingPoint, longitudeStartingPoint, startingDirection, List.of());
output(PresentationMessage.READY_MESSAGE);
reader.next(); //input ignored
@ -65,10 +64,12 @@ public class RoverInitializer {
return deployRover(10, 10, 2, 3, Direction.SOUTH, obstacles);
}
@SafeVarargs
private RotableRiderRover deployRover(int mapHeight, int mapWidth, int latitudeStartingPoint, int longitudeStartingPoint, Direction startingDirection, List<Coordinates>... obstaclesLocalizations) {
private RotableRiderRover deployRover(int mapHeight, int mapWidth, int latitudeStartingPoint, int longitudeStartingPoint, Direction startingDirection, List<Coordinates> obstaclesLocalizations) {
var startingCoordinates = Coordinates.of(latitudeStartingPoint, longitudeStartingPoint);
var marsMap = new MarsMap(mapHeight, mapWidth, startingCoordinates, obstaclesLocalizations);
return new MarsRover(marsMap, startingDirection);
var mapProvider = UICommons.getImplProviderOf(PlanetMap.Provider.class);
var roverProvider = UICommons.getImplProviderOf(RotableRiderRover.Provider.class);
var marsMap = mapProvider.provideWith(mapHeight, mapWidth, startingCoordinates, obstaclesLocalizations);
return roverProvider.provideWith(marsMap, startingDirection);
}
}

9
user-interface-console/src/main/java/cat/hack3/codingtests/marsrover/ui/console/UICommons.java
View File

@ -1,5 +1,7 @@
package cat.hack3.codingtests.marsrover.ui.console;
import java.util.ServiceLoader;
public class UICommons {
public static final String QUIT_COMMAND_TEXT = "q";
@ -15,4 +17,11 @@ public class UICommons {
static void output(String message) {
System.out.println(message);
}
static <T> T getImplProviderOf(Class<T> interfaceProvider) {
return ServiceLoader
.load(interfaceProvider)
.findFirst()
.orElseThrow();
}
}

13
user-interface-console/src/main/java/module-info.java Normal file
View File

@ -0,0 +1,13 @@
import cat.hack3.codingtests.marsrover.api.RotableRiderRover;
import cat.hack3.codingtests.marsrover.api.cartography.PlanetMap;
import cat.hack3.codingtests.marsrover.api.commands.RoverCommandFactory;
module ui.console {
requires rover.api;
requires mars.station;
requires rover.commands;
uses PlanetMap.Provider;
uses RotableRiderRover.Provider;
uses RoverCommandFactory.Provider;
}