GP-67 update exercise while preparing overview

* change the order of the tests
* update javadocs
* simplify impl
* add todo

Author: tboychuk

3-0-spring-framework/3-0-0-hello-spring-framework/src/main/java/com/bobocode/config/ApplicationConfig.java

@@ -1,30 +1,16 @@
 package com.bobocode.config;
 
 import com.bobocode.TestDataGenerator;
-import org.springframework.context.annotation.Bean;
-import org.springframework.context.annotation.ComponentScan;
-import org.springframework.context.annotation.Import;
-import org.springframework.context.annotation.ImportResource;
-import org.springframework.stereotype.Component;
 
 /**
- * This class specify application context configuration. Basically, it's all about which instances of which classes
- * should be created and registered in the context. An instance that is registered in the context is called 'bean'.
+ * This class specifies application context configuration. It tells Spring to scan "dao" and "service" packages in order
+ * to find and create instances for {@link com.bobocode.dao.FakeAccountDao} and
+ * {@link com.bobocode.service.AccountService}.
  * <p>
- * To tell the container, which bean should be created, you could either specify packages to scan using @{@link ComponentScan},
- * or declare your own beans using @{@link Bean}. When you use @{@link ComponentScan} the container will discover
- * specified package and its sub-folders, to find all classes marked @{@link Component}.
- * <p>
- * If you want to import other configs from Java class or XML file, you could use @{@link Import}
- * and @{@link ImportResource} accordingly
- * <p>
- * todo 1: make this class a Spring configuration class
- * todo 2: enable component scanning for dao and service packages
- * todo 3: provide explicit configuration for a bean of type {@link TestDataGenerator} with name "dataGenerator" in this class.
- * hint: use method creation approach with @Bean annotation;
- * todo 4: Don't specify bean name "dataGenerator" explicitly
+ * It also explicitly configures a bean of {@link TestDataGenerator} called "dataGenerator". This beans will be injected
+ * into {@link com.bobocode.dao.FakeAccountDao} in order to generate some fake accounts.
  */
-
 public class ApplicationConfig {
-
+    // todo: configure application context according to javadoc by following tests in ApplicationConfigTest
+    // todo: verify final implementation by running ApplicationContextTest
 }

3-0-spring-framework/3-0-0-hello-spring-framework/src/main/java/com/bobocode/dao/AccountDao.java

