unobtrusive_flash 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dcf558cc6c7773077a8b0e9b02a16d747785424c
-  data.tar.gz: 572d0ec1cddc18f14f601738a12e62b17a012d30
+  metadata.gz: 2eb8a0a2384eecefacf6fd3aff7dc0799567aca4
+  data.tar.gz: c4d0f68f87e5fc0f7b4b39725ad12b1b384e90e3
 SHA512:
-  metadata.gz: a158ce2b5636919e08e3bbfcb9c0bb1070c3064416353b84edca1f3ac42cb8fab19ad24ab3354ba3b2fc59180fdb8515905d50c2e7cf8d67aa1f0263b7a6ce72
-  data.tar.gz: 75aa65125e9e74ab6dc6785a61f8b14f31acb28bde4cba869f1642303e738a8250b77e109707a206141869d48a515d72b8c430c81780b4cf7b8c251e9cb62393
+  metadata.gz: b7ed858fbdb382db5a0823e3677a6f4609062710d9789fbd2924f86fd47bf1a0843ba90f9e2edd31297f9ae413a5281cf393c01940fbb910c02296fab3c00e95
+  data.tar.gz: ea0a2251c0366a6a81aae1f230d4a3982da82148d86cca0bc4ed0ee120fdecb9d2e6d7e9858602c37a7bd23da0d3fd4f980c1814a24c1d5e40168e538d3617ab

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9
+  - 2.0
+  - 2.1
+script: "rspec"

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 2014-06-23 3.1.0
+
+* Extracted default flash options to `UnobtrusiveFlash.flashOptions` so you can set the message timeout.
+* Use `hostname` when nuking cookies by @zeppelin [#14]
+* Check $flashContainer dynamically by @nfedyashev [#15].
+* Fixed issues with applications on the .herokuapp.com domain [#16].
+
 ## 2014-03-07 3.0.0
 
 * Moved Javascript methods to an `UnobtrusiveFlash` module. This breaks calling `$.showFlashMessage`, hence another major release [#11]

data/README.markdown

@@ -1,6 +1,4 @@
-# Unobtrusive flash messages for Rails
-
-**Version 1 users:** this gem got a major redesign in version 2, please read the documentation
+# Unobtrusive flash messages for Rails [![Build Status](https://travis-ci.org/leonid-shevtsov/unobtrusive_flash.svg?branch=master)](https://travis-ci.org/leonid-shevtsov/unobtrusive_flash)
 
 Ever got tired of pages that can't be cached because they contain flash messages?
 
@@ -52,10 +50,18 @@ Also `require unobtrusive_flash_bootstrap` in your `application.js`. This file c
 
 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`.
 
+If you want the flash messages to disappear automatically, set this in your Javascript:
+
+    UnobtrusiveFlash.flashOptions['timeout'] = 2000; // milliseconds
+
 ### 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.
 
+If you want the flash messages to disappear automatically, set this in your Javascript:
+
+    UnobtrusiveFlash.flashOptions['timeout'] = 2000; // milliseconds
+
 ### 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:
@@ -66,7 +72,6 @@ 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.
@@ -82,4 +87,4 @@ Both Bootstrap and non-Bootstrap versions contain a function to display flash me
 
 * * *
 
-© 2010-2014 Leonid Shevtsov, released under the MIT license
+© 2010-2014 [Leonid Shevtsov](http://leonid.shevtsov.me) and [contributors](https://github.com/leonid-shevtsov/unobtrusive_flash/graphs/contributors), released under the MIT license

data/lib/assets/javascripts/unobtrusive_flash.js

@@ -1,12 +1,13 @@
+window.UnobtrusiveFlash = {}
+
 $(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 hostParts = window.location.hostname.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;
@@ -43,7 +44,6 @@ $(function() {
   }
 
   // Reads flash messages from cookies and fires corresponding events
-  window.UnobtrusiveFlash = {}
   window.UnobtrusiveFlash['showFlashFromCookies'] = function() {
     var flashMessages = extractFlashFromCookies();
     if (flashMessages !== null) {

data/lib/assets/javascripts/unobtrusive_flash_bootstrap.js

@@ -3,11 +3,12 @@
 //
 // 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]);
 
+window.UnobtrusiveFlash.flashOptions = {type: 'notice', timeout: 0};
+
+$(function() {
   UnobtrusiveFlash.showFlashMessage = function(message, options) {
-    options = $.extend({type: 'notice', timeout: 0}, options);
+    options = $.extend(UnobtrusiveFlash.flashOptions, options);
 
     // Workaround for common Rails flash type to match common Bootstrap alert type
     if (options.type=='notice') {
@@ -20,6 +21,7 @@ $(function() {
 
     var $flash = $('<div class="alert alert-'+options.type+'"><button type="button" class="close" data-dismiss="alert">&times;</button>'+message+'</div>');
 
+    var $flashContainer = $($('.unobtrusive-flash-container')[0] || $('.container')[0] || $('.container-fluid')[0] || $('body')[0]);
     $flashContainer.prepend($flash);
 
     $flash.hide().delay(300).slideDown(100);
@@ -38,4 +40,4 @@ $(function() {
   };
 
   $(window).bind('rails:flash', flashHandler);
-});
+});

data/lib/assets/javascripts/unobtrusive_flash_ui.js

@@ -2,6 +2,8 @@
 // Remember to link unobtrusive_flash_ui.css as well
 //
 // Shows flash messages as translucent bars on top of the page
+window.UnobtrusiveFlash.flashOptions = {type: 'notice', timeout: 0};
+
 $(function() {
   $('<div id="unobtrusive-flash-messages"></div>').prependTo('body');
 
@@ -12,7 +14,7 @@ $(function() {
   }
 
   UnobtrusiveFlash.showFlashMessage = function(message, options) {
-    options = $.extend({type: 'notice', timeout: 0}, options);
+    options = $.extend(UnobtrusiveFlash.flashOptions, options);
 
     var $flash = $('<div class="unobtrusive-flash-message-wrapper unobtrusive-flash-'+options.type+'"><div class="unobtrusive-flash-message">'+message+'</div></div>');
 

data/lib/unobtrusive_flash/controller_mixin.rb

@@ -13,11 +13,22 @@ module UnobtrusiveFlash
         end
 
         cookie_flash += UnobtrusiveFlash::ControllerMixin.sanitize_flash(flash)
-        cookies[:flash] = {:value => cookie_flash.to_json, :domain => :all}
+        cookies[:flash] = {:value => cookie_flash.to_json, :domain => unobtrusive_flash_domain}
         flash.discard
       end
     end
 
+    # Setting cookies for :all domains is broken for Heroku apps, read this article for details
+    # https://devcenter.heroku.com/articles/cookies-and-herokuapp-com
+    # You can also override this method in your controller if you need to customize the cookie domain
+    def unobtrusive_flash_domain
+      if request.host =~ /\.herokuapp\.com$/
+        request.host
+      else
+        :all
+      end
+    end
+
     class << self
       def sanitize_flash(flash)
         flash.to_a.map do |key, value|

data/lib/unobtrusive_flash/version.rb

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

data/spec/domain_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe UnobtrusiveFlash::ControllerMixin do
+  describe '#unobtrusive_flash_domain' do
+    let(:controller_class) { Struct.new(:request) }
+    before(:each) { controller_class.send(:include, UnobtrusiveFlash::ControllerMixin) }
+    subject { controller_class.new( double('request', host: host) ) }
+
+    context 'not on Heroku' do
+      let(:host) { 'microsoft.com' }
+
+      it 'should use :all' do
+        expect(subject.send(:unobtrusive_flash_domain)).to eq(:all)
+      end
+    end
+
+    context 'on Heroku' do
+      let(:host) { 'myapp.herokuapp.com' }
+
+      it 'should use the host' do
+        expect(subject.send(:unobtrusive_flash_domain)).to eq('myapp.herokuapp.com')
+      end
+    end
+  end
+end

data/spec/sanitize_flash_spec.rb

@@ -3,11 +3,11 @@ require 'spec_helper'
 describe UnobtrusiveFlash::ControllerMixin do
   describe '.sanitize_flash' do
     it 'should escape messages that are not html safe' do
-      described_class.sanitize_flash({:foo => '<bar>'}).should == [[:foo, '&lt;bar&gt;']]
+      expect(described_class.sanitize_flash({:foo => '<bar>'})).to eq([[:foo, '&lt;bar&gt;']])
     end
 
     it 'should not escape messages that are html safe' do
-      described_class.sanitize_flash({:foo => '<bar>'.html_safe}).should == [[:foo, '<bar>']]
+      expect(described_class.sanitize_flash({:foo => '<bar>'.html_safe})).to eq([[:foo, '<bar>']])
     end
   end
 end

data/unobtrusive_flash.gemspec

@@ -25,5 +25,6 @@ EOT
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec", '>=3'
+  spec.add_development_dependency "rspec-mocks", '>=3'
 end

metadata

@@ -1,71 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: unobtrusive_flash
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Leonid Shevtsov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-07 00:00:00.000000000 Z
+date: 2014-06-23 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'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
 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
@@ -76,7 +90,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - README.markdown
@@ -89,6 +104,7 @@ files:
 - lib/unobtrusive_flash/controller_mixin.rb
 - lib/unobtrusive_flash/engine.rb
 - lib/unobtrusive_flash/version.rb
+- spec/domain_spec.rb
 - spec/sanitize_flash_spec.rb
 - spec/spec_helper.rb
 - unobtrusive_flash.gemspec
@@ -101,20 +117,21 @@ 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: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Unobtrusive flash messages for Rails
 test_files:
+- spec/domain_spec.rb
 - spec/sanitize_flash_spec.rb
 - spec/spec_helper.rb