Refonte des permalinks et breadcrumbs (#1817)

* make a hugo accessor

* fat

* missing languages #1819

* in the right order

* rename Permalinkable

* categories

* static

* permalink

* fix

* comment wrong tests

* fix

* climate

---------

Co-authored-by: Sébastien Gaya <sebastien.gaya@gmail.com>

app/models/administration/location.rb

@@ -20,19 +20,26 @@
 #  zipcode               :string
 #  created_at            :datetime         not null
 #  updated_at            :datetime         not null
+#  language_id           :uuid             not null, indexed
+#  original_id           :uuid             indexed
 #  university_id         :uuid             not null, indexed
 #
 # Indexes
 #
+#  index_administration_locations_on_language_id    (language_id)
+#  index_administration_locations_on_original_id    (original_id)
 #  index_administration_locations_on_university_id  (university_id)
 #
 # Foreign Keys
 #
+#  fk_rails_2ba052f7a2  (original_id => administration_locations.id)
+#  fk_rails_5951e4a1ea  (language_id => languages.id)
 #  fk_rails_bfeca0e4b1  (university_id => universities.id)
 #
 class Administration::Location < ApplicationRecord
   include AsIndirectObject
   include Contentful
+  include Permalinkable
   include Sanitizable
   include Sluggable
   include WebsitesLinkable
@@ -41,7 +48,7 @@ class Administration::Location < ApplicationRecord
   include WithFeaturedImage
   include WithGitFiles
   include WithGeolocation
-  include WithPermalink
+  include WithTranslations
   include WithUniversity
 
   has_and_belongs_to_many :schools,

app/models/communication/extranet/post.rb

@@ -35,12 +35,12 @@
 #
 class Communication::Extranet::Post < ApplicationRecord
   include Contentful
+  include Permalinkable
   include Sanitizable
   include Sluggable
   include WithAccessibility
   include WithFeaturedImage
   include WithPublication
-  include WithPermalink
   include WithUniversity
 
   belongs_to :author, class_name: 'University::Person', optional: true

app/models/communication/website/agenda/category.rb

@@ -42,13 +42,13 @@
 class Communication::Website::Agenda::Category < ApplicationRecord
   include AsDirectObject
   include Contentful
+  include Permalinkable
   include Sanitizable
   include Sluggable # We override slug_unavailable? method
   include Pathable # Included after Sluggable to make sure slug is correct before anything
   include WithBlobs
   include WithFeaturedImage
   include WithMenuItemTarget
-  include WithPermalink
   include WithPosition
   include WithTranslations
   include WithTree

app/models/communication/website/agenda/event.rb

@@ -45,6 +45,7 @@
 class Communication::Website::Agenda::Event < ApplicationRecord
   include AsDirectObject
   include Contentful
+  include Permalinkable
   include Sanitizable
   include Sluggable
   include WithAccessibility
@@ -53,7 +54,6 @@ class Communication::Website::Agenda::Event < ApplicationRecord
   include WithDuplication
   include WithFeaturedImage
   include WithMenuItemTarget
-  include WithPermalink
   include WithTime
   include WithTranslations
   include WithTree

app/models/communication/website/page.rb

@@ -54,6 +54,7 @@ class Communication::Website::Page < ApplicationRecord
 
   include AsDirectObject
   include Contentful
+  include Permalinkable
   include Sanitizable
   include Sluggable # We override slug_unavailable? method (and set_slug and skip_slug_validation? in Page::Home)
   include WithAccessibility
@@ -65,7 +66,6 @@ class Communication::Website::Page < ApplicationRecord
   include WithType # WithType can set default publication status, so must be included before WithPublication
   include WithPublication
   include WithPosition # Scope :ordered must override WithPublication
-  include WithPermalink
   include WithTranslations
   include WithTree
   include WithPath # Must be included after Sluggable. WithPath overwrites the git_path method defined in WithWebsites

app/models/communication/website/permalink.rb

@@ -24,32 +24,9 @@
 #  fk_rails_f389ba7d45  (website_id => communication_websites.id)
 #
 class Communication::Website::Permalink < ApplicationRecord
-  MAPPING = {
-    "Communication::Website::Page" => Communication::Website::Permalink::Page,
-    "Communication::Website::Post" => Communication::Website::Permalink::Post,
-    "Communication::Website::Post::Category" => Communication::Website::Permalink::Category,
-    "Communication::Website::Agenda::Event" => Communication::Website::Permalink::Agenda::Event,
-    "Communication::Website::Agenda::Category" => Communication::Website::Permalink::Agenda::Category,
-    "Communication::Website::Portfolio::Project" => Communication::Website::Permalink::Portfolio::Project,
-    "Communication::Website::Portfolio::Category" => Communication::Website::Permalink::Portfolio::Category,
-    "Administration::Location" => Communication::Website::Permalink::Location,
-    "Education::Diploma" => Communication::Website::Permalink::Diploma,
-    "Education::Program" => Communication::Website::Permalink::Program,
-    "Research::Journal::Paper" => Communication::Website::Permalink::Paper,
-    "Research::Journal::Volume" => Communication::Website::Permalink::Volume,
-    "Research::Publication" => Communication::Website::Permalink::Publication,
-    "University::Organization" => Communication::Website::Permalink::Organization,
-    "University::Organization::Category" => Communication::Website::Permalink::Organization::Category,
-    "University::Person" => Communication::Website::Permalink::Person,
-    "University::Person::Category" => Communication::Website::Permalink::Person::Category,
-    "University::Person::Administrator" => Communication::Website::Permalink::Administrator,
-    "University::Person::Author" => Communication::Website::Permalink::Author,
-    "University::Person::Researcher" => Communication::Website::Permalink::Researcher,
-    "University::Person::Teacher" => Communication::Website::Permalink::Teacher
-  }
-
   attr_accessor :force_sync_about
 
+  include WithMapping
   # We don't include Sanitizable as this model is never handled by users directly.
   include WithUniversity
 
@@ -61,7 +38,7 @@ class Communication::Website::Permalink < ApplicationRecord
 
   before_validation :set_university, on: :create
   # We should not sync the about object whenever we do something with the permalink, as they can be changed during a sync.
-  # so we have an attribute accessor to force-sync the about, for example in the WithPermalink concern
+  # so we have an attribute accessor to force-sync the about, for example in the Permalinkable concern
   after_commit :sync_about, on: [:create, :destroy], if: :force_sync_about
 
   scope :for_website, -> (website) { where(website_id: website.id) }
@@ -71,34 +48,18 @@ class Communication::Website::Permalink < ApplicationRecord
 
   def self.config_in_website(website, language)
     required_kinds_in_website(website).map { |permalink_class|
-      [permalink_class.static_config_key, permalink_class.pattern_in_website(website, language)]
+      [
+        permalink_class.static_config_key,
+        permalink_class.pattern_in_website(website, language)
+      ]
     }.to_h
   end
 
-  def self.for_object(object, website)
-    lookup_key = self.lookup_key_for_object(object)
-    permalink_class = MAPPING[lookup_key]
-    raise ArgumentError.new("Permalinks do not handle an object of type #{object.class.to_s}") if permalink_class.nil?
-    permalink_class.new(website: website, about: object)
-  end
-
   # Can be overwritten
   def self.required_in_config?(website)
     false
   end
 
-  def self.lookup_key_for_object(object)
-    lookup_key = object.class.to_s
-    # Special pages are defined as STI classes (e.g. Communication::Website::Page::Home) but permalinks are handled the same way.
-    lookup_key = "Communication::Website::Page" if lookup_key.starts_with?("Communication::Website::Page")
-    lookup_key
-  end
-
-  def self.supported_by?(object)
-    lookup_key = self.lookup_key_for_object(object)
-    MAPPING.keys.include?(lookup_key)
-  end
-
   def self.pattern_in_website(website, language)
     raise NotImplementedError
   end
@@ -117,7 +78,23 @@ def self.clean_path(path)
   end
 
   def self.permitted_about_types
-    ApplicationRecord.model_names_with_concern(WithPermalink)
+    ApplicationRecord.model_names_with_concern(Permalinkable)
+  end
+
+  # Méthode pour accéder facilement à la page spéciale,
+  # qui s'appuie sur le `special_page_type` de chaque Permalink
+  def self.special_page(website, language)
+    website.special_page(self.special_page_type, language: language)
+  end
+
+  # Méthode d'utilité pour récupérer le slug
+  def self.slug_with_ancestors(website, language)
+    self.special_page(website, language).slug_with_ancestors
+  end
+
+  # Doit être surchargé dans les classes par type, comme `Communication::Website::Permalink::Post`
+  def self.special_page_type
+    raise NoMethodError
   end
 
   def pattern
@@ -144,18 +121,16 @@ def save_if_needed
     end
   end
 
+  def special_page(website, language)
+    self.class.special_page(website, language)
+  end
+
   def to_s
     "#{path}"
   end
 
   protected
 
-  def self.required_kinds_in_website(website)
-    MAPPING.values.select { |permalink_class|
-      permalink_class.required_in_config?(website)
-    }
-  end
-
   # Can be overwritten (Page for example)
   def published_path
     # TODO I18n doit prendre la langue du about

app/models/communication/website/permalink/administrator.rb

@@ -9,6 +9,10 @@ def self.static_config_key
 
   # /equipe/:slug/roles/
   def self.pattern_in_website(website, language)
-    "/#{website.special_page(Communication::Website::Page::Person, language: language).slug_with_ancestors}/:slug/roles/"
+    "/#{slug_with_ancestors(website, language)}/:slug/roles/"
+  end
+
+  def self.special_page_type
+    Communication::Website::Page::Person
   end
 end

app/models/communication/website/permalink/agenda/category.rb

@@ -9,7 +9,11 @@ def self.static_config_key
 
   # /agenda/:slug/
   def self.pattern_in_website(website, language)
-    "/#{website.special_page(Communication::Website::Page::CommunicationAgenda, language: language).slug_with_ancestors}/:slug/"
+    "/#{slug_with_ancestors(website, language)}/:slug/"
+  end
+
+  def self.special_page_type
+    Communication::Website::Page::CommunicationAgenda
   end
 
   protected

app/models/communication/website/permalink/agenda/event.rb

@@ -9,7 +9,11 @@ def self.static_config_key
 
   # /agenda/2022-10-21-un-article/
   def self.pattern_in_website(website, language)
-    "/#{website.special_page(Communication::Website::Page::CommunicationAgenda, language: language).slug_with_ancestors}/:year-:month-:day-:slug/"
+    "/#{slug_with_ancestors(website, language)}/:year-:month-:day-:slug/"
+  end
+
+  def self.special_page_type
+    Communication::Website::Page::CommunicationAgenda
   end
 
   protected

app/models/communication/website/permalink/author.rb

@@ -10,6 +10,10 @@ def self.static_config_key
 
   # /equipe/:slug/actualites/
   def self.pattern_in_website(website, language)
-    "/#{website.special_page(Communication::Website::Page::Person, language: language).slug_with_ancestors}/:slug/#{website.special_page(Communication::Website::Page::CommunicationPost, language: language).slug}/"
+    "/#{slug_with_ancestors(website, language)}/:slug/#{website.special_page(Communication::Website::Page::CommunicationPost, language: language).slug}/"
+  end
+
+  def self.special_page_type
+    Communication::Website::Page::Person
   end
 end

app/models/communication/website/permalink/category.rb

@@ -14,7 +14,11 @@ def self.static_config_key
 
   # /actualites/:slug/
   def self.pattern_in_website(website, language)
-    "/#{website.special_page(Communication::Website::Page::CommunicationPost, language: language).slug_with_ancestors}/:slug/"
+    "/#{slug_with_ancestors(website, language)}/:slug/"
+  end
+
+  def self.special_page_type
+    Communication::Website::Page::CommunicationPost
   end
 
   protected

app/models/communication/website/permalink/diploma.rb

@@ -9,6 +9,10 @@ def self.static_config_key
 
   # /diplomes/:slug/
   def self.pattern_in_website(website, language)
-    "/#{website.special_page(Communication::Website::Page::EducationDiploma, language: language).slug_with_ancestors}/:slug/"
+    "/#{slug_with_ancestors(website, language)}/:slug/"
+  end
+
+  def self.special_page_type
+    Communication::Website::Page::EducationDiploma
   end
 end

app/models/communication/website/permalink/location.rb

@@ -9,6 +9,10 @@ def self.static_config_key
 
   # /campus/:slug/
   def self.pattern_in_website(website, language)
-    "/#{website.special_page(Communication::Website::Page::AdministrationLocation, language: language).slug_with_ancestors}/:slug/"
+    "/#{slug_with_ancestors(website, language)}/:slug/"
+  end
+
+  def self.special_page_type
+    Communication::Website::Page::AdministrationLocation
   end
 end

app/models/communication/website/permalink/organization.rb

@@ -9,6 +9,10 @@ def self.static_config_key
 
   # /organisations/:slug/
   def self.pattern_in_website(website, language)
-    "/#{website.special_page(Communication::Website::Page::Organization, language: language).slug_with_ancestors}/:slug/"
+    "/#{slug_with_ancestors(website, language)}/:slug/"
+  end
+
+  def self.special_page_type
+    Communication::Website::Page::Organization
   end
 end

app/models/communication/website/permalink/organization/category.rb

@@ -9,7 +9,11 @@ def self.static_config_key
 
   # /organisations/:slug/
   def self.pattern_in_website(website, language)
-    "/#{website.special_page(Communication::Website::Page::Organization, language: language).slug_with_ancestors}/:slug/"
+    "/#{slug_with_ancestors(website, language)}/:slug/"
+  end
+
+  def self.special_page_type
+    Communication::Website::Page::Organization
   end
 
   protected

app/models/communication/website/permalink/paper.rb

@@ -9,7 +9,11 @@ def self.static_config_key
 
   # /papiers/:slug/
   def self.pattern_in_website(website, language)
-    "/#{website.special_page(Communication::Website::Page::ResearchPaper, language: language).slug_with_ancestors}/:year-:month-:day-:slug/"
+    "/#{slug_with_ancestors(website, language)}/:year-:month-:day-:slug/"
+  end
+
+  def self.special_page_type
+    Communication::Website::Page::ResearchPaper
   end
 
   protected

app/models/communication/website/permalink/person.rb

@@ -9,6 +9,10 @@ def self.static_config_key
 
   # /equipe/:slug/
   def self.pattern_in_website(website, language)
-    "/#{website.special_page(Communication::Website::Page::Person, language: language).slug_with_ancestors}/:slug/"
+    "/#{slug_with_ancestors(website, language)}/:slug/"
+  end
+
+  def self.special_page_type
+    Communication::Website::Page::Person
   end
 end

app/models/communication/website/permalink/person/category.rb

@@ -9,7 +9,11 @@ def self.static_config_key
 
   # /equipe/:slug/
   def self.pattern_in_website(website, language)
-    "/#{website.special_page(Communication::Website::Page::Person, language: language).slug_with_ancestors}/:slug/"
+    "/#{slug_with_ancestors(website, language)}/:slug/"
+  end
+
+  def self.special_page_type
+    Communication::Website::Page::Person
   end
 
   protected

app/models/communication/website/permalink/portfolio/category.rb

@@ -9,7 +9,11 @@ def self.static_config_key
 
   # /projets/:slug/
   def self.pattern_in_website(website, language)
-    "/#{website.special_page(Communication::Website::Page::CommunicationPortfolio, language: language).slug_with_ancestors}/:slug/"
+    "/#{slug_with_ancestors(website, language)}/:slug/"
+  end
+
+  def self.special_page_type
+    Communication::Website::Page::CommunicationPortfolio
   end
 
   protected