Skip to content

OpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub

Extract all the logic for generating ICal into its own class

Klaus Zanders5500d7f88774
diff --git a/modules/meeting/app/services/meetings/calendar_wrapper.rb b/modules/meeting/app/services/meetings/calendar_wrapper.rb
new file mode 100644
index 00000000000..e5145e8c05e
--- /dev/null
+++ b/modules/meeting/app/services/meetings/calendar_wrapper.rb
@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+#-- copyright
+# OpenProject is an open source project management software.
+# Copyright (C) the OpenProject GmbH
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
+# Copyright (C) 2006-2013 Jean-Philippe Lang
+# Copyright (C) 2010-2013 the ChiliProject Team
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+#
+# See COPYRIGHT and LICENSE files for more details.
+#++
+require "icalendar"
+require "icalendar/tzinfo"
+
+module Meetings
+ class CalendarWrapper
+ attr_reader :timezone, :calendar, :calendar_timezones
+
+ def initialize(timezone:)
+ @timezone = timezone
+ @calendar = build_icalendar
+ @calendar_timezones = Set.new
+ end
+
+ def add_single_meeting_event(meeting:, cancelled: false) # rubocop:disable Metrics/AbcSize
+ calendar.event do |e|
+ e.dtstart = ical_datetime(meeting.start_time)
+ e.dtend = ical_datetime(meeting.end_time)
+ e.url = url_helpers.meeting_url(meeting)
+ e.summary = "[#{meeting.project.name}] #{meeting.title}"
+ e.description = "[#{meeting.project.name}] #{I18n.t(:label_meeting)}: #{meeting.title}"
+ e.uid = meeting.uid
+ e.organizer = ical_organizer
+ e.location = meeting.location.presence
+ e.status = if cancelled
+ "CANCELLED"
+ else
+ "CONFIRMED"
+ end
+
+ add_attendees(event: e, meeting: meeting)
+ end
+ end
+
+ def add_series_event(recurring_meeting:, cancelled: false) # rubocop:disable Metrics/AbcSize
+ calendar.event do |e|
+ e.uid = recurring_meeting.uid
+ e.summary = "[#{recurring_meeting.project.name}] #{recurring_meeting.title}"
+ e.description = "[#{recurring_meeting.project.name}] #{I18n.t(:label_meeting_series)}: #{recurring_meeting.title}"
+ e.organizer = ical_organizer
+
+ e.rrule = recurring_meeting.schedule.rrules.first.to_ical # We currently only have one recurrence rule
+ e.dtstart = ical_datetime(recurring_meeting.template.start_time)
+ e.dtend = ical_datetime(recurring_meeting.template.end_time)
+ e.url = url_helpers.project_recurring_meeting_url(recurring_meeting.project, recurring_meeting)
+ e.location = recurring_meeting.template.location.presence
+ e.status = if cancelled
+ "CANCELLED"
+ else
+ "CONFIRMED"
+ end
+
+ add_attendees(event: e, meeting: recurring_meeting.template)
+
+ # Add exceptions for all cancelled recurrences
+ set_excluded_recurrence_dates(event: e, recurring_meeting: recurring_meeting)
+ end
+
+ # Add single events for all occurrences
+ add_instantiated_occurences(recurring_meeting: recurring_meeting)
+ end
+
+ def update_calendar_status(cancelled:)
+ if cancelled
+ calendar.cancel
+ else
+ calendar.request
+ end
+ end
+
+ def to_ical
+ calendar_timezones.each do |ical_tzinfo|
+ calendar.add_timezone(ical_tzinfo)
+ end
+
+ calendar.to_ical
+ end
+
+ private
+
+ def build_icalendar
+ ::Icalendar::Calendar.new.tap do |calendar|
+ calendar.prodid = "-//OpenProject GmbH//#{OpenProject::VERSION}//Meeting//EN"
+ end
+ end
+
+ def add_timezone_definition(time)
+ calendar_timezones << timezone.tzinfo.ical_timezone(time)
+ end
+
+ def add_attendees(event:, meeting:)
+ meeting.participants.includes(:user).find_each do |participant|
+ user = participant.user
+ next unless user
+
+ address = Icalendar::Values::CalAddress.new(
+ "mailto:#{user.mail}",
+ {
+ "CN" => user.name,
+ "EMAIL" => user.mail,
+ "PARTSTAT" => "NEEDS-ACTION",
+ "RSVP" => "TRUE",
+ "CUTYPE" => "INDIVIDUAL",
+ "ROLE" => "REQ-PARTICIPANT"
+ }
+ )
+
+ event.append_attendee(address)
+ end
+ end
+
+ def tzid
+ @tzid ||= timezone.tzinfo.canonical_identifier
+ end
+
+ def ical_datetime(time)
+ time_in_time_zone = time.in_time_zone(timezone)
+ add_timezone_definition(time_in_time_zone)
+ Icalendar::Values::DateTime.new time_in_time_zone, "tzid" => tzid
+ end
+
+ def ical_organizer
+ Icalendar::Values::CalAddress.new("mailto:#{Setting.mail_from}", cn: Setting.app_title)
+ end
+
+ def url_helpers
+ @url_helpers ||= OpenProject::StaticRouting::StaticUrlHelpers.new
+ end
+
+ # Methods for recurrence meetings
+ def add_instantiated_occurences(recurring_meeting:)
+ upcoming_instantiated_schedules(recurring_meeting).find_each do |scheduled_meeting|
+ add_occurence(scheduled_meeting:)
+ end
+ end
+
+ def add_occurence(scheduled_meeting:) # rubocop:disable Metrics/AbcSize
+ recurring_meeting = scheduled_meeting.recurring_meeting
+ meeting = scheduled_meeting.meeting
+
+ calendar.event do |e|
+ e.uid = recurring_meeting.uid
+ e.summary = "[#{recurring_meeting.project.name}] #{recurring_meeting.title}"
+ e.description = "[#{recurring_meeting.project.name}] #{I18n.t(:label_meeting_series)}: #{recurring_meeting.title}"
+ e.organizer = ical_organizer
+
+ e.recurrence_id = ical_datetime(scheduled_meeting.start_time)
+ e.dtstart = ical_datetime(meeting.start_time)
+ e.dtend = ical_datetime(meeting.end_time)
+ e.url = url_helpers.project_meeting_url(meeting.project, meeting)
+ e.location = meeting.location.presence
+ e.sequence = meeting.lock_version
+
+ add_attendees(event: e, meeting: meeting)
+ e.status = if scheduled_meeting.cancelled?
+ "CANCELLED"
+ else
+ "CONFIRMED"
+ end
+ end
+ end
+
+ def set_excluded_recurrence_dates(event:, recurring_meeting:)
+ event.exdate = recurring_meeting
+ .scheduled_meetings
+ .cancelled
+ .pluck(:start_time)
+ .map { ical_datetime(it) }
+ end
+
+ def upcoming_instantiated_schedules(recurring_meeting)
+ recurring_meeting
+ .scheduled_meetings
+ .not_cancelled
+ .instantiated
+ .includes(meeting: [:project], recurring_meeting: [:project])
+ end
+ end
+end
diff --git a/modules/meeting/app/services/meetings/ical_helpers.rb b/modules/meeting/app/services/meetings/ical_helpers.rb
deleted file mode 100644
index ae0b744efcc..00000000000
--- a/modules/meeting/app/services/meetings/ical_helpers.rb
+++ /dev/null
@@ -1,92 +0,0 @@
-# frozen_string_literal: true
-#-- copyright
-# OpenProject is an open source project management software.
-# Copyright (C) the OpenProject GmbH
-#
-# This program is free software; you can redistribute it and/or
-# modify it under the terms of the GNU General Public License version 3.
-#
-# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
-# Copyright (C) 2006-2013 Jean-Philippe Lang
-# Copyright (C) 2010-2013 the ChiliProject Team
-#
-# This program is free software; you can redistribute it and/or
-# modify it under the terms of the GNU General Public License
-# as published by the Free Software Foundation; either version 2
-# of the License, or (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
-#
-# See COPYRIGHT and LICENSE files for more details.
-#++
-require "icalendar"
-require "icalendar/tzinfo"
-
-module Meetings
- module ICalHelpers
- def ical_event(start_time, cancelled:, &)
- calendar = build_icalendar(start_time)
- calendar.event(&)
-
- if cancelled
- calendar.cancel
- else
- calendar.request
- end
- calendar.to_ical
- end
-
- def set_status(cancelled, event)
- event.status =
- if cancelled
- "CANCELLED"
- else
- "CONFIRMED"
- end
- end
-
- def build_icalendar(start_time)
- ::Icalendar::Calendar.new.tap do |calendar|
- calendar.prodid = "-//OpenProject GmbH//#{OpenProject::VERSION}//Meeting//EN"
- ical_timezone = timezone.tzinfo.ical_timezone start_time
- calendar.add_timezone ical_timezone
- end
- end
-
- def add_attendees(event, meeting)
- meeting.participants.includes(:user).find_each do |participant|
- user = participant.user
- next unless user
-
- address = Icalendar::Values::CalAddress.new(
- "mailto:#{user.mail}",
- {
- "CN" => user.name,
- "EMAIL" => user.mail,
- "PARTSTAT" => "NEEDS-ACTION",
- "RSVP" => "TRUE",
- "CUTYPE" => "INDIVIDUAL",
- "ROLE" => "REQ-PARTICIPANT"
- }
- )
-
- event.append_attendee(address)
- end
- end
-
- def ical_datetime(time, timezone_id)
- Icalendar::Values::DateTime.new time.in_time_zone(timezone_id), "tzid" => timezone_id
- end
-
- def ical_organizer
- Icalendar::Values::CalAddress.new("mailto:#{Setting.mail_from}", cn: Setting.app_title)
- end
- end
-end
diff --git a/modules/meeting/app/services/meetings/ical_service.rb b/modules/meeting/app/services/meetings/ical_service.rb
index 6efee7e71cc..177e86728be 100644
--- a/modules/meeting/app/services/meetings/ical_service.rb
+++ b/modules/meeting/app/services/meetings/ical_service.rb
@@ -1,4 +1,5 @@
# frozen_string_literal: true
+
#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) the OpenProject GmbH
@@ -26,13 +27,10 @@
#
# See COPYRIGHT and LICENSE files for more details.
#++
-require "icalendar"
-require "icalendar/tzinfo"
module Meetings
class ICalService
- include ICalHelpers
- attr_reader :user, :meeting, :timezone, :url_helpers
+ attr_reader :user, :meeting, :url_helpers
def initialize(meeting:, user:)
@user = user
@@ -42,39 +40,15 @@ module Meetings
def call(cancelled: false)
User.execute_as(user) do
- @timezone = Time.zone || Time.zone_default
- ServiceResult.success(result: generate_ical(cancelled:))
+ calendar = Meetings::CalendarWrapper.new(timezone: Time.zone || Time.zone_default)
+ calendar.add_single_meeting_event(meeting:, cancelled:)
+ calendar.update_calendar_status(cancelled:)
+
+ ServiceResult.success(result: calendar.to_ical)
end
rescue StandardError => e
Rails.logger.error("Failed to generate ICS for meeting #{@meeting.id}: #{e.message}")
ServiceResult.failure(message: e.message)
end
-
- private
-
- # rubocop:disable Metrics/AbcSize
- def generate_ical(cancelled:)
- ical_event(meeting.start_time, cancelled:) do |e|
- tzinfo = timezone.tzinfo
- tzid = tzinfo.canonical_identifier
-
- e.dtstart = ical_datetime meeting.start_time, tzid
- e.dtend = ical_datetime meeting.end_time, tzid
- e.url = url_helpers.meeting_url(meeting)
- e.summary = "[#{meeting.project.name}] #{meeting.title}"
- e.description = ical_subject
- e.uid = meeting.uid
- e.organizer = ical_organizer
- e.location = meeting.location.presence
-
- set_status(cancelled, e)
- add_attendees(e, meeting)
- end
- end
- # rubocop:enable Metrics/AbcSize
-
- def ical_subject
- "[#{meeting.project.name}] #{I18n.t(:label_meeting)}: #{meeting.title}"
- end
end
end
diff --git a/modules/meeting/app/services/recurring_meetings/ical_service.rb b/modules/meeting/app/services/recurring_meetings/ical_service.rb
index 53ead1a72a1..ee38ccc642d 100644
--- a/modules/meeting/app/services/recurring_meetings/ical_service.rb
+++ b/modules/meeting/app/services/recurring_meetings/ical_service.rb
@@ -1,4 +1,5 @@
# frozen_string_literal: true
+
#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) the OpenProject GmbH
@@ -26,140 +27,31 @@
#
# See COPYRIGHT and LICENSE files for more details.
#++
-require "icalendar"
-require "icalendar/tzinfo"
module RecurringMeetings
class ICalService
- include ::Meetings::ICalHelpers
attr_reader :user,
- :series,
- :schedule,
- :timezone,
- :calendar,
- :url_helpers
+ :series
delegate :template, to: :series
def initialize(series:, user:)
@user = user
@series = series
- @schedule = series.schedule
- @url_helpers = OpenProject::StaticRouting::StaticUrlHelpers.new
- end
-
- def generate_series(cancelled: false)
- ical_result(series) do
- series_event(cancelled:)
- occurrences_events
- calendar_status(cancelled:)
- end
- rescue StandardError => e
- Rails.logger.error("Failed to generate ICS for meeting series #{series.id}: #{e.message}")
- ServiceResult.failure(message: e.message)
- end
-
- def generate_occurrence(meeting, cancelled: false)
- # Get the time the meeting was scheduled to take place
- scheduled_meeting = meeting.scheduled_meeting
- ical_result(scheduled_meeting) do
- occurrence_event(scheduled_meeting.start_time, meeting, cancelled:)
- calendar_status(cancelled:)
- end
- rescue StandardError => e
- Rails.logger.error("Failed to generate ICS for meeting #{meeting.id}: #{e.message}")
- ServiceResult.failure(message: e.message)
- end
-
- private
-
- def calendar_status(cancelled:)
- if cancelled
- calendar.cancel
- else
- calendar.request
- end
end
- def ical_result(meeting)
+ def generate_series(cancelled: false) # rubocop:disable Metrics/AbcSize
User.execute_as(user) do
- @timezone = Time.zone || Time.zone_default
- @calendar = build_icalendar(meeting.start_time)
+ calendar = Meetings::CalendarWrapper.new(timezone: Time.zone || Time.zone_default)
+ calendar.add_series_event(recurring_meeting: series, cancelled:)
- yield
+ calendar.update_calendar_status(cancelled:)
ServiceResult.success(result: calendar.to_ical)
end
- end
-
- def tzinfo
- timezone.tzinfo
- end
-
- def tzid
- tzinfo.canonical_identifier
- end
-
- def series_event(cancelled:) # rubocop:disable Metrics/AbcSize
- calendar.event do |e|
- base_series_attributes(e)
-
- e.rrule = schedule.rrules.first.to_ical # We currently only have one recurrence rule
- e.dtstart = ical_datetime template.start_time, tzid
- e.dtend = ical_datetime template.end_time, tzid
- e.url = url_helpers.project_recurring_meeting_url(series.project, series)
- e.location = template.location.presence
-
- add_attendees(e, template)
- e.exdate = cancelled_schedules
-
- set_status(cancelled, e)
- end
- end
-
- def occurrences_events
- upcoming_instantiated_schedules.find_each do |schedule|
- occurrence_event(schedule.start_time, schedule.meeting, cancelled: false)
- end
- end
-
- def occurrence_event(schedule_start_time, meeting, cancelled:) # rubocop:disable Metrics/AbcSize
- calendar.event do |e|
- base_series_attributes(e)
-
- e.recurrence_id = ical_datetime schedule_start_time, tzid
- e.dtstart = ical_datetime meeting.start_time, tzid
- e.dtend = ical_datetime meeting.end_time, tzid
- e.url = url_helpers.project_meeting_url(meeting.project, meeting)
- e.location = meeting.location.presence
- e.sequence = meeting.lock_version
-
- add_attendees(e, meeting)
- set_status(cancelled, e)
- end
- end
-
- def upcoming_instantiated_schedules
- series
- .scheduled_meetings
- .not_cancelled
- .instantiated
- .includes(:meeting)
- end
-
- def base_series_attributes(event) # rubocop:disable Metrics/AbcSize
- event.uid = series.uid
- event.summary = "[#{series.project.name}] #{series.title}"
- event.description = "[#{series.project.name}] #{I18n.t(:label_meeting_series)}: #{series.title}"
- event.organizer = ical_organizer
- end
-
- def cancelled_schedules
- series
- .scheduled_meetings
- .cancelled
- .pluck(:start_time)
- .map { |time| Icalendar::Values::DateTime.new time.in_time_zone(tzid), "tzid" => tzid }
+ rescue StandardError => e
+ Rails.logger.error("Failed to generate ICS for meeting series #{series.id}: #{e.message}")
+ ServiceResult.failure(message: e.message)
end
end
end
diff --git a/modules/meeting/spec/services/meetings/ical_service_spec.rb b/modules/meeting/spec/services/meetings/ical_service_spec.rb
index 0ffca665c04..a3a873d9cc7 100644
--- a/modules/meeting/spec/services/meetings/ical_service_spec.rb
+++ b/modules/meeting/spec/services/meetings/ical_service_spec.rb
@@ -1,4 +1,5 @@
# frozen_string_literal: true
+
#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) the OpenProject GmbH
@@ -67,7 +68,7 @@ RSpec.describe Meetings::ICalService, type: :model do # rubocop:disable RSpec/Sp
subject { service.call }
before do
- allow(service).to receive(:generate_ical).and_raise StandardError.new("Oh noes")
+ allow(Meetings::CalendarWrapper).to receive(:new).and_raise StandardError.new("Oh noes")
end
it "returns a failure" do
diff --git a/modules/meeting/spec/services/recurring_meetings/ical_service_spec.rb b/modules/meeting/spec/services/recurring_meetings/ical_service_spec.rb
index a2450e5fb8f..83a6fecab8b 100644
--- a/modules/meeting/spec/services/recurring_meetings/ical_service_spec.rb
+++ b/modules/meeting/spec/services/recurring_meetings/ical_service_spec.rb
@@ -1,4 +1,5 @@
# frozen_string_literal: true
+
#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) the OpenProject GmbH
@@ -28,6 +29,7 @@
#++
require "spec_helper"
+require "icalendar"
RSpec.describe RecurringMeetings::ICalService, type: :model do # rubocop:disable RSpec/SpecFilePathFormat
shared_let(:user) do
@@ -167,18 +169,5 @@ RSpec.describe RecurringMeetings::ICalService, type: :model do # rubocop:disable
expect(moved).to include("DTEND;TZID=America/New_York:20241216T073000")
expect(moved).to include("URL:http://#{Setting.host_name}/projects/my-project/meetings/#{moved_schedule.meeting_id}")
end
-
- context "when passing a specific occurrence" do
- let(:result) { service.generate_occurrence(schedule.meeting).result }
-
- it "creates the specific event when requested" do
- expect(parsed_events.count).to eq(1)
- occurrence = parsed_events.first.to_ical
-
- expect(occurrence).to include("DTSTART;TZID=America/New_York:20241208T050000")
- expect(occurrence).to include("DTEND;TZID=America/New_York:20241208T060000")
- expect(occurrence).to include("URL:http://#{Setting.host_name}/projects/my-project/meetings/#{schedule.meeting_id}")
- end
- end
end
end