From 9a4aba8d1c3b7b4928fa328349ca95278b2d6887 Mon Sep 17 00:00:00 2001
From: Gareth Rees <gareth@garethrees.co.uk>
Date: Wed, 7 Feb 2024 12:56:30 +0000
Subject: [PATCH 1/3] Render an icon depicting citation type

This information isn't really important enough individually (it's more
useful when looked at as a whole), but fun to know what's being linked
to, so add a little visual interest to display this.
---
 app/helpers/admin/citations_helper.rb       | 17 +++++++++++++
 app/helpers/admin_helper.rb                 |  1 +
 app/views/admin/citations/_list.html.erb    |  1 +
 spec/helpers/admin/citations_helper_spec.rb | 27 +++++++++++++++++++++
 4 files changed, 46 insertions(+)
 create mode 100644 app/helpers/admin/citations_helper.rb
 create mode 100644 spec/helpers/admin/citations_helper_spec.rb

diff --git a/app/helpers/admin/citations_helper.rb b/app/helpers/admin/citations_helper.rb
new file mode 100644
index 0000000000..bc0bf191e6
--- /dev/null
+++ b/app/helpers/admin/citations_helper.rb
@@ -0,0 +1,17 @@
+# Helpers for displaying Citations in the admin interface
+module Admin::CitationsHelper
+  ICONS = {
+    news_story: '🗞️',
+    academic_paper: '🎓',
+    other: '🌐'
+  }.with_indifferent_access.freeze
+
+  def citation_icon(citation)
+    html_attrs = {
+      title: citation.type.humanize,
+      class: "citation-icon citation-icon--#{citation.type}"
+    }
+
+    tag.span(ICONS.fetch(citation.type), **html_attrs)
+  end
+end
diff --git a/app/helpers/admin_helper.rb b/app/helpers/admin_helper.rb
index b8fe71a8a3..27069eec66 100644
--- a/app/helpers/admin_helper.rb
+++ b/app/helpers/admin_helper.rb
@@ -1,6 +1,7 @@
 module AdminHelper
   include Admin::BootstrapHelper
   include Admin::CensorRulesHelper
+  include Admin::CitationsHelper
   include Admin::LinkHelper
   include Admin::ProminenceHelper
 
diff --git a/app/views/admin/citations/_list.html.erb b/app/views/admin/citations/_list.html.erb
index c594b4ad65..d620a9b7f7 100644
--- a/app/views/admin/citations/_list.html.erb
+++ b/app/views/admin/citations/_list.html.erb
@@ -3,6 +3,7 @@
     <% citations.each do |citation| %>
       <div class="row">
         <span class="item-title span6">
+          <%= citation_icon(citation) %>
           <tt><%= link_to citation.source_url, citation.source_url %></tt>
         </span>
 
diff --git a/spec/helpers/admin/citations_helper_spec.rb b/spec/helpers/admin/citations_helper_spec.rb
new file mode 100644
index 0000000000..c7cb28167b
--- /dev/null
+++ b/spec/helpers/admin/citations_helper_spec.rb
@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+RSpec.describe Admin::CitationsHelper do
+  include Admin::CitationsHelper
+
+  describe '#citation_icon' do
+    subject { citation_icon(citation) }
+
+    context 'with a news story' do
+      let(:citation) { FactoryBot.build(:citation, type: 'news_story') }
+      it { is_expected.to include('🗞️') }
+      it { is_expected.to include('citation-icon--news_story') }
+    end
+
+    context 'with an academic paper' do
+      let(:citation) { FactoryBot.build(:citation, type: 'academic_paper') }
+      it { is_expected.to include('🎓') }
+      it { is_expected.to include('citation-icon--academic_paper') }
+    end
+
+    context 'with a generic link' do
+      let(:citation) { FactoryBot.build(:citation, type: 'other') }
+      it { is_expected.to include('🌐') }
+      it { is_expected.to include('citation-icon--other') }
+    end
+  end
+end

From 84cf979e018683a114800150d235c3e6385052cb Mon Sep 17 00:00:00 2001
From: Gareth Rees <gareth@garethrees.co.uk>
Date: Fri, 9 Feb 2024 16:37:07 +0000
Subject: [PATCH 2/3] Broaden Citation#type classifications

We care more about the general grouping rather than a citation being
e.g. specifically an academic _paper_. It could be some other generally
academic research that we'd want to track.
---
 app/helpers/admin/citations_helper.rb         |  4 ++--
 app/models/citation.rb                        |  2 +-
 app/views/citations/new.html.erb              | 12 +++++-----
 ...40209162933_change_citation_type_values.rb | 22 +++++++++++++++++++
 doc/CHANGES.md                                |  2 ++
 spec/controllers/citations_controller_spec.rb |  2 +-
 spec/helpers/admin/citations_helper_spec.rb   | 12 +++++-----
 spec/models/citation_spec.rb                  |  4 ++--
 8 files changed, 42 insertions(+), 18 deletions(-)
 create mode 100644 db/migrate/20240209162933_change_citation_type_values.rb

