glennr-flash-message-conductor 1.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Planet Argon
+
+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.rdoc

@@ -0,0 +1,70 @@
+== Flash Message Conductor
+
+A simple pattern for managing flash messages in your Ruby on Rails application.
+
+=== Installation
+
+==== Gem
+
+In environment.rb;
+
+  gem 'glennr-flash-message-conductor'
+
+  config.gem 'glennr-flash-message-conductor', :lib => 'flash-message-conductor', :source => 'http://gemcutter.org', :version => ">=1.1"
+
+==== Plugin
+
+  script/plugin install git://github.com/glennr/flash-message-conductor.git
+
+== Example
+
+=== Redirect actions
+  add_info( 'foo' )
+  redirect_to :action => "show"
+
+is the equivalent of
+
+    flash[:info] = 'foo'
+ 
+=== Render actions 
+  add_info_now( 'foo' )
+  render :action => "show"
+ 
+is the equivalent of
+
+    flash[:info] = 'foo'
+
+== Controller helpers included:
+
+  add_success( message )
+  add_info( message )
+  add_warning( message )
+  add_error( message )
+  add_message( message ) # alias for add_success
+  add_notice( message ) #alias for add_info
+  
+Plus all the _now methods e.g.
+  
+  add_success_now( message )
+
+== View helpers
+  
+  <%= render_flash_messages %>
+
+produces:
+
+  <div id="flash_messages">
+    <div class="info">You have successfully done XYZ...</p>
+  </div>
+
+or... if you set an error
+
+  <div id="flash_messages">
+    <p class="error">Oops! Something went bonkers!</p>
+  </div>
+
+== Example CSS and Icons
+  
+See examples/
+
+Copyright (c) 2008 Planet Argon, released under the MIT license

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 0
+:patch: 1
+:major: 1

data/examples/example.sass

@@ -0,0 +1,30 @@
+#flash_messages
+  .success
+    padding: 15px 10px 15px 50px
+    border-color: #9c9
+    color: #4F8A10
+    background: url(/images/flash-success-icon.png) #DFF2BF left no-repeat
+
+  .info
+    padding: 15px 10px 15px 50px
+    border-color: #9c9
+    color: #00529B
+    background: url(/images/flash-info-icon.png) #BDE5F8 left no-repeat
+
+  .warning
+    padding: 15px 10px 15px 50px
+    border-color: #9c9
+    color: #9F6000
+    background: url(/images/flash-warning-icon.png) #FEEFB3 left no-repeat
+
+  .validation_error
+    padding: 15px 10px 15px 50px
+    border-color: #c99
+    color: #D63301
+    background: url(/images/flash-validation_error-icon.png) #FFCCBA left no-repeat
+
+  .error
+    padding: 15px 10px 15px 50px
+    border-color: #c99
+    color: #D8000C
+    background: url(/images/flash-error-icon.png) #FFBABA left no-repeat

data/lib/flash_message_conductor.rb

@@ -0,0 +1,85 @@
+# ArgonHelpers
+
+module PlanetArgon
+  module FlashMessageConductor
+    FLASH_MESSAGE_TYPES = [ :error, :warning, :info, :success ]
+    
+    module ControllerHelpers
+      def add_error(msg)
+        flash[:error] = msg
+      end
+      def add_error_now(msg)
+        flash.now[:error] = msg
+      end
+      
+      def add_warning(msg)
+        flash[:warning] = msg
+      end
+    
+      def add_warning_now(msg)
+        flash.now[:warning] = msg
+      end
+      
+      def add_info(msg)
+        flash[:info] = msg
+      end
+      
+      def add_info_now(msg)
+        flash.now[:info] = msg
+      end
+      
+      def add_success(msg)
+        flash[:success] = msg
+      end
+      
+      def add_success_now(msg)
+        flash.now[:success] = msg
+      end
+      
+      #aliases - for convenience
+      def add_notice(msg)
+        add_info msg
+      end
+      
+      def add_notice_now(msg)
+        add_info_now msg
+      end
+
+      def add_message(msg)
+        add_success msg
+      end
+      
+      def add_message_now(msg)
+        add_success_now msg
+      end
+      
+    end
+  
+    module ViewHelpers
+      def render_flash_message( css_class, message = "" ) 
+        return "" if message.nil? or message.blank?
+        content_tag( "div", message, :class => "#{css_class}" )
+      end
+    
+      def render_flash_messages( div_id = "flash_messages", div_class = "" )
+        div_content = ''
+        FLASH_MESSAGE_TYPES.each do |key|
+          div_content << render_flash_message( key.to_s, flash[key] ) unless flash[key].blank?
+        end
+        if div_content.blank?
+          return ""
+        else
+          return content_tag( 'div', div_content, :id => div_id, :class => div_class )
+        end
+      end
+      
+      def flash_message_set?
+        flash_set = false
+        FLASH_MESSAGE_TYPES.each do |key|
+          flash_set = true unless flash[key].blank?
+        end
+        return flash_set
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,4 @@
+require 'flash_message_conductor'
+
+ActionController::Base.send( :include, PlanetArgon::FlashMessageConductor::ControllerHelpers )
+ActionView::Base.send( :include, PlanetArgon::FlashMessageConductor::ViewHelpers )

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: glennr-flash-message-conductor
+version: !ruby/object:Gem::Version 
+  version: "1.1"
+platform: ruby
+authors: 
+- Robby Russell
+- Glenn Roberts
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-14 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: A simple pattern for managing flash messages in your Ruby on Rails application
+email: robby@planetargon.com, glenn.roberts@siyelo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- VERSION.yml
+- lib/flash_message_conductor.rb
+- rails/init.rb
+- README.rdoc
+- MIT-LICENSE
+- examples/example.sass
+- examples/images/flash-error-icon.png
+- examples/images/flash-info-icon.png
+- examples/images/flash-success-icon.png
+- examples/images/flash-warning-icon.png
+has_rdoc: true
+homepage: http://github.com/glennr/flash-message-conductor
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --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: Conduct your Flash Messages in Rails
+test_files: []
+