gritter 0.5.1 → 0.6.0

data/README.markdown

@@ -1,6 +1,6 @@
 # gritter
 
-	version 0.5.1
+	version 0.6.0
 	Robin Brouwer
 	Daniël Zwijnenburg
 	45north
@@ -43,11 +43,19 @@ The :fade_in_speed and :fade_out_speed options accept the following Strings:
 	"slow"
 	"medium"
 	"fast"
-	
 
-## v0.5 changes
+Now you can use gritter inside your Rails application.
+You should really check out the gflash helper. It's really handy!
+
+
+## Changes
 
-I have made several changes in version 0.5:
+Version 0.6 changes:
+
+	- Added locales support for gflash (see README);
+	- README changes.
+
+Version 0.5 changes:
 
 	- Works with Ruby 1.9 now (the Array.to_s was causing problems);
 	- Refactored a lot of code to make everything a bit more logical;
@@ -59,12 +67,6 @@ I have made several changes in version 0.5:
 	- Changed the README.
 
 
-## Upcoming changes
-
-One of the features I have in mind for the following release will be locales support for gflash.
-The only thing you need to add in the Controller is what error should be shown and the locales will do the rest.
-
-
 ## Usage
 
 There are several helpers you can use with gritter. All of them print out Javascript code without script-tags.
@@ -76,7 +78,7 @@ There are several helpers you can use with gritter. All of them print out Javasc
 To add the script-tags we added another function called 'js'. It allows you to easily add script-tags around your javascript.
 It can be used in combination with gritter, but also other Javascript you want to run.
 
-Since version 0.3 we also added a gflash helper. You can read more about this helper below.
+Since version 0.3 we also added a gflash helper. This helper supports locales since version 0.6. You can read more about this helper below.
 
 
 ### add_gritter
@@ -154,9 +156,7 @@ The gflash helper is a different kind of flash[:notice] message. It uses the add
 It uses a session to remember the flash messages. Add the following inside your controller action:
 
 	def create
-		...
 		gflash :success => "The product has been created successfully!"
-		...
 	end
 
 Now you can add the following to your layout view inside the body-tag:
@@ -179,13 +179,37 @@ Now the default title will be overwritten. You can use the following gflash opti
 Each uses the corresponding image and title. You can also add multiple gritter notifications at once:
 
 	def create
-		...
-		gflash :success => "The product has been created successfully!", :notify => "This product doesn't have a category."
-		...
+		gflash :success => "The product has been created successfully!", :notice => "This product doesn't have a category."
+	end
+
+Besides passing the exact text inside the controller, gflash also supports locales (both for messages and titles). 
+When you start your server a new locale file will be added to /config/locales called 'gflash.en.yml'.
+Here you can set the locales for all your gflash messages and the titles. It works like this:
+
+	en:
+	  gflash:
+	    titles:
+	      notice: "Custom notice title"
+	      success: "Success"
+	      warning: "Warning"
+	      error: "Error"
+	      progress: "Progress"
+	    products: # => Controller name
+	      create: # => Action name
+	        notice: "Custom notice message"
+
+Now you can do the following inside your Controller:
+
+	def create
+		gflash :notice => true
 	end
 
-Just remember that you can only set the gflash message inside the controller. 
-The gflash helper inside the views will show the notification and change the title. It will not change the message.
+The locales for the :notice title and message will now be used. You can still pass a String to overwrite a locale.
+
+And that's how you add gflash to your Rails application.
+Just remember that you can only set which gflash message you want shown inside the controller.
+The gflash helper inside the views will show the notification and change the title when you pass extra arguments. 
+It will not change the message.
 
 
 ## Special Thanks

data/gritter.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.email       = ["robin@45north.nl"]
   s.homepage    = "http://www.45north.nl"
   s.summary     = %q{Growl notifications for your Rails application.}
-  s.description = %q{This Ruby on Rails gem allows you to easily add Growl-like notifications to your application using a JQuery plugin called 'gritter'.}
+  s.description = %q{This Ruby on Rails gem allows you to easily add Growl-like notifications to your application using a jQuery plugin called 'gritter'.}
   
   s.rubyforge_project = "nowarning"
   

