flash_messages_helper 0.1.0 → 0.2.1

data/README.textile

@@ -1,26 +1,40 @@
 h1. Flash Messages Helper
 
-Ruby on Rails view helper for displaying html flash messages in your Rails applications.
+A configurable Ruby on Rails view helper for displaying html flash messages in your Rails applications.
+
+h2. Recent Changes
+
+* 0.2.0
+** Added a proper configuration DSL
+** html_safe called on the output if available
 
 h2.  Install as a Ruby Gem
 
-<pre>sudo gem install flash_messages_helper</pre>
+<pre>gem install flash_messages_helper</pre>
+
+h3. Rails 2
 
 p. Then add the following line to your _environment.rb_
 
 <pre>config.gem 'flash_messages_helper'</pre>
 
+h3. Rails 3
+
+p. Add the following to your _Gemfile_
+<pre>gem 'flash_messages_helper'</pre>
+
+
 h2. Installation as a Ruby on Rails Plugin
 
 <pre>./script/plugin install git://github.com/mdeering/flash_messages_helper.git</pre>
 
 h2. Usage
 
-Once you have installed it as a plugin/gem in your rails app usage is simple. Just call the flash_messages function within you Rails layout or view file
+Once you have installed it as a plugin/gem in your rails app usage is simple. Just call the flash_messages function within you Rails view file
 
-<pre>flash_messages</pre>
+<pre>= flash_messages</pre>
 
-h2. Configuration Points
+h2. Configuration
 
 h3. Changing the default id of the flash elements
 
@@ -31,10 +45,13 @@ By default the id of the flash message element will come through as flash-_error
 * flash-warning
 * _ect..._
 
-To change this you can pass set a lambda that will get called with the key of the message type.
+To change this use the _dom_id_ configuration attribute.
 
-<pre># config/initializers/flash_messages_helper_settings.rb
-ActionView::Base.flash_message_id_proc = lambda {|key| "#{key}-message"}</pre>
+<pre><code># config/initializers/flash_messages_helper.rb
+FlashMessagesHelper.configure do |config|
+  config.dom_id = lambda { |key| "#{key}-message" }
+end
+</code></pre>
 
 A _error_ message will now displayed with the dom element id of _error-message_ rather then _flash-error_ throughout the application
 
@@ -49,21 +66,27 @@ By default the class of the flash message element will come through as _error-ty
 * warning
 * _ect..._
 
-To change this you can pass set a lambda that will get called with the key of the message type.
+To change this use the _css_class_ configuration attribute.
 
-<pre># config/initializers/flash_messages_helper_settings.rb
-ActionView::Base.flash_message_class_proc = lambda {|key| "#{key} hideable"}</pre>
+<pre><code># config/initializers/flash_messages_helper.rb
+FlashMessagesHelper.configure do |config|
+  config.css_class = lambda { |key| "#{key} dismissible" }
+end
+</code></pre>
 
-A _error_ message will now displayed with the dom element class of _error hideable rather then _error_ throughout the application
+A _error_ message will now displayed with the dom element class of _error dismissible rather then _error_ throughout the application
 
-<pre><div class="error hideable" id="flash-error">There was an error!</div></pre>
+<pre><div class="error dismissible" id="flash-error">There was an error!</div></pre>
 
 h3. Changing the default html tag type of the flash elements
 
 As a default the html tag used to wrap the flash messages is a div element.  This can be easily globally changed with the following setting.
 
-<pre># config/initializers/flash_messages_helper_settings.rb
-ActionView::Base.flash_message_tag = :p</pre>
+<pre><code># config/initializers/flash_messages_helper.rb
+FlashMessagesHelper.configure do |config|
+  config.wrapper = :p
+end
+</code></pre>
 
 With the above setting flash messages will be wrapped inside of a paragraph tag rather then a div.
 
@@ -71,4 +94,4 @@ With the above setting flash messages will be wrapped inside of a paragraph tag
 
 h2. Credits
 
-p. Copyright (c) 2009 "Michael Deering(Ruby on Rails Development Edmonton)":http://mdeering.com, released under the MIT license
+p. Copyright (c) 2011 "Michael Deering(Ruby on Rails Development Edmonton)":http://mdeering.com, released under the MIT license

data/lib/flash_messages_helper.rb

@@ -1,29 +1,64 @@
 module FlashMessagesHelper
 
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  class Configuration
+     attr_accessor :css_class, :dom_id, :wrapper
+     def initialize
+       @css_class = lambda { |key| "#{key}" }
+       @dom_id    = lambda { |key| "flash-#{key}" }
+       @wrapper   = :div
+     end
+   end
+
   def self.included(target)
-    target.cattr_accessor :flash_message_class_proc
-    target.flash_message_class_proc = lambda { |key| "#{key}" }
-    target.cattr_accessor :flash_message_id_proc
-    target.flash_message_id_proc = lambda { |key| "flash-#{key}" }
-    target.cattr_accessor :flash_message_tag
-    target.flash_message_tag     = :div
+    target.extend ClassMethods
     target.send :include, InstanceMethods
   end
 
