RubyGems - user_announcements - Versions diffs - 0.0.1 → 0.0.2 - Mend

user_announcements 0.0.1 → 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (19) hide show

data/README.md CHANGED Viewed

@@ -1,5 +1,71 @@
-# UserAnnouncements
+# user_announcements
-Manage and display site-wide announcements by user, role and announcement type.
+[![Gem Version](https://badge.fury.io/rb/user_announcements.png)](http://badge.fury.io/rb/user_announcements)
+[![Code Climate](https://codeclimate.com/github/stevedowney/user_announcements.png)](https://codeclimate.com/github/stevedowney/user_announcements)
-## Under construction
+Manage and display site-wide announcements on a per-user basis.
+Coming soon, scope by user role and announcement type.
+### Acknowledgements
+This gem was inspired by the [Site-Wide Announcements (revised)](http://railscasts.com/episodes/103-site-wide-announcements-revised)
+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).
+## Installation
+Add it to your Gemfile:
+```ruby
+gem "user_announcements"
+```
+Run bundler:
+```sh
+bundle install
+```
+Install files:
+```sh
+rails generate user_announcements:install
+```
+By default, Bootstrap styling is applied.  This can be turned on/off:
+```ruby
+# ../config/initializers/user_announcements.rb
+  # control Bootstrap styling
+  # c.bootstrap = false
+  c.bootstrap = true
+```
+Don't forget to restart your Rails server.
+## Getting Going
+To create an announcement go to:
+```
+http://<your app>/admin/announcements
+```
+To see the announcment add the helper method to your views, e.g.:
+```erb
+#../layouts/application.html.erb
+<body>
+  <%= user_announcements %>
+  ...
+```
+Non-admin users can see (and unhide) announcements they have hidden:
+```
+http://<your app>/announcements
+```

data/app/controllers/admin/announcements_controller.rb CHANGED Viewed

@@ -2,7 +2,7 @@ class Admin::AnnouncementsController <  Admin::BaseController
   before_filter :find_announcement, :only => [:edit, :update, :destroy]
   def index
-    @announcements = Announcement.all#AnnouncementFinder.ordered
+    @announcements = AnnouncementFinder.ordered
   end
   def new

data/app/helpers/user_announcements_helper.rb CHANGED Viewed

@@ -1,10 +1,7 @@
 module UserAnnouncementsHelper
-  # style: "warning"
-  # type: "blog"
-  # role: "admin super-admin"
-  def announcements(options={})
+  # Helper method for displaying messages for +current_user+.
+  def user_announcements(options={})
     return if controller.controller_name == 'user_announcements'
     announcements_rows = AnnouncementFinder.current_for_user(current_user)
@@ -16,21 +13,27 @@ module UserAnnouncementsHelper
   end
   def announcement_div(announcement)
-    # <div class="alert">
-    #   <button type="button" class="close" data-dismiss="alert">&times;</button>
-    #   <strong>Warning!</strong> Best check yo self, you're not looking too good.
-    # </div>
+    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_user_announcement_path(announcement), remote: true) do
-        content_tag(:button, raw('&times;'), type: 'button', class: 'close', data: {dismissx: 'alert'})
+        content_tag(:button, raw('&times;'), type: 'button', class: 'close')
       end +
-      announcement.body.html_safe
+      announcement.message.html_safe
+    end
+  end
+  def announcement_div_non_bootstrap(announcement)
+    div_for(announcement, class: 'non-bootstrap') do
+      announcement.message.html_safe +
+      link_to("hide announcement", hide_user_announcement_path(announcement), remote: true)
     end
-    # div_for(announcement) do
-    #   announcement.body.html_safe +
-    #   link_to("hide announcement", 'hide_announcement_path(announcement)', remote: true)
-    # end
   end
   def unhide_announcement_link(announcement)
@@ -41,6 +44,20 @@ module UserAnnouncementsHelper
     end
   end
+  def ua_table_attrs
+    if bootstrap?
+      {class: "table table-striped table-bordered table-condensed table-hover"}
+    else
+      {class: 'ua-table'}
+    end
+  end
+  def ua_table_tag(options={})
+    content_tag(:table, options.merge(ua_table_attrs)) do
+      yield
+    end
+  end
   def boolean_display(boolean)
     ( boolean ? '&#10004;' : '&nbsp;' ).html_safe
   end
@@ -63,4 +80,11 @@ module UserAnnouncementsHelper
     end
   end
+  def bootstrap?
+    if params.has_key?(:bootstrap)
+      params[:bootstrap] == 'true'
+    else
+      UserAnnouncements.config.bootstrap
+    end
+  end
 end

data/app/models/announcement.rb CHANGED Viewed

@@ -1,17 +1,18 @@
 class Announcement < ActiveRecord::Base
-  attr_accessible :body, :starts_at, :ends_at, :active
+  attr_accessible :message, :starts_at, :ends_at, :active
   has_many :user_announcements, :dependent => :destroy
-  validates_presence_of :body, :starts_at, :ends_at
+  validates_presence_of :message, :starts_at, :ends_at
+  INACTIVE = 'inactive'
   PAST = 'past'
   CURRENT = 'current'
   FUTURE = 'future'
   def status
     case
+    when active.presence.nil? then INACTIVE
     when ends_at.try(:past?) then PAST
     when starts_at.try(:future?) then FUTURE
     else CURRENT
@@ -23,18 +24,21 @@ class Announcement < ActiveRecord::Base
   end
   def status_order
-    { FUTURE => 1, CURRENT => 2, PAST => 3 }[status]
+    { FUTURE => 1, CURRENT => 2, PAST => 3, INACTIVE => 4 }[status]
   end
   class << self
+    def active
+      where(active: true)
+    end
     def new_with_defaults
       new do |ann|
         ann.active = true
         ann.starts_at = Time.now.at_beginning_of_day
         ann.ends_at = 1.week.from_now.at_midnight
       end
     end
   end

data/app/models/announcement_finder.rb CHANGED Viewed

@@ -2,17 +2,22 @@ class AnnouncementFinder
   class << self
-    # def ordered
-    #   Announcement.all.sort_by(&:status_order)
-    # end
+    def ordered
+      Announcement.all.sort_by(&:status_order)
+    end
     def current
-      Announcement.where("(starts_at is null or starts_at < :now) and (ends_at is null or ends_at > :now)", :now => DateTime.now)
+      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
     def past_or_current
-      Announcement.where("(starts_at is null or starts_at < :now)", :now => DateTime.now).order('created_at desc')
+      Announcement
+        .active
+        .where("(starts_at is null or starts_at < :now)", :now => DateTime.now)
+        .order('created_at desc')
     end
     def current_for_user(user)

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

@@ -1,7 +1,7 @@
 <tr id="<%= dom_id(announcement) %>" class='<%= announcement.status %>'>
-  <td><%=raw announcement.body %></td>
-  <td><%= announcement.starts_at.try(:to_s, :db) %></td>
-  <td><%= announcement.ends_at.try(:to_s, :db) %></td>
+  <td><%=raw announcement.message %></td>
+  <td class='date'><%= announcement.starts_at.try(:to_s, :db) %></td>
+  <td class='date'><%= announcement.ends_at.try(:to_s, :db) %></td>
   <td><%= announcement.status %></td>
   <td><%= boolean_display(announcement.active)%></td>
   <td><%= link_to('edit', edit_admin_announcement_path(announcement), :class => 'btn btn-mini') %></td>

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

@@ -4,8 +4,8 @@
   <%#= f.input(:starts_at, :as => :string, :input_html => {class: 'datepicker'}) %>
   <%#= f.input(:ends_at, :as => :string, :input_html => {class: 'datepicker'}) %>
   <p>
-    <%= f.label(:body) %>
-    <%= f.text_area :body, size: "60x10", class: 'span6' %>
+    <%= f.label(:message) %>
+    <%= f.text_area :message, size: "60x10", class: 'span6' %>
   </p>
   <%= ua_datetime_p(f, :starts_at) %>

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

@@ -1,10 +1,10 @@
-<h1>Announcements</h1>
+<h1>Administer Announcements</h1>
 <p>
   <%= link_to('New Announcement', new_admin_announcement_path(), :class => 'btn btn-primary') %>
 </p>
-<table id="admin-announcements" class="table table-striped table-bordered table-condensed table-hover">
+<%= ua_table_tag(id: 'admin-announcements') do %>
   <thead>
     <tr>
       <th>Announcement</th>
@@ -19,4 +19,4 @@
   <tbody>
     <%= render @announcements %>
   </tbody>
-</table>
+<% end %>

data/app/views/user_announcements/_announcement.html.erb CHANGED Viewed

@@ -1,14 +1,8 @@
 <tr id="<%= dom_id(announcement) %>">
   <td class='date'><%= announcement.created_at.try(:to_s, :db) %></td>
   <td>
-    <%= announcement.body.html_safe %>
+    <%= announcement.message.html_safe %>
     <%= unhide_announcement_link(announcement) %>
   </td>
-</tr>
-<style>
-  td.date {
-    white-space: nowrap;
-    vertical-align: top;
-  }
-</style>
+</tr>

data/app/views/user_announcements/index.html.erb CHANGED Viewed

@@ -1,6 +1,6 @@
 <h1>Announcements</h1>
-<table border="1" cellspacing="0" cellpadding="4">
+<%= ua_table_tag(id: 'user-announcements') do %>
   <thead>
     <tr>
       <th>Date</th>
@@ -10,4 +10,5 @@
   <tbody>
     <%= render partial: 'user_announcements/announcement', collection: @announcements %>
   </tbody>
-</table>
+<% end %>

data/lib/generators/user_announcements/install_generator.rb ADDED Viewed

@@ -0,0 +1,27 @@
+require 'rails/generators/active_record/migration'
+module UserAnnouncements
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      extend ActiveRecord::Generators::Migration
+      source_root File.join(File.dirname(__FILE__), "templates")
+      desc <<DESC
+Description:
+    Copies stylesheet    to 'app/assets/stylesheets/user_announcements.css.scss'
+    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 "initializer.rb", 'config/initializers/user_announcements.rb'
+        migration_template "migration.rb", "db/migrate/create_user_announcement_tables.rb"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+table.ua-table {
+  border: 1px solid black;
+  th, td {
+    border: 1px solid black;
+    padding: 0.5em;
+  }
+  td {
+    vertical-align: top;
+    &.date {
+      white-space: nowrap;
+    }
+  }
+}
+.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;
+  }
+}

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

@@ -0,0 +1,6 @@
+UserAnnouncements.config do |c|
+  # uncomment to user Bootstrap styling
+  # c.bootstrap = true
+end

data/lib/generators/{templates/create_user_announcement_tables.rb → user_announcements/templates/migration.rb} RENAMED Viewed

@@ -1,10 +1,12 @@
 class CreateUserAnnouncementTables < ActiveRecord::Migration
   def change
     create_table :announcements do |t|
-      t.text :body
+      t.text :message
       t.datetime :starts_at
       t.datetime :ends_at
       t.boolean :active
+      t.text :roles
+      t.text :types
       t.timestamps
     end
@@ -13,5 +15,8 @@ class CreateUserAnnouncementTables < ActiveRecord::Migration
       t.integer :announcement_id
       t.timestamps
     end
+    add_index :user_announcements, :user_id
+    add_index :user_announcements, :announcement_id
   end
 end

data/lib/user_announcements/engine.rb CHANGED Viewed

@@ -2,5 +2,12 @@ module UserAnnouncements
   class Engine < ::Rails::Engine
     config.generators.integration_tool :rspec
     config.generators.test_framework :rspec
+    config.bootstrap = false
+  end
+  def self.config(&block)
+    yield Engine.config if block
+    Engine.config
   end
 end

data/lib/user_announcements/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module UserAnnouncements
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: user_announcements
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease:
 platform: ruby
 authors:
@@ -290,9 +290,10 @@ files:
 - app/views/user_announcements/hide.js.erb
 - app/views/user_announcements/index.html.erb
 - config/routes.rb
-- db/migrate/20130521175710_create_announcements.rb
-- lib/generators/templates/create_user_announcement_tables.rb
-- lib/generators/user_announcements_generator.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/tasks/user_announcements_tasks.rake
 - lib/user_announcements/engine.rb
 - lib/user_announcements/version.rb
@@ -313,18 +314,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1264060976197441369
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1264060976197441369
 requirements: []
 rubyforge_project:
 rubygems_version: 1.8.25

data/db/migrate/20130521175710_create_announcements.rb DELETED Viewed

@@ -1,9 +0,0 @@
-class CreateUserAnnouncementTables < ActiveRecord::Migration
-  def change
-    create_table :announcements do |t|
-      t.text :body
-      t.timestamps
-    end
-  end
-end

data/lib/generators/user_announcements_generator.rb DELETED Viewed

@@ -1,32 +0,0 @@
-require 'rails/generators/active_record/migration'
-class UserAnnouncementsGenerator < Rails::Generators::Base
-  include Rails::Generators::Migration
-  extend ActiveRecord::Generators::Migration
-  desc "Put the code"
-  source_root File.join(File.dirname(__FILE__), "templates")
-  def install
-    # copy_javascript if needs_js_copied?
-    migration_template "create_user_announcement_tables.rb", "db/migrate/create_user_announcement_tables.rb"
-  end
-  private
-  def copy_javascript
-    copy_file File.join(javascript_path, 'announcements.js'), js_destination
-  end
-  def javascript_path
-    File.join(%w(.. .. .. .. app assets javascripts))
-  end
-  def needs_js_copied?
-    ::Rails.version < '3.1' || !::Rails.application.config.assets.enabled
-  end
-  def js_destination
-    'public/javascripts/announcements.js'
-  end
-end