gubbara 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b180c17e9b04468098b457d14fd4e89f00029c16
-  data.tar.gz: dcff530806919bf0d2f0fb01a9faabf58d1890e7
+  metadata.gz: ebf4b07c28b80ae36e8b76a67bc39a2f179bb694
+  data.tar.gz: 069c8a642bcb7124adf837777af5088ddffb4ed2
 SHA512:
-  metadata.gz: e92ce7ae929ef14cf95d7b566c2861a262428108cd68cdc84bc2cc4ee48627aab477e9981b04cf5bd5fe2f7434b3418cbf2adfab5585024db38b4cc33fdcf4fa
-  data.tar.gz: c3c8b4fea8306dd177f597eaa621290477be82752e61beab311405da0c3d8679fbacc7c90a5ae630572be7bbf76b5cadc34f1156c219b0788ff04c5b256588d3
+  metadata.gz: c05e17995d850242ed3862bf5f184603b0caf668d53afb400e0fd78448d14d733d8953b94d2a79cf30ce8a10c1cafb7116bcb31d5d60d32ce90ce99c99b330fd
+  data.tar.gz: 7108fd14e66964d95131a9568c9731921401c89eeb4f167483349d718a85de0b68883fd0605c13a7436742ee04051206e244d7873d6cfa7f8593e49addb4ddb5

data/README.rdoc

@@ -1,6 +1,9 @@
 = Gubbara
 
-It helps admin to announce anything to every user in the system in a form of a notice which is configurable also every user has an option to hide it and will not appear till session expires or disabled by admin.
+It helps admin to announce anything including pasrsed html in a form a notice.It consists two types of announcements:
+
+- Session Based: Only for logged in users.(Application Layout)
+- Cookie Based: For all users visting the website.(Public Layout)
 
 == Installation
 
@@ -26,25 +29,57 @@ To use this gem you just need to mount it in your route file *config/routes.rb*
 
 <tt>mount Gubbara::Engine => '/gubbara'</tt>
 
-Place this helper method in any layout or any view page where you want to place your notice.
+Place the helper method according to your requirement in any layout or any view page where you want to place your notice.
 
-example: place this in *app/views/layouts/application.html.erb* file
+=== Session Based Announcements
 
-<tt><%= list_notices %></tt>
+For session based announcements place this helper method in the layout which is not publicly accessible.
 
-==  Hide
+example: place this in *app/views/layouts/application.html.erb* file.
 
-When a user clicks on the cross button it hides the template for that session and will not show till the session expires or disabled by admin.
+<tt><%= user_announcements %></tt>
+
+=== Cookie Based Announcements
+
+For cookie based announcements place this helper method in the layout which is publicly accessible.
+
+example: place this in *app/views/layouts/public.html.erb* file.
 
-== Admin Accesss
+<tt><%= public_announcements %></tt>
 
-You can access 'Gubbara Admin Panel'.
+==  Features
 
-Please ensure that only admin can access this gubbara panel to do that you can use *http_basic_authenticate_with*.
+=== Admin Panel
 
-== Configuration
+You can access Gubbara Admin Panel.
+
+Please ensure that only admin can access this gubbara panel to do that you can use *http_basic_authenticate_with* or some other methods to prevent that url.
+
+=== Configuration
 
 You can configure *background_color*, *font_color*, *font_size*, *text_alignment*, *z_index* and even *cross_button_color* of that notice.
 
 It also can disable the notice when notice will not be needed any more.
 
+=== Disable 
+
+You can disable the announcement from the admin panel when you don't want your users to see that announcement anymore.
+
+=== Html Parsing
+
+You can even put your complete html in the text field and the output would be html parsed announcement.
+
+=== Hide
+
+==== Session
+
+When a user clicks on the cross button it hides the template for that session and will not show till the session expires or disabled by admin.
+
+==== Cookie
+
+When a user clicks on the cross button it hides the template and user will not be able to see that annoucement again on that broswer because cookies are permanent and also the expiry date of cookies are 1 year. 
+
+== Note
+
+There may be the situations that you want to play with the CSS of annoucements so you can play with it.
+Structure of it is like Notices is parent class for all the annoucements.

data/app/controllers/gubbara/notices_controller.rb

@@ -2,8 +2,8 @@ require_dependency "gubbara/application_controller"
 
 module Gubbara
   class NoticesController < ApplicationController
-
-    before_action :find_notice, only: [:edit, :update, :destroy]
+    skip_filter *_process_action_callbacks.map(&:filter), :only => [:hide]
+    before_action :find_notice, only: [:edit, :update, :destroy, :hide]
 
     def new
       @notice = Gubbara::Notice.new
@@ -32,18 +32,24 @@ module Gubbara
     end
 
     def hide
-      session[:hidden_notices] ||= []
-      session[:hidden_notices].push(params[:id])
+      if @notice.base == 'session'
+        session[:hidden_notices] ||= []
+        session[:hidden_notices].push(@notice.id)
+      else
+        cookies.permanent[:hidden_public_notices] ||= ''
+        cookies[@notice.id.to_s] = {value: @notice.id.to_s, expires: 1.year.from_now}
+        cookies.permanent[:hidden_public_notices] += " #{@notice.id.to_s}"
+      end
     end
 
     private
 
     def find_notice
