spina-admin-conferences 1.3.3

data/app/jobs/spina/admin/conferences/import_job.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'csv'
+
+module Spina
+  module Admin
+    module Conferences
+      # Job for importing CSV files.
+      class ImportJob < ApplicationJob
+        CSV::Converters[:json] = lambda do |field|
+          JSON.parse field, symbolize_names: true
+        rescue JSON::ParserError
+          field
+        end
+
+        # Performs the job.
+        # @param file [String] the UTF-8-encoded string to parse as a CSV
+        # @yieldparam row [Hash] the current row of the CSV
+        def import(file)
+          csv_rows = CSV.parse file, encoding: 'UTF-8', headers: true, header_converters: :symbol, converters: [:json]
+          csv_rows.each { |row| yield(row) }
+        end
+      end
+    end
+  end
+end

data/app/jobs/spina/admin/conferences/presentation_import_job.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Conferences
+      # Job for importing {Presentation} objects
+      # @see Presentation
+      class PresentationImportJob < ImportJob
+        queue_as :default
+
+        # Performs the job.
+        # @param csv [String] the UTF-8-encoded string to parse as a CSV
+        #   == Columns
+        #   The CSV should has the following columns. Make sure to include the column names in the header row.
+        #   +session_id+:: The id of the associated session.
+        #   +date+:: The date of the presentation, in ISO 8601 format.
+        #   +start_time+:: The start time of the presentation, in HH:MM format.
+        #   +title+:: The title of the presentation for the default locale.
+        #   +abstract+:: The presentation's abstract.
+        #   +presenter_ids+:: The ids of the presenters.
+        #
+        # @return [void]
+        def perform(csv)
+          Presentation.transaction do
+            import(csv) { |row| Presentation.create! presentation_params(row.to_h) }
+          end
+        end
+
+        private
+
+        def presentation_params(params)
+          params = ActionController::Parameters.new(params)
+          params.permit :title, :date, :start_time, :abstract, :session_id, presenter_ids: []
+        end
+      end
+    end
+  end
+end

data/app/mailers/spina/admin/conferences/application_mailer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Conferences
+      # @abstract Abstract mailer from which all others inherit.
+      class ApplicationMailer < ActionMailer::Base
+        default from: 'from@example.com'
+        layout 'mailer'
+      end
+    end
+  end
+end

data/app/models/spina/admin/conferences.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Conferences # rubocop:disable Style/Documentation
+      def self.table_name_prefix
+        'spina_conferences_'
+      end
+    end
+  end
+end

data/app/models/spina/admin/conferences/application_record.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Conferences
+      # @abstract Subclass to implement a custom record.
+      class ApplicationRecord < ActiveRecord::Base
+        extend Mobility
+
+        self.abstract_class = true
+      end
+    end
+  end
+end

