spina-admin-conferences-fork 2.1.1

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

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Conferences
+      # Presentation records.
+      #
+      # = Validators
+      # Presence:: {#title}, {#date}, {#start_time}, {#start_datetime}, {#abstract}, {#presenters}.
+      # Conference date (using {ConferenceDateValidator}):: {#date}.
+      # @see ConferenceDateValidator
+      #
+      # = Translations
+      # - {#name}
+      # - {#title}
+      # - {#abstract}
+      class Presentation < ApplicationRecord
+        include AttrJson::Record
+        include AttrJson::NestedAttributes
+        include Spina::Partable
+        include Spina::TranslatedContent
+
+        # @!attribute [rw] start_datetime
+        #   @return [ActiveSupport::TimeWithZone, nil] the presentation start time
+
+        default_scope { includes(:translations) }
+
+        # @!attribute [rw] title
+        #   @return [String, nil] the presentation title
+        # @!attribute [rw] abstract
+        #   @return [ActionText::RichText, nil] the presentation abstract
+        translates :title, fallbacks: true
+        translates :abstract, backend: :action_text, fallbacks: true
+
+        # @return [ActiveRecord::Relation] all conferences, ordered by date
+        scope :sorted, -> { order start_datetime: :desc }
+
+        # @!attribute [rw] name
+        #   @return [String, nil] the presentation title (alias)
+        #   @see #title
+        alias_attribute :name, :title
+
+        # @!attribute [rw] session
+        #   @return [Session, nil] directly associated session
+        #   @see Session
+        belongs_to :session, -> { includes(:translations) }, inverse_of: :presentations, touch: true
+        # @!attribute [rw] presentation_type
+        #   @return [PresentationType, nil] Presentation type associated with {#session}
+        #   @see PresentationType
+        #   @see Session#presentation_type
+        has_one :presentation_type, -> { includes(:translations) }, through: :session
+        # @!attribute [rw] room
+        #   @return [Room, nil] Room associated with {#session}
+        #   @see Session
+        #   @see Session#room
+        has_one :room, -> { includes(:translations) }, through: :session
+        # @!attribute [rw] conference
+        #   @return [Conference, nil] Conference associated with {#presentation_type}
+        #   @see Conference
+        #   @see PresentationType#conference
+        has_one :conference, -> { includes(:translations) }, through: :presentation_type
+        # @!attribute [rw] attachments
+        #   @return [ActiveRecord::Relation] directly associated presentation attachments
+        #   @note This relation accepts nested attributes.
+        #   @note Destroying a presentation destroys associated attachments.
+        #   @see Attachment
+        has_many :attachments, class_name: 'Spina::Admin::Conferences::PresentationAttachment', dependent: :destroy,
+                               inverse_of: :presentation
+        # @!attribute [rw] presenters
+        #   @return [ActiveRecord::Relation] directly associated delegates
+        #   @see Delegate
+        has_and_belongs_to_many :presenters, class_name: 'Spina::Admin::Conferences::Delegate', # rubocop:disable Rails/HasAndBelongsToMany
+                                             foreign_key: :spina_conferences_presentation_id,
+                                             association_foreign_key: :spina_conferences_delegate_id
+        accepts_nested_attributes_for :attachments, allow_destroy: true
+
+        validates :title, :start_datetime, :abstract, :presenters, presence: true
+        validates :start_datetime, 'spina/admin/conferences/conference_date': true
+        validates_associated :presenters
+        validates_associated :attachments
+
+        # @!attribute [rw] start_time
+        #   @return [ActiveSupport::TimeWithZone, nil] the start time (alias)
+        #   @see #start_datetime
+        alias_attribute :start_time, :start_datetime
+
+        # Imports a presentation from CSV.
+        # @param file [String] the CSV file to be read
+        # @return [void]
+        # @see PresentationImportJob#perform
+        def self.import(file)
+          PresentationImportJob.perform_later IO.read(file)
+        end
+
+        # @return [Date, nil] the start date of the presentation. Nil if the presentation has no start date and time
+        def date
+          return if start_datetime.blank?
+
+          start_datetime.to_date
+        end
+
+        # @return [ActiveSupport::TimeWithZone, nil] the presentation end time. Nil if the presentation has no start date and time
+        def finish_datetime
+          return if start_datetime.blank?
+
+          start_datetime + presentation_type.duration
+        end
+
+        # @return [TZInfo::TimezonePeriod, nil] the time zone period for the presentation
+        def time_zone_period
+          return if start_datetime.blank?
+
+          start_datetime.period
+        end
+
+        # @return [Icalendar::Event] the presentation as an iCal event
+        def to_event # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+          event = Icalendar::Event.new
+          return event if invalid?
+
+          event.dtstart = Icalendar::Values::DateTime.new(start_datetime, tzid: start_datetime.time_zone.tzinfo.name)
+          event.dtend = Icalendar::Values::DateTime.new(finish_datetime, tzid: finish_datetime.time_zone.tzinfo.name)
+          event.location = session.room_name
+          presenters.each { |presenter| event.contact = presenter.full_name_and_institution }
+          event.categories = Presentation.model_name.human(count: 0)
+          event.summary = title
+          event.append_custom_property('alt_description', abstract.to_s)
+          event.description = abstract.try(:to_plain_text)
+          event
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Conferences
+      # Presentation attachment records.
+      class PresentationAttachment < ApplicationRecord
+        # @!attribute [rw] presentation
+        #   @return [Presentation, nil] directly associated presentation
+        belongs_to :presentation, -> { includes(:translations) }, inverse_of: :attachments, touch: true
+        # @!attribute [rw] presentation_attachment_type
+        #   @return [PresentationAttachmentType, nil] directly associated presentation attachment type
+        belongs_to :attachment_type, -> { includes(:translations) }, class_name: 'Spina::Admin::Conferences::PresentationAttachmentType',
+                                                                     inverse_of: :presentation_attachments,
+                                                                     touch: true
+        # @!attribute [rw] attachment
+        #   @return [Spina::Attachment, nil] directly associated attachment
+        belongs_to :attachment, class_name: 'Spina::Attachment'
+
+        # @!method name
+        #   @return [String, nil] name of associated presentation attachment type
+        #   @note Delegated to {#presentation_attachment_type}.
+        delegate :name, to: :attachment_type, allow_nil: true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Conferences
+      # Presentation attachment type records.
+      #
+      # = Validators
+      # Presence:: {#name}.
+      #
+      # = Translations
+      # - {#name}
+      class PresentationAttachmentType < ApplicationRecord
+        default_scope { includes(:translations) }
+
+        # @!attribute [rw] name
+        #   @return [String, nil] the name of the presentation attachment type
+        translates :name, fallbacks: true
+
+        # @return [ActiveRecord::Relation] all presentation attachment types, ordered by name
+        scope :sorted, -> { i18n.order :name }
+
+        # @!attribute [rw] presentation_attachments
+        #   @return [ActiveRecord::Relation] directly associated presentation attachments
+        #   @see PresentationAttachment
+        has_many :presentation_attachments, class_name: 'Spina::Admin::Conferences::PresentationAttachment',
+                                            foreign_key: 'attachment_type_id',
+                                            dependent: :destroy,
+                                            inverse_of: :attachment_type
+
+        validates :name, presence: true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Conferences
+      # Presentation type records.
+      #
+      # = Validators
+      # Presence:: {#name}, {#minutes}. {#duration}.
+      #
+      # = Translations
+      # - {#name}
+      class PresentationType < ApplicationRecord
+        default_scope { includes(:translations) }
+
+        # @!attribute [rw] name
+        #   @return [String, nil] the name of the presentation type
+        translates :name, fallbacks: true
+
+        # @return [ActiveRecord::Relation] all presentation types, ordered by name
+        scope :sorted, -> { i18n.order :name }
+
+        # @!attribute [rw] duration
+        #   @return [ActiveSupport::Duration, nil] the duration of dependent presentations
+        attribute :duration, :interval
+
+        # @!attribute [rw] conference
+        #   @return [Conference, nil] directly associated conference
+        belongs_to :conference, -> { includes(:translations) }, inverse_of: :presentation_types, touch: true
+        # @!attribute [rw] sessions
+        #   @return [ActiveRecord::Relation] directly associated sessions
+        #   @note A presentation type cannot be destroyed if it has dependent sessions.
+        #   @see Session
+        has_many :sessions, -> { includes(:translations) }, inverse_of: :presentation_type, dependent: :restrict_with_error
+        # @!attribute [rw] presentations
+        #   @return [ActiveRecord::Relation] Presentations associated with {#sessions}
+        #   @see Presentation
+        #   @see Session#presentations
+        has_many :presentations, -> { distinct.includes(:translations) }, through: :sessions
+
+        validates :name, :minutes, :duration, presence: true
+        validates :minutes, numericality: { greater_than_or_equal_to: 1 }
+
+        # @return [Integer, nil] duration in minutes. Nil if the conference has no duration
+        def minutes
+          return if duration.blank?
+
+          duration.to_i / ActiveSupport::Duration::PARTS_IN_SECONDS[:minutes]
+        end
+
+        # Sets the duration of the conference.
+        # @param minutes [#to_i] the new duration in minutes
+        # @return [void]
+        def minutes=(minutes)
+          self.duration = minutes.to_i.minutes
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Conferences
+      # Room records.
+      #
+      # = Validators
+      # Presence:: {#number}, {#building}.
+      #
+      # = Translations
+      # - {#number}
+      # - {#building}
+      class Room < ApplicationRecord
+        default_scope { includes(:translations) }
+
+        # @!attribute [rw] number
+        #   @return [String, nil] the number of the room
+        # @!attribute [rw] building
+        #   @return [String, nil] the building of the room
+        translates :building, :number, fallbacks: true
+
+        # @return [ActiveRecord::Relation] all rooms, ordered by building and number
+        scope :sorted, -> { i18n.order :building, :number }
+
+        # @!attribute [rw] institution
+        #   @return [Institution, nil] directly associated institution
+        #   @see Institution
+        belongs_to :institution, -> { includes(:translations) }, inverse_of: :rooms, autosave: true, touch: true
+        # @!attribute [rw] sessions
+        #   @return [ActiveRecord::Relation] directly associated sessions
+        #   @note A room cannot be destroyed if it has dependent sessions.
+        #   @see Session
+        has_many :sessions, -> { includes(:translations) }, inverse_of: :room, dependent: :restrict_with_error
+        # @!attribute [rw] presentations
+        #   @return [ActiveRecord::Relation] Presentations associated with {#sessions}
+        #   @see Presentation
+        #   @see Session#presentations
+        has_many :presentations, -> { distinct.includes(:translations) }, through: :sessions
+
+        validates :number, :building, presence: true
+
+        # @return [String] the building and number of the room
+        def name
+          return if building.blank? || number.blank?
+
+          Room.human_attribute_name :name, building: building, number: number
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Conferences
+      # Session records.
+      #
+      # = Validators
+      # Presence:: {#name}.
+      #
+      # = Translations
+      # - {#name}
+      class Session < ApplicationRecord
+        default_scope { includes(:translations) }
+
+        # @!attribute [rw] name
+        #   @return [String, nil] the name of the session
+        translates :name, fallbacks: true
+
+        # @!attribute [rw] room
+        #   @return [Room, nil] directly associated room
+        belongs_to :room, -> { includes(:translations) }, inverse_of: :sessions, touch: true
+        # @!attribute [rw] room
+        #   @return [PresentationType, nil] directly associated presentation type
+        #   @see PresentationType
+        belongs_to :presentation_type, -> { includes(:translations) }, inverse_of: :sessions, touch: true
+        # @!attribute [rw] conference
+        #   @return [Conference, nil] Conference associated with {#presentation_type}
+        #   @see Conference
+        #   @see PresentationType#conference
+        has_one :conference, -> { includes(:translations) }, through: :presentation_type
+        # @!attribute [rw] institution
+        #   @return [Institution, nil] Institution associated with {#room}
+        #   @see Institution
+        #   @see Room#institution
+        has_one :institution, -> { includes(:translations) }, through: :room
+        # @!attribute [rw] presentations
+        #   @return [ActiveRecord::Relation] directly associated presentations
+        #   @note A session cannot be destroyed if it has dependent presentations.
+        #   @see Presentation
+        has_many :presentations, inverse_of: :session, dependent: :restrict_with_error
+
+        validates :name, presence: true
+
+        # @!method room_name
+        #   @return [String, nil] name of associated room
+        #   @note Delegated to {#room}.
+        delegate :name, to: :room, prefix: true, allow_nil: true
+        # @!method presentation_type_name
+        #   @return [String, nil] name of associated presentation type
+        #   @note Delegated to {#presentation_type}.
+        delegate :name, to: :presentation_type, prefix: true, allow_nil: true
+      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/parts/admin/conferences/date.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Spina
+  module Parts
+    module Admin
+      module Conferences
+        # Date parts, without associated times.
+        class Date < Spina::Parts::Base
+          attr_json :content, :date
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Spina
+  module Parts
+    module Admin
+      module Conferences
+        # Email address parts. The format is validated.
+        #
+        # = Validators
+        # Email address (using {EmailAddressValidator}):: {#content}.
+        # @see EmailAddressValidator
+        class EmailAddress < Spina::Parts::Base
+          attr_json :content, :string
+
+          validates :content, 'spina/admin/conferences/email_address': true, allow_blank: true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Spina
+  module Parts
+    module Admin
+      module Conferences
+        # Time parts.
+        class Time < Spina::Parts::Base
+          attr_json :content, :time
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Spina
+  module Parts
+    module Admin
+      module Conferences
+        # URL parts. The format is validated.
+        #
+        # = Validators
+        # HTTP(S) URL (using {HttpUrlValidator}):: {#content}.
+        # @see HttpUrlValidator
+        class Url < Spina::Parts::Base
+          attr_json :content, :string
+
+          validates :content, 'spina/admin/conferences/http_url': true, allow_blank: true
+        end
+      end
+    end
+  end
+end

