garlicjs-rails 1.0.3 → 1.1.1

data/README.md

@@ -18,9 +18,20 @@ Add the following directive to your Javascript manifest file (application.js):
 
     //= require garlic
 
+## Compatibility
+
+Garlic.js relies on localStorage, which is only compatible with "modern" browsers: IE8+, Chrome 4+, FF 4+, Safari 4+, Opera 11+.
+To add support for IE6 and IE7, add the `localstorageshim-rails` gem to your Gemfile:
+
+    gem 'localstorageshim-rails'
+
+And add the following line to your application layout (must be before garlicjs is loaded):
+
+    <%= localstorage_shim %>
+
 ## Versioning
 
-garlicjs-rails 1.0.3 == Garlic.js 1.0.3
+garlicjs-rails 1.1.1 == Garlic.js 1.1.1
 
 ## Contributing
 

data/lib/garlicjs-rails/version.rb

@@ -1,5 +1,5 @@
 module Garlicjs
   module Rails
-    VERSION = "1.0.3"
+    VERSION = "1.1.1"
   end
 end

data/vendor/assets/javascripts/garlic.js

@@ -84,16 +84,18 @@
       this.storage = storage;
       this.path = this.getPath();
       this.parentForm = this.$element.closest( 'form' );
+      this.$element.addClass('garlic-auto-save');
+      this.expiresFlag = !this.options.expires ? false : ( this.$element.data( 'expires' ) ? this.path : this.getPath( this.parentForm ) ) + '_flag' ;
 
-      this.retrieve();
-
+      // bind garlic events
       this.$element.on( this.options.events.join( '.' + this.type + ' ') , false, $.proxy( this.persist, this ) );
 
       if ( this.options.destroy ) {
-        this.$element.closest( 'form' ).on( 'submit reset' , false, $.proxy( this.destroy, this ) );
+        $( this.parentForm ).on( 'submit reset' , false, $.proxy( this.destroy, this ) );
       }
 
-      this.$element.addClass('garlic-auto-save');
+      // retrieve garlic persisted data
+      this.retrieve();
     }
 
     , getOptions: function ( options ) {
@@ -104,6 +106,19 @@
 
     /* temporary store data / state in localStorage */
     , persist: function () {
+
+      // some binded events are redundant (change & paste for example), persist only once by field val
+      if ( this.val === this.$element.val() ) {
+        return;
+      }
+
+      this.val = this.$element.val();
+
+      // if auto-expires is enabled, set the expiration date for future auto-deletion
+      if ( this.options.expires ) {
+        this.storage.set( this.expiresFlag , ( new Date().getTime() + this.options.expires * 1000 ).toString() );
+      }
+
       // for checkboxes, we need to implement an unchecked / checked behavior
       if ( this.$element.is( 'input[type=checkbox]' ) ) {
         return this.storage.set( this.path , this.$element.attr( 'checked' ) ? 'checked' : 'unchecked' );
@@ -115,6 +130,18 @@
     /* retrieve localStorage data / state and update elem accordingly */
     , retrieve: function () {
       if ( this.storage.has( this.path ) ) {
+
+        // if data expired, destroy it!
+        if ( this.options.expires ) {
+          var date = new Date().getTime();
+          if ( this.storage.get( this.expiresFlag ) < date.toString() ) {
+            this.storage.destroy( this.path );
+            return;
+          } else {
+            this.$element.attr( 'expires-in',  Math.floor( ( parseInt( this.storage.get( this.expiresFlag ) ) - date ) / 1000 ) );
+          }
+        }
+
         var storedValue = this.storage.get( this.path );
 
         // if conflictManager enabled, manage fields with already provided data, different from the one stored
@@ -245,16 +272,20 @@
        * other inputs: domain > pathname > form.<attr.name>[:eq(x)] > input.<attr.name>[:eq(y)]
           we just need the element name / eq() inside a given form
     */
-    , getPath: function () {
+    , getPath: function ( elem ) {
+
+      if ( 'undefined' === typeof elem ) {
+        elem = this.$element;
+      }
 
       // Requires one element.
-      if ( this.$element.length != 1 ) {
+      if ( elem.length != 1 ) {
         return false;
       }
 
       var path = ''
-        , fullPath = this.$element.is( 'input[type=checkbox]' )
-        , node = this.$element;
+        , fullPath = elem.is( 'input[type=checkbox]' )
+        , node = elem;
 
       while ( node.length ) {
         var realNode = node[0]
@@ -364,6 +395,7 @@
     , inputs: 'input, textarea, select'                                                           // Default supported inputs.
     , events: [ 'DOMAttrModified', 'textInput', 'input', 'change', 'keypress', 'paste', 'focus' ] // Events list that trigger a localStorage
     , domain: false                                                                               // Store et retrieve forms data accross all domain, not just on
+    , expires: false                                                                              // false for no expiration, otherwise (int) in seconds for auto-expiration
     , conflictManager: {
         enabled: true                                                                             // Manage default data and persisted data. If false, persisted data will always replace default ones
       , garlicPriority: true                                                                      // If form have default data, garlic persisted data will be shown first
@@ -383,4 +415,4 @@
   });
 
 // This plugin works with jQuery or Zepto (with data extension builded for Zepto. See changelog 0.0.6)
-}(window.jQuery || window.Zepto);
+}(window.jQuery || window.Zepto);

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: garlicjs-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-13 00:00:00.000000000 Z
+date: 2012-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -58,7 +58,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2086385096376470105
+      hash: 4582252746168385461
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -67,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2086385096376470105
+      hash: 4582252746168385461
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24