Merge pull request #2140 from broadinstitute/jb-home-page-link

Adding reusing component for placing link on home page (SCP-5803)

app/controllers/site_controller.rb

@@ -61,6 +61,7 @@ def index
       @cell_count = 0
     end
 
+    @home_page_link = HomePageLink.published
   end
 
   def covid

app/javascript/styles/_brand.scss

@@ -252,11 +252,17 @@
   }
 }
 
-#whitepaper-btn {
+#home-page-link {
   position: absolute;
   top: 220px;
   right: 15px;
   z-index: 500;
+
+  img {
+    height: 24px;
+    object-fit: scale-down;
+    padding-right: 5px;
+  }
 }
 
 #latest-features-btn {

app/javascript/styles/_global.scss

@@ -941,6 +941,16 @@ figcaption.ck-editor__editable {
   color: #C45500;
 }
 
+.btn-home-link {
+  color: #fff;
+  box-shadow: 8px 8px 12px #2b2b2b;
+}
+
+.btn-home-link:hover {
+  color: #fff;
+  filter: brightness(90%);
+}
+
 .link-darker-blue {
   color: #1b476d
 }

app/models/home_page_link.rb

@@ -0,0 +1,78 @@
+class HomePageLink
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  DEFAULT_CSS_CLASS='btn btn-home-link'.freeze
+  DEFAULT_BG_COLOR='#4999F9'.freeze
+
+  field :name, type: String
+  field :href, type: String
+  field :tooltip, type: String
+  field :bg_color, type: String, default: DEFAULT_BG_COLOR
+  field :css_class, type: String, default: DEFAULT_CSS_CLASS
+  field :published, type: Mongoid::Boolean, default: false
+  field :image, type: String
+
+  validates :name, :href, presence: true
+  validate :ensure_one_published_link
+
+  def publish!
+    update(published: true)
+  end
+
+  def unpublish!
+    update(published: false)
+  end
+
+  def reset_css!
+    puts "Resetting css_class to '#{DEFAULT_CSS_CLASS}'"
+    update(css_class: DEFAULT_CSS_CLASS)
+  end
+
+  def reset_bg_color!
+    puts "Resetting bg_color to '#{DEFAULT_BG_COLOR}'"
+    update(bg_color: DEFAULT_BG_COLOR)
+  end
+
+  def self.published
+    self.find_by(published: true)
+  end
+
+  def self.publish_last!
+    if published
+      puts "'#{published.name}' is already published"
+      return false
+    end
+
+    link = last
+    if link
+      puts "Publishing '#{link.name}'"
+      link.publish!
+    else
+      puts "Nothing to publish"
+    end
+  end
+
+  def self.unpublish!
+    if published.present?
+      puts "Unpublishing '#{published.name}'"
+      published.update(published: false)
+    else
+      puts "No published links"
+      return false
+    end
+  end
+
+  private
+
+  def ensure_one_published_link
+    if published && HomePageLink.where(published: true, :id.ne => self.id).exists?
+      existing = HomePageLink.published
+      errors.add(
+        :published,
+        "link exists: '#{existing.name}', please unpublish first with HomePageLink.unpublish!"
+      )
+      puts errors.full_messages.to_sentence
+    end
+  end
+end

app/views/layouts/application.html.erb

@@ -192,10 +192,12 @@
       &copy; <%= Date.today.year %> The Broad Institute of MIT and Harvard
     </div>
     <div class="footer-text-block pull-left left-border-0-5">
-      <%= scp_link_to 'Privacy Policy', privacy_policy_path %>
-      &nbsp;
-      <%= scp_link_to "Terms of Service".html_safe, terms_of_service_path %>
-      &nbsp;
+      <%= scp_link_to 'Privacy Policy', privacy_policy_path %>&nbsp;
+      <%= scp_link_to 'Terms of Service', terms_of_service_path %>&nbsp;
+      <%= scp_link_to 'Portal whitepaper', "https://www.biorxiv.org/content/10.1101/2023.07.13.548886v1",
+                      id: 'whitepaper-btn', data: { toggle: 'tooltip', placement: 'top' },
+                      title: 'Read the Single Cell Portal whitepaper!', target: :_blank %>
+
       <% if @selected_branding_group.present? %>
         <%= link_to "<i class='fas fa-chevron-circle-left fa-fw'></i> Return to Single Cell Portal".html_safe, site_path %>
       <% end %>

