"""Python data analysis example.

We have a tab separated fields file - seven years of monthly statistics off the
First Great Western Coffee Shop forum which is hosted and administered by Well
House Consultants - and we want to come up with annual totals for some of the
columns (column 2, new topics and column 3, new posts). The final tqo columns
are member applications and most online at a time, and are not significant due
to the numbers of applications from people looking to "spam" the forum, or
automata reading the forum.

Rather than write the program in one chunk, I have separated out the internal
detail of how to handle the individual month records into a separate class called
monthRecord, and this way I can keep all the very specific format stuff in an area
of its own in the program, and have my main program be much clearer and easier to
follow, as well as providing good separation between the data format and how I
want to handle the data. The effect of this is to let me re-use the same data
detail code for othere analyses, and also to allow me to reuse the main program
section again even if the data is supplied to me in a different format.

NOTE - you may download the data file from
        http://www.wellho.net/data/fgws.tsv

"""

class monthRecord(object):
        def __init__(self,m,y,topics,posts):
                self.m = m
                self.y = y
                self.topics = topics
                self.posts = posts

        # This method breaks down an incoming record into component parts and
        # then calls the constructor to turn it into an object

        @staticmethod
        def factory(record):
                month,newTopics,newPosts,newMembers,mostOnline = record.strip().split('\t')
                mon,yr = month.split(' ')
                return monthRecord(mon,int(yr),int(newTopics),int(newPosts))

        def getPosts(self):
                return self.posts

        def getTopics(self):
                return self.topics

        def getYear(self):
                return self.y

# Following code to run only if this program is run directly.
# This allows me to pull this file into another program to re-use the code above

if __name__ == "__main__":

        # read in the records from file

        series = []
        for monthLine in open('fgws.tsv'):
                series.append(monthRecord.factory(monthLine))

        # sum the fields in batchs of 12 and come up with a list of lines to print

        report = []
        for yearNo in range(0,len(series),12):
                totalPosts = 0
                totalTopics = 0
                for monthNo in range(12):
                        current = series[monthNo+yearNo]
                        totalPosts += current.getPosts()
                        totalTopics += current.getTopics()
                year = current.getYear()
                report.append("In year {0:4d} there were {1:6d} new posts in {2:6d} new topics".format
                                                        (year,totalPosts,totalTopics))

        # We want to print the list line first, so reverse the report list. This works in situ, so
        # that we cannot add the .reverse() onto the end of the for loop line.

        report.reverse()
        for line in report:
                print(line)

""" Output:
WomanWithCat:y106 grahamellis$ python3 forum.py
In year 2007 there were 7330 new posts in 1320 new topics
In year 2008 there were 25211 new posts in 2747 new topics
In year 2009 there were 25925 new posts in 1892 new topics
In year 2010 there were 24293 new posts in 2111 new topics
In year 2011 there were 21836 new posts in 1807 new topics
In year 2012 there were 18682 new posts in 1657 new topics
In year 2013 there were 22285 new posts in 1533 new topics
In year 2014 there were 22869 new posts in 1705 new topics
In year 2015 there were 20711 new posts in 1421 new topics
In year 2016 there were 17400 new posts in 1138 new topics
WomanWithCat:y106 grahamellis$ python2 forum.py
In year 2007 there were 7330 new posts in 1320 new topics
In year 2008 there were 25211 new posts in 2747 new topics
In year 2009 there were 25925 new posts in 1892 new topics
In year 2010 there were 24293 new posts in 2111 new topics
In year 2011 there were 21836 new posts in 1807 new topics
In year 2012 there were 18682 new posts in 1657 new topics
In year 2013 there were 22285 new posts in 1533 new topics
In year 2014 there were 22869 new posts in 1705 new topics
In year 2015 there were 20711 new posts in 1421 new topics
In year 2016 there were 17400 new posts in 1138 new topics
WomanWithCat:y106 grahamellis$
"""