gbdev-pretty_flash 0.1.1 → 0.1.2

data/CHANGELOG

@@ -1,3 +1,9 @@
+0.1.2
+ * Added new hash option :message and now the only method argument is the hash option
+ * Updated README instructions and examples.
+ * Renamed :check_associations to just :associations
+ * Added TODO file
+
 0.1.1
  * Moved 'assets' to 'public'
  * Made it copy 'public' stuff to your rails app when application starts

data/README.textile

@@ -1,17 +1,36 @@
 h1. PrettyFlash
 
-Rails plugin that provides "pretty" flash messages and additional helpers to pull errors from ActiveRecord objects and as well as errors on associated models of an ActiveRecord object.
+Rails plugin/gem that provides "pretty" css-driven flash messages and additional helpers to pull all errors from ActiveRecord objects and as well as errors on associated models of an ActiveRecord object.
 
 h2. In the controller...
 
-This plugin gives a couple of convenience methods for setting flash messages.
-
-<pre><code>success "Hooray! You did something good."
-notice "Hey! This is for tips and general information."
-warning "Ummm, You're not allowed to do that yet."
-error "Ooooops! Something went wrong."</code></pre>
-
-Use those methods instead of the typical @flash[:notice] = "Some String"@
+This plugin/gem provides convenience methods for setting flash messages. Use this instead of the typical @flash[:notice] = "Some String"@
+
+<pre><code>
+flash_success :message => "Hooray! You did something good."
+flash_notice :message => "Hey! This is for tips and general information."
+flash_warning :message => "Ummm, You're not allowed to do that yet."
+flash_error :message => 'ID does not exist'
+</code></pre>
+
+You can specify whether to use flash() or flash.now() via the options hash.  The default is to use flash.now().  This is needed when setting flash and then redirecting.  Also, any AJAX request defaults to flash.now() 
+<pre><code>
+flash_error :message => 'Blah', :now => false
+redirect_to :list
+</code></pre>
+
+You can also load validation errors from ActiveRecord Objects and any specified associated models
+<pre><code>
+flash_error :object => @user, :associations => [:roles, :permissions]
+</code></pre>
+
+The complete list of hash options for flash_success, flash_notice, flash_warning, flash_error is as follows:
+ :message - the flash message to be added
+ :now - Whether to use flash or flash.now
+ :delimiter - separator between messages
+ :clear_flash - delete flash for the type of flash called (:notice, :error, etc)
+ :object - an ActiveRecord object with @errors
+ :associations - model associations of the AR Object that should be checked for errors
 
 h2. In the view...
 
@@ -31,13 +50,11 @@ Add the gem to your environment.rb file
 
 There's a public folder with this plugin/gem that contains the images, CSS, and javascript (optional). The first time you run your application with the added config.gem line, the images, stylesheet, and javascript will be copied to your public folder.
 
-On subsequent application starts, the plugin/gem checks for the presence of public/images/flash-error.png.  If this file
-is present, nothing will be copied to your public directory.
+On subsequent application starts, the plugin/gem checks for the presence of public/images/flash-error.png.  If this file is present, nothing will be copied to your public directory.
 
 WARNING: this will overwrite any of the files that have the same name. So double check if you don't want that to happen.
 
-Also, the pretty_flash.js file located in the public/javascripts folder is only used to fade the flash messages after so many
-seconds (defaults to 2.5 seconds). If you want that capability, just copy the relevant section of code (prototype or jquery) to application.js and you're all set.
+Also, the pretty_flash.js file located in the public/javascripts folder is only used to fade the flash messages after so many seconds (defaults to 2.5 seconds). If you want that capability, just copy the relevant section of code (prototype or jquery) to application.js and you're all set.
 
 h2. Credits
 

data/install.rb

@@ -1,20 +1,22 @@
 message = <<-MESSAGE
   
   ********************************************
-  To get started, navigate to your project
-  root, and type:
+  To get started, install the gem then add
+  the gem to your environment.rb
   
-  $ rake pretty_flash:install
-  
-  That will copy all of the necessary assets
-  to their appropriate homes.
+  $ sudo gem install gbdev-pretty_flash
+
+  Add the gem to your environment.rb file
   
-  !! WARNING: there is no protection against
-     file collision, so your files will be
-     overwritten if they already exist. You
-     may want to check that first! (see the
-     pretty_flash/assets/ to check)
+  config.gem 'gbdev-pretty_flash',
+   :lib => 'pretty_flash',
+   :version => '0.1.0',
+   :source => 'http://gems.github.com'
   
