ucb_site_announcements 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4333bc60de8c92e69d82330727edb8195c45a3016a53de499cf089ff8ed95fad
+  data.tar.gz: af80d23b82f4c658b765e32beb564117238345bd71c755b538ec8fd3a6fb3ace
+SHA512:
+  metadata.gz: a6b028437b25fea81cf9d4e053097f31b282b44e8fa7caba535e3356e7aaf6076bdfc5bc3da78caf39bb407abd258763d4ad01f28732cfba79208c52924a1c07
+  data.tar.gz: 1fec7ee3d5c6e998df7d5ad824d3ebd688dbed2378bbb97d86692c8f0ace5cdb30be5cf9878c980d7835f8ba784fa191ea7b6d3e2bf77f4e09b4341462608885

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 Darin Wilson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+# Site Announcements Engine
+
+The site_announcements engine provides administrator management and site display for timed announcements.
+
+## Prerequisites
+
+   * Ruby >= 3.0
+   * Rails >= 7.0
+
+## Installation
+
+To add the engine to a Rails application:
+
+1. Add the gem to your Gemfile:
+
+```ruby
+gem "site_announcements"
+```
+
+2. Run `bundle install`
+
+3. Mount the engine in `config/routes.rb`:
+
+```ruby
+mount SiteAnnouncements::Engine => "/announcements" # set whatever URL you'd like to use here
+```
+
+4. Set up a configuration block in `config/initializers/site_announcements.rb` - `auth_callback` is required.
+
+```ruby
+# config/initializers/site_announcements.rb
+SiteAnnouncements.configure do |config|
+  config.auth_callback = ->(controller) {
+    # This will be called in the admin controller to determine if the current user can make changes
+    # to the announcements
+    #
+    # "controller" is the current controller instance so it will have access to anything defined in your
+    # ApplicationController
+    #
+    # Return true if the current user can view/edit announcements; false otherwise
+    #
+    # Example:
+    # controller.current_user.admin?
+  }
+  config.time_zone = "Pacific Time (US & Canada)"
+end
+```
+
+`time_zone` is optional, but will default to `Pacific Time (US & Canada)`
+
+> [!CAUTION]
+> If you don't provide a setting for `auth_callback` all users will be able to access the admin section for announcements, which is probably not what you want.
+
+5. Migrate the database:
+
+```
+rake site_announcements:install:migrations
+rake db:migrate
+```
+
+## Creating and Managing Announcements
+
+Access the admin inteface at, e.g. `/announcements/admin` (assuming you set the mount point at `announcements` in step 3)
+
+## Displaying Announcements
+
+To display active announcements in application views:
+
+```erb
+<%= active_site_announcements %>
+```
+
+This will render Bootstrap alert components for each active announcement.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/site_announcements_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/site_announcements .css

data/app/assets/stylesheets/site_announcements/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/site_announcements/announcements_controller.rb

@@ -0,0 +1,66 @@
+module SiteAnnouncements
+  class AnnouncementsController < ::ApplicationController
+    around_action :set_time_zone
+    before_action :check_auth
+    before_action :set_announcement, only: [:show, :edit, :update, :destroy]
+
+    def index
+      @announcements = Announcement.all
+    end
+
+    def show
+    end
+
+    def new
+      @announcement = Announcement.new
+    end
+
+    def edit
+    end
+
+    def create
+      @announcement = Announcement.new(announcement_params)
+
+      if @announcement.save
+        redirect_to announcements_url, notice: "Announcement was successfully created."
+      else
+        render :new
+      end
+    end
+
+    def update
+      if @announcement.update(announcement_params)
+        redirect_to announcements_url, notice: "Announcement was successfully updated."
+      else
+        render :edit
+      end
+    end
+
+    def destroy
+      @announcement.destroy
+      redirect_to announcements_url, notice: "Announcement was successfully destroyed."
+    end
+
+    private
+
+    def set_time_zone(&block)
+      Time.use_zone(SiteAnnouncements.time_zone, &block)
+    end
+
+    def check_auth
+      callback = SiteAnnouncements.auth_callback
+      if callback.present? && !callback.call(self)
+        redirect_to "/", alert: "You are not authorized to access this page"
+      end
+    end
+
+    def set_announcement
+      @announcement = Announcement.find(params[:id])
+    end
+
+    def announcement_params
+      params.require(:announcement).permit(:message, :category, :start_time, :end_time, :enabled)
+    end
+
+  end
+end