data/app/validators/spina/admin/conferences/conference_date_validator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Conferences
+      # Validator for dates which should occur during the associated conference.
+      class ConferenceDateValidator < ActiveModel::EachValidator
+        # Performs validation on the supplied record.
+        # @param record [ActiveRecord::Base] the associated record
+        # @param attribute [Symbol] the attribute key
+        # @param value [Date] the attribute value
+        def validate_each(record, attribute, value)
+          return if value.blank? || record.conference&.dates&.cover?(value.to_date)
+
+          record.errors.add(attribute, :outside_conference)
+        end
+      end
+    end
+  end
+end

data/app/validators/spina/admin/conferences/email_address_validator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Conferences
+      # Validator for email addresses.
+      class EmailAddressValidator < ActiveModel::EachValidator
+        # Performs validation on the supplied record.
+        # @param record [ActiveRecord::Base] the associated record
+        # @param attribute [Symbol] the attribute key
+        # @param value [String] the attribute value
+        def validate_each(record, attribute, value)
+          return if value.blank?
+
+          record.errors.add(attribute, :invalid_email_address) unless parse(value)
+        end
+
+        private
+
+        def parse(value)
+          Mail::Address.new(value).then { |address| address.domain.present? && address.local.present? }
+        rescue Mail::Field::IncompleteParseError
+          false
+        end
+      end
+    end
+  end
+end

