Tests in Green, eveything should work !

Lab01App-build/Lab01App-code/src/main/java/ch/heigvd/res/lab01/impl/Application.java

@@ -7,154 +7,195 @@
 import ch.heigvd.res.lab01.interfaces.IFileVisitor;
 import ch.heigvd.res.lab01.quotes.QuoteClient;
 import ch.heigvd.res.lab01.quotes.Quote;
-import java.io.File;
-import java.io.FileOutputStream;
-import java.io.IOException;
-import java.io.OutputStreamWriter;
-import java.io.StringWriter;
-import java.io.Writer;
+
+import java.io.*;
+import java.util.*;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import org.apache.commons.io.FileUtils;
 
 /**
  *
  * @author Olivier Liechti
+ * EDITED BY 
+ * @author Antoine Nourazar
  */
 public class Application implements IApplication {
 
-  /**
-   * This constant defines where the quotes will be stored. The path is relative
-   * to where the Java application is invoked.
-   */
-  public static String WORKSPACE_DIRECTORY = "./workspace/quotes";
-
-  private static final Logger LOG = Logger.getLogger(Application.class.getName());
-
-  public static void main(String[] args) {
-
-    /*
-     * I prefer to have LOG output on a single line, it's easier to read. Being able
-     * to change the formatting of console outputs is one of the reasons why it is
-     * better to use a Logger rather than using System.out.println
-     */
-    System.setProperty("java.util.logging.SimpleFormatter.format", "%4$s: %5$s%6$s%n");
-
-
-    int numberOfQuotes = 0;
-    try {
-      numberOfQuotes = Integer.parseInt(args[0]);
-    } catch (Exception e) {
-      System.err.println("The command accepts a single numeric argument (number of quotes to fetch)");
-      System.exit(-1);
-    }
-
-    Application app = new Application();
-    try {
+   /**
+    * This constant defines where the quotes will be stored. The path is
+    * relative to where the Java application is invoked.
+    */
+   public static String WORKSPACE_DIRECTORY = "." + File.separator + "workspace"
+           + File.separator + "quotes";
+
+   private static final Logger LOG = Logger.getLogger(Application.class.getName());
+
+   public static void main(String[] args) {
+
       /*
-       * Step 1 : clear the output directory
+       * I prefer to have LOG output on a single line, it's easier to read. Being able
+       * to change the formatting of console outputs is one of the reasons why it is
+       * better to use a Logger rather than using System.out.println
        */
-      app.clearOutputDirectory();
+      System.setProperty("java.util.logging.SimpleFormatter.format", "%4$s: %5$s%6$s%n");
 
-      /*
-       * Step 2 : use the QuotesClient to fetch quotes; store each quote in a file
-       */
-      app.fetchAndStoreQuotes(numberOfQuotes);
+      int numberOfQuotes = 0;
+      try {
+         numberOfQuotes = Integer.parseInt(args[0]);
+      } catch (Exception e) {
+         System.err.println("The command accepts a single numeric argument (number of quotes to fetch)");
+         System.exit(-1);
+      }
 
-      /*
+      Application app = new Application();
+      try {
+         /*
+          * Step 1 : clear the output directory
+          */
+         app.clearOutputDirectory();
+
+         /*
+       * Step 2 : use the QuotesClient to fetch quotes; store each quote in a file
+          */
+         app.fetchAndStoreQuotes(numberOfQuotes);
+
+         /*
        * Step 3 : use a file explorer to traverse the file system; print the name of each directory and file
-       */
-      Writer writer = new StringWriter(); // we create a special writer that will send characters into a string (memory)
-      app.printFileNames(writer);         // we hand over this writer to the printFileNames method
-      LOG.info(writer.toString());       // we dump the whole result on the console
-      
-      /*
+          */
+         Writer writer = new StringWriter(); // we create a special writer that will send characters into a string (memory)
+         app.printFileNames(writer);         // we hand over this writer to the printFileNames method
+         LOG.info(writer.toString());       // we dump the whole result on the console
+
+         /*
        * Step 4 : process the quote files, by applying 2 transformations to their content
        *          (convert to uppercase and add line numbers)
-       */
-      app.processQuoteFiles();
+          */
+         app.processQuoteFiles();
+
+      } catch (IOException ex) {
+         LOG.log(Level.SEVERE, "Could not fetch quotes. {0}", ex.getMessage());
+         ex.printStackTrace();
+      }
+   }
+
+   @Override
+   public void fetchAndStoreQuotes(int numberOfQuotes) throws IOException {
 
-    } catch (IOException ex) {
-      LOG.log(Level.SEVERE, "Could not fetch quotes. {0}", ex.getMessage());
-      ex.printStackTrace();
-    }
-  }
-
-  @Override
-  public void fetchAndStoreQuotes(int numberOfQuotes) throws IOException {
-    clearOutputDirectory();
-    QuoteClient client = new QuoteClient();
-    for (int i = 0; i < numberOfQuotes; i++) {
-      Quote quote = client.fetchQuote();
-      /* There is a missing piece here!
-       * As you can see, this method handles the first part of the lab. It uses the web service
-       * client to fetch quotes. We have removed a single line from this method. It is a call to
-       * one method provided by this class, which is responsible for storing the content of the
-       * quote in a text file (and for generating the directories based on the tags).
-       */
-      LOG.info("Received a new joke with " + quote.getTags().size() + " tags.");
-      for (String tag : quote.getTags()) {
-        LOG.info("> " + tag);
+      clearOutputDirectory();
+      QuoteClient client = new QuoteClient();
+
+      for (int i = 0; i < numberOfQuotes; i++) {
+
+         Quote quote = client.fetchQuote();
+         /* There is a missing piece here!
+          * As you can see, this method handles the first part of the lab. It uses the web service
+          * client to fetch quotes. We have removed a single line from this method. It is a call to
+          * one method provided by this class, which is responsible for storing the content of the
+          * quote in a text file (and for generating the directories based on the tags).
+          *
+          * FIXED
+          */
+         storeQuote(quote, "quote-" + Integer.toString(i+1) + ".utf8");
+
+         LOG.info("Received a new joke with " + quote.getTags().size() + " tags.");
+         for (String tag : quote.getTags()) {
+            LOG.info("> " + tag);
+         }
       }
-    }
-  }
-
-  /**
-   * This method deletes the WORKSPACE_DIRECTORY and its content. It uses the
-   * apache commons-io library. You should call this method in the main method.
-   * 
-   * @throws IOException 
-   */
-  void clearOutputDirectory() throws IOException {
-    FileUtils.deleteDirectory(new File(WORKSPACE_DIRECTORY));    
-  }
+   }
+
+   /**
+    * This method deletes the WORKSPACE_DIRECTORY and its content. It uses the
+    * apache commons-io library. You should call this method in the main method.
+    *
+    * @throws IOException
+    */
+   void clearOutputDirectory() throws IOException {
+      FileUtils.deleteDirectory(new File(WORKSPACE_DIRECTORY));
+   }
+
+   /**
+    * This method stores the content of a quote in the local file system. It has
+    * 2 responsibilities:
+    *
+    * - with quote.getTags(), it gets a list of tags and uses it to create
+    * sub-folders (for instance, if a quote has three tags "A", "B" and "C", it
+    * will be stored in /quotes/A/B/C/quotes-n.utf8.
+    *
+    * - with quote.getQuote(), it has access to the text of the quote. It stores
+    * this text in UTF-8 file.
+    *
+    * @param quote the quote object, with tags and text
+    * @param filename the name of the file to create and where to store the
+    * quote text
+    * @throws IOException
+    */
+   void storeQuote(Quote quote, String filename) throws IOException {
+
+      //Get the tags
+      List<String> tagsList = quote.getTags();
 
-  /**
-   * This method stores the content of a quote in the local file system. It has
-   * 2 responsibilities: 
-   * 
-   * - with quote.getTags(), it gets a list of tags and uses
-   *   it to create sub-folders (for instance, if a quote has three tags "A", "B" and
-   *   "C", it will be stored in /quotes/A/B/C/quotes-n.utf8.
-   * 
-   * - with quote.getQuote(), it has access to the text of the quote. It stores
-   *   this text in UTF-8 file.
-   * 
-   * @param quote the quote object, with tags and text
-   * @param filename the name of the file to create and where to store the quote text
-   * @throws IOException 
-   */
-  void storeQuote(Quote quote, String filename) throws IOException {
-    throw new UnsupportedOperationException("The student has not implemented this method yet.");
-  }
-
-  /**
-   * This method uses a IFileExplorer to explore the file system and prints the name of each
-   * encountered file and directory.
-   */
-  void printFileNames(final Writer writer) {
-    IFileExplorer explorer = new DFSFileExplorer();
-    explorer.explore(new File(WORKSPACE_DIRECTORY), new IFileVisitor() {
-      @Override
-      public void visit(File file) {
-        /*
-         * There is a missing piece here. Notice how we use an anonymous class here. We provide the implementation
-         * of the the IFileVisitor interface inline. You just have to add the body of the visit method, which should
-         * be pretty easy (we want to write the filename, including the path, to the writer passed in argument).
-         */
+      /* Create the directory */
+      String directory = WORKSPACE_DIRECTORY;
+
+      //Create the pathname
+      for (String tag : tagsList) {
+         directory += File.separator + tag;
       }
-    });
-  }
-
-  @Override
-  public String getAuthorEmail() {
-    throw new UnsupportedOperationException("The student has not implemented this method yet.");
-  }
+
+      filename = directory + File.separator + filename;
+
+      File file = new File(directory);
+
+      //Create every necessary directories
+      file.mkdirs();
+
+      File namedFile = new File(filename);
+
+      //Writing in the file...
+      BufferedOutputStream writer = new BufferedOutputStream(new FileOutputStream(namedFile));
+      writer.write(quote.getQuote().getBytes("UTF-8"));
+      writer.close();
+   }
 
-  @Override
-  public void processQuoteFiles() throws IOException {
-    IFileExplorer explorer = new DFSFileExplorer();
-    explorer.explore(new File(WORKSPACE_DIRECTORY), new CompleteFileTransformer());    
-  }
+   /**
+    * This method uses a IFileExplorer to explore the file system and prints the
+    * name of each encountered file and directory.
+    */
+   void printFileNames(final Writer writer) {
+
+      IFileExplorer explorer = new DFSFileExplorer();
+      explorer.explore(new File(WORKSPACE_DIRECTORY), new IFileVisitor() {
+
+         @Override
+         public void visit(File file) {
+            /*
+             * There is a missing piece here. Notice how we use an anonymous class here. We provide the implementation
+             * of the the IFileVisitor interface inline. You just have to add the body of the visit method, which should
+             * be pretty easy (we want to write the filename, including the path, to the writer passed in argument).
+             *
+             *  FIXED ! 
+             */
+            try {
+               writer.write(file.getPath()+ '\n');
+            } catch (IOException e) {
+               e.printStackTrace();
+            }
+         }
+      });
+   }
+
+   @Override
+   public String getAuthorEmail() {
+      //return my email as it was indicate in IApplication interface
+      return "[email protected]";
+   }
+
+   @Override
+   public void processQuoteFiles() throws IOException {
+      IFileExplorer explorer = new DFSFileExplorer();
+      explorer.explore(new File(WORKSPACE_DIRECTORY), new CompleteFileTransformer());
+   }
 
 }

Lab01App-build/Lab01App-code/src/main/java/ch/heigvd/res/lab01/impl/Utils.java

@@ -5,22 +5,47 @@
 /**
  *
  * @author Olivier Liechti
+ * EDITED BY 
+ * @author Antoine Nourazar
  */
 public class Utils {
 
-  private static final Logger LOG = Logger.getLogger(Utils.class.getName());
+   private static final Logger LOG = Logger.getLogger(Utils.class.getName());
 
-  /**
-   * This method looks for the next new line separators (\r, \n, \r\n) to extract
-   * the next line in the string passed in arguments. 
-   * 
-   * @param lines a string that may contain 0, 1 or more lines
-   * @return an array with 2 elements; the first element is the next line with
-   * the line separator, the second element is the remaining text. If the argument does not
-   * contain any line separator, then the first element is an empty string.
-   */
-  public static String[] getNextLine(String lines) {
-    throw new UnsupportedOperationException("The student has not implemented this method yet.");
-  }
+   /**
+    * This method looks for the next new line separators (\r, \n, \r\n) to extract
+    * the next line in the string passed in arguments.
+    *
+    * @param lines a string that may contain 0, 1 or more lines
+    * @return an array with 2 elements; the first element is the next line with the
+    * line separator, the second element is the remaining text. If the argument does
+    * not contain any line separator, then the first element is an empty string.
+    */
+   public static String[] getNextLine(String lines) {
 
-}
+      String[] lineTab = new String[2];
+
+      /* Initialize an empty string */
+      lineTab[0] = "";
+      lineTab[1] = "";
+
+      String[] separators = {"\r\n","\r", "\n"};
+      int index = -1;
+
+      //Check if the string given is containing one of the separators
+      for (String separator : separators) {
+
+         if (lines.contains(separator)) {
+
+            index = lines.indexOf(separator);
+            //Create the next line
+            lineTab[0] = lines.substring(0,index + 1);
+         }
+      }
+
+      //return the remaining text
+      lineTab[1] = lines.substring(index + 1,lines.length());
+
+      return lineTab;
+   }
+}