Standardize return types of functions to objects

- Make all functions return objects, until the very end
- Rename event_ics_from_yaml → event_from_yaml
- Rename events_to_calendar_ics → events_to_calendar
- Add a test of whole-calendar events
  - This required splitting out some of the previous __main__ script
    to a separate function.  I am not entirely sure if I made the
    right choice, but it should be easy to adjust later.

Author: rkdarst

tests/test_calendar.py

@@ -1,7 +1,30 @@
-from yaml2ics import events_to_calendar_ics
+import io
+import textwrap
+
+from util import parse_yaml
+
+from yaml2ics import events_to_calendar, files_to_calendar
 
 
 def test_calendar_structure():
-    cal = events_to_calendar_ics([])
-    assert cal.startswith('BEGIN:VCALENDAR')
-    assert cal.endswith('END:VCALENDAR')
+    cal = events_to_calendar([])
+    cal_str = cal.serialize()
+    assert cal_str.startswith('BEGIN:VCALENDAR')
+    assert cal_str.endswith('END:VCALENDAR')
+
+def test_calendar_event():
+    cal = files_to_calendar(
+        [io.StringIO(textwrap.dedent(
+            '''
+            events:
+              - summary: Earth Day
+                begin: 2021-04-22
+                url: https://earthday.org
+                location: Earth
+            '''
+        ))]
+    )
+    cal_str = cal.serialize()
+    assert cal_str.startswith('BEGIN:VCALENDAR')
+    assert 'SUMMARY:Earth Day' in cal_str
+    assert cal_str.endswith('END:VCALENDAR')

tests/test_events.py

@@ -1,10 +1,10 @@
 from util import parse_yaml
 
-from yaml2ics import event_ics_from_yaml
+from yaml2ics import event_from_yaml
 
 
 def test_basic_structure():
-    event = event_ics_from_yaml(
+    event = event_from_yaml(
         parse_yaml(
             '''
             summary: Earth Day
@@ -28,7 +28,7 @@ def test_basic_structure():
 
 
 def test_all_day_event():
-    event = event_ics_from_yaml(
+    event = event_from_yaml(
         parse_yaml(
             '''
             summary: Earth Day
@@ -46,7 +46,7 @@ def test_all_day_event():
 
 
 def test_rrule():
-    event = event_ics_from_yaml(
+    event = event_from_yaml(
         parse_yaml(
             '''
             summary: Earth Day
@@ -65,7 +65,7 @@ def test_rrule():
 
 
 def test_event_with_time_range():
-    event = event_ics_from_yaml(
+    event = event_from_yaml(
         parse_yaml(
             '''
             summary: Event of the Century
@@ -82,7 +82,7 @@ def test_event_with_time_range():
 
 
 def test_event_with_duration():
-    event = event_ics_from_yaml(
+    event = event_from_yaml(
         parse_yaml(
             '''
             summary: Event of the Century

yaml2ics.py

@@ -19,7 +19,7 @@
 }
 
 
-def event_ics_from_yaml(event_yaml: dict) -> ics.Event:
+def event_from_yaml(event_yaml: dict) -> ics.Event:
     d = event_yaml
     repeat = d.pop('repeat', None)
 
@@ -74,11 +74,24 @@ def event_ics_from_yaml(event_yaml: dict) -> ics.Event:
     return event
 
 
-def events_to_calendar_ics(events: dict) -> str:
+def events_to_calendar(events: list) -> str:
     cal = ics.Calendar()
     for event in events:
         cal.events.append(event)
-    return cal.serialize()
+    return cal
+
+def files_to_calendar(files: list) -> ics.Calendar:
+    """'main' function: list of files to our result"""
+    all_events = [ ]
+    for f in files:
+        if hasattr(f, 'read'):
+            calendar_yaml = yaml.load(f.read(), Loader=yaml.FullLoader)
+        else:
+            calendar_yaml = yaml.load(open(f, 'r'), Loader=yaml.FullLoader)
+        for event in calendar_yaml['events']:
+            all_events.append(event_from_yaml(event))
+    calendar = events_to_calendar(all_events)
+    return calendar
 
 
 if __name__ == '__main__':
@@ -92,10 +105,6 @@ def events_to_calendar_ics(events: dict) -> str:
             print(f'Error: {f} is not a file')
             sys.exit(-1)
 
-    all_events = []
-    for f in files:
-        calendar_yaml = yaml.load(open(f, 'r'), Loader=yaml.FullLoader)
-        for event in calendar_yaml['events']:
-            all_events.append(event_ics_from_yaml(event))
+    calendar = files_to_calendar(files)
 
-    print(events_to_calendar_ics(all_events))
+    print(calendar.serialize())