Multilingual organization name (decidim#12681)

* Initial commit * More mailers fixed * Fix more specs * Lint * Fix more specs * refactor * Fix Specs * Fix specs * Fix more specs * Fix specs * lint * Remove helper methods * Add organization uniqueness validator * mark name as translattable * Fix more specs * Fix specs * Running lint * Fix specs * Apply suggestions from code review Co-authored-by: Andrés Pereira de Lucena <[email protected]> * use current_organization_name helper * Fis current_organization_name usage * Apply review recommendations * Update decidim-core/db/migrate/20240401192628_change_name_on_decidim_organizations.rb Co-authored-by: Andrés Pereira de Lucena <[email protected]> * Apply review recommendation * Apply review recommendations * Lint * Fix specs * Update decidim-system/app/forms/decidim/system/update_organization_form.rb Co-authored-by: Andrés Pereira de Lucena <[email protected]> * Fix failing specs * Fix edge case when Organization name is empty in update * Fix edge case --------- Co-authored-by: Andrés Pereira de Lucena <[email protected]>
OpenSourcePolitics · May 21, 2024 · cb466cb · cb466cb
1 parent 8afa643
commit cb466cb
Show file tree

Hide file tree

Showing 146 changed files with 662 additions and 351 deletions.
diff --git a/decidim-admin/app/forms/decidim/admin/organization_form.rb b/decidim-admin/app/forms/decidim/admin/organization_form.rb
@@ -10,7 +10,7 @@ class OrganizationForm < Form
 
       mimic :organization
 
-      attribute :name, String
+      translatable_attribute :name, String
       attribute :reference_prefix, String
       attribute :time_zone, String
       attribute :twitter_handler, String
@@ -37,7 +37,7 @@ class OrganizationForm < Form
 
       validates :welcome_notification_subject, :welcome_notification_body, translatable_presence: true, if: proc { |form| form.customize_welcome_notification }
 
-      validates :name, presence: true
+      validates :name, translatable_presence: true
       validates :time_zone, presence: true
       validates :time_zone, time_zone: true
       validates :default_locale, :reference_prefix, presence: true

diff --git a/decidim-admin/app/helpers/decidim/admin/moderations/reports_helper.rb b/decidim-admin/app/helpers/decidim/admin/moderations/reports_helper.rb
@@ -28,6 +28,8 @@ def reportable_author_name(reportable)
                     decidim_sanitize_translated(author.title)
                   end
                 end
+              when Decidim::Organization
+                content_tag :li, organization_name(author)
               else
                 content_tag(:li, author.name)
               end

diff --git a/decidim-admin/app/views/decidim/admin/dashboard/show.html.erb b/decidim-admin/app/views/decidim/admin/dashboard/show.html.erb
@@ -2,7 +2,7 @@
 
 <div class="item_show__header">
   <h1 class="item_show__header-title">
-  <%= t "decidim.admin.titles.dashboard" %> <%= current_organization.name %>
+  <%= t "decidim.admin.titles.dashboard" %> <%= current_organization_name %>
   </h1>
 </div>
 

diff --git a/decidim-admin/app/views/decidim/admin/organization/_form.html.erb b/decidim-admin/app/views/decidim/admin/organization/_form.html.erb
@@ -3,7 +3,7 @@
     <div class="card-section">
       <div class="row column">
         <div class="columns">
-          <%= form.text_field :name %>
+          <%= form.translated :text_field, :name %>
         </div>
 
         <div class="columns">

diff --git a/decidim-admin/app/views/layouts/decidim/admin/_application.html.erb b/decidim-admin/app/views/layouts/decidim/admin/_application.html.erb
@@ -1,5 +1,5 @@
 <% add_decidim_page_title(t("titles.panel", scope: "decidim.admin")) %>
-<% add_decidim_page_title(current_organization.name) %>
+<% add_decidim_page_title(current_organization_name) %>
 <!doctype html>
 <html class="no-js" lang="<%= I18n.locale %>" dir="<%= rtl_direction %>">
   <head>
@@ -21,9 +21,9 @@
         </div>
         <div class="relative md:flex grow min-h-max w-full">
           <div class="layout-nav">
-            <%= link_to decidim_admin.root_path, class: "logo hidden md:block", data: { "external-link": false }, aria: { label: t("decidim.accessibility.logo", organization: current_organization.name) } do %>
+            <%= link_to decidim_admin.root_path, class: "logo hidden md:block", data: { "external-link": false }, aria: { label: t("decidim.accessibility.logo", organization: current_organization_name) } do %>
               <% if current_organization.logo.present? %>
-                <%= image_tag current_organization.attached_uploader(:logo).path, alt: current_organization.name %>
+                <%= image_tag current_organization.attached_uploader(:logo).path, alt: current_organization_name %>
               <% else %>
                 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 134 109">
                   <g fill="#fff">

diff --git a/decidim-admin/app/views/layouts/decidim/admin/_title_bar.html.erb b/decidim-admin/app/views/layouts/decidim/admin/_title_bar.html.erb
@@ -1,7 +1,7 @@
 <div class="title-bar">
   <div class="layout-content__container">
     <span class="font-semibold text-sm">
-      <%= current_organization.name %>
+      <%= current_organization_name %>
     </span>
     <div class="tool-bar">
       <%= link_to decidim.root_path, class: "button__site", target: "_blank", data: { "external-link": false } do %>

diff --git a/decidim-admin/app/views/layouts/decidim/admin/_title_bar_responsive.html.erb b/decidim-admin/app/views/layouts/decidim/admin/_title_bar_responsive.html.erb
@@ -2,7 +2,7 @@
   <div class="layout-content__container">
     <a href="#menu" class="menu-trigger"><%= icon "menu-line", class: "fill-black" %></a>
     <span class="font-semibold text-sm">
-      <%= current_organization.name %>
+      <%= current_organization_name %>
     </span>
     <div class="tool-bar">
       <%= link_to decidim.root_path, class: "button__site", target: "_blank", data: { "external-link": false } do %>

diff --git a/decidim-admin/spec/commands/decidim/admin/update_organization_spec.rb b/decidim-admin/spec/commands/decidim/admin/update_organization_spec.rb
@@ -10,7 +10,7 @@ module Decidim::Admin
       let(:params) do
         {
           organization: {
-            name: "My super organization",
+            name: { en: "My super organization" },
             reference_prefix: "MSO",
             time_zone: "Hawaii",
             default_locale: "en",
@@ -48,7 +48,7 @@ module Decidim::Admin
           command.call
           organization.reload
 
-          expect(organization.name).not_to eq("My super organization")
+          expect(translated(organization.name)).not_to eq("My super organization")
         end
       end
 
@@ -74,7 +74,7 @@ module Decidim::Admin
           expect { command.call }.to broadcast(:ok)
           organization.reload
 
-          expect(organization.name).to eq("My super organization")
+          expect(translated(organization.name)).to eq("My super organization")
           expect(organization.rich_text_editor_in_public_views).to be(true)
           expect(organization.enable_machine_translations).to be(true)
         end

diff --git a/...dmin/spec/forms/organization_form_spec.rb → ...spec/forms/base_organization_form_spec.rb b/...dmin/spec/forms/organization_form_spec.rb → ...spec/forms/base_organization_form_spec.rb
@@ -11,7 +11,7 @@ module Admin
         )
       end
 
-      let(:name) { "My super organization" }
+      let(:name) { { ca: "", en: "My super organization", es: "" } }
       let(:reference_prefix) { "MSO" }
       let(:time_zone) { "UTC" }
       let(:twitter_handler) { "My twitter awesome handler" }

diff --git a/decidim-api/app/views/decidim/api/documentation/show.html.erb b/decidim-api/app/views/decidim/api/documentation/show.html.erb
@@ -1,7 +1,7 @@
 <div class="content">
   <div class="version">Decidim <%= Decidim.version %></div>
 
-  <h1><%= current_organization.name %> API documentation</h1>
+  <h1><%= current_organization_name %> API documentation</h1>
   <% if defined?(graphiql_path) %>
     <%= link_to "Explore the API interactively with GraphiQL", graphiql_path %>
   <% end %>

diff --git a/decidim-api/app/views/layouts/decidim/api/documentation.html.erb b/decidim-api/app/views/layouts/decidim/api/documentation.html.erb
@@ -1,6 +1,6 @@
 <html>
   <head>
-    <title><%= current_organization.name %> - API Documentation</title>
+    <title><%= current_organization_name %> - API Documentation</title>
     <%= stylesheet_pack_tag("decidim_api_docs") %>
   </head>
   <body>

diff --git a/decidim-api/spec/system/documentation_spec.rb b/decidim-api/spec/system/documentation_spec.rb
@@ -14,7 +14,7 @@
       visit decidim_api.documentation_path
 
       within "h1" do
-        expect(page).to have_content(organization.name)
+        expect(page).to have_content(translated(organization.name))
       end
       expect(page).to have_content("About the GraphQL API")
     end

diff --git a/decidim-blogs/app/helpers/decidim/blogs/admin/posts_helper.rb b/decidim-blogs/app/helpers/decidim/blogs/admin/posts_helper.rb
@@ -22,7 +22,7 @@ def post_description_admin(post, max_length = 100)
 
         def post_author_select_field(form, name, _options = {})
           select_options = [
-            [current_organization.name, ""],
+            [current_organization_name, ""],
             [current_user.name, current_user.id]
           ]
           current_user_groups = Decidim::UserGroups::ManageableUserGroups.for(current_user).verified

diff --git a/decidim-blogs/app/views/decidim/blogs/admin/posts/index.html.erb b/decidim-blogs/app/views/decidim/blogs/admin/posts/index.html.erb
@@ -33,7 +33,7 @@
               <%= decidim_sanitize_editor post_description_admin(post) %>
             </td>
             <td>
-              <%= post.try(:author).try(:name) %>
+              <%= translated_attribute(post.try(:author).try(:name)) %>
             </td>
             <% publish_data = publish_data(post.published_at) %>
             <td>

diff --git a/decidim-blogs/spec/helpers/decidim/blogs/admin/post_helper_spec.rb b/decidim-blogs/spec/helpers/decidim/blogs/admin/post_helper_spec.rb
@@ -20,15 +20,15 @@ module Decidim::Blogs::Admin
 
       let(:all_fields) do
         [
-          [organization.name, ""],
+          [translated(organization.name), ""],
           [user.name, user.id],
           [user_group.name, user_group.id]
         ]
       end
 
       let(:extra_user_fields) do
         [
-          [organization.name, ""],
+          [translated(organization.name), ""],
           [user.name, user.id],
           [user_group.name, user_group.id],
           [another_user.name, another_user.id]
@@ -37,7 +37,7 @@ module Decidim::Blogs::Admin
 
       let(:extra_group_fields) do
         [
-          [organization.name, ""],
+          [translated(organization.name), ""],
           [user.name, user.id],
           [user_group.name, user_group.id],
           [another_user_group.name, another_user_group.id]
@@ -46,7 +46,7 @@ module Decidim::Blogs::Admin
 
       let(:basic_fields) do
         [
-          [organization.name, ""],
+          [translated(organization.name), ""],
           [user.name, user.id]
         ]
       end

diff --git a/decidim-blogs/spec/shared/manage_posts_examples.rb b/decidim-blogs/spec/shared/manage_posts_examples.rb
@@ -15,7 +15,7 @@
     end
 
     within ".edit_post" do
-      expect(page).to have_select("post_decidim_author_id", selected: author.name)
+      expect(page).to have_select("post_decidim_author_id", selected: translated(author.name))
 
       fill_in_i18n(
         :post_title,
@@ -40,7 +40,7 @@
     within "table" do
       expect(page).to have_content("My new title")
       expect(page).to have_content("Post title 2")
-      expect(page).to have_content(author.name)
+      expect(page).to have_content(translated(author.name))
     end
   end
 
@@ -158,7 +158,7 @@
     it "can set organization as posts author" do
       click_on "New post"
 
-      select organization.name, from: "post_decidim_author_id"
+      select translated(organization.name), from: "post_decidim_author_id"
 
       fill_in_i18n(
         :post_title,
@@ -183,7 +183,7 @@
       expect(page).to have_admin_callout("successfully")
 
       within "table" do
-        expect(page).to have_content(author.name)
+        expect(page).to have_content(translated(organization.name))
         expect(page).to have_content("My post")
         expect(page).to have_content("Post title 1")
         expect(page).to have_content("Post title 2")
@@ -196,14 +196,14 @@
       end
 
       within ".edit_post" do
-        select organization.name, from: "post_decidim_author_id"
+        select translated(organization.name), from: "post_decidim_author_id"
         find("*[type=submit]").click
       end
 
       expect(page).to have_admin_callout("successfully")
 
       within "tr", text: translated(post1.title) do
-        expect(page).to have_content(author.name)
+        expect(page).to have_content(translated(organization.name))
       end
     end
   end

diff --git a/decidim-blogs/spec/system/explore_posts_spec.rb b/decidim-blogs/spec/system/explore_posts_spec.rb
@@ -112,7 +112,7 @@
       it "show post info" do
         expect(page).to have_i18n_content(post.title)
         expect(page).to have_i18n_content(post.body)
-        expect(page).to have_content(post.author.name)
+        expect(page).to have_content(translated(post.author.name))
         expect(page).to have_content(post.created_at.strftime("%d/%m/%Y %H:%M"))
       end
 

diff --git a/decidim-blogs/spec/types/integration_schema_spec.rb b/decidim-blogs/spec/types/integration_schema_spec.rb
@@ -29,7 +29,7 @@
           "id" => endo.author.id.to_s,
           "name" => endo.author.name,
           "nickname" => "@#{endo.author.nickname}",
-          "organizationName" => endo.author.organization.name,
+          "organizationName" => { "translation" => translated(endo.author.organization.name) },
           "profilePath" => "/profiles/#{endo.author.nickname}"
         }
       end,
@@ -98,7 +98,7 @@
                 deleted
                 name
                 nickname
-                organizationName
+                organizationName { translation(locale:"#{locale}") }
                 profilePath
                 __typename
               }
@@ -278,7 +278,7 @@
             deleted
             name
             nickname
-            organizationName
+            organizationName { translation(locale:"#{locale}") }
             profilePath
             __typename
           }

diff --git a/decidim-budgets/spec/mailers/decidim/budgets/order_summary_mailer_spec.rb b/decidim-budgets/spec/mailers/decidim/budgets/order_summary_mailer_spec.rb
@@ -19,7 +19,7 @@ module Decidim::Budgets
         end
 
         it "includes the organization data" do
-          expect(mail.body.encoded).to include(user.organization.name)
+          expect(mail.body.encoded).to include(translated(user.organization.name))
         end
 
         it "includes the budget title" do

diff --git a/decidim-budgets/spec/system/orders_spec.rb b/decidim-budgets/spec/system/orders_spec.rb
@@ -305,7 +305,7 @@
 
         expect(page).to have_content "€25,000,000"
 
-        page.find("header a", text: organization.name).click
+        page.find("header a", text: translated(organization.name)).click
 
         expect(page).to have_content "You have not yet voted"
 

diff --git a/...erences/app/views/decidim/conferences/admin/invite_join_conference_mailer/invite.html.erb b/...erences/app/views/decidim/conferences/admin/invite_join_conference_mailer/invite.html.erb
@@ -1,7 +1,7 @@
 <p class="email-greeting"><%= t("devise.mailer.invitation_instructions.hello", email: @user.name) %></p>
 
 <p class="email-instructions">
-  <%= t ".invited_existing_user_to_join_a_conference", invited_by: @invited_by.name, application: @user.organization.name %>
+  <%= t ".invited_existing_user_to_join_a_conference", invited_by: @invited_by.name, application: organization_name(@user.organization) %>
 </p>
 
 <p class="email-button email-button__cta cta-decline">

diff --git a/decidim-conferences/app/views/devise/mailer/join_conference.html.erb b/decidim-conferences/app/views/devise/mailer/join_conference.html.erb
@@ -1,7 +1,7 @@
 <p class="email-greeting"><%= t("devise.mailer.invitation_instructions.hello", email: @resource.name) %></p>
 
 <p class="email-instructions">
-  <%= t("decidim.conferences.admin.invite_join_conference_mailer.invite.invited_user_to_join_a_conference", invited_by: @resource.invited_by.name, application: @resource.organization.name) %>
+  <%= t("decidim.conferences.admin.invite_join_conference_mailer.invite.invited_user_to_join_a_conference", invited_by: @resource.invited_by.name, application: organization_name(@user.organization)) %>
 </p>
 
 <p class="email-button email-button__cta"><%= link_to t("devise.mailer.invitation_instructions.accept"), accept_invitation_url(@resource, invitation_token: @token, invite_redirect: Decidim::EngineRouter.main_proxy(@opts[:conference]).conference_registration_type_conference_registration_path(conference_slug: @opts[:conference], registration_type_id: @opts[:registration_type]), host: @resource.organization.host) %></p>

diff --git a/decidim-conferences/app/views/devise/mailer/join_conference.text.erb b/decidim-conferences/app/views/devise/mailer/join_conference.text.erb
@@ -1,6 +1,6 @@
 <%= t("devise.mailer.invitation_instructions.hello", email: @resource.name) %>
 
-<%= t("decidim.conferences.admin.invite_join_conference_mailer.invite.invited_existing_user_to_join_a_conference", invited_by: @resource.invited_by.name, application: @resource.organization.name) %>
+<%= t("decidim.conferences.admin.invite_join_conference_mailer.invite.invited_existing_user_to_join_a_conference", invited_by: @resource.invited_by.name, application: organization_name(@user.organization)) %>
 
 <%= link_to t("devise.mailer.invitation_instructions.accept"), accept_invitation_url(@resource, invitation_token: @token, invite_redirect: Decidim::EngineRouter.main_proxy(@opts[:conference]).conference_registration_type_conference_registration_path(conference_slug: @opts[:conference], registration_type_id: @opts[:registration_type]), host: @resource.organization.host) %>
 

diff --git a/decidim-core/app/cells/decidim/content_blocks/footer_sub_hero/show.erb b/decidim-core/app/cells/decidim/content_blocks/footer_sub_hero/show.erb
@@ -1,7 +1,7 @@
 <section id="footer_sub_hero" class="home__section text-center">
   <div class="flex justify-center mb-12">
     <h2 class="title-decorator">
-      <%= t("decidim.pages.home.footer_sub_hero.footer_sub_hero_headline", organization: current_organization.name) %>
+      <%= t("decidim.pages.home.footer_sub_hero.footer_sub_hero_headline", organization: current_organization_name) %>
     </h2>
   </div>
   <p class="text-lg text-gray-2">

diff --git a/decidim-core/app/cells/decidim/content_blocks/hero/show.erb b/decidim-core/app/cells/decidim/content_blocks/hero/show.erb
@@ -2,7 +2,7 @@
   <div class="hero">
     <h1 class="hero__title">
       <% if translated_welcome_text.blank? %>
-        <%= t("decidim.pages.home.hero.welcome", organization: current_organization.name) %>
+        <%= t("decidim.pages.home.hero.welcome", organization: current_organization_name) %>
       <% else %>
         <%= decidim_sanitize_admin translated_welcome_text %>
       <% end %>

diff --git a/decidim-core/app/cells/decidim/content_blocks/how_to_participate/show.erb b/decidim-core/app/cells/decidim/content_blocks/how_to_participate/show.erb
@@ -38,7 +38,7 @@
     </div>
   </div>
   <%= link_to decidim.pages_path, class: "button button__sm md:button__lg button__secondary mt-6" do %>
-    <%= t("more_info", scope: "decidim.pages.home.extended", resource_name: translated_attribute(current_organization.name, current_organization)) %>
+    <%= t("more_info", scope: "decidim.pages.home.extended", resource_name: current_organization_name) %>
     <%= icon "arrow-right-line", class: "fill-current" %>
   <% end %>
 </section>
diff --git a/decidim-core/app/cells/decidim/content_blocks/stats/show.erb b/decidim-core/app/cells/decidim/content_blocks/stats/show.erb
@@ -1,6 +1,6 @@
 <section id="statistics" class="home__section home__section-content-block">
   <h2 class="home__section-title mb-8">
-    <%= t("decidim.pages.home.statistics.headline", organization: current_organization.name) %>
+    <%= t("decidim.pages.home.statistics.headline", organization: current_organization_name) %>
   </h2>
 
   <%= cell("decidim/statistics", stats.highlighted + stats.not_highlighted) %>

diff --git a/decidim-core/app/cells/decidim/newsletter_templates/basic_only_text/show.erb b/decidim-core/app/cells/decidim/newsletter_templates/basic_only_text/show.erb
@@ -62,9 +62,9 @@
           <th class="small-12 first columns cityhall-bar">
             <div class="decidim-logo" style="float: right; text-align: right; padding-right: 16px">
               <% if custom_url_for_mail_root.present? %>
-                <%= link_to organization.name.html_safe, custom_url_for_mail_root %>
+                <%= link_to organization_name(organization).html_safe, custom_url_for_mail_root %>
               <% else %>
-                <%= link_to organization.name.html_safe, decidim.root_url(host: organization.host) %>
+                <%= link_to organization_name(organization).html_safe, decidim.root_url(host: organization.host) %>
               <% end %>
             </div>
           </th>

diff --git a/decidim-core/app/cells/decidim/newsletter_templates/image_text_cta/show.erb b/decidim-core/app/cells/decidim/newsletter_templates/image_text_cta/show.erb
@@ -101,9 +101,9 @@ table.button table td {
           <th class="small-12 first columns cityhall-bar">
             <div class="decidim-logo" style="float: right; text-align: right; padding-right: 16px">
               <% if custom_url_for_mail_root.present? %>
-                <%= link_to organization.name.html_safe, custom_url_for_mail_root %>
+                <%= link_to organization_name(organization).html_safe, custom_url_for_mail_root %>
               <% else %>
-                <%= link_to organization.name.html_safe, decidim.root_url(host: organization.host) %>
+                <%= link_to organization_name(organization).html_safe, decidim.root_url(host: organization.host) %>
               <% end %>
             </div>
           </th>

diff --git a/decidim-core/app/cells/decidim/pad_iframe/show.erb b/decidim-core/app/cells/decidim/pad_iframe/show.erb
@@ -8,7 +8,7 @@
         src="<%= iframe_url %>"
         style="border: solid 4px #fff; border-radius: 4px; box-shadow: 0 0 0 1px #e8e8e8; width: 100%; height: 600px">
       </iframe>
-      <p><%= t("decidim.pad_iframe.disclaimer", organization: current_organization.name) %></p>
+      <p><%= t("decidim.pad_iframe.disclaimer", organization: current_organization_name) %></p>
     </div>
   </div>
 </div>