gbdev-pretty_flash 0.1.1

data/CHANGELOG

@@ -0,0 +1,15 @@
+0.1.1
+ * Moved 'assets' to 'public'
+ * Made it copy 'public' stuff to your rails app when application starts
+ * Gem'ified plugin
+ * Refactored flash set methods to add hash options for:
+		: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 - load errors from model associations of the AR Object
+
+0.1.0
+ * Forked from http://github.com/rpheath/pretty_flash
+ * Added 'success' and made it take the 'green' action
+ * Made 'notice' into blue/white informational flash message

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [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,49 @@
+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.
+
+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"@
+
+h2. In the view...
+
+Then all you have to do to display them is:
+
+<pre><code><%= display_flash_messages %></code></pre>
+
+Easy enough?
+
+h2. Get Started
+
+Install the Gem
+<pre><code>sudo gem install gbdev-pretty_flash</code></pre>
+
+Add the gem to your environment.rb file
+<pre><code>config.gem 'gbdev-pretty_flash', :lib => 'pretty_flash', :version => '0.1.0', :source => 'http://gems.github.com'</code></pre>
+
+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.
+
+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.
+
+h2. Credits
+
+Original plugin by Ryan Heath (http://github.com/rpheath/pretty_flash).
+Converted to a gem and extensively modified by Great Basin Development, LLC.
+
+h2. Licensing
+
+Copyright (c) 2008 Ryan Heath, released under the MIT license

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the pretty_flash plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the pretty_flash plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PrettyFlash'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/lib/pretty_flash.rb"

data/install.rb

@@ -0,0 +1,23 @@
+message = <<-MESSAGE
+  
+  ********************************************
+  To get started, navigate to your project
+  root, and type:
+  
+  $ rake pretty_flash:install
+  
+  That will copy all of the necessary assets
+  to their appropriate homes.
+  
+  !! 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)
+  
+  Enjoy!
+  ********************************************
+  
+MESSAGE
+
+puts message

data/lib/pretty_flash/pretty_flash.rb

@@ -0,0 +1,91 @@
+module PrettyFlash
+  module ControllerMethods
+
+    # clear all flash if you need to ensure it is empty. This shouldn't
+    # normally be needed if you are properly using flash and flash.now
+    def clear_all_flash
+      flash.delete(:success)
+      flash.delete(:notice)
+      flash.delete(:warning)
+      flash.delete(:error)
+    end
+
+    # Flash Message Valid options
+    # :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
+    
+    # Add a success flash message
+    def success(msg, options={})
+      flash_message(msg, options.merge({:msg_sym => :success}))
+    end
+
+    # Add a notice flash message
+    def notice(msg, options={})
+      flash_message(msg, options.merge({:msg_sym => :notice}))
+    end
+  
+    # Add a warning flash message
+    def warning(msg, options={})
+      flash_message(msg, options.merge({:msg_sym => :warning}))
+    end
+
+    # Add an error flash message
+    def error(msg, options={})
+      flash_message(msg, options.merge({:msg_sym => :error}))
+    end
+
+  private
+
+    def flash_message(msg, options={})
+      now = options[:now].nil? || options[:now] || (request.xhr? ? true : false)
+      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?
+      flash.delete(options[:msg_sym]) if options[:clear_flash]
+      
+      msgs = []
+      msgs << msg unless msg.empty?
+      
+      unless obj.nil?
+        obj.errors.each { |att, dtl| 
+          msgs << dtl unless options[:check_associations].include?(att.to_sym)
+        }
+        options[:check_associations].each { |assoc|
+          eval("obj.#{assoc}").each { |obj_assoc|
+            obj_assoc.errors.each { |att, dtl|
+              msgs << dtl
+            }
+          }
+        }
+      end
+
+      unless msgs.empty?
+        if now
+          flash.now[options[:msg_sym]] = '' if flash[options[:msg_sym]].nil?
+          flash.now[options[:msg_sym]] << msgs.join(options[:delimiter])
+        else
+          flash[options[:msg_sym]] = '' if flash[options[:msg_sym]].nil?
+          flash[options[:msg_sym]] << msgs.join(options[:delimiter])
+        end
+      end
+    end    
+    
+  end
+
+  module Display
+
+    def display_flash_messages
+      returning html = String.new do
+        flash.each do |css_class, message|
+          html << content_tag(:p, content_tag(:span, nil) + message, :class => css_class)
+        end
+      end
+    end
+
+  end
+  
+end

data/lib/pretty_flash.rb

@@ -0,0 +1,18 @@
+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)
+
+  # install files
+  unless File.exists?(RAILS_ROOT + '/public/images/flash-error.png')
+    ['/public/images', '/public/stylesheets', '/public/javascripts'].each do |dir|
+      source = File.dirname(__FILE__) + "/../#{dir}"
+      dest = RAILS_ROOT + dir
+      FileUtils.mkdir_p(dest)
+      FileUtils.cp(Dir.glob(source+'/*.*'), dest)
+    end
+  end
+
+end

