unobtrusive_flash 0.0.2 → 2.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MWU1ZTA0MjUzNzMyYmY4MTkzZGUzMzE3MmEzNmE1NTc2YWEwYTA4NQ==
+  data.tar.gz: !binary |-
+    OTVhNmFkNWI2YTFjYjk3MjY2YjI5YjI2Yjg5MDY1YjQzNzc3YTM2NQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MDkwODU2YmEzNTJjODJmYTg2MDhhZDllMzUwYmRiYjdiNjNlNTY0MDcyMjdi
+    NDkzYTk4MjVmYjk5N2RhMjEyN2NhYTBkZjg2ODU2NDZhYmMzNTJkNDNhNjkz
+    NzI3NGIxODQwMmI1NTU3MjUzYjRkNGQzOGJkODA3MTNmMTcwY2M=
+  data.tar.gz: !binary |-
+    YjIxMGFkMjkzZjMyYjg0ZWQ5NWQ1OWU1YmJkZTk3ZDk3MTVmZTgxZjY1NTI5
+    N2M5ZGVlNTlhYjA5ODY1OGIxM2ZhOTZjYjYwNGJiZjQxOTgwYmE0NWVmNTEx
+    OWUyZjE0MGMwMjE5Yjk2NzM1MDNkMjk3NDcwYmM0Mjg3YzZiMjc=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## 2013-10-09 2.0.0
+
+* Grand refactoring
+* Compatibility with Rails 3 Asset Pipeline
+* Dropped compatibility with Rails 2
+* Decoupled logic from presentation
+* Compatibility with Bootstrap
+* Event-driven architecture

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in unobtrusive_flash.gemspec
+gemspec

data/README.markdown

@@ -1,5 +1,7 @@
 # Unobtrusive flash messages for Rails
 
+**Version 1 users:** this gem got a major redesign in version 2, please read the documentation
+
 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?
@@ -13,32 +15,64 @@ 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: 
+Tested 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*
+* Internet Explorer 8 and later
+* Firefox up to v24
+* Chrome up to v30
+* Safari 6
+* Opera 12
 
 ## Requirements
 
