announcements 0.0.3 → 0.1.0

data/.rspec

@@ -0,0 +1 @@
+"--color" 

data/README.md

@@ -2,7 +2,7 @@
 
 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).
+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
 
@@ -11,7 +11,7 @@ there is a single helper method which you can customise) and is a bit more flexi
 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, add some CSS (find an example below; the default output is quite plain and ugly) and customise it.
+6. Next, relax bootstrap's got the rest.
 
 ## Styling
 
@@ -33,7 +33,7 @@ You can use the following css in your application.css file to start:
 }
 ```
 
-## Customisation
+## Customization
 
 The default HTML output of the `announce` helper is
 
@@ -44,7 +44,7 @@ The default HTML output of the `announce` helper is
 </div>
 ```
 
-The default div class is `info`. You can specify you own like that:
+The default div class is `info`. You can customise it like that:
 
 ```
 <%= announce Announcement.newest, :div_class => "mydiv" %>
@@ -53,9 +53,27 @@ The default div class is `info`. You can specify you own like that:
 You can also change the "hide message" text:
 
 ```
-<%= announce Announcement.newest, :div_class => "mydiv", :hide_message => "X" %>
+<%= 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) 

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/announcements.gemspec

@@ -5,9 +5,9 @@ require "announcements/version"
 Gem::Specification.new do |s|
   s.name        = "announcements"
   s.version     = Announcements::VERSION
-  s.authors     = ["Svilen Gospodinov"]
-  s.email       = ["svilen@gospodinov.co.uk"]
-  s.homepage    = ""
+  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"
 
@@ -18,8 +18,8 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec"
+
   s.add_runtime_dependency "rails", "~> 3.1"
   s.add_runtime_dependency "jquery-rails"
 

data/lib/announcements/announcements_helper.rb

@@ -1,22 +1,40 @@
 module AnnouncementsHelper
 
-	# Outputs given announcement in HTML.
+	# 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"
+	#   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 = {}
-		text = options[:hide_message] || "hide message"
-		div_class = options[:div_class] || "info"
-		if announcement != nil && cookies["announcement_" + announcement.id.to_s] != "hidden"
-			content_tag :div, :class => div_class do
-				result = announcement.body.html_safe
-				result << content_tag(:span, text, :class => "hide_announcement", :data => { :announcementid => announcement.id })
-				result
-			end
-		end
+		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

data/lib/announcements/version.rb

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

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

@@ -1,6 +1,6 @@
 $(function() {
 
-    $('.hide_announcement').click(function() {
+    $('.hide_announcement, .close').click(function() {
         var a_id = $(this).data("announcementid");
         createCookie("announcement_" + a_id, "hidden", 45);
         $(this).parent().slideUp();

data/spec/announcements/announcements_helper_spec.rb

@@ -0,0 +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
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+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

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

metadata

@@ -1,19 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: announcements
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
 - Svilen Gospodinov
+- Chase Southard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-24 00:00:00.000000000Z
+date: 2012-04-19 00:00:00.000000000Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &30209508 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *30209508
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &28996596 !ruby/object:Gem::Requirement
+  requirement: &30209160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +33,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *28996596
+  version_requirements: *30209160
 - !ruby/object:Gem::Dependency
   name: jquery-rails
-  requirement: &28996212 !ruby/object:Gem::Requirement
+  requirement: &30208848 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,16 +44,16 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *28996212
+  version_requirements: *30208848
 description: The Announcements gem makes it easier to display short announcement messages
   in your views
-email:
-- svilen@gospodinov.co.uk
+email: svilen@gospodinov.co.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE
 - README.md
@@ -53,7 +65,10 @@ files:
 - lib/generators/announcements/install/install_generator.rb
 - lib/generators/announcements/install/templates/announcement.rb
 - lib/generators/announcements/install/templates/announcements.js
-homepage: ''
+- spec/announcements/announcements_helper_spec.rb
+- spec/spec_helper.rb
+- spec/support/announcement.rb
+homepage: https://github.com/svileng/announcements
 licenses: []
 post_install_message: 
 rdoc_options: []