cicd: Update toolchain

Fixes #104

.github/workflows/ci.yml

@@ -4,6 +4,9 @@ on:
     branches: ["main"]
   pull_request:
     branches: ["main"]
+permissions:
+  contents: read
+  pull-requests: write
 
 env:
   CARGO_TERM_COLOR: always

.github/workflows/cicd.yml

@@ -0,0 +1,57 @@
+name: "CICD"
+on: [push, pull_request]
+permissions:
+  contents: read
+  pull-requests: write
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  check:
+    name: Check
+    runs-on: ubuntu-latest
+    steps:
+      - run: rustup update
+      - name: Checkout sources
+        uses: actions/checkout@v4
+      - run: cargo check
+
+  test:
+    name: Test Suite
+    runs-on: ubuntu-latest
+    steps:
+      - run: rustup update
+      - name: Checkout sources
+        uses: actions/checkout@v4
+      - run: cargo test --all-features --verbose --workspace
+
+  coverage:
+    name: Test Coverage
+    runs-on: ubuntu-latest
+    steps:
+      - run: rustup update
+      - name: Install tarpaulin
+        run: cargo install cargo-tarpaulin
+
+      - name: Checkout sources
+        uses: actions/checkout@v4
+
+      - name: Run tarpaulin
+        run: cargo tarpaulin --workspace --all-features --exclude xml_derive --coveralls ${{ secrets.COVERALLS_REPO_TOKEN }}
+
+  lints:
+    name: Lints
+    runs-on: ubuntu-latest
+    steps:
+      - run: rustup update
+      - run: rustup component add rustfmt clippy
+
+      - name: Checkout sources
+        uses: actions/checkout@v4
+
+      - name: Run cargo fmt
+        run: cargo fmt --all -- --check
+
+      - name: Run cargo clippy
+        run: cargo clippy -- -D warnings

Cargo.lock

@@ -5085,6 +5085,7 @@ version = "0.1.0"
 dependencies = [
  "darling 0.21.3",
  "heck",
+ "itertools 0.14.0",
  "proc-macro2",
  "quote",
  "syn 2.0.106",

Dockerfile

@@ -1,4 +1,4 @@
-FROM --platform=$BUILDPLATFORM rust:1.89-alpine AS chef
+FROM --platform=$BUILDPLATFORM rust:1.90-alpine AS chef
 
 ARG TARGETPLATFORM
 ARG BUILDPLATFORM

Justfile

@@ -12,3 +12,6 @@ docs:
 
 docs-dev:
   mkdocs serve
+
+coverage:
+  cargo tarpaulin --workspace --exclude xml_derive

crates/caldav/src/calendar/methods/get.rs

@@ -8,7 +8,7 @@ use http::{HeaderValue, Method, StatusCode, header};
 use ical::generator::{Emitter, IcalCalendarBuilder};
 use ical::property::Property;
 use percent_encoding::{CONTROLS, utf8_percent_encode};
-use rustical_ical::{CalendarObjectComponent, EventObject, JournalObject, TodoObject};
+use rustical_ical::{CalendarObjectComponent, EventObject};
 use rustical_store::{CalendarStore, SubscriptionStore, auth::Principal};
 use std::collections::HashMap;
 use std::str::FromStr;
@@ -83,16 +83,16 @@ pub async fn route_get<C: CalendarStore, S: SubscriptionStore>(
                         ical_calendar_builder.add_event(_override.event.clone());
                 }
             }
