Put message behind feature flipper and rake task (#3688)

Closes #3268

README.md

@@ -221,3 +221,15 @@ MY_URL=the url you copied above
 curl $MY_URL -o config/hosts.dat
 ```
 1. Optionally, alphabetize the file using your local editor
+
+## Announcement messages
+
+1. To see the current announcement message and feature status, run 
+```bash
+bundle exec rake announcement:show
+```
+1. To set a new announcement message, run
+```bash
+bundle exec rake announcement:set\["My message in a string. Must escape quotes."\]
+```
+1. To toggle announcements on and off, sign in and go to /features and toggle message display.

app/models/announcement.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+class Announcement < ApplicationRecord
+end

app/views/shared/_announcement.html.erb

@@ -1,5 +1,7 @@
-<%# to remove messages altogether, set this to empty string %>
-<% message = '' %>
+<%# To remove messages altogether, go to /features and turn off Message display %>
+<%# To set a new message, run the rake task `bundle exec rake announcement:set\["This is my new text."\]` %>
+<%# To see the current message, run `bundle exec rake announcement:show` %>
+<% message = Announcement&.first&.text %>
 <% if Orangelight.read_only_mode %>
   <div class="col-12 alert alert-warning announcement">
     <div class="container">
@@ -8,7 +10,7 @@
       </p>
     </div>
   </div>
-<% elsif message.present? %>
+<% elsif Flipflop.message_display? %>
   <div class="col-12 alert alert-warning announcement">
     <div class="container">
       <p>

config/features.rb

@@ -27,6 +27,10 @@
     default: true,
     description: "When on / true, uses the old locator service for Firestone. When off / false uses the new Stackmap service for Firestone."
 
+  feature :message_display,
+    default: false,
+    description: "When on / true, displays the message set by the announcement rake task."
+
   group :blacklight_8 do
     feature :json_query_dsl,
     description: "When on / true, use the JSON query DSL for search fields in the advanced search.  When off / false, use query params"

db/migrate/20230817164417_create_announcements.rb

@@ -0,0 +1,9 @@
+class CreateAnnouncements < ActiveRecord::Migration[6.1]
+  def change
+    create_table :announcements do |t|
+      t.string :text
+
+      t.timestamps
+    end
+  end
+end

db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2023_04_19_231330) do
+ActiveRecord::Schema.define(version: 2023_08_17_164417) do
 
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
@@ -54,6 +54,12 @@
     t.index ["sort"], name: "index_alma_orangelight_subjects_on_sort"
   end
 
+  create_table "announcements", force: :cascade do |t|
+    t.string "text"
+    t.datetime "created_at", precision: 6, null: false
+    t.datetime "updated_at", precision: 6, null: false
+  end
+
   create_table "bookmarks", id: :serial, force: :cascade do |t|
     t.integer "user_id", null: false
     t.string "user_type"

lib/tasks/announcement.rake

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+namespace :announcement do
+  desc 'Set text for announcement'
+  task :set, [:text] => [:environment] do |_task, args|
+    if Announcement.count.zero?
+      Announcement.create!(text: args.text)
+    else
+      announcement = Announcement.first
+      announcement.text = args.text
+      announcement.save!
+    end
+    Rake::Task["announcement:show"].invoke
+  end
+
+  desc 'Show current text of announcement'
+  task show: :environment do
+    puts "The currently set text is: #{Announcement.first.text}"
+    puts "The text will be displayed in the Catalog: #{Flipflop.message_display?}"
+  end
+end

spec/factories/announcements.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :announcement do
+    text { 'Text announcement text' }
+  end
+end

spec/models/announcement_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+require 'rails_helper'
+
+RSpec.describe Announcement, type: :model do
+  it 'can be instantiated' do
+    described_class.create(text: "My announcement text")
+    expect(described_class.last.text).to eq("My announcement text")
+  end
+end

spec/views/shared/_announcement.html.erb_spec.rb

@@ -3,6 +3,8 @@
 require 'rails_helper'
 
 RSpec.describe 'shared/_announcement' do
+  let!(:announcement) { FactoryBot.create(:announcement) }
+
   it 'renders an announcement' do
     render
     expect(rendered).to match(//)
@@ -16,4 +18,26 @@
       expect(rendered).to match(/test message/)
     end
   end
+
+  context 'with a non-read-only announcement' do
+    before do
+      allow(Flipflop).to receive(:message_display?).and_return(true)
+      allow(Orangelight).to receive(:read_only_mode).and_return(false)
+    end
+
+    it 'displays the message' do
+      render
+      expect(rendered).to match(/#{announcement.text}/)
+    end
+  end
+  context 'without a non-read-only announcement' do
+    before do
+      allow(Flipflop).to receive(:message_display?).and_return(false)
+    end
+
+    it 'renders an empty announcement partial' do
+      render
+      expect(rendered).to match(//)
+    end
+  end
 end