From bbd558be7c307933a9ba385e475ba902cdf62f70 Mon Sep 17 00:00:00 2001
From: Finn Bacall <finn.bacall@manchester.ac.uk>
Date: Thu, 23 May 2024 17:29:10 +0100
Subject: [PATCH] Improve how entities rendered in previews.
 seek4science/seek#1895

---
 lib/ro_crate/ro-crate-preview.html.erb | 40 ++++++++++++++-------
 test/preview_test.rb                   | 48 ++++++++++++++++++++++++++
 2 files changed, 76 insertions(+), 12 deletions(-)
 create mode 100644 test/preview_test.rb
diff --git a/lib/ro_crate/ro-crate-preview.html.erb b/lib/ro_crate/ro-crate-preview.html.erb
index cea9075..a9fe05a 100644
--- a/lib/ro_crate/ro-crate-preview.html.erb
+++ b/lib/ro_crate/ro-crate-preview.html.erb
@@ -1,3 +1,23 @@
+<%
+  def entity_to_html(entity)
+    if entity.is_a?(Array)
+      if entity.length == 1
+        entity_to_html(entity.first)
+      else
+        "<ul><li>#{entity.map { |e| entity_to_html(e) }.join('</li><li>')}</li></ul>"
+      end
+    elsif entity.is_a?(ROCrate::Entity)
+      label = entity['name'] || entity.id
+      if entity.external?
+        "<a href=\"#{entity.id}\" target=\"_blank\">#{label}</a>"
+      else
+        label
+      end
+    else
+      entity
+    end
+  end
+%>
 <!DOCTYPE html>
 <html lang="en">
 <head>
@@ -18,36 +38,32 @@
   <dl>
     <% if author %>
       <dt>Author</dt>
-      <dd><%= author %></dd>
+      <dd><%= entity_to_html author %></dd>
     <% end %>
     <% if contact_point %>
       <dt>Contact</dt>
-      <dd><%= contact_point %></dd>
+      <dd><%= entity_to_html contact_point %></dd>
     <% end %>
     <% if publisher %>
       <dt>Publisher</dt>
-      <dd><%= publisher %></dd>
+      <dd><%= entity_to_html publisher %></dd>
     <% end %>
     <% if license %>
       <dt>License</dt>
-      <dd><%= license %></dd>
+      <dd><%= entity_to_html license %></dd>
     <% end %>
   </dl>
 
   <h2>Contents</h2>
   <ul>
     <% data_entities.each do |data_entity| %>
-      <li id="__data_entity_<%= data_entity.id.gsub(/\s/, '-') %>">
-        <% if data_entity.external? %>
-          <strong><a href="<%= data_entity.id %>" target="_blank"><%= data_entity.name || data_entity.id %></a></strong>
-        <% else %>
-          <strong><%= data_entity.name || data_entity.id %></strong>
-        <% end %>
+      <li>
+        <strong><%= entity_to_html data_entity %></strong>
         <% if data_entity.content_size %>
-          <br/>Size: <%= data_entity.content_size %>
+          <br/>Size: <%= entity_to_html data_entity.content_size %>
         <% end %>
         <% if data_entity.encoding_format %>
-          <br/>Format: <%= data_entity.encoding_format %>
+          <br/>Format: <%= entity_to_html data_entity.encoding_format %>
         <% end %>
       </li>
     <% end %>
diff --git a/test/preview_test.rb b/test/preview_test.rb
new file mode 100644
index 0000000..11d1f64
--- /dev/null
+++ b/test/preview_test.rb
@@ -0,0 +1,48 @@
+# encoding: utf-8
+require 'test_helper'
+
+class PreviewTest < Test::Unit::TestCase
+  test 'simple attributes' do
+    crate = ROCrate::Crate.new
+    crate.author = 'Finn'
+
+    html = crate.preview.source.read
+    assert_includes html, '<dd>Finn</dd>'
+  end
+
+  test 'list attributes' do
+    crate = ROCrate::Crate.new
+    crate.author = ['Finn', 'Josiah']
+
+    html = crate.preview.source.read
+    assert_includes html, '<dd><ul><li>Finn</li><li>Josiah</li></ul></dd>'
+  end
+
+  test 'entity attributes' do
+    crate = ROCrate::Crate.new
+    crate.author = crate.add_person('https://orcid.org/0000-0002-0048-3300', name: 'Finn')
+
+    html = crate.preview.source.read
+    assert_includes html, '<dd><a href="https://orcid.org/0000-0002-0048-3300" target="_blank">Finn</a></dd>'
+  end
+
+  test 'complex attributes' do
+    crate = ROCrate::Crate.new
+    crate.author = [crate.add_person('https://orcid.org/0000-0002-0048-3300', name: 'Finn'), 'Josiah']
+
+    html = crate.preview.source.read
+
+    assert_includes html, '<dd><ul><li><a href="https://orcid.org/0000-0002-0048-3300" target="_blank">Finn</a></li><li>Josiah</li></ul></dd>'
+  end
+
+  test 'files' do
+    crate = ROCrate::Crate.new
+    crate.add_file(fixture_file('info.txt'))
+    crate.add_external_file('https://raw.githubusercontent.com/ResearchObject/ro-crate-ruby/master/README.md')
+
+    html = crate.preview.source.read
+
+    assert_includes html, '<strong>info.txt</strong>'
+    assert_includes html, '<strong><a href="https://raw.githubusercontent.com/ResearchObject/ro-crate-ruby/master/README.md" target="_blank">https://raw.githubusercontent.com/ResearchObject/ro-crate-ruby/master/README.md</a></strong>'
+  end
+end
