feat(logos): manage departments and organisations logos with scaleway

.rubocop.yml

@@ -34,6 +34,9 @@ Style/ClassAndModuleChildren:
 Style/ParallelAssignment:
   Enabled: false
 
+Style/Alias:
+  Enabled: false
+
 Style/RegexpLiteral:
   Enabled: false
 

Gemfile

@@ -98,11 +98,14 @@ gem "blueprinter"
 # A Rails engine for creating super-flexible admin dashboards
 gem "administrate", git: "https://github.com/thoughtbot/administrate.git"
 
-# Required for ActiveStorage for S3 compatible storage
-gem "aws-sdk-s3", require: false
+# manage attachments from administrate dashboards
+gem "administrate-field-active_storage"
 
 # Use Active Storage variant
-gem "image_processing", "~> 1.2"
+gem "image_processing"
+
+# Required for ActiveStorage for S3 compatible storage
+gem "aws-sdk-s3", require: false
 
 # Reduces boot times through caching; required in config/boot.rb
 gem "bootsnap", ">= 1.4.2", require: false

Gemfile.lock

@@ -91,6 +91,9 @@ GEM
       tzinfo (~> 2.0)
     addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
+    administrate-field-active_storage (1.0.1)
+      administrate (>= 0.2.2)
+      rails (>= 7.0)
     afm (0.2.2)
     ast (2.4.2)
     aws-eventstream (1.3.0)
@@ -526,6 +529,7 @@ PLATFORMS
 DEPENDENCIES
   addressable
   administrate!
+  administrate-field-active_storage
   aws-sdk-s3
   blueprinter
   bootsnap (>= 1.4.2)
@@ -536,7 +540,7 @@ DEPENDENCIES
   factory_bot_rails
   faraday
   groupdate
-  image_processing (~> 1.2)
+  image_processing
   jbuilder (~> 2.7)
   jsbundling-rails
   jwt

app/controllers/application_controller.rb

@@ -10,6 +10,9 @@ class ApplicationController < ActionController::Base
   include EnvironmentsHelper
   include TurboStreamConcern
 
+  # Needed to generate ActiveStorage urls locally, it sets the host and protocol
+  include ActiveStorage::SetCurrent unless Rails.env.production?
+
   private
 
   def set_sentry_context

app/controllers/previews/invitations_controller.rb

@@ -81,9 +81,7 @@ def mailer_instance_variables
         mandatory_warning: @invitation.mandatory_warning,
         punishable_warning: @invitation.punishable_warning,
         custom_sentence: @invitation.custom_sentence,
-        signature_lines: @organisation.messages_configuration&.signature_lines,
-        organisation_logo_path: @organisation.logo_path(%w[png jpg]),
-        department_logo_path: @department.logo_path(%w[png jpg])
+        signature_lines: @organisation.messages_configuration&.signature_lines
       }
     end
 

app/controllers/previews/notifications_controller.rb

@@ -81,9 +81,7 @@ def mailer_instance_variables
         punishable_warning: @notification.punishable_warning,
         custom_sentence: @notification.custom_sentence,
         signature_lines: @notification.signature_lines,
-        instruction_for_rdv: @notification.instruction_for_rdv,
-        organisation_logo_path: @organisation.logo_path(%w[png jpg]),
-        department_logo_path: @department.logo_path(%w[png jpg])
+        instruction_for_rdv: @notification.instruction_for_rdv
       }
     end
 

app/controllers/super_admins/application_controller.rb

@@ -8,6 +8,9 @@ module SuperAdmins
   class ApplicationController < Administrate::ApplicationController
     include AuthenticatedControllerConcern
     include SuperAdmins::RedirectAndRenderConcern
+    # Needed to generate ActiveStorage urls locally, it sets the host and protocol
+    include ActiveStorage::SetCurrent unless Rails.env.production?
+
     before_action :authenticate_super_admin!
 
     def authenticate_super_admin!

app/controllers/super_admins/departments_controller.rb

@@ -42,6 +42,10 @@ class DepartmentsController < SuperAdmins::ApplicationController
 
     private
 
+    def scoped_resource
+      resource_class.with_attached_logo
+    end
+
     def default_sorting_attribute
       :number
     end

app/controllers/super_admins/organisations_controller.rb

