New Feature: Its now possible to define your own graphs by subclassing a new Graph() class.

Author: anderspetersson

Diff for: .gitignore

@@ -6,3 +6,4 @@ django-bigrother.egg-info/*
 .idea
 *.sqlite3
 docs/_*
+*.DS_Store

Diff for: bigbrother/core.py

@@ -18,6 +18,16 @@ def get_module_list():
     )
     return getattr(settings, 'BIGBROTHER_MODULES', default_modules)
 
+def get_graph_list():
+    """
+    Returns a list of the default graphs.
+    """
+    default_graphs = (
+        'bigbrother.graphs.LastWeekGraph',
+        'bigbrother.graphs.LastMonthGraph',
+        'bigbrother.graphs.LastYearGraph',
+    )
+    return getattr(settings, 'BIGBROTHER_GRAPHS', default_graphs)
 
 def get_module_classes():
     """
@@ -36,6 +46,22 @@ def get_module_classes():
         clslist.append(cls)
     return clslist
 
+def get_graph_classes():
+    """
+    Returns all the graph classes defined in settings.
+    """
+    clslist = []
+    for m in get_graph_list():
+        modulename, attr = m.rsplit('.', 1)
+        try:
+            module = import_module(modulename)
+        except ImportError:
+            continue
+        cls = getattr(module, attr, None)
+        if not cls:
+            continue
+        clslist.append(cls)
+    return clslist
 
 def get_module_by_slug(slug):
     """
@@ -65,19 +91,15 @@ class BigBrotherModule():
     Base class for all BigBrother modules that implements the basic skeleton required for a module.
     """
 
-    #: The human readable display name for the module
     name = 'Unnamed Module'
-    #: Flag to indicate it should be processed by the update function and store the results in the DB.
     write_to_db = True
-    #: Text to be prefixed onto the display version of the module's value
     prefix_text = None
-    #: Text to be suffixed onto the display version of the module's value
     suffix_text = None
     warning_low = None
     warning_high = None
     link_url = None
-    #: The Django ORM aggregation object to be used for aggregating the data for graph data.
     aggregate_function = None
+    graphs = get_graph_list()
 
     def check_compatible(self):
         """
@@ -115,7 +137,7 @@ def get_text(self):
         Returns the current value as formatted text
         """
         return '%s%g%s' % (self.get_prefix_text(), self.get_val(), self.get_suffix_text())
-        
+
     def get_slug(self):
         """
         Returns the URL friendly slug for the module
@@ -133,7 +155,7 @@ def check_warning(self):
             self.warn(warningtype='low')
             return True
         return False
-    
+
     def warn(self, warningtype):
         send_warning(module=self.__class__, warningtype=warningtype)
 
@@ -159,7 +181,7 @@ def get_val(self):
         users = USER_MODEL.objects.all()
         return users.count()
 
-        
+
 class NewUsersTodayCount(BigBrotherModule):
     """
     Module providing a count of new users from django.contrib.auth

Diff for: bigbrother/graphs.py

@@ -0,0 +1,39 @@
+from bigbrother.core import get_module_by_slug
+from bigbrother.models import ModuleStat
+from django.db.models import Avg
+from datetime import datetime, timedelta
+import qsstats
+
+
+class Graph():
+    stopdate = datetime.utcnow()
+
+    def get_graph_data(self, slug, *args, **kwargs):
+        module = get_module_by_slug(slug)()
+        q = ModuleStat.objects.filter(modulename=slug)
+        qs = qsstats.QuerySetStats(q, 'added', module.get_aggregate_function() or Avg('value'))
+        qss = qsstats.QuerySetStats(q, 'value')
+        data = qs.time_series(self.startdate, self.stopdate, interval=self.interval)
+        return data
+
+
+class LineGraph(Graph):
+    type = 'line'
+
+
+class LastWeekGraph(LineGraph):
+    name = 'Last Week'
+    interval = 'days'
+    startdate = datetime.utcnow() - timedelta(weeks=1)
+
+
+class LastMonthGraph(LineGraph):
+    name = 'Last Month'
+    interval = 'days'
+    startdate = datetime.utcnow() - timedelta(weeks=4)
+
+
+class LastYearGraph(LineGraph):
+    name = 'Last Year'
+    interval = 'weeks'
+    startdate = datetime.utcnow() - timedelta(weeks=52)

Diff for: bigbrother/templates/bigbrother/graph.html

@@ -3,12 +3,10 @@
 {% block content %}
 <div id="graphcontainer">
 	<h1>{{ modulename }}</h1>
-	<h2>Last Week</h2>
-	<div id="week" class="graph">No Data</div>
-	<h2>Last Month</h2>
-	<div id="month" class="graph">No Data</div>
-	<h2>Last Year</h2>
-	<div id="year" class="graph">No Data</div>
+    {% for graph in bb %}
+	<h2>{{ graph.name }}</h2>
+	<div id="{{ graph.name|slugify }}" class="graph">No Data</div>
+    {% endfor %}
 </div>
 {% endblock %}
 
@@ -19,43 +17,18 @@ <h2>Last Year</h2>
     <script src="{{ STATIC_URL }}js/jquery.flot.time.js"></script>
 	<script type="text/javascript">
 	$(function () {
-        {% if week %}
-		var weekdata = [{% for dt, val in week %}[(new Date("{{ dt.isoformat }}")).getTime(), {{ val|stringformat:"f" }}],{% endfor %}]
-        $.plot($("#week"), [weekdata], {
+        {% for graph in bb %}
+		var data = [{% for dt, val in graph.data %}[(new Date("{{ dt.isoformat }}")).getTime(), {{ val|stringformat:"f" }}],{% endfor %}]
+        $.plot($("#{{ graph.name|slugify }}"), [data], {
             points: {show:true},
             lines: {show:true},
             yaxis: {min: 0},
             xaxis: {mode: "time",
-                min: (new Date("{{ firstdow.isoformat }}")).getTime(),
-                max: (new Date("{{ lastdow.isoformat }}")).getTime()
+                min: (new Date("{{ graph.startdate.isoformat }}")).getTime(),
+                max: (new Date("{{ graph.stopdate.isoformat }}")).getTime()
             }
         });
-        {% endif %}
-        {% if month %}
-		var monthdata = [{% for dt, val in month %}[(new Date("{{ dt.isoformat }}")).getTime(), {{ val|stringformat:"f" }}],{% endfor %}]
-        $.plot($("#month"), [monthdata], {
-            points: {show:true},
-            lines: {show:true},
-            yaxis: {min: 0},
-            xaxis: {mode: "time",
-                min: (new Date("{{ firstdom.isoformat }}")).getTime(),
-                max: (new Date("{{ lastdom.isoformat }}")).getTime()
-            }
-        });
-        {% endif %}
-        {% if year %}
-		var yeardata = [{% for dt, val in year %}[(new Date("{{ dt.isoformat }}")).getTime(), {{ val|stringformat:"f" }}],{% endfor %}]
-        $.plot($("#year"), [yeardata], {
-            points: {show:true},
-            lines: {show:true},
-            yaxis: {min: 0},
-            xaxis: {mode: "time",
-                min: (new Date("{{ firstdoy.isoformat }}")).getTime(),
-                max: (new Date("{{ lastdoy.isoformat }}")).getTime()
-            }
-        });
-        {% endif %}
-
+        {% endfor %}
 	});
 	</script>
-{% endblock %}
+{% endblock %}

Diff for: bigbrother/views.py

@@ -4,9 +4,8 @@
 from django.db.models import Avg
 from django.conf import settings
 import qsstats
-
 from bigbrother.models import ModuleStat
-from bigbrother.core import get_module_classes, get_module_by_slug
+from bigbrother.core import get_module_classes, get_graph_classes
 
 
 class BigBrotherView(TemplateView):
@@ -53,39 +52,24 @@ class BigBrotherGraphView(BigBrotherView):
     """
 
     template_name = 'bigbrother/graph.html'
-    week_interval = None
-    month_interval = None
-    year_interval = None
-
-    def get_week_interval(self):
-        return self.week_interval or 'hours'
-
-    def get_month_interval(self):
-        return self.month_interval or 'days'
-
-    def get_year_interval(self):
-        return self.week_interval or 'weeks'
 
     def get_graph_data(self):
-        slug = self.kwargs.get('slug')
-        module = get_module_by_slug(slug)()
-        q = ModuleStat.objects.filter(modulename=slug)
-        qs = qsstats.QuerySetStats(q, 'added', module.get_aggregate_function() or Avg('value'))
-
-        week = qs.time_series(datetime.utcnow() - timedelta(weeks=1), datetime.utcnow(), interval=self.get_week_interval())
-        month = qs.time_series(datetime.utcnow() - timedelta(weeks=4), datetime.utcnow(), interval=self.get_month_interval())
-        year = qs.time_series(datetime.utcnow() - timedelta(weeks=52), datetime.utcnow(), interval=self.get_year_interval())
-
-        return {
-            'week': week, 'month': month, 'year': year,
-            'lastdow': week[-1][0], 'lastdom': month[-1][0], 'lastdoy': year[-1][0],
-            'firstdow': week[0][0], 'firstdom': month[0][0], 'firstdoy': year[0][0],
-            'modulename': module.name,
-        }
+        data = []
+        for cls in get_graph_classes():
+            instance = cls()
+            dataset = instance.get_graph_data(slug=self.kwargs.get('slug'))
+            data.append({'name': instance.name,
+                         'data': dataset,
+                         'startdate': dataset[0][0],
+                         'stopdate': dataset[-1][0]})
+        return data
 
     def get_context_data(self, **kwargs):
         ctx = super(BigBrotherGraphView, self).get_context_data(**kwargs)
-        ctx.update(self.get_graph_data())
+        ctx.update({
+            'bb': self.get_graph_data,
+            'modulename': self.kwargs.get('slug')
+        })
         return ctx