data/app/validators/spina/admin/conferences/finish_date_validator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Conferences
+      # Validator for dates which should occur after a +start_date+.
+      class FinishDateValidator < ActiveModel::EachValidator
+        # Performs validation on the supplied record.
+        # @param record [ActiveRecord::Base] the associated record
+        # @param attribute [Symbol] the attribute key
+        # @param value [Date] the attribute value
+        def validate_each(record, attribute, value)
+          return if value.blank? || record.start_date.blank? || value >= record.start_date
+
+          record.errors.add(attribute, :before_start_date)
+        end
+      end
+    end
+  end
+end

data/app/validators/spina/admin/conferences/finish_time_validator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Conferences
+      # Validator for times which should occur after a +start_time+.
+      class FinishTimeValidator < ActiveModel::EachValidator
+        # Performs validation on the supplied record.
+        # @param record [ActiveRecord::Base] the associated record
+        # @param attribute [Symbol] the attribute key
+        # @param value [Time] the attribute value
+        def validate_each(record, attribute, value)
+          return if value.blank? || record.start_time.blank? || value >= record.start_time
+
+          record.errors.add(attribute, :before_start_time)
+        end
+      end
+    end
+  end
+end

data/app/validators/spina/admin/conferences/http_url_validator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Spina
+  module Admin
+    module Conferences
+      # Validator for HTTP(S) URLs.
+      class HttpUrlValidator < ActiveModel::EachValidator
+        # Performs validation on the supplied record.
+        # @param record [ActiveRecord::Base] the associated record
+        # @param attribute [Symbol] the attribute key
+        # @param value [String] the attribute value
+        def validate_each(record, attribute, value)
+          return if value.blank?
+
+          record.errors.add(attribute, :invalid_http_https_url) unless parse(value)
+        end
+
+        private
+
+        def parse(value)
+          URI.parse(value).then { |uri| uri.is_a?(URI::HTTP) && uri.host.present? }
+        rescue URI::InvalidURIError
+          false
+        end
+      end
+    end
+  end
+end

