End of quarter Code Clean-Up

[hwray]

Given our "heart-attack" approach to the software dev side of the project, our code base has gotten slightly hacky and diffuse. It'd be great to clean things up a bit before Friday: remove debug System.out.println()s, delete old code that is redundant or no longer being used, add some comments, and maybe move some things around for better encapsulation. Perhaps Jay and I can get on this while working on our Wiki documentation tomorrow.

[JayThomason]

I've removed a fair amount of unnecessary code left over from previous iterations of the app: https://github.com/JayThomason/Tutti/commit/6a1457a9c04010a9d2c10d71df325dc8ab4ba2a0

[JayThomason]

I think we should focus on a few things:

• Removing unnecessary println() calls
• Refactoring methods that are too long for the purpose of clarity
• Renaming variables which are not descriptive
• Commenting classes and methods whose purpose is not immediately obvious

Recall that our goal is two-fold:

1. Improve our code quality so that it is easier for us to write and maintain our codebase moving forward.
2. Make it easier for a new Android dev to jump into our project, understand the design and structure, and contribute.

[hwray]

I totally agree with these priorities and actually really appreciate you recalling focus to our goals. I'll be taking a structured tour through our codebase to tackle some of these issues.

[hwray]

After a first pass through the code, here's what I've done and what I've noted down to do later:

• Song/Album/Artist: Added comments to toJSON() methods.
• ExpandableListView: Added comments. This was totally uncommented before, but it's a pretty crucial part of our UI/UX, especially in terms of song navigation, so it's important that we can all figure out what the methods of this module do at a glance.
• Globals: Removed currentArtist()/currentAlbum() getters and setters. This functionality should be encapsulated in the Jam (and already is: jam.getCurrentSong().getArtist(), etc.).
• Jam: Changed internal playlist variable from songs to songList (to match our usage elsewhere). Removed getSongList() method, as this enables direct editing of the internal songList from elsewhere in the code base, when really all changes should be made through the Jam helper methods (addSong(), setSong(), etc.).
• JoinJamActivity: Removed a bunch of old unnecessary code. We definitely still need some cleanup here, especially in the configureJoinJamButton method.
• JoinJamThread: Punting on this for now, but we need a lot of commenting and cleanup, mostly for the massive loadMusicFromJSON method.
• Main Activity: Things are looking pretty good. Maybe some basic comments about the button set-up methods.
• New Jam Activity: Moved getIPAddress() method to Globals. Still some commenting / clean-up needed here.
• Server: Could use a thorough commenting breakdown.

[JayThomason]

I've done ViewJamActivity pretty extensively as well

[JayThomason]

There is still a fair amount of code that we could refactor, and we will probably need to in the long run, but for now I have cleaned up every source file to some degree so I'm going to close this issue.