Adds location filters for events

Author: Marc Sommerhalder

HISTORY.rst

@@ -1,6 +1,9 @@
 Changelog
 ---------
 
+- Adds location filters for events.
+  [msom]
+
 0.45.0 (2018-12-07)
 ~~~~~~~~~~~~~~~~~~~
 

onegov/org/forms/settings.py

@@ -3,7 +3,7 @@
 from lxml import etree
 from onegov.form import Form
 from onegov.form import with_options
-from onegov.form.fields import MultiCheckboxField
+from onegov.form.fields import MultiCheckboxField, TagsField
 from onegov.form.validators import Stdnum
 from onegov.gis import CoordinatesField
 from onegov.org import _
@@ -194,6 +194,11 @@ class SettingsForm(Form):
         ],
     )
 
+    event_locations = TagsField(
+        label=_("Values of the location filter"),
+        fieldset=_("Events"),
+    )
+
     default_map_view = CoordinatesField(
         label=_("The default map view. This should show the whole town"),
         render_kw={
@@ -224,6 +229,9 @@ class SettingsForm(Form):
     # common.js for more information (search for footer)
     footer_height = HiddenField()
 
+    def on_request(self):
+        self.request.include('tags-input')
+
     def validate_homepage_structure(self, field):
         if field.data:
             try:

onegov/org/locale/de_CH/LC_MESSAGES/onegov.org.po

@@ -1,8 +1,8 @@
 msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE 1.0\n"
-"POT-Creation-Date: 2018-12-06 14:53+0100\n"
-"PO-Revision-Date: 2018-12-06 14:53+0100\n"
+"POT-Creation-Date: 2018-12-08 11:01+0100\n"
+"PO-Revision-Date: 2018-12-08 11:01+0100\n"
 "Last-Translator: Marc Sommerhalder <[email protected]>\n"
 "Language-Team: German\n"
 "Language: de_CH\n"
@@ -1045,6 +1045,9 @@ msgstr "Startseiten Weiterleitung"
 msgid "Hide these fields for non-logged-in users"
 msgstr "Diese Felder für nicht angemeldete Benutzer ausblenden"
 
+msgid "Values of the location filter"
+msgstr "Werte des Ortfilters"
+
 msgid "The default map view. This should show the whole town"
 msgstr "Die Standard Kartenansicht. Diese sollte die ganze Gemeinde zeigen."
 
@@ -2212,6 +2215,9 @@ msgstr ""
 "die Anfrage zu übermitteln. Wenn Sie Änderungen vornehmen möchten, klicken "
 "Sie auf \"Bearbeiten\" um zum Formular zurückzukehren."
 
+msgid "Tag"
+msgstr "Schlagwort"
+
 msgid "Export these events"
 msgstr "Diese Termine exportieren"
 

onegov/org/locale/fr_CH/LC_MESSAGES/onegov.org.po

@@ -2,8 +2,8 @@
 msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE 1.0\n"
-"POT-Creation-Date: 2018-12-06 14:53+0100\n"
-"PO-Revision-Date: 2018-12-06 14:53+0100\n"
+"POT-Creation-Date: 2018-12-08 11:01+0100\n"
+"PO-Revision-Date: 2018-12-08 11:02+0100\n"
 "Last-Translator: Marc Sommerhalder <[email protected]>\n"
 "Language-Team: French\n"
 "Language: fr_CH\n"
@@ -1047,6 +1047,9 @@ msgstr "Redirection vers la page d'accueil"
 msgid "Hide these fields for non-logged-in users"
 msgstr "Masquer ces champs pour les utilisateurs non connectés"
 
+msgid "Values of the location filter"
+msgstr "Valeurs du filtre de localisation"
+
 msgid "The default map view. This should show the whole town"
 msgstr "La vue par défaut de la carte. Cela devrait montrer la ville entière"
 
@@ -2218,6 +2221,9 @@ msgstr ""
 "processus. S'il y a quelque chose que vous souhaitez modifier, cliquez sur « "
 "Modifier » pour retourner sur le formulaire complété."
 
+msgid "Tag"
+msgstr "Étiquette"
+
 msgid "Export these events"
 msgstr "Exporter ces événements"
 

onegov/org/models/organisation.py

@@ -57,6 +57,7 @@ class Organisation(Base, TimestampMixin):
     locales = meta_property()
     redirect_homepage_to = meta_property()
     hidden_people_fields = meta_property(default=list)
+    event_locations = meta_property(default=list)
     geo_provider = meta_property(default='geo-mapbox')
 
     @contact.setter

onegov/org/path.py

@@ -352,12 +352,26 @@ def get_resource_move(app, key, subject, direction, target):
             session, resource, subject, target, direction)
 
 
-@OrgApp.path(model=OccurrenceCollection, path='/events',
-             converters=dict(start=extended_date_converter,
-                             end=extended_date_converter, tags=[]))
-def get_occurrences(app, page=0, range=None, start=None, end=None, tags=None):
+@OrgApp.path(
+    model=OccurrenceCollection, path='/events',
+    converters=dict(
+        start=extended_date_converter,
+        end=extended_date_converter,
+        tags=[],
+        locations=[]
+    )
+)
+def get_occurrences(
+    app, page=0, range=None, start=None, end=None, tags=None, locations=None
+):
     return OccurrenceCollection(
-        app.session(), page=page, range=range, start=start, end=end, tags=tags
+        app.session(),
+        page=page,
+        range=range,
+        start=start,
+        end=end,
+        tags=tags,
+        locations=locations
     )
 
 

onegov/org/templates/macros.pt

@@ -788,7 +788,7 @@
                     <div class="occurrence-time" tal:define="time layout.format_time_range(occurrence.localized_start, occurrence.localized_end)">
                         ${time[0].upper()}${time[1:]}
                     </div>
-                    <div><span tal:repeat="tag occurrence.tags" class="blank-label" i18n:translate>${tag}</span></div>
+                    <div class="occurrence-tags"><span tal:repeat="tag occurrence.tags" class="blank-label" i18n:translate>${tag}</span></div>
                 </div>
                 <div class="clearfix"></div>
             </div>

onegov/org/templates/occurrences.pt

@@ -20,8 +20,8 @@
 
             <div class="large-4 medium-4 columns">
 
-                <div class="tag-filters borderless-side-panel">
-                    <h2 i18n:translate>Tags</h2>
+                <div class="tag-filters borderless-side-panel" tal:condition="tags">
+                    <h2 i18n:translate>Tag</h2>
                     <div class="occurrences-filter-tags">
                         <tal:b tal:repeat="tag tags">
                             <span class="blank-label ${tag.active and 'active' or ''}">
@@ -31,6 +31,21 @@
                     </div>
                 </div>
 
+                <div class="location-filters borderless-side-panel" tal:condition="locations">
+                    <h2 i18n:translate>Location</h2>
+                    <div class="occurrences-filter-locations">
+                        <div class="filter-panel">
+                            <ul class="tags">
+                                <li tal:repeat="location locations">
+                                    <span class="blank-label ${location.active and 'active' or ''}">
+                                        <tal:b replace="structure location(request)"></tal:b>
+                                    </span>
+                                </li>
+                            </ul>
+                        </div>
+                    </div>
+                </div>
+
                 <div class="date-filters borderless-side-panel">
                     <h2 i18n:translate>Date</h2>
                     <div class="occurrences-filter-ranges">

onegov/org/tests/test_views.py

@@ -2181,57 +2181,70 @@ def test_cleanup_allocations(client):
 
 
 def test_view_occurrences(client):
+    client.login_admin()
+    settings = client.get('/settings')
+    settings.form['event_locations'] = [
+        "Gemeindesaal", "Sportanlage", "Turnhalle"
+    ]
+    settings.form.submit()
+    client.logout()
 
     def events(query=''):
         page = client.get(f'/events/?{query}')
         return [event.text for event in page.pyquery('h3 a')]
 
     def dates(query=''):
         page = client.get(f'/events/?{query}')
-        return [datetime.strptime(div.text, '%d.%m.%Y').date() for div
-                in page.pyquery('.occurrence-date')]
+        return [
+            datetime.strptime(div.text, '%d.%m.%Y').date()
+            for div in page.pyquery('.occurrence-date')
+        ]
 
     def tags(query=''):
         page = client.get(f'/events/?{query}')
-        tags = [tag.text.strip() for tag in page.pyquery('.blank-label')]
-        return list(set([tag for tag in tags if tag]))
+        tags = [s.text.strip() for s in page.pyquery('.occurrence-tags span')]
+        return list(set(tags))
 
     def as_json(query=''):
         return client.get(f'/events/json?{query}').json
 
     assert len(events()) == 10
     assert len(events('page=1')) == 2
     assert dates() == sorted(dates())
-    assert len(as_json()) == 12
-    assert len(as_json('max=3')) == 3
 
+    # Test tags
     query = 'tags=Party'
     assert tags(query) == ["Party"]
     assert events(query) == ["150 Jahre Govikon"]
-    assert len(as_json('cat1=Party')) == 1
-    assert len(as_json('cat1=Party&cat2=Sportanlage')) == 1
 
     query = 'tags=Politics'
     assert tags(query) == ["Politik"]
     assert events(query) == ["Generalversammlung"]
-    assert len(as_json('cat1=Politics')) == 1
-    assert len(as_json('cat2=Saal')) == 1
 
     query = 'tags=Sports'
     assert tags(query) == ["Sport"]
     assert len(events(query)) == 10
     assert set(events(query)) == set(["Gemeinsames Turnen", "Fussballturnier"])
-    assert len(as_json('cat1=Sports')) == 10
-    assert len(as_json('cat2=Turnhalle&cat2=Sportanlage')) == 11
 
     query = 'tags=Politics&tags=Party'
     assert sorted(tags(query)) == ["Party", "Politik"]
     assert len(events(query)) == 2
     assert set(events(query)) == set(["150 Jahre Govikon",
                                       "Generalversammlung"])
-    assert len(as_json('cat1=Politics&cat1=Party')) == 2
-    assert len(as_json('max=1&cat1=Politics&cat1=Party')) == 1
 
+    # Test locations
+    query = 'locations=Sportanlage'
+    assert sorted(events(query)) == ["150 Jahre Govikon", "Fussballturnier"]
+
+    query = 'locations=Gemeindesaal&locations=Turnhalle'
+    assert sorted(set(events(query))) == [
+        "Gemeinsames Turnen", "Generalversammlung"
+    ]
+
+    query = 'locations=halle'
+    assert events(query) == []
+
+    # Test dates
     unique_dates = sorted(set(dates()))
 
     query = 'start={}'.format(unique_dates[1].isoformat())
@@ -2265,6 +2278,20 @@ def as_json(query=''):
     query = 'range=weekend&start={}'.format(unique_dates[-2].isoformat())
     assert len(events(query)) == 1
 
+    # Test JSON
+    assert len(as_json()) == 12
+    assert len(as_json('max=3')) == 3
+    assert len(as_json('cat1=Party')) == 1
+    assert len(as_json('cat1=Party&cat2=Sportanlage')) == 1
+    assert len(as_json('cat1=Politics')) == 1
+    assert len(as_json('cat2=Gemeindesaal')) == 1
+    assert len(as_json('cat2=saal')) == 0
+    assert len(as_json('cat1=Sports')) == 10
+    assert len(as_json('cat2=Turnhalle&cat2=Sportanlage')) == 11
+    assert len(as_json('cat1=Politics&cat1=Party')) == 2
+    assert len(as_json('max=1&cat1=Politics&cat1=Party')) == 1
+
+    # Test iCal
     assert client.get('/events/').click('Diese Termine exportieren').\
         text.startswith('BEGIN:VCALENDAR')
 

onegov/org/views/occurrence.py

@@ -12,8 +12,6 @@
 from onegov.org.layout import OccurrenceLayout, OccurrencesLayout
 from onegov.ticket import TicketCollection
 from sedate import as_datetime, replace_timezone
-from sqlalchemy import or_
-from sqlalchemy.dialects.postgresql import array
 from sqlalchemy.orm import joinedload
 
 
@@ -29,13 +27,21 @@ def view_occurrences(self, request):
     ]
     translated_tags.sort(key=lambda i: i[1])
 
