diff --git a/backend/pronunciationAppBack/pom.xml b/backend/pronunciationAppBack/pom.xml index 5963cf3b7..68220ba2e 100644 --- a/backend/pronunciationAppBack/pom.xml +++ b/backend/pronunciationAppBack/pom.xml @@ -34,6 +34,11 @@ org.springframework.boot spring-boot-starter-data-jpa + + org.projectlombok + lombok + true + org.springframework.boot spring-boot-starter-web diff --git a/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/controller/HealthController.java b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/controller/HealthController.java new file mode 100644 index 000000000..27dcc7185 --- /dev/null +++ b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/controller/HealthController.java @@ -0,0 +1,88 @@ +package dev.pronunciationAppBack.controller; + + +import dev.pronunciationAppBack.service.WordService; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RestController; + +import java.util.Date; +import java.util.HashMap; +import java.util.Map; + +@RestController +@RequestMapping("/api/health") +public class HealthController { + + @Autowired + private WordService wordService; + + @GetMapping + public ResponseEntity> healthCheck() { + Map healthStatus = new HashMap<>(); + healthStatus.put("status", "UP"); + healthStatus.put("timestamp", new Date()); + healthStatus.put("wordCount", wordService.getWordCount()); + + // verify database connection + boolean databaseConnection = checkDatabaseConnection(); + healthStatus.put("database", databaseConnection ? "Connected" : "Disconnected"); + + // Add more health checks as needed + healthStatus.put("memoryUsage", getMemoryUsage()); + healthStatus.put("diskSpace", getDiskSpace()); + + // Add PID, Java version, and other process info + healthStatus.put("pid", ProcessHandle.current().pid()); + healthStatus.put("javaVersion", System.getProperty("java.version")); + healthStatus.put("javaVendor", System.getProperty("java.vendor")); + healthStatus.put("osName", System.getProperty("os.name")); + healthStatus.put("osVersion", System.getProperty("os.version")); + + HttpHeaders headers = getCommonHeaders("Health check endpoint"); + HttpStatus status = databaseConnection ? HttpStatus.OK : HttpStatus.SERVICE_UNAVAILABLE; + + return new ResponseEntity<>(healthStatus, headers, status); + } + + private boolean checkDatabaseConnection() { + try { + wordService.getAllWords(); + return true; + } catch (Exception e) { + return false; + } + } + + private Map getMemoryUsage() { + Runtime runtime = Runtime.getRuntime(); + Map memoryInfo = new HashMap<>(); + memoryInfo.put("total", runtime.totalMemory()); + memoryInfo.put("free", runtime.freeMemory()); + memoryInfo.put("used", runtime.totalMemory() - runtime.freeMemory()); + return memoryInfo; + } + + private Map getDiskSpace() { + java.io.File root = new java.io.File("/"); + Map diskInfo = new HashMap<>(); + diskInfo.put("total", root.getTotalSpace()); + diskInfo.put("free", root.getFreeSpace()); + diskInfo.put("usable", root.getUsableSpace()); + return diskInfo; + } + + private HttpHeaders getCommonHeaders(String description) { + HttpHeaders headers = new HttpHeaders(); + headers.add("desc", description); + headers.add("content-type", "application/json"); + headers.add("date", new Date().toString()); + headers.add("server", "Spring Boot"); + headers.add("version", "1.0.0"); + return headers; + } +} diff --git a/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/controller/StageWordController.java b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/controller/StageWordController.java new file mode 100644 index 000000000..1d5a57c1e --- /dev/null +++ b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/controller/StageWordController.java @@ -0,0 +1,87 @@ +package dev.pronunciationAppBack.controller; + +import dev.pronunciationAppBack.model.StageWord; +import dev.pronunciationAppBack.service.StageWordService; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.*; + +import java.util.Date; +import java.util.List; +import java.util.Optional; + +@RestController +@RequestMapping("/api/stagewords") +public class StageWordController { + + @Autowired + private StageWordService stageWordService; + + @GetMapping + public ResponseEntity> getAllStageWords() { + List stageWords = stageWordService.getAllStageWords(); + HttpHeaders headers = getCommonHeaders("Get all stage words"); + + return !stageWords.isEmpty() + ? new ResponseEntity<>(stageWords, headers, HttpStatus.OK) + : new ResponseEntity<>(headers, HttpStatus.NOT_FOUND); + } + + @GetMapping("/{id}") + public ResponseEntity getStageWordById(@PathVariable String id) { + Optional stageWord = stageWordService.getStageWordById(id); + HttpHeaders headers = getCommonHeaders("Get stage word by ID"); + + return stageWord.map(value -> new ResponseEntity<>(value, headers, HttpStatus.OK)) + .orElseGet(() -> new ResponseEntity<>(headers, HttpStatus.NOT_FOUND)); + } + + @PostMapping("/createStageWord") + public ResponseEntity createStageWord(@RequestBody StageWord stageWord) { + StageWord createdStageWord = stageWordService.createStageWord(stageWord); + HttpHeaders headers = getCommonHeaders("Create a new stage word"); + + return new ResponseEntity<>(createdStageWord, headers, HttpStatus.CREATED); + } + + @PutMapping("/{id}") + public ResponseEntity updateStageWord(@PathVariable String id, @RequestBody StageWord stageWord) { + StageWord updatedStageWord = stageWordService.updateStageWord(stageWord); + HttpHeaders headers = getCommonHeaders("Update a stage word"); + + return new ResponseEntity<>(updatedStageWord, headers, HttpStatus.OK); + } + + @DeleteMapping("/{id}") + public ResponseEntity deleteStageWord(@PathVariable("id") String idToDelete) { + HttpHeaders headers = getCommonHeaders("Delete a stage word"); + + if (stageWordService.existsById(idToDelete)) { + stageWordService.deleteStageWord(idToDelete); + return new ResponseEntity<>("Stage word deleted", headers, HttpStatus.OK); + } else { + return new ResponseEntity<>("Stage word not found", headers, HttpStatus.NOT_FOUND); + } + } + + @DeleteMapping + public ResponseEntity deleteAllStageWords() { + stageWordService.deleteAllStageWords(); + HttpHeaders headers = getCommonHeaders("Delete all stage words"); + return new ResponseEntity<>("All stage words deleted", headers, HttpStatus.OK); + } + + private HttpHeaders getCommonHeaders(String description) { + HttpHeaders headers = new HttpHeaders(); + headers.add("desc", description); + headers.add("content-type", "application/json"); + headers.add("date", new Date().toString()); + headers.add("server", "Spring Boot"); + headers.add("version", "1.0.0"); + headers.add("stage-word-count", String.valueOf(stageWordService.getStageWordCount())); + headers.add("object", "stage-words"); + return headers; + } +} diff --git a/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/controller/WordController.java b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/controller/WordController.java new file mode 100644 index 000000000..908061ccb --- /dev/null +++ b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/controller/WordController.java @@ -0,0 +1,88 @@ +package dev.pronunciationAppBack.controller; + +import dev.pronunciationAppBack.model.Word; +import dev.pronunciationAppBack.service.WordService; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.*; + +import java.util.Date; +import java.util.List; +import java.util.Optional; + +@RestController +@RequestMapping("/api/words") +public class WordController { + + @Autowired + private WordService wordService; + + @GetMapping + public ResponseEntity> getAllWords() { + List words = wordService.getAllWords(); + HttpHeaders headers = getCommonHeaders("Get all words"); + + return !words.isEmpty() + ? new ResponseEntity<>(words, headers, HttpStatus.OK) + : new ResponseEntity<>(headers, HttpStatus.NOT_FOUND); + } + + @GetMapping("/{id}") + public ResponseEntity getWordById(@PathVariable String id) { + Optional word = wordService.getWordById(id); + HttpHeaders headers = getCommonHeaders("Get word by ID"); + + return word.map(value -> new ResponseEntity<>(value, headers, HttpStatus.OK)) + .orElseGet(() -> new ResponseEntity<>(headers, HttpStatus.NOT_FOUND)); + } + + @PostMapping("/createWord") + public ResponseEntity createWord(@RequestBody Word word) { + Word createdWord = wordService.createWord(word); + HttpHeaders headers = getCommonHeaders("Create a new word"); + + return new ResponseEntity<>(createdWord, headers, HttpStatus.CREATED); + } + + @PutMapping("/{id}") + public ResponseEntity updateWord(@PathVariable String id, @RequestBody Word word) { + Word updatedWord = wordService.updateWord(word); + HttpHeaders headers = getCommonHeaders("Update a word"); + + return new ResponseEntity<>(updatedWord, headers, HttpStatus.OK); + } + + @DeleteMapping("/{id}") + public ResponseEntity deleteWord(@PathVariable("id") String idToDelete) { + HttpHeaders headers = getCommonHeaders("Delete a word"); + + if (wordService.existsById(idToDelete)) { + wordService.deleteWord(idToDelete); + return new ResponseEntity<>("Word deleted", headers, HttpStatus.OK); + } else { + return new ResponseEntity<>("Word not found", headers, HttpStatus.NOT_FOUND); + } + } + + @DeleteMapping + public ResponseEntity deleteAllWords() { + wordService.deleteAllWords(); + HttpHeaders headers = getCommonHeaders("Delete all words"); + return new ResponseEntity<>("All words deleted", headers, HttpStatus.OK); + } + + private HttpHeaders getCommonHeaders(String description) { + HttpHeaders headers = new HttpHeaders(); + headers.add("desc", description); + headers.add("content-type", "application/json"); + headers.add("date", new Date().toString()); + headers.add("server", "Spring Boot"); + headers.add("version", "1.0.0"); + headers.add("word-count", String.valueOf(wordService.getWordCount())); + headers.add("object", "words"); + return headers; + } +} + diff --git a/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/model/AppUser.java b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/model/AppUser.java new file mode 100644 index 000000000..9b35edbf9 --- /dev/null +++ b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/model/AppUser.java @@ -0,0 +1,31 @@ +package dev.pronunciationAppBack.model; + +import jakarta.persistence.*; +import lombok.AllArgsConstructor; +import lombok.Data; +import lombok.NoArgsConstructor; +import org.hibernate.annotations.GenericGenerator; + +@Entity +@Data +@NoArgsConstructor +@AllArgsConstructor +public class AppUser { + @Id + @GeneratedValue(generator = "UUID") + @GenericGenerator(name = "UUID", strategy = "org.hibernate.id.UUIDGenerator") + private String id; + + private String userName; + private int age; + private String email; + private String password; + private int totalScore; + private boolean isActive; + + @OneToOne + @JoinColumn (name = "game_progress_id", referencedColumnName = "id") + private GameProgress gameProgress; +} + + diff --git a/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/model/Category.java b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/model/Category.java new file mode 100644 index 000000000..121308949 --- /dev/null +++ b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/model/Category.java @@ -0,0 +1,26 @@ +package dev.pronunciationAppBack.model; + +import jakarta.persistence.*; + +import java.util.HashSet; +import java.util.Set; + +@Entity +public class Category { + @Id + @GeneratedValue(strategy = GenerationType.IDENTITY) + private Long id; + private String categoryName; + private String description; + + + @ManyToMany(cascade = {CascadeType.PERSIST, CascadeType.MERGE}, orphanRemoval = true) + @JoinTable ( + name = "word_category", + joinColumns = @JoinColumn(name = "category_id"), + inverseJoinColumns = @JoinColumn(name = "word_id") + ) + private Set words = new HashSet<>(); + + +} \ No newline at end of file diff --git a/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/model/GameProgress.java b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/model/GameProgress.java new file mode 100644 index 000000000..24b33aa47 --- /dev/null +++ b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/model/GameProgress.java @@ -0,0 +1,42 @@ +package dev.pronunciationAppBack.model; + +import jakarta.persistence.*; +import lombok.AllArgsConstructor; +import lombok.Data; +import lombok.NoArgsConstructor; +import org.hibernate.annotations.GenericGenerator; +import jakarta.persistence.Enumerated; + +import java.util.Date; + +@Entity +@Data +@NoArgsConstructor +@AllArgsConstructor +public class GameProgress { + @Id + @GeneratedValue(generator = "UUID") + @GenericGenerator(name = "UUID", strategy = "org.hibernate.id.UUIDGenerator") + private String id; + + @OneToOne + @JoinColumn(mappedBy = "gameProgress") + private AppUser appUser; + + private int currentScore; + + public enum Stage { + STAGE_01, STAGE_02, STAGE_03, STAGE_04, STAGE_05 + } + + @Enumerated(EnumType.STRING) + private Stage currentStage; + + @Temporal(TemporalType.TIMESTAMP) + private Date lastPlayedDate; + + private int wordsLearned; + + + +} \ No newline at end of file diff --git a/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/model/Pronunciation.java b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/model/Pronunciation.java new file mode 100644 index 000000000..a99da8c0e --- /dev/null +++ b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/model/Pronunciation.java @@ -0,0 +1,38 @@ +package dev.pronunciationAppBack.model; + +import com.fasterxml.jackson.annotation.JsonIgnore; +import jakarta.persistence.Entity; +import jakarta.persistence.Id; +import jakarta.persistence.JoinColumn; +import jakarta.persistence.ManyToOne; +import lombok.AllArgsConstructor; +import lombok.Data; +import lombok.NoArgsConstructor; + +@Data +@NoArgsConstructor +@AllArgsConstructor +@Entity +public class Pronunciation { + @Id + private String id; + private String audioDescription; + private long audioDuration; + private long audioSize; + private String audioUrl; + private String definition; + private String phoneticSpelling; + private String speakerGender; + public enum type { + RECORDED, SAMPLE + } + private type type; + + @JsonIgnore + @ManyToOne + @JoinColumn(name = "WORD_ID_FK") + private Word word; + + + +} diff --git a/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/model/StageWord.java b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/model/StageWord.java new file mode 100644 index 000000000..6d74b9e27 --- /dev/null +++ b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/model/StageWord.java @@ -0,0 +1,34 @@ +package dev.pronunciationAppBack.model; + +import jakarta.persistence.*; +import lombok.Getter; +import lombok.Setter; +import lombok.NoArgsConstructor; +import lombok.AllArgsConstructor; +import lombok.ToString; + +import java.util.Date; + +@Entity +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +@ToString +public class StageWord { + + @Id + private String id; + @Enumerated(EnumType.STRING) + private Status status; + private int listenedQty; + private Date lastUpdatedDateTime; + + public enum Status { + DONE, PENDING, FAIL + } + + @ManyToOne + @JoinColumn(name = "WORD_ID_FK") + private Word word; +} diff --git a/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/model/Word.java b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/model/Word.java new file mode 100644 index 000000000..437792d08 --- /dev/null +++ b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/model/Word.java @@ -0,0 +1,123 @@ +package dev.pronunciationAppBack.model; + +import jakarta.persistence.*; + + +import java.util.HashSet; +import java.util.List; +import java.util.Set; + +@Entity +public class Word { + + @Id + private String id; + private String wordName; + private String definition; + private String phoneticSpelling; + private String sentence; + private boolean isActive; + private int level; + + @OneToMany(mappedBy = "word") + private List pronunciations; + + @ManyToMany(cascade = {CascadeType.PERSIST, CascadeType.MERGE}, orphanRemoval = true) + @JoinTable ( + name = "word_category", + joinColumns = @JoinColumn(name = "word_id"), + inverseJoinColumns = @JoinColumn(name = "category_id") + ) + private Set categories = new HashSet<>(); + + public Word() {} + + public Word(String id, String wordName, String definition, String phoneticSpelling, String sentence, boolean isActive, int level) { + this.id = id; + this.wordName = wordName; + this.definition = definition; + this.phoneticSpelling = phoneticSpelling; + this.sentence = sentence; + this.isActive = isActive; + this.level = level; + } + + public List getPronunciations() { + return pronunciations; + } + + public void setPronunciations(List pronunciations) { + this.pronunciations = pronunciations; + } + + public String getId() { + return id; + } + + public String getWordName() { + return wordName; + } + + public String getDefinition() { + return definition; + } + + public String getPhoneticSpelling() { + return phoneticSpelling; + } + + public String getSentence() { + return sentence; + } + + public boolean isActive() { + return isActive; + } + + public int getLevel() { + return level; + } + + public void setId(String id) { + this.id = id; + } + + public void setWordName(String wordName) { + this.wordName = wordName; + } + + public void setDefinition(String definition) { + this.definition = definition; + } + + public void setPhoneticSpelling(String phoneticSpelling) { + this.phoneticSpelling = phoneticSpelling; + } + + public void setSentence(String sentence) { + this.sentence = sentence; + } + + public void setActive(boolean active) { + isActive = active; + } + + public void setLevel(int level) { + this.level = level; + } + + @Override + public String toString() { + return "Word{" + + "id='" + id + '\'' + + ", wordName='" + wordName + '\'' + + ", definition='" + definition + '\'' + + ", phoneticSpelling='" + phoneticSpelling + '\'' + + ", sentence='" + sentence + '\'' + + ", isActive=" + isActive + + ", level=" + level + + '}'; + } + + +} diff --git a/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/repository/AppUserRepository.java b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/repository/AppUserRepository.java new file mode 100644 index 000000000..5b0235140 --- /dev/null +++ b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/repository/AppUserRepository.java @@ -0,0 +1,15 @@ +package dev.pronunciationAppBack.repository; + +import dev.pronunciationAppBack.model.AppUser; +import org.springframework.data.jpa.repository.JpaRepository; + +import java.util.List; + + +public interface AppUserRepository extends JpaRepository { + List findByIsActiveTrue(); + + AppUser findByEmail(String email); + + List findByAgeGreaterThan(int age); +} diff --git a/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/repository/GameProgressRepository.java b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/repository/GameProgressRepository.java new file mode 100644 index 000000000..e9523bfb7 --- /dev/null +++ b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/repository/GameProgressRepository.java @@ -0,0 +1,19 @@ +package dev.pronunciationAppBack.repository; + +import dev.pronunciationAppBack.model.GameProgress; +import org.springframework.data.jpa.repository.JpaRepository; + +import java.util.Date; +import java.util.List; + +public interface GameProgressRepository extends JpaRepository { + List findByCurrentStage(GameProgress.Stage stage); + + List findByLastPlayedDateAfter(Date date); + + List findByWordsLearnedGreaterThan(int count); + + GameProgress findByAppUserId(String userId); + + List findByCurrentScoreGreaterThan(int score); +} diff --git a/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/repository/PronunciationRepository.java b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/repository/PronunciationRepository.java new file mode 100644 index 000000000..8fd7703f6 --- /dev/null +++ b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/repository/PronunciationRepository.java @@ -0,0 +1,16 @@ +package dev.pronunciationAppBack.repository; + +import dev.pronunciationAppBack.model.Pronunciation; +import org.springframework.data.jpa.repository.JpaRepository; + +import java.util.List; + +public interface PronunciationRepository extends JpaRepository { + List findByType(Pronunciation.type type); + + List findBySpeakerGender(String gender); + + List findByWordId(String wordId); + + List findByPhoneticSpellingContaining(String phoneticSpelling); +} diff --git a/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/repository/StageWordRepository.java b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/repository/StageWordRepository.java new file mode 100644 index 000000000..24af36ca8 --- /dev/null +++ b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/repository/StageWordRepository.java @@ -0,0 +1,10 @@ +package dev.pronunciationAppBack.repository; + +import dev.pronunciationAppBack.model.StageWord; +import org.springframework.data.jpa.repository.JpaRepository; + +import java.util.List; + +public interface StageWordRepository extends JpaRepository { + List findByStatus(StageWord.Status status); +} diff --git a/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/repository/WordRepository.java b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/repository/WordRepository.java new file mode 100644 index 000000000..e0d4c25cb --- /dev/null +++ b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/repository/WordRepository.java @@ -0,0 +1,10 @@ +package dev.pronunciationAppBack.repository; + +import dev.pronunciationAppBack.model.Word; +import org.springframework.data.jpa.repository.JpaRepository; + + +public interface WordRepository extends JpaRepository { + Word getWordById(String id); + Word getWordByPhoneticSpelling(String pronunciation); +} diff --git a/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/service/AppUserService.java b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/service/AppUserService.java new file mode 100644 index 000000000..d9da88d81 --- /dev/null +++ b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/service/AppUserService.java @@ -0,0 +1,61 @@ +package dev.pronunciationAppBack.service; + +import dev.pronunciationAppBack.model.AppUser; +import dev.pronunciationAppBack.repository.AppUserRepository; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Service; + +import java.util.List; +import java.util.Optional; + +@Service +public class AppUserService { + + @Autowired + private AppUserRepository appUserRepository; + + public List getAllUsers() { + return appUserRepository.findAll(); + } + + public Optional getUserById(String id) { + return appUserRepository.findById(id); + } + + public AppUser createUser(AppUser user) { + return appUserRepository.save(user); + } + + public AppUser updateUser(AppUser user) { + return appUserRepository.save(user); + } + + public void deleteUser(String id) { + appUserRepository.deleteById(id); + } + + public void deleteAllUsers() { + appUserRepository.deleteAll(); + } + + public boolean existsById(String id) { + return appUserRepository.existsById(id); + } + + public long getUserCount() { + return appUserRepository.count(); + } + + // Additional business logic can be added here + public List getActiveUsers() { + return appUserRepository.findByIsActiveTrue(); + } + + public AppUser getUserByEmail(String email) { + return appUserRepository.findByEmail(email); + } + + public List getUsersByAgeGreaterThan(int age) { + return appUserRepository.findByAgeGreaterThan(age); + } +} diff --git a/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/service/GameProgressService.java b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/service/GameProgressService.java new file mode 100644 index 000000000..189311cc1 --- /dev/null +++ b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/service/GameProgressService.java @@ -0,0 +1,70 @@ +package dev.pronunciationAppBack.service; + +import dev.pronunciationAppBack.model.GameProgress; +import dev.pronunciationAppBack.repository.GameProgressRepository; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Service; + +import java.util.List; +import java.util.Optional; +import java.util.Date; + +@Service +public class GameProgressService { + + @Autowired + private GameProgressRepository gameProgressRepository; + + public List getAllGameProgresses() { + return gameProgressRepository.findAll(); + } + + public Optional getGameProgressById(String id) { + return gameProgressRepository.findById(id); + } + + public GameProgress createGameProgress(GameProgress gameProgress) { + return gameProgressRepository.save(gameProgress); + } + + public GameProgress updateGameProgress(GameProgress gameProgress) { + return gameProgressRepository.save(gameProgress); + } + + public void deleteGameProgress(String id) { + gameProgressRepository.deleteById(id); + } + + public void deleteAllGameProgresses() { + gameProgressRepository.deleteAll(); + } + + public boolean existsById(String id) { + return gameProgressRepository.existsById(id); + } + + public long getGameProgressCount() { + return gameProgressRepository.count(); + } + + // Additional business logic methods + public List getGameProgressesByCurrentStage(GameProgress.Stage stage) { + return gameProgressRepository.findByCurrentStage(stage); + } + + public List getGameProgressesByLastPlayedDateAfter(Date date) { + return gameProgressRepository.findByLastPlayedDateAfter(date); + } + + public List getGameProgressesByWordsLearnedGreaterThan(int count) { + return gameProgressRepository.findByWordsLearnedGreaterThan(count); + } + + public GameProgress getGameProgressByAppUserId(String userId) { + return gameProgressRepository.findByAppUserId(userId); + } + + public List getGameProgressesByCurrentScoreGreaterThan(int score) { + return gameProgressRepository.findByCurrentScoreGreaterThan(score); + } +} diff --git a/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/service/PronunciationService.java b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/service/PronunciationService.java new file mode 100644 index 000000000..be5020ce9 --- /dev/null +++ b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/service/PronunciationService.java @@ -0,0 +1,66 @@ +package dev.pronunciationAppBack.service; + + +import dev.pronunciationAppBack.model.Pronunciation; +import dev.pronunciationAppBack.repository.PronunciationRepository; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Service; + +import java.util.List; +import java.util.Optional; + +@Service +public class PronunciationService { + + @Autowired + private PronunciationRepository pronunciationRepository; + + public List getAllPronunciations() { + return pronunciationRepository.findAll(); + } + + public Optional getPronunciationById(String id) { + return pronunciationRepository.findById(id); + } + + public Pronunciation createPronunciation(Pronunciation pronunciation) { + return pronunciationRepository.save(pronunciation); + } + + public Pronunciation updatePronunciation(Pronunciation pronunciation) { + return pronunciationRepository.save(pronunciation); + } + + public void deletePronunciation(String id) { + pronunciationRepository.deleteById(id); + } + + public void deleteAllPronunciations() { + pronunciationRepository.deleteAll(); + } + + public boolean existsById(String id) { + return pronunciationRepository.existsById(id); + } + + public long getPronunciationCount() { + return pronunciationRepository.count(); + } + + // Additional business logic methods + public List getPronunciationsByType(Pronunciation.type type) { + return pronunciationRepository.findByType(type); + } + + public List getPronunciationsBySpeakerGender(String gender) { + return pronunciationRepository.findBySpeakerGender(gender); + } + + public List getPronunciationsByWordId(String wordId) { + return pronunciationRepository.findByWordId(wordId); + } + + public List getPronunciationsByPhoneticSpelling(String phoneticSpelling) { + return pronunciationRepository.findByPhoneticSpellingContaining(phoneticSpelling); + } +} diff --git a/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/service/StageWordService.java b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/service/StageWordService.java new file mode 100644 index 000000000..37f222ad2 --- /dev/null +++ b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/service/StageWordService.java @@ -0,0 +1,53 @@ +package dev.pronunciationAppBack.service; + +import dev.pronunciationAppBack.model.StageWord; +import dev.pronunciationAppBack.repository.StageWordRepository; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Service; + +import java.util.List; +import java.util.Optional; + +@Service +public class StageWordService { + + @Autowired + private StageWordRepository stageWordRepository; + + public List getAllStageWords() { + return stageWordRepository.findAll(); + } + + public Optional getStageWordById(String id) { + return stageWordRepository.findById(id); + } + + public StageWord createStageWord(StageWord stageWord) { + return stageWordRepository.save(stageWord); + } + + public StageWord updateStageWord(StageWord stageWord) { + return stageWordRepository.save(stageWord); + } + + public void deleteStageWord(String id) { + stageWordRepository.deleteById(id); + } + + public void deleteAllStageWords() { + stageWordRepository.deleteAll(); + } + + public boolean existsById(String id) { + return stageWordRepository.existsById(id); + } + + public long getStageWordCount() { + return stageWordRepository.count(); + } + + // Additional business logic can be added here + public List getStageWordsByStatus(StageWord.Status status) { + return stageWordRepository.findByStatus(status); + } +} diff --git a/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/service/WordCategoryService.java b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/service/WordCategoryService.java new file mode 100644 index 000000000..91f3b42a1 --- /dev/null +++ b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/service/WordCategoryService.java @@ -0,0 +1,46 @@ +package dev.pronunciationAppBack.service; + +import dev.pronunciationAppBack.model.Category; +import dev.pronunciationAppBack.model.Word; +import org.springframework.beans.factory.annotation.Autowired; + +public class WordCategoryService { + + @Autowired + private WordRepository wordRepository; + + @Autowired + private CategoryRepository categoryRepository; + + public void assignCategory() { + // Create some categories + Category animal = new Category("Animal"); + Category furniture = new Category("Furniture"); + + // Save categories + categoryRepository.save(animal); + categoryRepository.save(furniture); + + // Create a word and assign it to a category. + Word dog = new Word("Dog"); + dog.assignCategory(animal); + + Word chair = new Word("Chair"); + chair.assignCategory(furniture); + + // Save the word in the database + categoryRepository.save(dog); + categoryRepository.save(chair); + + // Remove the category from the word + dog.removeCategory(animal); + chair.removeCategory(furniture); + + // Now if we save the word, it will be without a category. + categoryRepository.save(dog); + categoryRepository.save(chair); + + + } + +} diff --git a/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/service/WordService.java b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/service/WordService.java new file mode 100644 index 000000000..fba5d3e1b --- /dev/null +++ b/backend/pronunciationAppBack/src/main/java/dev/pronunciationAppBack/service/WordService.java @@ -0,0 +1,53 @@ +package dev.pronunciationAppBack.service; + +import dev.pronunciationAppBack.model.Word; +import dev.pronunciationAppBack.repository.WordRepository; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Service; + +import java.util.List; +import java.util.Optional; + +@Service +public class WordService { + + @Autowired + private WordRepository wordRepository; + + public List getAllWords() { + return wordRepository.findAll(); + } + + public Optional getWordById(String id) { + return Optional.ofNullable(wordRepository.getWordById(id)); + } + + public Word createWord(Word word) { + return wordRepository.save(word); + } + + public Word updateWord(Word word) { + return wordRepository.save(word); + } + + public void deleteWord(String id) { + wordRepository.deleteById(id); + } + + public void deleteAllWords() { + wordRepository.deleteAll(); + } + + public boolean existsById(String id) { + return wordRepository.existsById(id); + } + + public long getWordCount() { + return wordRepository.count(); + } + + // Additional business logic can be added here + public Word getWordByPhoneticSpelling(String pronunciation) { + return wordRepository.getWordByPhoneticSpelling(pronunciation); + } +} \ No newline at end of file diff --git a/backend/pronunciationAppBack/src/main/resources/application.properties b/backend/pronunciationAppBack/src/main/resources/application.properties index edb9ea0d2..83cb16f3e 100644 --- a/backend/pronunciationAppBack/src/main/resources/application.properties +++ b/backend/pronunciationAppBack/src/main/resources/application.properties @@ -1 +1,20 @@ spring.application.name=pronunciationAppBack + +# H2 DATABASE SERVER +spring.datasource.driverClassName=org.h2.Driver +spring.jpa.database-platform=org.hibernate.dialect.H2Dialect +spring.h2.console.enabled=true + +# H2 IN MEMORY +#spring.datasource.url=jdbc:h2:mem:testdb +#spring.datasource.username=sa +#spring.datasource.password= + + +# H2 LOCAL DB SERVER +spring.datasource.url=jdbc:h2:/home/albert/MyProjects/DataBase/pronunciationDB/pronunciationDB.db +spring.datasource.username=albert +spring.datasource.password=1234 + +# DDL OPTIONS: create-drop, create, update, none, validate +spring.jpa.hibernate.ddl-auto=none \ No newline at end of file diff --git a/backend/pronunciationAppBack/src/test/java/dev/pronunciationAppBack/PronunciationAppBackApplicationTests.java b/backend/pronunciationAppBack/src/test/java/dev/pronunciationAppBack/PronunciationAppBackApplicationTests.java index ea361613f..63c919e16 100644 --- a/backend/pronunciationAppBack/src/test/java/dev/pronunciationAppBack/PronunciationAppBackApplicationTests.java +++ b/backend/pronunciationAppBack/src/test/java/dev/pronunciationAppBack/PronunciationAppBackApplicationTests.java @@ -1,13 +1,67 @@ +/* package dev.pronunciationAppBack; +import dev.pronunciationAppBack.model.Word; +import dev.pronunciationAppBack.repository.WordRepository; import org.junit.jupiter.api.Test; -import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest; +import org.springframework.boot.test.autoconfigure.orm.jpa.TestEntityManager; -@SpringBootTest -class PronunciationAppBackApplicationTests { +import static org.assertj.core.api.Assertions.assertThat; + +@DataJpaTest +public class PronunciationAppBackApplicationTests { + + @Autowired + private TestEntityManager entityManager; + + @Autowired + private WordRepository wordRepository; + + @Test + public void testCreateWord() { + Word word = new Word("1", "Example", "A thing characteristic of its kind", "ɪɡˈzæmpəl", "This is an example sentence.", true, 1); + // assign the word object to the repository and save to H2 + Word savedWord = wordRepository.save(word); + assertThat(savedWord).isNotNull(); + assertThat(savedWord.getId()).isEqualTo("1"); + } + + @Test + public void testReadWord() { + Word word = new Word("2", "Test", "A procedure to evaluate", "test", "This is a test sentence.", true, 2); + entityManager.persist(word); + + Word foundWord = wordRepository.findById("2").orElse(null); + assertThat(foundWord).isNotNull(); + assertThat(foundWord.getWordName()).isEqualTo("Test"); + } @Test - void contextLoads() { + public void testUpdateWord() { + Word word = new Word("3", "Update", "To bring up to date", "ˈʌpdeɪt", "This word will be updated.", true, 3); + entityManager.persist(word); + + Word wordToUpdate = wordRepository.findById("3").orElse(null); + assertThat(wordToUpdate).isNotNull(); + wordToUpdate.setDefinition("To make something more modern or up to date"); + wordRepository.save(wordToUpdate); + + Word updatedWord = wordRepository.findById("3").orElse(null); + assertThat(updatedWord).isNotNull(); + assertThat(updatedWord.getDefinition()).isEqualTo("To make something more modern or up to date"); } + @Test + public void testDeleteWord() { + Word word = new Word("4", "Delete", "To remove or erase", "dɪˈliːt", "This word will be deleted.", true, 4); + entityManager.persist(word); + + wordRepository.deleteById("4"); + + Word deletedWord = wordRepository.findById("4").orElse(null); + assertThat(deletedWord).isNull(); + } } +*/ diff --git a/backend/pronunciationAppBack/src/test/java/dev/pronunciationAppBack/PronunciationTest.java b/backend/pronunciationAppBack/src/test/java/dev/pronunciationAppBack/PronunciationTest.java new file mode 100644 index 000000000..49d6a8707 --- /dev/null +++ b/backend/pronunciationAppBack/src/test/java/dev/pronunciationAppBack/PronunciationTest.java @@ -0,0 +1,59 @@ +package dev.pronunciationAppBack; + +import dev.pronunciationAppBack.repository.PronunciationRepository; +import dev.pronunciationAppBack.repository.WordRepository; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest; + +import dev.pronunciationAppBack.model.Word; +import dev.pronunciationAppBack.model.Pronunciation; +import org.springframework.boot.test.context.SpringBootTest; + +import java.util.Optional; + +@SpringBootTest +public class PronunciationTest { + + @Autowired + WordRepository wordRepository; + @Autowired + PronunciationRepository pronunciationRepository; + + @Test + public void AssignTestWord(){ + + //Word w1 = new Word(); + + Pronunciation p1 = new Pronunciation(); + p1.setId("1"); + p1.setAudioDescription("test"); + p1.setAudioDuration(1); + p1.setAudioSize(1); + p1.setAudioUrl("test"); + p1.setDefinition("test"); + p1.setPhoneticSpelling("test"); + p1.setSpeakerGender("test"); + p1.setType(Pronunciation.type.SAMPLE); + + pronunciationRepository.save(p1); + + // get word by id from repository + // by JPA repository by id returning optional container Word/Null + Optional optionalWord = wordRepository.findById("8f7d1b9e3a2c5f6e"); + System.out.println(optionalWord); + + if (optionalWord.isPresent()) { + // get word from optional container + p1.setWord(optionalWord.get()); + pronunciationRepository.save(p1); + } + + + + // pronunciationRepository.save(p1); + // w1.getPronunciations().add(p1); + // wordRepository.save(w1); + + } +} diff --git a/backend/pronunciationAppBack/src/test/java/dev/pronunciationAppBack/WordCategoryTest.java b/backend/pronunciationAppBack/src/test/java/dev/pronunciationAppBack/WordCategoryTest.java new file mode 100644 index 000000000..acd79c796 --- /dev/null +++ b/backend/pronunciationAppBack/src/test/java/dev/pronunciationAppBack/WordCategoryTest.java @@ -0,0 +1,47 @@ +package dev.pronunciationAppBack; + +import dev.pronunciationAppBack.model.Category; +import dev.pronunciationAppBack.model.Word; +import dev.pronunciationAppBack.repository.WordRepository; +import org.springframework.beans.factory.annotation.Autowired; + +public class WordCategoryTest { + + @Autowired + private WordRepository wordRepository; + + @Autowired + private CategoryRepository categoryRepository; + + public void assignCategory() { + // Create some categories + Category animal = new Category("Animal"); + Category furniture = new Category("Furniture"); + + // Save categories + categoryRepository.save(animal); + categoryRepository.save(furniture); + + // Create a word and assign it to a category. + Word dog = new Word("Dog"); + dog.assignCategory(animal); + + Word chair = new Word("Chair"); + chair.assignCategory(furniture); + + // Save the word in the database + categoryRepository.save(dog); + categoryRepository.save(chair); + + // Remove the category from the word + dog.removeCategory(animal); + chair.removeCategory(furniture); + + // Now if we save the word, it will be without a category. + categoryRepository.save(dog); + categoryRepository.save(chair); + + + } + +} diff --git a/backend/resources/Test-JUnit DB/test-JUnit-Word.md b/backend/resources/Test-JUnit DB/test-JUnit-Word.md new file mode 100644 index 000000000..e9312dc38 --- /dev/null +++ b/backend/resources/Test-JUnit DB/test-JUnit-Word.md @@ -0,0 +1,171 @@ +# Test JUnit Word H2 DB + +## Test + +Here are 4 simple test cases for CRUD operations using `JUnit` and `Spring Boot` for the Word `entity`: + +```java +package dev.pronunciationAppBack; + +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest; +import org.springframework.boot.test.autoconfigure.orm.jpa.TestEntityManager; + +import static org.assertj.core.api.Assertions.assertThat; + +@DataJpaTest +public class WordRepositoryTest { + + @Autowired + private TestEntityManager entityManager; + + @Autowired + private WordRepository wordRepository; + + @Test + public void testCreateWord() { + Word word = new Word("1", "Example", "A thing characteristic of its kind", "ɪɡˈzæmpəl", "This is an example sentence.", true, 1); + Word savedWord = wordRepository.save(word); + assertThat(savedWord).isNotNull(); + assertThat(savedWord.getId()).isEqualTo("1"); + } + + @Test + public void testReadWord() { + Word word = new Word("2", "Test", "A procedure to evaluate", "test", "This is a test sentence.", true, 2); + entityManager.persist(word); + + Word foundWord = wordRepository.findById("2").orElse(null); + assertThat(foundWord).isNotNull(); + assertThat(foundWord.getWordName()).isEqualTo("Test"); + } + + @Test + public void testUpdateWord() { + Word word = new Word("3", "Update", "To bring up to date", "ˈʌpdeɪt", "This word will be updated.", true, 3); + entityManager.persist(word); + + Word wordToUpdate = wordRepository.findById("3").orElse(null); + assertThat(wordToUpdate).isNotNull(); + wordToUpdate.setDefinition("To make something more modern or up to date"); + wordRepository.save(wordToUpdate); + + Word updatedWord = wordRepository.findById("3").orElse(null); + assertThat(updatedWord).isNotNull(); + assertThat(updatedWord.getDefinition()).isEqualTo("To make something more modern or up to date"); + } + + @Test + public void testDeleteWord() { + Word word = new Word("4", "Delete", "To remove or erase", "dɪˈliːt", "This word will be deleted.", true, 4); + entityManager.persist(word); + + wordRepository.deleteById("4"); + + Word deletedWord = wordRepository.findById("4").orElse(null); + assertThat(deletedWord).isNull(); + } +} +``` + +These test cases cover the basic CRUD (Create, Read, Update, Delete) operations for the Word entity. Here's a brief explanation of each test: + +1. `testCreateWord`: Tests the creation of a new Word entity. +2. `testReadWord`: Tests reading a Word entity from the database. +3. `testUpdateWord`: Tests updating an existing Word entity. +4. `testDeleteWord`: Tests deleting a Word entity from the database. + +## Repository + +Note that these tests assume you have a `WordRepository` interface that extends `JpaRepository`. You'll need to create this interface in your project: + +```java +package dev.pronunciationAppBack; + +import org.springframework.data.jpa.repository.JpaRepository; + +public interface WordRepository extends JpaRepository { +} +``` + +Also, make sure you have the necessary dependencies in your `pom.xml` or `build.gradle` file for Spring Boot Test and JPA Test. + +## H2 and application.properties + +> For these JUnit tests to run properly with an in-memory database, we need to add the `H2 database` dependency and configure the `application.properties` file. + +Here's what you need to add: + +1. H2 Database Dependency: + Add this to your `pom.xml` if you're using Maven: + +```xml + + com.h2database + h2 + test + +``` + +Or if you're using Gradle, add this to your `build.gradle`: + +```gradle +dependencies { + testImplementation 'com.h2database:h2' +} +``` + +2. Application Properties: + Create a file named `application.properties` in your `src/test/resources` directory with the following content: + +```properties +spring.datasource.url=jdbc:h2:mem:testdb +spring.datasource.driverClassName=org.h2.Driver +spring.datasource.username=sa +spring.datasource.password=password +spring.jpa.database-platform=org.hibernate.dialect.H2Dialect + +spring.jpa.hibernate.ddl-auto=create-drop +spring.jpa.show-sql=true +``` + +These settings will: + +- Configure an **in-memory H2 database for testing** +- Set up the database to create tables based on your entities and drop them after the tests +- Show SQL statements in the console, which can be helpful for debugging + +## Local DB + +First you must create the DB: + +```properties +# DDL OPTIONS: create-drop, create, update, none, validate +spring.jpa.hibernate.ddl-auto=create +``` + +Once created, change DDL to none + +```properties +spring.application.name=pronunciationAppBack + +# H2 DATABASE SERVER +spring.datasource.driverClassName=org.h2.Driver +spring.jpa.database-platform=org.hibernate.dialect.H2Dialect +spring.h2.console.enabled=true + +# H2 IN MEMORY +#spring.datasource.url=jdbc:h2:mem:testdb +#spring.datasource.username=sa +#spring.datasource.password= + + +# H2 LOCAL DB SERVER +spring.datasource.url=jdbc:h2:/home/albert/MyProjects/DataBase/pronunciationDB/pronunciationDB.db +spring.datasource.username=albert +spring.datasource.password=1234 + +# DDL OPTIONS: create-drop, create, update, none, validate +spring.jpa.hibernate.ddl-auto=none +``` diff --git a/backend/resources/annotations/Param-PathVariable.md b/backend/resources/annotations/Param-PathVariable.md new file mode 100644 index 000000000..386848a2f --- /dev/null +++ b/backend/resources/annotations/Param-PathVariable.md @@ -0,0 +1,66 @@ +# Param vs Path Variable + +## Using @DeleteMapping in Spring Boot with Postman + +Spring Boot's `@DeleteMapping` annotation simplifies the process of handling HTTP DELETE requests. + +> The `@DeleteMapping` annotation in Spring Boot provides a clean and efficient way to handle DELETE requests. Whether you choose to use path variables or query parameters depends on your API design preferences and requirements. Postman is an excellent tool for testing these endpoints, allowing you to easily send DELETE requests and verify the results. + +## DeleteWord Example + +Here's a simple example of a delete operation in a Spring Boot controller: + +```java +@RestController +@RequestMapping("/words") +public class WordController { + + @Autowired + private WordRepository wordRepository; + + @DeleteMapping("/{id}") + public String deleteWord(@PathVariable("id") String idToDelete) { + wordRepository.deleteById(idToDelete); + return "Word deleted"; + } +} +``` + +In this example, the `deleteWord` method is mapped to handle DELETE requests to the `/words/{id}` endpoint[1][4]. The `@PathVariable` annotation binds the `id` from the URL to the `idToDelete` parameter[3]. + +## Testing with Postman + +To test this endpoint using Postman, follow these steps: + +1. Open Postman and create a new request. +2. Set the HTTP method to DELETE. +3. Enter the URL: `http://localhost:8080/words/{id}` (replace `{id}` with the actual ID you want to delete). +4. Click the "Send" button to execute the request. + +### Using Path Variable + +For our `deleteWord` example, we're using a path variable. The ID is part of the URL path: + +``` +DELETE http://localhost:8080/words/123 +``` + +Here, `123` is the ID of the word to be deleted[5]. + +### Using Query Parameter (Alternative Approach) + +While our example uses a path variable, you could also design your endpoint to use a query parameter: + +```java +@DeleteMapping +public String deleteWord(@RequestParam("id") String idToDelete) { + wordRepository.deleteById(idToDelete); + return "Word deleted"; +} +``` + +To test this with Postman: + +1. Set the URL to `http://localhost:8080/words` +2. Add a query parameter: Key: `id`, Value: `123` +3. The full URL will look like: `http://localhost:8080/words?id=123` diff --git a/backend/resources/annotations/annotatin-xml.md b/backend/resources/annotations/annotatin-xml.md new file mode 100644 index 000000000..cb7005f65 --- /dev/null +++ b/backend/resources/annotations/annotatin-xml.md @@ -0,0 +1,120 @@ +# Annotations and xml + +> Spring Boot has significantly simplified configuration through extensive use of annotations, reducing the need for XML-based configuration. +> +> This shift towards annotation-based configuration became more prominent with Spring 2.1 and has continued to evolve in subsequent versions. + +Here's a simple example comparing XML-based configuration with annotation-based configuration in Spring Boot: + +XML Configuration: + +```xml + + + + + +``` + +Equivalent Annotation-based Configuration: + +```java +@Service +public class MyService { + @Autowired + private MyRepository repository; +} + +@Repository +public class MyRepository { + // Implementation +} +``` + +In this example, the `@Service` and `@Repository` annotations replace the XML bean definitions, while `@Autowired` handles dependency injection[3](https://docs.spring.io/spring-framework/reference/core/beans/annotation-config.html). + +#### Key Annotations in Spring Boot + +1. **@SpringBootApplication**: This annotation combines `@Configuration`, `@EnableAutoConfiguration`, and `@ComponentScan`. It's typically used on the main class of a Spring Boot application1. + +2. **@Component**: A generic stereotype for any Spring-managed component[3](https://docs.spring.io/spring-framework/reference/core/beans/annotation-config.html). + +3. **@Controller**, **@Service**, **@Repository**: Specializations of `@Component` for more specific use cases[3](https://docs.spring.io/spring-framework/reference/core/beans/annotation-config.html). + +4. **@Autowired**: Used for automatic dependency injection[3](https://docs.spring.io/spring-framework/reference/core/beans/annotation-config.html). + +5. **@Configuration**: Indicates that a class declares one or more `@Bean` methods and may be processed by the Spring container to generate bean definitions1. + +6. **@Bean**: Indicates that a method produces a bean to be managed by the Spring container1. + +7. **@Value**: Used to inject values from properties files into components[3](https://docs.spring.io/spring-framework/reference/core/beans/annotation-config.html). + +#### Advantages of Annotation-based Configuration + +1. **Reduced boilerplate**: Annotations significantly reduce the amount of configuration code needed1. + +2. **Type safety**: Annotations are checked at compile-time, reducing runtime errors[3](https://docs.spring.io/spring-framework/reference/core/beans/annotation-config.html). + +3. **Improved readability**: Annotations make the code more self-documenting1. + +4. **Easier refactoring**: Changes to class names or package structures are automatically reflected in the configuration[3](https://docs.spring.io/spring-framework/reference/core/beans/annotation-config.html). + +While annotations have become the preferred method of configuration in Spring Boot, it's still possible to use XML configuration when needed, especially for legacy systems or specific use cases. Spring Boot allows for mixing both approaches, providing flexibility in configuration strategies[2](https://www.springboottutorial.com/spring-boot-java-xml-context-configuration)[4](https://docs.spring.io/spring-framework/docs/4.2.x/spring-framework-reference/html/xsd-configuration.html). + +### Citations: + +1. [Spring Boot Tutorial: Mixing XML and Annotation Configuration - YouTube](https://www.youtube.com/watch?v=6arSdLciC_k) +2. [Java Annotation and XML Bean Configurations with Spring Boot | Spring Boot Tutorial](https://www.springboottutorial.com/spring-boot-java-xml-context-configuration) +3. [Annotation-based Container Configuration :: Spring Framework](https://docs.spring.io/spring-framework/reference/core/beans/annotation-config.html) +4. [XML Schema-based configuration](https://docs.spring.io/spring-framework/docs/4.2.x/spring-framework-reference/html/xsd-configuration.html) +5. [Do we need xml file for doing Spring configuration using Annotation? - Stack Overflow](https://stackoverflow.com/questions/38322967/do-we-need-xml-file-for-doing-spring-configuration-using-annotation) +6. [Spring Boot XML Configuration Example](https://www.javaguides.net/2018/09/spring-boot-xml-configuration-example.html) +7. [Spring Annotation and XML Based Configuration - Studytonight](https://www.studytonight.com/spring-framework/spring-annotation-and-xml-based-configuration) +8. [How can I use Spring Boot auto-configured beans in XML configuration files? - Stack Overflow](https://stackoverflow.com/questions/25495629/how-can-i-use-spring-boot-auto-configured-beans-in-xml-configuration-files) + +## Example + +```java +@JoinTable(name = "USER_PRODUCT" +joinColumns = @JoinColumn(name = "USER_FK"), +inverseJoinColumns = @JoinColumn(name = "PRODUCT_FK")) +public Set products +``` + +To configure the equivalent of the given `@JoinTable` annotation in `XML` for Spring MVC, you would use the following XML configuration: + +```xml + + + + + + + + + + + + + + + + + + + + +``` + +This `XML` configuration creates a many-to-many relationship between the `User` and `Product` entities using a join table named "`USER_PRODUCT`". The join column for the User entity is "`USER_FK`", and the inverse join column for the Product entity is "`PRODUCT_FK`"[1](https://stackoverflow.com/questions/30454300/spring-mvc-xml-configuration)[3](https://dzone.com/articles/spring-mvc-and-java-based-configuration-1). + +### Citations: + +1. [java - Spring MVC xml configuration - Stack Overflow](https://stackoverflow.com/questions/30454300/spring-mvc-xml-configuration) +2. [SQL INNER JOIN](https://www.w3schools.com/sql/sql_join_inner.asp) +3. https://dzone.com/articles/spring-mvc-and-java-based-configuration-1 +4. [Introduction to Spring Data JPA Part 8: Many-to-Many Bidirectional](https://dzone.com/articles/introduction-to-spring-data-jpa-part-8-many-to-man) +5. https://proliferay.com/xml-configuration-files-for-spring-mvc/ +6. [EclipseLink/Examples/JPA/2.0/ElementCollections - Eclipsepedia](https://wiki.eclipse.org/EclipseLink/Examples/JPA/2.0/ElementCollections) +7. [Spring MVC Basic Example Without Any XML Configuration.](https://codedeal.wixsite.com/codedeal/single-post/spring-mvc-basic-example-without-any-xml-configuration) +8. [Spring MVC :: Spring Boot](https://docs.spring.io/spring-boot/how-to/spring-mvc.html) diff --git a/backend/resources/cli-spring/create-spring-repo.sh b/backend/resources/cli-spring/create-spring-repo.sh new file mode 100755 index 000000000..cae608119 --- /dev/null +++ b/backend/resources/cli-spring/create-spring-repo.sh @@ -0,0 +1,60 @@ +#!/bin/bash + +# Set default values +JAVA_VERSION=21 +SPRING_BOOT_VERSION=3.4.2 +GROUP_ID="com.example" # You can change this or prompt the user for it +DEPENDENCIES="web,data-jpa,h2,devtools,lombok" #define dependencies + +# Prompt the user for the project name +read -p "Enter the Spring Boot project name: " PROJECT_NAME + +# Validate project name (optional, but recommended) +if [[ -z "$PROJECT_NAME" ]]; then + echo "Error: Project name cannot be empty." + exit 1 +fi + +# Prompt user for GitHub username +read -p "Enter your Github username: " GITHUB_USERNAME + +# Initialize the Spring Boot project +echo "Initializing Spring Boot project '$PROJECT_NAME'..." +spring init \ + --dependencies="$DEPENDENCIES" \ + --build=maven \ + --java-version="$JAVA_VERSION" \ + --packaging=jar \ + --version="$SPRING_BOOT_VERSION" \ + --name="$PROJECT_NAME" \ + --groupId="$GROUP_ID" \ + "$PROJECT_NAME" + +# Change directory to the project +cd "$PROJECT_NAME" || exit + +# Initialize Git repository +echo "Initializing Git repository..." +git init + +# Configure Git user (you might want to prompt the user for these, or set them globally) +git config user.name "$GITHUB_USERNAME" +git config user.email "$GITHUB_USERNAME@gmail.com" #modify + +# Create GitHub repository +echo "Creating GitHub repository '$PROJECT_NAME'..." +gh repo create "$PROJECT_NAME" --public + +# Add remote origin +echo "Adding remote origin..." +git remote add origin "https://github.com/$GITHUB_USERNAME/$PROJECT_NAME.git" + +# Add all files, commit, and push +echo "Adding files, committing, and pushing to GitHub..." +git add . +git commit -m "Initial commit" +git push -u origin master + +echo "Project '$PROJECT_NAME' created and pushed to GitHub successfully!" +exit 0 + diff --git a/backend/resources/cli-spring/spring-boot-cli.md b/backend/resources/cli-spring/spring-boot-cli.md new file mode 100644 index 000000000..6a3d0aece --- /dev/null +++ b/backend/resources/cli-spring/spring-boot-cli.md @@ -0,0 +1,77 @@ +# Build Spring Boot project by CLI + +- [Installing the CLI :: Spring Boot](https://docs.spring.io/spring-boot/cli/installation.html) +- [Using the CLI :: Spring Boot](https://docs.spring.io/spring-boot/cli/using-the-cli.html) +- https://start.spring.io/ + +Building by CLI Spring Boot projects is easy but your must be careful with no using a outdated versoin of Spring Boot CLI. + +To resolve this, you need to properly install the Spring Boot CLI, uninstalling the current/previous Spring CLI installation. + +If you do not have any previous or current installation go to step 3. + +Here's how to do it: + +1. First, uninstall the current Spring CLI installation: + +```bash +sudo apt remove spring +``` + +2. Install SDKMAN, which is a better tool for managing Spring Boot CLI: + +```bash +curl -s "https://get.sdkman.io" | bash source "$HOME/.sdkman/bin/sdkman-init.sh" +``` + +3. Use SDKMAN to install the latest Spring Boot CLI: + +```bash +sdk install springboot` +``` + +4. Verify the installation: + +```bash +spring --version +``` + +This should now show the latest version of Spring Boot CLI. + +5. Now, run `spring init`command: + +```bash +spring init \ + --dependencies=web,data-jpa,h2,devtools,lombok \ + --build=maven \ + --java-version=21 \ + --packaging=jar \ + --version=3.4.2 \ + --name=borrowabook \ + borrowabook +``` + +> If you still encounter issues, ensure that Java 21 is installed on your system, as Spring Boot 3.4.2 requires Java 17 or later. You can install Java 21 using: + +```bash +sudo apt install openjdk-21-jdk +``` + +After installing Java 21, set it as the default Java version: + +```bash +sudo update-alternatives --config java +``` + +Choose the option corresponding to Java 21. + +### Citations: + +1. [Spring Boot CLI Setup and HelloWorld Example | DigitalOcean](https://www.digitalocean.com/community/tutorials/spring-boot-cli-setup-and-helloworld-example) +2. [How to install spring boot CLI on Mac? - Stack Overflow](https://stackoverflow.com/questions/47704002/how-to-install-spring-boot-cli-on-mac) +3. [Spring Cloud CLI installation with Spring Boot 1.4 CLI - ClassNotFoundException - org.springframework.boot.cli.command.CommandFactory - Stack Overflow](https://stackoverflow.com/questions/38862408/spring-cloud-cli-installation-with-spring-boot-1-4-cli-classnotfoundexception) +4. [Installing the CLI :: Spring Boot](https://docs.spring.io/spring-boot/cli/installation.html) +5. [Install instructions do not work with spring-boot-cli 3.0.0 · Issue #180 · spring-cloud/spring-cloud-cli · GitHub](https://github.com/spring-cloud/spring-cloud-cli/issues/180) +6. [Spring Boot CLI :: Spring Boot](https://docs.spring.io/spring-boot/cli/index.html) +7. [Failed to run spring cloud cli · Issue #80 · spring-cloud/spring-cloud-cli · GitHub](https://github.com/spring-cloud/spring-cloud-cli/issues/80) +8. [Reddit - Dive into anything](https://www.reddit.com/r/SpringBoot/comments/1fm7ik0/install_springboot_cli_with_homebrew_doesnt/) diff --git a/backend/resources/containers/Containers-Spring.md b/backend/resources/containers/Containers-Spring.md new file mode 100644 index 000000000..4da920796 --- /dev/null +++ b/backend/resources/containers/Containers-Spring.md @@ -0,0 +1,150 @@ +# Popular Containers in Spring Boot + +> Containers in Java are typically defined by their ability to hold and manage collections of objects or references. + +However, for example, List`and`Optional` serve fundamentally different purposes: + +- `List` is a collection container designed to store multiple elements with order and allow dynamic manipulation. +- `Optional` is a wrapper to explicitly handle the presence or absence of a single value, preventing null reference issues. + +While both can "contain" elements, they solve distinct programming challenges: data storage versus null-safety management. + +#### Wrapper and Collection + +> A **wrapper** is a layer of code that "wraps around" something simpler, adding extra functionality or protection. Like a protective cover that makes something easier to use or more powerful. +> +> In Java, a wrapper takes a basic object or value and provides additional methods or behaviors to interact with it more conveniently. + + + +> A **Collection** is a more structured way of storing and managing those items, with methods to add, remove, and manipulate the group of elements. +> +> An **Iterable** is something you can loop through, like a collection of items. +> +> + +**Container Comparison: List vs Optional** + +| Characteristic | List | Optional | +| -------------------- | ------------------------------- | ------------------------------------------- | +| **Purpose** | Store multiple elements | Represent optional value | +| **Nullability** | Can contain null elements | Explicitly prevents null | +| **Size** | Dynamic, variable length | Always contains 0 or 1 element | +| **Mutability** | Mutable (add/remove elements) | Immutable | +| **Creation** | `new ArrayList<>()` | `Optional.of()`, `Optional.empty()` | +| **Common Methods** | `.add()`, `.remove()`, `.get()` | `.isPresent()`, `.orElse()`, `.ifPresent()` | +| **Java 8+ Feature** | Pre-Java 8 | Introduced in Java 8 | +| **Typical Use Case** | Collection storage | Avoiding null checks | +| **Stream Support** | `.stream()` directly | Treated as stream with `.stream()` | +| **Performance** | Higher memory overhead | Lightweight wrapper | + +### Response Containers + +1. **ResponseEntity** + + - Full control over HTTP response + - Set status codes, headers, body + - Example: + + ```java + return ResponseEntity.ok(word); + return ResponseEntity.notFound().build(); + return ResponseEntity.status(HttpStatus.CREATED).body(word); + ``` + +2. **Optional** + + - Prevent null pointer exceptions + - Avoid explicit null checks + - Example: + + ```java + Optional word = repository.findById(id); + return word.orElseThrow(() -> new ResourceNotFoundException()); + ``` + +3. **Page** + + - Pagination support + - Metadata about result set + - Example: + + ```java + Page words = repository.findAll(PageRequest.of(0, 10)); + ``` + +4. **Mono** and **Flux** (Reactive Programming) + + - Asynchronous data streams + - Non-blocking operations + - Example: + + ```java + Mono wordMono = wordRepository.findById(id); + Flux wordFlux = wordRepository.findAll(); + ``` + +5. **Resource** (HATEOAS) + + - Include hyperlinks in responses + - Support for hypermedia-driven APIs + - Example: + + ```java + Resource resource = new Resource<>(word); + resource.add(linkTo(methodOn(WordController.class).getWord(id)).withSelfRel()); + ``` + +### Key Benefits + +- Type safety +- Explicit error handling +- Flexible response management +- Support for modern architectural patterns + +## Non-Response + +### Data Containers + +1. **List** + + - Basic collection of elements + - Dynamic sizing + - Example: `List words = new ArrayList<>();` + +2. **Set** + + - Unique elements + - No duplicates + - Example: `Set uniqueWordNames = new HashSet<>();` + +3. **Map** + + - Key-value pairs + - Fast lookups + - Example: `Map wordMap = new HashMap<>();` + +4. **Stream** + + - Functional-style operations + - Lazy evaluation + - Example: `words.stream().filter(w -> w.getLevel() > 2)` + +5. **CompletableFuture** + + - Asynchronous computation + - Chaining operations + - Example: `CompletableFuture wordFuture = CompletableFuture.supplyAsync(() -> createWord());` + +6. **Queue** + + - First-In-First-Out (FIFO) + - Task scheduling + - Example: `Queue wordQueue = new LinkedList<>();` + +### Key Characteristics + +- Thread-safety +- Performance optimization +- Flexible data manipulation +- Support for functional programming diff --git a/backend/resources/CreateSpringBootproject.md b/backend/resources/create project/CreateSpringBootproject.md similarity index 100% rename from backend/resources/CreateSpringBootproject.md rename to backend/resources/create project/CreateSpringBootproject.md diff --git a/backend/resources/create project/create-spring-boot-b.png b/backend/resources/create project/create-spring-boot-b.png new file mode 100644 index 000000000..7230e9fdd Binary files /dev/null and b/backend/resources/create project/create-spring-boot-b.png differ diff --git a/backend/resources/create project/create-spring-boot.png b/backend/resources/create project/create-spring-boot.png new file mode 100644 index 000000000..415b8d1dd Binary files /dev/null and b/backend/resources/create project/create-spring-boot.png differ diff --git a/backend/resources/pronunciationAppBack-v0.0-project-structure.png b/backend/resources/create project/pronunciationAppBack-v0.0-project-structure.png similarity index 100% rename from backend/resources/pronunciationAppBack-v0.0-project-structure.png rename to backend/resources/create project/pronunciationAppBack-v0.0-project-structure.png diff --git a/backend/resources/start-spring-io-create-project.png b/backend/resources/create project/pronunciationAppBack-v0.0-spring-io-create-project.png similarity index 100% rename from backend/resources/start-spring-io-create-project.png rename to backend/resources/create project/pronunciationAppBack-v0.0-spring-io-create-project.png diff --git a/backend/resources/images/pronunciationAppBack-v0.0-api-rest-words.png b/backend/resources/images/pronunciationAppBack-v0.0-api-rest-words.png new file mode 100644 index 000000000..43e002693 Binary files /dev/null and b/backend/resources/images/pronunciationAppBack-v0.0-api-rest-words.png differ diff --git a/backend/resources/images/pronunciationAppBack-v0.0-basic-CRUD-controller-2.png b/backend/resources/images/pronunciationAppBack-v0.0-basic-CRUD-controller-2.png new file mode 100644 index 000000000..e97453151 Binary files /dev/null and b/backend/resources/images/pronunciationAppBack-v0.0-basic-CRUD-controller-2.png differ diff --git a/backend/resources/images/pronunciationAppBack-v0.0-basic-CRUD-controller.png b/backend/resources/images/pronunciationAppBack-v0.0-basic-CRUD-controller.png new file mode 100644 index 000000000..2d4acde25 Binary files /dev/null and b/backend/resources/images/pronunciationAppBack-v0.0-basic-CRUD-controller.png differ diff --git a/backend/resources/images/pronunciationAppBack-v0.0-db-2.png b/backend/resources/images/pronunciationAppBack-v0.0-db-2.png new file mode 100644 index 000000000..c6672f82a Binary files /dev/null and b/backend/resources/images/pronunciationAppBack-v0.0-db-2.png differ diff --git a/backend/resources/images/pronunciationAppBack-v0.0-db.png b/backend/resources/images/pronunciationAppBack-v0.0-db.png new file mode 100644 index 000000000..2a496ab0a Binary files /dev/null and b/backend/resources/images/pronunciationAppBack-v0.0-db.png differ diff --git a/backend/resources/images/pronunciationAppBack-v0.0-project-structure-2.png b/backend/resources/images/pronunciationAppBack-v0.0-project-structure-2.png new file mode 100644 index 000000000..22a050a1f Binary files /dev/null and b/backend/resources/images/pronunciationAppBack-v0.0-project-structure-2.png differ diff --git a/backend/resources/images/pronunciationAppBack-v0.0-project-structure.png b/backend/resources/images/pronunciationAppBack-v0.0-project-structure.png new file mode 100644 index 000000000..3dbc4ee10 Binary files /dev/null and b/backend/resources/images/pronunciationAppBack-v0.0-project-structure.png differ diff --git a/backend/resources/images/pronunciationAppBack-v0.2-checkhealth.png b/backend/resources/images/pronunciationAppBack-v0.2-checkhealth.png new file mode 100644 index 000000000..c62a94f9e Binary files /dev/null and b/backend/resources/images/pronunciationAppBack-v0.2-checkhealth.png differ diff --git a/backend/resources/images/pronunciationAppBack-v0.2-project-structure.png b/backend/resources/images/pronunciationAppBack-v0.2-project-structure.png new file mode 100644 index 000000000..d376fc077 Binary files /dev/null and b/backend/resources/images/pronunciationAppBack-v0.2-project-structure.png differ diff --git a/backend/resources/images/pronunciationAppBack-v0.3-db.png b/backend/resources/images/pronunciationAppBack-v0.3-db.png new file mode 100644 index 000000000..5d57a59ec Binary files /dev/null and b/backend/resources/images/pronunciationAppBack-v0.3-db.png differ diff --git a/backend/resources/images/pronunciationAppBack-v0.3-model.png b/backend/resources/images/pronunciationAppBack-v0.3-model.png new file mode 100644 index 000000000..cbe96193d Binary files /dev/null and b/backend/resources/images/pronunciationAppBack-v0.3-model.png differ diff --git a/backend/resources/images/pronunciationAppBack-v0.3-postman.png b/backend/resources/images/pronunciationAppBack-v0.3-postman.png new file mode 100644 index 000000000..2b4fcf2a3 Binary files /dev/null and b/backend/resources/images/pronunciationAppBack-v0.3-postman.png differ diff --git a/backend/resources/jpa/invalidate-cache/InvalidateCache.md b/backend/resources/jpa/invalidate-cache/InvalidateCache.md new file mode 100644 index 000000000..4d794da5d --- /dev/null +++ b/backend/resources/jpa/invalidate-cache/InvalidateCache.md @@ -0,0 +1,14 @@ +# Invalidate Cache + +> When switching branches in IntelliJ IDEA for Spring Boot projects a common issue appear: **no class is load into the IDE ** + +Here are some steps to resolve the problem: + +1. Invalidate caches and restart: Go to File > Invalidate Caches / Restart[5](https://stackoverflow.com/questions/12132003/getting-cannot-find-symbol-in-java-project-in-intellij). +2. Rebuild the project: Select Build > Rebuild Project[5](https://stackoverflow.com/questions/12132003/getting-cannot-find-symbol-in-java-project-in-intellij). +3. Reimport Maven dependencies: Right-click on the project, select Maven > Reimport[5](https://stackoverflow.com/questions/12132003/getting-cannot-find-symbol-in-java-project-in-intellij). +4. Enable annotation processing: Go to Preferences > Build, Execution, Deployment > Compiler > Annotation Processors and check "Enable annotation processing"[1](https://stackoverflow.com/questions/53031917/logback-references-are-red-in-intellij-using-spring-boot/53036773). +5. Ensure the Lombok plugin is installed: Go to Preferences > Plugins, search for Lombok, and install it if not already present[1](https://stackoverflow.com/questions/53031917/logback-references-are-red-in-intellij-using-spring-boot/53036773). +6. Check Java version: Make sure IntelliJ is set to use the correct Java version for your project[2](https://stackoverflow.com/questions/11632120/why-so-red-intellij-seems-to-think-every-declaration-method-cannot-be-found-res). +7. Verify source folders: Ensure that your source folders are correctly marked as "Sources" in the Project Structure (File > Project Structure > Modules > Sources)[4](https://www.jmri.org/help/en/html/doc/Technical/IntelliJ.shtml). +8. Delete the .idea folder: If the issue persists, try deleting the .idea folder and reimporting the project[2](https://stackoverflow.com/questions/11632120/why-so-red-intellij-seems-to-think-every-declaration-method-cannot-be-found-res). diff --git a/backend/resources/jpa/invalidate-cache/indexing-intelljidea.png b/backend/resources/jpa/invalidate-cache/indexing-intelljidea.png new file mode 100644 index 000000000..71ad9dd22 Binary files /dev/null and b/backend/resources/jpa/invalidate-cache/indexing-intelljidea.png differ diff --git a/backend/resources/jpa/invalidate-cache/invalidate-cache.png b/backend/resources/jpa/invalidate-cache/invalidate-cache.png new file mode 100644 index 000000000..e7d0d091a Binary files /dev/null and b/backend/resources/jpa/invalidate-cache/invalidate-cache.png differ diff --git a/backend/resources/jpa/jpa-hibernate-jdbc.png b/backend/resources/jpa/jpa-hibernate-jdbc.png new file mode 100644 index 000000000..cf6d0e302 Binary files /dev/null and b/backend/resources/jpa/jpa-hibernate-jdbc.png differ diff --git a/backend/resources/jpa/jpa.md b/backend/resources/jpa/jpa.md new file mode 100644 index 000000000..1b828ad61 --- /dev/null +++ b/backend/resources/jpa/jpa.md @@ -0,0 +1,119 @@ +# JPA + +- [Spring Boot: Data & DB – albertprofe wiki](https://albertprofe.dev/springboot/boot-concepts-data.html) + +- [Spring Boot: JPA & DI – albertprofe wiki](https://albertprofe.dev/springboot/boot-concepts-jpa.html) + +- [Spring Boot: JPA Mappings – albertprofe wiki](https://albertprofe.dev/springboot/boot-concepts-jpa-2.html) + +- [Spring Boot: JPA Relationships – albertprofe wiki](https://albertprofe.dev/springboot/boot-concepts-jpa-3.html) + +- [Spring Boot: JPA Queries – albertprofe wiki](https://albertprofe.dev/springboot/boot-concepts-jpa-4.html) + +- [Spring Boot: JPA Inherence – albertprofe wiki](https://albertprofe.dev/springboot/boot-concepts-jpa-5.html) + +- [Spring Boot: Scaling – albertprofe wiki](https://albertprofe.dev/springboot/boot-concepts-scaling.html) + +## Summary + +JPA stands for `Java Persistence API`. + +It is a Java specification for **managing, persisting, and accessing relational data** in Java applications. + +JPA is a **standard API for ORM (Object-Relational Mapping)** and provides a way to map Java objects to relational databases + +## Spring Boot DAL/DAO + +**ORM (Object-Relational Mapping)** + +> ORM is the concept of mapping object-oriented domain models to relational database tables. JPA and Hibernate are examples of ORM frameworks. + +```bash +App +└── Spring Data JPA + └── JPA (Java Persistence API) + └── Hibernate + └── JDBC (Java Database Connectivity) + └── Relational Database +``` + +**Application Layer** + +At the top, we have the application code that needs to interact with data. + +**Repository (Spring Data JPA)** + +Spring Data JPA provides a high-level abstraction for data access. It simplifies database operations by allowing developers to define interfaces that extend JpaRepository. For example: + +```java +public interface UserRepository extends JpaRepository { + List findByLastName(String lastName); +} +``` + +This interface automatically generates methods for common database operations. + +**JPA (Java Persistence API)** + +JPA is a specification that defines how to persist data in Java applications. + +**It's not an implementation**, but a set of interfaces and annotations that describe how to map Java objects to database tables. For example: + +```java +@Entity +public class User { + @Id + private Long id; + private String firstName; + private String lastName; +} +``` + +**Hibernate** + +Hibernate is a popular implementation of JPA. + + It provides the actual code that performs the object-relational mapping (ORM) based on JPA specifications. Hibernate translates JPA annotations and method calls into SQL queries. + +**JDBC (Java Database Connectivity)** + +JDBC is a low-level API for connecting Java applications to databases. + +It provides a set of Java classes and interfaces that send SQL statements to the database and process the results. Hibernate uses JDBC under the hood to communicate with the database. + +**Database** + +At the bottom is the actual database system, such as MySQL, PostgreSQL, or Oracle. + +## DAL/DAO for a 5yo + +Imagine you're building a house: + +- The **Application** is like the entire house. +- The **Repository** is like a smart assistant that helps you organize and find things in the house. +- **JPA** is like a blueprint that describes how rooms should be organized. +- **Hibernate** is the construction team that builds the rooms according to the blueprint. +- **JDBC** is like the basic tools (hammers, nails) the construction team uses. +- The **Database** is the foundation and structure of the house. +- **ORM** is the process of arranging the rooms to match how you want to use them. + +## Vendors and Context + +These technologies work together to simplify database operations in Java applications, from low-level database connections (JDBC) to high-level abstractions (Spring Data JPA) + +- JPA: Specification by Oracle (formerly Sun Microsystems) +- Hibernate: Open-source project maintained by Red Hat +- JDBC: Part of the Java Standard Edition (SE) platform +- Spring Data JPA: Part of the Spring Framework ecosystem +- Database vendors: MySQL (Oracle), PostgreSQL (open-source), Oracle Database, Microsoft SQL Server + +## CrudRepository vs. JpaRepository + +[In Spring Boot what is the difference between CrudRepository and JpaRepository in extending a Java repository interface - Stack Overflow](https://stackoverflow.com/questions/72058502/in-spring-boot-what-is-the-difference-between-crudrepository-and-jparepository-i) + +| CrudRepository | JpaRepository | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------- | +| CrudRepository does not provide any method for pagination and sorting. | JpaRepository extends PagingAndSortingRepository. It provides all the methods for implementing the pagination. | +| It works as a **marker** interface. | JpaRepository extends both **CrudRepository** and **PagingAndSortingRepository**. | +| It provides CRUD function only. For example **findById(), findAll(),** etc. | It provides some extra methods along with the method of PagingAndSortingRepository and CrudRepository. For example, **flush(), deleteInBatch().** | +| It is used when we do not need the functions provided by JpaRepository and PagingAndSortingRepository. | It is used when we want to implement pagination and sorting functionality in an application. | diff --git a/backend/resources/jpa/jparepository.png b/backend/resources/jpa/jparepository.png new file mode 100644 index 000000000..82c5d07b6 Binary files /dev/null and b/backend/resources/jpa/jparepository.png differ diff --git a/backend/resources/jpa/manytomany-example.png b/backend/resources/jpa/manytomany-example.png new file mode 100644 index 000000000..24fa3179a Binary files /dev/null and b/backend/resources/jpa/manytomany-example.png differ diff --git a/backend/resources/jpa/model/pronunciationApp-v0.2-model-1.md b/backend/resources/jpa/model/pronunciationApp-v0.2-model-1.md new file mode 100644 index 000000000..dd79f2f18 --- /dev/null +++ b/backend/resources/jpa/model/pronunciationApp-v0.2-model-1.md @@ -0,0 +1,74 @@ +# pronunciationApp-v0.2-model + +```mermaid +classDiagram + class User { + +String id + +String usrname + +int age + +String email + +int totalScore + +boolean isActive + } + class Word { + +String id + +String text + +String description + +String sentence + +int difficulty + +boolean isCommon + } + class Pronunciation { + +String id + +String audioName + +int audioSize + +String audioUrl + +String phoneticSpelling + +String speakerGender + +enum type // canonical, recorded + } + class Level { + +String id + +int number + +String name + +int requiredScore + +boolean isBlocked + } + class Category { + +String id + +String categoryName + +String subCategoryName + +String description + +int wordCount + } + class GameProgress { + +String id + +int currentScore + +enum currentStage // stage_01, stage_02 + +Date lastPlayedDate + +int wordsLearned + } + class Stage { + +String id + +String name + +String avatarUrl + +String status + +int progress + +int currentScore + } + class StageWords { + +String id + +enum status // done, pending, fail + +Date lastUpdatedDateTime + } + + + User "1" -- "*" GameProgress : tracks progress + Word "1" -- "1" Pronunciation : has pronunciation + Word "*" -- "*" Category : belongs to group + Word "*" -- "1" Level : has level + GameProgress "1" -- "1" Stage : is at stage + Stage "*" -- "1" Level : has level + Stage "1" -- "*" StageWords : has tracked words + StageWords "1" -- "1" Word : has a word +``` diff --git a/backend/resources/jpa/model/pronunciationApp-v0.2-model-1.png b/backend/resources/jpa/model/pronunciationApp-v0.2-model-1.png new file mode 100644 index 000000000..73ea6f2e9 Binary files /dev/null and b/backend/resources/jpa/model/pronunciationApp-v0.2-model-1.png differ diff --git a/backend/resources/jpa/model/pronunciationApp-v0.2-model-2.md b/backend/resources/jpa/model/pronunciationApp-v0.2-model-2.md new file mode 100644 index 000000000..183a1e8bc --- /dev/null +++ b/backend/resources/jpa/model/pronunciationApp-v0.2-model-2.md @@ -0,0 +1,92 @@ +# pronunciationApp-v0.2-model-2.0 + +## Summary + +The class diagram represents a gamified system for learning words, involving multiple users. + +- The **User** class tracks individual profiles and progress through the **GameProgress** class, which monitors stages and scores. Words are central, belonging to categories (**Category**) and levels (**Level**), with associated pronunciations (**Pronunciation**). + +- Users advance through **Stages**, which track progress and learned words using **StageWords**. Each stage is tied to a level, ensuring structured progression. + +The system also incorporates metadata like word difficulty, phonetic spelling, and stage statuses for personalized learning. + +--- + +### Note + +The context assumes multiple users in a gamified learning environment where the **Word** class is the core entity driving the system. + + + +```mermaid +classDiagram + class User { + +String id + +String usrname + +int age + +String email + +int totalScore + +boolean isActive + } + class Word { + +String id + +String text + +String description + +String sentence + +int difficulty + +boolean isCommon + } + class Pronunciation { + +String id + +String audioName + +int audioSize + +String audioUrl + +String phoneticSpelling + +String speakerGender + +enum type // canonical, recorded + } + class Level { + +String id + +int number + +String name + +int requiredScore + +boolean isBlocked + } + class Category { + +String id + +String categoryName + +String subCategoryName + +String description + +int wordCount + } + class GameProgress { + +String id + +int currentScore + +enum currentStage // stage_01, stage_02 + +Date lastPlayedDate + +int wordsLearned + } + class Stage { + +String id + +String name + +String avatarUrl + +String status + +int progress + +int currentScore + } + class StageWord { + +String id + +enum status // done, pending, fail + +Date lastUpdatedDateTime + } + + + User "1" -- "1" GameProgress : tracks progress + Word "1" -- "*" Pronunciation : has pronunciation + Word "*" -- "1" Category : belongs to group + Word "*" -- "1" Level : has level + GameProgress "1" -- "*" Stage : is at stage + Stage "*" -- "1" Level : has level + Stage "1" -- "*" StageWord : has tracked words + Word "1" -- "*" StageWord : has stageword +``` diff --git a/backend/resources/jpa/onetomany-example.png b/backend/resources/jpa/onetomany-example.png new file mode 100644 index 000000000..e74abd7f4 Binary files /dev/null and b/backend/resources/jpa/onetomany-example.png differ diff --git a/backend/resources/jpa/userAppBorrowBook-2.png b/backend/resources/jpa/userAppBorrowBook-2.png new file mode 100644 index 000000000..daa62829e Binary files /dev/null and b/backend/resources/jpa/userAppBorrowBook-2.png differ diff --git a/backend/resources/mock-data/bash-script/cli-execute-bash.png b/backend/resources/mock-data/bash-script/cli-execute-bash.png new file mode 100644 index 000000000..3af293426 Binary files /dev/null and b/backend/resources/mock-data/bash-script/cli-execute-bash.png differ diff --git a/backend/resources/mock-data/bash-script/data.json b/backend/resources/mock-data/bash-script/data.json new file mode 100644 index 000000000..edfdfa618 --- /dev/null +++ b/backend/resources/mock-data/bash-script/data.json @@ -0,0 +1,318 @@ +[ + { + "id": "8f7d1b9e3a2c5f6e", + "wordName": "aberration", + "definition": "a departure from what is normal, usual, or expected", + "phoneticSpelling": "ˌæbəˈreɪʃən", + "sentence": "The sudden drop in temperature was an aberration for this time of year.", + "level": 3, + "active": true + }, + { + "id": "2c4a6b8d0e1f3g5h", + "wordName": "benevolent", + "definition": "kind, generous, and caring about others", + "phoneticSpelling": "bəˈnevələnt", + "sentence": "The benevolent donor provided funds for the new hospital wing.", + "level": 2, + "active": true + }, + { + "id": "7j9k1l3m5n2o4p6q", + "wordName": "cacophony", + "definition": "a harsh, discordant mixture of sounds", + "phoneticSpelling": "kəˈkɒfəni", + "sentence": "The cacophony of car horns filled the busy street.", + "level": 4, + "active": true + }, + { + "id": "1r3s5t7u9v2w4x6y", + "wordName": "diligent", + "definition": "having or showing care and conscientiousness in one's work or duties", + "phoneticSpelling": "ˈdɪlɪdʒənt", + "sentence": "The diligent student always completed her homework on time.", + "level": 2, + "active": true + }, + { + "id": "8z0a2b4c6d1e3f5g", + "wordName": "ephemeral", + "definition": "lasting for a very short time", + "phoneticSpelling": "ɪˈfemərəl", + "sentence": "The beauty of cherry blossoms is ephemeral, lasting only a few days.", + "level": 3, + "active": true + }, + { + "id": "7h9i1j3k5l2m4n6o", + "wordName": "facetious", + "definition": "treating serious issues with deliberately inappropriate humor", + "phoneticSpelling": "fəˈsiːʃəs", + "sentence": "His facetious remarks about the company's financial troubles were not well-received.", + "level": 4, + "active": true + }, + { + "id": "5p7q9r1s3t5u2v4w", + "wordName": "gregarious", + "definition": "fond of company; sociable", + "phoneticSpelling": "ɡrɪˈɡeəriəs", + "sentence": "The gregarious host made sure all the guests felt welcome at the party.", + "level": 3, + "active": true + }, + { + "id": "6x8y0z2a4b1c3d5e", + "wordName": "harbinger", + "definition": "a person or thing that announces or signals the approach of another", + "phoneticSpelling": "ˈhɑːbɪndʒə", + "sentence": "The robin is often seen as a harbinger of spring.", + "level": 4, + "active": true + }, + { + "id": "9f1g3h5i7j2k4l6m", + "wordName": "incessant", + "definition": "continuing without pause or interruption", + "phoneticSpelling": "ɪnˈsesənt", + "sentence": "The incessant barking of the neighbor's dog kept us awake all night.", + "level": 3, + "active": true + }, + { + "id": "2n4o6p8q0r1s3t5u", + "wordName": "juxtapose", + "definition": "to place or deal with close together for contrasting effect", + "phoneticSpelling": "ˈdʒʌkstəpəʊz", + "sentence": "The artist decided to juxtapose images of war and peace in her latest work.", + "level": 4, + "active": true + }, + { + "id": "7v9w1x3y5z2a4b6c", + "wordName": "kinetic", + "definition": "relating to or resulting from motion", + "phoneticSpelling": "kɪˈnetɪk", + "sentence": "The sculpture's kinetic elements moved gently in the breeze.", + "level": 3, + "active": true + }, + { + "id": "8d0e2f4g6h1i3j5k", + "wordName": "lethargic", + "definition": "sluggish and apathetic", + "phoneticSpelling": "lɪˈθɑːdʒɪk", + "sentence": "The hot weather made everyone feel lethargic and unmotivated.", + "level": 2, + "active": true + }, + { + "id": "1l3m5n7o9p2q4r6s", + "wordName": "mellifluous", + "definition": "sweet or musical; pleasant to hear", + "phoneticSpelling": "məˈlɪfluəs", + "sentence": "The singer's mellifluous voice captivated the audience.", + "level": 4, + "active": true + }, + { + "id": "5t7u9v1w3x5y2z4a", + "wordName": "nefarious", + "definition": "wicked or criminal", + "phoneticSpelling": "nɪˈfeəriəs", + "sentence": "The detective uncovered the CEO's nefarious scheme to embezzle company funds.", + "level": 3, + "active": true + }, + { + "id": "6b8c0d2e4f1g3h5i", + "wordName": "obfuscate", + "definition": "to render obscure, unclear, or unintelligible", + "phoneticSpelling": "ˈɒbfʌskeɪt", + "sentence": "The politician tried to obfuscate the issue by using complex jargon.", + "level": 4, + "active": true + }, + { + "id": "9j1k3l5m7n2o4p6q", + "wordName": "panacea", + "definition": "a solution or remedy for all difficulties or diseases", + "phoneticSpelling": "ˌpænəˈsiːə", + "sentence": "Exercise is not a panacea for all health problems, but it certainly helps.", + "level": 3, + "active": true + }, + { + "id": "2r4s6t8u0v1w3x5y", + "wordName": "quintessential", + "definition": "representing the most perfect or typical example of a quality or class", + "phoneticSpelling": "ˌkwɪntɪˈsenʃəl", + "sentence": "The small town diner was the quintessential American eating establishment.", + "level": 4, + "active": true + }, + { + "id": "7z9a1b3c5d2e4f6g", + "wordName": "resilient", + "definition": "able to withstand or recover quickly from difficult conditions", + "phoneticSpelling": "rɪˈzɪliənt", + "sentence": "The resilient community quickly rebuilt after the natural disaster.", + "level": 3, + "active": true + }, + { + "id": "8h0i2j4k6l1m3n5o", + "wordName": "surreptitious", + "definition": "kept secret, especially because it would not be approved of", + "phoneticSpelling": "ˌsʌrəpˈtɪʃəs", + "sentence": "He made a surreptitious attempt to leave the party without saying goodbye.", + "level": 4, + "active": true + }, + { + "id": "1p3q5r7s9t2u4v6w", + "wordName": "tenacious", + "definition": "tending to keep a firm hold of something; clinging or adhering closely", + "phoneticSpelling": "təˈneɪʃəs", + "sentence": "The tenacious climber refused to give up, even when faced with steep cliffs.", + "level": 3, + "active": true + }, + { + "id": "5x7y9z1a3b5c2d4e", + "wordName": "ubiquitous", + "definition": "present, appearing, or found everywhere", + "phoneticSpelling": "juːˈbɪkwɪtəs", + "sentence": "Smartphones have become ubiquitous in modern society.", + "level": 4, + "active": true + }, + { + "id": "6f8g0h2i4j1k3l5m", + "wordName": "vociferous", + "definition": "expressing or characterized by vehement opinions; loud and forceful", + "phoneticSpelling": "və(ʊ)ˈsɪfərəs", + "sentence": "The vociferous crowd demanded justice for the wrongly accused man.", + "level": 4, + "active": true + }, + { + "id": "9n1o3p5q7r2s4t6u", + "wordName": "whimsical", + "definition": "playfully quaint or fanciful, especially in an appealing and amusing way", + "phoneticSpelling": "ˈwɪmzɪkəl", + "sentence": "The artist's whimsical sculptures brought a smile to everyone's face.", + "level": 3, + "active": true + }, + { + "id": "2v4w6x8y0z1a3b5c", + "wordName": "xenophobia", + "definition": "dislike of or prejudice against people from other countries", + "phoneticSpelling": "ˌzenəˈfəʊbiə", + "sentence": "The politician's xenophobia was evident in his discriminatory policies.", + "level": 4, + "active": true + }, + { + "id": "7d9e1f3g5h2i4j6k", + "wordName": "yearn", + "definition": "to have an intense feeling of longing for something", + "phoneticSpelling": "jɜːn", + "sentence": "After months away, she yearned to return to her hometown.", + "level": 2, + "active": true + }, + { + "id": "8l0m2n4o6p1q3r5s", + "wordName": "zealous", + "definition": "having or showing zeal; enthusiastic and diligent", + "phoneticSpelling": "ˈzeləs", + "sentence": "The zealous volunteer dedicated all her free time to the charity.", + "level": 3, + "active": true + }, + { + "id": "1t3u5v7w9x2y4z6a", + "wordName": "ambivalent", + "definition": "having mixed feelings or contradictory ideas about something or someone", + "phoneticSpelling": "æmˈbɪvələnt", + "sentence": "She felt ambivalent about moving to a new city for her job.", + "level": 3, + "active": true + }, + { + "id": "5b7c9d1e3f5g2h4i", + "wordName": "brevity", + "definition": "concise and exact use of words in writing or speech", + "phoneticSpelling": "ˈbrevɪti", + "sentence": "The speaker's brevity was appreciated by the audience.", + "level": 3, + "active": true + }, + { + "id": "6j8k0l2m4n1o3p5q", + "wordName": "cognizant", + "definition": "having knowledge or awareness", + "phoneticSpelling": "ˈkɒɡnɪzənt", + "sentence": "The manager was cognizant of the team's concerns about the new project.", + "level": 4, + "active": true + }, + { + "id": "9r1s3t5u7v2w4x6y", + "wordName": "dexterous", + "definition": "showing or having skill, especially with the hands", + "phoneticSpelling": "ˈdekstərəs", + "sentence": "The dexterous magician amazed the crowd with his sleight of hand.", + "level": 3, + "active": true + }, + { + "id": "2z4a6b8c0d1e3f5g", + "wordName": "eloquent", + "definition": "fluent or persuasive in speaking or writing", + "phoneticSpelling": "ˈeləkwənt", + "sentence": "Her eloquent speech moved the entire audience to tears.", + "level": 3, + "active": true + }, + { + "id": "7h9i1j3k5l2m4n6o", + "wordName": "fortuitous", + "definition": "happening by chance rather than intention", + "phoneticSpelling": "fɔːˈtjuːɪtəs", + "sentence": "Their meeting at the airport was entirely fortuitous.", + "level": 4, + "active": true + }, + { + "id": "8p0q2r4s6t1u3v5w", + "wordName": "garrulous", + "definition": "excessively talkative, especially on trivial matters", + "phoneticSpelling": "ˈɡærʊləs", + "sentence": "The garrulous passenger talked throughout the entire flight.", + "level": 4, + "active": true + }, + { + "id": "1x3y5z7a9b2c4d6e", + "wordName": "haphazard", + "definition": "lacking any obvious principle of organization", + "phoneticSpelling": "hæpˈhæzəd", + "sentence": "The room was in a haphazard state, with clothes and books strewn everywhere.", + "level": 3, + "active": true + }, + { + "id": "5f7g9h1i3j5k2l4m", + "wordName": "iconoclast", + "definition": "a person who attacks or criticizes cherished beliefs or institutions", + "phoneticSpelling": "aɪˈkɒnəklæst", + "sentence": "The young artist was seen as an iconoclast in the conservative art world.", + "level": 4, + "active": true + } +] + diff --git a/backend/resources/mock-data/bash-script/h2-db-fill-with-mock-data.png b/backend/resources/mock-data/bash-script/h2-db-fill-with-mock-data.png new file mode 100644 index 000000000..9587257d3 Binary files /dev/null and b/backend/resources/mock-data/bash-script/h2-db-fill-with-mock-data.png differ diff --git a/backend/resources/mock-data/bash-script/import_words.sh b/backend/resources/mock-data/bash-script/import_words.sh new file mode 100755 index 000000000..568b90fdd --- /dev/null +++ b/backend/resources/mock-data/bash-script/import_words.sh @@ -0,0 +1,27 @@ +#!/bin/bash + +# Check if jq is installed +if ! command -v jq &> /dev/null +then + echo "jq is required but not installed. Please install jq and try again." + exit 1 +fi + +# Read the JSON file and process each word object +jq -c '.[]' data.json | while read -r word; do + # Send POST request for each word + curl -X POST \ + -H "Content-Type: application/json" \ + -d "$word" \ + http://localhost:8080/api/words/createWord + + echo -e "\nWord processed" + echo "----------" + + # Optional: Add a small delay between requests to avoid overwhelming the server + sleep 0.5 +done + +echo -e "\nAll words have been posted" + + diff --git a/backend/resources/mock-data/faker-java/java-faker.md b/backend/resources/mock-data/faker-java/java-faker.md new file mode 100644 index 000000000..0f7562bee --- /dev/null +++ b/backend/resources/mock-data/faker-java/java-faker.md @@ -0,0 +1,98 @@ +# Java Faker + +> **Java Faker is a tool that creates realistic-looking fake data**, including names, addresses, phone numbers, and much more. + +- [GitHub - DiUS/java-faker: Brings the popular ruby faker gem to Java](https://github.com/DiUS/java-faker) + +It’s useful for: + +1. **Populating** databases with test data +2. Creating **mock objects for unit testing** +3. Generating sample data for applications +4. Prototyping user interfaces + +The library provides a wide range of pre-defined categories (like name, address, phone number) and methods to generate fake data within those categories. It’s easy to use and can generate data in multiple languages and locales. + +For example, you can create a Faker instance and generate fake data like this: + +```java +Faker faker = new Faker(); + // Generates a random full name +String name = faker.name().fullName(); +// Generates a random email address +String email = faker.internet().emailAddress(); +``` + +Dependency for maven: + +```xml + + com.github.javafaker + javafaker + 1.0.2 + +``` + +## Example #1 + +- [CustomerDataLoader.java at master · AlbertProfe/restaurantManager · GitHub](https://github.com/AlbertProfe/restaurantManager/blob/master/src/main/java/dev/example/restaurantManager/utilities/CustomerDataLoader.java) + +- [DataLoader.java at master · AlbertProfe/restaurantManager · GitHub](https://github.com/AlbertProfe/restaurantManager/blob/master/src/main/java/dev/example/restaurantManager/utilities/DataLoader.java) + +In this example, it's used to create fake customer data for a restaurant management system. Here's how it works: + +1. The `CustomerDataLoader` class is annotated with `@Component`, making it a Spring-managed bean[3]. + +2. It uses `@Autowired` to inject the `CustomerRepository`, which will be used to save the generated data[3]. + +3. The `createFakeCustomers()` method first checks if the database is empty: + +```java +if (customerRepository.count() == 0) { + // Generate fake data +} +``` + +4. A new `Faker` instance is created with the US locale: + +```java +Faker faker = new Faker(new Locale("en-US")); +``` + +5. The method then generates 50 fake customers in a loop: + +```java +for (int i = 0; i < qty; i++) { + Customer customer = new Customer( + UUID.randomUUID().toString(), + faker.name().fullName(), + faker.internet().emailAddress(), + faker.phoneNumber().cellPhone(), + faker.random().nextInt(18, 130), + faker.random().nextBoolean(), + faker.random().nextBoolean() + ); + customerRepository.save(customer); +} +``` + +6. For each customer, Java Faker generates: + + - A random full name using `faker.name().fullName()` + - A random email address using `faker.internet().emailAddress()` + - A random cell phone number using `faker.phoneNumber().cellPhone()` + - A random age between 18 and 130 using `faker.random().nextInt(18, 130)` + - Two random boolean values using `faker.random().nextBoolean()` + +7. Each generated customer is saved to the database using `customerRepository.save(customer)`[3]. + +This approach allows the application to populate the database with realistic-looking customer data for testing or development purposes, without the need for manual data entry. + +Citations: +[1] https://github.com/AlbertProfe/restaurantManager/tree/master +[2] https://albertprofe.dev/springboot/sblab8-1.html +[3] https://albertprofe.dev/springboot/sblab8-3.html + +--- + +Answer from Perplexity: pplx.ai/share diff --git a/backend/resources/mock-data/import-csv/import-csv.md b/backend/resources/mock-data/import-csv/import-csv.md new file mode 100644 index 000000000..ff13c8d9d --- /dev/null +++ b/backend/resources/mock-data/import-csv/import-csv.md @@ -0,0 +1,32 @@ +# Import CSV to H2 + +> To test the H2 database CSV import functionality with a basic CSV file for a UserApp object, follow these steps: + +1. Create a CSV file named `users.csv` with the following content: + +``` +id,username,email,created_at +1,john_doe,john@example.com,2025-01-24 20:00:00 +2,jane_smith,jane@example.com,2025-01-24 20:15:00 +3,bob_johnson,bob@example.com,2025-01-24 20:30:00 +``` + +2. Save this file in a location accessible to your H2 database, for example, `/path/to/users.csv`. + +3. Connect to your H2 database and execute the following SQL command: + +```sql +CREATE TABLE UserApp AS SELECT * FROM CSVREAD('/path/to/users.csv'); +``` + +This command will create a new table named `UserApp` with columns matching the CSV file structure. + +4. To verify the import, you can run a SELECT query: + +```sql +SELECT * FROM UserApp; +``` + +This should display the imported data from the CSV file. + +> **Note** that the H2 database will automatically infer the column types based on the data in the CSV file[2]. In this case, `id` will likely be treated as an INTEGER, while `username` and `email` will be VARCHAR, and `created_at` will be TIMESTAMP. diff --git a/backend/resources/mock-data/import-csv/userApp-from-csv.png b/backend/resources/mock-data/import-csv/userApp-from-csv.png new file mode 100644 index 000000000..163c5bd77 Binary files /dev/null and b/backend/resources/mock-data/import-csv/userApp-from-csv.png differ diff --git a/backend/resources/mock-data/import-csv/userApp-sql-import-csv.png b/backend/resources/mock-data/import-csv/userApp-sql-import-csv.png new file mode 100644 index 000000000..7b92d9239 Binary files /dev/null and b/backend/resources/mock-data/import-csv/userApp-sql-import-csv.png differ diff --git a/backend/resources/mock-data/import-csv/users.csv b/backend/resources/mock-data/import-csv/users.csv new file mode 100644 index 000000000..d4ca3dc38 --- /dev/null +++ b/backend/resources/mock-data/import-csv/users.csv @@ -0,0 +1,4 @@ +id,username,email,created_at +1,john_doe,john@example.com,2025-01-24 20:00:00 +2,jane_smith,jane@example.com,2025-01-24 20:15:00 +3,bob_johnson,bob@example.com,2025-01-24 20:30:00 diff --git a/backend/resources/mock-data/mockServer-postman/mock-serverPostman.md b/backend/resources/mock-data/mockServer-postman/mock-serverPostman.md new file mode 100644 index 000000000..62829a7a2 --- /dev/null +++ b/backend/resources/mock-data/mockServer-postman/mock-serverPostman.md @@ -0,0 +1,49 @@ +# How to create a mock server in Postman from a collection? + +> Mock servers simulate real API behavior and are useful for testing and development without relying on live APIs. + +## Reference + +- https://86c6ea23-f1a9-4a53-85a9-9c9869d64809.mock.pstmn.io/api/words/ + +- [Configure and use a Postman mock server | Postman Docs](https://learning.postman.com/docs/designing-and-developing-your-api/mocking-data/setting-up-mock/) + +## Step-by-step + + + +To create a mock server in Postman from a collection, follow these steps: + +1. **Select the Collection**: + + - In the Postman sidebar, go to **Collections**. + - Find the collection you want to mock, click **View more actions** (three dots), and select **Mock Collection**. + +2. **Configure Mock Server Details**: + + - Provide a name for your mock server. + - (Optional) Choose an environment to use environment variables with your mock server. + - Decide whether to make the mock server private or public. Private servers require an API key in the request header. + - Optionally, simulate a fixed network delay by specifying a response delay. + +3. **Create the Mock Server**: + + - Click **Create Mock Server** to finalize the setup. + - Postman will display the mock server URL, which can be used in requests. + +4. **Add Examples to Requests**: + + - Ensure that each request in your collection has at least one saved example. Postman uses these examples to generate responses for mock requests. + +5. **Use the Mock Server**: + + - Copy the mock server URL and use it in your API requests. + - If the server is private, include your Postman API key as an `x-api-key` header. + +6. **Edit or Delete Mock Servers**: + + - To edit, go to **Mock Servers** in the sidebar, select the desired server, and click **Edit Configuration**. + - To delete, click **View more actions** next to the server name and select **Delete**. + +Citations: +[1] https://learning.postman.com/docs/designing-and-developing-your-api/mocking-data/setting-up-mock/ diff --git a/backend/resources/mock-data/mockServer-postman/mockServer_Postman_from_collection-1.png b/backend/resources/mock-data/mockServer-postman/mockServer_Postman_from_collection-1.png new file mode 100644 index 000000000..23c7bb50c Binary files /dev/null and b/backend/resources/mock-data/mockServer-postman/mockServer_Postman_from_collection-1.png differ diff --git a/backend/resources/mock-data/mockServer-postman/mockServer_Postman_from_collection-2.png b/backend/resources/mock-data/mockServer-postman/mockServer_Postman_from_collection-2.png new file mode 100644 index 000000000..e925ef98e Binary files /dev/null and b/backend/resources/mock-data/mockServer-postman/mockServer_Postman_from_collection-2.png differ diff --git a/backend/resources/mock-data/mockServer-postman/mockServer_Postman_from_collection-3.png b/backend/resources/mock-data/mockServer-postman/mockServer_Postman_from_collection-3.png new file mode 100644 index 000000000..80a3d7bca Binary files /dev/null and b/backend/resources/mock-data/mockServer-postman/mockServer_Postman_from_collection-3.png differ diff --git a/backend/resources/mock-data/mockServer-postman/mockServer_Postman_from_collection-4.png b/backend/resources/mock-data/mockServer-postman/mockServer_Postman_from_collection-4.png new file mode 100644 index 000000000..afa299449 Binary files /dev/null and b/backend/resources/mock-data/mockServer-postman/mockServer_Postman_from_collection-4.png differ diff --git a/backend/resources/mock-data/mockServer-postman/mockServer_Postman_from_collection-5.png b/backend/resources/mock-data/mockServer-postman/mockServer_Postman_from_collection-5.png new file mode 100644 index 000000000..09d0cbe06 Binary files /dev/null and b/backend/resources/mock-data/mockServer-postman/mockServer_Postman_from_collection-5.png differ diff --git a/backend/resources/mock-data/mockServer-postman/mockServer_Postman_from_collection-6.png b/backend/resources/mock-data/mockServer-postman/mockServer_Postman_from_collection-6.png new file mode 100644 index 000000000..00cef8081 Binary files /dev/null and b/backend/resources/mock-data/mockServer-postman/mockServer_Postman_from_collection-6.png differ diff --git a/backend/resources/pronunciationApp-v0.1.md b/backend/resources/pronunciationApp-v0.1.md new file mode 100644 index 000000000..62dbb8fcd --- /dev/null +++ b/backend/resources/pronunciationApp-v0.1.md @@ -0,0 +1,390 @@ +# PronunciationApp Backend v0.1 + +## Project + +- pronunciationApp Backend **GitHub** [code](https://github.com/AlbertProfe/pronunciationApp/tree/backend-spring-boot/backend/pronunciationAppBack) + +- pronunciatoinApp Backend [resources](https://github.com/AlbertProfe/pronunciationApp/tree/backend-spring-boot/backend/resources) **documentation** + +### Project Structure + +A Spring Boot backend application for the `Pronunciation App`, using: + +- H2 Database (local file-based or memory for certain purposes) +- `Spring Data JPA` +- REST Controller +- Service Layer +- Entity Mapping: `@Entity` + +### Dependencies + +Add these to your `pom.xml`: + +```xml + + + org.springframework.boot + spring-boot-starter-data-jpa + + + org.springframework.boot + spring-boot-starter-web + + + com.h2database + h2 + runtime + + +``` + +### Entity + +`Word.java`: + +```java +package com.pronunciationapp.model; + +import jakarta.persistence.Entity; +import jakarta.persistence.Id; + +@Entity +public class Word { + + @Id + private String id; + private String wordName; + private String definition; + private String phoneticSpelling; + private String sentence; + private boolean isActive; + private int level; + + // Constructors + public Word() {} + + public Word(String id, String wordName, String definition, + String phoneticSpelling, String sentence, + boolean isActive, int level) { + this.id = id; + this.wordName = wordName; + this.definition = definition; + this.phoneticSpelling = phoneticSpelling; + this.sentence = sentence; + this.isActive = isActive; + this.level = level; + } + + // Getters and Setters + // ... (generate these for all fields) +} +``` + +### Repository + +`WordRepository.java`: + +```java +package com.pronunciationapp.repository; + +import com.pronunciationapp.model.Word; +import org.springframework.data.jpa.repository.JpaRepository; +import org.springframework.stereotype.Repository; + +import java.util.List; + +@Repository +public interface WordRepository extends JpaRepository { + List findByIsActiveTrue(); + List findByLevel(int level); + Word findByWordName(String wordName); +} +``` + +### Service + +`WordService.java`: + +```java +package com.pronunciationapp.service; + +import com.pronunciationapp.model.Word; +import com.pronunciationapp.repository.WordRepository; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Service; + +import java.util.List; +import java.util.Optional; +import java.util.UUID; + +@Service +public class WordService { + + @Autowired + private WordRepository wordRepository; + + public List getAllWords() { + return wordRepository.findAll(); + } + + public Optional getWordById(String id) { + return wordRepository.findById(id); + } + + public Word createWord(Word word) { + if (word.getId() == null) { + word.setId(UUID.randomUUID().toString()); + } + return wordRepository.save(word); + } + + public Word updateWord(String id, Word wordDetails) { + Word word = wordRepository.findById(id) + .orElseThrow(() -> new RuntimeException("Word not found")); + + word.setWordName(wordDetails.getWordName()); + word.setDefinition(wordDetails.getDefinition()); + word.setPhoneticSpelling(wordDetails.getPhoneticSpelling()); + word.setSentence(wordDetails.getSentence()); + word.setActive(wordDetails.isActive()); + word.setLevel(wordDetails.getLevel()); + + return wordRepository.save(word); + } + + public void deleteWord(String id) { + Word word = wordRepository.findById(id) + .orElseThrow(() -> new RuntimeException("Word not found")); + wordRepository.delete(word); + } + + public List getActiveWords() { + return wordRepository.findByIsActiveTrue(); + } + + public List getWordsByLevel(int level) { + return wordRepository.findByLevel(level); + } +} +``` + +### REST Controller + +`WordController.java`: + +```java +package com.pronunciationapp.controller; + +import com.pronunciationapp.model.Word; +import com.pronunciationapp.service.WordService; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.*; + +import java.util.List; + +@RestController +@RequestMapping("/api/words") +public class WordController { + + @Autowired + private WordService wordService; + + @GetMapping + public List getAllWords() { + return wordService.getAllWords(); + } + + @GetMapping("/{id}") + public ResponseEntity getWordById(@PathVariable String id) { + return wordService.getWordById(id) + .map(ResponseEntity::ok) + .orElse(ResponseEntity.notFound().build()); + } + + @PostMapping + public Word createWord(@RequestBody Word word) { + return wordService.createWord(word); + } + + @PutMapping("/{id}") + public ResponseEntity updateWord( + @PathVariable String id, + @RequestBody Word wordDetails + ) { + Word updatedWord = wordService.updateWord(id, wordDetails); + return ResponseEntity.ok(updatedWord); + } + + @DeleteMapping("/{id}") + public ResponseEntity deleteWord(@PathVariable String id) { + wordService.deleteWord(id); + return ResponseEntity.ok().build(); + } + + @GetMapping("/active") + public List getActiveWords() { + return wordService.getActiveWords(); + } + + @GetMapping("/level/{level}") + public List getWordsByLevel(@PathVariable int level) { + return wordService.getWordsByLevel(level); + } +} +``` + +### Application Properties + +`application.properties`: + +```properties +spring.application.name=pronunciationAppBack + +# H2 DATABASE SERVER +spring.datasource.driverClassName=org.h2.Driver +spring.jpa.database-platform=org.hibernate.dialect.H2Dialect +spring.h2.console.enabled=true + +# H2 LOCAL DB SERVER +spring.datasource.url=jdbc:h2:/home/albert/MyProjects/DataBase/pronunciationDB/pronunciationDB.db +spring.datasource.username=albert +spring.datasource.password=1234 + +# DDL OPTIONS: create-drop, create, update, none, validate +spring.jpa.hibernate.ddl-auto=update + +# Enable H2 web console +spring.h2.console.path=/h2-console +``` + +## Testing with Postman + +Sample JSON for testing: + +```json +{ + "words": [ + { + "id": "8b9248a4e0b64bbccf82e7723a3734279bf9bbc4", + "wordName": "benevolent", + "definition": "Kind and generous", + "phoneticSpelling": "/bɪˈnɛvələnt/", + "sentence": "Her benevolent actions helped many people in need.", + "isActive": true, + "level": 2 + }, + { + "id": "3a7bd3e2a07e8c7e9b6e0d2c1f4a5b8d9c0e3f2", + "wordName": "serendipity", + "definition": "A fortunate discovery", + "phoneticSpelling": "/ˌserənˈdɪpɪti/", + "sentence": "Meeting her was pure serendipity.", + "isActive": true, + "level": 3 + } + ] +} +``` + +### Postman Collection Setup + +Create a new collection for `PronunciationApp` with these CRUD endpoints: + +1. **GET All Words** + + - Method: GET + - URL: `http://localhost:8080/api/words` + - Expected: Returns full list of words + +2. **GET Word by ID** + + - Method: GET + - URL: `http://localhost:8080/api/words/{id}` + - Params: Replace `{id}` with a specific word ID + - Expected: Returns single word details + +3. **POST Create Word** + + - Method: POST + + - URL: `http://localhost:8080/api/words` + + - Body (raw JSON): + + ```json + { + "wordName": "ephemeral", + "definition": "Lasting for a very short time", + "phoneticSpelling": "/ɪˈfɛmərəl/", + "sentence": "The beauty of cherry blossoms is ephemeral.", + "isActive": true, + "level": 2 + } + ``` + + - Expected: Returns created word with auto-generated ID + +4. **PUT Update Word** + + - Method: PUT + + - URL: `http://localhost:8080/api/words/{id}` + + - Params: Replace `{id}` with existing word ID + + - Body (raw JSON): + + ```json + { + "wordName": "ephemeral", + "definition": "Lasting for a very short time", + "phoneticSpelling": "/ɪˈfɛmərəl/", + "sentence": "The beauty of cherry blossoms is ephemeral.", + "isActive": false, + "level": 3 + } + ``` + + - Expected: Returns updated word + +5. **DELETE Word** + + - Method: DELETE + - URL: `http://localhost:8080/api/words/{id}` + - Params: Replace `{id}` with word ID to delete + - Expected: 200 OK response + +### Additional Test Endpoints + +- **GET Active Words**: `http://localhost:8080/api/words/active` +- **GET Words by Level**: `http://localhost:8080/api/words/level/2` + +### Testing Workflow + +1. Import collection in Postman +2. Start Spring Boot application +3. Execute requests in sequence +4. Verify responses match expected results + +### Common Testing Scenarios + +- Test creating words with missing fields +- Validate ID generation +- Check level and active status constraints +- Test boundary conditions (max/min levels) + +## Running the Application + +1. Ensure you have Java 17+ and Maven installed +2. Configure the database path in `application.properties` +3. Run the Spring Boot application +4. Access H2 console at `http://localhost:8080/h2-console` +5. Access API endpoints at `http://localhost:8080/api/words` + +## Notes + +- The application uses a **local** H2 database file +- UUID is used for generating unique word IDs +- Basic CRUD operations are implemented +- Additional **query methods are available in the repository** and service layers diff --git a/backend/resources/pronunciationApp-v0.2.md b/backend/resources/pronunciationApp-v0.2.md new file mode 100644 index 000000000..aaf6a676a --- /dev/null +++ b/backend/resources/pronunciationApp-v0.2.md @@ -0,0 +1,498 @@ +# PronunciationApp Backend v0.2 + +## Refactoring @RestController and adding @Service + +> Implementing a `WordService` and refactoring the `WordController` is a good practice in Spring Boot applications for several reasons. + +Let's implement the `WordService`, refactor the `WordController`, and discuss why this approach is beneficial. + +### Implementing WordService + +```java +package dev.pronunciationAppBack.service; + +import dev.pronunciationAppBack.model.Word; +import dev.pronunciationAppBack.repository.WordRepository; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Service; + +import java.util.List; +import java.util.Optional; + +@Service +public class WordService { + + @Autowired + private WordRepository wordRepository; + + public List getAllWords() { + return wordRepository.findAll(); + } + + public Optional getWordById(String id) { + return Optional.ofNullable(wordRepository.getWordById(id)); + } + + public Word createWord(Word word) { + return wordRepository.save(word); + } + + public Word updateWord(Word word) { + return wordRepository.save(word); + } + + public void deleteWord(String id) { + wordRepository.deleteById(id); + } + + public void deleteAllWords() { + wordRepository.deleteAll(); + } + + public boolean existsById(String id) { + return wordRepository.existsById(id); + } + + public long getWordCount() { + return wordRepository.count(); + } + + // Additional business logic can be added here + public Word getWordByPhoneticSpelling(String pronunciation) { + return wordRepository.getWordByPhoneticSpelling(pronunciation); + } +} +``` + +### Why is this refactoring necessary? + +1. **Separation of Concerns**: The service layer separates business logic from the controller, making the code more modular and easier to maintain. + +2. **Reusability**: Business logic in the service can be reused across different controllers or other services. + +3. **Testability**: It's easier to unit test business logic in a service class than in a controller. + +4. **Scalability**: As the application grows, having a separate service layer makes it easier to manage and scale the codebase. + +5. **Abstraction**: The controller doesn't need to know about the repository implementation, providing better abstraction. + +#### Refactoring WordController + +```java +@RestController +@RequestMapping("/api/words") +public class WordController { + + @Autowired + private WordService wordService; + + /* + @GetMapping("/hello") + public ResponseEntity hello() { + HttpHeaders headers = getCommonHeaders("Hello endpoint"); + return new ResponseEntity<>("hello Emiliano, are you sleeping?", headers, HttpStatus.OK); + } + */ + + @GetMapping + public ResponseEntity> getAllWords() { + List words = wordService.getAllWords(); + HttpHeaders headers = getCommonHeaders("Get all words"); + + return !words.isEmpty() + ? new ResponseEntity<>(words, headers, HttpStatus.OK) + : new ResponseEntity<>(headers, HttpStatus.NOT_FOUND); + } + + @GetMapping("/{id}") + public ResponseEntity getWordById(@PathVariable String id) { + Optional word = wordService.getWordById(id); + HttpHeaders headers = getCommonHeaders("Get word by ID"); + + return word.map(value -> new ResponseEntity<>(value, headers, HttpStatus.OK)) + .orElseGet(() -> new ResponseEntity<>(headers, HttpStatus.NOT_FOUND)); + } + + @PostMapping("/createWord") + public ResponseEntity createWord(@RequestBody Word word) { + Word createdWord = wordService.createWord(word); + HttpHeaders headers = getCommonHeaders("Create a new word"); + + return new ResponseEntity<>(createdWord, headers, HttpStatus.CREATED); + } + + @PutMapping("/{id}") + public ResponseEntity updateWord(@PathVariable String id, @RequestBody Word word) { + Word updatedWord = wordService.updateWord(word); + HttpHeaders headers = getCommonHeaders("Update a word"); + + return new ResponseEntity<>(updatedWord, headers, HttpStatus.OK); + } + + @DeleteMapping("/{id}") + public ResponseEntity deleteWord(@PathVariable("id") String idToDelete) { + HttpHeaders headers = getCommonHeaders("Delete a word"); + + if (wordService.existsById(idToDelete)) { + wordService.deleteWord(idToDelete); + return new ResponseEntity<>("Word deleted", headers, HttpStatus.OK); + } else { + return new ResponseEntity<>("Word not found", headers, HttpStatus.NOT_FOUND); + } + } + + @DeleteMapping + public ResponseEntity deleteAllWords() { + wordService.deleteAllWords(); + HttpHeaders headers = getCommonHeaders("Delete all words"); + return new ResponseEntity<>("All words deleted", headers, HttpStatus.OK); + } + + private HttpHeaders getCommonHeaders(String description) { + HttpHeaders headers = new HttpHeaders(); + headers.add("desc", description); + headers.add("content-type", "application/json"); + headers.add("date", new Date().toString()); + headers.add("server", "Spring Boot"); + headers.add("version", "1.0.0"); + headers.add("word-count", String.valueOf(wordService.getWordCount())); + headers.add("object", "words"); + return headers; + } +} +``` + +## Check health + +Well create a new controller class that incorporates the health check endpoint along with other best practices. + +Here's the new `HealthController` class: + +```java +package dev.pronunciationAppBack.controller; + +import dev.pronunciationAppBack.model.Word; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RestController; + +import java.util.Date; +import java.util.HashMap; +import java.util.Map; + +@RestController +@RequestMapping("/api/health") +public class HealthController { + + @Autowired + private WordService wordService; + + @GetMapping + public ResponseEntity> healthCheck() { + Map healthStatus = new HashMap<>(); + healthStatus.put("status", "UP"); + healthStatus.put("timestamp", new Date()); + healthStatus.put("wordCount", wordService.getWordCount()); + + boolean databaseConnection = checkDatabaseConnection(); + healthStatus.put("database", databaseConnection ? "Connected" : "Disconnected"); + + // Add more health checks as needed + healthStatus.put("memoryUsage", getMemoryUsage()); + healthStatus.put("diskSpace", getDiskSpace()); + + HttpHeaders headers = getCommonHeaders("Health check endpoint"); + HttpStatus status = databaseConnection ? HttpStatus.OK : HttpStatus.SERVICE_UNAVAILABLE; + + return new ResponseEntity<>(healthStatus, headers, status); + } + + private boolean checkDatabaseConnection() { + try { + wordService.getAllWords(); + return true; + } catch (Exception e) { + return false; + } + } + + private Map getMemoryUsage() { + Runtime runtime = Runtime.getRuntime(); + Map memoryInfo = new HashMap<>(); + memoryInfo.put("total", runtime.totalMemory()); + memoryInfo.put("free", runtime.freeMemory()); + memoryInfo.put("used", runtime.totalMemory() - runtime.freeMemory()); + return memoryInfo; + } + + private Map getDiskSpace() { + java.io.File root = new java.io.File("/"); + Map diskInfo = new HashMap<>(); + diskInfo.put("total", root.getTotalSpace()); + diskInfo.put("free", root.getFreeSpace()); + diskInfo.put("usable", root.getUsableSpace()); + return diskInfo; + } + + private HttpHeaders getCommonHeaders(String description) { + HttpHeaders headers = new HttpHeaders(); + headers.add("desc", description); + headers.add("content-type", "application/json"); + headers.add("date", new Date().toString()); + headers.add("server", "Spring Boot"); + headers.add("version", "1.0.0"); + return headers; + } +} +``` + +This new `HealthController` class offers several improvements: + +1. **Dedicated controller**: It's a separate controller focused on health and monitoring, following the Single Responsibility Principle. + +2. **Comprehensive health check**: The `healthCheck()` method provides a detailed health status, including database connectivity, word count, memory usage, and disk space. + +3. **Modular design**: Different aspects of the health check are separated into methods, making the code more maintainable and easier to extend. + +4. **Resource monitoring**: It includes basic system resource monitoring (memory and disk space), which can be crucial for identifying potential issues. + +5. **Consistent headers**: It uses a `getCommonHeaders()` method similar to the `WordController`, maintaining consistency across the API. + +6. **Appropriate mapping**: The controller uses the `/api/health` endpoint, which is a common convention for health check APIs. + +> This health check endpoint provides a comprehensive overview of your application's health, making it valuable for monitoring and troubleshooting in production environments. + +## @Service business logic examples + +#### Real Use Case #1 + +Let's consider a real use case where the service layer becomes key: + +Imagine you're expanding your pronunciation app to include a feature for generating word lists based on difficulty levels. This involves complex logic that shouldn't be in the controller. + +Add this method to `WordService`: + +```java +public List getWordsByDifficultyLevel(int level) { + List allWords = wordRepository.findAll(); + return allWords.stream() + .filter(word -> calculateDifficulty(word) == level) + .collect(Collectors.toList()); +} + +private int calculateDifficulty(Word word) { + // Complex logic to determine word difficulty + // Based on factors like length, rarity, phonetic complexity, etc. + // This is a simplified example + int difficulty = word.getWord().length(); + difficulty += word.getPhoneticSpelling().length(); + // More factors... + return difficulty / 5; // Normalize to a 1-10 scale +} +``` + +And in `WordController`: + +```java +@GetMapping("/difficulty/{level}") +public ResponseEntity> getWordsByDifficulty(@PathVariable int level) { + List words = wordService.getWordsByDifficultyLevel(level); + HttpHeaders headers = getCommonHeaders("Get words by difficulty"); + + return !words.isEmpty() + ? new ResponseEntity<>(words, headers, HttpStatus.OK) + : new ResponseEntity<>(headers, HttpStatus.NOT_FOUND); +} +``` + +In this case, the service layer is key because: + +1. It encapsulates complex business logic (difficulty calculation) that doesn't belong in the controller. +2. This logic can be reused in other parts of the application. +3. It's easier to test and modify the difficulty calculation independently of the controller. +4. If you decide to change how difficulty is calculated or stored (e.g., moving to a database-computed value), you only need to change the service, not the controller. + +> This structure allows your application to grow and adapt to new requirements more easily, demonstrating the importance of a well-structured service layer in a Spring Boot application. + +#### Real Use Case #2 + +Let's consider another real-world use case where the WordService would be essential: implementing a personalized word recommendation system based on a user's learning history and performance. + +Here's how we could implement this feature: + +```java +@Service +public class WordService { + @Autowired + private WordRepository wordRepository; + + @Autowired + private UserRepository userRepository; + + @Autowired + private UserProgressRepository userProgressRepository; + + public List getPersonalizedWordRecommendations(String userId, int count) { + User user = userRepository.findById(userId) + .orElseThrow(() -> new UserNotFoundException("User not found")); + + List userProgress = userProgressRepository.findByUserId(userId); + + Set masteredWords = userProgress.stream() + .filter(progress -> progress.getMasteryLevel() > 0.8) + .map(UserProgress::getWordId) + .collect(Collectors.toSet()); + + List allWords = wordRepository.findAll(); + + return allWords.stream() + .filter(word -> !masteredWords.contains(word.getId())) + .sorted(Comparator.comparingDouble(word -> calculateRelevance(word, user, userProgress))) + .limit(count) + .collect(Collectors.toList()); + } + + private double calculateRelevance(Word word, User user, List userProgress) { + double difficultyScore = calculateDifficulty(word); + double userLevelScore = user.getProficiencyLevel(); + double progressScore = userProgress.stream() + .filter(progress -> progress.getWordId().equals(word.getId())) + .mapToDouble(UserProgress::getMasteryLevel) + .findFirst() + .orElse(0.0); + + // Complex algorithm to determine word relevance based on user's level, + // word difficulty, and user's progress on this word + return (difficultyScore * 0.4) + (userLevelScore * 0.3) + ((1 - progressScore) * 0.3); + } + + private double calculateDifficulty(Word word) { + // Implementation of difficulty calculation + // ... + } +} +``` + +In the controller: + +```java +@RestController +@RequestMapping("/api/words") +public class WordController { + @Autowired + private WordService wordService; + + @GetMapping("/recommendations/{userId}") + public ResponseEntity> getPersonalizedRecommendations( + @PathVariable String userId, + @RequestParam(defaultValue = "10") int count) { + List recommendations = wordService.getPersonalizedWordRecommendations(userId, count); + HttpHeaders headers = getCommonHeaders("Get personalized word recommendations"); + + return !recommendations.isEmpty() + ? new ResponseEntity<>(recommendations, headers, HttpStatus.OK) + : new ResponseEntity<>(headers, HttpStatus.NOT_FOUND); + } +} +``` + +This use case demonstrates why the service layer is key: + +1. Complex Business Logic: The recommendation system involves complex calculations and data processing that shouldn't be in the controller. + +2. Data Integration: It requires integration of data from multiple repositories (words, users, and user progress), which is better handled in a service. + +3. Reusability: The recommendation logic can be reused in other parts of the application, such as generating daily practice sessions or progress reports. + +4. Scalability: As the recommendation algorithm becomes more sophisticated (e.g., incorporating machine learning), the service can be easily extended without affecting the controller. + +5. Testability: The complex recommendation logic can be unit tested independently of the web layer. + +6. Separation of Concerns: The controller remains focused on handling HTTP requests and responses, while the service manages the business logic. + +7. Flexibility: If you decide to change how recommendations are generated (e.g., using a third-party AI service), you only need to modify the service, not the controller. + +> This example showcases how a well-structured service layer can handle complex, data-intensive operations while keeping the controller lean and focused on its primary responsibility of managing HTTP interactions. + +## JpaRepository + +```java +public interface WordRepository extends JpaRepository { +``` + +> JpaRepository is an interface provided by Spring Data JPA that simplifies database operations. +> +> It extends other repository interfaces, offering a complete set of CRUD (Create, Read, Update, Delete) operations, as well as paging and sorting capabilities. + +An interface in Java is a contract that specifies a set of abstract methods that a class must implement. It defines what a class should do, without specifying how it should do it. + +In the case of `WordRepository`, extending` JpaRepository` is a good idea because: + +1. Automatic implementation: Spring Data JPA automatically generates the implementation of the repository interface at runtime, saving developers from writing boilerplate code. + +2. Built-in methods: It provides common database operations like save(), findAll(), and deleteById() out of the box. + +3. Custom queries: You can define custom query methods, as seen with getWordById() and getWordByPhoneticSpelling(), by simply declaring them in the interface. + +4. Type safety: JpaRepository uses generics (), ensuring type safety for the entity (Word) and its ID type (String). + +5. Extensibility: You can easily add more custom methods as your application's requirements grow. + +### Queries + +- [Lab#SB08-3: H2 and API Rest – albertprofe wiki](https://albertprofe.dev/springboot/sblab8-3.html#jpa-query-methods) + +**JPA Derived Query Methods** + +`Spring Data JPA` can automatically create queries based on method names in your repository interface. + +```java +public interface UserRepository + extends JpaRepository { + List findByLastNameAndAge(String lastName, int age); +} +``` + +**@Query Annotation** + +You can use the `@Query` annotation to define custom JPQL queries. + +```java +public interface UserRepository + extends JpaRepository { + @Query("SELECT u FROM User u WHERE u.emailAddress = ?1") + User findByEmailAddress(String emailAddress); +} +``` + +**EntityManager with JPQL** + +For more complex queries, you can use the `EntityManager` directly with JPQL. + +```java +@PersistenceContext +private EntityManager entityManager; + +public List findUsersByAgeRange(int minAge, int maxAge) { + String jpql = "SELECT u FROM User u WHERE u.age BETWEEN :minAge AND :maxAge"; + return entityManager.createQuery(jpql, User.class) + .setParameter("minAge", minAge) + .setParameter("maxAge", maxAge) + .getResultList(); +} +``` + +**Native SQL Queries** + +When you need to use database-specific features, you can write native SQL queries. + +```java +public interface UserRepository extends JpaRepository { + @Query(value = "SELECT * FROM users WHERE status = ?1", nativeQuery = true) + List findUsersByStatus(int status); +} +``` diff --git a/backend/resources/pronunciationApp-v0.3.md b/backend/resources/pronunciationApp-v0.3.md new file mode 100644 index 000000000..5aaff7bcf --- /dev/null +++ b/backend/resources/pronunciationApp-v0.3.md @@ -0,0 +1,569 @@ +# PronunciationApp Backend v0.3 + +## JPA References + +- [Spring Boot: Data & DB – albertprofe wiki](https://albertprofe.dev/springboot/boot-concepts-data.html) + +- [Spring Boot: JPA & DI – albertprofe wiki](https://albertprofe.dev/springboot/boot-concepts-jpa.html) + +- [Spring Boot: JPA Mappings – albertprofe wiki](https://albertprofe.dev/springboot/boot-concepts-jpa-2.html) + +- [Spring Boot: JPA Relationships – albertprofe wiki](https://albertprofe.dev/springboot/boot-concepts-jpa-3.html) + +- [Spring Boot: JPA Queries – albertprofe wiki](https://albertprofe.dev/springboot/boot-concepts-jpa-4.html) + +- [Spring Boot: JPA Inherence – albertprofe wiki](https://albertprofe.dev/springboot/boot-concepts-jpa-5.html) + +- [Spring Boot: Scaling – albertprofe wiki](https://albertprofe.dev/springboot/boot-concepts-scaling.html) + +### Summary + +JPA stands for `Java Persistence API`. + +It is a Java specification for **managing, persisting, and accessing relational data** in Java applications. + +JPA is a **standard API for ORM (Object-Relational Mapping)** and provides a way to map Java objects to relational databases + +## Word 1:n Pronunciation Bidirectional + +```java +@Entity +public class Word { + @Id + private String id; + private String wordName; + private String definition; + private String phoneticSpelling; + private String sentence; + private boolean isActive; + private int level; +} + +// .. +@Entity +public class Pronunciation { + @Id + private String id; + private String audioDescription; + private long audioDuration; + private long audioSize; + private String audioUrl; + private String definition; + private String phoneticSpelling; + private String speakerGender; + public enum Type { + RECORDED, SAMPLE + } + private Type type; +} +``` + +**Step 1: Define the Relationship** + +> We must to identify the relationship as One-to-Many: one Word can have multiple Pronunciations, and each Pronunciation belongs to a unique Word. + +**Step 2: Choose the Annotations** + +We need to use `@OneToMany` in the `Word` entity and `@ManyToOne` in the `Pronunciation` entity. + +**Step 3: Use @JoinColumn** + +The `@JoinColumn` annotation is key for specifying the foreign key **column** in the `Pronunciation` table + +**Step 4: Configure the Annotations** + +We can configure the annotations for better performance and consistency: + +In the `Word` class: + +```java +@OneToMany(mappedBy = "word", cascade = CascadeType.ALL, fetch = FetchType.LAZY) +private List pronunciations = new ArrayList<>(); +``` + +In the `Pronunciation` class: + +```java +@ManyToOne(fetch = FetchType.LAZY) +@JoinColumn(name = "WORD_ID_FK", nullable = false) +private Word word; +``` + +- `cascade = CascadeType.ALL` ensures that operations on Word are cascaded to associated Pronunciations. +- `fetch = FetchType.LAZY` improves performance by loading related entities only when accessed. +- `nullable = false` ensures that every Pronunciation must be associated with a Word. + +```java +@Entity +public class Word { + @Id + private String id; + private String wordName; + private String definition; + private String phoneticSpelling; + private String sentence; + private boolean isActive; + private int level; + + @OneToMany(mappedBy = "word") + private List pronunciations; +} + +// .. +@Entity +public class Pronunciation { + @Id + private String id; + private String audioDescription; + private long audioDuration; + private long audioSize; + private String audioUrl; + private String definition; + private String phoneticSpelling; + private String speakerGender; + + public enum Type { + RECORDED, SAMPLE + } + @Enumerated(EnumType.STRING) + private Type type; + + @JsonIgnore + @ManyToOne + @JoinColumn(name = "WORD_ID_FK") + private Word word; +} +``` + +### Test JUnit + +#### With @SpringBootTest + +Test Class Overview: + +- Uses `@SpringBootTest` annotation, which loads the full application context for testing. +- Autowires `WordRepository` and `PronunciationRepository` for database operations. + +Test Method: AssignTestWord + +1. Creates a new `Pronunciation` object and sets its properties. +2. Saves the `Pronunciation` object to the database. +3. Attempts to find a `Word` by ID "8f7d1b9e3a2c5f6e". +4. If the `Word` is found: + - Associates the `Pronunciation` with the found `Word`. + - Saves the updated `Pronunciation` to the database. + +**Key Points** + +- The test doesn't create a new `Word`, it assumes one exists with ID "8f7d1b9e3a2c5f6e". +- There are no assertions to verify the test results. +- The test demonstrates how to associate a `Pronunciation` with an existing `Word`. +- Commented code suggests alternative approaches that were not implemented. + +**Potential Improvements** + +- Add assertions to verify the relationship is correctly established. +- Create a `Word` object if it doesn't exist to ensure test consistency. +- Use `@DataJpaTest` for more focused repository testing. +- Add error handling for cases where the `Word` is not found. + +```java +@SpringBootTest +public class PronunciationTest { + + @Autowired + WordRepository wordRepository; + @Autowired + PronunciationRepository pronunciationRepository; + + @Test + public void AssignTestWord(){ + + // New Pronunciation object + Pronunciation p1 = new Pronunciation(); + p1.setId("1"); + p1.setAudioDescription("test"); + p1.setAudioDuration(1); + p1.setAudioSize(1); + p1.setAudioUrl("test"); + p1.setDefinition("test"); + p1.setPhoneticSpelling("test"); + p1.setSpeakerGender("test"); + p1.setType(Pronunciation.type.SAMPLE); + + pronunciationRepository.save(p1); + + // get word by id from repository + // by JPA repository by id returning optional container Word/Null + Optional optionalWord = wordRepository.findById("8f7d1b9e3a2c5f6e"); + System.out.println(optionalWord); + + if (optionalWord.isPresent()) { + // get word from optional container + p1.setWord(optionalWord.get()); + pronunciationRepository.save(p1); + } + + } +} +``` + +#### With @DataJpaTest + +Our test case is a good start, but there are a few improvements we can make: + +1. Use `@DataJpaTest` instead of `@SpringBootTest` for repository tests to load only JPA-related components. +2. Use `@Transactional` to ensure each test runs in its own transaction. +3. Add assertions to verify the relationship is correctly established. + +Here's an improved version of our test: + +```java +@DataJpaTest +@Transactional +public class PronunciationTest { + + @Autowired + WordRepository wordRepository; + @Autowired + PronunciationRepository pronunciationRepository; + + @Test + public void testAssignPronunciationToWord() { + // Create and save a Word + Word word = new Word(); + word.setId("8f7d1b9e3a2c5f6e"); + word.setWordName("Test"); + wordRepository.save(word); + + // Create and save a Pronunciation + Pronunciation pronunciation = new Pronunciation(); + pronunciation.setId("1"); + pronunciation.setAudioDescription("test"); + // ... set other fields ... + pronunciation.setWord(word); + pronunciationRepository.save(pronunciation); + + // Verify the relationship + Optional retrievedWord = wordRepository.findById("8f7d1b9e3a2c5f6e"); + assertThat(retrievedWord).isPresent(); + assertThat(retrievedWord.get().getPronunciations()).hasSize(1); + assertThat(retrievedWord.get().getPronunciations().get(0).getId()).isEqualTo("1"); + + Optional retrievedPronunciation = pronunciationRepository.findById("1"); + assertThat(retrievedPronunciation).isPresent(); + assertThat(retrievedPronunciation.get().getWord().getId()).isEqualTo("8f7d1b9e3a2c5f6e"); + } +} +``` + +### Postman Usage + +To test this relationship using Postman: + +1. Create a POST endpoint to create a Word. +2. Create another POST endpoint to create a Pronunciation and associate it with a Word. +3. Create a GET endpoint to retrieve a Word with its associated Pronunciations. + +Example Postman requests: + +1. Create Word: + POST /api/words + + ```json + { + "id": "8f7d1b9e3a2c5f6e", + "wordName": "Example", + "definition": "An instance serving to illustrate" + } + ``` + +2. Create Pronunciation: + POST /api/pronunciations + + ```json + { + "id": "1", + "audioDescription": "Example pronunciation", + "word": { + "id": "8f7d1b9e3a2c5f6e" + } + } + ``` + +3. Retrieve Word with Pronunciations: + GET /api/words/8f7d1b9e3a2c5f6e + +#### Our example + +```json +{ + "id": "8f7d1b9e3a2c5f6e", + "wordName": "aberration", + "definition": "a departure from what is normal, usual, or expected", + "phoneticSpelling": "ˌæbəˈreɪʃən", + "sentence": "The sudden drop in temperature was an aberration for this time of year.", + "level": 3, + "pronunciations": [ + { + "id": "1", + "audioDescription": "test", + "audioDuration": 1, + "audioSize": 1, + "audioUrl": "test", + "definition": "test", + "phoneticSpelling": "test", + "speakerGender": "test", + "type": "SAMPLE" + } + ], + "active": true +``` + +## Word 1:n Pronunciation Unidirectional + +> Let's create the two unidirectional versions of the relationship between `Word` and `Pronunciation`. + +**Version 1: Unidirectional One-to-Many (Word owns the relationship)** + +In this version, the `Word` entity knows about the `Pronunciation` entities, but the `Pronunciation` entity doesn't have a direct reference back to the `Word`. + +```java +@Entity +public class Word { + @Id + private String id; + private String wordName; + private String definition; + private String phoneticSpelling; + private String sentence; + private boolean isActive; + private int level; + + @OneToMany + @JoinColumn(name = "WORD_ID_FK") // Foreign key in Pronunciation table + private List pronunciations; + + // Constructors, getters, and setters + +} + +@Entity +public class Pronunciation { + @Id + private String id; + private String audioDescription; + private long audioDuration; + private long audioSize; + private String audioUrl; + private String definition; + private String phoneticSpelling; + private String speakerGender; + + public enum Type { + RECORDED, SAMPLE + } + @Enumerated(EnumType.STRING) + private Type type; + + // Remove the ManyToOne relationship + // @JsonIgnore + // @ManyToOne + // @JoinColumn(name = "WORD_ID_FK") + // private Word word; + + // Constructors, getters, and setters + +} +``` + +**Changes:** + +* In the `Word` entity, the `@OneToMany` annotation now has a `@JoinColumn(name = "WORD_ID_FK")`. This specifies that the `WORD_ID_FK` column in the `Pronunciation` table will be used as the foreign key. +* In the `Pronunciation` entity, the `@ManyToOne` relationship and the associated `word` field are removed. + +**Version 2: Unidirectional Many-to-One (Pronunciation knows about Word)** + +In this version, a `Pronunciation` entity knows to which `Word` it belongs, but the `Word` entity has no direct knowledge of the `Pronunciation` entities. + +```java +@Entity +public class Word { + @Id + private String id; + private String wordName; + private String definition; + private String phoneticSpelling; + private String sentence; + private boolean isActive; + private int level; + + // Remove the OneToMany relationship + //@OneToMany + //@JoinColumn(name = "WORD_ID_FK") // Foreign key in Pronunciation table + //private List pronunciations; + + // Constructors, getters, and setters +} + +@Entity +public class Pronunciation { + @Id + private String id; + private String audioDescription; + private long audioDuration; + private long audioSize; + private String audioUrl; + private String definition; + private String phoneticSpelling; + private String speakerGender; + + public enum Type { + RECORDED, SAMPLE + } + @Enumerated(EnumType.STRING) + private Type type; + + // Add the ManyToOne relationship + @ManyToOne + @JoinColumn(name = "WORD_ID_FK") + private Word word; + + // Constructors, getters, and setters + +} +``` + +**Changes:** + +* In the `Word` entity, the `@OneToMany` relationship and its associated `pronunciations` field are removed. +* In the `Pronunciation` entity, the `@ManyToOne` relationship is added with the `@JoinColumn(name = "WORD_ID_FK")`. This indicates that the `Pronunciation` entity has a foreign key relationship with the `Word` entity. + +**Important Considerations:** + +* In both unidirectional approaches, the database schema will still include a `WORD_ID_FK` column in the `Pronunciation` table. +* Choosing the appropriate unidirectional approach depends on your application's specific needs and how you intend to query and access the data. The first version will be good if you mostly work with `Word` and their `Pronunciation` and the second one if the oposite. + +## Summary Table + +| Relationship Type | Owner | Inverse | Word (Fields & Annotations) | Pronunciation (Fields & Annotations) | +| ----------------------------------- | ------------- | ------------- | --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| Bidirectional | Pronunciation | Word | `@OneToMany(mappedBy = "word")`
`private List pronunciations;` | `@ManyToOne`
`@JoinColumn(name = "WORD_ID_FK")`
`private Word word;`
`@JsonIgnore` (optional, to prevent infinite recursion) | +| Unidirectional (Word owns) | Word | Pronunciation | `@OneToMany`
`@JoinColumn(name = "WORD_ID_FK")`
`private List pronunciations;` | No field referencing Word. | +| Unidirectional (Pronunciation owns) | Pronunciation | Word | No field referencing Pronunciation. | `@ManyToOne`
`@JoinColumn(name = "WORD_ID_FK")`
`private Word word;` | + +**Explanation of the Table Columns:** + +* **Relationship Type:** The type of relationship between the `Word` and `Pronunciation` entities (bidirectional, unidirectional from `Word`, unidirectional from `Pronunciation`). +* **Owner:** The entity that "owns" the relationship. The owning side is responsible for managing the foreign key column in the database. +* **Inverse:** The entity on the non-owning (or inverse) side of the relationship. +* **Word (Fields & Annotations):** Shows if Word contains field and annotations. +* **Pronunciation (Fields & Annotations):** Shows if Pronunciation contains field and annotations. + +## Word 1:n StageWord + +Let's integrate the `StageWord` entity into the existing `Word` entity with a **one-to-many** relationship: + +```java +@Entity +public class Word { + + @Id + private String id; + private String wordName; + private String definition; + private String phoneticSpelling; + private String sentence; + private boolean isActive; + private int level; + + @OneToMany(mappedBy = "word", +                cascade = CascadeType.ALL, fetch = FetchType.LAZY)) + private List pronunciations; + + @OneToMany(mappedBy = "word", + cascade = CascadeType.ALL, fetch = FetchType.LAZY) + private List stageWords; + + // ... getters and setters ... + +} +``` + +```java +@Entity +public class StageWord { + + @Id + private String id; + + @Enumerated(EnumType.STRING) + private Status status; + + private int listenedQty; + private Date lastUpdatedDateTime; + + @JsonIgnore + @ManyToOne(fetch = FetchType.LAZY) + @JoinColumn(name = "WORD_ID_FK", nullable = false) + private Word word; + + public enum Status { + DONE, PENDING, FAIL + } +} +``` + +Key points: + +* **`Word` Entity:** + + * `@OneToMany(mappedBy = "word", cascade = CascadeType.ALL, fetch = FetchType.LAZY)`: This annotation establishes the one-to-many relationship. + * `mappedBy = "word"`: Specifies that the `word` field in the `StageWord` entity owns the relationship. + * `cascade = CascadeType.ALL`: Ensures that all operations (persist, merge, remove) on a `Word` entity are cascaded to its associated `StageWord` entities. This is useful for managing the lifecycle of the related entities. + * `fetch = FetchType.LAZY`: Loads the `stageWords` only when they are accessed, improving performance. + +* **`StageWord` Entity:** + + * `@ManyToOne(fetch = FetchType.LAZY)`: Establishes the many-to-one relationship back to the `Word` entity. + * `@JoinColumn(name = "WORD_ID_FK", nullable = false)`: Specifies the foreign key column in the `StageWord` table that references the `Word` table. `nullable = false` ensures that every `StageWord` must be associated with a `Word`. + * `@JsonIgnore`: This annotation prevents infinite recursion during serialization when fetching `Word` objects with their associated `StageWord` objects, which in turn would try to serialize the `Word` object again. + +## Enum + +- [Enum](https://drive.google.com/drive/folders/1I68HPNDff_XCo0NbxuJjlOkap0kUNTxe?usp=drive_link) + +- [Enum Oracle](https://docs.oracle.com/javase/tutorial/java/javaOO/enum.html) + +> `enum` is commonly used in JPA entities to represent a field that can only have a specific set of predefined values, providing type safety and clear semantics in your Java code while ensuring proper persistence in the database. + +1. Enum Definition: + + ```java + public enum Type { + RECORDED, SAMPLE + } + ``` + + This defines an enumeration called `Type` with two possible values: `RECORDED` and `SAMPLE`. `Enums` in Java are used to define a fixed set of constants. + +2. Field Declaration: + + ```java + @Enumerated(EnumType.STRING) + private Type type; + ``` + + This declares a private field named `type` of the `Type` enum type. + + The `@Enumerated` annotation is used to specify how the enum should be persisted in the database. + +Key points: + +1. The `@Enumerated` annotation is from the JPA (Java Persistence API) and is used to specify how an enum type should be persisted in the database. + +2. `EnumType.STRING` indicates that the enum will be stored as a string in the database. This means the actual names of the enum constants (`"RECORDED"` or `"SAMPLE"`) will be stored, rather than their ordinal values. + +3. Using `EnumType.STRING` is often preferred over the default `EnumType.ORDINAL` because it's more robust against changes in the enum order and provides better readability in the database. + +4. When retrieving data from the database, **JPA will automatically convert the string back into the corresponding enum value.** diff --git a/backend/resources/pronunciationApp-v0.4.md b/backend/resources/pronunciationApp-v0.4.md new file mode 100644 index 000000000..fbfa2751c --- /dev/null +++ b/backend/resources/pronunciationApp-v0.4.md @@ -0,0 +1,168 @@ +# PronunciationApp Backend v0.4 + +**Reference links**: + +- [pronunciationApp model· GitHub](https://github.com/AlbertProfe/pronunciationApp/tree/backend-spring-boot/backend/resources/jpa/model) +- [pronunciationApp-v0.3.md GitHub](https://github.com/AlbertProfe/pronunciationApp/blob/backend-spring-boot/backend/resources/pronunciationApp-v0.3.md) +- [userBorrowBook sanbox repo](https://github.com/AlbertProfe/userBorrowBook) + +## One-To-One + +```java +@Entity +public class AppUser { + @Id + @GeneratedValue(generator = "UUID") + @GenericGenerator(name = "UUID", strategy = "org.hibernate.id.UUIDGenerator") + private String id; + + private String aapUserName; + private int age; + private String email; + private String password; + private int totalScore; + private boolean isActive; + + @OneToOne(mappedBy = "user", cascade = CascadeType.ALL) + private GameProgress gameProgress; +} + + +// ... + +@Entity +public class GameProgress { + @Id + @GeneratedValue(generator = "UUID") + @GenericGenerator(name = "UUID", strategy = "org.hibernate.id.UUIDGenerator") + private String id; + + private int currentScore; + + public enum Stage { + STAGE_01, STAGE_02, STAGE_03, STAGE_04, STAGE_05 + } + + @Enumerated(EnumType.STRING) + private Stage currentStage; + + @Temporal(TemporalType.TIMESTAMP) + private Date lastPlayedDate; + + private int wordsLearned; + + @OneToOne + @JoinColumn(name = "appUser_id") + private AppUser appUser; +} +``` + +### One-to-One Relationship in JPA: AppUser and GameProgress + +**Bidirectional Relationship** + +In this example, we have a bidirectional one-to-one relationship between `AppUser` and `GameProgress`. Here's a simple explanation: + +1. **AppUser Entity:** + + java + + `@OneToOne(mappedBy = "user", cascade = CascadeType.ALL) private GameProgress gameProgress;` + + - This annotation indicates that each `AppUser` is associated with one `GameProgress`. + + - `mappedBy = "user"` specifies that `GameProgress` owns the relationship. + + - `cascade = CascadeType.ALL` means that operations on `AppUser` will cascade to the associated `GameProgress`. + +2. **GameProgress Entity:** + + java + + `@OneToOne @JoinColumn(name = "user_id") private AppUser appUser;` + + - This annotation shows that each `GameProgress` is linked to one `AppUser`. + + - `@JoinColumn(name = "user_id")` creates a column in the `GameProgress` table to store the `AppUser`'s ID. + +**Bidirectional vs Unidirectional** + +Bidirectional (Current Setup): + +- Both entities have a reference to each other. + +- You can navigate from `AppUser` to `GameProgress` and vice versa. + +- Useful when you need to access related data from both sides frequently. + +Unidirectional (Alternative): + +If we remove the `gameProgress` field from `AppUser`, it becomes unidirectional: + +- Only `GameProgress` would have a reference to `AppUser`. + +- You could navigate from `GameProgress` to `AppUser`, but not the other way around. + +- Simpler, but limits navigation to one direction. + +**Key Points** + +- In a bidirectional relationship, one side must own the relationship (here, `GameProgress`). + +- The non-owning side uses `mappedBy` to indicate the owning side's field name. + +- Bidirectional relationships offer more flexibility but require careful management to maintain consistency. + +## Many-To-Many + +In JPA (Java Persistence API) with Spring Boot, many-to-many relationships between entities can be implemented in **two main ways**: + +1. **Using `@ManyToMany` with `@JoinTable`:** + + - This approach can be configured as either **unidirectional** or **bidirectional**. + + - It relies on a **join table** managed by JPA through the `@JoinTable` annotation. + + - Example: + + ```java + @ManyToMany + @JoinTable( + name = "student_course", + joinColumns = @JoinColumn(name = "student_id"), + inverseJoinColumns = @JoinColumn(name = "course_id") + ) + private Set courses; + ``` + + - **Use case:** Ideal for simple relationships where the join table does not require additional attributes. + +2. **Using an Intermediate Entity with `@OneToMany` and `@ManyToOne`:** + + - This approach involves creating an **intermediate entity** to represent the relationship explicitly. + + - The intermediate entity acts as an **assignment table** and connects the two main entities using `@OneToMany` and `@ManyToOne`. + + - Example: + + ```java + @Entity + public class StudentCourse { + @Id + @GeneratedValue(strategy = GenerationType.IDENTITY) + private Long id; + + @ManyToOne + @JoinColumn(name = "student_id") + private Student student; + + @ManyToOne + @JoinColumn(name = "course_id") + private Course course; + + // Additional attributes (e.g., enrollment date, grade) + private LocalDate enrolledDate; + } + ``` + + - **Use case:** Necessary when the relationship requires additional attributes or when more control over the join table is needed. diff --git a/backend/resources/springboot-for-5yo.md b/backend/resources/springboot-for-5yo.md new file mode 100644 index 000000000..37463525d --- /dev/null +++ b/backend/resources/springboot-for-5yo.md @@ -0,0 +1,41 @@ +# Spring Boot and MVC to a 5yo kid + +> Imagine a big restaurant called `Spring Boot`. + +Here's how it works: + +- The menu is like the `View`. It shows you all the yummy food you can order. + +- When you come in, you meet the maitre. They're like the `Front Controller`, welcoming you and guiding you to your table. + +- The waiter is like the `Controller`. They take your order and make sure you get what you wan. + +- Once the waiter has the order, our restaurant is so big that all the waiters are queuing to deliver the orders to the **kitchen**: it's where all the food is prepared. Our restaurant has a orders-board where the waiter boss pins the order, it is like the `Service`. + +- In the kitchen, there's a chef who's like `JPA`. They know all the recipes and how to make the dishes just right. + +- The cook is like `SQL queries.` They do the actual cooking, following the chef's instructions. + +- Each plate has a super-sercret code just for superheroes, this secret code is the `id` at `database`. + +- All the ingredients are kept in the pantry and fridge, which is like the `database`. + +- And finally, the plates and dishes are like the `Model`. They hold all the delicious food that comes to your table. + +- Imagine you want pizza at home. The `API Rest` is like a super-fast delivery superhero who brings your yummy food exactly where you want it! + +- What if you could watch chefs cooking? The `WebSocket` is like a magical window where you see everything happening in the kitchen, right when it's happening! + +- The `Security` is like a kind and strong firend who makes sure only nice people can enter and keeps all the secret recipes safe. + +- The `Thymeleaf Templates` and `Vaadin` create super cool, colorful menus that make you smile and want to try everything. + +- When you want the perfect meal, the `AI` is like a magic waiter who knows exactly what you like and suggests the most delicious food just for you! + +- Someone needs to make sure everything works perfectly. The `Actuator` is like the restaurant's superhero manager who watches over everything. + +- What if restaurants could help each other? The `Spring Cloud` is like a big friendly restaurant family that shares cool tricks and helps everyone. + +- Want to cook something amazing super fast? The `Spring Initializr` is like a magic kitchen that appears instantly, ready to make any delicious meal you want! + +All these parts work together to make sure you have a great meal at the Spring Boot restaurant!