-* Rails 2.3 or 3
-* jQuery (maybe I'll make it agnostic in the future)
+* Rails 3
+* jQuery (tested with v1.10)
 
 ## 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`):
+2. Add the following to the controllers that generate flash messages (or better, to the `ApplicationController`):
 
         after_filter :prepare_unobtrusive_flash
+
+    Important! **Flash messages are NOT HTML escaped**, so you can use any markup in them. Take additional care to protect yourself from injection attacks if necessary.
+
+3. Include `require unobtrusive_flash` in your `application.js`.
+
+4. Delete flash rendering code from your views, if there was any.
+
+5. You have three options to render flash messages on the frontend:
+
+### Option 1: For Bootstrap projects
+
+Also `require unobtrusive_flash_bootstrap` in your `application.js`. This file contains flash message UI based on the [Bootstrap alert component](http://getbootstrap.com/components/#alerts).
+
+Either declare a `.unobtrusive-flash-container` element somewhere on the page to contain the alerts, or Unobtrusive flash will choose the first `.container` or `.container-fluid` element on the page, or fall back to the `body`.
+
+### Option 2: For non-Bootstrap projects
+
+Also `require unobtrusive_flash_ui` in your `application.js` and `require unobtrusive_flash_ui` in your `application.css`. These files contain a no-frills flash message UI that works out of the box.
+
+### Option 3: Roll your own
+
+Unobtrusive Flash triggers jQuery events when flash is received. If you want to integrate it with your own UI, implement and bind a handler:
+
+    flashHandler = function(e, params) {
+      alert('Received flash message '+params.message+' with type '+params.type);
+    };
+
+    $(window).bind('rails:flash', flashHandler);
+
  
-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.
+## Bonus: show 'flash messages' from the front-end
+
+Both Bootstrap and non-Bootstrap versions contain a function to display flash messages:
+
+    // Shown for 5 seconds (default)
+    $.showFlashMessage('Hello World', {type: 'notice'})
+    // Shown forever
+    $.showFlashMessage('Error', {type: 'error', timeout: 0})
 
 * * *
 
-© 2010 Leonid Shevtsov, released under the MIT license
+© 2010-2013 Leonid Shevtsov, released under the MIT license

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/unobtrusive_flash/controller_mixin.rb

@@ -0,0 +1,19 @@
+module UnobtrusiveFlash
+  module ControllerMixin
+    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] = {:value => cookie_flash.to_json, :domain => :all}
+        flash.discard
+      end
+    end
+  end
+end

data/lib/unobtrusive_flash/{railtie.rb → engine.rb}

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

data/lib/unobtrusive_flash/version.rb

@@ -0,0 +1,3 @@
+module UnobtrusiveFlash
+  VERSION = "2.0.0"
+end

data/lib/unobtrusive_flash.rb

@@ -1,21 +1,5 @@
-require File.join(File.dirname(__FILE__), *%w[unobtrusive_flash railtie]) if defined?(::Rails::Railtie)
+require "unobtrusive_flash/version"
+require "unobtrusive_flash/engine"
 
 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/unobtrusive_flash.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'unobtrusive_flash/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "unobtrusive_flash"
+  spec.version       = UnobtrusiveFlash::VERSION
+  spec.authors       = ["Leonid Shevtsov"]
+  spec.email         = ["leonid@shevtsov.me"]
+  spec.summary = "Unobtrusive flash messages for Rails"
+  spec.description   = <<EOT
+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?
+EOT
+  spec.homepage      = "https://github.com/leonid-shevtsov/unobtrusive_flash"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "railties"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/vendor/assets/javascripts/unobtrusive_flash.js

@@ -0,0 +1,61 @@
+$(function() {
+  // Delete the cookie regardless of the domain it was set from
+  // Partial credit to http://stackoverflow.com/a/2959110/6678
+  function nukeCookie(cookieName) {
+      var yesterday = new Date();
+      yesterday.setDate(yesterday.getDate() - 1);
+      var hostParts = window.location.host.split('.').reverse();
+      var expireHost = hostParts.shift();
+      $.each(hostParts, function(i,part) {
+        expireHost = part + '.' + expireHost;
+        document.cookie = cookieName+'=; path=/;expires='+yesterday+'; domain='+expireHost;
+      });
+      document.cookie = cookieName+'=; path=/';expires=+yesterday+'; domain=';
+  }
+
+  // Extracts flash array stored in cookie and clears the cookie
+  function extractFlashFromCookies() {
+    var data = null;
+    if (document.cookie && document.cookie !== '') {
+      var cookies = document.cookie.split(';');
+      var name = 'flash';
+      var cookieValue = 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'));
+            if (cookieValue.length > 0) break; // there might be empty "flash=" cookies
+          }
+      }
+
+      try {
+        data = $.parseJSON(cookieValue);
+      } catch(e) {
+      }
+
+      nukeCookie('flash');
+    }
+
+    return data;
+  }
+
+  // Reads flash messages from cookies and fires corresponding events
+  function showFlashFromCookies() {
+    var flashMessages = extractFlashFromCookies();
+    if (flashMessages !== null) {
+      $.each(flashMessages, function(_, flashMessage) {
+        $(window).trigger('rails:flash', {type: flashMessage[0], message: flashMessage[1]});
+      });
+    }
+  }
+
+  $(function() {
+    showFlashFromCookies();
+  });
+
+  $(document).ajaxSuccess(function(event,request,options) {
+    showFlashFromCookies();
+  });
+});

data/vendor/assets/javascripts/unobtrusive_flash_bootstrap.js

@@ -0,0 +1,35 @@
+// Unobtrusive flash UI implementation with Bootstrap 3
+// For sites that use Bootstrap http://getbootstrap.com/
+//
+// Declare a .unobtrusive-flash-container wherever you want the messages to appear
+// Defaults to .container, .container-fluid (core Bootstrap classes), or just the body tag, whichever is present
+$(function() {
+  var $flashContainer = $($('.unobtrusive-flash-container')[0] || $('.container')[0] || $('.container-fluid')[0] || $('body')[0]);
+
+  $.showFlashMessage = function(message, options) {
+    options = $.extend({type: 'notice', timeout: 5000}, options);
+
+    // Workaround for common Rails flash type to match common Bootstrap alert type
+    if (options.type=='notice') options.type = 'info';
+
+    var $flash = $('<div class="alert alert-'+options.type+'"><button type="button" class="close" data-dismiss="alert">&times;</button>'+message+'</div>');
+
+    $flashContainer.prepend($flash);
+
+    $flash.hide().delay(300).slideDown(100);
+
+    $flash.alert();
+
+    if (options.timeout>0) {
+      setTimeout(function() {
+        $flash.alert('close');
+      },options.timeout);
+    }
+  };
+
+  flashHandler = function(e, params) {
+    $.showFlashMessage(params.message, {type: params.type});
+  };
+
+  $(window).bind('rails:flash', flashHandler);
+});

