flash_messages_helper 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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.textile

@@ -0,0 +1,74 @@
+h1. Flash Messages Helper
+
+Ruby on Rails view helper for displaying html flash messages in your Rails applications.
+
+h2.  Install as a Ruby Gem
+
+<pre>sudo gem install flash_messages_helper</pre>
+
+p. Then add the following line to your _environment.rb_
+
+<pre>config.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
+
+<pre>flash_messages</pre>
+
+h2. Configuration Points
+
+h3. Changing the default id of the flash elements
+
+By default the id of the flash message element will come through as flash-_error-type_
+
+* flash-error
+* flash-notice
+* flash-warning
+* _ect..._
+
+To change this you can pass set a lambda that will get called with the key of the message type.
+
+<pre># config/initializers/flash_messages_helper_settings.rb
+ActionView::Base.flash_message_id_proc = lambda {|key| "#{key}-message"}</pre>
+
+A _error_ message will now displayed with the dom element id of _error-message_ rather then _flash-error_ throughout the application
+
+<pre><div class="error" id="error-message">There was an error!</div></pre>
+
+h3. Changing the default class of the flash elements
+
+By default the class of the flash message element will come through as _error-type_
+
+* error
+* notice
+* warning
+* _ect..._
+
+To change this you can pass set a lambda that will get called with the key of the message type.
+
+<pre># config/initializers/flash_messages_helper_settings.rb
+ActionView::Base.flash_message_class_proc = lambda {|key| "#{key} hideable"}</pre>
+
+A _error_ message will now displayed with the dom element class of _error hideable rather then _error_ throughout the application
+
+<pre><div class="error hideable" 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>
+
+With the above setting flash messages will be wrapped inside of a paragraph tag rather then a div.
+
+<pre><p class="error" id="flash-error">There was an error!</p></pre>
+
+h2. Credits
+
+p. Copyright (c) 2009 "Michael Deering(Ruby on Rails Development Edmonton)":http://mdeering.com, released under the MIT license

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rake'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+begin
+  AUTHOR   = "Michael Deering"
+  EMAIL    = "mdeering@mdeering.com"
+  GEM      = "flash_messages_helper"
+  HOMEPAGE = "http://github.com/mdeering/flash_messages_helper"
+  SUMMARY  = "A simple yet configurable rails view helper for displaying flash messages."
+
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.author       = AUTHOR
+    s.email        = EMAIL
+    s.files        = %w(install.rb install.txt MIT-LICENSE README.textile Rakefile) + Dir.glob("{rails,lib,spec}/**/*")
+    s.homepage     = HOMEPAGE
+    s.name         = GEM
+    s.require_path = 'lib'
+    s.summary      = SUMMARY
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+desc 'Default: spec tests.'
+task :default => :spec
+
+desc 'Test the flash_messages_helper gem.'
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ["-c"]
+end
+
+desc "Run all examples with RCov"
+Spec::Rake::SpecTask.new('rcov') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+  t.rcov_opts = ['--exclude', '/opt,spec,Library']
+end
+
+desc 'Generate documentation for the flash_messages_helper plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'FlashMessagesHelper'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/install.rb

@@ -0,0 +1 @@
+puts IO.read(File.join(File.dirname(__FILE__), 'install.txt'))

data/install.txt

@@ -0,0 +1,12 @@
+-----------------------------------------------------------------------
+  Flash Messages Helper:
+
+  Thank you for using Flash Messages Helper.  You will find full
+  documentation on usage and configuration options here:
+  http://github.com/mdeering/flash_messages_helper
+
+  All comments, suggestions, and pull requests are welcome.
+
+  Cheers,
+  Michael Deering http://mdeering.com
+-----------------------------------------------------------------------

data/lib/flash_messages_helper.rb

@@ -0,0 +1,29 @@
+module FlashMessagesHelper
+
+  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.send :include, InstanceMethods
+  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)
+          }.merge(options)
+        )
+      end
+      return ret.join("\n")
+    end
+  end
+
+end
+
+ActionView::Base.send(:include, FlashMessagesHelper)

data/rails/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), *%w[.. lib flash_messages_helper])

data/spec/flash_messages_helper_spec.rb

@@ -0,0 +1,47 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+require 'flash_messages_helper'
+
+ActionView::Base.send(:include, FlashMessagesHelper)
+
+describe FlashMessagesHelper do
+
+  view = ActionView::Base.new
+  controller = ActionController::Base.new
+  view.controller = controller
+
+  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 == ''
+  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>"
+  end
+
+  {
+    :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
+      ActionView::Base.send("#{singleton_variable}=", value)
+      ActionView::Base.send(singleton_variable).should == value
+    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>"
+  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>"
+  end
+
+end

data/spec/test_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'spec'
+require 'action_view'
+require 'action_controller'
+
+Spec::Runner.configure do |config|
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: flash_messages_helper
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Michael Deering
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-19 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: mdeering@mdeering.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- install.rb
+- install.txt
+- lib/flash_messages_helper.rb
+- rails/init.rb
+- spec/flash_messages_helper_spec.rb
+- spec/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/mdeering/flash_messages_helper
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A simple yet configurable rails view helper for displaying flash messages.
+test_files: 
+- spec/flash_messages_helper_spec.rb
+- spec/test_helper.rb