data/app/models/spina/admin/conferences/conference.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Conferences
+      # Conference records.
+      #
+      # = Validators
+      # Presence:: {#name}, {#start_date}, {#finish_date}, {#year}.
+      # Conference date (using {FinishDateValidator}):: {#finish_date}.
+      # @see FinishDateValidator
+      #
+      # = Translations
+      # - {#name}
+      class Conference < ApplicationRecord
+        include Partable
+
+        default_scope { includes(:translations) }
+
+        # @!attribute [rw] dates
+        #   @return [Range<Date>, nil] the dates of the conference
+
+        # @!attribute [rw] name
+        #   @return [String, nil] the translated name of the conference
+        translates :name, fallbacks: true
+
+        # @return [ActiveRecord::Relation] all conferences, ordered by date
+        scope :sorted, -> { order dates: :desc }
+
+        # @!attribute [rw] presentation_types
+        #   @return [ActiveRecord::Relation] directly associated presentation types
+        #   @note A conference cannot be destroyed if it has dependent presentation types.
+        #   @see PresentationType
+        has_many :presentation_types, -> { includes(:translations) }, inverse_of: :conference, dependent: :restrict_with_error
+        # @!attribute [rw] events
+        #   @return [ActiveRecord::Relation] directly associated events
+        #   @note Destroying a conference destroys dependent events.
+        #   @see Event
+        has_many :events, -> { includes(:translations) }, inverse_of: :conference, dependent: :destroy
+        # @!attribute [rw] events
+        #   @return [ActiveRecord::Relation] directly associated events
+        #   @note Destroying a conference destroys dependent events.
+        #   @see Event
+        has_many :parts, as: :pageable, dependent: :destroy
+        # @!attribute [rw] sessions
+        #   @return [ActiveRecord::Relation] Sessions associated with {#presentation_types}
+        #   @see Session
+        #   @see PresentationType#sessions
+        has_many :sessions, -> { distinct.includes(:translations) }, through: :presentation_types
+        # @!attribute [rw] presentations
+        #   @return [ActiveRecord::Relation] Presentations associated with {#sessions}
+        #   @see Presentation
+        #   @see Session#presentations
+        has_many :presentations, -> { distinct.includes(:translations) }, through: :sessions
+        # @!attribute [rw] rooms
+        #   @return [ActiveRecord::Relation] Rooms associated with {#sessions}
+        #   @see Room
+        #   @see Session#rooms
+        has_many :rooms, -> { distinct.includes(:translations) }, through: :sessions
+        # @!attribute [rw] institutions
+        #   @return [ActiveRecord::Relation] Institutions associated with {#rooms}
+        #   @see Institution
+        #   @see Room#institutions
+        has_many :institutions, -> { distinct.includes(:translations) }, through: :rooms
+        # @!attribute [rw] delegates
+        #   @return [ActiveRecord::Relation] directly associated delegates
+        #   @see Delegate
+        has_and_belongs_to_many :delegates, foreign_key: :spina_conferences_conference_id, # rubocop:disable Rails/HasAndBelongsToMany
+                                            association_foreign_key: :spina_conferences_delegate_id
+        accepts_nested_attributes_for :events, allow_destroy: true
+        accepts_nested_attributes_for :parts, allow_destroy: true
+
+        validates :name, :start_date, :finish_date, :year, presence: true
+        validates :finish_date, 'spina/admin/conferences/finish_date': true, unless: proc { |conference| conference.start_date.blank? }
+
+        # @return [Date, nil] the start date of the conference. Nil if the conference has no dates
+        def start_date
+          return if dates.blank?
+
+          dates.begin
+        end
+
+        # Sets the start date of the conference.
+        # @param date [Date] the new start date
+        # @return [void]
+        def start_date=(date)
+          self.dates = date.try(:to_date)..finish_date
+        end
+
+        # @return [Date, nil] the finish date of the conference. Nil if the conference has no dates
+        def finish_date
+          return if dates.blank?
+
+          if dates.exclude_end?
+            dates.end - 1.day if dates.end.is_a? Date
+          else
+            dates.end
+          end
+        end
+
+        # Sets the finish date of the conference.
+        # @param date [Date] the new finish date
+        # @return [void]
+        def finish_date=(date)
+          self.dates = start_date..date.try(:to_date)
+        end
+
+        # @return [Integer, nil] the year of the conference. Nil if the conference has no dates
+        def year
+          return if start_date.blank?
+
+          start_date.try(:year)
+        end
+
+        # @return [Array<Hash{Symbol=>String}>, nil] an array of hashes containing the date in ISO 8601 format and as a localised string
+        #   Nil if the conference has no dates.
+        def localized_dates
+          return if dates.blank?
+
+          dates.entries.collect { |date| { date: date.to_formatted_s(:iso8601), localization: I18n.l(date, format: :long) } }
+        end
+
+        # @return [String] the names of each institution associated with the conference
+        def location
+          institutions.collect(&:name).to_sentence
+        end
+
+        # @return [Icalendar::Event] the conference as an iCal event
+        def to_event # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+          event = Icalendar::Event.new
+          return event if invalid?
+
+          event.dtstart = start_date
+          event.dtstart.ical_param(:value, 'DATE')
+          event.dtend = finish_date
+          event.dtend.ical_param(:value, 'DATE')
+          event.location = location
+          event.contact = Spina::Account.first.email
+          event.categories = Conference.model_name.human(count: 0)
+          event.summary = name
+          event
+        end
+
+        # @param (see #to_event)
+        # @deprecated Use {#to_event} instead
+        def to_ics
+          to_event
+        end
+      end
+    end
+  end
+end

data/app/models/spina/admin/conferences/date_part.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Conferences
+      # Date parts, without associated times.
+      class DatePart < ApplicationRecord
+        has_many :page_parts, as: :page_partable
+        has_many :parts, as: :partable
+        has_many :layout_parts, as: :layout_partable
+        has_many :structure_parts, as: :structure_partable
+      end
+    end
+  end
+end