@@ -5,7 +5,7 @@
 import java.util.List;
 
 /**
- * Defines an API for {@link Account} data access object (DAO).
+ * Defines a simple API for {@link Account} data access object (DAO).
  */
 public interface AccountDao {
     List<Account> findAll();

3-0-spring-framework/3-0-0-hello-spring-framework/src/main/java/com/bobocode/dao/FakeAccountDao.java

@@ -2,22 +2,20 @@
 
 import com.bobocode.TestDataGenerator;
 import com.bobocode.model.Account;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.stereotype.Component;
 
 import java.util.List;
 import java.util.stream.Stream;
 
 import static java.util.stream.Collectors.toList;
 
 /**
- * This class should be marked with @{@link Component}, thus Spring container will create an instance
- * of {@link FakeAccountDao} class, and will register it the context.
+ * {@link FakeAccountDao} implements {@link AccountDao} using fake data. Instead of storing and fetching accounts from
+ * some storage, it just generates fake records using {@link TestDataGenerator}.
  * <p>
- * todo: configure this class as Spring component with bean name "accountDao"
- * todo: use explicit (with {@link Autowired} annotation) constructor-based dependency injection for specific bean
+ * An instance of this class should be created and added to the application context, so it is marked as Spring component.
+ * Its bean is called "accountDao". And it uses constructor with explicit autowired annotation in order to inject
+ * {@link TestDataGenerator} instance.
  */
-
 public class FakeAccountDao implements AccountDao {
     private List<Account> accounts;
 

3-0-spring-framework/3-0-0-hello-spring-framework/src/main/java/com/bobocode/service/AccountService.java

@@ -3,16 +3,15 @@
 import com.bobocode.dao.AccountDao;
 import com.bobocode.model.Account;
 
-import java.util.Comparator;
-import java.util.List;
+import static java.util.Comparator.comparing;
 
 /**
- * Provides service API for {@link Account}.
+ * {@link AccountService} is a very simple service that allows to find the richest person based on data provided to
+ * {@link AccountDao}.
  * <p>
- * todo: configure {@link AccountService} bean implicitly using special annotation for service classes
- * todo: use implicit constructor-based dependency injection (don't use {@link org.springframework.beans.factory.annotation.Autowired})
+ * Since it's a service that should be added to the application context, it is marked as Spring service. It order to get
+ * {@link AccountDao} instances, it uses implicit constructor-based injection.
  */
-
 public class AccountService {
     private final AccountDao accountDao;
 
@@ -21,9 +20,9 @@ public AccountService(AccountDao accountDao) {
     }
 
     public Account findRichestAccount() {
-        List<Account> accounts = accountDao.findAll();
-        return accounts.stream()
-                .max(Comparator.comparing(Account::getBalance))
-                .get();
+        return accountDao.findAll()
+                .stream()
+                .max(comparing(Account::getBalance))
+                .orElseThrow();
     }
 }

3-0-spring-framework/3-0-0-hello-spring-framework/src/test/java/com/bobocode/ApplicationConfigTest.java

@@ -5,6 +5,7 @@
 import com.bobocode.dao.FakeAccountDao;
 import com.bobocode.service.AccountService;
 import org.junit.jupiter.api.*;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.ComponentScan;
 import org.springframework.context.annotation.Configuration;
@@ -18,7 +19,7 @@
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 
 @TestMethodOrder(MethodOrderer.OrderAnnotation.class)
-public class ApplicationConfigTest {
+class ApplicationConfigTest {
 
     @Test
     @Order(1)
@@ -52,6 +53,24 @@ void componentScanPackagesAreSpecified() {
 
     @Test
     @Order(4)
+    @DisplayName("FakeAccountDao is configured as @Component")
+    void fakeAccountDaoIsConfiguredAsComponent() {
+        Component component = FakeAccountDao.class.getAnnotation(Component.class);
+
+        assertNotNull(component);
+    }
+
+    @Test
+    @Order(5)
+    @DisplayName("AccountDao constructor is marked with @Autowired")
+    void accountDaoConstructorIsMarkedWithAutowired() throws NoSuchMethodException {
+        Autowired autowired = FakeAccountDao.class.getConstructor(TestDataGenerator.class).getAnnotation(Autowired.class);
+
+        assertNotNull(autowired);
+    }
+
+    @Test
+    @Order(6)
     @DisplayName("DataGenerator bean is configured in method marked with @Bean")
     void dataGeneratorBeanIsConfiguredExplicitly() {
         Method[] methods = ApplicationConfig.class.getMethods();
@@ -61,7 +80,7 @@ void dataGeneratorBeanIsConfiguredExplicitly() {
     }
 
     @Test
-    @Order(5)
+    @Order(7)
     @DisplayName("DataGenerator bean name is not specified explicitly")
     void dataGeneratorBeanNameIsNotSpecifiedExplicitly() {
         Method[] methods = ApplicationConfig.class.getMethods();
@@ -73,16 +92,7 @@ void dataGeneratorBeanNameIsNotSpecifiedExplicitly() {
     }
 
     @Test
-    @Order(6)
-    @DisplayName("FakeAccountDao is configured as @Component")
-    void fakeAccountDaoIsConfiguredAsComponent() {
-        Component component = FakeAccountDao.class.getAnnotation(Component.class);
-
-        assertNotNull(component);
-    }
-
-    @Test
-    @Order(7)
+    @Order(8)
     @DisplayName("AccountService is configured as @Service")
     void accountServiceIsConfiguredAsService() {
         Service service = AccountService.class.getAnnotation(Service.class);
@@ -91,7 +101,7 @@ void accountServiceIsConfiguredAsService() {
     }
 
     @Test
-    @Order(8)
+    @Order(9)
     @DisplayName("AccountService bean name is not specified explicitly")
     void accountServiceBeanNameIsNotSpecifiedExplicitly() {
         Service service = AccountService.class.getAnnotation(Service.class);
@@ -100,7 +110,7 @@ void accountServiceBeanNameIsNotSpecifiedExplicitly() {
     }
 
     @Test
-    @Order(9)
+    @Order(10)
     @DisplayName("AccountService doesn't use @Autowired")
     void accountServiceDoesNotUseAutowired() throws NoSuchMethodException {
         Annotation[] annotations = AccountService.class.getConstructor(AccountDao.class).getDeclaredAnnotations();

3-0-spring-framework/3-0-0-hello-spring-framework/src/test/java/com/bobocode/ApplicationContextTest.java

@@ -26,12 +26,6 @@ static class TestConfig {
     @Autowired
     private ApplicationContext applicationContext;
 
-    @Autowired
-    private AccountService accountService;
-
-    @Autowired
-    private AccountDao accountDao;
-
     @Test
     @Order(1)
     @DisplayName("DataGenerator has only one bean")
@@ -43,7 +37,7 @@ void dataGeneratorHasOnlyOneBean() {
 
     @Test
     @Order(2)
-    @DisplayName("DataGenerator bean has proper name")
+    @DisplayName("DataGenerator bean is called \"dataGenerator\"")
     void testDataGeneratorBeanName() {
         Map<String, TestDataGenerator> dataGeneratorBeanMap = applicationContext.getBeansOfType(TestDataGenerator.class);
 
@@ -61,22 +55,13 @@ void accountDaoHasOnlyOneBean() {
 
     @Test
     @Order(4)
-    @DisplayName("AccountDao bean has proper name")
+    @DisplayName("AccountDao bean is called \"accountDao\"")
     void accountDaoBeanName() {
         Map<String, AccountDao> accountDaoBeanMap = applicationContext.getBeansOfType(AccountDao.class);
 
         assertThat(accountDaoBeanMap.keySet()).contains("accountDao");
     }
 
-    @Test
-    @Order(5)
-    @DisplayName("AccountDao constructor is marked with @Autowired")
-    void accountDaoConstructorIsMarkedWithAutowired() throws NoSuchMethodException {
-        Autowired autowired = FakeAccountDao.class.getConstructor(TestDataGenerator.class).getAnnotation(Autowired.class);
-
-        assertNotNull(autowired);
-    }
-
     @Test
     @Order(6)
     @DisplayName("AccountService has only one bean")
@@ -88,7 +73,7 @@ void accountServiceHasOnlyOneBean() {
 
     @Test
     @Order(7)
-    @DisplayName("AccountService has proper name")
+    @DisplayName("AccountService bean is called \"accountService\"")
     void accountServiceBeanName() {
         Map<String, AccountService> accountServiceMap = applicationContext.getBeansOfType(AccountService.class);
 

java-web-course-util/spring-framework-exercises-util/src/main/java/com/bobocode/TestDataGenerator.java

@@ -8,26 +8,31 @@
 import java.math.BigDecimal;
 import java.time.LocalDate;
 import java.time.LocalDateTime;
-import java.util.Random;
+import java.util.concurrent.ThreadLocalRandom;
 
 public class TestDataGenerator {
     public Account generateAccount() {
         Fairy fairy = Fairy.create();
         Person person = fairy.person();
-        Random random = new Random();
 
-        Account fakeAccount = new Account();
-        fakeAccount.setFirstName(person.getFirstName());
-        fakeAccount.setLastName(person.getLastName());
-        fakeAccount.setEmail(person.getEmail());
-        fakeAccount.setBirthday(LocalDate.of(
+        Account account = convertToAccount(person);
+        BigDecimal balance = BigDecimal.valueOf(ThreadLocalRandom.current().nextInt(200_000));
+        account.setBalance(balance);
+        account.setCreationTime(LocalDateTime.now());
+
+        return account;
+    }
+
+    private Account convertToAccount(Person person) {
+        Account account = new Account();
+        account.setFirstName(person.getFirstName());
+        account.setLastName(person.getLastName());
+        account.setEmail(person.getEmail());
+        account.setBirthday(LocalDate.of(
                 person.getDateOfBirth().getYear(),
                 person.getDateOfBirth().getMonthOfYear(),
                 person.getDateOfBirth().getDayOfMonth()));
-        fakeAccount.setGender(Gender.valueOf(person.getSex().name()));
-        fakeAccount.setBalance(BigDecimal.valueOf(random.nextInt(200_000)));
-        fakeAccount.setCreationTime(LocalDateTime.now());
-
-        return fakeAccount;
+        account.setGender(Gender.valueOf(person.getSex().name()));
+        return account;
     }
 }