Merge pull request #320 – Přidání času do modelu

encukou · web-flow · commit ea791022f1a1 · 2018-02-21T13:29:18.000+01:00
#320
diff --git a/naucse/models.py b/naucse/models.py
@@ -1,6 +1,8 @@
 from collections import OrderedDict
 import copy
+import datetime
 
+import dateutil.tz
 import jinja2
 
 from naucse.modelutils import Model, YamlProperty, DataProperty, DirProperty
@@ -10,6 +12,8 @@
 from naucse.notebook_util import convert_notebook
 from pathlib import Path
 
+_TIMEZONE = 'Europe/Prague'
+
 
 class Lesson(Model):
     """An individual lesson stored on naucse"""
@@ -294,10 +298,11 @@ def merge_dict(base, patch):
 
 class Session(Model):
     """An ordered collection of materials"""
-    def __init__(self, root, path, base_course, info, index):
+    def __init__(self, root, path, base_course, info, index, course=None):
         super().__init__(root, path)
         base_name = info.get('base')
         self.index = index
+        self.course = course
         if base_name is None:
             self.info = info
         else:
@@ -314,6 +319,23 @@ def __str__(self):
     slug = DataProperty(info)
     date = DataProperty(info, default=None)
 
+    def _time(self, key, default_time):
+        if self.date and default_time:
+            return datetime.datetime.combine(self.date, default_time)
+        return None
+
+    @reify
+    def start_time(self):
+        if self.course:
+            return self._time('start', self.course.default_start_time)
+        return None
+
+    @reify
+    def end_time(self):
+        if self.course:
+            return self._time('end', self.course.default_end_time)
+        return None
+
     @reify
     def materials(self):
         materials = [material(self.root, self.path, s)
@@ -352,7 +374,7 @@ def _get_sessions(course, plan):
     result = OrderedDict()
     for index, sess_info in enumerate(plan):
         session = Session(course.root, course.path, course.base_course,
-                          sess_info, index=index)
+                          sess_info, index=index, course=course)
         result[session.slug] = session
 
     sessions = list(result.values())
@@ -424,6 +446,25 @@ def end_date(self):
             return None
         return max(dates)
 
+    def _default_time(self, key):
+        default_time = self.info.get('default_time')
+        if default_time:
+            time_string = default_time[key]
+            hour, minute = time_string.split(':')
+            hour = int(hour)
+            minute = int(minute)
+            tzinfo = dateutil.tz.gettz(_TIMEZONE)
+            return datetime.time(hour, minute, tzinfo=tzinfo)
+        return None
+
+    @reify
+    def default_start_time(self):
+        return self._default_time('start')
+
+    @reify
+    def default_end_time(self):
+        return self._default_time('end')
+
 
 class RunYear(Model):
     """A year of runs"""
diff --git a/naucse/routes.py b/naucse/routes.py
@@ -334,15 +334,19 @@ def course_calendar_ics(course):
         abort(404)
     calendar = ics.Calendar()
     for session in course.sessions.values():
-        combined = datetime.datetime.combine(session.date, datetime.time())
+        if session.start_time:
+            start_time = session.start_time
+            end_time = session.end_time
+        else:
+            abort(404)
         cal_event = ics.Event(
             name = session.title,
-            begin = combined,
+            begin = start_time,
+            end = end_time,
             uid = url_for("session_coverpage",
                            course=course,
                            session=session.slug,
                            _external=True),
         )
-        cal_event.make_all_day()
         calendar.events.append(cal_event)
     return Response(str(calendar), mimetype="text/calendar")
diff --git a/naucse/templates.py b/naucse/templates.py
@@ -170,6 +170,13 @@ def __str__(self):
     }
 
 
+@template_filter()
+def format_time(time):
+    if time.second:
+        return '{d.hour}:{d.minute:02}:{d.second:02}'.format(d=time)
+    return '{d.hour}:{d.minute:02}'.format(d=time)
+
+
 @template_filter()
 def format_date(date, relative_to=None):
     return '{d.day}. {d.month}. {d.year}'.format(d=date)
diff --git a/naucse/templates/course.html b/naucse/templates/course.html
@@ -57,6 +57,13 @@ <h4>
                             <div class="calendar-dates">
                                 {{ (course.start_date, course.end_date) | format_date_range }}
                             </div>
+                            {% if course.default_start_time %}
+                                <div class="default-times">
+                                    {{ course.default_start_time | format_time }}
+                                    –
+                                    {{ course.default_end_time | format_time }}
+                                </div>
+                            {% endif %}
                         </div>
                         <div class="card-footer small text-left">
                             <ul class="list-unstyled" style="margin-bottom:0;">
diff --git a/naucse/templates/course_calendar.html b/naucse/templates/course_calendar.html
@@ -28,10 +28,14 @@ <h1>{{ course.title }}</h1>
     {% if course.subtitle is defined and course.subtitle != None %}
         <h2>{{ course.subtitle }}</h2>
     {% endif%}
-    <div>
-      Přidej si kurz do svého kalendáře:
-      <a href="{{ url_for('course_calendar_ics', course=course) }}">iCal</a>
-    </div>
+    {% if course.default_start_time %}
+        <div>
+            Přidej si kurz do svého kalendáře:
+            <a href="{{ url_for('course_calendar_ics', course=course) }}">iCal</a>
+        </div>
+    {% else %}
+        <!-- iCal link missing because course doesn't have info about start/end times. -->
+    {% endif%}
     {% if course.start_date %}
         {% for year, month in months %}
             <h3 class="calendar-heading">