data/app/models/spina/admin/conferences/delegate.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Conferences
+      # Delegate records.
+      #
+      # = Validators
+      # Presence:: {#first_name}, {#last_name}.
+      # Email address (using {EmailAddressValidator}):: {#email_address}.
+      # HTTP(S) URL (using {HttpUrlValidator}):: {#url}.
+      # @see EmailAddressValidator
+      # @see HttpUrlValidator
+      class Delegate < ApplicationRecord
+        # @!attribute [rw] first_name
+        #   @return [String, nil] the first name of the delegate
+        # @!attribute [rw] last_name
+        #   @return [String, nil] the last name of the delegate
+        # @!attribute [rw] email_address
+        #   @return [String, nil] the email address of the delegate
+        # @!attribute [rw] url
+        #   @return [String, nil] the website belonging to the delegate
+
+        # @return [ActiveRecord::Relation] all delegates, ordered by last name and first name
+        scope :sorted, -> { order :last_name, :first_name }
+
+        # @!attribute [rw] institution
+        #   @return [Institution, nil] directly associated institution
+        #   @see Institution
+        belongs_to :institution, inverse_of: :delegates, touch: true
+        # @!attribute [rw] conferences
+        #   @return [ActiveRecord::Relation] directly associated conferences
+        #   @see Conference
+        has_and_belongs_to_many :conferences, -> { includes(:translations) }, foreign_key: :spina_conferences_delegate_id, # rubocop:disable Rails/HasAndBelongsToMany
+                                              association_foreign_key: :spina_conferences_conference_id
+        # @!attribute [rw] presentations
+        #   @return [ActiveRecord::Relation] directly associated presentations
+        #   @see Presentation
+        has_and_belongs_to_many :presentations, -> { includes(:translations) }, foreign_key: :spina_conferences_delegate_id, # rubocop:disable Rails/HasAndBelongsToMany
+                                                association_foreign_key: :spina_conferences_presentation_id
+        # @!attribute [rw] dietary_requirements
+        #   @return [ActiveRecord::Relation] directly associated dietary requirements
+        #   @see DietaryRequirement
+        has_and_belongs_to_many :dietary_requirements, -> { includes(:translations) }, foreign_key: :spina_conferences_delegate_id, # rubocop:disable Rails/HasAndBelongsToMany
+                                                       association_foreign_key: :spina_conferences_dietary_requirement_id
+
+        validates :first_name, :last_name, presence: true
+        validates :email_address, 'spina/admin/conferences/email_address': true
+        validates :url, 'spina/admin/conferences/http_url': true
+
+        # Imports a conference from CSV.
+        # @param file [String] the CSV file to be read
+        # @return [void]
+        # @see DelegateImportJob
+        def self.import(file)
+          DelegateImportJob.perform_later Pathname.new(file).read
+        end
+
+        # @return [String] the first name and last name of the delegate
+        def full_name
+          return if first_name.blank? || last_name.blank?
+
+          Delegate.human_attribute_name :full_name, first_name: first_name, last_name: last_name
+        end
+
+        # @return [String] the full name and institution of the delegate
+        def full_name_and_institution
+          return if full_name.blank? || institution.blank?
+
+          Delegate.human_attribute_name :name_and_institution, name: full_name, institution: institution.name
+        end
+
+        # @return [String] the last name and first name of the delegate
+        def reversed_name
+          return if first_name.blank? || last_name.blank?
+
+          Delegate.human_attribute_name :reversed_name, first_name: first_name, last_name: last_name
+        end
+
+        # @return [String] the reversed name and institution of the delegate
+        def reversed_name_and_institution
+          return if reversed_name.blank? || institution.blank?
+
+          Delegate.human_attribute_name :name_and_institution, name: reversed_name, institution: institution.name
+        end
+      end
+    end
+  end
+end

data/app/models/spina/admin/conferences/dietary_requirement.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Conferences
+      # Dietary requirement records.
+      #
+      # = Validators
+      # Presence:: {#name}.
+      #
+      # = Translations
+      # - {#name}
+      class DietaryRequirement < ApplicationRecord
+        default_scope { includes(:translations) }
+
+        # @!attribute [rw] name
+        #   @return [String, nil] the name of the dietary requirement
+        translates :name, fallbacks: true
+
+        # @return [ActiveRecord::Relation] all dietary requirements, ordered by name
+        scope :sorted, -> { i18n.order :name }
+
+        # @!attribute [rw] delegates
+        #   @return [ActiveRecord::Relation] directly associated delegates
+        #   @see Delegate
+        has_and_belongs_to_many :delegates, foreign_key: :spina_conferences_dietary_requirement_id, # rubocop:disable Rails/HasAndBelongsToMany
+                                            association_foreign_key: :spina_conferences_delegate_id
+
+        validates :name, presence: true
+      end
+    end
+  end
+end

