Initialize Rock-Paper-Scissors project with Spring Boot, domain, SPI, and Modulith setup.

This commit is contained in:
Maxime Pierront
2025-11-22 23:54:22 +01:00
commit 513ac8356e
45 changed files with 1420 additions and 0 deletions

View File

@@ -0,0 +1,13 @@
package fr.iut_fbleau.info.but3.automation.rock_paper_scissors;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class Application {
static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}

View File

@@ -0,0 +1,17 @@
package fr.iut_fbleau.info.but3.automation.rock_paper_scissors.ddd;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
/**
* <p>
* A Domain Service, i.e. a feature that belongs to the domain and the ubiquitous
* language.
* </p>
*
* @see <a href=
* "https://www.domainlanguage.com/wp-content/uploads/2016/05/DDD_Reference_2015-03.pdf">Domain-Driven Design Reference</a>
*/
@Retention(RetentionPolicy.RUNTIME)
public @interface DomainService {
}

View File

@@ -0,0 +1,9 @@
package fr.iut_fbleau.info.but3.automation.rock_paper_scissors.ddd;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
@Retention(RetentionPolicy.RUNTIME)
public @interface Stub {
}

View File

@@ -0,0 +1,8 @@
package fr.iut_fbleau.info.but3.automation.rock_paper_scissors.play;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.play.domain.Move;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.play.domain.RoundResult;
public interface RockPaperScissorsPlay {
RoundResult playRound(String name, Move move);
}

View File

@@ -0,0 +1,16 @@
package fr.iut_fbleau.info.but3.automation.rock_paper_scissors.play.configuration;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.ddd.DomainService;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.ddd.Stub;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.play.domain.RockPaperScissorsPlayer;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.play.spi.CpuPick;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;
@Configuration
@ComponentScan(
basePackageClasses = {CpuPick.class, RockPaperScissorsPlayer.class},
includeFilters = {@ComponentScan.Filter(type = FilterType.ANNOTATION, classes = {DomainService.class})})
public class PlayConfiguration {
}

View File

@@ -0,0 +1,15 @@
package fr.iut_fbleau.info.but3.automation.rock_paper_scissors.play.domain;
public enum Move {
ROCK,
PAPER,
SCISSORS;
public boolean beats(Move other) {
return switch (this) {
case ROCK -> other == SCISSORS;
case PAPER -> other == ROCK;
case SCISSORS -> other == PAPER;
};
}
}

View File

@@ -0,0 +1,25 @@
package fr.iut_fbleau.info.but3.automation.rock_paper_scissors.play.domain;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.ddd.DomainService;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.play.RockPaperScissorsPlay;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.play.spi.CpuPick;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.stat.StatSave;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.stat.domain.StatSaver;
@DomainService
public record RockPaperScissorsPlayer(CpuPick cpuPick, StatSave statSave) implements RockPaperScissorsPlay {
public static final String WIN = "WIN";
public static final String LOOSE = "LOOSE";
@Override
public RoundResult playRound(String name, Move move) {
var cpuPicked = this.cpuPick.pick();
boolean beats = move.beats(cpuPicked);
String result = beats ? WIN : LOOSE;
if (result.equals(WIN)) {
this.statSave.addWin(name);
}
return new RoundResult(result, name, cpuPicked);
}
}

View File

@@ -0,0 +1,4 @@
package fr.iut_fbleau.info.but3.automation.rock_paper_scissors.play.domain;
public record RoundResult(String result, String opponent, Move cpuChoice) {
}

View File

@@ -0,0 +1,4 @@
@ApplicationModule(displayName = "Play")
package fr.iut_fbleau.info.but3.automation.rock_paper_scissors.play;
import org.springframework.modulith.ApplicationModule;

View File

@@ -0,0 +1,7 @@
package fr.iut_fbleau.info.but3.automation.rock_paper_scissors.play.spi;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.play.domain.Move;
public interface CpuPick {
Move pick();
}

View File

@@ -0,0 +1,17 @@
package fr.iut_fbleau.info.but3.automation.rock_paper_scissors.play.spi;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.ddd.DomainService;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.play.domain.Move;
import java.util.Random;
@DomainService
public class RandomCpuPicker implements CpuPick {
private final Random random = new Random();
@Override
public Move pick() {
return Move.values()[random.nextInt(Move.values().length)];
}
}

View File

@@ -0,0 +1,46 @@
package fr.iut_fbleau.info.but3.automation.rock_paper_scissors.play.web;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.play.domain.RoundResult;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.play.RockPaperScissorsPlay;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/play")
@Tag(name = "Play", description = "Rock Paper Scissors game endpoints")
public class PlayController {
private final RockPaperScissorsPlay rockPaperScissorsPlay;
public PlayController(RockPaperScissorsPlay rockPaperScissorsPlay) {
this.rockPaperScissorsPlay = rockPaperScissorsPlay;
}
@Operation(
summary = "Play a round",
description = "Play a round of Rock Paper Scissors against the CPU",
responses = {
@ApiResponse(
responseCode = "200",
description = "Round completed successfully",
content = @Content(schema = @Schema(implementation = PlayResponse.class))
)
}
)
@PostMapping
public PlayResponse play(
@Parameter(description = "Player name and move", required = true)
@RequestBody PlayRequest request
) {
RoundResult roundResult = rockPaperScissorsPlay.playRound(request.name(), request.move());
return new PlayResponse(roundResult);
}
}

View File