@@ -23,6 +23,10 @@ def update
 
     private
 
+    def scoped_resource
+      resource_class.with_attached_logo
+    end
+
     def resource
       @resource ||= Organisation.new(resource_params)
     end

app/controllers/teleprocedure_landings_controller.rb

@@ -5,6 +5,5 @@ class TeleprocedureLandingsController < ApplicationController
 
   def show
     @department = Department.find_by!(number: params[:department_number])
-    @department_logo_path = @department.logo_path
   end
 end

app/dashboards/department_dashboard.rb

@@ -19,6 +19,7 @@ class DepartmentDashboard < Administrate::BaseDashboard
     email: Field::String,
     file_configurations: Field::HasMany,
     invitations: Field::HasMany,
+    logo: Field::ActiveStorage.with_options(show_preview_variant: false),
     motif_categories: Field::HasMany,
     name: Field::String,
     number: Field::String,
@@ -64,6 +65,7 @@ class DepartmentDashboard < Administrate::BaseDashboard
     organisations
     created_at
     updated_at
+    logo
   ].freeze
 
   # FORM_ATTRIBUTES
@@ -79,6 +81,7 @@ class DepartmentDashboard < Administrate::BaseDashboard
     phone_number
     carnet_de_bord_deploiement_id
     display_in_stats
+    logo
   ].freeze
 
   # COLLECTION_FILTERS

app/dashboards/organisation_dashboard.rb

@@ -20,6 +20,7 @@ class OrganisationDashboard < Administrate::BaseDashboard
     invitations: Field::HasMany,
     last_webhook_update_received_at: Field::DateTime,
     lieux: Field::HasMany,
+    logo: Field::ActiveStorage.with_options(show_preview_variant: false),
     logo_filename: Field::String,
     messages_configuration: Field::HasOne,
     motif_categories: Field::HasMany,
@@ -63,13 +64,13 @@ class OrganisationDashboard < Administrate::BaseDashboard
     email
     safir_code
     independent_from_cd
-    logo_filename
     agent_roles
     lieux
     motif_categories
     created_at
     updated_at
     last_webhook_update_received_at
+    logo
   ].freeze
 
   # FORM_ATTRIBUTES
@@ -84,12 +85,13 @@ class OrganisationDashboard < Administrate::BaseDashboard
     email
     safir_code
     independent_from_cd
-    logo_filename
+    logo
   ].freeze
 
   FORM_ATTRIBUTES_NEW = %i[
     rdv_solidarites_organisation_id
     department
+    logo
   ].freeze
 
   # COLLECTION_FILTERS

app/helpers/pdf_helper.rb

@@ -1,8 +1,4 @@
 module PdfHelper
-  def logo_path(name, formats = [])
-    Logo.new(name).path(formats)
-  end
-
   def pdf_stylesheet_link_tag(source)
     if Rails.env.test?
       # wicked_pdf_stylesheet_link_tag produces prevents from forming a pdf in test

app/javascript/controllers/tooltip_controller.js

@@ -57,12 +57,6 @@ export default class extends Controller {
     });
   }
 