data/app/views/layouts/spina/admin/conferences/application.html.haml

@@ -0,0 +1,6 @@
+- content_for :application do
+  %div{ data: { turbolinks: 'false' } }
+    = yield(:admin_header)
+    = yield
+
+= render template: 'layouts/spina/admin/admin'

data/app/views/layouts/spina/admin/conferences/conferences.html.haml

@@ -0,0 +1,17 @@
+- content_for :admin_header do
+  %header#header
+    #header_actions
+      = yield(:header_actions)
+
+    = render partial: 'spina/admin/shared/breadcrumbs'
+
+    %nav#secondary.tabs
+      %ul
+        %li{class: ('active' if controller_name == 'conferences')}
+          = link_to Spina::Admin::Conferences::Conference.model_name.human(count: 0), admin_conferences_conferences_path
+        %li{class: ('active' if controller_name == 'presentation_types')}
+          = link_to Spina::Admin::Conferences::PresentationType.model_name.human(count: 0), admin_conferences_presentation_types_path
+        %li{class: ('active' if controller_name == 'sessions')}
+          = link_to Spina::Admin::Conferences::Session.model_name.human(count: 0), admin_conferences_sessions_path
+
+= render template: 'layouts/spina/admin/conferences/application'

data/app/views/layouts/spina/admin/conferences/delegates.html.haml