app/views/site/_home_page_link.html.erb

@@ -0,0 +1,11 @@
+<% image_link = @home_page_link.image.present? ? "#{image_tag(@home_page_link.image)}" : nil %>
+<style>
+  #home-page-link {
+    background-color: <%= @home_page_link.bg_color %>;
+  }
+</style>
+<%=
+  link_to "#{image_link}#{@home_page_link.name}".html_safe, @home_page_link.href, title: @home_page_link.tooltip,
+          data: { toggle: 'tooltip', placement: 'left'}, class: @home_page_link.css_class,
+          id: 'home-page-link', target: :_blank
+%>

app/views/site/_main_banner_content.html.erb

@@ -5,10 +5,9 @@
                     latest_feature_announcements_path, class: 'btn btn-warning-scp', id: 'latest-features-btn',
                     data: { toggle: 'tooltip', placement: 'left' }, title: 'Learn about new Single Cell Portal features!' %>
   <% end %>
-  <%= link_to "<span class='badge btn-warning-scp-icon'></span> " \
-  "Portal whitepaper".html_safe, 
-  "https://www.biorxiv.org/content/10.1101/2023.07.13.548886v1", class: 'btn btn-warning-scp', id: 'whitepaper-btn',
-  data: { toggle: 'tooltip', placement: 'left' }, title: 'Read the Single Cell Portal whitepaper!', target: :_blank %>
+  <% if @home_page_link.present? %>
+    <%= render partial: 'home_page_link' %>
+  <% end %>
   <% if @selected_branding_group.present? %>
   <% content_for(:html_title) { "#{@selected_branding_group.name} - Collections - Single Cell Portal" } %>
     <% if @selected_branding_group.banner_image.file %>

test/controllers/site_controller_test.rb

@@ -249,4 +249,13 @@ def teardown
       assert @study.publications.empty?
     end
   end
+
+  test 'should show home page link' do
+    get site_path
+    assert_select '#home-page-link', 0
+    HomePageLink.create(name: 'Foo', href: 'http://foo.com', published: true)
+    get site_path
+    assert_select '#home-page-link', 1
+    HomePageLink.delete_all
+  end
 end

test/models/home_page_link_test.rb

@@ -0,0 +1,48 @@
+require "test_helper"
+
+class HomePageLinkTest < ActiveSupport::TestCase
+
+  before(:all) do
+    @home_page_link = HomePageLink.create(name: 'Broad Institute', href: 'https://broadinstitute.org')
+  end
+
+  teardown do
+    HomePageLink.unpublish!
+  end
+
+  after(:all) do
+    HomePageLink.delete_all
+  end
+
+  test 'should publish/unpublish link' do
+    assert_nil HomePageLink.published
+    HomePageLink.publish_last!
+    assert HomePageLink.published.present?
+    link = HomePageLink.published
+    link.unpublish!
+    assert_nil HomePageLink.published
+    link.publish!
+    assert HomePageLink.published.present?
+    HomePageLink.unpublish!
+    assert_nil HomePageLink.published
+  end
+
+  test 'should reset css/color attributes' do
+    @home_page_link.update(css_class: 'foo', bg_color: '#ff0000')
+    @home_page_link.reset_css!
+    @home_page_link.reload
+    assert_equal HomePageLink::DEFAULT_CSS_CLASS, @home_page_link.css_class
+    @home_page_link.reset_bg_color!
+    @home_page_link.reload
+    assert_equal HomePageLink::DEFAULT_BG_COLOR, @home_page_link.bg_color
+  end
+
+  test 'should ensure only one link is published' do
+    assert_not HomePageLink.published.present?
+    HomePageLink.publish_last!
+    assert HomePageLink.published.present?
+    new_link = HomePageLink.new(name: 'Google', href: 'https://google.com', published: true)
+    assert_not new_link.valid?
+    assert_includes new_link.errors.attribute_names, :published
+  end
+end