ucb_site_announcements 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4333bc60de8c92e69d82330727edb8195c45a3016a53de499cf089ff8ed95fad
-  data.tar.gz: af80d23b82f4c658b765e32beb564117238345bd71c755b538ec8fd3a6fb3ace
+  metadata.gz: 46929e6222186a1624d8dd852e46938d1da4b39f1915fa734476883bdb741bfa
+  data.tar.gz: aa03e7a8b7b78636af8971d28ea104d3e4bc928c5435c16a7fdd151941fe3ae6
 SHA512:
-  metadata.gz: a6b028437b25fea81cf9d4e053097f31b282b44e8fa7caba535e3356e7aaf6076bdfc5bc3da78caf39bb407abd258763d4ad01f28732cfba79208c52924a1c07
-  data.tar.gz: 1fec7ee3d5c6e998df7d5ad824d3ebd688dbed2378bbb97d86692c8f0ace5cdb30be5cf9878c980d7835f8ba784fa191ea7b6d3e2bf77f4e09b4341462608885
+  metadata.gz: b0f23e06ebfb2775fdb1dd840535342471797cf9fbf48722c3905943a9c373cd9a8297fde166258b9edfc21e88dfb54b3d7d01c6be4e24c7b0b6ddde07b8b75c
+  data.tar.gz: 449a9ab9d4b6cae6fa06ff14debf5bb98569a20e3e0416976bad49aff7c8a8b9a4a87b8c443bebd62b3618ce855cabfae3abc188de188ba581d2aa44bc996348

data/README.md

@@ -1,6 +1,6 @@
-# Site Announcements Engine
+# UCB Site Announcements
 
-The site_announcements engine provides administrator management and site display for timed announcements.
+The ucb_site_announcements Rails engine provides administrator management and site display for timed announcements.
 
 ## Prerequisites
 
@@ -14,22 +14,28 @@ To add the engine to a Rails application:
 1. Add the gem to your Gemfile:
 
 ```ruby
-gem "site_announcements"
+gem "ucb_site_announcements"
 ```
 
 2. Run `bundle install`
 
-3. Mount the engine in `config/routes.rb`:
+3. Install and run migrations
+```bash
+bin/rails ucb_site_announcements:install:migrations
+bin/rails db:migrate
+```
+
+4. Mount the engine in `config/routes.rb`:
 
 ```ruby
-mount SiteAnnouncements::Engine => "/announcements" # set whatever URL you'd like to use here
+mount UcbSiteAnnouncements::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.
+5. Set up a configuration block in `config/initializers/ucb_site_announcements.rb` - `auth_callback` is required.
 
 ```ruby
-# config/initializers/site_announcements.rb
-SiteAnnouncements.configure do |config|
+# config/initializers/ucb_site_announcements.rb
+UcbSiteAnnouncements.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
@@ -54,7 +60,7 @@ end
 5. Migrate the database:
 
 ```
-rake site_announcements:install:migrations
+rake ucb_site_announcements:install:migrations
 rake db:migrate
 ```
 

data/app/assets/config/ucb_site_announcements_manifest.js

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

data/app/controllers/{site_announcements → ucb_site_announcements}/announcements_controller.rb

@@ -1,4 +1,4 @@
-module SiteAnnouncements
+module UcbSiteAnnouncements
   class AnnouncementsController < ::ApplicationController
     around_action :set_time_zone
     before_action :check_auth
@@ -44,11 +44,11 @@ module SiteAnnouncements
     private
 
     def set_time_zone(&block)
-      Time.use_zone(SiteAnnouncements.time_zone, &block)
+      Time.use_zone(UcbSiteAnnouncements.time_zone, &block)
     end
 
     def check_auth
-      callback = SiteAnnouncements.auth_callback
+      callback = UcbSiteAnnouncements.auth_callback
       if callback.present? && !callback.call(self)
         redirect_to "/", alert: "You are not authorized to access this page"
       end

data/app/helpers/{site_announcements → ucb_site_announcements}/application_helper.rb

@@ -1,4 +1,4 @@
-module SiteAnnouncements
+module UcbSiteAnnouncements
   module ApplicationHelper
     def active_site_announcements
       Announcement.active.map do |a|

data/app/jobs/{site_announcements → ucb_site_announcements}/application_job.rb

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

data/app/mailers/{site_announcements → ucb_site_announcements}/application_mailer.rb

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

data/app/models/{site_announcements → ucb_site_announcements}/announcement.rb

@@ -1,4 +1,4 @@
-module SiteAnnouncements
+module UcbSiteAnnouncements
   class Announcement < ApplicationRecord
     validates_presence_of :message, :category
 

data/app/models/{site_announcements → ucb_site_announcements}/application_record.rb

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

data/config/routes.rb

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

data/db/migrate/20231206192929_create_ucb_site_announcements_announcements.rb

@@ -0,0 +1,15 @@
+class CreateUcbSiteAnnouncementsAnnouncements < ActiveRecord::Migration[7.0]
+  def change
+    create_table :ucb_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 :ucb_site_announcements_announcements, :start_time
+    add_index :ucb_site_announcements_announcements, :end_time
+  end
+end

data/lib/tasks/site_announcements_tasks.rake

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

data/lib/{site_announcements → ucb_site_announcements}/engine.rb

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

data/lib/ucb_site_announcements/version.rb

@@ -0,0 +1,3 @@
+module UcbSiteAnnouncements
+  VERSION = "0.2.0"
+end

data/lib/{site_announcements.rb → ucb_site_announcements.rb}

@@ -1,7 +1,7 @@
-require "site_announcements/version"
-require "site_announcements/engine"
+require "ucb_site_announcements/version"
+require "ucb_site_announcements/engine"
 
-module SiteAnnouncements
+module UcbSiteAnnouncements
   mattr_accessor :time_zone
   mattr_accessor :auth_callback
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ucb_site_announcements
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Darin Wilson
@@ -104,26 +104,26 @@ 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
+- app/assets/config/ucb_site_announcements_manifest.js
+- app/assets/stylesheets/ucb_site_announcements/application.css
+- app/controllers/ucb_site_announcements/announcements_controller.rb
+- app/helpers/ucb_site_announcements/application_helper.rb
+- app/jobs/ucb_site_announcements/application_job.rb
+- app/mailers/ucb_site_announcements/application_mailer.rb
+- app/models/ucb_site_announcements/announcement.rb
+- app/models/ucb_site_announcements/application_record.rb
+- app/views/ucb_site_announcements/announcements/_form.html.erb
+- app/views/ucb_site_announcements/announcements/edit.html.erb
+- app/views/ucb_site_announcements/announcements/index.html.erb
+- app/views/ucb_site_announcements/announcements/new.html.erb
+- app/views/ucb_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
+- db/migrate/20231206192929_create_ucb_site_announcements_announcements.rb
 - lib/tasks/site_announcements_tasks.rake
-homepage: https://github.com/ucb-ist-eas/site_announcements
+- lib/ucb_site_announcements.rb
+- lib/ucb_site_announcements/engine.rb
+- lib/ucb_site_announcements/version.rb
+homepage: https://github.com/ucb-ist-eas/ucb_site_announcements
 licenses:
 - MIT
 metadata: {}

data/app/assets/config/site_announcements_manifest.js

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

data/db/migrate/20231206192929_create_site_announcements_announcements.rb

@@ -1,15 +0,0 @@
-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/version.rb

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