midas-flash_growler 1.0.1 → 1.0.2

data/Manifest.txt

@@ -14,6 +14,7 @@ rails_generators/flash_growler_assets/templates/error.png
 rails_generators/flash_growler_assets/templates/guilded.flash_growler.js
 rails_generators/flash_growler_assets/templates/info.png
 rails_generators/flash_growler_assets/templates/jquery-growler-0.1.js
+rails_generators/flash_growler_assets/templates/jquery-growler-0.1.min.js
 script/console
 script/destroy
 script/generate

data/README.rdoc

@@ -1,32 +1,63 @@
 = flash_growler
 
-* http://github.com/midas/flash_growler/tree/master
+http://github.com/midas/flash_growler/tree/master
 
 == DESCRIPTION:
 
-A Guilded component that displays Rails flash messages in an interface similar to OS/X's growler.
+A Guilded (http://github.com/midas/guilded/tree/master) component that displays Rails flash messages in an 
+interface similar to OS/X's growler.
 
-== FEATURES/PROBLEMS:
+== FEATURES:
 
+Looks for flash messages in flash[:error], flash[:warning] and flash[:notice] and displays a message that will 
+slide out of view if JavaScript is enabled.
 
 
-== SYNOPSIS:
+== INSTALL:
 
+  sudo gem install midas-flash_growler
 
 
-== REQUIREMENTS:
+== USE:
 
-* guilded
+Include the gems in your Rails project:
 
-== INSTALL:
+  config.gem 'midas-guilded', :version => '0.0.5', :lib => 'guilded', :source => 'http://gems.github.com'
+  config.gem 'midas-flash_growler', :version => '1.0.2', :lib => 'flash_growler', :source => 'http://gems.github.com'
+
+Run generator to create the CSS and JavaScript assets:
+
+  script/generate flash_growler_assets
+
+Call the flash growler helper somewhere in your view(s).  I usually call it in the application layout (or another layout):
+
+  <%= g_flash_growler :id => 'growler', :position => 'bottom' %>
+	
+Also, as with all Guilded components, a call to the apply behavior helper.  It also makes the most sense to do this 
+in your layout(s):
+
+  <%= g_apply_behavior %>
+
+
+== OPTIONS:
+
+* :position - 'top' to display the message at the top of the browser or 'bottom' to display message at the bottom (defaults to bottom).
+* :delay - Number of milliseconds to display the message before starting the slide out of view (defaults to 4000 ms).
+* :speed - Number of milliseconds to animate the slide out of view (defaults to 1000 ms).
+
+
+== REQUIREMENTS:
 
+* midas-guilded >= 0.0.5
+* jQuery 1.3.2 (included with midas-guilded)
+* jquery-growler-0.1.js (included with midas-guilded)
 
 
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2009 FIXME full name
+Copyright (c) 2009 C. Jason Harrelson (midas)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/flash_growler.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{flash_growler}
-  s.version = "1.0.1"
+  s.version = "1.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["midas"]

data/lib/flash_growler.rb

@@ -4,7 +4,7 @@ $:.unshift(File.dirname(__FILE__)) unless
 require 'flash_growler/view_helpers'
 
 module FlashGrowler
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end
 
 ActionView::Base.send( :include, FlashGrowler::ViewHelpers ) if defined?( ActionView )

data/rails_generators/flash_growler_assets/flash_growler_assets_generator.rb

@@ -8,6 +8,7 @@ class FlashGrowlerAssetsGenerator < Rails::Generator::Base
       m.file "guilded.flash_growler.js", "public/javascripts/guilded.flash_growler.js"
       m.directory "public/javascripts/jquery"
       m.file 'jquery-growler-0.1.js', 'public/javascripts/jquery/jquery-growler-0.1.js'
+      m.file 'jquery-growler-0.1.js', 'public/javascripts/jquery/jquery-growler-0.1.min.js'
       m.directory "public/stylesheets/guilded"
       m.directory "public/stylesheets/guilded/flash_growler"
       m.directory "public/stylesheets/guilded/flash_growler/default"

data/rails_generators/flash_growler_assets/templates/jquery-growler-0.1.js

@@ -1,3 +1,18 @@
+/* 
+Copyright © 2009 C. Jason Harrelson (midas) 
+
+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.
+*/
 (function($){
 		  
   jQuery.fn.growl = function( opts )

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: midas-flash_growler
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors: 
 - midas