-  logoFilenameAttribute() {
-    tippy(this.element, {
-      content: "Renseigner le nom du logo sans l'extension du fichier (.png, .svg, .jpg)",
-    });
-  }
-
   senderCityAttribute() {
     tippy(this.element, {
       content:

app/mailers/invitation_mailer.rb

@@ -82,13 +82,15 @@ def set_signature_lines
   end
 
   def set_organisation_logo_path
-    return if @invitation.organisations.length != 1 || first_organisation.logo_path(%w[png jpg]).blank?
+    return if @invitation.organisations.length != 1 || first_organisation.logo.blank?
 
-    @organisation_logo_path = first_organisation.logo_path(%w[png jpg])
+    @organisation_logo_path = first_organisation.logo.url
   end
 
   def set_department_logo_path
-    @department_logo_path = @department.logo_path(%w[png jpg])
+    return if @department.logo.blank?
+
+    @department_logo_path = @department.logo.url
   end
 
   def set_rdv_title

app/mailers/notification_mailer.rb

@@ -114,11 +114,13 @@ def set_rdv_purpose
   end
 
   def set_organisation_logo_path
-    @organisation_logo_path = @rdv.organisation.logo_path(%w[png jpg])
+    return if @rdv.organisation.logo.blank?
+
+    @organisation_logo_path = @rdv.organisation.logo.url
   end
 
   def set_department_logo_path
-    @department_logo_path = @department.logo_path(%w[png jpg])
+    @department_logo_path = @department.logo.url
   end
 
   def rdv_by_phone?

app/models/concerns/attachment_validator.rb

@@ -0,0 +1,30 @@
+module AttachmentValidator
+  # to be included, this concern need the following things in the model :
+  # - a has_one_attached
+  # - a attachment method (an alias for the name of the has_one_attached)
+  # - a constant MAX_ATTACHMENT_SIZE
+  # - a constant MIME_TYPES
+  # - a constant ACCEPTED_FORMATS (an array of strings with the attachment extensions allowed by the MIME_TYPES )
+
+  extend ActiveSupport::Concern
+
+  included do
+    validate :attachment_size_validation, if: -> { attachment.present? }
+    validate :attachment_format_validation, if: -> { attachment.present? }
+  end
+
+  private
+
+  def attachment_size_validation
+    return unless attachment.blob.byte_size > self.class::MAX_ATTACHMENT_SIZE
+
+    # MAX_ATTACHMENT_SIZE must be in megabytes for the error message to be accurate
+    errors.add(:base, "Le fichier est trop volumineux (#{self.class::MAX_ATTACHMENT_SIZE.to_s[0...-6]}mo maximum)")
+  end
+
+  def attachment_format_validation
+    return if self.class::MIME_TYPES.include?(attachment.blob.content_type)
+
+    errors.add(:base, "Seuls les formats #{self.class::ACCEPTED_FORMATS.join(', ')} sont acceptés.")
+  end
+end

app/models/concerns/has_logo.rb

@@ -1,11 +1,20 @@
 module HasLogo
-  delegate :path, to: :logo, prefix: true
+  extend ActiveSupport::Concern
 
-  def logo
-    Logo.new(logo_name)
-  end
+  MAX_ATTACHMENT_SIZE = 2.megabytes
+
+  ACCEPTED_FORMATS = %w[PNG JPG].freeze
+
+  MIME_TYPES = [
+    "image/png",
+    "image/jpeg"
+  ].freeze
+
+  included do
+    include AttachmentValidator
+
+    has_one_attached :logo
 
-  def logo_name
-    respond_to?(:logo_filename) && logo_filename.present? ? logo_filename : name.parameterize
+    alias attachment logo
   end
 end

app/models/department.rb

@@ -1,7 +1,7 @@
 class Department < ApplicationRecord
   include HasLogo
 
-  validates :name, :capital, :number, :pronoun, :region, presence: true
+  validates :name, :capital, :number, :pronoun, :region, :logo, presence: true
 
   has_many :organisations, dependent: :nullify
   has_many :invitations, dependent: :nullify

app/models/parcours_document.rb

@@ -1,14 +1,7 @@
 class ParcoursDocument < ApplicationRecord
-  belongs_to :department
-  belongs_to :agent
-  belongs_to :user
-
-  has_one_attached :file
-
-  validates :file, presence: true
+  MAX_ATTACHMENT_SIZE = 5.megabytes
 
-  validate :file_size_validation
-  validate :file_format_validation
+  ACCEPTED_FORMATS = %w[PDF JPG PNG ODT DOC DOCX XLSX PPT ZIP].freeze
 
   MIME_TYPES = [
     "application/pdf",
@@ -27,19 +20,15 @@ class ParcoursDocument < ApplicationRecord
     "application/zip"
   ].freeze
 
-  MAX_FILE_SIZE = 5.megabytes
+  include AttachmentValidator
 
-  private
-
-  def file_size_validation
-    return unless file.blob.byte_size > MAX_FILE_SIZE
+  belongs_to :department
+  belongs_to :agent
+  belongs_to :user
 
-    errors.add(:base, "Le fichier est trop volumineux (5mo maximum)")
-  end
+  has_one_attached :file
 
-  def file_format_validation
-    return if MIME_TYPES.include?(file.blob.content_type)
+  validates :file, presence: true
 
-    errors.add(:base, "Seuls les formats PDF, JPG, PNG, ODT, DOCX, XLSX, PPT, DOC et ZIP sont acceptés.")
-  end
+  alias attachment file
 end