cone.calendar 1.1.0__py3-none-any.whl

cone/calendar/interfaces.py

@@ -0,0 +1,14 @@
+from zope.interface import Attribute
+from zope.interface import Interface
+
+
+class IEvent(Interface):
+    start = Attribute('Date as datetime.datetime instance')
+    end = Attribute('Date as datetime.datetime instance')
+
+
+class ICron(Interface):
+    effective = Attribute('Date as datetime.datetime instance')
+    expires = Attribute('Date as datetime.datetime instance')
+    rule = Attribute('Crontab rule as string')
+    duration = Attribute('Duration in minutes')

cone/calendar/tests/test_calendar.py

@@ -0,0 +1,340 @@
+from cone.app import testing
+from cone.app.model import BaseNode
+from cone.app.model import Properties
+from cone.calendar import browser
+from cone.calendar.browser import CalendarEvents
+from cone.calendar.browser import CalendarTile
+from cone.calendar.browser.calendar import JSONView
+from cone.tile import render_tile
+from cone.tile.tests import TileTestCase
+from datetime import datetime
+from node.utils import instance_property
+from pyramid.httpexceptions import HTTPForbidden
+import json
+import os
+import sys
+import unittest
+import uuid
+
+
+class CalendarLayer(testing.Security):
+
+    def make_app(self, **kw):
+        super(CalendarLayer, self).make_app(**{
+            'cone.plugins': 'cone.calendar',
+            'cone.calendar.locales': 'de,it'
+        })
+
+
+calendar_layer = CalendarLayer()
+
+
+class CalendarNode(BaseNode):
+
+    @instance_property
+    def properties(self):
+        return Properties()
+
+
+class TestCalendarTile(TileTestCase):
+    layer = calendar_layer
+
+    def test_calendar_rendering(self):
+        model = CalendarNode(name='calendar')
+        request = self.layer.new_request()
+
+        with self.assertRaises(HTTPForbidden):
+            render_tile(model, request, 'calendar')
+
+        with self.layer.authenticated('admin'):
+            rendered = render_tile(model, request, 'calendar')
+        self.checkOutput("""
+        <div id="calendar"
+             data-calendar_target='http://example.com/calendar'
+             data-calendar_options='{"locale": "en"}'
+             data-calendar_sources='[{"events": "calendar_events"}]'
+             data-calendar_actions='[]'></div>
+        """, rendered)
+
+    def test_calendar_target(self):
+        root = BaseNode(name='container')
+        model = CalendarNode(name='cal', parent=root)
+        calendar = CalendarTile()
+        calendar.model = model
+        calendar.request = self.layer.new_request()
+        self.assertEqual(calendar.target, 'http://example.com/container/cal')
+
+    def test_calendar_options(self):
+        calendar = CalendarTile()
+        calendar.model = CalendarNode(name='calendar')
+        calendar.request = self.layer.new_request()
+
+        self.assertEqual(calendar.option_mapping, {
+            'calendar_locale': 'locale',
+            'calendar_header': 'header',
+            'calendar_footer': 'footer',
+            'calendar_first_day': 'firstDay',
+            'calendar_weekends': 'weekends',
+            'calendar_week_numbers': 'weekNumbers',
+            'calendar_week_numbers_within_days': 'weekNumbersWithinDays',
+            'calendar_business_hours': 'businessHours'
+        })
+        self.assertEqual(calendar.default_options, {
+            'calendar_locale': 'en'
+        })
+        self.assertTrue(isinstance(calendar.options, str))
+        self.assertEqual(json.loads(calendar.options), {'locale': 'en'})
+
+        properties = calendar.model.properties
+        properties.calendar_locale = 'de'
+        properties.calendar_header = {
+            'left': 'title',
+            'center': 'today',
+            'right': 'prev,next'
+        }
+        properties.calendar_footer = {
+            'left': 'title',
+            'center': 'today',
+            'right': 'prev,next'
+        }
+        properties.calendar_first_day = 2
+        properties.calendar_weekends = False
+        properties.calendar_week_numbers = True
+        properties.calendar_week_numbers_within_days = True
+        properties.calendar_business_hours = [{
+            'dow': [1, 2, 3, 4, 5],
+            'start': '08:00',
+            'end': '18:00'
+        }]
+        self.assertEqual(json.loads(calendar.options), {
+            'locale': 'de',
+            'header': {
+                'left': 'title',
+                'center': 'today',
+                'right': 'prev,next'
+            },
+            'footer': {
+                'left': 'title',
+                'center': 'today',
+                'right': 'prev,next'
+            },
+            'firstDay': 2,
+            'weekends': False,
+            'weekNumbers': True,
+            'weekNumbersWithinDays': True,
+            'businessHours': [{
+                'dow': [1, 2, 3, 4, 5],
+                'start': '08:00',
+                'end': '18:00'
+            }]
+        })
+
+    def test_calendar_sources(self):
+        calendar = CalendarTile()
+        calendar.model = CalendarNode(name='calendar')
+        calendar.request = self.layer.new_request()
+
+        self.assertEqual(calendar.default_sources, [
+            {'events': 'calendar_events'}
+        ])
+        self.assertTrue(isinstance(calendar.sources, str))
+        self.assertEqual(json.loads(calendar.sources), [{
+            'events': 'calendar_events'
+        }])
+
+        properties = calendar.model.properties
+        properties.calendar_sources = [{
+            'events': 'calendar_events_1'
+        }, {
+            'events': 'calendar_events_2'
+        }]
+        self.assertEqual(json.loads(calendar.sources), [{
+            'events': 'calendar_events_1'
+        }, {
+            'events': 'calendar_events_2'
+        }])
+
+    def test_calendar_actions(self):
+        calendar = CalendarTile()
+        calendar.model = CalendarNode(name='calendar')
+        calendar.request = self.layer.new_request()
+
+        self.assertEqual(calendar.default_actions, [])
+        self.assertTrue(isinstance(calendar.actions, str))
+        self.assertEqual(json.loads(calendar.actions), [])
+
+        calendar.default_actions = [{
+            'title': 'Default Action',
+        }]
+        self.assertEqual(json.loads(calendar.actions), [{
+            'title': 'Default Action',
+        }])
+
+        properties = calendar.model.properties
+        properties.calendar_actions = [{
+            'title': 'Context Action',
+        }]
+        self.assertEqual(json.loads(calendar.actions), [{
+            'title': 'Context Action',
+        }])
+
+
+class TestJSONView(TileTestCase):
+    layer = calendar_layer
+
+    def test_json_view(self):
+        model = CalendarNode(name='calendar')
+        request = self.layer.new_request()
+
+        view = JSONView(model, request)
+        with self.assertRaises(NotImplementedError):
+            view.data()
+
+        res = view()
+        self.assertEqual(sorted(res.keys()), ['error', 'message'])
+        self.assertTrue(res['error'])
+        self.checkOutput("""
+        <pre>Traceback (most recent call last):
+        ...
+        NotImplementedError:
+        Abstract ``JSONView`` does not implement ``data``\n</pre>
+        """, res['message'])
+
+        class MyJSONView(JSONView):
+            def data(self):
+                return 'data'
+
+        view = MyJSONView(model, request)
+        res = view()
+        self.assertEqual(sorted(res.keys()), ['data'])
+        self.assertEqual(res['data'], 'data')
+
+
+class TestCalendarEvents(TileTestCase):
+    layer = calendar_layer
+
+    def test_calendar_events(self):
+        model = CalendarNode(name='calendar')
+        request = self.layer.new_request()
+
+        events = CalendarEvents(model, request)
+
+        request.params['start'] = '1588312800'
+        self.assertEqual(events.range_start, datetime(2020, 5, 1, 6, 0))
+
+        request.params['end'] = '1588320000'
+        self.assertEqual(events.range_end, datetime(2020, 5, 1, 8, 0))
+
+        with self.assertRaises(NotImplementedError):
+            events.events(events.range_start, events.range_end)
+
+        with self.assertRaises(NotImplementedError):
+            events.data()
+
+        res = events()
+        self.assertEqual(sorted(res.keys()), ['error', 'message'])
+        self.assertTrue(res['error'])
+        self.checkOutput("""
+        <pre>Traceback (most recent call last):
+        ...
+        NotImplementedError:
+        Abstract ``CalendarEvents`` does not implement ``events``\n</pre>
+        """, res['message'])
+
+        class MyEvents(CalendarEvents):
+            def events(self, start, end):
+                return [{
+                    'id': uuid.UUID('08148acd-edda-4e37-9d43-662d4b2d5f59'),
+                    'title': 'Title',
+                    'start': datetime(2020, 5, 1, 7, 0),
+                    'end': datetime(2020, 5, 1, 7, 30),
+                }]
+
+        events = MyEvents(model, request)
+        self.assertEqual(events(), {
+            'data': [{
+                'id': '08148acd-edda-4e37-9d43-662d4b2d5f59',
+                'title': 'Title',
+                'start': '2020-05-01T07:00:00',
+                'end': '2020-05-01T07:30:00'
+            }]
+        })
+
+
+def np(path):
+    return path.replace('/', os.path.sep)
+
+
+class TestResources(unittest.TestCase):
+    layer = calendar_layer
+
+    def test_moment_resources(self):
+        resources_ = browser.moment_resources
+        self.assertTrue(resources_.directory.endswith(np('/static/moment')))
+        self.assertEqual(resources_.name, 'cone.calendar-moment')
+        self.assertEqual(resources_.path, 'moment')
+
+        scripts = resources_.scripts
+        self.assertEqual(len(scripts), 1)
+
+        self.assertTrue(scripts[0].directory.endswith(np('/static/moment')))
+        self.assertEqual(scripts[0].path, 'moment')
+        self.assertEqual(scripts[0].file_name, 'moment.min.js')
+        self.assertTrue(os.path.exists(scripts[0].file_path))
+
+        styles = resources_.styles
+        self.assertEqual(len(styles), 0)
+
+    def test_fullcalendar_resources(self):
+        resources_ = browser.fullcalendar_resources
+        self.assertTrue(resources_.directory.endswith(np('/static/fullcalendar')))
+        self.assertEqual(resources_.name, 'cone.calendar-fullcalendar')
+        self.assertEqual(resources_.path, 'fullcalendar')
+
+        scripts = resources_.scripts
+        self.assertEqual(len(scripts), 3)
+
+        self.assertTrue(scripts[0].directory.endswith(np('/static/fullcalendar')))
+        self.assertEqual(scripts[0].path, 'fullcalendar')
+        self.assertEqual(scripts[0].file_name, 'fullcalendar.min.js')
+        self.assertTrue(os.path.exists(scripts[0].file_path))
+
+        self.assertTrue(scripts[1].directory.endswith(np('/static/fullcalendar/locale')))
+        self.assertEqual(scripts[1].path, 'fullcalendar/locale')
+        self.assertEqual(scripts[1].file_name, 'de.js')
+        self.assertTrue(os.path.exists(scripts[1].file_path))
+
+        self.assertTrue(scripts[2].directory.endswith(np('/static/fullcalendar/locale')))
+        self.assertEqual(scripts[2].path, 'fullcalendar/locale')
+        self.assertEqual(scripts[2].file_name, 'it.js')
+        self.assertTrue(os.path.exists(scripts[2].file_path))
+
+        styles = resources_.styles
+        self.assertEqual(len(styles), 1)
+
+        self.assertTrue(styles[0].directory.endswith(np('/static/fullcalendar')))
+        self.assertEqual(styles[0].path, 'fullcalendar')
+        self.assertEqual(styles[0].file_name, 'fullcalendar.min.css')
+        self.assertTrue(os.path.exists(styles[0].file_path))
+
+    def test_cone_calendar_resources(self):
+        resources_ = browser.cone_calendar_resources
+        self.assertTrue(resources_.directory.endswith(np('/static/calendar')))
+        self.assertEqual(resources_.name, 'cone.calendar-calendar')
+        self.assertEqual(resources_.path, 'calendar')
+
+        scripts = resources_.scripts
+        self.assertEqual(len(scripts), 1)
+
+        self.assertTrue(scripts[0].directory.endswith(np('/static/calendar')))
+        self.assertEqual(scripts[0].path, 'calendar')
+        self.assertEqual(scripts[0].file_name, 'cone.calendar.min.js')
+        self.assertTrue(os.path.exists(scripts[0].file_path))
+
+        styles = resources_.styles
+        self.assertEqual(len(styles), 1)
+
+        self.assertTrue(styles[0].directory.endswith(np('/static/calendar')))
+        self.assertEqual(styles[0].path, 'calendar')
+        self.assertEqual(styles[0].file_name, 'cone.calendar.css')
+        self.assertTrue(os.path.exists(styles[0].file_path))

