Recent changes to Developer Guide

Developer Guide modified by BARCELO MARTINEZ Raphaël

BARCELO MARTINEZ Raphaël — Fri, 10 Jan 2020 23:14:41 -0000

--- v28
+++ v29
@@ -37,7 +37,7 @@
                                               * `pathFile` — `string` — - The array in which the results of the function will be returned.
                                               * `pathFile` — `string` — - The directory to explore.

-                                          **Returns:** `Array.<string>` * An array in which the paths of the file found will be stored*
+                                          **Returns:** `Array<string>` * An array in which the paths of the file found will be stored*

 ####               [Parse.js](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/src/Parse.js)

@@ -52,7 +52,7 @@
                                           Then, returns the result of the promise by replacing the unparsed line of the file by the parsed one.

                                            **Parameters:** `pathFile` — `string` *— - The directory of the file to parse.*
-                                           **Returns:** `Promise.<object>` *— - A promise that provides a mail object when resolved*
+                                           **Returns:** `Promise<object>` *— - A promise that provides a mail object when resolved*

 ####               [WriteJSON.js](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/src/WriteJSON.js)

@@ -72,7 +72,7 @@
                                          Finally, writes the formated mail into the JSON file.

                                           **Parameters:** `pathFile` — `string` *— - The directory of the file to parse.*
-                                           **Returns:** `Promise.<object>` *— - A promise that provides a mail object when resolved*
+                                           **Returns:** `Promise<void>` *— - A promise that provides a mail object when resolved*

 ####              [commands.js](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/src/commands.js)


</void></object></object></object></string></string>

Developer Guide modified by BARCELO MARTINEZ Raphaël

BARCELO MARTINEZ Raphaël — Fri, 10 Jan 2020 22:58:09 -0000

--- v27
+++ v28
@@ -247,8 +247,8 @@

 ###                >tests
                       Contains the code used to execute the tests
-                     [Parcours.js](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/tests/Parcours.js "Parcours.js")
-                     [Parse.js](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/tests/Parse.js "Parse.js")
+                      [Parcours.js](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/tests/Parcours.js "Parcours.js")
+                      [Parse.js](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/tests/Parse.js "Parse.js")
                      [WriteJSON.js](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/tests/WriteJSON.js "WriteJSON.js")

Developer Guide modified by BARCELO MARTINEZ Raphaël

BARCELO MARTINEZ Raphaël — Fri, 10 Jan 2020 22:56:50 -0000

--- v26
+++ v27
@@ -2,24 +2,24 @@
 ====================
 


-[>branches](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/branches "branches")  
+>branches
 ---------

-[>tags](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/tags "tags")
+>tags
 -----

 ####        [release-1.0.0](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/tags/release-1.0.0)

               File containing the old version of the code     

-[>trunk](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk "trunk")
+>trunk
 ------

 ####         [.eslintrc.js](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/.eslintrc.js)

 ####         [package.json](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/package.json)

-###         [>src](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/src "src")
+###         >src

               Package containing the source code and all the .js files.

@@ -237,19 +237,19 @@

                                           **Parameters:**  * `user` — `string` — - The user whose contacts will be sought.

-###         >tests_dataset
-               The set of data used to execute the tests.
-####               [>subFolder](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/test_dataset/subFolder "subFolder") 
-                     [3_](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/test_dataset/subFolder/3_ "3_")
+###                 >tests_dataset
+                      The set of data used to execute the tests.
+####                       >subFolder
+                             [3_](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/test_dataset/subFolder/3_ "3_")
               [1_](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/test_dataset/1_ "1_")
               [2_](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/test_dataset/2_ "2_")


-###         >tests
-               Contains the code used to execute the tests
-              [Parcours.js](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/tests/Parcours.js "Parcours.js")
-              [Parse.js](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/tests/Parse.js "Parse.js")
-              [WriteJSON.js](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/tests/WriteJSON.js "WriteJSON.js")
+###                >tests
+                      Contains the code used to execute the tests
+                     [Parcours.js](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/tests/Parcours.js "Parcours.js")
+                     [Parse.js](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/tests/Parse.js "Parse.js")
+                     [WriteJSON.js](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/tests/WriteJSON.js "WriteJSON.js")

Developer Guide modified by BARCELO MARTINEZ Raphaël

BARCELO MARTINEZ Raphaël — Fri, 10 Jan 2020 22:53:59 -0000

--- v25
+++ v26
@@ -5,14 +5,14 @@
 [>branches](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/branches "branches")  
 ---------

-[>tags](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/tags "tags")>
+[>tags](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/tags "tags")
 -----

 ####        [release-1.0.0](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/tags/release-1.0.0)

               File containing the old version of the code     

->trunk
+[>trunk](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk "trunk")
 ------

 ####         [.eslintrc.js](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/.eslintrc.js)

Developer Guide modified by BARCELO MARTINEZ Raphaël

BARCELO MARTINEZ Raphaël — Fri, 10 Jan 2020 22:53:10 -0000

