unobtrusive_flash 2.1.0 → 3.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YTFiNGZlYTIwNDBjMDEwZTVmMGM3Mzc4YTExZDEyNTJlZmNlYjNlNw==
-  data.tar.gz: !binary |-
-    NGE5MWVkZWVhODFlZGNmYWM1YzRhZWZkNDczYWQ3YWFlY2FkYmEzYw==
+SHA1:
+  metadata.gz: dcf558cc6c7773077a8b0e9b02a16d747785424c
+  data.tar.gz: 572d0ec1cddc18f14f601738a12e62b17a012d30
 SHA512:
-  metadata.gz: !binary |-
-    YzExMDQ1YjM2ODA3YjFmOGZlZWM5MWY3MjViYmYzYmRmMjc3Y2NhYjc2NGUw
-    ZTJlOWJlZjdjNzllMTdmOTYxMWI5OWI5YWY5ZGQ3MDRkMmVkNmNkNDg1NTdh
-    NTUwNmM1YTRjNWM5Y2FjNzJiOTg5YjQ2YmYwNDc4Mzk0OGJmNjE=
-  data.tar.gz: !binary |-
-    MzU3YTc0NDI5OGI2NjY2MjEzZjI3NmNmODlmYmE4OWRmNTRjNmE5MTY5OTk4
-    Nzc1NDI3OWUwNzk1YjMzNWY0Njg5YmU3OWYyN2VlNDNkM2FlMzhkMWZkYjEz
-    NjY2NWZkOTZlMTFjNzI2NTI1NTRhYWY4MTA3NTQzMmU0OWY0NDk=
+  metadata.gz: a158ce2b5636919e08e3bbfcb9c0bb1070c3064416353b84edca1f3ac42cb8fab19ad24ab3354ba3b2fc59180fdb8515905d50c2e7cf8d67aa1f0263b7a6ce72
+  data.tar.gz: 75aa65125e9e74ab6dc6785a61f8b14f31acb28bde4cba869f1642303e738a8250b77e109707a206141869d48a515d72b8c430c81780b4cf7b8c251e9cb62393

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 2014-03-07 3.0.0
+
+* Moved Javascript methods to an `UnobtrusiveFlash` module. This breaks calling `$.showFlashMessage`, hence another major release [#11]
+* Make sure that the flash events are invoked after a handler had a chance to bind [#10]
+* Changed default alerts to never autohide [#6]
+* Bootstrap handler: All conventional Rails notices are correctly styled by @conzett [#12]
+* Turbolinks are supported thanks to @yoyos [#13]
+* Fixes to cookie nuking by @asaletnik [#7]
+
 ## 2013-12-21 2.1.0
 
 * Changed message escaping logic to use the Rails html_safe conventions (Possibly breaking change)

data/README.markdown

@@ -9,7 +9,7 @@ Ever got tired of writing custom code to handle flash messages passed in AJAX re
 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
+HTTP cookies. This works with both **regular page loads**, **jQuery AJAX requests**, and **turbolinks** (from v3), 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
@@ -25,14 +25,14 @@ Tested in:
 
 ## Requirements
 
-* Rails 3
+* Rails >=3
 * jQuery (tested with v1.10)
 
 ## Usage
 
 1. Add the `unobtrusive_flash` gem to your Gemfile.
 
-        gem 'unobtrusive_flash', '~>2'
+        gem 'unobtrusive_flash', '>=3'
 
 2. Add the following to the controllers that generate flash messages (or better, to the `ApplicationController`):
 
@@ -66,16 +66,20 @@ Unobtrusive Flash triggers jQuery events when flash is received. If you want to
 
     $(window).bind('rails:flash', flashHandler);
 
+
+## Using UnobtrusiveFlash with a frontend framework that doesn't use jQuery for AJAX
+
+Call `UnobtrusiveFlash.showFlashFromCookies()` in your Javascript after a completed request.
  
 ## 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'})
+    UnobtrusiveFlash.showFlashMessage('Hello World', {type: 'notice'})
     // Shown forever
-    $.showFlashMessage('Error', {type: 'error', timeout: 0})
+    UnobtrusiveFlash.showFlashMessage('Error', {type: 'error', timeout: 0})
 
 * * *
 
-© 2010-2013 Leonid Shevtsov, released under the MIT license
+© 2010-2014 Leonid Shevtsov, released under the MIT license

data/lib/assets/javascripts/unobtrusive_flash.js

@@ -6,6 +6,7 @@ $(function() {
       yesterday.setDate(yesterday.getDate() - 1);
       var hostParts = window.location.host.split('.').reverse();
       var expireHost = hostParts.shift();
+      expireHost = expireHost.replace(/^([a-z]{1,})\:[0-9]{1,5}/, '$1');
       $.each(hostParts, function(i,part) {
         expireHost = part + '.' + expireHost;
         document.cookie = cookieName+'=; path=/;expires='+yesterday+'; domain='+expireHost;
@@ -42,7 +43,8 @@ $(function() {
   }
 
   // Reads flash messages from cookies and fires corresponding events
-  function showFlashFromCookies() {
+  window.UnobtrusiveFlash = {}
+  window.UnobtrusiveFlash['showFlashFromCookies'] = function() {
     var flashMessages = extractFlashFromCookies();
     if (flashMessages !== null) {
       $.each(flashMessages, function(_, flashMessage) {
@@ -51,11 +53,13 @@ $(function() {
     }
   }
 
-  $(function() {
-    showFlashFromCookies();
+  $(window).load(function() {
+    UnobtrusiveFlash.showFlashFromCookies();
   });
 
+  $(document).on('page:change page:load', UnobtrusiveFlash.showFlashFromCookies);
+
   $(document).ajaxSuccess(function(event,request,options) {
-    showFlashFromCookies();
+    UnobtrusiveFlash.showFlashFromCookies();
   });
 });

data/lib/assets/javascripts/unobtrusive_flash_bootstrap.js

@@ -6,11 +6,17 @@
 $(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);
+  UnobtrusiveFlash.showFlashMessage = function(message, options) {
+    options = $.extend({type: 'notice', timeout: 0}, options);
 
     // Workaround for common Rails flash type to match common Bootstrap alert type
-    if (options.type=='notice') options.type = 'info';
+    if (options.type=='notice') {
+      options.type = 'info';
+    } else if(options.type=='alert') {
+      options.type = 'warning';
+    } else if(options.type=='error') {
+      options.type = 'danger';
+    }
 
     var $flash = $('<div class="alert alert-'+options.type+'"><button type="button" class="close" data-dismiss="alert">&times;</button>'+message+'</div>');
 
@@ -28,7 +34,7 @@ $(function() {
   };
 
   flashHandler = function(e, params) {
-    $.showFlashMessage(params.message, {type: params.type});
+    UnobtrusiveFlash.showFlashMessage(params.message, {type: params.type});
   };
 
   $(window).bind('rails:flash', flashHandler);

data/lib/assets/javascripts/unobtrusive_flash_ui.js

@@ -11,8 +11,8 @@ $(function() {
     });
   }
 
-  $.showFlashMessage = function(message, options) {
-    options = $.extend({type: 'notice', timeout: 5000}, options);
+  UnobtrusiveFlash.showFlashMessage = function(message, options) {
+    options = $.extend({type: 'notice', timeout: 0}, options);
 
     var $flash = $('<div class="unobtrusive-flash-message-wrapper unobtrusive-flash-'+options.type+'"><div class="unobtrusive-flash-message">'+message+'</div></div>');
 
@@ -31,7 +31,7 @@ $(function() {
   };
 
   flashHandler = function(e, params) {
-    $.showFlashMessage(params.message, {type: params.type});
+    UnobtrusiveFlash.showFlashMessage(params.message, {type: params.type});
   };
 
   $(window).bind('rails:flash', flashHandler);

data/lib/unobtrusive_flash/version.rb

@@ -1,3 +1,3 @@
 module UnobtrusiveFlash
-  VERSION = "2.1.0"
+  VERSION = "3.0.0"
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: unobtrusive_flash
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Leonid Shevtsov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-21 00:00:00.000000000 Z
+date: 2014-03-07 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
@@ -42,39 +42,34 @@ dependencies:
   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'
 - !ruby/object:Gem::Dependency
   name: rspec
   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.
-
-  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?
-
-'
+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?
 email:
 - leonid@shevtsov.me
 executables: []
@@ -106,12 +101,12 @@ require_paths:
 - lib
 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: []