cone_calendar-1.1.0.dist-info/METADATA

@@ -0,0 +1,252 @@
+Metadata-Version: 2.4
+Name: cone.calendar
+Version: 1.1.0
+Summary: jQuery Fullcalendar integration for cone.app
+Project-URL: Homepage, http://github.com/conestack/cone.calendar
+Author-email: Cone Contributors <dev@conestack.org>
+License: Simplified BSD
+License-File: LICENSE.rst
+Keywords: cone,node,pyramid,web
+Classifier: Environment :: Web Environment
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Requires-Python: >=3.10
+Requires-Dist: cone-app<2.0.0,>1.0.99
+Requires-Dist: yafowil-widget-cron>1.99
+Provides-Extra: test
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: zope-pytestlayer; extra == 'test'
+Description-Content-Type: text/x-rst
+
+.. image:: https://img.shields.io/pypi/v/cone.calendar.svg
+    :target: https://pypi.python.org/pypi/cone.calendar
+    :alt: Latest PyPI version
+
+.. image:: https://img.shields.io/pypi/dm/cone.calendar.svg
+    :target: https://pypi.python.org/pypi/cone.calendar
+    :alt: Number of PyPI downloads
+
+.. image:: https://github.com/conestack/cone.calendar/actions/workflows/test.yml/badge.svg
+    :target: https://github.com/conestack/cone.calendar/actions/workflows/test.yml
+    :alt: Test cone.calendar
+
+
+This package provides a calendar integration in to cone.app.
+It utilizes jQuery Fullcalendar
+(https://github.com/fullcalendar/fullcalendar).
+
+Currently, tag 3.1.0 is included. See
+(https://github.com/fullcalendar/fullcalendar/releases).
+
+
+Calendar Widget
+---------------
+
+The calendar widget integration is done via
+``cone.calendar.browser.CalendarTile`` which is registered by name ``calendar``.
+
+The overall calendar configuration is done via model properties.
+
+.. code-block:: python
+
+    from cone.app.model import BaseNode
+    from cone.app.model import Properties
+
+    class MyCalendar(BaseNode):
+
+        @property
+        def properties(self):
+            props = Properties()
+            props.default_content_tile = 'calendar'
+            props.calendar_header = {
+                'left': 'month,agendaWeek,agendaDay',
+                'center': 'title',
+                'right': 'today prev,next'
+            }
+            return props
+
+For a full list of available calendar options read
+``cone.calendar.browser.CalendarTile`` documentation.
+
+
+Calendar Events
+---------------
+
+In order to display events in the calendar, one or more event data sources
+must be provided.
+
+Concrete event data implementation must derive from
+``cone.calendar.browser.CalendarEvents`` and provide ``events`` function.
+
+The default event data source is expected as JSON view registered by name
+``calendar_events`` for a dedictaed model context.
+
+.. code-block:: python
+
+    from cone.calendar.browser import CalendarEvents
+    from datetime import datetime
+    from pyramid.view import view_config
+    import uuid
+
+    @view_config(
+        name='calendar_events',
+        context=MyCalendar,
+        accept='application/json',
+        renderer='json',
+        permission='view')
+    class MyEvents(CalendarEvents):
+
+        def events(self, start, end):
+            events = [{
+                'id': uuid.uuid4(),
+                'title': 'Title',
+                'start': datetime(2020, 4, 29, 17, 40),
+                'end': datetime(2020, 4, 29, 18, 0),
+            }]
+            return events
+
+For a full list of available event options read
+``cone.calendar.browser.CalendarEvents`` documentation.
+
+Multiple event data sources are defined via model properties.
+
+.. code-block:: python
+
+    class MyCalendar(BaseNode):
+
+        @property
+        def properties(self):
+            props = Properties()
+            props.calendar_sources = [{
+                'events': 'event_data_1',
+                'color': 'green'
+            }, {
+                'events': 'event_data_2',
+                'color': 'red'
+            }]
+            return props
+
+For a full list of available event source options read
+``cone.calendar.browser.CalendarTile`` documentation.
+
+
+Locales
+-------
+
+The calendar locale can be set via ``calendar_locale`` on model properties.
+
+.. code-block:: python
+
+    class MyCalendar(BaseNode):
+
+        @property
+        def properties(self):
+            props = Properties()
+            props.calendar_locale = 'de'
+            return props
+
+Default calendar locale is ``en``. The desired locales must be delivered to
+the browser in order to work correctly. Locales to deliver are defined in the
+application ini config as comma separated list of locale names.
+
+.. code-block:: ini
+
+    cone.calendar.locales = de,fr
+
+For a complete list of available locales see ``browser/static/fullcalendar/locales``
+folder of this package.
+
+
+Contributors
+============
+
+- Robert Niederreiter
+- Johannes Raggam
+
+
+Changes
+=======
+
+1.1.0 (2026-02-03)
+------------------
+
+- Refactor package layout to use ``pyproject.toml`` and implicit namespace packages.
+  [rnix]
+
+- Setup Makefile.
+  [lenadax]
+
+- Run tests with pytest.
+  [lenadax]
+
+
+1.0a1 (2023-05-15)
+------------------
+
+- Use ``webresource`` for resource registration.
+  [rnix]
+
+
+0.4 (2025-10-25)
+----------------
+
+- Pin upper versions of dependencies.
+  [rnix]
+
+
+0.3 (2022-10-06)
+----------------
+
+- Modernize JavaScript.
+  [rnix]
+
+
+0.2 (2020-07-09)
+----------------
+
+- Add ``show_contextmenu`` to ``CalendarTile``. Defaults to ``False``.
+  [rnix]
+
+- Also check for action length when handling actions dropdown in JS.
+  [rnix]
+
+
+0.1 (2020-05-30)
+----------------
+
+- Initial.
+  [rnix, thet]
+
+
+License
+=======
+
+Copyright (c) 2017-2021, BlueDynamics Alliance, Austria
+Copyright (c) 2021-2025, Cone Contributors
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.