diff --git a/requirements.txt b/requirements.txt
@@ -10,5 +10,6 @@ jupyter_client
 mistune
 nbconvert
 pygments
+python-dateutil
 traitlets
 werkzeug
diff --git a/runs/2018/pyladies-brno-jaro/info.yml b/runs/2018/pyladies-brno-jaro/info.yml
@@ -1,6 +1,9 @@
 title: Začátečnický kurz PyLadies
 subtitle: Brno - jaro 2018 - pondělí
 time: 18:00–20:00
+default_time:
+  start: '18:00'
+  end: '20:00'
 place: Experis, BC Titanuim, Nové sady 996/25
 description: Naučte se Python vážně od začátku. Žádné předchozí znalosti nejsou potřeba.
 long_description: |
diff --git a/test_naucse/fixtures/test_content/courses/normal-course/info.yml b/test_naucse/fixtures/test_content/courses/normal-course/info.yml
@@ -0,0 +1,5 @@
+title: A plain vanilla course
+
+plan:
+- title: A normal lesson
+  slug: normal-lesson
diff --git a/test_naucse/fixtures/test_content/runs/2000/run-with-times/info.yml b/test_naucse/fixtures/test_content/runs/2000/run-with-times/info.yml
@@ -0,0 +1,9 @@
+title: Test run with scheduled times
+default_time:
+  start: '19:00'
+  end: '21:00'
+
+plan:
+- title: A normal lesson
+  slug: normal-lesson
+  date: 2000-01-01
diff --git a/test_naucse/fixtures/test_content/runs/2000/run-without-times/info.yml b/test_naucse/fixtures/test_content/runs/2000/run-without-times/info.yml
@@ -0,0 +1,6 @@
+title: Test run without scheduled times
+
+plan:
+- title: A normal lesson
+  slug: normal-lesson
+  date: 2000-01-01
diff --git a/test_naucse/test_filters.py b/test_naucse/test_filters.py
@@ -1,4 +1,4 @@
-from datetime import date
+from datetime import date, time, datetime
 
 import pytest
 
@@ -13,8 +13,24 @@
         (date(2017, 8, 1), date(2017, 9, 25), '1. 8. – 25. 9. 2017'),
         (date(2017, 8, 25), date(2017, 9, 25), '25. 8. – 25. 9. 2017'),
         (date(2016, 9, 25), date(2017, 9, 25), '25. 9. 2016 – 25. 9. 2017'),
+        (datetime(2016, 9, 25, 8, 30), datetime(2017, 9, 25, 18, 0),
+         '25. 9. 2016 – 25. 9. 2017'),
     )
 )
 def test_format_date_range(start, end, result):
     assert naucse.templates.format_date_range((start, end)) == result
 
+@pytest.mark.parametrize(
+    ('time', 'result'),
+    (
+        (time(8, 0, 0), '8:00'),
+        (time(18, 0, 0), '18:00'),
+        (time(8, 3, 0), '8:03'),
+        (time(8, 3, 5), '8:03:05'),
+        (time(18, 4, 5), '18:04:05'),
+        (datetime(2018, 1, 14, 18, 4, 5), '18:04:05'),
+    )
+)
+def test_format_time(time, result):
+    assert naucse.templates.format_time(time) == result
+
diff --git a/test_naucse/test_session_times.py b/test_naucse/test_session_times.py
@@ -0,0 +1,50 @@
+import datetime
+from pathlib import Path
+
+import pytest
+import dateutil
+
+from naucse import models
+
+
+TZINFO = dateutil.tz.gettz('Europe/Prague')
+
+@pytest.fixture
+def model():
+    path = Path(__file__).parent / 'fixtures/test_content'
+    return models.Root(path)
+
+
+def test_run_with_times(model):
+    run = model.runs[2000, 'run-with-times']
+    assert run.default_start_time == datetime.time(19, 00, tzinfo=TZINFO)
+    assert run.default_end_time == datetime.time(21, 00, tzinfo=TZINFO)
+
+    lesson = run.sessions['normal-lesson']
+    assert lesson.date == datetime.date(2000, 1, 1)
+    assert lesson.start_time == datetime.datetime(2000, 1, 1, 19, 00,
+                                                  tzinfo=TZINFO)
+    assert lesson.end_time == datetime.datetime(2000, 1, 1, 21, 00,
+                                                tzinfo=TZINFO)
+
+
+def test_run_without_times(model):
+    run = model.runs[2000, 'run-without-times']
+    assert run.default_start_time is None
+    assert run.default_end_time is None
+
+    lesson = run.sessions['normal-lesson']
+    assert lesson.date == datetime.date(2000, 1, 1)
+    assert lesson.start_time is None
+    assert lesson.end_time is None
+
+
+def test_course(model):
+    course = model.courses['normal-course']
+    assert course.default_start_time is None
+    assert course.default_end_time is None
+
+    lesson = course.sessions['normal-lesson']
+    assert lesson.date is None
+    assert lesson.start_time is None
+    assert lesson.end_time is None