data/app/helpers/site_announcements/application_helper.rb

@@ -0,0 +1,9 @@
+module SiteAnnouncements
+  module ApplicationHelper
+    def active_site_announcements
+      Announcement.active.map do |a|
+        content_tag(:div, a.message, class: "alert alert-#{a.category}")
+      end.join.html_safe
+    end
+  end
+end

data/app/jobs/site_announcements/application_job.rb

@@ -0,0 +1,4 @@
+module SiteAnnouncements
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/site_announcements/application_mailer.rb

@@ -0,0 +1,6 @@
+module SiteAnnouncements
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/site_announcements/announcement.rb

@@ -0,0 +1,27 @@
+module SiteAnnouncements
+  class Announcement < ApplicationRecord
+    validates_presence_of :message, :category
+
+    def self.active
+      now = Time.zone.now
+
+      self
+        .where(enabled: true)
+        .where("(start_time IS NULL OR start_time < :now) AND (end_time IS NULL OR end_time > :now)", now: now)
+    end
+
+    def formatted_start_time
+      format_datetime(start_time)
+    end
+
+    def formatted_end_time
+      format_datetime(end_time)
+    end
+
+    private
+
+    def format_datetime(datetime)
+      datetime&.strftime("%m/%d/%Y %I:%M %P")
+    end
+  end
+end

data/app/models/site_announcements/application_record.rb

@@ -0,0 +1,5 @@
+module SiteAnnouncements
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/site_announcements/announcements/_form.html.erb

@@ -0,0 +1,49 @@
+<div class="row">
+  <div class="col-md-8">
+    <%= form_with(model: @announcement) do |form| %>
+      <% if @announcement.errors.any? %>
+          <div class="alert alert-danger">
+            <ul>
+              <% @announcement.errors.full_messages.each do |msg| %>
+                <li><%= msg %></li>
+              <% end %>
+            </ul>
+          </div>
+        <% end %>
+
+      <div class="mb-3 form-group">
+        <%= form.label :message %>
+        <%= form.text_field :message, class: "form-control" %>
+      </div>
+
+      <div class="mb-3 form-group">
+        <%= form.label :category %>
+        <%= form.select :category, [["Info", "info"], ["Warning", "warning"], ["Danger", "danger"]], { prompt: "Choose a category" }, { class: "form-control" } %>
+      </div>
+
+      <div class="row">
+        <div class="col-md-6 form-group">
+          <%= form.label :start_time %>
+          <%= form.datetime_field :start_time, class: "form-control" %>
+        </div>
+
+        <div class="col-md-6 form-group">
+          <%= form.label :end_time %>
+          <%= form.datetime_field :end_time, class: "form-control" %>
+        </div>
+      </div>
+
+      <div class="form-check">
+        <%= form.check_box :enabled %>
+        <%= form.label :enabled %>
+      </div>
+
+      <div class="form-group">
+        <%= form.submit class: "btn btn-primary" %>
+        &nbsp;
+        <%= link_to "Cancel", :back %>
+      </div>
+    </div>
+  </div>
+
+<% end %>

data/app/views/site_announcements/announcements/edit.html.erb

@@ -0,0 +1,3 @@
+<h1>Editing Announcement</h1>
+
+<%= render 'form', announcement: @announcement %>

data/app/views/site_announcements/announcements/index.html.erb

@@ -0,0 +1,35 @@
+<h1>Announcements</h1>
+
+<div class="mb-3">
+  <%= link_to "New Announcement", new_announcement_path, class: "btn btn-primary" %>
+</div>
+
+<table class="table table-striped">
+  <thead>
+    <tr>
+      <th>Message</th>
+      <th>Category</th>
+      <th>Enabled</th>
+      <th>Start Time</th>
+      <th>End Time</th>
+      <th colspan="2"></th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <% @announcements.each do |announcement| %>
+      <tr>
+        <td><%= announcement.message %></td>
+        <td><%= announcement.category %></td>
+        <td><%= announcement.enabled ? "Yes" : "No" %></td>
+        <td><%= announcement.formatted_start_time %></td>
+        <td><%= announcement.formatted_end_time %></td>
+        <td><%= link_to "Edit", edit_announcement_path(announcement) %></td>
+        <td><%= button_to "Delete", announcement_url(announcement), method: :delete, class: "btn btn-danger",
+          onclick: "return confirm('Are you sure?')" %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<br>

