unobtrusive_flash 0.0.1

data/README.markdown

@@ -0,0 +1,44 @@
+# Unobtrusive flash messages for Rails
+
+Ever got tired of pages that can't be cached because they contain flash messages?
+
+Ever got tired of writing custom code to handle flash messages passed in AJAX responses?
+
+Here comes the solution.
+
+`unobtrusive_flash` takes your flash messages for the backend and automagically passes them to the frontend via
+HTTP cookies. This works with both regular page loads and AJAX requests, does not tamper with the page body and requires
+about 3 extra lines of code in your app - how's that for unobtrusive?
+
+You can pass up to 4K of text into flash this way, and you don't need to worry about cookie size since they are
+cleared immediately upon rendering.
+
+Tested and fully functional in: 
+
+* Internet Explorer 8
+* Firefox 4b7
+* Chrome 7
+* Safari 5
+* Opera 10.6
+* *please let me know if it works in firefox 3 and ie 6, 7*
+
+## Requirements
+
+* Rails 2.3 or 3
+* jQuery (maybe I'll make it agnostic in the future)
+
+## Usage
+
+1. Add the gem to your Rails app.
+2. Run `script/generate unobtrusive_flash` or `rails g unobtrusive_flash:install`
+3. Add the following to the controllers that generate flash messages (or better, to the `ApplicationController`):
+
+        after_filter :prepare_unobtrusive_flash
+ 
+4. Include `unobtrusive_flash.css` and `unobtrusive_flash.js` in your layouts. No custom markup is needed.
+5. Remove existing flash rendering code from your layouts.
+6. That's all! You can also edit the generated CSS/JS to your liking.
+
+* * *
+
+© 2010 Leonid Shevtsov, released under the MIT license

data/generators/unobtrusive_flash/unobtrusive_flash_generator.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+class UnobtrusiveFlashGenerator < Rails::Generator::Base
+
+  def manifest
+    record do |m|
+      m.directory File.join('public', 'stylesheets')
+      m.template 'unobtrusive_flash.css', File.join('public', 'stylesheets', 'unobtrusive_flash.css')
+
+      m.directory File.join('public', 'javascripts')
+      m.template 'unobtrusive_flash.js', File.join('public', 'stylesheets', 'unobtrusive_flash.js')
+    end
+  end
+
+  protected
+
+  def banner
+    %{Usage: #{$0} #{spec.name}\nCopies unobtrusive_flash.css and .js to their corresponding locations}
+  end
+ 
+  def source_root
+    File.expand_path('../../../lib/generators/templates', __FILE__)
+  end
+
+end
+
+

data/lib/generators/templates/unobtrusive_flash.css

@@ -0,0 +1,23 @@
+#flash-messages {
+  position: fixed;
+  top: 0;
+  left: 0;
+  width: 100%;
+  z-index: 10000;
+}
+
+#flash-messages .flash-message {
+  padding: 10px 0;
+  background: #dcecaa;
+  opacity: 0.8;
+}
+
+#flash-messages .flash-message.flash-error {
+  background: #ffe2e2;
+}
+
+#flash-messages .flash-message .message {
+  width: 960px;
+  margin: 0 auto;
+}
+

data/lib/generators/templates/unobtrusive_flash.js

@@ -0,0 +1,67 @@
+// This requires jQuery at least for now
+$(function() {
+  $('<div id="flash-messages"></div>').prependTo('body');
+
+  function hideFlash($flash) {
+    $flash.slideUp(100,function(){$flash.remove()});
+  }
+
+  $.flash = function(message, options) {
+  
+    options = $.extend({type: 'notice', timeout: 5000}, options);
+
+    var $flash = $('<div class="flash-message flash-'+options.type+' invisible"><div class="message">'+message+'</div></div>');
+
+    $('#flash-messages').prepend($flash);
+    $flash.slideDown(100);
+
+    $flash.click(function() {
+      hideFlash($flash);
+    });
+
+    if (options.timeout>0) {
+      setTimeout(function() {
+        hideFlash($flash);
+      },options.timeout);
+    }
+  }
+
+
+
+  function loadFlashFromCookies() {
+    if (document.cookie && document.cookie != '') {
+      var cookies = document.cookie.split(';');
+      var name = 'flash';
+      var cookieValue = null;
+      var data = null;
+
+      for (var i = 0; i < cookies.length; i++) {
+          var cookie = jQuery.trim(cookies[i]);
+          if (cookie.substring(0, name.length + 1) == (name + '=')) {
+            // replace fixes problems with Rails escaping. Duh.
+            cookieValue = decodeURIComponent(cookie.substring(name.length + 1).replace(/\+/g,'%20'));
+            break;
+          }
+      }
+
+      try {
+        data = $.parseJSON(cookieValue);
+      } catch(e) {
+      }
+
+      if (data!=null) {
+        $.each(data, function(i, d) {
+          $.flash(d[1], {type: d[0]});
+        });
+      }
+
+      document.cookie = 'flash=; path=/';
+    }
+  }
+
+  loadFlashFromCookies();
+
+  $('html').ajaxSuccess(function(event,request,options) {
+    loadFlashFromCookies();
+  });
+});