-    tags = (
+    tags = [
         Link(
             text=translation,
             url=request.link(self.for_filter(tag=tag)),
             active=tag in self.tags and 'active' or ''
         ) for tag, translation in translated_tags
-    )
+    ]
+
+    locations = [
+        Link(
+            text=location,
+            url=request.link(self.for_filter(location=location)),
+            active=location in self.locations and 'active' or ''
+        ) for location in request.app.org.event_locations
+    ]
 
     ranges = [
         Link(
@@ -73,6 +79,7 @@ def view_occurrences(self, request):
         'start': self.start.isoformat() if self.start else '',
         'ranges': ranges,
         'tags': tags,
+        'locations': locations,
         'title': _('Events'),
     }
 
@@ -190,20 +197,10 @@ def json_export_occurences(self, request):
     def cors(response):
         response.headers.add('Access-Control-Allow-Origin', '*')
 
-    query = self.query()
-
-    tags = request.params.getall('cat1')
-    if tags:
-        query = query.filter(Occurrence._tags.has_any(array(tags)))
-
-    locations = request.params.getall('cat2')
-    if locations:
-        query = query.filter(
-            or_(*[
-                Occurrence.location.ilike(f'%{location}%')
-                for location in locations
-            ])
-        )
+    query = self.for_filter(
+        tags=request.params.getall('cat1'),
+        locations=request.params.getall('cat2')
+    ).query()
 
     limit = request.params.get('max')
     if limit and limit.isdigit():

setup.py

@@ -40,7 +40,7 @@ def get_long_description():
         'onegov.chat',
         'onegov.core>=0.41.0',
         'onegov.directory>=0.4.1',
-        'onegov.event>=1.0.0',
+        'onegov.event>=1.1.0',
         'onegov.file>=0.2.1',
         'onegov.form>=0.18.0',
         'onegov.foundation>=0.0.7',