announcements 0.1.0 → 0.2.0

data/.gitignore

@@ -1,10 +1,10 @@
-.DS_Store
-.bundle
-db/*.sqlite3
-log/*.log
-tmp/
-.sass-cache/
-.idea/
+.DS_Store
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/
+.sass-cache/
+.idea/
 *.gem
 .bundle
 Gemfile.lock

data/.rspec

@@ -1 +1 @@
-"--color" 
+"--color" 

data/LICENSE

@@ -1,20 +1,20 @@
-Copyright (c) 2012 Svilen Gospodinov
-
-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
+Copyright (c) 2012 Svilen Gospodinov
+
+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

@@ -1,90 +1,90 @@
-# announcements
-
-The Announcements gem provides an easy way to publish short messages in your views, which the user can then hide permanently.
-It was influenced by the gem `paul_revere` by thoughtbot, but unlike `paul_revere`, `announcements` doesn't use partials (instead,
-there is a single helper method which you can customise) and is a bit more flexible (you have an additional 'type' attribute by default). Announcements can also output text in a twitter-bootstrap style format (see below).
-
-## Quick start
-
-1. Requirements: rails >= 3.1.0 and jquery-rails
-2. Add `gem 'announcements'` to your Gemfile and run `bundle`
-3. Run `rails g announcements:install`
-4. Use `<%= announce Announcement.newest %>` in your views to display the latest announcement
-5. Create your first announcement in `rails c` by simply creating a new Announcement record, like `Announcement.create(:body => 'This is my first announcement!')`
-6. Next, relax bootstrap's got the rest.
-
-## Styling
-
-By default, the announcement text and hide message text are wrapped in a div called "info" (if you want to customise that, see the Customisation section below).
-You can use the following css in your application.css file to start:
-
-```css
-.info {
-	background: #D5EDF8;
-	color: #205791;
-	padding: 0.8em;
-	margin-bottom: 1em;
-	border: 2px solid #92CAE4;
-}
-
-.hide_announcement {
-	cursor: pointer;
-	float: right;
-}
-```
-
-## Customization
-
-The default HTML output of the `announce` helper is
-
-```html
-<div class="info">
-	My announcement!
-	<span class="hide_announcement" data-announcementid="1">hide message</span>
-</div>
-```
-
-The default div class is `info`. You can customise it like that:
-
-```
-<%= announce Announcement.newest, :div_class => "mydiv" %>
-```
-
-You can also change the "hide message" text:
-
-```
-<%= announce Announcement.newest, :hide_message => "×" %>
-```
-
-The output from the helper is marked as html_safe, so you can have links or add more formatting in the announcement text itself.
-
-## For Twitter Bootstrap users
-
-A new option has been added to `announcements` to display alerts in the `twitter-bootstrap` [style](http://twitter.github.com/bootstrap/components.html#alerts) through the following usage:
-
-```
-<%= announce Announcement.newest, :format => "bootstrap" %>
-```
-
-You can also change the "alert heading" text (twitter bootstrap option only):
-
-```
-<%= announce Announcement.newest, {:format => "bootstrap", :alert_heading => "Achtung!"} %>
-```
-
-Be sure to use one of the twitter-bootstrap gems.
-
-## How it works
-
-The gem creates an Announcement model with a few class methods like `Announcement.newest`. The Announcement model has a body:text (the actual announcement text) 
-and a type:string (which you can use for different types of announcements, e.g. public (everyone) and private (only for registered users)). There is also a js file in vendor/assets/javascripts
-which permanently hides the announcement by creating a cookie (that's when you click on the 'hide message' text).
-
-## How to uninstall
-
-There is no uninstaller at this point, but you can simply remove the following files manually:
-
-1. app/models/announcement.rb
-2. vendor/assets/javascripts/announcements.js
-
+# announcements
+
+The Announcements gem provides an easy way to publish short messages in your views, which the user can then hide permanently.
+It was influenced by the gem `paul_revere` by thoughtbot, but unlike `paul_revere`, `announcements` doesn't use partials (instead,
+there is a single helper method which you can customise) and is a bit more flexible (you have an additional 'type' attribute by default). Announcements can also output text in a twitter-bootstrap style format (see below).
+
+## Quick start
+
+1. Requirements: rails >= 3.1.0 and jquery-rails
+2. Add `gem 'announcements'` to your Gemfile and run `bundle`
+3. Run `rails g announcements:install`
+4. Use `<%= announce Announcement.newest %>` in your views to display the latest announcement
+5. Create your first announcement in `rails c` by simply creating a new Announcement record, like `Announcement.create(:body => 'This is my first announcement!')`
+6. You're done! You can now add some styling and have a look at the customization options below.
+
+## Styling
+
+By default, the announcement text and hide message text are wrapped in a div called "info" (if you want to customise that, see the Customisation section below).
+You can use the following css in your application.css file to start:
+
+```css
+.info {
+	background: #D5EDF8;
+	color: #205791;
+	padding: 0.8em;
+	margin-bottom: 1em;
+	border: 2px solid #92CAE4;
+}
+
+.hide_announcement {
+	cursor: pointer;
+	float: right;
+}
+```
+
+## Customization
+
+The default HTML output of the `announce` helper is
+
+```html
+<div class="info">
+	My announcement!
+	<span class="hide_announcement" data-announcementid="1">hide message</span>
+</div>
+```
+
+The default div class is `info`. You can customise it like that:
+
+```
+<%= announce Announcement.newest, :div_class => "mydiv" %>
+```
+
+You can also change the "hide message" text:
+
+```
+<%= announce Announcement.newest, :hide_message => "×" %>
+```
+
+The output from the helper is marked as html_safe, so you can have links or add more formatting in the announcement text itself.
+
+## For Twitter Bootstrap users
+
+A new option has been added to `announcements` to display alerts in the `twitter-bootstrap` [style](http://twitter.github.com/bootstrap/components.html#alerts) through the following usage:
+
+```
+<%= announce Announcement.newest, :format => "bootstrap" %>
+```
+
+You can also change the "alert heading" text (twitter bootstrap option only):
+
+```
+<%= announce Announcement.newest, {:format => "bootstrap", :alert_heading => "Achtung!"} %>
+```
+
+Be sure to use one of the twitter-bootstrap gems.
+
+## How it works
+
+The gem creates an Announcement model with a few class methods like `Announcement.newest`. The Announcement model has a body:text (the actual announcement text) 
+and a type:string (which you can use for different types of announcements, e.g. public (everyone) and private (only for registered users)). There is also a js file in vendor/assets/javascripts
+which permanently hides the announcement by creating a cookie (that's when you click on the 'hide message' text).
+
+## How to uninstall
+
+There is no uninstaller at this point, but you can simply remove the following files manually:
+
+1. app/models/announcement.rb
+2. vendor/assets/javascripts/announcements.js
+
 You also have to remove the `//= require announcements` line in your app/assets/javascripts/application.js file, and rollback the `create_announcements` migration.

data/announcements.gemspec

@@ -1,26 +1,26 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "announcements/version"
-
-Gem::Specification.new do |s|
-  s.name        = "announcements"
-  s.version     = Announcements::VERSION
-  s.authors     = ["Svilen Gospodinov", "Chase Southard"]
-  s.email       = "svilen@gospodinov.co.uk"
-  s.homepage    = "https://github.com/svileng/announcements"
-  s.summary     = "Announcements gem for Rails"
-  s.description = "The Announcements gem makes it easier to display short announcement messages in your views"
-
-  s.rubyforge_project = "announcements"
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-
-  s.add_development_dependency "rspec"
-
-  s.add_runtime_dependency "rails", "~> 3.1"
-  s.add_runtime_dependency "jquery-rails"
-
-end
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "announcements/version"
+
+Gem::Specification.new do |s|
+  s.name        = "announcements"
+  s.version     = Announcements::VERSION
+  s.authors     = ["Svilen Gospodinov", "and others"]
+  s.email       = "svilen.gospodinov@gmail.com"
+  s.homepage    = "https://github.com/svileng/announcements"
+  s.summary     = "Announcements gem for Rails"
+  s.description = "The Announcements gem makes it easier to display short announcement messages in your views"
+
+  s.rubyforge_project = "announcements"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+
+  s.add_runtime_dependency "rails", ">= 3.1.0"
+  s.add_runtime_dependency "jquery-rails"
+
+end

data/lib/announcements/announcements_helper.rb

@@ -1,40 +1,40 @@
-module AnnouncementsHelper
-
-	# Outputs given announcement in HTML (with optional twitter bootstrap style).
-	# 
-	# Basic usage: <%= announce Announcement.newest %>
-	# Alt usage: <%= announce Announcement.newest, :format => "boostrap" %>
-	#
-	# Options:
-	#   div_class -- name for a custom div class, which wraps the announcement text and hide message, default is "info"
-	#   hide_message -- clickable text which hides the announcement, default is "hide message"
-	#   format[:boostrap] -- format announcement to use the twitter bootstrap Alert style, defaults to normals stylings.
-	#   alert_heading -- Adding an alert heading when used with the bootstrap option.
-	def announce announcement, options = {}
-		result = nil
-    data_attribute = { :announcementid => announcement.id }
-
-    if announcement != nil && cookies["announcement_" + announcement.id.to_s] != "hidden"
-      if options[:format] == "bootstrap"
-        text = options[:hide_message] || "x"
-        div_class = options[:div_class] || "alert alert-block"
-        alert_heading = options[:alert_heading] || "Warning!"
-
-        close_content_tag = content_tag(:a, text, :class => "close", data: data_attribute)
-        alert_content_tag = content_tag(:h4, alert_heading, :class => "alert-heading")
-
-        result = content_tag(:div, close_content_tag + alert_content_tag + announcement.body.html_safe, class: div_class)
-      else
-        text = options[:hide_message] || "hide message"
-        div_class = options[:div_class] || "info"
-
-        close_content_tag = content_tag(:span, text, :class => "hide_announcement", data: data_attribute)
-
-        result = content_tag(:div, announcement.body.html_safe + close_content_tag, class: div_class)
-      end
-    end
-
-    result
-	end
-
-end
+module AnnouncementsHelper
+
+  # Outputs given announcement in HTML (with optional twitter bootstrap style).
+  #
+  # Basic usage: <%= announce Announcement.newest %>
+  # Alt usage: <%= announce Announcement.newest, :format => "boostrap" %>
+  #
+  # Options:
+  # div_class -- name for a custom div class, which wraps the announcement text and hide message, default is "info"
+  # hide_message -- clickable text which hides the announcement, default is "hide message"
+  # format[:boostrap] -- format announcement to use the twitter bootstrap Alert style, defaults to normals stylings.
+  # alert_heading -- Adding an alert heading when used with the bootstrap option.
+  def announce announcement, options = {}
+    result = nil
+
+    if announcement != nil && cookies["announcement_" + announcement.id.to_s] != "hidden"
+      data_attribute = { :announcementid => announcement.id }
+      if options[:format] == "bootstrap"
+        text = options[:hide_message] || "x"
+        div_class = options[:div_class] || "alert alert-warning"
+        alert_heading = announcement.try(:heading) || options[:alert_heading] || "Warning!"
+
+        close_content_tag = content_tag(:a, text, :class => "close", data: data_attribute)
+        alert_content_tag = content_tag(:h4, alert_heading, :class => "alert-heading")
+
+        result = content_tag(:div, close_content_tag + alert_content_tag + announcement.body.html_safe, class: div_class)
+      else
+        text = options[:hide_message] || "hide message"
+        div_class = options[:div_class] || "info"
+
+        close_content_tag = content_tag(:span, text, :class => "hide_announcement", data: data_attribute)
+
+        result = content_tag(:div, announcement.body.html_safe + close_content_tag, class: div_class)
+      end
+    end
+
+    result
+  end
+
+end

data/lib/announcements/version.rb

@@ -1,3 +1,3 @@
-module Announcements
-  VERSION = "0.1.0"
-end
+module Announcements
+  VERSION = "0.2.0"
+end

data/lib/generators/announcements/install/install_generator.rb

@@ -8,7 +8,7 @@ module Announcements
 			say "--- Creating model in app/models..."
 			template "announcement.rb", "app/models/announcement.rb"
 			say "--- Creating the migration ..."
-			generate("model", "announcement body:text type:string --skip")
+			generate("model", "announcement body:text heading:text type:string --skip")
 			say "--- Running the migration..."
 			rake("db:migrate")	
 		end
@@ -22,4 +22,4 @@ module Announcements
 		end
 				
 	end
-end
+end

data/lib/generators/announcements/install/templates/announcement.rb

@@ -1,17 +1,17 @@
-class Announcement < ActiveRecord::Base
-
-  validates_presence_of :body
-  
-  def self.newest
-	Announcement.last
-  end
-  
-  def self.newest_private
-    Announcement.where("type is null").order("id desc").first
-  end
-
-  def self.newest_public
-    Announcement.where("type = 'public'").order("id desc").first
-  end
-  
-end
+class Announcement < ActiveRecord::Base
+
+  validates_presence_of :body
+  
+  def self.newest
+	Announcement.last
+  end
+  
+  def self.newest_private
+    Announcement.where("type is null").order("id desc").first
+  end
+
+  def self.newest_public
+    Announcement.where("type = 'public'").order("id desc").first
+  end
+  
+end

data/lib/generators/announcements/install/templates/announcements.js

@@ -1,21 +1,21 @@
-$(function() {
-
-    $('.hide_announcement, .close').click(function() {
-        var a_id = $(this).data("announcementid");
-        createCookie("announcement_" + a_id, "hidden", 45);
-        $(this).parent().slideUp();
-    });
-
-    function createCookie(name, value, days) {
-        var expires = "";
-        if (days) {
-            var date = new Date();
-            date.setTime(date.getTime() + (days*24*60*60*1000));
-            expires = "; expires=" + date.toGMTString();
-        } else {
-            expires = "";
-        }
-
-        document.cookie = name + "=" + value + expires + "; path=/";
-    }
+$(function() {
+
+    $('.hide_announcement, .close').click(function() {
+        var a_id = $(this).data("announcementid");
+        createCookie("announcement_" + a_id, "hidden", 45);
+        $(this).parent().slideUp();
+    });
+
+    function createCookie(name, value, days) {
+        var expires = "";
+        if (days) {
+            var date = new Date();
+            date.setTime(date.getTime() + (days*24*60*60*1000));
+            expires = "; expires=" + date.toGMTString();
+        } else {
+            expires = "";
+        }
+
+        document.cookie = name + "=" + value + expires + "; path=/";
+    }
 });

data/spec/announcements/announcements_helper_spec.rb

@@ -1,44 +1,44 @@
-require 'spec_helper'
-include ActionView::Context
-include ActionView::Helpers
-include AnnouncementsHelper
-
-describe AnnouncementsHelper do
-
-  before do
-    @announcement = Announcement.new
-    @announcement.id = 1
-    @announcement.body = "announcement text"
-    
-    @mocked_cookies = Hash.new
-    stub!(:cookies).and_return(@mocked_cookies)
-  end
-
-  it "should output announcement text with no params" do
-    @mocked_cookies["announcement_1"] = "not hidden"
-    output = announce(@announcement)
-    output.should include("x")
-    output.should include("announcement text")
-  end
-
-  it "should not output announcement if was already hidden by user" do
-    @mocked_cookies["announcement_1"] = "hidden"
-    output = announce(@announcement)
-    output.should be_nil
-  end
-
-  it "should output custom hide message and div class" do
-    @mocked_cookies["announcement_1"] = "not hidden"
-    output = announce(@announcement, hide_message: "X", div_class: "customdiv")
-    output.should include("<div class=\"customdiv\"")
-    output.should include(">X</span>")
-  end
-
-  it "should output bootstrap style" do 
-    @mocked_cookies["announcement_1"] = "not hidden"
-    output = announce(@announcement, format: "bootstrap")
-    output.should include("<a class=\"close\"")
-    output.should include("<h4 class=\"alert-heading\"")
-  end
-
+require 'spec_helper'
+include ActionView::Context
+include ActionView::Helpers
+include AnnouncementsHelper
+
+describe AnnouncementsHelper do
+
+  before do
+    @announcement = Announcement.new
+    @announcement.id = 1
+    @announcement.body = "announcement text"
+    
+    @mocked_cookies = Hash.new
+    stub!(:cookies).and_return(@mocked_cookies)
+  end
+
+  it "should output announcement text with no params" do
+    @mocked_cookies["announcement_1"] = "not hidden"
+    output = announce(@announcement)
+    output.should include("x")
+    output.should include("announcement text")
+  end
+
+  it "should not output announcement if was already hidden by user" do
+    @mocked_cookies["announcement_1"] = "hidden"
+    output = announce(@announcement)
+    output.should be_nil
+  end
+
+  it "should output custom hide message and div class" do
+    @mocked_cookies["announcement_1"] = "not hidden"
+    output = announce(@announcement, hide_message: "X", div_class: "customdiv")
+    output.should include("<div class=\"customdiv\"")
+    output.should include(">X</span>")
+  end
+
+  it "should output bootstrap style" do 
+    @mocked_cookies["announcement_1"] = "not hidden"
+    output = announce(@announcement, format: "bootstrap")
+    output.should include("<a class=\"close\"")
+    output.should include("<h4 class=\"alert-heading\"")
+  end
+
 end

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
-require "action_view"
-require "active_support/core_ext"
-require "announcements"
-
+require "action_view"
+require "active_support/core_ext"
+require "announcements"
+
 Dir["#{File.dirname(__FILE__)}/support/*.rb"].each{|f| require f}

data/spec/support/announcement.rb

@@ -1,4 +1,4 @@
-class Announcement
-  attr_accessor :body
-  attr_accessor :id
+class Announcement
+  attr_accessor :body
+  attr_accessor :id
 end

metadata

@@ -1,20 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: announcements
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
 - Svilen Gospodinov
-- Chase Southard
+- and others
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-19 00:00:00.000000000Z
+date: 2014-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &30209508 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,21 +22,31 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *30209508
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &30209160 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *30209160
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: jquery-rails
-  requirement: &30208848 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +54,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *30208848
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: The Announcements gem makes it easier to display short announcement messages
   in your views
-email: svilen@gospodinov.co.uk
+email: svilen.gospodinov@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -88,8 +103,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: announcements
-rubygems_version: 1.8.11
+rubygems_version: 1.8.19
 signing_key: 
 specification_version: 3
 summary: Announcements gem for Rails
-test_files: []
+test_files:
+- spec/announcements/announcements_helper_spec.rb
+- spec/spec_helper.rb
+- spec/support/announcement.rb