data/vendor/assets/javascripts/unobtrusive_flash_ui.js

@@ -0,0 +1,38 @@
+// Unobtrusive flash UI implementation, design agnostic
+// Remember to link unobtrusive_flash_ui.css as well
+//
+// Shows flash messages as translucent bars on top of the page
+$(function() {
+  $('<div id="unobtrusive-flash-messages"></div>').prependTo('body');
+
+  function hideFlash($flash) {
+    $flash.slideUp(100,function(){
+      $flash.remove();
+    });
+  }
+
+  $.showFlashMessage = function(message, options) {
+    options = $.extend({type: 'notice', timeout: 5000}, options);
+
+    var $flash = $('<div class="unobtrusive-flash-message-wrapper unobtrusive-flash-'+options.type+'"><div class="unobtrusive-flash-message">'+message+'</div></div>');
+
+    $('#unobtrusive-flash-messages').prepend($flash);
+    $flash.hide().delay(300).slideDown(100);
+
+    $flash.click(function() {
+      hideFlash($flash);
+    });
+
+    if (options.timeout>0) {
+      setTimeout(function() {
+        hideFlash($flash);
+      },options.timeout);
+    }
+  };
+
+  flashHandler = function(e, params) {
+    $.showFlashMessage(params.message, {type: params.type});
+  };
+
+  $(window).bind('rails:flash', flashHandler);
+});

data/vendor/assets/stylesheets/unobtrusive_flash_ui.css

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

metadata

@@ -1,79 +1,107 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: unobtrusive_flash
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
+version: !ruby/object:Gem::Version
+  version: 2.0.0
 platform: ruby
-authors: 
+authors:
 - Leonid Shevtsov
 autorequire: 
 bindir: bin
 cert_chain: []
+date: 2013-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'unobtrusive_flash takes your flash messages for the backend and automagically
+  passes them to the frontend via HTTP cookies.
 
-date: 2010-11-18 00:00:00 +02:00
-default_executable: 
-dependencies: []
+  This works with both regular page loads and AJAX requests, does not tamper with
+  the page body and requires about 3 extra
 
-description: |
-  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?
+  lines of code in your app - how''s that for unobtrusive?
 
-email: leonid@shevtsov.me
+'
+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
-- init.rb
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
 - README.markdown
-has_rdoc: true
-homepage: http://github.com/leonid-shevtsov/unobtrusive_flash
+- Rakefile
+- lib/unobtrusive_flash.rb
+- lib/unobtrusive_flash/controller_mixin.rb
+- lib/unobtrusive_flash/engine.rb
+- lib/unobtrusive_flash/version.rb
+- unobtrusive_flash.gemspec
+- vendor/assets/javascripts/unobtrusive_flash.js
+- vendor/assets/javascripts/unobtrusive_flash_bootstrap.js
+- vendor/assets/javascripts/unobtrusive_flash_ui.js
+- vendor/assets/stylesheets/unobtrusive_flash_ui.css
+homepage: https://github.com/leonid-shevtsov/unobtrusive_flash
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+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"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 2.0.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Unobtrusive flash messages for Rails
 test_files: []
-

data/generators/unobtrusive_flash/unobtrusive_flash_generator.rb

@@ -1,27 +0,0 @@
-# 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', 'javascripts', '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/init.rb

@@ -1,2 +0,0 @@
-require 'unobtrusive_flash'
-::ActionController::Base.send(:include, UnobtrusiveFlash)

data/lib/generators/templates/unobtrusive_flash.css

@@ -1,23 +0,0 @@
-#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

@@ -1,67 +0,0 @@
-// 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

@@ -1,15 +0,0 @@
-# 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/rails/init.rb

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