Michael Glinski (F'11)

Objectives and Key Results (OKRs) for the Fall 2011 Semester
Objective 1: Familiarize Self with Code-Base
 * Key Result 1: Learn how to use Git to work with the code from Source Forge (began on 9/12/11 [complete])
 * COMTOR's Repository URL
 * Source Forge's Git Documentation
 * SmartGit - Graphical Client for Git
 * Key Result 2: Understand the architecture of the system (began on 9/12/11)
 * Dug through code starting from ComtorDriver.java and used the following useful resources from the wiki:
 * The COMTOR Architecture
 * How Modules Work
 * How to Write a Module
 * Key Result 3: Develop UML diagrams to represent the system's architecture (began on 9/23/11)
 * Overall COMTOR Architecture - [[media:Arch_Sequence_Diagram.png|Sequence Diagram]]
 * 'Basic Info' module - [[media:ActivityDiagram_BasicInfo.png|Activity Diagram]]
 * 'Offensive Words' module - [[media:ActivityDiagram_OffensiveWords.png|Activity Diagram]]
 * 'Percentage Methods' module - [[media:ActivityDiagram_PercentageMethods.png|Activity Diagram]]
 * Key Result 4: Learn how to modify and execute the code (began on 10/30/11)
 * Learned how to execute the stand-alone version of COMTOR via this wiki page, but have yet to try any significant modifications to the code.
 * Key Result 5: Familiarize self with module reporting system to see how statistics are reported (began on 9/17/11)
 * Sample report in its generic form
 * Also, see the later parts of this wiki page
 * Module Design Docs
 * Percentage Methods Design Doc
 * Basic Info Design Doc
 * Offensive Words Design Doc
 * Spell Check Design Doc

Objective 2: Enhance Existing Code-Base
 * Key Result 1: Learn bug system being used for COMTOR (began on 9/24/11)
 * Bug Tracker
 * Key Result 2: Fix already detected bugs
 * Key Result 3: Report new bugs found while going through the code
 * Key Result 4: Successfully write a new module to completely show the ability to develop for COMTOR

Progress Blog
Monday, October 31, 2011
 * Spent time trying to get the stand alone version of COMTOR running on my local machine with help from Executing COMTOR as a stand-alone application, but was unable to get a clean run of the program. I must not be supplying the right parameters for -sourcepath and -trimto because it is not finding any of the packages that it should be finding. Will work on debugging this.

Sunday, October 30th, 2011
 * Looked through the system's code in search of anything that seemed to deal with collecting report info and exporting it to a single file with the user's results. Through following the execution of the system, I was lead to the point in ComtorDriver.java where either a report or debug file is generated. If not in "debug mode", the generateReport method of GenerateReport.java is ran. From what I've gathered, this method's main purpose is to generate a report of the run's results and enter it into the database, not a file to be saved to the user's hard drive. It seems this is more geared towards the web version of COMTOR, which is not what I'm interested in at the moment. If the program is in "debug mode", however, the generateDebugFile method of ComtorDebugger.java is ran. The file created by this method would seem very unreadable to the average user, but contains all of the raw info from the result vector. I'm not sure if this debug file is a proper report or is even what I should be looking at, but it's the closest I can find to a file being written which contains the report info. Something I'd like to do to help myself understand this more is get the stand alone version of the application compiling and running on my machine, locally, which is what I plan to do next.

Friday, October 28th, 2011
 * Uploaded new and updated activity diagrams. Will now take a break from creating diagrams to focus solely on the reporting system, with the intent of being able to modify it to work with the updated web version of COMTOR.

Wednesday, October 26th, 2011
 * Have been working on activity diagrams for the remaining modules. Also taking a look at how the reporting system (and exporting of the report) is done in the system.

Monday, October 10th, 2011
 * Created an activity diagram for the 'Basic Info' module. Turned out to be a rather smooth process, but will have to have a discussion to make sure this is the correct approach before I continue making these for other modules. Assuming activity diagrams are the correct approach, further diagrams will be created for the 'Offensive Words', 'Percentage Methods', 'Comment Average Ratio', and 'Spell Checker' modules.

Sunday, October 9th, 2011
 * After finalizing the sequence diagram describing COMTOR's architecture, I spent time over the weekend researching possible diagrams to use to describe the actions occurring within a module while it runs. The strongest candidate so far is an activity diagram, so I will try to draft one tomorrow and see if it ends up being the most appropriate for the situation.

Monday, September 26th, 2011
 * Further developed the sequence diagram which was in progress and translated it into Microsoft Visio.

Friday, September 23rd, 2011
 * Looked at the architecture on a lower level within the code. Refreshed myself on sequence diagrams and started drafting one by hand to be ready by the end of the weekend, then to be re-created digitally.

Monday, September 19th, 2011
 * Worked more with Git to achieve a high enough level of understanding to efficiently work with the project's code. After looking at already-created pages on the wiki referring to COMTOR's architecture, began to trace my way through the process COMTOR goes through to run a module, starting from Comtor.java (of the debug version of COMTOR) in the 'comtor' package, and trying to connect it to and back from analysis modules. Wiki pages made by Dr. DePasquale and comments within the code were my main sources of knowledge for this task. Next, will attempt to use software such as Microsoft Visio or ArgoUML to create a sequence diagram if one can be visualized.

Monday, September 12th, 2011
 * Familiarized myself with Git and checked out the latest version of COMTOR's code. Began investigating basic architecture of the project.

Wednesday, September 7th, 2011
 * Discussed OKRs for the semester with Dr. DePasquale. Also registered a user-name on Source Forge and was granted developer access to the COMTOR project.