olay-rails 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
 SHA512: 
-  metadata.gz: 001159fb1812f1bf0989aa239b5c607ea999ce20d58d034a8f4ace8faf10f409d61d2d842ad4b908551a6cceb785813a04957b92c224ebb66b5b7b993a644426
-  data.tar.gz: 90f92fece5782e56261e1b404a262ff2231e27552382c5948f5a5bec61d40df6896eb87843637f5b862706afcbbffebaf6ca875564333e9288e08cabb2fa1e0e
+  data.tar.gz: 3114549633c5e25c242a848201f9462cada5a8f54470ecf30cee395add7c6d49598a8186d67902336010a8d0478f34b1d6311e1f3ba6e7c9fa86a024072a73dc
+  metadata.gz: ca99747b6a1f88fd8e8797d573e3ef0c25c37f71ccc7c2aa18df2c97fc055ae21f771369839947cc65ecdf0e46b522fc5db5bf89a52ac2ab5d84dd02a6fb1fa8
 SHA1: 
-  metadata.gz: 6986f1c388b29ed89aa0a22ce0a70c13d04a6588
-  data.tar.gz: dfb57902d6aa600617640b457b7d37397749eaf6
+  data.tar.gz: a5fa72dd98c53d38d620bbb98a6481f2765c8ee7
+  metadata.gz: 4447c9c9feae298e14a42cce37bc46a3c8e3018a

data/lib/olay/rails/version.rb

@@ -1,6 +1,6 @@
 module Olay
-  VERSION = '0.1.3'
+  VERSION = '0.1.5'
   module Rails
-    VERSION = '0.1.4'
+    VERSION = '0.1.5'
   end
 end

data/vendor/assets/javascripts/olay.js

@@ -16,13 +16,25 @@
     }
   });
 
+  // This private function will be used to stop event propagation in $content.
+  var stopPropagation = function (ev) { ev.stopPropagation(); };
+
   // Create the `Olay` constructor.
   //
   // ```js
   // var olay = new Olay('Howdy!', {duration: 5000});
   // ```js
   var Olay = window.Olay = function (el, options) {
+
+    // Extend the instance with its options.
     for (var name in options) this[name] = options[name];
+
+    // Store a bound `hide` to be used for callbacks. This is also used to
+    // ensure event callbacks can be removed consistently.
+    var self = this;
+    this._hide = function () { return self.hide(); };
+
+    // Create the necessary DOM nodes.
     this.$container = $('<div>')
       .addClass('js-olay-container')
       .addClass(this.transition)
@@ -36,8 +48,10 @@
     this.$content = $('<div>')
       .addClass('js-olay-content')
       .attr({role: 'alertdialog', 'aria-label': this.ariaLabel})
-      .append(
-    this.$el = el instanceof $ ? el : $(el)))));
+      .on('click', '.js-olay-hide', this._hide))));
+
+    // Finally, set the element.
+    this.setElement(el);
   };
 
   // Define `prototype` properties and methods for `Olay`.
@@ -62,6 +76,13 @@
     // Should the olay be hidden when there is a click outside the content box?
     hideOnClick: true,
 
+    // Preserve the DOM data and events for this olay. If this is set to `true`,
+    // be sure to either set it to `false` before your final `hide` call, or
+    // after your final `hide` call invoke `destroy()` after your transition.
+    // Failure to do this will cause memory leaks. When `preserve` is set to
+    // `false` this is handled automaticaly.
+    preserve: false,
+
     // Show the olay.
     show: function () {
       var inDom = $.contains($('body')[0], this.$container[0]);
@@ -73,19 +94,17 @@
       // this will apply the end result of the transition instantly, which is
       // not desirable in a transition...
       this.$container.data('olay', this).height();
-      this.$container.addClass('js-olay-show');
-      var self = this;
-      var hide = function () { self.hide(); };
-      this.$content.on('click', '.js-olay-hide', hide);
+      this.$container.addClass('js-olay-show').off('click', this._hide);
+      this.$content.off('click', stopPropagation);
       if (this.hideOnClick) {
-        this.$container.click(hide);
-        this.$content.click(function (ev) { ev.stopPropagation(); });
+        this.$container.click(this._hide);
+        this.$content.click(stopPropagation);
       }
       this.$el.trigger('show');
       var duration = this.duration;
       if (!duration) return this;
       duration += this.transitionDuration;
-      this._timeout = setTimeout(hide, duration);
+      this._timeout = setTimeout(this._hide, duration);
       return this;
     },
 
@@ -95,7 +114,6 @@
       if (!this.$container.hasClass('js-olay-show')) return;
       clearTimeout(this._timeout);
       this.$container.removeClass('js-olay-show');
-      this.$el.trigger('hide');
       var duration = this.transitionDuration;
       if (!duration) return this._remove();
       var self = this;
@@ -103,6 +121,19 @@
       return this;
     },
 
+    // Use this method to set or update `$el`.
+    setElement: function (el) {
+      this.$content.empty().append(this.$el = el instanceof $ ? el : $(el));
+    },
+
+    // Completely remove the `$container` element and its children and all of
+    // the associated data and events. This will only ever need to be called if
+    // the `preserve` option is `true` to prevent memory leaks.
+    destroy: function () {
+      this.$container.remove();
+      return this;
+    },
+
     // Append `$container` to the DOM. Used internally.
     _append: function () {
       var $body = $('body');
@@ -123,9 +154,9 @@
       return this;
     },
 
-    // Detach or remove `$container` from the DOM. Used internally.
+    // Detach and optionally remove `$container` from the DOM. Used internally.
     _remove: function () {
-      this.$container.remove();
+      this.$container.detach();
       this._$active.attr('tabindex', 0).focus().removeAttr('tabindex');
       var $olays = $('.js-olay-container');
       ($olays.length ? $olays.last() : $('body').removeClass('js-olay-visible'))
@@ -134,6 +165,8 @@
           $t.attr('tabindex', $t.data('olayTabindex'))
             .removeData('olayTabindex');
         });
+      this.$el.trigger('hide');
+      if (!this.preserve) this.destroy();
       return this;
     }
   };

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: olay-rails
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - Casey Foster
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-03-06 00:00:00 Z
+date: 2013-03-07 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   prerelease: false
@@ -22,7 +22,7 @@ dependencies:
         version: "3.1"
   type: :runtime
   version_requirements: *id001
-description: Places Olay 0.1.3 in the Rails asset pipeline.
+description: Places Olay 0.1.5 in the Rails asset pipeline.
 email: 
 - c@sey.me
 executables: []