-            CalendarObjectComponent::Todo(TodoObject(todo), overrides) => {
+            CalendarObjectComponent::Todo(todo, overrides) => {
                 ical_calendar_builder = ical_calendar_builder.add_todo(todo.clone());
                 for _override in overrides {
-                    ical_calendar_builder = ical_calendar_builder.add_todo(_override.0.clone());
+                    ical_calendar_builder = ical_calendar_builder.add_todo(_override.clone());
                 }
             }
-            CalendarObjectComponent::Journal(JournalObject(journal), overrides) => {
+            CalendarObjectComponent::Journal(journal, overrides) => {
                 ical_calendar_builder = ical_calendar_builder.add_journal(journal.clone());
                 for _override in overrides {
-                    ical_calendar_builder = ical_calendar_builder.add_journal(_override.0.clone());
+                    ical_calendar_builder = ical_calendar_builder.add_journal(_override.clone());
                 }
             }
         }

crates/caldav/src/calendar/methods/report/calendar_query/elements.rs

@@ -1,7 +1,7 @@
-use crate::{Error, calendar_object::CalendarObjectPropWrapperName};
+use crate::calendar_object::CalendarObjectPropWrapperName;
 use rustical_dav::xml::PropfindType;
 use rustical_ical::{CalendarObject, UtcDateTime};
-use rustical_store::{CalendarStore, calendar_store::CalendarQuery};
+use rustical_store::calendar_store::CalendarQuery;
 use rustical_xml::XmlDeserialize;
 use std::ops::Deref;
 
@@ -17,24 +17,24 @@ pub(crate) struct TimeRangeElement {
 #[derive(XmlDeserialize, Clone, Debug, PartialEq)]
 #[allow(dead_code)]
 // https://www.rfc-editor.org/rfc/rfc4791#section-9.7.3
-struct ParamFilterElement {
+pub struct ParamFilterElement {
     #[xml(ns = "rustical_dav::namespace::NS_CALDAV")]
-    is_not_defined: Option<()>,
+    pub(crate) is_not_defined: Option<()>,
     #[xml(ns = "rustical_dav::namespace::NS_CALDAV")]
-    text_match: Option<TextMatchElement>,
+    pub(crate) text_match: Option<TextMatchElement>,
 
     #[xml(ty = "attr")]
-    name: String,
+    pub(crate) name: String,
 }
 
 #[derive(XmlDeserialize, Clone, Debug, PartialEq)]
 #[allow(dead_code)]
-struct TextMatchElement {
+pub struct TextMatchElement {
     #[xml(ty = "attr")]
-    collation: String,
+    pub(crate) collation: String,
     #[xml(ty = "attr")]
     // "yes" or "no", default: "no"
-    negate_condition: Option<String>,
+    pub(crate) negate_condition: Option<String>,
 }
 
 #[derive(XmlDeserialize, Clone, Debug, PartialEq)]
@@ -42,16 +42,16 @@ struct TextMatchElement {
 // https://www.rfc-editor.org/rfc/rfc4791#section-9.7.2
 pub(crate) struct PropFilterElement {
     #[xml(ns = "rustical_dav::namespace::NS_CALDAV")]
-    is_not_defined: Option<()>,
+    pub(crate) is_not_defined: Option<()>,
     #[xml(ns = "rustical_dav::namespace::NS_CALDAV")]
-    time_range: Option<TimeRangeElement>,
+    pub(crate) time_range: Option<TimeRangeElement>,
     #[xml(ns = "rustical_dav::namespace::NS_CALDAV")]
-    text_match: Option<TextMatchElement>,
+    pub(crate) text_match: Option<TextMatchElement>,
     #[xml(ns = "rustical_dav::namespace::NS_CALDAV", flatten)]
-    param_filter: Vec<ParamFilterElement>,
+    pub(crate) param_filter: Vec<ParamFilterElement>,
 
     #[xml(ty = "attr")]
-    name: String,
+    pub(crate) name: String,
 }
 
 #[derive(XmlDeserialize, Clone, Debug, PartialEq)]
@@ -192,117 +192,3 @@ impl From<&CalendarQueryRequest> for CalendarQuery {
             .unwrap_or_default()
     }
 }
-
-pub async fn get_objects_calendar_query<C: CalendarStore>(
-    cal_query: &CalendarQueryRequest,
-    principal: &str,
-    cal_id: &str,
-    store: &C,
-) -> Result<Vec<CalendarObject>, Error> {
-    let mut objects = store
-        .calendar_query(principal, cal_id, cal_query.into())
-        .await?;
-    if let Some(filter) = &cal_query.filter {
-        objects.retain(|object| filter.matches(object));
-    }
-    Ok(objects)
-}
-
-#[cfg(test)]
-mod tests {
-    use rustical_dav::xml::PropElement;
-    use rustical_xml::XmlDocument;
-
-    use crate::{
-        calendar::methods::report::{
-            ReportRequest,
-            calendar_query::{
-                CalendarQueryRequest, CompFilterElement, FilterElement, ParamFilterElement,
-                PropFilterElement, TextMatchElement,
-            },
-        },
-        calendar_object::{CalendarObjectPropName, CalendarObjectPropWrapperName},
-    };
-
-    #[test]
-    fn calendar_query_7_8_7() {
-        const INPUT: &str = r#"
-            <?xml version="1.0" encoding="utf-8" ?>
-            <C:calendar-query xmlns:C="urn:ietf:params:xml:ns:caldav">
-                <D:prop xmlns:D="DAV:">
-                    <D:getetag/>
-                    <C:calendar-data/>
-                </D:prop>
-                <C:filter>
-                <C:comp-filter name="VCALENDAR">
-                    <C:comp-filter name="VEVENT">
-                        <C:prop-filter name="ATTENDEE">
-                            <C:text-match collation="i;ascii-casemap">mailto:lisa@example.com</C:text-match>
-                            <C:param-filter name="PARTSTAT">
-                                <C:text-match collation="i;ascii-casemap">NEEDS-ACTION</C:text-match>
-                            </C:param-filter>
-                        </C:prop-filter>
-                    </C:comp-filter>
-                </C:comp-filter>
-                </C:filter>
-            </C:calendar-query>
-        "#;
-
-        let report = ReportRequest::parse_str(INPUT).unwrap();
-        let calendar_query: CalendarQueryRequest =
-            if let ReportRequest::CalendarQuery(query) = report {
-                query
-            } else {
-                panic!()
-            };
-        assert_eq!(
-            calendar_query,
-            CalendarQueryRequest {
-                prop: rustical_dav::xml::PropfindType::Prop(PropElement(
-                    vec![
-                        CalendarObjectPropWrapperName::CalendarObject(
-                            CalendarObjectPropName::Getetag,
-                        ),
-                        CalendarObjectPropWrapperName::CalendarObject(
-                            CalendarObjectPropName::CalendarData(Default::default())
-                        ),
-                    ],
-                    vec![]
-                )),
-                filter: Some(FilterElement {
-                    comp_filter: CompFilterElement {
-                        is_not_defined: None,
-                        time_range: None,
-                        prop_filter: vec![],
-                        comp_filter: vec![CompFilterElement {
-                            prop_filter: vec![PropFilterElement {
-                                name: "ATTENDEE".to_owned(),
-                                text_match: Some(TextMatchElement {
-                                    collation: "i;ascii-casemap".to_owned(),
-                                    negate_condition: None
-                                }),
-                                is_not_defined: None,
-                                param_filter: vec![ParamFilterElement {
-                                    is_not_defined: None,
-                                    name: "PARTSTAT".to_owned(),
-                                    text_match: Some(TextMatchElement {
-                                        collation: "i;ascii-casemap".to_owned(),
-                                        negate_condition: None
-                                    }),
-                                }],
-                                time_range: None
-                            }],
-                            comp_filter: vec![],
-                            is_not_defined: None,
-                            name: "VEVENT".to_owned(),
-                            time_range: None
-                        }],
-                        name: "VCALENDAR".to_owned()
-                    }
-                }),
-                timezone: None,
-                timezone_id: None
-            }
-        )
-    }
-}

crates/caldav/src/calendar/methods/report/calendar_query/mod.rs

@@ -0,0 +1,120 @@
+use crate::Error;
+use rustical_ical::CalendarObject;
+use rustical_store::CalendarStore;
+
+mod elements;
+pub(crate) use elements::*;
+
+pub async fn get_objects_calendar_query<C: CalendarStore>(
+    cal_query: &CalendarQueryRequest,
+    principal: &str,
+    cal_id: &str,
+    store: &C,
+) -> Result<Vec<CalendarObject>, Error> {
+    let mut objects = store
+        .calendar_query(principal, cal_id, cal_query.into())
+        .await?;
+    if let Some(filter) = &cal_query.filter {
+        objects.retain(|object| filter.matches(object));
+    }
+    Ok(objects)
+}
+
+#[cfg(test)]
+mod tests {
+    use rustical_dav::xml::PropElement;
+    use rustical_xml::XmlDocument;
+
+    use crate::{
+        calendar::methods::report::{
+            ReportRequest,
+            calendar_query::{
+                CalendarQueryRequest, CompFilterElement, FilterElement, ParamFilterElement,
+                PropFilterElement, TextMatchElement,
+            },
+        },
+        calendar_object::{CalendarObjectPropName, CalendarObjectPropWrapperName},
+    };
+
+    #[test]
+    fn calendar_query_7_8_7() {
+        const INPUT: &str = r#"
+            <?xml version="1.0" encoding="utf-8" ?>
+            <C:calendar-query xmlns:C="urn:ietf:params:xml:ns:caldav">
+                <D:prop xmlns:D="DAV:">
+                    <D:getetag/>
+                    <C:calendar-data/>
+                </D:prop>
+                <C:filter>
+                <C:comp-filter name="VCALENDAR">
+                    <C:comp-filter name="VEVENT">
+                        <C:prop-filter name="ATTENDEE">
+                            <C:text-match collation="i;ascii-casemap">mailto:lisa@example.com</C:text-match>
+                            <C:param-filter name="PARTSTAT">
+                                <C:text-match collation="i;ascii-casemap">NEEDS-ACTION</C:text-match>
+                            </C:param-filter>
+                        </C:prop-filter>
+                    </C:comp-filter>
+                </C:comp-filter>
+                </C:filter>
+            </C:calendar-query>
+        "#;
+
+        let report = ReportRequest::parse_str(INPUT).unwrap();
+        let calendar_query: CalendarQueryRequest =
+            if let ReportRequest::CalendarQuery(query) = report {
+                query
+            } else {
+                panic!()
+            };
+        assert_eq!(
+            calendar_query,
+            CalendarQueryRequest {
+                prop: rustical_dav::xml::PropfindType::Prop(PropElement(
+                    vec![
+                        CalendarObjectPropWrapperName::CalendarObject(
+                            CalendarObjectPropName::Getetag,
+                        ),
+                        CalendarObjectPropWrapperName::CalendarObject(
+                            CalendarObjectPropName::CalendarData(Default::default())
+                        ),
+                    ],
+                    vec![]
+                )),
+                filter: Some(FilterElement {
+                    comp_filter: CompFilterElement {
+                        is_not_defined: None,
+                        time_range: None,
+                        prop_filter: vec![],
+                        comp_filter: vec![CompFilterElement {
+                            prop_filter: vec![PropFilterElement {
+                                name: "ATTENDEE".to_owned(),
+                                text_match: Some(TextMatchElement {
+                                    collation: "i;ascii-casemap".to_owned(),
+                                    negate_condition: None
+                                }),
+                                is_not_defined: None,
+                                param_filter: vec![ParamFilterElement {
+                                    is_not_defined: None,
+                                    name: "PARTSTAT".to_owned(),
+                                    text_match: Some(TextMatchElement {
+                                        collation: "i;ascii-casemap".to_owned(),
+                                        negate_condition: None
+                                    }),
+                                }],
+                                time_range: None
+                            }],
+                            comp_filter: vec![],
+                            is_not_defined: None,
+                            name: "VEVENT".to_owned(),
+                            time_range: None
+                        }],
+                        name: "VCALENDAR".to_owned()
+                    }
+                }),
+                timezone: None,
+                timezone_id: None
+            }
+        )
+    }
+}

crates/caldav/src/calendar/test_files/propfind.outputs

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<response xmlns:CS="http://calendarserver.org/ns/" xmlns:CARD="urn:ietf:params:xml:ns:carddav" xmlns:CAL="urn:ietf:params:xml:ns:caldav" xmlns="DAV:" xmlns:PUSH="https://bitfire.at/webdav-push">
+<response xmlns="DAV:" xmlns:CAL="urn:ietf:params:xml:ns:caldav" xmlns:CARD="urn:ietf:params:xml:ns:carddav" xmlns:CS="http://calendarserver.org/ns/" xmlns:PUSH="https://bitfire.at/webdav-push">
     <href>/caldav/principal/user/calendar/</href>
     <propstat>
         <prop>
@@ -33,7 +33,7 @@
 
 
 <?xml version="1.0" encoding="utf-8"?>
-<response xmlns:CS="http://calendarserver.org/ns/" xmlns:CARD="urn:ietf:params:xml:ns:carddav" xmlns:CAL="urn:ietf:params:xml:ns:caldav" xmlns="DAV:" xmlns:PUSH="https://bitfire.at/webdav-push">
+<response xmlns="DAV:" xmlns:CAL="urn:ietf:params:xml:ns:caldav" xmlns:CARD="urn:ietf:params:xml:ns:carddav" xmlns:CS="http://calendarserver.org/ns/" xmlns:PUSH="https://bitfire.at/webdav-push">
     <href>/caldav/principal/user/calendar/</href>
     <propstat>
         <prop>

crates/caldav/src/calendar/tests.rs

@@ -4,7 +4,7 @@ use rustical_store::auth::Principal;
 use rustical_xml::XmlSerializeRoot;
 use serde_json::from_str;
 
-// #[tokio::test]
+#[tokio::test]
 async fn test_propfind() {
     let requests: Vec<_> = include_str!("./test_files/propfind.requests")
         .trim()

crates/ical/src/icalendar/journal.rs

@@ -1,11 +0,0 @@
-use derive_more::From;
-use ical::parser::ical::component::IcalJournal;
-
-#[derive(Debug, Clone, From)]
-pub struct JournalObject(pub IcalJournal);
-
-impl JournalObject {
-    pub fn get_uid(&self) -> &str {
-        self.0.get_uid()
-    }
-}

crates/ical/src/icalendar/mod.rs

@@ -1,9 +1,5 @@
 mod event;
-mod journal;
 mod object;
-mod todo;
 
 pub use event::*;
-pub use journal::*;
 pub use object::*;
-pub use todo::*;

crates/ical/src/icalendar/object.rs

@@ -1,11 +1,13 @@
-use super::{EventObject, JournalObject, TodoObject};
+use super::EventObject;
 use crate::CalDateTime;
 use crate::Error;
 use chrono::DateTime;
 use chrono::Utc;
 use derive_more::Display;
 use ical::generator::{Emitter, IcalCalendar};
+use ical::parser::ical::component::IcalJournal;
 use ical::parser::ical::component::IcalTimeZone;
+use ical::parser::ical::component::IcalTodo;
 use ical::property::Property;
 use serde::Deserialize;
 use serde::Serialize;
@@ -57,8 +59,18 @@ impl rustical_xml::ValueDeserialize for CalendarObjectType {
 #[derive(Debug, Clone)]
 pub enum CalendarObjectComponent {
     Event(EventObject, Vec<EventObject>),
-    Todo(TodoObject, Vec<TodoObject>),
-    Journal(JournalObject, Vec<JournalObject>),
+    Todo(IcalTodo, Vec<IcalTodo>),
+    Journal(IcalJournal, Vec<IcalJournal>),
+}
+
+impl From<&CalendarObjectComponent> for CalendarObjectType {
+    fn from(value: &CalendarObjectComponent) -> Self {
+        match value {
+            CalendarObjectComponent::Event(..) => CalendarObjectType::Event,
+            CalendarObjectComponent::Todo(..) => CalendarObjectType::Todo,
+            CalendarObjectComponent::Journal(..) => CalendarObjectType::Journal,
+        }
+    }
 }
 
 impl CalendarObjectComponent {
@@ -82,9 +94,9 @@ impl CalendarObjectComponent {
         }
         Ok(Self::Event(main_event, overrides))
     }
-    fn from_todos(mut todos: Vec<TodoObject>) -> Result<Self, Error> {
+    fn from_todos(mut todos: Vec<IcalTodo>) -> Result<Self, Error> {
         let main_todo = todos
-            .extract_if(.., |todo| todo.0.get_recurrence_id().is_none())
+            .extract_if(.., |todo| todo.get_recurrence_id().is_none())
             .next()
             .expect("there must be one main event");
         let overrides = todos;
@@ -94,7 +106,7 @@ impl CalendarObjectComponent {
                     "Calendar object contains multiple UIDs".to_owned(),
                 ));
             }
-            if todo.0.get_recurrence_id().is_none() {
+            if todo.get_recurrence_id().is_none() {
                 return Err(Error::InvalidData(
                     "Calendar object can only contain one main component".to_owned(),
                 ));
@@ -102,9 +114,9 @@ impl CalendarObjectComponent {
         }
         Ok(Self::Todo(main_todo, overrides))
     }
-    fn from_journals(mut journals: Vec<JournalObject>) -> Result<Self, Error> {
+    fn from_journals(mut journals: Vec<IcalJournal>) -> Result<Self, Error> {
         let main_journal = journals
-            .extract_if(.., |journal| journal.0.get_recurrence_id().is_none())
+            .extract_if(.., |journal| journal.get_recurrence_id().is_none())
             .next()
             .expect("there must be one main event");
         let overrides = journals;
@@ -114,7 +126,7 @@ impl CalendarObjectComponent {
                     "Calendar object contains multiple UIDs".to_owned(),
                 ));
             }
-            if journal.0.get_recurrence_id().is_none() {
+            if journal.get_recurrence_id().is_none() {
                 return Err(Error::InvalidData(
                     "Calendar object can only contain one main component".to_owned(),
                 ));
@@ -179,16 +191,9 @@ impl CalendarObject {
                     .collect(),
             )?
         } else if !cal.todos.is_empty() {
-            CalendarObjectComponent::from_todos(
-                cal.todos.into_iter().map(|todo| todo.into()).collect(),
-            )?
+            CalendarObjectComponent::from_todos(cal.todos)?
         } else if !cal.journals.is_empty() {
-            CalendarObjectComponent::from_journals(
-                cal.journals
-                    .into_iter()
-                    .map(|journal| journal.into())
-                    .collect(),
-            )?
+            CalendarObjectComponent::from_journals(cal.journals)?
         } else {
             return Err(Error::InvalidData(
                 "iCalendar component type not supported :(".to_owned(),
@@ -215,9 +220,9 @@ impl CalendarObject {
         match &self.data {
             // We've made sure before that the first component exists and all components share the
             // same UID
-            CalendarObjectComponent::Todo(todo, _) => todo.0.get_uid(),
+            CalendarObjectComponent::Todo(todo, _) => todo.get_uid(),
             CalendarObjectComponent::Event(event, _) => event.event.get_uid(),
-            CalendarObjectComponent::Journal(journal, _) => journal.0.get_uid(),
+            CalendarObjectComponent::Journal(journal, _) => journal.get_uid(),
         }
     }
 
@@ -237,11 +242,7 @@ impl CalendarObject {
     }
 
     pub fn get_object_type(&self) -> CalendarObjectType {
-        match self.data {
-            CalendarObjectComponent::Todo(_, _) => CalendarObjectType::Todo,
-            CalendarObjectComponent::Event(_, _) => CalendarObjectType::Event,
-            CalendarObjectComponent::Journal(_, _) => CalendarObjectType::Journal,
-        }
+        (&self.data).into()
     }
 
     pub fn get_first_occurence(&self) -> Result<Option<CalDateTime>, Error> {

crates/ical/src/icalendar/todo.rs

@@ -1,11 +0,0 @@
-use derive_more::From;
-use ical::parser::ical::component::IcalTodo;
-
-#[derive(Debug, Clone, From)]
-pub struct TodoObject(pub IcalTodo);
-
-impl TodoObject {
-    pub fn get_uid(&self) -> &str {
-        self.0.get_uid()
-    }
-}

crates/store/src/tests/mod.rs

@@ -0,0 +1 @@
+

crates/xml/derive/Cargo.toml

@@ -13,3 +13,4 @@ quote.workspace = true
 proc-macro2.workspace = true
 heck.workspace = true
 darling.workspace = true
+itertools.workspace = true

crates/xml/derive/src/xml_struct/impl_se.rs

@@ -1,3 +1,4 @@
+use itertools::Itertools;
 use quote::quote;
 
 use crate::{Field, attrs::FieldType};
@@ -69,6 +70,7 @@ impl NamedStruct {
             self.attrs
                 .ns_prefix
                 .iter()
+                .sorted_by_key(|(_ns, prefix)| prefix.value())
                 .map(|(ns, prefix)| {
                     let attr_name = if prefix.value().is_empty() {
                         "xmlns".to_owned()