--- v24
+++ v25
@@ -2,10 +2,10 @@
 ====================
 


->branches     
+[>branches](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/branches "branches")  
 ---------

->tags
+[>tags](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/tags "tags")>
 -----

 ####        [release-1.0.0](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/tags/release-1.0.0)
@@ -19,7 +19,7 @@

 ####         [package.json](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/package.json)

-###         >src
+###         [>src](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/src "src")

               Package containing the source code and all the .js files.

@@ -239,7 +239,7 @@

 ###         >tests_dataset
                The set of data used to execute the tests.
-              [subFolder](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/test_dataset/subFolder "subFolder") 
+####               [>subFolder](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/test_dataset/subFolder "subFolder") 
                      [3_](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/test_dataset/subFolder/3_ "3_")
               [1_](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/test_dataset/1_ "1_")
               [2_](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/test_dataset/2_ "2_")

Developer Guide modified by BARCELO MARTINEZ Raphaël

BARCELO MARTINEZ Raphaël — Fri, 10 Jan 2020 22:47:27 -0000

--- v23
+++ v24
@@ -219,7 +219,7 @@
                                           Then, reduce "data" down to the values of the accumulator, and sort them by the one with the highest value.
                                           Finally, cuts down "data" to the 10 first word, and returns it.

-                                          **Parameters:**  * `user` — `string` — - The user whose contacts will be sought.
+                                          **Parameters:**  * `user` — `string` — - The word whose occurences will be sought.



@@ -227,15 +227,30 @@
 #####                             `.argument('<user>', 'A valid mail address')`

                                           see .command('inter', ...) for top 10 interlocutor
+
                                           Uses a vega lite template for a graph, in which is inserted the data from the previous command.
-
                                           Next compiles it and save its specifications into a javascript variable "MyChart".
+
                                           After that, parses it, and renders it into an SVG format.
-                                          After that, trims the whitespaces from the usernames with the trim() function and add them to the Set interlocutors.
-
                                           Finally, saves it in the repository, and prints the path in the console

+
                                           **Parameters:**  * `user` — `string` — - The user whose contacts will be sought.