data/app/models/spina/admin/conferences/email_address_part.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Conferences
+      # Email address parts. The format is validated.
+      #
+      # = Validators
+      # Email address (using {EmailAddressValidator}):: {#content}.
+      # @see EmailAddressValidator
+      class EmailAddressPart < ApplicationRecord
+        has_many :page_parts, as: :page_partable
+        has_many :parts, as: :partable
+        has_many :layout_parts, as: :layout_partable
+        has_many :structure_parts, as: :structure_partable
+
+        validates :content, 'spina/admin/conferences/email_address': true, allow_blank: true
+      end
+    end
+  end
+end

data/app/models/spina/admin/conferences/event.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Conferences
+      # Events during conferences.
+      #
+      # = Validators
+      # Presence:: {#name}, {#start_time}, {#finish_time}.
+      # Conference date (using {ConferenceDateValidator}):: {#start_time}, {#finish_time}.
+      # @see ConferenceDateValidator
+      #
+      # = Translations
+      # - {#name}
+      # - {#description}
+      # - {#location}
+      class Event < ApplicationRecord
+        default_scope { includes(:translations) }
+
+        # @!attribute [rw] name
+        #   @return [String, nil] the translated name of the conference
+        # @!attribute [rw] description
+        #   @return [String, nil] the translated description of the conference
+        # @!attribute [rw] location
+        #   @return [String, nil] the translated location of the conference
+        translates :name, :description, :location, fallbacks: true
+
+        # @return [ActiveRecord::Relation] all events, ordered by name
+        scope :sorted, -> { i18n.order :name }
+
+        # @!attribute [rw] conference
+        #   @return [Conference, nil] directly associated conferences
+        belongs_to :conference, -> { includes(:translations) }, inverse_of: :events, touch: true
+
+        validates :name, :date, :start_time, :start_datetime, :finish_time, :finish_datetime, :location, presence: true
+        validates :date, 'spina/admin/conferences/conference_date': true
+        validates :finish_time, 'spina/admin/conferences/finish_time': true
+
+        # @return [Date, nil] the start date of the event. Nil if the event has no start date and time
+        def date
+          return if start_datetime.blank?
+
+          start_datetime.to_date
+        end
+
+        # Sets the date of the presentation.
+        # @param date [Date] the new date
+        # @return [void]
+        def date=(date)
+          if date.blank? || date.to_date.blank?
+            self.start_datetime = nil
+            return
+          end
+
+          self.start_datetime = date.to_date + (start_datetime.try(:seconds_since_midnight) || 0).seconds
+        end
+
+        # @return [ActiveSupport::TimeWithZone, nil] the start time of the event. Nil if the event has no start date and time
+        def start_time
+          return if start_datetime.blank?
+
+          start_datetime
+        end
+
+        # Sets the start time of the event.
+        # @param start_time [ActiveSupport::TimeWithZone] the new start time
+        # @return [void]
+        def start_time=(start_time)
+          if start_time.blank?
+            self.start_datetime = nil
+            return
+          end
+
+          self.start_datetime = Time.parse(start_time, date).to_datetime.in_time_zone
+        end
+
+        # @return [ActiveSupport::TimeWithZone, nil] the finish time of the event. Nil if the event has no finish date and time
+        def finish_time
+          return if finish_datetime.blank?
+
+          finish_datetime
+        end
+
+        # Sets the finish time of the event.
+        # @param finish_time [ActiveSupport::TimeWithZone] the new finish time
+        # @return [void]
+        def finish_time=(finish_time)
+          if finish_time.blank?
+            self.finish_datetime = nil
+            return
+          end
+
+          self.finish_datetime = Time.parse(finish_time, date).to_datetime.in_time_zone
+        end
+
+        # @return [Icalendar::Event] the event as an iCal event
+        def to_event # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+          event = Icalendar::Event.new
+          return event if invalid?
+
+          event.dtstart = start_datetime
+          event.dtend = finish_datetime
+          event.location = location
+          event.contact = Spina::Account.first.email
+          event.categories = Event.model_name.human(count: 0)
+          event.summary = name
+          event.append_custom_property('alt_description', description.try(:html_safe))
+          event.description = description.try(:gsub, %r{</?[^>]*>}, '')
+          event
+        end
+
+        # @param (see #to_event)
+        # @deprecated Use {#to_event} instead
+        def to_ics
+          to_event
+        end
+      end
+    end
+  end
+end