data/lib/gritter.rb

@@ -16,9 +16,11 @@ module Gritter
     orig_javascripts = File.join(File.dirname(__FILE__), 'gritter', 'assets', 'javascripts')
     orig_stylesheets = File.join(File.dirname(__FILE__), 'gritter', 'assets', 'stylesheets')
     orig_images = File.join(File.dirname(__FILE__), 'gritter', 'assets', 'images')
+    orig_lang = File.join(File.dirname(__FILE__), 'gritter', 'assets', 'gflash.en.yml')
     dest_javascripts = File.join(Rails.root, 'public', 'javascripts', 'gritter')
     dest_stylesheets = File.join(Rails.root, 'public', 'stylesheets', 'gritter')
     dest_images = File.join(Rails.root, 'public', 'images', 'gritter')
+    dest_lang = File.join(Rails.root, 'config', 'locales', 'gflash.en.yml')
     
     gritter = File.join(dest_javascripts, 'jquery.gritter.min.js')
 
@@ -36,6 +38,8 @@ module Gritter
         FileUtils.cp_r "#{orig_stylesheets}/.", dest_stylesheets
         puts "Copying gritter to #{dest_images}..."
         FileUtils.cp_r "#{orig_images}/.", dest_images
+        puts "Copying language file to #{dest_lang}..."
+        FileUtils.cp_r orig_lang, dest_lang
         puts "Successfully installed gritter."
       rescue
         puts "ERROR: Problem installing gritter. Please copy the files manually."

data/lib/gritter/assets/gflash.en.yml

@@ -0,0 +1,21 @@
+en:
+  gflash:
+    #
+    # These are the translations for the different titles.
+    #
+    titles:
+      notice: "Notice"
+      success: "Success"
+      warning: "Warning"
+      error: "Error"
+      progress: "Progress"
+    #
+    # Add gflash messages for controller actions:
+    # products:
+    #   create:
+    #     notice: "This is a notification"
+    #     error: "Something went wrong"
+    #
+    # Inside controller: 
+    # gflash :notice => true, :error => true
+    #

data/lib/gritter/gflash.rb

@@ -4,7 +4,7 @@ module Gritter
       session[:gflash] ||= {}
       options = args.extract_options!
       options.each do |key, value|
-        session[:gflash][key] = value
+        session[:gflash][key] = value == true ? I18n.t("gflash.#{params[:controller]}.#{params[:action]}.#{key}") : value
       end
     end
   end

data/lib/gritter/helpers.rb

@@ -70,11 +70,15 @@ module Gritter
     
     def gflash_titles *args
       options = args.extract_options!
-      titles = { :success => "Success", :warning => "Warning", :error => "Error", :notice => "Notice", :progress => "Progress" }
+      titles = { :success => get_translation(:success), :warning => get_translation(:warning), :error => get_translation(:error), :notice => get_translation(:notice), :progress => get_translation(:progress) }
       options.each do |key, value|
         titles[key] = value if titles.has_key?(key)
       end
       titles
     end
+    
+    def get_translation translation
+      I18n.t(translation, :scope => [:gflash, :titles])
+    end
   end
 end

data/lib/gritter/version.rb

@@ -1,3 +1,3 @@
 module Gritter
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 5
-  - 1
-  version: 0.5.1
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Robin Brouwer
@@ -19,7 +19,7 @@ date: 2011-02-02 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
-description: This Ruby on Rails gem allows you to easily add Growl-like notifications to your application using a JQuery plugin called 'gritter'.
+description: This Ruby on Rails gem allows you to easily add Growl-like notifications to your application using a jQuery plugin called 'gritter'.
 email: 
 - robin@45north.nl
 executables: []
@@ -36,6 +36,7 @@ files:
 - gritter.gemspec
 - init.rb
 - lib/gritter.rb
+- lib/gritter/assets/gflash.en.yml
 - lib/gritter/assets/images/error.png
 - lib/gritter/assets/images/gritter-close-ie6.gif
 - lib/gritter/assets/images/gritter-long.png