data/lib/generators/unobtrusive_flash/install/install_generator.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+module UnobtrusiveFlash
+  class InstallGenerator < Rails::Generators::Base
+    desc "Copies unobtrusive_flash.css and .js to their corresponding locations"
+
+    source_root File.expand_path('../../../templates', __FILE__)
+
+    def copy_files
+      empty_directory 'public/stylesheets'
+      template 'unobtrusive_flash.css', 'public/stylesheets/unobtrusive_flash.css'
+      empty_directory 'public/javascripts'
+      template 'unobtrusive_flash.js', 'public/javascripts/unobtrusive_flash.js'
+    end
+  end
+end

data/lib/unobtrusive_flash.rb

@@ -0,0 +1,21 @@
+require File.join(File.dirname(__FILE__), *%w[unobtrusive_flash railtie]) if defined?(::Rails::Railtie)
+
+module UnobtrusiveFlash
+
+  protected
+
+  def prepare_unobtrusive_flash
+    if flash.any?
+      cookie_flash = []
+      if cookies['flash']
+        cookie_flash = JSON.parse(cookies['flash']) rescue nil
+        cookie_flash=[] unless cookie_flash.is_a? Array
+      end
+
+      cookie_flash += flash.to_a
+
+      cookies['flash'] = cookie_flash.to_json
+      flash.discard
+    end
+  end
+end

data/lib/unobtrusive_flash/railtie.rb

@@ -0,0 +1,10 @@
+require 'unobtrusive_flash'
+require 'rails'
+
+module UnobtrusiveFlash
+  class Railtie < Rails::Railtie
+    initializer 'unobtrusive_flash.initialize', :after => :after_initialize do
+      ActionController::Base.send :include, UnobtrusiveFlash
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "init"))

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification 
+name: unobtrusive_flash
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Leonid Shevtsov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-18 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: |
+  # Unobtrusive flash messages for Rails
+  
+  Ever got tired of pages that can't be cached because they contain flash messages?
+  
+  Ever got tired of writing custom code to handle flash messages passed in AJAX responses?
+  
+  Here comes the solution.
+  
+  `unobtrusive_flash` takes your flash messages for the backend and automagically passes them to the frontend via
+  HTTP cookies. This works with both regular page loads and AJAX requests, does not tamper with the page body and requires
+  about 3 extra lines of code in your app - how's that for unobtrusive?
+  
+  You can pass up to 4K of text into flash this way, and you don't need to worry about cookie size since they are
+  cleared immediately upon rendering.
+  
+  Tested and fully functional in: 
+  
+  * Internet Explorer 8
+  * Firefox 4b7
+  * Chrome 7
+  * Safari 5
+  * Opera 10.6
+  * *please let me know if it works in firefox 3 and ie 6, 7*
+  
+  ## Requirements
+  
+  * Rails 2.3 or 3
+  * jQuery (maybe I'll make it agnostic in the future)
+  
+  ## Usage
+  
+  1. Add the gem to your Rails app.
+  2. Run `script/generate unobtrusive_flash` or `rails g unobtrusive_flash:install`
+  3. Add the following to the controllers that generate flash messages (or better, to the `ApplicationController`):
+  
+          after_filter :prepare_unobtrusive_flash
+   
+  4. Include `unobtrusive_flash.css` and `unobtrusive_flash.js` in your layouts. No custom markup is needed.
+  5. Remove existing flash rendering code from your layouts.
+  6. That's all! You can also edit the generated CSS/JS to your liking.
+  
+  * * *
+  
+  © 2010 Leonid Shevtsov, released under the MIT license
+
+email: leonid@shevtsov.me
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/generators/templates/unobtrusive_flash.css
+- lib/generators/templates/unobtrusive_flash.js
+- lib/generators/unobtrusive_flash/install/install_generator.rb
+- lib/unobtrusive_flash.rb
+- lib/unobtrusive_flash/railtie.rb
+- generators/unobtrusive_flash/unobtrusive_flash_generator.rb
+- rails/init.rb
+- README.markdown
+has_rdoc: true
+homepage: http://github.com/leonid-shevtsov/unobtrusive_flash
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Unobtrusive flash messages for rails
+test_files: []
+