From 5192ac052f7fb6d7fb88d7ea4cfc7fc634857e57 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Javi=20Mart=C3=ADn?= <javim@elretirao.net>
Date: Sun, 3 Nov 2019 16:47:21 +0100
Subject: [PATCH] Improve user interface showing a change log entry

Don't use <label> tags for things that are not labels, add a proper
<title> for the page, add a back link, remove an unnecessary
`inline-block` style for a header, localize dates and field names, ...

The interface could be further improve: proper diffs for long texts,
better separation between fields, ...
---
 app/helpers/audits_helper.rb         |  8 +++++--
 app/views/admin/audits/show.html.erb | 31 ++++++++++++++--------------
 config/locales/en/admin.yml          |  1 +
 config/locales/es/admin.yml          |  1 +
 4 files changed, 24 insertions(+), 17 deletions(-)

diff --git a/app/helpers/audits_helper.rb b/app/helpers/audits_helper.rb
index e69c65fa7..d5abfa98d 100644
--- a/app/helpers/audits_helper.rb
+++ b/app/helpers/audits_helper.rb
@@ -1,11 +1,15 @@
 module AuditsHelper
   def truncate_audit_value(resource, field, value)
+    truncate(audit_value(resource, field, value), length: 50)
+  end
+
+  def audit_value(resource, field, value)
     if value.is_a?(Array)
-      truncate(value.join(","), length: 50)
+      value.join(",")
     elsif resource.type_for_attribute(field.to_s).type == :boolean
       resource.class.human_attribute_name("#{field}_#{value}")
     else
-      truncate(value.to_s, length: 50)
+      value.to_s
     end
   end
 end
diff --git a/app/views/admin/audits/show.html.erb b/app/views/admin/audits/show.html.erb
index f788d2612..75f873936 100644
--- a/app/views/admin/audits/show.html.erb
+++ b/app/views/admin/audits/show.html.erb
@@ -1,19 +1,20 @@
-<h2 class="inline-block"><%= t("admin.audits.title") %></h2>
+<% provide(:title) do %>
+  <%= t("admin.audits.title") %>
+<% end %>
+<%= back_link_to polymorphic_path([:admin, *resource_hierarchy_for(@audit.associated || @audit.auditable)]) %>
 
-<label><strong><%= t("admin.audits.id") %></strong></label>
-<p><%= @audit.id %></p>
+<h2><%= t("admin.audits.title") %></h2>
+
+<p><strong><%= t("admin.audits.edited_at") %></strong> <%= l @audit.created_at.to_date %></p>
+<p><strong><%= t("admin.audits.edited_by") %></strong> <%= @audit.user&.name %></p>
+
+<h3><%= t("admin.audits.changes") %></h3>
 
 <% @audit.audited_changes.each do |field, (old_value, new_value)| %>
-  <label><strong><%= t("admin.audits.field") %></strong></label>
-  <p><%= field %></p>
-  <label><strong><%= t("admin.audits.old_value") %></strong></label>
-  <p><%= old_value %></p>
-  <label><strong><%= t("admin.audits.new_value") %></strong></label>
-  <p><%= new_value %></p>
+  <strong><%= t("admin.audits.field") %></strong>
+  <p><%= sanitize(@audit.auditable.class.human_attribute_name(field)) %></p>
+  <strong><%= t("admin.audits.old_value") %></strong>
+  <p><%= wysiwyg(audit_value(@audit.auditable, field, old_value)) %></p>
+  <strong><%= t("admin.audits.new_value") %></strong>
+  <p><%= wysiwyg(audit_value(@audit.auditable, field, new_value)) %></p>
 <% end %>
-
-<label><strong><%= t("admin.audits.edited_at") %></strong></label>
-<p><%= @audit.created_at.to_date %></p>
-<strong><%= t("admin.audits.edited_by") %></strong>
-<label><strong><%= t("admin.audits.edited_by") %></strong></label>
-<p><%= @audit.user&.name %></p>
diff --git a/config/locales/en/admin.yml b/config/locales/en/admin.yml
index 568a1410b..30d69b5d1 100644
--- a/config/locales/en/admin.yml
+++ b/config/locales/en/admin.yml
@@ -1583,6 +1583,7 @@ en:
         submit_card: Save card
     audits:
       title: "Change Log"
+      changes: "List of changes"
       id: "ID"
       field: "Field"
       new_value: "New Value"
diff --git a/config/locales/es/admin.yml b/config/locales/es/admin.yml
index 89eeeb289..256db29ec 100644
--- a/config/locales/es/admin.yml
+++ b/config/locales/es/admin.yml
@@ -1582,6 +1582,7 @@ es:
         submit_card: Guardar tarjeta
     audits:
       title: "Historial"
+      changes: "Lista de cambios"
       id: "ID"
       field: "Campo"
       new_value: "Valor nuevo"