@@ -0,0 +1,8 @@
+- content_for :admin_header do
+  %header#header
+    #header_actions
+      = yield(:header_actions)
+
+    = render partial: 'spina/admin/shared/breadcrumbs'
+
+= render template: 'layouts/spina/admin/conferences/application'

data/app/views/layouts/spina/admin/conferences/dietary_requirements.html.haml

@@ -0,0 +1,8 @@
+- content_for :admin_header do
+  %header#header
+    #header_actions
+      = yield(:header_actions)
+
+    = render partial: 'spina/admin/shared/breadcrumbs'
+
+= render template: 'layouts/spina/admin/conferences/application'

data/app/views/layouts/spina/admin/conferences/institutions.html.haml

@@ -0,0 +1,15 @@
+- content_for :admin_header do
+  %header#header
+    #header_actions
+      = yield(:header_actions)
+
+    = render partial: 'spina/admin/shared/breadcrumbs'
+
+    %nav#secondary.tabs
+      %ul
+        %li{class: ('active' if controller_name == 'institutions')}
+          = link_to Spina::Admin::Conferences::Institution.model_name.human(count: 0), admin_conferences_institutions_path
+        %li{class: ('active' if controller_name == 'rooms')}
+          = link_to Spina::Admin::Conferences::Room.model_name.human(count: 0), admin_conferences_rooms_path
+
+= render template: 'layouts/spina/admin/conferences/application'

data/app/views/layouts/spina/admin/conferences/presentation_attachment_types.html.haml

@@ -0,0 +1,8 @@
+- content_for :admin_header do
+  %header#header
+    #header_actions
+      = yield(:header_actions)
+
+    = render partial: 'spina/admin/shared/breadcrumbs'
+
+= render template: 'layouts/spina/admin/conferences/application'

data/app/views/layouts/spina/admin/conferences/presentations.html.haml

@@ -0,0 +1,8 @@
+- content_for :admin_header do
+  %header#header
+    #header_actions
+      = yield(:header_actions)
+
+    = render partial: 'spina/admin/shared/breadcrumbs'
+
+= render template: 'layouts/spina/admin/conferences/application'

data/app/views/spina/admin/conferences/application/_conferences.html.haml

@@ -0,0 +1,12 @@
+.well
+  .table-container
+    %table.table
+      %thead
+        %tr
+          %th= Spina::Admin::Conferences::Conference.human_attribute_name :name
+          %th= Spina::Admin::Conferences::Conference.human_attribute_name :year
+          %th= Spina::Admin::Conferences::Conference.human_attribute_name :start_date
+          %th= Spina::Admin::Conferences::Conference.human_attribute_name :finish_date
+          %th
+
+      %tbody= render conferences.presence || 'empty_list', message: t('.no_conferences')