@@ -0,0 +1,6 @@
package fr.iut_fbleau.info.but3.automation.rock_paper_scissors.play.web;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.play.domain.Move;
public record PlayRequest(String name, Move move) {
}

View File

@@ -0,0 +1,10 @@
package fr.iut_fbleau.info.but3.automation.rock_paper_scissors.play.web;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.play.domain.Move;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.play.domain.RoundResult;
public record PlayResponse(String result, Move cpu) {
public PlayResponse(RoundResult roundResult) {
this(roundResult.result(), roundResult.cpuChoice());
}
}

View File

@@ -0,0 +1,7 @@
package fr.iut_fbleau.info.but3.automation.rock_paper_scissors.stat;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.stat.domain.StatBoard;
public interface StatBoardGet {
StatBoard board();
}

View File

@@ -0,0 +1,5 @@
package fr.iut_fbleau.info.but3.automation.rock_paper_scissors.stat;
public interface StatSave {
void addWin(String name);
}

View File

@@ -0,0 +1,16 @@
package fr.iut_fbleau.info.but3.automation.rock_paper_scissors.stat.configuration;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.ddd.DomainService;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.ddd.Stub;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.stat.domain.StatBoard;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.stat.spi.StatRepository;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;
@Configuration
@ComponentScan(
basePackageClasses = {StatBoard.class, StatRepository.class},
includeFilters = {@ComponentScan.Filter(type = FilterType.ANNOTATION, classes = {DomainService.class, Stub.class})})
public class StatConfiguration {
}

View File

@@ -0,0 +1,6 @@
package fr.iut_fbleau.info.but3.automation.rock_paper_scissors.stat.domain;
import java.util.Map;
public record StatBoard(Map<String, Integer> stats) {
}

View File

@@ -0,0 +1,13 @@
package fr.iut_fbleau.info.but3.automation.rock_paper_scissors.stat.domain;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.ddd.DomainService;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.stat.StatBoardGet;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.stat.spi.StatRepository;
@DomainService
public record StatBoardGetter(StatRepository statRepository) implements StatBoardGet {
@Override
public StatBoard board() {
return statRepository.board();
}
}

View File

@@ -0,0 +1,13 @@
package fr.iut_fbleau.info.but3.automation.rock_paper_scissors.stat.domain;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.ddd.DomainService;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.stat.StatSave;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.stat.spi.StatRepository;
@DomainService
public record StatSaver(StatRepository statRepository) implements StatSave {
@Override
public void addWin(String name) {
this.statRepository.add(name);
}
}

View File

@@ -0,0 +1 @@
package fr.iut_fbleau.info.but3.automation.rock_paper_scissors.stat;

View File

@@ -0,0 +1,9 @@
package fr.iut_fbleau.info.but3.automation.rock_paper_scissors.stat.spi;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.stat.domain.StatBoard;
public interface StatRepository {
void add(String name);
StatBoard board();
}

View File

@@ -0,0 +1,33 @@
package fr.iut_fbleau.info.but3.automation.rock_paper_scissors.stat.spi.stub;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.ddd.Stub;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.stat.domain.StatBoard;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.stat.spi.StatRepository;
import java.util.HashMap;
import java.util.Map;
@Stub
public record InMemoryStatRepository(Map<String, Integer> stats) implements StatRepository {
public InMemoryStatRepository() {
HashMap<String, Integer> stats1 = new HashMap<>();
stats1.put("joe", 1);
stats1.put("eoj", 3);
this(stats1);
}
@Override
public void add(String name) {
this.stats.put(name, this.stats.getOrDefault(name, 0) + 1);
}
@Override
public StatBoard board() {
return new StatBoard(this.stats);
}
public int get(String name) {
return stats.getOrDefault(name, 0);
}
}

View File

@@ -0,0 +1,9 @@
package fr.iut_fbleau.info.but3.automation.rock_paper_scissors.stat.web;
import java.util.Map;
public record Stat(String name, int wins) {
public static Stat fromMap(Map.Entry<String, Integer> stringIntegerEntry) {
return new Stat(stringIntegerEntry.getKey(), stringIntegerEntry.getValue());
}
}

View File

@@ -0,0 +1,14 @@
package fr.iut_fbleau.info.but3.automation.rock_paper_scissors.stat.web;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.stat.domain.StatBoard;
import java.util.List;
public record StatBoardReponse(List<Stat> stats) {
public StatBoardReponse(StatBoard statBoard) {
this(statBoard.stats().entrySet().stream()
.map(Stat::fromMap)
.toList());
}
}

View File

@@ -0,0 +1,30 @@
package fr.iut_fbleau.info.but3.automation.rock_paper_scissors.stat.web;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.stat.domain.StatBoardGetter;
import fr.iut_fbleau.info.but3.automation.rock_paper_scissors.stat.domain.StatSaver;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.responses.ApiResponses;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/stat")
@Tag(name = "Statistics", description = "Statistics management API")
public record StatController(StatBoardGetter statBoardGetter, StatSaver statSaver) {
@Operation(summary = "Get statistics board", description = "Returns the current statistics board with player wins")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Statistics retrieved successfully",
content = {@Content(mediaType = "application/json",
schema = @Schema(implementation = StatBoardReponse.class))}),
})
@GetMapping
public StatBoardReponse board() {
return new StatBoardReponse(statBoardGetter.board());
}
}

View File

@@ -0,0 +1 @@
spring.application.name=rock-paper-scissors