wiselinks 0.3.0 → 0.3.2

data/README.md

@@ -51,7 +51,7 @@ Wiselinks works in all major browsers including browsers that do not support HTM
 			<td><strong>Yes</strong></td>
 		</tr>
 		<tr>
-			<td>Asset change detection</td>
+			<td>Assets change detection</td>
 			<td>Yes, by parsing document head on every request.</td>
 			<td><strong>Yes</strong>, by calculating assets MD5 hash on boot.</td>
 		</tr>
@@ -70,6 +70,8 @@ Then do:
 	
 	bundle install
 
+Restart your server and you're now using wiselinks!
+
 ## How does it work?
 
 Modify your `application.js.coffee` file to use Wiselinks object:
@@ -188,18 +190,24 @@ $(document).ready ->
             # start loading animation
     )
 
+	$(document).off('page:complete').on(
+        'page:complete'
+        (event, xhr, settings) ->
+            console.log("Wiselinks page loading completed")
+            # stop loading animation
+    )
+
     $(document).off('page:success').on(
         'page:success'
         (event, data, status) ->        
             console.log("Wiselinks status: '#{status}'")
-            # stop loading animation
     )
 
     $(document).off('page:error').on(
         'page:error'
         (event, data, status) ->        
             console.log("Wiselinks status: '#{status}'")
-            # stop loading animation and show error message
+            # show error message
     )
 ```     	
 
@@ -245,6 +253,22 @@ Method returns `true` if current request is initiated by Wiselinks and client wa
 ### #wiselinks_partial? ###
 Method returns `true` if current request is initiated by Wiselinks and client want to render partial, `false` otherwise. 
 
+## Assets change detection
+
+You can enable assets change detection with Wiselinks. To do this you have to enable assets digests by adding this to you environment file:
+
+```ruby
+config.assets.digest = true
+```
+
+Then you should append your layout by adding this to head section:
+
+```erb
+<%= wiselinks_meta_tag %>
+```
+
+Now Wiselinks will track changes of your assets and if anything will change, your page will be reloaded completely.
+
 ## Title handling
 
 Wiselinks handles page titles by passing `X-Title` header with response. To do this you can use `wiselinks_title` helper.
@@ -262,7 +286,7 @@ Of course you can use `wiselinks_title` helper in your own helpers too.
 
 ##Example
 
-We crafted small example application that uses Wiselinks so you can see it in action.
+We crafted example application that uses nearly all features of Wiselinks so you can see it in action.
 
 * GitHub Repository: [https://github.com/igor-alexandrov/wiselinks_example](https://github.com/igor-alexandrov/wiselinks_example)
 

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.2

data/lib/assets/javascripts/_history.adapter.jquery.js

@@ -0,0 +1,76 @@
+/**
+ * History.js jQuery Adapter
+ * @author Benjamin Arthur Lupton <contact@balupton.com>
+ * @copyright 2010-2011 Benjamin Arthur Lupton <contact@balupton.com>
+ * @license New BSD License <http://creativecommons.org/licenses/BSD/>
+ */
+
+// Closure
+(function(window,undefined){
+  "use strict";
+
+  // Localise Globals
+  var
+    History = window.History = window.History||{},
+    jQuery = window.jQuery;
+
+  // Check Existence
+  if ( typeof History.Adapter !== 'undefined' ) {
+    throw new Error('History.js Adapter has already been loaded...');
+  }
+
+  // Add the Adapter
+  History.Adapter = {
+    /**
+     * History.Adapter.bind(el,event,callback)
+     * @param {Element|string} el
+     * @param {string} event - custom and standard events
+     * @param {function} callback
+     * @return {void}
+     */
+    bind: function(el,event,callback){
+      jQuery(el).bind(event,callback);
+    },
+
+    /**
+     * History.Adapter.trigger(el,event)
+     * @param {Element|string} el
+     * @param {string} event - custom and standard events
+     * @param {Object=} extra - a object of extra event data (optional)
+     * @return {void}
+     */
+    trigger: function(el,event,extra){
+      jQuery(el).trigger(event,extra);
+    },
+
+    /**
+     * History.Adapter.extractEventData(key,event,extra)
+     * @param {string} key - key for the event data to extract
+     * @param {string} event - custom and standard events
+     * @param {Object=} extra - a object of extra event data (optional)
+     * @return {mixed}
+     */
+    extractEventData: function(key,event,extra){
+      // jQuery Native then jQuery Custom
+      var result = (event && event.originalEvent && event.originalEvent[key]) || (extra && extra[key]) || undefined;
+
+      // Return
+      return result;
+    },
+
+    /**
+     * History.Adapter.onDomLoad(callback)
+     * @param {function} callback
+     * @return {void}
+     */
+    onDomLoad: function(callback) {
+      jQuery(callback);
+    }
+  };
+
+  // Try and Initialise History
+  if ( typeof History.init !== 'undefined' ) {
+    History.init();
+  }
+
+})(window);