data/public/javascripts/pretty_flash.js

@@ -0,0 +1,29 @@
+// Copy the snippet that applies to you, and paste it in application.js
+// You can delete this file after copying what you need.
+
+
+// jQuery -------------------------------------------------------------
+// $(document).ready(function() {
+//   setTimeout(hideFlashes, 25000);
+// });
+// 
+// var hideFlashes = function() {
+//   $('p.notice, p.warning, p.error').fadeOut(1500);
+// }
+// --------------------------------------------------------------------
+
+
+
+
+
+// Prototype JS -------------------------------------------------------
+// document.observe('dom:loaded', function() {
+//   setTimeout(hideFlashes, 25000);
+// });
+// 
+// var hideFlashes = function() {
+//   $$('.notice', '.warning', '.error').each(function(e) {
+//     if (e) Effect.Fade(e, { duration: 1.5 });
+//   })
+// }
+// --------------------------------------------------------------------

data/public/stylesheets/pretty_flash.css

@@ -0,0 +1,59 @@
+/*
+Copy the contents to your default.css and edit as needed or keep this 
+as a separate css file.
+
+You can delete this file after copying what you need to default.css.
+*/
+
+p.success,
+p.notice,
+p.warning,
+p.error {
+  font-size: 18px;
+  padding: 15px 10px;
+  margin-bottom: 10px;
+}
+
+p.success span,
+p.notice span,
+p.warning span,
+p.error span {
+  float: left;
+  width: 42px;
+  height: 32px;
+  margin-top: -5px;
+}
+
+p.success {
+  background: url(../images/flash-success-bg.jpg) repeat-x left top;
+  color: #41612f; 
+}
+p.success span {
+  background: url(../images/flash-success.png) no-repeat left top;
+}
+
+p.notice {
+  background: url(../images/flash-notice-bg.jpg) repeat-x left top;
+  color: #41612f; 
+}
+p.notice span {
+  background: url(../images/flash-notice.png) no-repeat left top;
+}
+
+p.warning {
+  background: url(../images/flash-warning-bg.jpg) repeat-x left -10px;
+  color: #a26a1a;
+}
+p.warning span {
+  margin-top: -6px;
+  background: url(../images/flash-warning.png) no-repeat left top;
+}
+
+p.error {
+  background: url(../images/flash-error-bg.jpg) repeat-x left -10px;
+  color: #af0100;
+}
+p.error span {
+  margin-top: -6px;
+  background: url(../images/flash-error.png) no-repeat left top;
+}

data/test/pretty_flash_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class PrettyFlashTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: gbdev-pretty_flash
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Ryan Heath
+- John Dell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-15 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: A Rails plugin/gem that provides css friendly success/notice/warning/error flash messages.
+email: 
+- rpheath@gmail.com
+- spovich@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- CHANGELOG
+- init.rb
+- install.rb
+- MIT-LICENSE
+- Rakefile
+- README.textile
+- uninstall.rb
+- lib/pretty_flash.rb
+- lib/pretty_flash/pretty_flash.rb
+- public/images/flash-success.png
+- public/images/flash-success-bg.jpg
+- public/images/flash-notice.png
+- public/images/flash-notice-bg.jpg
+- public/images/flash-warning.png
+- public/images/flash-warning-bg.jpg
+- public/images/flash-error.png
+- public/images/flash-error-bg.jpg
+- public/javascripts/pretty_flash.js
+- public/stylesheets/pretty_flash.css
+- test/pretty_flash_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/gbdev/pretty_flash
+post_install_message: 
+rdoc_options: []
+
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Rails plugin/gem that provides pretty flash messages
+test_files: 
+- test/pretty_flash_test.rb
+- test/test_helper.rb