user_announcements 0.0.3 → 0.0.4

data/README.md

@@ -5,9 +5,15 @@
 [![Coverage Status](https://coveralls.io/repos/stevedowney/user_announcements/badge.png?branch=master)](https://coveralls.io/r/stevedowney/user_announcements?branch=master)
 [![Code Climate](https://codeclimate.com/github/stevedowney/user_announcements.png)](https://codeclimate.com/github/stevedowney/user_announcements)
 
-Manage and display site-wide announcements on a per-user basis.
+## Features:
 
-Coming soon, scope by user role and announcement type.
+* admins
+  * page for maintaining announcements
+  * announcements can be scoped by user role
+* users
+  * hide announcements
+  * view past and hidden announcements
+  * unhide hidden announcements
 
 ### Acknowledgements
  
@@ -15,6 +21,13 @@ This gem was inspired by the [Site-Wide Announcements (revised)](http://railscas
 episode of [RailsCasts](http://railscasts.com/).  If you don't have a premium account you can see the 
 [original episode](http://railscasts.com/episodes/103-site-wide-announcements).
 
+## Assumptions
+
+* your controllers respond to `ensure_admin_user` which ensures only admin users can create/edit/delete
+announcemets
+* your controllers respond to `current_user`, which is also a `helper_method`
+* if you implement roles, `current_user` responds to `#has_role?(<role>)`
+
 ## Installation
 
 Add it to your Gemfile:
@@ -35,28 +48,53 @@ Install files:
 rails generate user_announcements:install
 ```
 
-By default, Bootstrap styling is applied.  This can be turned on/off:
-
-```ruby
-# ../config/initializers/user_announcements.rb
+## Getting Started
 
-  # control Bootstrap styling
-  # c.bootstrap = false
-  c.bootstrap = true
+### Controller Methods Example
 
+```ruby
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+  
+  private
+  
+  def ensure_admin_user
+    current_user.has_role?('admin')
+  end
+  
+  def current_user
+    @user ||= User.find(session[:user_id])
+  end
+  helper_method :current_user
+  
+end
 ```
 
-Don't forget to restart your Rails server.
+### User Model Methods
+
 
-## Getting Going
+```ruby
+class User < ActiveRecord::Base
+  
+  def has_role?(role)
+    return true if role.blank?
+    return true if role == admin && self.admin?
+    # ... more elaborate role checking code here?
+    false
+  end
+  
+end
+```
 
-To create an announcement go to:
+### Create an Announcement
 
 ```
 http://<your app>/admin/announcements
 ```
 
-To see the announcment add the helper method to your views, e.g.:
+### View the Announcement
+
+Add the helper method to your layout:
 
 ```erb
 #../layouts/application.html.erb
@@ -66,8 +104,59 @@ To see the announcment add the helper method to your views, e.g.:
   ...
 ```
 
-Non-admin users can see (and unhide) announcements they have hidden:
+Now visit some page that uses that layout to see the announcement.
+
+Non-admin users can see current and past announcements, including ones they have hidden,
+by visiting:
 
 ```
 http://<your app>/announcements
 ```
+
+### URL Helpers
+
+The following url helpers are available:
+
+```ruby
+# admin manages announcements
+admin_announcements_path
+
+# user manages own announcements
+hidden_announcements_path
+```
+
+## Configuration
+
+There are several configuration settings found in `../config/initializers/user_announcements.rb`.
+
+```ruby
+# note: all options accept lambdas
+
+UserAnnouncements.config do |config|
+
+  # Bootstrap
+  config.bootstrap = true
+  config.styles = [['Yellow', ''], ['Red', 'alert-error'], ['Green', 'alert-success'], ['Blue', 'alert-info']]
+
+  # non-Bootstrap
+  # config.bootstrap = false
+  # config.styles = [['Yellow', 'yellow'], ['Red', 'red'], ['Green', 'green'], ['Blue', 'blue']]
+
+  # Announcement defaults
+  config.default_active = true
+  config.default_starts_at = lambda { Time.now.in_time_zone }
+  config.default_ends_at = lambda { 1.week.from_now.in_time_zone.end_of_day }
+  config.default_style = ''
+  # config.default_roles = ['admin']
+
+  # Roles
+  # config.roles = []
+  # config.roles = ['', 'admin']
+  # config.roles = [ ['Public', ''], ['Administrator', 'admin'] ]
+  # config.roles = lambda { MyRoleClass.map { |role| [role.name, role.id] } }  
+  
+end
+```
+
+Don't forget to restart your Rails server after changes to the config file.
+

data/app/controllers/admin/announcements_controller.rb

@@ -1,8 +1,9 @@
-class Admin::AnnouncementsController <  Admin::BaseController
+class Admin::AnnouncementsController < ApplicationController
+  before_filter :ensure_admin_user
   before_filter :find_announcement, :only => [:edit, :update, :destroy]
 
   def index
-    @announcements = AnnouncementFinder.ordered
+    @announcements = AnnouncementFinder.for_admin
   end
   
   def new
@@ -22,7 +23,10 @@ class Admin::AnnouncementsController <  Admin::BaseController
   end
   
   def update
-    if @announcement.update_attributes(params.fetch(:announcement))
+    attributes = params.fetch(:announcement)
+      .reverse_merge(roles: [])
+      
+    if @announcement.update_attributes(attributes)
       redirect_to admin_announcements_path, :flash => { success: 'Announcement updated' }
     else
       render "edit"

data/app/controllers/hidden_announcements_controller.rb

@@ -1,8 +1,7 @@
 class HiddenAnnouncementsController < ApplicationController
-  before_filter :ensure_current_user
-  
+
   def index
-    @announcements = AnnouncementFinder.past_or_current
+    @announcements = AnnouncementFinder.for_edit(current_user)
     @hidden_announcement_ids = HiddenAnnouncement.hidden_announcement_ids_for(current_user.id)
   end
   
@@ -19,5 +18,5 @@ class HiddenAnnouncementsController < ApplicationController
     HiddenAnnouncement.delete_all(user_id: current_user.id, announcement_id: params.fetch(:announcement_id))
     redirect_to action: 'index'
   end
-  
+
 end

data/app/helpers/user_announcements/admin_helper.rb

@@ -0,0 +1,43 @@
+module UserAnnouncements::AdminHelper
+  
+  def _ua_active_model_errors(model)
+    return unless model.errors.present?
+
+    content_tag(:div, class: ['alert', 'alert-error']) do
+      content_tag(:h4, "Correct the following errors:") +
+      content_tag(:ul) do
+        safe_join(model.errors.full_messages.map { |msg| content_tag(:li, msg) }, "\n")
+      end
+    end
+  end
+  
+  def ua_table_tag(options={})
+    content_tag(:table, options.merge(ua_table_attrs)) do
+      yield
+    end
+  end
+  
+  def boolean_display(boolean)
+    ( boolean ? '✔' : ' ' ).html_safe
+  end
+  
+  def ua_datetime_p(f, method)
+    content_tag(:p, class: 'datetime-select') do
+      f.label(method) + 
+      ua_br +      
+      f.datetime_select(method)
+    end
+  end
+  
+  private
+
+  def ua_table_attrs
+    if ua_bootstrap?
+      {class: "ua-table bootstrap table table-striped table-bordered table-hover"}
+    else
+      {class: 'ua-table non-bootstrap'}
+    end
+  end
+  
+  
+end

data/app/helpers/user_announcements/misc_helper.rb

@@ -0,0 +1,39 @@
+module UserAnnouncements::MiscHelper
+  
+  def ua_datetime_display(datetime)
+    if datetime.present?
+      datetime.to_s(:short)
+    else
+      nil
+    end
+  end
+  
+  # Return a <br> tag if not bootstrap
+  def ua_br
+    "<br />".html_safe unless ua_bootstrap?
+  end
+  
+  def flash_messages
+    return nil if flash.empty?
+    result = []
+    flash.each do |name, msg|
+      result << build_message(name, msg)
+    end
+    result.join("").html_safe
+  end
+
+  def build_message(msg_type, msg)
+    content_tag(:div, :class => "alert alert-#{msg_type.to_s}") do
+      content_tag(:a, 'x', :class => "close", "data-dismiss" => "alert") + msg.html_safe
+    end
+  end
+  
+  def ua_bootstrap?
+    if params.has_key?(:bootstrap)
+      params[:bootstrap] == 'true'
+    else
+      UserAnnouncements.config.bootstrap
+    end
+  end
+  
+end

data/app/helpers/user_announcements/roles_helper.rb

@@ -0,0 +1,44 @@
+module UserAnnouncements::RolesHelper
+  Role = Struct.new(:name, :id) 
+  
+  # Roles checkboxes for admin detail form
+  def ua_roles_html(f)
+    return unless _ua_roles.present?
+
+    f.label(:roles) +
+    ua_br + 
+    _ua_roles_checkboxes(_ua_roles)
+  end
+
+  # Roles display on index page
+  def ua_roles_display(announcement)
+    role_names = announcement.roles.map { |role_id| _ua_role_id_to_name(role_id) }
+
+    safe_join(role_names, '<br />'.html_safe)
+  end
+  
+  private
+  
+  def _ua_roles_checkboxes(roles)
+    safe_join( roles.map { |role| _ua_role_checkbox(role) } )
+  end
+
+  def _ua_role_checkbox(role)
+    id = "role_#{role.id}"
+    checked = @announcement.roles.include?(role.id)
+
+    check_box_tag('announcement[roles][]', role.id, checked, id: id) + ' ' +
+      label_tag(id, role.name, style: "display: inline; margin-right: 1em")
+  end
+
+  def _ua_role_id_to_name(role_id)
+    _ua_roles.detect { |role| role.id == role_id  }.try(:name)
+  end
+  
+  def _ua_roles
+    @_ua_roles ||= Array(UserAnnouncements[:roles]).map do |role|
+      name_id = (role.is_a?(Array) ? role : [role, role]).map(&:to_s)
+      Role.new(name_id.first, name_id.last)
+    end
+  end
+end

data/app/helpers/user_announcements/show_announcements.rb

@@ -0,0 +1,66 @@
+module UserAnnouncements::ShowAnnouncements
+  
+  # Helper method for displaying messages for +current_user+.
+  def user_announcements(options={})
+    return if controller.controller_name == 'hidden_announcements'
+    
+    announcements_rows = AnnouncementFinder.for_display(current_user)
+    divs = announcements_rows.map do |announcement|
+      _ua_announcement_div(announcement)
+    end
+    
+    safe_join(divs, "\n")
+  end
+  
+  private
+  
+  def _ua_announcement_div(ann)
+    if ua_bootstrap?
+      _ua_announcement_div_bootstrap(ann)
+    else
+      _ua_announcement_div_non_bootstrap(ann)
+    end
+  end
+  
+  def _ua_announcement_div_bootstrap(ann)
+    div_for ann, class: _ua_announcement_classes(ann.style), style: 'width:40em' do
+      link_to(*_ua_hide_announcement_link_args(ann)) do
+        content_tag(:button, raw('×'), type: 'button', class: 'close')
+      end + 
+      ann.message.html_safe
+    end
+  end
+  
+  def _ua_announcement_div_non_bootstrap(ann)
+    div_for(ann, class: _ua_announcement_classes(ann.style)) do
+      ann.message.html_safe +
+      link_to("hide announcement", *_ua_hide_announcement_link_args(ann))
+    end
+  end
+  
+  def _ua_hide_announcement_link_args(announcement)
+    url = hidden_announcements_path(announcement_id: announcement)
+    options = {
+      method: :post,
+      remote: true,
+      id: "hide_#{dom_id(announcement)}"
+    }
+    
+    [url, options]
+  end
+  
+  def _ua_unhide_announcement_link(announcement)
+    if @hidden_announcement_ids.include?(announcement.id)
+      content_tag(:div) do
+        link_to('Unhide', hidden_announcement_path(announcement, announcement_id: announcement), method: :delete)
+      end
+    end
+  end
+  
+  
+  def _ua_announcement_classes(style)
+    bootstrap_or_non = ua_bootstrap? ? 'bootstrap alert' : 'non-bootstrap'
+    [bootstrap_or_non, style.presence].compact.join(' ')
+  end
+  
+end

data/app/helpers/user_announcements/style_helper.rb

@@ -0,0 +1,20 @@
+module UserAnnouncements::StyleHelper
+  
+  # Style dropdown for admin detail form
+  def ua_style_html(f)
+    return unless _ua_styles.present?
+
+    f.label(:style) +
+    ua_br + 
+    f.select(:style, _ua_styles)
+  end
+  
+  private
+  
+  def _ua_styles
+    @_ua_styles ||= UserAnnouncements[:styles].map do |style|
+      (style.is_a?(Array) ? style : [style, style]).map(&:to_s)
+    end
+  end
+  
+end

data/app/helpers/user_announcements_helper.rb

@@ -1,101 +1,7 @@
 module UserAnnouncementsHelper
-  
-  # Helper method for displaying messages for +current_user+.
-  def user_announcements(options={})
-    return if controller.controller_name == 'hidden_announcements'
-    
-    announcements_rows = AnnouncementFinder.current_for_user(current_user)
-    divs = announcements_rows.map do |announcement|
-      announcement_div(announcement)
-    end
-    
-    safe_join(divs, "\n")
-  end
-  
-  def announcement_div(announcement)
-    if bootstrap?
-      announcement_div_bootstrap(announcement)
-    else
-      announcement_div_non_bootstrap(announcement)
-    end
-  end
-  
-  def announcement_div_bootstrap(announcement)
-    div_for announcement, class: 'alert', style: 'width:40em' do
-      link_to(*hide_announcement_link_args(announcement)) do
-        content_tag(:button, raw('×'), type: 'button', class: 'close')
-      end + 
-      announcement.message.html_safe
-    end
-  end
-  
-  def hide_announcement_link_args(announcement)
-    url = hidden_announcements_path(announcement_id: announcement)
-    options = {
-      method: :post,
-      remote: true,
-      id: "hide_#{dom_id(announcement)}"
-    }
-    
-    [url, options]
-  end
-  
-  def announcement_div_non_bootstrap(announcement)
-    div_for(announcement, class: 'non-bootstrap') do
-      announcement.message.html_safe +
-      link_to("hide announcement", *hide_announcement_link_args(announcement))
-    end
-  end
-  
-  def unhide_announcement_link(announcement)
-    if @hidden_announcement_ids.include?(announcement.id)
-      content_tag(:div) do
-        link_to('Unhide', hidden_announcement_path(announcement, announcement_id: announcement), method: :delete)
-      end
-    end
-  end
-  
-  def ua_table_attrs
-    if bootstrap?
-      {class: "ua-table bootstrap table table-striped table-bordered table-condensed table-hover"}
-    else
-      {class: 'ua-table non-bootstrap'}
-    end
-  end
-  
-  def ua_table_tag(options={})
-    content_tag(:table, options.merge(ua_table_attrs)) do
-      yield
-    end
-  end
-  
-  def boolean_display(boolean)
-    ( boolean ? '✔' : ' ' ).html_safe
-  end
-  
-  def active_model_errors(model)
-    return unless model.errors.present?
-
-    content_tag(:div, class: ['alert', 'alert-error']) do
-      content_tag(:h4, "Correct the following errors:") +
-      content_tag(:ul) do
-        safe_join(model.errors.full_messages.map { |msg| content_tag(:li, msg) }, "\n")
-      end
-    end
-  end
-  
-  def ua_datetime_p(f, method)
-    content_tag(:p, class: 'datetime-select') do
-      f.label(method) + 
-      f.datetime_select(method)
-    end
-  end
-  
-  def bootstrap?
-    if params.has_key?(:bootstrap)
-      params[:bootstrap] == 'true'
-    else
-      UserAnnouncements.config.bootstrap
-    end
-  end
+  include UserAnnouncements::AdminHelper
+  include UserAnnouncements::RolesHelper
+  include UserAnnouncements::MiscHelper
+  include UserAnnouncements::StyleHelper
+  include UserAnnouncements::ShowAnnouncements
 end

data/app/models/announcement.rb

@@ -1,9 +1,12 @@
 class Announcement < ActiveRecord::Base
-  attr_accessible :message, :starts_at, :ends_at, :active
+  serialize :roles, class_name = Array
+  serialize :types, class_name = Array
+  
+  attr_accessible :message, :starts_at, :ends_at, :active, :roles, :style
 
   has_many :hidden_announcements, :dependent => :destroy
   
-  validates_presence_of :message, :starts_at, :ends_at
+  validates_presence_of :message
   
   INACTIVE = 'inactive'
   PAST = 'past'
@@ -23,6 +26,10 @@ class Announcement < ActiveRecord::Base
     status == CURRENT
   end
   
+  def starts_at_for_user
+    starts_at || created_at
+  end
+  
   def status_order
     { FUTURE => 1, CURRENT => 2, PAST => 3, INACTIVE => 4 }[status]
   end
@@ -35,24 +42,13 @@ class Announcement < ActiveRecord::Base
     
     def new_with_defaults
       new do |ann|
-        ann.active = get_default(:active)
-        ann.starts_at = get_default(:starts_at)
-        ann.ends_at = get_default(:ends_at)
+        ann.active = UserAnnouncements[:default_active]
+        ann.starts_at = UserAnnouncements[:default_starts_at]
+        ann.ends_at = UserAnnouncements[:default_ends_at]
+        ann.roles = Array(UserAnnouncements[:default_roles])
+        ann.style = UserAnnouncements[:default_style]
       end
     end
     
-    private
-    
-    def get_default(column)
-      config_key = "default_#{column}"
-      default = UserAnnouncements.config.send(config_key)
-      
-      if default.is_a?(Proc)
-        default.call
-      else
-        default
-      end
-    end
-
   end
 end

data/app/models/announcement_finder.rb

@@ -1,44 +1,87 @@
+# Class to handle fetching +Announcement+ rows for various use cases.
 class AnnouncementFinder
   
   class << self
     
-    def ordered
-      Announcement.all.sort_by(&:status_order)
+    # Returns all +Announcement+s for admin edit page.
+    #
+    # @return [ActiveRecord::Relation<Announcement>]
+    def for_admin
+      Announcement
+        .all
+        .sort_by(&:status_order)
     end
     
-    def current
-      Announcement
-        .active
-        .where("starts_at is null or starts_at < :now", now: DateTime.now)
-        .where("ends_at is null or ends_at > :now", now: DateTime.now)
+    # Returns unhidden +Announcement+s that _user_ may see.
+    #
+    # @param user [User]
+    # @return [Array<Announcement>]
+    def for_display(user)
+      result = current
+      result = remove_hidden(user, result)
+      result = filter_by_role(user, result)
+      result
     end
     
-    def past_or_current
-      Rails.logger.debug '***** start past_or_current'
-r =       Announcement
+    # Returns +Announcement+s that _user_ may edit.
+    #
+    # @param user [User]
+    # @return [ActiveRecord::Relation<Announcement>]
+    def for_edit(user)
+     Announcement
         .active
         .where("(starts_at is null or starts_at < :now)", :now => DateTime.now)
         .order('created_at desc')
-        Rails.logger.debug '***** end past_or_current'
-        # sleep 1
-    r  
-    end
-    
-    def current_for_user(user)
-      for_user(user, current)
     end
     
-    # def past_or_current_for_user(user)
-    #   # FIXME: apply roles
-    #   past_or_current
-    # end
+    private
     
-    def for_user(user, type)
+    # Returns current +Announcement+s
+    #
+    # @return [ActiveRecord::Relation<Announcement>]
+    def current
+      Announcement
+        .active
+        .where("starts_at is null or starts_at < :now", now: DateTime.now)
+        .where("ends_at is null or ends_at > :now", now: DateTime.now)
+    end
+
+    # Removes any +Announcement+s from _relation_ that _user_ has hidden.
+    #
+    # @param user [User]
+    # @param relation [ActiveRecord::Relation<Announcement>]
+    # @return [ActiveRecord::Relation<Announcement>]
+    def remove_hidden(user, relation)
       hidden_announcement_ids = HiddenAnnouncement.hidden_announcement_ids_for(user.id)
-      result = type
-      result = result.where("id not in (?)", hidden_announcement_ids) if hidden_announcement_ids.present?
-      result.sort_by(&:status_order)
+      
+      if hidden_announcement_ids.present?
+        relation.where("id not in (?)", hidden_announcement_ids)
+      else
+        relation
+      end
     end
+
+    # Removes any +Announcement+s from _relation_ that _user_ can't see.
+    #
+    # @param user [User]
+    # @param relation [ActiveRecord::Relation<Announcement>]
+    def filter_by_role(user, relation)
+      relation.select { |announcement| user_can_see(user, announcement.roles) }
+    end
+    
+    # Returns +true+ if _user_ can see announcement based on _roles_.
+    #
+    # @param user [User, #has_role?]
+    # @param roles [Array<String>]
+    # @return [Boolean]
+    def user_can_see(user, roles)
+      if roles.detect(&:blank?) || roles.blank?
+        true
+      else
+        roles.any? { |role| user.has_role?(role) }
+      end
+    end
+    
   end
   
 end

data/app/views/admin/announcements/_announcement.html.erb

@@ -1,9 +1,10 @@
 <tr id="<%= dom_id(announcement) %>" class='<%= announcement.status %>'>
   <td><%=raw announcement.message %></td>
-  <td class='date'><%= announcement.starts_at.to_s(:long) %></td>
-  <td class='date'><%= announcement.ends_at.to_s(:long) %></td>
-  <td><%= announcement.status %></td>
-  <td><%= boolean_display(announcement.active)%></td>
+  <td class='datetime'><%= ua_datetime_display(announcement.starts_at) %></td>
+  <td class='datetime'><%= ua_datetime_display(announcement.ends_at) %></td>
+  <td class='status'><%= announcement.status %></td>
+  <td class='active'><%= boolean_display(announcement.active)%></td>
+  <td><%= ua_roles_display(announcement) %></td>
   <td><%= link_to('edit', edit_admin_announcement_path(announcement), :class => 'btn btn-mini') %></td>
   <td><%= link_to('delete', admin_announcement_path(announcement), :data => {confirm: 'Are you sure?'}, :method => :delete, :class => 'btn btn-mini btn-danger') %></td>
 </tr>

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

@@ -1,10 +1,14 @@
-<%= form_for [:admin, @announcement], :html => {:class => 'form-horizontal'} do |f| %>
-  <%= active_model_errors(f.object) %>
-  <%#= f.input :subject, :as => :text, :input_html => {:size => "60x3", class: 'span6'} %>
-  <%#= f.input(:starts_at, :as => :string, :input_html => {class: 'datepicker'}) %>
-  <%#= f.input(:ends_at, :as => :string, :input_html => {class: 'datepicker'}) %>
+<%= form_for [:admin, @announcement], :html => {:class => 'form-horizontal announcement-detail'} do |f| %>
+  <%= _ua_active_model_errors(f.object) %>
+
+  <p>
+    <%= f.check_box(:active) %>
+    <%= f.label :active %>
+  </p>
+
   <p>
     <%= f.label(:message) %>
+    <%= ua_br %>
     <%= f.text_area :message, size: "60x10", class: 'span6' %>
   </p>
 
@@ -13,10 +17,13 @@
   <%= ua_datetime_p(f, :ends_at) %>
   
   <p>
-    <%= f.check_box(:active) %>
-    <%= f.label :active %>
+    <%= ua_roles_html(f) %>
   </p>
-
+  
+  <p>
+    <%= ua_style_html(f) %>
+  </p>
+  
   <div class="form-actions">
     <%= f.submit :class => 'btn btn-primary' %>
     <%= link_to("Cancel", admin_announcements_path, :class => 'btn') %>

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

@@ -11,7 +11,8 @@
       <th>Starts</th>
       <th>Ends</th>
       <th>Status</th>
-      <th>Active</th>
+      <th class='active'>Active</th>
+      <th class='roles'>Roles</th>
       <th colspan="2" width="1%">Actions</th>
     </tr>
   </thead>

data/app/views/hidden_announcements/_announcement.html.erb

@@ -1,8 +1,8 @@
 
 <tr id="<%= dom_id(announcement) %>">
-  <td class='date'><%= announcement.created_at.try(:to_s, :db) %></td>
+  <td class='datetime'><%= ua_datetime_display(announcement.starts_at_for_user) %></td>
   <td>
     <%= announcement.message.html_safe %>
-    <%= unhide_announcement_link(announcement) %>
+    <%= _ua_unhide_announcement_link(announcement) %>
   </td>
 </tr>

data/lib/generators/user_announcements/install_generator.rb

@@ -9,14 +9,14 @@ module UserAnnouncements
 
       desc <<DESC
 Description:
-    Copies stylesheet    to 'app/assets/stylesheets/user_announcements.css.scss'
+    Copies stylesheet    to 'app/assets/stylesheets/user_announcements.css'
     Copies configuration to 'config/initializers/user_announcements.rb'
     Copies db migration  to 'db/migrate/<timestamp>/create_user_announcement_tables.rb'
     
 DESC
   
       def install
-        copy_file "css.scss", 'app/assets/stylesheets/user_announcements.css.scss'
+        copy_file "template.css", 'app/assets/stylesheets/user_announcements.css'
         copy_file "initializer.rb", 'config/initializers/user_announcements.rb'
         migration_template "migration.rb", "db/migrate/create_user_announcement_tables.rb"
       end

data/lib/generators/user_announcements/templates/initializer.rb

@@ -1,9 +1,26 @@
-UserAnnouncements.config do |c|
-  
-  # config.bootstrap = true
+# note: all options accept lambdas
+
+UserAnnouncements.config do |config|
+
+  # Bootstrap
+  config.bootstrap = true
+  config.styles = [['Yellow', ''], ['Red', 'alert-error'], ['Green', 'alert-success'], ['Blue', 'alert-info']]
+
+  # non-Bootstrap
+  # config.bootstrap = false
+  # config.styles = [['Yellow', 'yellow'], ['Red', 'red'], ['Green', 'green'], ['Blue', 'blue']]
+
+  # Announcement defaults
+  config.default_active = true
+  config.default_starts_at = lambda { Time.now.in_time_zone }
+  config.default_ends_at = lambda { 1.week.from_now.in_time_zone.end_of_day }
+  config.default_style = ''
+  # config.default_roles = ['admin']
 
-  # config.default_active = true
-  # config.default_starts_at = lambda { Time.now.in_time_zone }
-  # config.default_ends_at = lambda { 1.week.from_now.in_time_zone.end_of_day }
+  # Roles
+  # config.roles = []
+  # config.roles = ['', 'admin']
+  # config.roles = [ ['Public', ''], ['Administrator', 'admin'] ]
+  # config.roles = lambda { MyRoleClass.map { |role| [role.name, role.id] } }  
   
 end

data/lib/generators/user_announcements/templates/migration.rb

@@ -7,6 +7,7 @@ class CreateUserAnnouncementTables < ActiveRecord::Migration
       t.boolean :active
       t.text :roles
       t.text :types
+      t.text :style
       t.timestamps
     end
     

data/lib/generators/user_announcements/templates/template.css

@@ -0,0 +1,78 @@
+table.ua-table td.status {
+  width: 1%;
+  text-align: center;
+}
+  
+table.ua-table th.active {
+  width: 1%;
+}
+  
+table.ua-table td.active {
+  text-align: center;
+}
+
+table.ua-table td.datetime {
+  width: 6em;
+  white-space: nowrap;
+}
+
+table.ua-table th.roles {
+  width: 1%;
+}
+
+table.ua-table.non-bootstrap {
+  border-collapse:collapse;
+}
+
+table.ua-table.non-bootstrap th, table.ua-table.non-bootstrap td {
+  border: 1px solid black;
+  padding: 0.5em;
+}
+
+table.ua-table td {
+  vertical-align: top;
+}
+
+.announcement.non-bootstrap {
+  background-color: #fcf8e3;
+  color: #c09853;
+  border-bottom: solid 1px black;
+  width: 100%;
+  padding: 10px;
+  text-align: center;
+}
+
+
+.announcement.non-bootstrap a {
+    font-size: 12px;
+    margin-left: 5px;
+    color: #6E5910;
+  }
+}
+
+.announcement.non-bootstrap.yellow {
+  background-color: #fcf8e3;
+  color: #c09853;
+}
+
+.announcement.non-bootstrap.red {
+  background-color: #f2dede;
+/*  border-color: #eed3d7;*/
+  color: #b94a48;
+}
+
+.announcement.non-bootstrap.green {
+  background-color: #dff0d8;
+/*  border-color: #d6e9c6;*/
+  color: #468847;
+}
+  
+.announcement.non-bootstrap.blue {
+  background-color: #d9edf7;
+/*  border-color: #bce8f1;*/
+  color: #3a87ad;
+}
+
+form.announcement-detail label{
+  margin-bottom: 0.4em;
+}

data/lib/user_announcements/engine.rb

@@ -1,23 +1,28 @@
 module UserAnnouncements
   
   class Engine < ::Rails::Engine
+
     config.generators.integration_tool :rspec
     config.generators.test_framework :rspec
     
-    config.bootstrap = true
-  
-    config.default_active = true
-    config.default_starts_at = lambda { Time.now.in_time_zone }
-    config.default_ends_at = lambda { 1.week.from_now.in_time_zone.end_of_day }
-    
-    config.roles = []
-    config.types = []
-    config.styles = %w(error succes info)
-    
   end
   
   def self.config(&block)
     yield Engine.config if block
     Engine.config
   end
+  
+  def self.[](key)
+    setting = config.send(key)
+    
+    if setting.is_a?(Proc)
+      setting.call
+    else
+      setting
+    end
+    
+  rescue NameError
+    Rails.logger.debug "[UserAnnouncements] Tried to access unknown UserAnnouncements.config key: #{key.inspect}"
+    nil
+  end
 end

data/lib/user_announcements/version.rb

@@ -1,3 +1,3 @@
 module UserAnnouncements
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: user_announcements
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-24 00:00:00.000000000 Z
+date: 2013-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -339,8 +339,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - app/controllers/admin/announcements_controller.rb
-- app/controllers/admin/base_controller.rb
 - app/controllers/hidden_announcements_controller.rb
+- app/helpers/user_announcements/admin_helper.rb
+- app/helpers/user_announcements/misc_helper.rb
+- app/helpers/user_announcements/roles_helper.rb
+- app/helpers/user_announcements/show_announcements.rb
+- app/helpers/user_announcements/style_helper.rb
 - app/helpers/user_announcements_helper.rb
 - app/models/announcement.rb
 - app/models/announcement_finder.rb
@@ -355,9 +359,9 @@ files:
 - app/views/hidden_announcements/index.html.erb
 - config/routes.rb
 - lib/generators/user_announcements/install_generator.rb
-- lib/generators/user_announcements/templates/css.scss
 - lib/generators/user_announcements/templates/initializer.rb
 - lib/generators/user_announcements/templates/migration.rb
+- lib/generators/user_announcements/templates/template.css
 - lib/tasks/user_announcements_tasks.rake
 - lib/user_announcements/engine.rb
 - lib/user_announcements/version.rb
@@ -389,7 +393,6 @@ rubyforge_project:
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: Manage and display site-wide announcements by user, role and announcement
-  type.
+summary: Manage and display site-wide announcements by user, scoped by user role.
 test_files: []
 has_rdoc: 

data/app/controllers/admin/base_controller.rb

@@ -1,12 +0,0 @@
-class Admin::BaseController < ApplicationController
-  before_filter :ensure_admin_user
-
-  private
-  
-  def ensure_admin_user
-    # FIXME
-    # unless current_user.has_role?(:admin)
-    #   redirect_to root_path
-    # end
-  end
-end

data/lib/generators/user_announcements/templates/css.scss

@@ -1,33 +0,0 @@
-table.ua-table {
-
-  td.date {
-    white-space: nowrap;
-  }
-
-  &.non-bootstrap {
-    border: 1px solid black;
-  
-    th, td {
-      border: 1px solid black;
-      padding: 0.5em;
-    }
-
-    td {
-      vertical-align: top;
-    }
-  
-  }
-}
-
-.announcement.non-bootstrap {
-  width: 100%;
-  background-color: #F1F094;
-  border-bottom: solid 1px black;
-  padding: 10px;
-  text-align: center;
-  a {
-    font-size: 12px;
-    margin-left: 5px;
-    color: #6E5910;
-  }
-}