Browse Source

Maintenance: Renamed confusing fields in EmailAddresses table

The EmailAddress model is used to store email addresses used by the system.
It was using realname: field as a name while the rest of the system uses name: for, well, naming objects.
This commit renames email_addresses.realname to email_addresses.name for the sake of consistency.
Mantas Masalskis 1 year ago
parent
commit
e1cf198a70

+ 5 - 5
app/assets/javascripts/app/models/email_address.coffee

@@ -1,13 +1,13 @@
 class App.EmailAddress extends App.Model
-  @configure 'EmailAddress', 'realname', 'email', 'channel_id', 'note', 'active', 'updated_at'
+  @configure 'EmailAddress', 'name', 'email', 'channel_id', 'note', 'active', 'updated_at'
   @extend Spine.Model.Ajax
   @url: @apiPath + '/email_addresses'
 
   displayName: ->
-    if @realname
+    if @name
       # Do not use App.Utils.buildEmailAddress here because we don't build an email address and the
       #   quoting would confuse sorting in the GUI.
-      return "#{@realname} <#{@email}>"
+      return "#{@name} <#{@email}>"
     @email
 
   @filterChannel: (options, type, params) ->
@@ -29,7 +29,7 @@ class App.EmailAddress extends App.Model
     )
 
   @configure_attributes = [
-    { name: 'realname',   display: __('Display name'),  tag: 'input', type: 'text', limit: 250, null: false },
+    { name: 'name',   display: __('Display name'),  tag: 'input', type: 'text', limit: 250, null: false },
     { name: 'email',      display: __('Email'),     tag: 'input', type: 'email', limit: 250, null: false },
     { name: 'channel_id', display: __('Channel'),   tag: 'select', multiple: false, null: true, relation: 'Channel', nulloption: true, filter: @filterChannel, do_not_log: true },
     { name: 'note',       display: __('Note'),      tag: 'textarea', note: __('Notes are visible to agents only, never to customers.'), limit: 250, null: true },
@@ -37,5 +37,5 @@ class App.EmailAddress extends App.Model
     { name: 'active',     display: __('Active'),    tag: 'active',   readonly: 1 },
   ]
   @configure_overview = [
-    'realname', 'email'
+    'name', 'email'
   ]

+ 2 - 2
app/assets/javascripts/app/views/channel/email_account_overview.jst.eco

@@ -6,7 +6,7 @@
     <div class="action-block">
       <ul>
         <% for email_address in @accounts_fixed: %>
-          <li><%= email_address.realname %> &lt;<%= email_address.email %>&gt;
+          <li><%= email_address.name %> &lt;<%= email_address.email %>&gt;
         <% end %>
       </ul>
     </div>
@@ -25,7 +25,7 @@
       <% for email_address in @not_used_email_addresses: %>
         <li class="list-item" data-id="<%= email_address.id %>">
           <div class="list-item-name">
-            <a href="#" class="js-emailAddressEdit"><%= email_address.realname %> &lt;<%= email_address.email %>&gt;</a>
+            <a href="#" class="js-emailAddressEdit"><%= email_address.name %> &lt;<%= email_address.email %>&gt;</a>
           </div>
           <div class="list-item-delete js-emailAddressDelete">
             <%- @Icon('diagonal-cross') %>

+ 2 - 2
app/assets/javascripts/app/views/getting_started/email_pre_configured.jst.eco

@@ -7,7 +7,7 @@
         <p class="text-center"><%- @T('Your Zammad has the following email address:') %></p>
         <% if @addresses: %>
           <% for address in @addresses: %>
-          <p><%= address.realname %> &lt;<%= address.email %>&gt;</p>
+          <p><%= address.name %> &lt;<%= address.email %>&gt;</p>
           <% end %>
         <% end %>
         <p class="text-center"><%- @T('If you want to use additional email addresses, you can configure them later.') %></p>
@@ -18,4 +18,4 @@
       </div>
     </div>
   </form>
-</div>
+</div>

+ 1 - 1
app/assets/javascripts/app/views/google/list.jst.eco

@@ -18,7 +18,7 @@
       <% for email_address in @not_used_email_addresses: %>
         <li class="list-item" data-id="<%= email_address.id %>">
           <div class="list-item-name">
-            <a href="#" class="js-emailAddressEdit"><%= email_address.realname %> &lt;<%= email_address.email %>&gt;</a>
+            <a href="#" class="js-emailAddressEdit"><%= email_address.name %> &lt;<%= email_address.email %>&gt;</a>
           </div>
           <div class="list-item-delete js-emailAddressDelete">
             <%- @Icon('diagonal-cross') %>