data/app/views/site_announcements/announcements/new.html.erb

@@ -0,0 +1,3 @@
+<h1>New Announcement</h1>
+
+<%= render 'form', announcement: @announcement %>

data/app/views/site_announcements/announcements/show.html.erb

@@ -0,0 +1,27 @@
+<p>
+  <strong>Message:</strong>
+  <%= @announcement.message %>
+</p>
+
+<p>
+  <strong>Category:</strong>
+  <%= @announcement.category %>
+</p>
+
+<p>
+  <strong>Start Time:</strong>
+  <%= @announcement.formatted_start_time %>
+</p>
+
+<p>
+  <strong>End Time:</strong>
+  <%= @announcement.formatted_end_time %>
+</p>
+
+<p>
+  <strong>Enabled:</strong>
+  <%= @announcement.enabled ? "Yes" : "No" %>
+</p>
+
+<%= link_to 'Edit', edit_announcement_path(@announcement) %> |
+<%= link_to 'Back', announcements_path %>

data/config/routes.rb

@@ -0,0 +1,4 @@
+SiteAnnouncements::Engine.routes.draw do
+  resources :announcements
+  root to: "announcements#index"
+end

data/db/migrate/20231206192929_create_site_announcements_announcements.rb

@@ -0,0 +1,15 @@
+class CreateSiteAnnouncementsAnnouncements < ActiveRecord::Migration[7.0]
+  def change
+    create_table :site_announcements_announcements do |t|
+      t.string :message, null: false
+      t.string :category, null: false
+      t.datetime :start_time
+      t.datetime :end_time
+      t.boolean :enabled, null: false, default: true
+      t.timestamps
+    end
+
+    add_index :site_announcements_announcements, :start_time
+    add_index :site_announcements_announcements, :end_time
+  end
+end

data/lib/site_announcements/engine.rb

@@ -0,0 +1,15 @@
+module SiteAnnouncements
+  class Engine < ::Rails::Engine
+    isolate_namespace SiteAnnouncements
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    initializer 'local_helper.action_controller' do
+      ActiveSupport.on_load :action_controller do
+        helper SiteAnnouncements::ApplicationHelper
+      end
+    end
+  end
+end

data/lib/site_announcements/version.rb

@@ -0,0 +1,3 @@
+module SiteAnnouncements
+  VERSION = "0.1.0"
+end

data/lib/site_announcements.rb

@@ -0,0 +1,14 @@
+require "site_announcements/version"
+require "site_announcements/engine"
+
+module SiteAnnouncements
+  mattr_accessor :time_zone
+  mattr_accessor :auth_callback
+
+  def self.configure(&block)
+    configuration = OpenStruct.new(time_zone: Time.zone, auth_callback: nil)
+    yield configuration if block
+    self.time_zone = configuration.time_zone || "Pacific Time (US & Canada)"
+    self.auth_callback = configuration.auth_callback
+  end
+end

data/lib/tasks/site_announcements_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :site_announcements do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: ucb_site_announcements
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Darin Wilson
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara-screenshot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Rails engine for site-wide announcement banners
+email:
+- darinwilson@berkeley.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/site_announcements_manifest.js
+- app/assets/stylesheets/site_announcements/application.css
+- app/controllers/site_announcements/announcements_controller.rb
+- app/helpers/site_announcements/application_helper.rb
+- app/jobs/site_announcements/application_job.rb
+- app/mailers/site_announcements/application_mailer.rb
+- app/models/site_announcements/announcement.rb
+- app/models/site_announcements/application_record.rb
+- app/views/site_announcements/announcements/_form.html.erb
+- app/views/site_announcements/announcements/edit.html.erb
+- app/views/site_announcements/announcements/index.html.erb
+- app/views/site_announcements/announcements/new.html.erb
+- app/views/site_announcements/announcements/show.html.erb
+- config/routes.rb
+- db/migrate/20231206192929_create_site_announcements_announcements.rb
+- lib/site_announcements.rb
+- lib/site_announcements/engine.rb
+- lib/site_announcements/version.rb
+- lib/tasks/site_announcements_tasks.rake
+homepage: https://github.com/ucb-ist-eas/site_announcements
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key:
+specification_version: 4
+summary: A Rails engine for site-wide announcement banners
+test_files: []