+  When you start your application, all
+  necessary images/css/javascript are copied
+  to your public folder.
+    
   Enjoy!
   ********************************************
   

data/lib/pretty_flash/pretty_flash.rb

@@ -11,50 +11,52 @@ module PrettyFlash
     end
 
     # Flash Message Valid options
+    # :message - the flash message to be added
     # :now - Whether to use flash or flash.now
     # :delimiter - separator between messages
     # :clear_flash - delete flash for the type of flash called (:notice, :error, etc)
     # :object - an activerecord object with @errors
-    # :check_associations - model associations of the AR Object that may also have errors that need to be displayed
+    # :associations - model associations of the AR Object that may also have errors that need to be displayed
     
     # Add a success flash message
-    def success(msg, options={})
-      flash_message(msg, options.merge({:msg_sym => :success}))
+    def flash_success(options={})
+      flash_message(options.merge({:msg_sym => :success}))
     end
 
     # Add a notice flash message
-    def notice(msg, options={})
-      flash_message(msg, options.merge({:msg_sym => :notice}))
+    def flash_notice(options={})
+      flash_message(options.merge({:msg_sym => :notice}))
     end
   
     # Add a warning flash message
-    def warning(msg, options={})
-      flash_message(msg, options.merge({:msg_sym => :warning}))
+    def flash_warning(options={})
+      flash_message(options.merge({:msg_sym => :warning}))
     end
 
     # Add an error flash message
-    def error(msg, options={})
-      flash_message(msg, options.merge({:msg_sym => :error}))
+    def flash_error(options={})
+      flash_message(options.merge({:msg_sym => :error}))
     end
 
   private
 
-    def flash_message(msg, options={})
+    def flash_message(options={})
       now = options[:now].nil? || options[:now] || (request.xhr? ? true : false)
+      msg = options[:message].nil? ? '' : options[:message]
+      obj = options[:object].nil? ? nil : options[:object]
       options[:msg_sym] = :error if options[:msg_sym].nil?
       options[:delimiter] = '<br />' if options[:delimiter].nil?
-      obj = options[:object].nil? ? nil : options[:object]
-      options[:check_associations] = [] if options[:check_associations].nil? or obj.nil?
+      options[:associations] = [] if options[:associations].nil? or obj.nil?
       flash.delete(options[:msg_sym]) if options[:clear_flash]
       
       msgs = []
-      msgs << msg unless msg.empty?
+      msgs << options[:message] unless options[:message].nil? || options[:message].blank?
       
       unless obj.nil?
         obj.errors.each { |att, dtl| 
-          msgs << dtl unless options[:check_associations].include?(att.to_sym)
+          msgs << dtl unless options[:associations].include?(att.to_sym)
         }
-        options[:check_associations].each { |assoc|
+        options[:associations].each { |assoc|
           eval("obj.#{assoc}").each { |obj_assoc|
             obj_assoc.errors.each { |att, dtl|
               msgs << dtl
@@ -76,7 +78,7 @@ module PrettyFlash
     
   end
 
-  module Display
+  module DisplayMethods
 
     def display_flash_messages
       returning html = String.new do

data/lib/pretty_flash.rb

@@ -3,7 +3,7 @@ require "pretty_flash/pretty_flash.rb"
 if Object.const_defined?(:Rails) && File.directory?(Rails.root + "/public")
 
   ActionController::Base.send(:include, PrettyFlash::ControllerMethods)
-  ActionView::Base.send(:include, PrettyFlash::Display)
+  ActionView::Base.send(:include, PrettyFlash::DisplayMethods)
 
   # install files
   unless File.exists?(RAILS_ROOT + '/public/images/flash-error.png')

data/public/javascripts/pretty_flash.js

@@ -8,7 +8,7 @@
 // });
 // 
 // var hideFlashes = function() {
-//   $('p.notice, p.warning, p.error').fadeOut(1500);
+//   $('p.notice, p.warning, p.error').fadeOut(2500);
 // }
 // --------------------------------------------------------------------
 
@@ -23,7 +23,7 @@
 // 
 // var hideFlashes = function() {
 //   $$('.notice', '.warning', '.error').each(function(e) {
-//     if (e) Effect.Fade(e, { duration: 1.5 });
+//     if (e) Effect.Fade(e, { duration: 2.5 });
 //   })
 // }
 // --------------------------------------------------------------------

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gbdev-pretty_flash
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Ryan Heath