diff --git a/app/helpers/admin/citations_helper.rb b/app/helpers/admin/citations_helper.rb
index bc0bf191e6..316d65b9f5 100644
--- a/app/helpers/admin/citations_helper.rb
+++ b/app/helpers/admin/citations_helper.rb
@@ -1,8 +1,8 @@
 # Helpers for displaying Citations in the admin interface
 module Admin::CitationsHelper
   ICONS = {
-    news_story: '🗞️',
-    academic_paper: '🎓',
+    journalism: '🗞️',
+    academic: '🎓',
     other: '🌐'
   }.with_indifferent_access.freeze
 
diff --git a/app/models/citation.rb b/app/models/citation.rb
index 8758f522fb..a9aa4e359b 100644
--- a/app/models/citation.rb
+++ b/app/models/citation.rb
@@ -29,7 +29,7 @@ class Citation < ApplicationRecord
                                    message: _('Source URL is too long') },
                          format: { with: /\Ahttps?:\/\/.*\z/,
                                    message: _('Please enter a Source URL') }
-  validates :type, inclusion: { in: %w(news_story academic_paper other),
+  validates :type, inclusion: { in: %w(journalism academic other),
                                 message: _('Please select a type') }
 
   scope :newest, ->(limit = 1) do
diff --git a/app/views/citations/new.html.erb b/app/views/citations/new.html.erb
index e5dd283201..de87a069df 100644
--- a/app/views/citations/new.html.erb
+++ b/app/views/citations/new.html.erb
@@ -23,14 +23,14 @@
       <%= _('What type of article is it?') %>
     </span>
 
-    <label for="citation_type_news_story" class="form_label">
-      <%= f.radio_button :type, 'news_story' %>
-      <%= _('News story') %>
+    <label for="citation_type_journalism" class="form_label">
+      <%= f.radio_button :type, 'journalism' %>
+      <%= _('Journalism') %>
     </label>
 
-    <label for="citation_type_academic_paper" class="form_label">
-      <%= f.radio_button :type, 'academic_paper' %>
-      <%= _('Academic paper') %>
+    <label for="citation_type_academic" class="form_label">
+      <%= f.radio_button :type, 'academic' %>
+      <%= _('Academic') %>
     </label>
 
     <label for="citation_type_other" class="form_label">
diff --git a/db/migrate/20240209162933_change_citation_type_values.rb b/db/migrate/20240209162933_change_citation_type_values.rb
new file mode 100644
index 0000000000..80ea2f7206
--- /dev/null
+++ b/db/migrate/20240209162933_change_citation_type_values.rb
@@ -0,0 +1,22 @@
+class ChangeCitationTypeValues < ActiveRecord::Migration[7.0]
+  CHANGES = {
+    'news_story' => 'journalism',
+    'academic_paper' => 'academic'
+  }
+
+  def up
+    perform(CHANGES)
+  end
+
+  def down
+    perform(CHANGES.invert)
+  end
+
+  private
+
+  def perform(data)
+    data.each_pair do |before, after|
+      Citation.where(type: before).update_all(type: after)
+    end
+  end
+end
diff --git a/doc/CHANGES.md b/doc/CHANGES.md
index 4bd9745911..2f7734862f 100644
--- a/doc/CHANGES.md
+++ b/doc/CHANGES.md
@@ -2,6 +2,8 @@
 
 ## Highlighted Features
 
+* Broaden citation type classifications to cover wider thematic areas (Gareth
+  Rees)
 * Reduce amount of storage related background jobs (Graeme Porteous)
 * Add automatic parsing of emails contain Excel spreadsheets (Graeme Porteous)
 * Improve rendering of admin hidden request prominence and explanations (Graeme
diff --git a/spec/controllers/citations_controller_spec.rb b/spec/controllers/citations_controller_spec.rb
index 6b262cac2a..bc39876f76 100644
--- a/spec/controllers/citations_controller_spec.rb
+++ b/spec/controllers/citations_controller_spec.rb
@@ -129,7 +129,7 @@ def action
       end
 
       let(:params) do
-        { source_url: 'http://example.com/news', type: 'news_story' }
+        { source_url: 'http://example.com/news', type: 'journalism' }
       end
       let(:apply_to_batch) { nil }
 
diff --git a/spec/helpers/admin/citations_helper_spec.rb b/spec/helpers/admin/citations_helper_spec.rb
index c7cb28167b..1e31a47fa8 100644
--- a/spec/helpers/admin/citations_helper_spec.rb
+++ b/spec/helpers/admin/citations_helper_spec.rb
@@ -6,16 +6,16 @@
   describe '#citation_icon' do
     subject { citation_icon(citation) }
 
-    context 'with a news story' do
-      let(:citation) { FactoryBot.build(:citation, type: 'news_story') }
+    context 'with a journalism link' do
+      let(:citation) { FactoryBot.build(:citation, type: 'journalism') }
       it { is_expected.to include('🗞️') }
-      it { is_expected.to include('citation-icon--news_story') }
+      it { is_expected.to include('citation-icon--journalism') }
     end
 
-    context 'with an academic paper' do
-      let(:citation) { FactoryBot.build(:citation, type: 'academic_paper') }
+    context 'with an academic link' do
+      let(:citation) { FactoryBot.build(:citation, type: 'academic') }
       it { is_expected.to include('🎓') }
-      it { is_expected.to include('citation-icon--academic_paper') }
+      it { is_expected.to include('citation-icon--academic') }
     end
 
     context 'with a generic link' do
diff --git a/spec/models/citation_spec.rb b/spec/models/citation_spec.rb
index 031dc17ab4..64a018586a 100644
--- a/spec/models/citation_spec.rb
+++ b/spec/models/citation_spec.rb
@@ -199,9 +199,9 @@ def setup_for_x_scope_data
     it 'requires known type' do
       citation.type = 'foobar'
       is_expected.not_to be_valid
-      citation.type = 'news_story'
+      citation.type = 'journalism'
       is_expected.to be_valid
-      citation.type = 'academic_paper'
+      citation.type = 'academic'
       is_expected.to be_valid
       citation.type = 'other'
       is_expected.to be_valid

From 7af5fff93bafd2f94dac3836455fc51c37b3309c Mon Sep 17 00:00:00 2001
From: Gareth Rees <gareth@garethrees.co.uk>
Date: Fri, 9 Feb 2024 16:44:50 +0000
Subject: [PATCH 3/3] Add "campaigning" Citation#type
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

We're missing this from our three main Pro audiences – journalists,
campaigners and researchers.
---
 app/helpers/admin/citations_helper.rb | 1 +
 app/models/citation.rb                | 2 +-
 app/views/citations/new.html.erb      | 5 +++++
 doc/CHANGES.md                        | 4 ++--
 spec/models/citation_spec.rb          | 2 ++
 5 files changed, 11 insertions(+), 3 deletions(-)

diff --git a/app/helpers/admin/citations_helper.rb b/app/helpers/admin/citations_helper.rb
index 316d65b9f5..a383aa7d67 100644
--- a/app/helpers/admin/citations_helper.rb
+++ b/app/helpers/admin/citations_helper.rb
@@ -2,6 +2,7 @@
 module Admin::CitationsHelper
   ICONS = {
     journalism: '🗞️',
+    campaigning: '📣',
     academic: '🎓',
     other: '🌐'
   }.with_indifferent_access.freeze
diff --git a/app/models/citation.rb b/app/models/citation.rb
index a9aa4e359b..460eb357ef 100644
--- a/app/models/citation.rb
+++ b/app/models/citation.rb
@@ -29,7 +29,7 @@ class Citation < ApplicationRecord
                                    message: _('Source URL is too long') },
                          format: { with: /\Ahttps?:\/\/.*\z/,
                                    message: _('Please enter a Source URL') }
-  validates :type, inclusion: { in: %w(journalism academic other),
+  validates :type, inclusion: { in: %w(journalism academic campaigning other),
                                 message: _('Please select a type') }
 
   scope :newest, ->(limit = 1) do
diff --git a/app/views/citations/new.html.erb b/app/views/citations/new.html.erb
index de87a069df..bc8d604b28 100644
--- a/app/views/citations/new.html.erb
+++ b/app/views/citations/new.html.erb
@@ -28,6 +28,11 @@
       <%= _('Journalism') %>
     </label>
 
+    <label for="citation_type_campaigning" class="form_label">
+      <%= f.radio_button :type, 'campaigning' %>
+      <%= _('Campaigning') %>
+    </label>
+
     <label for="citation_type_academic" class="form_label">
       <%= f.radio_button :type, 'academic' %>
       <%= _('Academic') %>
diff --git a/doc/CHANGES.md b/doc/CHANGES.md
index 2f7734862f..fe2555d9ab 100644
--- a/doc/CHANGES.md
+++ b/doc/CHANGES.md
@@ -2,8 +2,8 @@
 
 ## Highlighted Features
 
-* Broaden citation type classifications to cover wider thematic areas (Gareth
-  Rees)
+* Broaden citation type classifications to cover wider thematic areas and add
+  "campaigning" type (Gareth Rees)
 * Reduce amount of storage related background jobs (Graeme Porteous)
 * Add automatic parsing of emails contain Excel spreadsheets (Graeme Porteous)
 * Improve rendering of admin hidden request prominence and explanations (Graeme
diff --git a/spec/models/citation_spec.rb b/spec/models/citation_spec.rb
index 64a018586a..46d940ac03 100644
--- a/spec/models/citation_spec.rb
+++ b/spec/models/citation_spec.rb
@@ -201,6 +201,8 @@ def setup_for_x_scope_data
       is_expected.not_to be_valid
       citation.type = 'journalism'
       is_expected.to be_valid
+      citation.type = 'campaigning'
+      is_expected.to be_valid
       citation.type = 'academic'
       is_expected.to be_valid
       citation.type = 'other'