Merge pull request #8 from DevLab-umontp/debug

🚑 Patch du package

Author: Fabien "BioTheWolff" Zoccola

README.md

@@ -1,4 +1,4 @@
-<!-- [![Maven Central](https://img.shields.io/maven-central/v/com.github.devlab-umontp/villes-et-departements-de-france.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22com.github.devlab-umontp%22%20AND%20a:%22villes-et-departements-de-france%22) -->
+ [![Maven Central](https://img.shields.io/maven-central/v/com.github.devlab-umontp/villes-et-departements-de-france.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22com.github.devlab-umontp%22%20AND%20a:%22villes-et-departements-de-france%22)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=DevLab-umontp_Librairie-Java-Villes-de-France&metric=alert_status)](https://sonarcloud.io/dashboard?id=DevLab-umontp_Librairie-Java-Villes-de-France)
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=DevLab-umontp_Librairie-Java-Villes-de-France&metric=coverage)](https://sonarcloud.io/dashboard?id=DevLab-umontp_Librairie-Java-Villes-de-France)
 ![GitHub Actions](https://github.com/DevLab-umontp/Librairie-Java-Villes-de-France/workflows/Java%20CI%20with%20Maven/badge.svg)
@@ -23,7 +23,7 @@ Si vous avez Maven, ajoutez ce qui suit aux dépendances de votre fichier `pom.x
 <dependency>
   <groupId>com.github.devlab-umontp</groupId>
   <artifactId>villes-et-departements-de-france</artifactId>
-  <version>1.0.0</version>
+  <version>1.0.1</version>
 </dependency>
 ```
 >*Voir un exemple de fichier [pom.xml](https://github.com/DevLab-umontp/Librarie-Java-Villes-de-France/blob/main/ressources/pom.xml#L20L24) avec la librairie Villes de France*
@@ -32,7 +32,7 @@ Si vous avez Maven, ajoutez ce qui suit aux dépendances de votre fichier `pom.x
 Si vous utilisez Gradle, ajoutez ce qui suit aux dépendances de votre fichier `build.gradle`:
 
 ```
-    implementation 'com.github.devlab-umontp:villes-et-departements-de-france:1.0.0'
+    implementation 'com.github.devlab-umontp:villes-et-departements-de-france:1.0.1'
 ```
 
 ## Exemple de code d'utilisation de la Librairie Java Villes de France

pom.xml

@@ -2,7 +2,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.github.devlab-umontp</groupId>
   <artifactId>villes-et-departements-de-france</artifactId>
-  <version>1.0.0</version>
+  <version>1.0.1</version>
   <packaging>jar</packaging>
 
   <name>Code postaux villes et départements de France</name>
@@ -36,6 +36,7 @@
       <groupId>org.hamcrest</groupId>
       <artifactId>hamcrest</artifactId>
       <version>2.2</version>
+      <scope>test</scope>
     </dependency>
 
     <dependency>
@@ -76,6 +77,12 @@
       <organization>com.github.devlab-umontp</organization>
       <organizationUrl>https://github.com/DevLab-umontp</organizationUrl>
     </developer>
+    <developer>
+      <name>Fabien ZOCCOLA</name>
+      <email>[email protected]</email>
+      <organization>com.github.devlab-umontp</organization>
+      <organizationUrl>https://github.com/DevLab-umontp</organizationUrl>
+    </developer>
   </developers>
 
   <issueManagement>
@@ -191,6 +198,16 @@
   </profiles>
 
   <build>
+    <!-- Resources (the .CSV) -->
+    <resources>
+      <resource>
+        <directory>${project.basedir}</directory>
+        <includes>
+          <include>communes.csv</include>
+        </includes>
+      </resource>
+    </resources>
+
     <plugins>
 
       <plugin>
@@ -262,4 +279,5 @@
 
     </plugins>
   </build>
+
 </project>

ressources/pom.xml

@@ -20,7 +20,7 @@
         <dependency>
             <groupId>com.github.devlab-umontp</groupId>
             <artifactId>villes-et-departements-de-france</artifactId>
-            <version>1.0.0</version>
+            <version>1.0.1</version>
         </dependency>
         <dependency>
             <groupId>org.junit.jupiter</groupId>

src/main/java/fr/france/RepertoireCommune.java

@@ -1,15 +1,17 @@
 package fr.france;
 
 import java.io.FileNotFoundException;
-import java.io.FileReader;
+import java.io.Reader;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
-import com.opencsv.bean.CsvToBeanBuilder;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
 
+import fr.france.outils.OutilsRepertoireCommune;
 import fr.france.outils.OutilsString;
 
 /**
@@ -31,19 +33,21 @@
  */
 public class RepertoireCommune {
 
+    private static final Log log = LogFactory.getLog(RepertoireCommune.class);
+
     private RepertoireCommune() {
-        throw new IllegalStateException("Class utilitaire");
+        throw new IllegalStateException("Classe utilitaire");
     }
 
     private static final List<Commune> COMMUNES = initCommunes();
 
     private static List<Commune> initCommunes() {
         List<Commune> result = null;
         try {
-            result = new CsvToBeanBuilder<Commune>(new FileReader("communes.csv")).withType(Commune.class).build()
-                    .parse();
+            Reader reader = OutilsRepertoireCommune.getRessource("communes.csv");
+            result = OutilsRepertoireCommune.convertirCsvEnCommune(reader);
         } catch (IllegalStateException | FileNotFoundException e) {
-            System.err.println("Le fichier contenant les communes n'a pas été trouvé");
+            log.error(e.getMessage(), e);
         }
         return result;
     }
@@ -53,23 +57,13 @@ private static List<Commune> initCommunes() {
     private static final Map<String, Commune> REPERTOIRE_NOM_ET_CODE_POSTAL;
 
     static {
-        Map<Integer, List<Commune>> codePostaux = new HashMap<>();
-        Map<String, List<Commune>> noms = new HashMap<>();
-        Map<String, Commune> nomEtCodePostal = new HashMap<>();
-        for (Commune Commune : COMMUNES) {
-            if (Commune.getNom() == null)
-                continue;
-            nomEtCodePostal.put(OutilsString.formater(Commune.getNom()) + Commune.getCodePostal(), Commune);
-            List<Commune> villesNom = noms.computeIfAbsent(OutilsString.formater(Commune.getNom()),
-                    k -> new ArrayList<>());
-            List<Commune> villesCodePostal = codePostaux.computeIfAbsent(Commune.getCodePostal(),
-                    k -> new ArrayList<>());
-            villesNom.add(Commune);
-            villesCodePostal.add(Commune);
-        }
-        REPERTOIRE_CODE_POSTAL = Collections.unmodifiableMap(codePostaux);
-        REPERTOIRE_NOM = Collections.unmodifiableMap(noms);
-        REPERTOIRE_NOM_ET_CODE_POSTAL = Collections.unmodifiableMap(nomEtCodePostal);
+        Map<Integer, List<Commune>> repCodePostaux = new HashMap<>();
+        Map<String, List<Commune>> repNoms = new HashMap<>();
+        Map<String, Commune> repNomEtCodePostal = new HashMap<>();
+        OutilsRepertoireCommune.initialiserRepertoires(repCodePostaux, repNoms, repNomEtCodePostal, COMMUNES);
+        REPERTOIRE_CODE_POSTAL = Collections.unmodifiableMap(repCodePostaux);
+        REPERTOIRE_NOM = Collections.unmodifiableMap(repNoms);
+        REPERTOIRE_NOM_ET_CODE_POSTAL = Collections.unmodifiableMap(repNomEtCodePostal);
     }
 
     /**

src/main/java/fr/france/outils/OutilsRepertoireCommune.java

@@ -0,0 +1,58 @@
+package fr.france.outils;
+
+import java.io.FileNotFoundException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.io.Reader;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+
+import com.opencsv.bean.CsvToBeanBuilder;
+
+import fr.france.Commune;
+import fr.france.RepertoireCommune;
+
+/**
+ * <b>OutilsRepertoireCommune est la classe utilitaire de la class
+ * RepertoireCommune.</b>
+ * <p>
+ * Elle permet d'alléger la class {@link fr.france.RepertoireCommune}
+ * </p>
+ * 
+ * @see RepertoireCommune
+ * 
+ * @author MathieuSoysal
+ * @version 1.0.0
+ */
+public class OutilsRepertoireCommune {
+
+    private OutilsRepertoireCommune() {
+        throw new IllegalStateException("Class utilitaire");
+    }
+
+    public static List<Commune> convertirCsvEnCommune(Reader reader) {
+        return new CsvToBeanBuilder<Commune>(reader).withType(Commune.class).build().parse();
+    }
+
+    public static Reader getRessource(String fileName) throws FileNotFoundException {
+        InputStream resource = RepertoireCommune.class.getClassLoader().getResourceAsStream(fileName);
+        if (resource == null)
+            throw new FileNotFoundException("Le fichier contenant les communes n'a pas été trouvé");
+        return new InputStreamReader(resource);
+    }
+
+    public static void initialiserRepertoires(Map<Integer, List<Commune>> codePostaux, Map<String, List<Commune>> noms,
+            Map<String, Commune> nomEtCodePostal, final List<Commune> communes) {
+        for (Commune Commune : communes) {
+            nomEtCodePostal.put(OutilsString.formater(Commune.getNom()) + Commune.getCodePostal(), Commune);
+            List<Commune> villesNom = noms.computeIfAbsent(OutilsString.formater(Commune.getNom()),
+                    k -> new ArrayList<>());
+            List<Commune> villesCodePostal = codePostaux.computeIfAbsent(Commune.getCodePostal(),
+                    k -> new ArrayList<>());
+            villesNom.add(Commune);
+            villesCodePostal.add(Commune);
+        }
+    }
+
+}

src/test/java/fr/france/RepertoireCaumuneTest.java renamed to src/test/java/fr/france/RepertoireCommuneTest.java

@@ -3,14 +3,32 @@
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertNotEquals;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 
+import java.lang.reflect.Constructor;
+import java.lang.reflect.InvocationTargetException;
 import java.util.Collections;
 import java.util.List;
 
 import org.junit.jupiter.api.Test;
 
 class RepertoireCommuneTest {
 
+    @Test
+    void test_ConstructionJetteIllegalStateException() throws NoSuchMethodException {
+        Constructor<RepertoireCommune> constructor = RepertoireCommune.class.getDeclaredConstructor();
+        constructor.setAccessible(true);
+
+        // On vérifie qu'il jette une erreur
+        assertThrows(InvocationTargetException.class, constructor::newInstance);
+        try {
+            constructor.newInstance();
+        } catch (InvocationTargetException | InstantiationException | IllegalAccessException e) {
+            // On vérifie que la cause est bien une IllegalStateException
+            assertEquals("java.lang.IllegalStateException: Classe utilitaire", e.getCause().toString());
+        }
+    }
+
     @Test
     void test_CommunesInitialise() {
         assertNotEquals(Collections.emptyList(), RepertoireCommune.getCommunes());

src/test/java/fr/france/outils/OutilsRepertoireCommuneTest.java

@@ -0,0 +1,18 @@
+package fr.france.outils;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+import java.io.FileNotFoundException;
+
+import org.junit.jupiter.api.Test;
+
+class OutilsRepertoireCommuneTest {
+
+    @Test
+    void test_getRessources() {
+        Throwable e = assertThrows(FileNotFoundException.class, () -> OutilsRepertoireCommune.getRessource("noFile"));
+        assertEquals("Le fichier contenant les communes n'a pas été trouvé", e.getMessage());
+    }
+
+}