-      @notice =  Gubbara::Notice.where(id: params[:id]).take
+      @notice = Gubbara::Notice.where(id: params[:id]).take
     end
 
     def notice_params
-      params.require(:notice).permit(:message, :active, :background_color, :font_color, :font_size, :text_align, :cross_button_color, :z_index)
+      params.require(:notice).permit(:message, :active, :background_color, :font_color, :font_size, :text_align, :cross_button_color, :z_index, :base)
     end
   end
 end

data/app/helpers/gubbara/application_helper.rb

@@ -1,7 +1,12 @@
 module Gubbara
   module ApplicationHelper
-    def list_notices
-      session[:hidden_notices] ? @notices = Gubbara::Notice.where("gubbara_notices.id not in (?) and gubbara_notices.active not in (?)", session[:hidden_notices], false) : @notices = Gubbara::Notice.where("gubbara_notices.active not in (?)", false)
+    def user_announcements
+      session[:hidden_notices] ? @notices = Gubbara::Notice.where("gubbara_notices.id not in (?) and gubbara_notices.active not in (?) and gubbara_notices.base not in (?)", session[:hidden_notices], false, 'cookie') : @notices = Gubbara::Notice.where("gubbara_notices.active not in (?) and gubbara_notices.base not in (?)", false, 'cookie')
+      render(:partial => 'gubbara/application/fetch_notices', locale: {notices: @notices})
+    end
+
+    def public_announcements
+      cookies[:hidden_public_notices] ? @notices = Gubbara::Notice.where("gubbara_notices.id not in (?) and gubbara_notices.active not in (?) and gubbara_notices.base not in (?)", cookies[:hidden_public_notices].split, false, 'session') : @notices = Gubbara::Notice.where("gubbara_notices.active not in (?) and gubbara_notices.base not in (?)", false, 'session')
       render(:partial => 'gubbara/application/fetch_notices', locale: {notices: @notices})
     end
   end

data/app/views/gubbara/application/_notice.html.erb

@@ -1,5 +1,5 @@
 <div class="notice_panel notice_<%= user_notice.id %>" style="background: <%= user_notice.background_color %>; width: 100%; position: relative; float: left; clear: both; padding: 10px 10px; text-align: <%= user_notice.text_align %>; font-size: <%= user_notice.font_size %>; z-index: <%= user_notice.z_index %>; line-height: normal;">
-  <p style="margin: 0px; padding: 0px; line-height: normal; color: <%= user_notice.font_color%>;"><%= user_notice.message %></p>
+  <p style="margin: 0px; padding: 0px; line-height: normal; color: <%= user_notice.font_color%>;"><%= user_notice.message.html_safe %></p>
 
   <div style="position: absolute; top: 8px; color: #ffffff; font-size: 14px; right: 15px; z-index: 101;"><%= link_to 'X', gubbara.hide_notice_path(user_notice), method: :post, remote: true, title: 'X', class: 'cross_button', style: "color: #{user_notice.cross_button_color};" %></div>
 </div>

data/app/views/gubbara/notices/_form.html.erb

@@ -47,6 +47,13 @@
         <%= f.check_box :active %>
       </div>
     </div>
+    <div class="form-group">
+      <%= f.label :base, class: 'control-label col-sm-4' %>
+      <div class="col-sm-4">
+        Session <%= f.radio_button :base, 'session', checked: true %>
+        Cookie <%= f.radio_button :base, 'cookie' %>
+      </div>
+    </div>
     <div class="actions">
       <div class="col-sm-offset-4 col-sm-4">
         <% if params[:action] == 'edit' %>

data/app/views/gubbara/notices/index.html.erb

@@ -14,6 +14,7 @@
       <th>text_align</th>
       <th>cross_button_color</th>
       <th>z_index</th>
+      <th>base</th>
       <th>Actions</th>
     </tr>
     </thead>
@@ -29,6 +30,7 @@
           <td><%= notice.text_align %></td>
           <td><%= notice.cross_button_color %></td>
           <td><%= notice.z_index %></td>
+          <td><%= notice.base %></td>
           <td><%= link_to 'Edit', edit_notice_path(notice) %>
             <%= link_to 'Delete', notice, action: :delete, method: :delete %></td>
         </tr>

data/db/migrate/20151103123233_create_gubbara_notices.rb

@@ -9,6 +9,7 @@ class CreateGubbaraNotices < ActiveRecord::Migration
       t.string :text_align, default: 'center'
       t.string :cross_button_color, default: '#ffffff'
       t.string :z_index, default: '9999'
+      t.string :base
 
       t.timestamps
     end

data/lib/gubbara/version.rb

@@ -1,3 +1,3 @@
 module Gubbara
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gubbara
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - nitanshu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-26 00:00:00.000000000 Z
+date: 2017-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,9 +24,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: It helps admin to announce anything to every user in the system in a
-  form of a notice which is configurable also every user has an option to hide it
-  and will not appear till session expires or disabled by admin.
+description: 'It helps admin to announce anything including pasrsed html in a form
+  a notice.It consists two types of announcements: Session Based: Only for logged
+  in users.(Application Layout), Cookie Based: For all users visting the website.(Public
+  Layout)'
 email:
 - nitanshu1991@gmail.com
 executables: []