+ 1 - 1
app/assets/javascripts/app/views/microsoft365/list.jst.eco

@@ -19,7 +19,7 @@
       <% for email_address in @not_used_email_addresses: %>
         <li class="list-item" data-id="<%= email_address.id %>">
           <div class="list-item-name">
-            <a href="#" class="js-emailAddressEdit"><%= email_address.realname %> &lt;<%= email_address.email %>&gt;</a>
+            <a href="#" class="js-emailAddressEdit"><%= email_address.name %> &lt;<%= email_address.email %>&gt;</a>
           </div>
           <div class="list-item-delete js-emailAddressDelete">
             <%- @Icon('diagonal-cross') %>

+ 2 - 2
app/controllers/channels_email_controller.rb

@@ -162,14 +162,14 @@ class ChannelsEmailController < ApplicationController
 
     if address
       address.update!(
-        realname:   params[:meta][:realname],
+        name:       params[:meta][:realname],
         email:      email,
         active:     true,
         channel_id: channel.id,
       )
     else
       EmailAddress.create(
-        realname:   params[:meta][:realname],
+        name:       params[:meta][:realname],
         email:      email,
         active:     true,
         channel_id: channel.id,

+ 7 - 7
app/controllers/email_addresses_controller.rb

@@ -11,7 +11,7 @@ JSON
 Example:
 {
   "id":1,
-  "realname":"some realname",
+  "name":"some realname",
   "email":"system@example.com",
   "updated_at":"2012-09-14T17:51:53Z",
   "created_at":"2012-09-14T17:51:53Z",
@@ -30,12 +30,12 @@ Response:
 [
   {
     "id": 1,
-    "realname":"some realname1",
+    "name":"some realname1",
     ...
   },
   {
     "id": 2,
-    "realname":"some realname2",
+    "name":"some realname2",
     ...
   }
 ]
@@ -77,7 +77,7 @@ POST /api/v1/email_addresses.json
 
 Payload:
 {
-  "realname":"some realname",
+  "name":"some realname",
   "email":"system@example.com",
   "note": "",
   "active":true,
@@ -86,7 +86,7 @@ Payload:
 Response:
 {
   "id": 1,
-  "realname":"some realname",
+  "name":"some realname",
   "email":"system@example.com",
   ...
 }
@@ -107,7 +107,7 @@ PUT /api/v1/email_addresses/{id}.json
 
 Payload:
 {
-  "realname":"some realname",
+  "name":"some realname",
   "email":"system@example.com",
   "note": "",
   "active":true,
@@ -116,7 +116,7 @@ Payload:
 Response:
 {
   "id": 1,
-  "realname":"some realname",
+  "name":"some realname",
   "email":"system@example.com",
   ...
 }

+ 1 - 1
app/graphql/gql/types/group_type.rb

@@ -26,7 +26,7 @@ module Gql::Types
 
       email_address = @object.email_address
 
-      { name: email_address.realname, email_address: email_address.email }
+      { name: email_address.name, email_address: email_address.email }
     end
   end
 end

+ 2 - 2
app/models/email_address.rb

@@ -6,8 +6,8 @@ class EmailAddress < ApplicationModel
 
   has_many        :groups, after_add: :cache_update, after_remove: :cache_update
   belongs_to      :channel, optional: true
-  validates       :realname, presence: true
-  validates       :email,    presence: true
+  validates       :name,    presence: true
+  validates       :email,   presence: true
 
   before_validation :check_email
   before_create   :check_if_channel_exists_set_inactive

+ 2 - 2
app/models/ticket/article/adds_metadata_email.rb

@@ -71,13 +71,13 @@ module Ticket::Article::AddsMetadataEmail
       case Setting.get('ticket_define_email_from')
       when 'AgentNameSystemAddressName'
         separator = Setting.get('ticket_define_email_from_separator')
-        return "#{created_by.firstname} #{created_by.lastname} #{separator} #{email_address.realname}"
+        return "#{created_by.firstname} #{created_by.lastname} #{separator} #{email_address.name}"
       when 'AgentName'
         return "#{created_by.firstname} #{created_by.lastname}"
       end
     end
 
-    email_address.realname
+    email_address.name
   end
 
   def metadata_email_process_from

Some files were not shown because too many files changed in this diff