+  module ClassMethods
+
+    # Deprications
+    {
+      :flash_message_class_proc => :css_class,
+      :flash_message_id_proc    => :dom_id,
+      :flash_message_tag        => :wrapper
+    }.each do |old_method, new_method|
+      define_method "#{old_method}=" do |value|
+        ActiveSupport::Deprecation.warn "FlashMessagesHelper.#{old_method} has been removed in favor of #{new_method}.  Please refer to the README https://github.com/mdeering/flash_messages_helper for the configuration DSL"
+        FlashMessagesHelper.configure do |config|
+          config.send("#{new_method}=", value)
+        end
+      end
+    end
+
+  end
+
   module InstanceMethods
     def flash_messages(options = {})
       ret = []
       flash.each do |key, value|
-        ret << content_tag(ActionView::Base.flash_message_tag, value, {
-            :class => ActionView::Base.flash_message_class_proc.call(key),
-            :id    => ActionView::Base.flash_message_id_proc.call(key)
+        ret << content_tag(FlashMessagesHelper.configuration.wrapper, value, {
+            :class => FlashMessagesHelper.configuration.css_class.call(key),
+            :id    => FlashMessagesHelper.configuration.dom_id.call(key)
           }.merge(options)
         )
       end
-      return ret.join("\n")
+      return_string = ret.join("\n")
+      return return_string.respond_to?(:html_safe) ? return_string.html_safe : return_string
     end
   end
 
 end
 
-ActionView::Base.send(:include, FlashMessagesHelper)
+ActionView::Base.send(:include, FlashMessagesHelper) if defined?(ActionView::Base)

data/spec/flash_messages_helper_spec.rb

@@ -6,42 +6,50 @@ ActionView::Base.send(:include, FlashMessagesHelper)
 
 describe FlashMessagesHelper do
 
-  view = ActionView::Base.new
-  controller = ActionController::Base.new
-  view.controller = controller
+  before do
+    @view = ActionView::Base.new
+    @controller = ActionController::Base.new
+    @view.controller = @controller
+    FlashMessagesHelper.configuration = FlashMessagesHelper::Configuration.new
+  end
 
   it 'will have nothing to display of the flash is not set in any way' do
-    controller.stub!(:flash).and_return({})
-    view.flash_messages.should == ''
+    @controller.stub!(:flash).and_return({})
+    @view.flash_messages.should == ''
   end
 
   it 'will return a div with the error message' do
-    controller.stub!(:flash).and_return({:error => 'There was an error'})
-    view.flash_messages.should == "<div class=\"error\" id=\"flash-error\">There was an error</div>"
+    @controller.stub!(:flash).and_return({ :error => 'There was an error' })
+    @view.flash_messages.should == "<div class=\"error\" id=\"flash-error\">There was an error</div>"
   end
 
   {
-    :flash_message_class_proc => lambda { |key| "#{key}-message hiddable"},
-    :flash_message_id_proc    => lambda { |key| "flash-#{key}-message"},
+    :flash_message_class_proc => lambda { |key| "#{key}-message hiddable" },
+    :flash_message_id_proc    => lambda { |key| "flash-#{key}-message" },
     :flash_message_tag        => :p
   }.each do |singleton_variable, value|
-    it "should create flash_messages class (singleton) variable #{singleton_variable} on its included class" do
-      ActionView::Base.send(singleton_variable).should_not == nil
+    it "should give deprication warnings for 0.1.0 usage but still set configuration points" do
+      ActiveSupport::Deprecation.should_receive(:warn)
       ActionView::Base.send("#{singleton_variable}=", value)
-      ActionView::Base.send(singleton_variable).should == value
+      FlashMessagesHelper.configuration.css_class == value if singleton_variable == :flash_message_class_proc
+      FlashMessagesHelper.configuration.dom_id    == value if singleton_variable == :flash_message_id_proc
+      FlashMessagesHelper.configuration.wrapper   == value if singleton_variable == :flash_message_tag
     end
   end
 
   # Now that the defaults have been set
 
   it 'will return a p with the error message and the defaults set differently' do
-    controller.stub!(:flash).and_return({:error => 'There was an error'})
-    view.flash_messages.should == "<p class=\"error-message hiddable\" id=\"flash-error-message\">There was an error</p>"
+    FlashMessagesHelper.configuration.wrapper = :p
+    @controller.stub!(:flash).and_return({ :error => 'There was an error' })
+    @view.flash_messages.should == "<p class=\"error\" id=\"flash-error\">There was an error</p>"
   end
 
   it 'will still honor the html options passed in' do
-    controller.stub!(:flash).and_return({:error => 'There was an error'})
-    view.flash_messages(:class => 'my-class').should == "<p class=\"my-class\" id=\"flash-error-message\">There was an error</p>"
+    @controller.stub!(:flash).and_return({ :error => 'There was an error' })
+    @view.flash_messages(:class => 'my-class').should == "<div class=\"my-class\" id=\"flash-error\">There was an error</div>"
   end
 
+  it 'will call html_safe on the return string if available'
+
 end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: flash_messages_helper
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  hash: 21
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Michael Deering
@@ -9,10 +15,53 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-19 00:00:00 -07:00
+date: 2011-03-19 00:00:00 -06:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  name: rails
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - <
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  prerelease: false
+  type: :development
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - <
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  prerelease: false
+  type: :development
+  requirement: *id003
 description: 
 email: mdeering@mdeering.com
 executables: []
@@ -36,26 +85,32 @@ homepage: http://github.com/mdeering/flash_messages_helper
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: A simple yet configurable rails view helper for displaying flash messages.