+
+###         >tests_dataset
+               The set of data used to execute the tests.
+              [subFolder](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/test_dataset/subFolder "subFolder") 
+                     [3_](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/test_dataset/subFolder/3_ "3_")
+              [1_](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/test_dataset/1_ "1_")
+              [2_](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/test_dataset/2_ "2_")
+
+
+###         >tests
+               Contains the code used to execute the tests
+              [Parcours.js](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/tests/Parcours.js "Parcours.js")
+              [Parse.js](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/tests/Parse.js "Parse.js")
+              [WriteJSON.js](https://sourceforge.net/p/lesfuretscomateux-gl02/code/HEAD/tree/trunk/tests/WriteJSON.js "WriteJSON.js")
+

  


</user>

Developer Guide modified by BARCELO MARTINEZ Raphaël

BARCELO MARTINEZ Raphaël — Fri, 10 Jan 2020 22:23:24 -0000

--- v22
+++ v23
@@ -156,7 +156,7 @@
                                           Runs through each mail contained in "data", and filter them to only retain
                                           the mail written by and sent to the user passed in the argument.

-                                          again, in the reduce() call, runs through each mail (named as the value "elt"),
+                                          Again, in the reduce() call, runs through each mail (named as the value "elt"),
                                           and determines which user is the interlocutor, between the "from" and the "to" field of the mail.

                                           After that, determines if the user is already stored in the accumulator
@@ -203,6 +203,26 @@



+#####                             `.command('occur', 'Gives the list of the 10 words the most used in the "subject" field')`
+
+
+                                          Parses "file.json" and extracts the subjects into a JavaScript variable ("data").
+                                          Runs through each mail contained in "data", and splits them into different values (words).
+
+                                          Again, in the reduce() call, runs through each mail (named as the value "elt"),
+                                          and determines if the word is already stored in the accumulator ("acc") (array[word] = [numberOfOccurence]) that will be returned.
+                                          ("acc") (array[word] = [numberOfOccurence]) that will be returned.
+
+                                          If not, puts the word as a key into the array, and set its value (number of interactions) to 1.
+                                          If it is, increments its value by 1.
+
+                                          Then, reduce "data" down to the values of the accumulator, and sort them by the one with the highest value.
+                                          Finally, cuts down "data" to the 10 first word, and returns it.
+
+                                          **Parameters:**  * `user` — `string` — - The user whose contacts will be sought.
+
+
+
 #####                             `.command('chart', 'Export a Vega-lite chart with top 10 interlocutors')`
 #####                             `.argument('<user>', 'A valid mail address')`

</user>

Developer Guide modified by BARCELO MARTINEZ Raphaël

BARCELO MARTINEZ Raphaël — Fri, 10 Jan 2020 22:16:01 -0000

--- v21
+++ v22
@@ -203,7 +203,19 @@



-
+#####                             `.command('chart', 'Export a Vega-lite chart with top 10 interlocutors')`
+#####                             `.argument('<user>', 'A valid mail address')`
+
+                                          see .command('inter', ...) for top 10 interlocutor
+                                          Uses a vega lite template for a graph, in which is inserted the data from the previous command.
+
+                                          Next compiles it and save its specifications into a javascript variable "MyChart".
+                                          After that, parses it, and renders it into an SVG format.
+                                          After that, trims the whitespaces from the usernames with the trim() function and add them to the Set interlocutors.
+
+                                          Finally, saves it in the repository, and prints the path in the console
+
+                                          **Parameters:**  * `user` — `string` — - The user whose contacts will be sought.

  


</user>

Developer Guide modified by BARCELO MARTINEZ Raphaël

BARCELO MARTINEZ Raphaël — Fri, 10 Jan 2020 22:03:42 -0000

--- v20
+++ v21
@@ -168,7 +168,22 @@
                                           Then, reduce "data" down to the values of the accumulator, and sort them by the one with the highest value.
                                           Finally, cuts down "data" to the 10 first users, and returns it.

-                         * `user` — `string` — - The user whose contacts will be sought.
+                                          **Parameters:**  * `user` — `string` — - The user whose contacts will be sought.
+
+
+#####                             `.command('list', 'Gives the list of all the people present in "from" or in "to"')`
+
+                                          Parses "file.json" and extracts the mails into a JavaScript variable ("data").
+                                           Next, creates a Set of interlocutors to prevent doubles.
+
+                                          Then, for each mail, gets the different users contained in the "To" and "From" fields into an array
+                                          by splitting them into different values at each occurrence of the ", " character with the split() function.
+                                          After that, trims the whitespaces from the usernames with the trim() function and add them to the Set interlocutors.
+
+                                          Finally, returns interlocutors.
+
+
+

 #####                             `.command('inter', 'Gives the top 10 of interlocutors for a given person ')`
 #####                             `.argument('<user>', 'The given person')`
@@ -186,6 +201,9 @@
                                           Then, reduce "data" down to the values of the accumulator, and sort them by the one with the highest value.
                                           Finally, cuts down "data" to the 10 first words, and returns it.

+
+
+

  


</user>

Developer Guide modified by BARCELO MARTINEZ Raphaël

BARCELO MARTINEZ Raphaël — Fri, 10 Jan 2020 21:56:47 -0000

--- v19
+++ v20
@@ -136,7 +136,55 @@
                                               * `dateFin` — `date` — - The most recent date to look up to.

-
+#####                             `.command('buzzy', 'Gives the list of email writen during buzzy days ')`
+
+                                          Parses "file.json" into a JavaScript variable ("data").
+
+                                          Runs through each mail contained in "data", and parse the dates
+                                          contained in the mails into a Moment.js format (in UTC).
+
+                                          Filters the mails to search those whose dates are either on Saturday,
+                                          Sunday, or between 10:00 PM and 8:00 AM.
+
+                                          Then, returns them.
+
+
+#####                             `.command('inter', 'Gives the top 10 of interlocutors for a given person ')`
+#####                             `.argument('<user>', 'The given person')`
+
+                                          Parses "file.json" and extracts the subjects into a JavaScript variable ("data").
+                                          Runs through each mail contained in "data", and filter them to only retain
+                                          the mail written by and sent to the user passed in the argument.
+
+                                          again, in the reduce() call, runs through each mail (named as the value "elt"),
+                                          and determines which user is the interlocutor, between the "from" and the "to" field of the mail.
+
+                                          After that, determines if the user is already stored in the accumulator
+                                          ("acc") (array[user] = [numberOfInteractions]) that will be returned.
+
+                                          If not, puts the user as a key into the array, and set its value (number of interactions) to 1.
+                                          If it is, increments its value by 1.
+
+                                          Then, reduce "data" down to the values of the accumulator, and sort them by the one with the highest value.
+                                          Finally, cuts down "data" to the 10 first users, and returns it.
+
+                         * `user` — `string` — - The user whose contacts will be sought.
+
+#####                             `.command('inter', 'Gives the top 10 of interlocutors for a given person ')`
+#####                             `.argument('<user>', 'The given person')`
+
+                                          Parses "file.json" and extracts the subjects into a JavaScript variable ("data").
+                                           Runs through each mail contained in "data", and splits them into different values (words).
+
+                                          again, in the reduce() call, runs through each mail (named as the value "elt"),
+                                          and determines if the word is already stored in the accumulator
+                                          ("acc") (array[word] = [numberOfOccurence]) that will be returned.
+
+                                          If not, puts the word as a key into the array, and set its value (number of occurences) to 1.
+                                          If it is, increments its value by 1.
+
+                                          Then, reduce "data" down to the values of the accumulator, and sort them by the one with the highest value.
+                                          Finally, cuts down "data" to the 10 first words, and returns it.


  

</user></user>