ajaxify_rails 0.0.6 → 0.0.7

data/README.md

@@ -13,13 +13,17 @@ Features:
 - Falls back to a hash based approach for browsers without the history interface (like Internet Explorer version <10)
 - Hash based and non-hash URLs are interchangeable.
 - Transparently handles redirects and supports page titles and flash messages.
-- Requires Ruby 1.9 and the asset pipeline.
 - Tested with Chrome, Firefox, Safari and Internet Explorer 8+
 
 Demo: http://ajaxify-demo.herokuapp.com/
 
 Inspired by the pjax_rails gem (https://github.com/rails/pjax_rails)
 
+## Requirements
+
+- Ruby 1.9 and the asset pipeline.
+- Your app doesn't use named anchors (#). Named anchors can't be correctly represented in the fallback hash based url scheme.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -75,7 +79,7 @@ update the page's title tag after the main content has changed.
 
 It's a common use case to have a navigation that needs to change its appearence and possibly functioning when the user navigates
 to a different section of the page. Ajaxify provides a success callback that is triggered after successful
-updates of he page's main content. Just hook into it in your javascript and make your layout changes:
+updates of the page's main content. Just hook into it in your javascript and make your layout changes:
 
     Ajaxify.success ->
       # update navigation and/or other layout elements
@@ -98,7 +102,7 @@ Also make sure that you supply invisible wrapper tags in your layout with the fl
 We all know them. Those big requests changing the layout of the page so significantly that 
 loading ajax into a content area and doing some minor layout tweaks here and there simply doesn't cut it. Sigh.
 
-There might also be links and forms that have already their own ajax functionality.
+There might also be links and forms which already have their own ajax functionality.
 
 To turn Ajaxify off for certain links and forms, simply add the class `no_ajaxify` directly to the link or form:
 

data/lib/ajaxify_rails/version.rb

@@ -1,3 +1,3 @@
 module AjaxifyRails
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/vendor/assets/javascripts/ajaxify_rails/ajaxify_rails.js.coffee

@@ -22,7 +22,6 @@
 
   # internal use only
   #
-  hash_changed: null
   ignore_hash_change: null
   load_page_from_hash: null
 
@@ -74,27 +73,34 @@
         false
 
 
+    # (history interface browsers only)
     window.onpopstate = (e) ->
       if e.state
         e.state.cache = false
         self.load e.state, true
 
 
+    # (non history interface browsers only)
     window.onhashchange = ->
-      if window.location.hash.indexOf('#/') == 0  # only react to hash changes if hash starts with '/'
-        unless self.ignore_hash_change
-          self.on_hash_change()
-        else
-          self.ignore_hash_change = false
+      unless self.ignore_hash_change
+        self.on_hash_change()
+      else
+        self.ignore_hash_change = false
 
 
+  # load content from url hash (non history interface browsers)
   on_hash_change: ->
     url = window.location.hash.replace(/#/, "")
-    if url == ''
-      url = '/'
+
+    base_path_regexp = this.base_path_regexp()
+    if match = window.location.pathname.match(base_path_regexp)
+      url = match[0] + url
+
+    url = '/' if url == ''
     this.hash_changed = true
     this.load
       url: url
+    , true
 
 
   load: (options, pop_state = false) ->
@@ -164,11 +170,7 @@
       options.url = current_url.replace(/(&|\?)ajaxify_redirect=true/,'')
       options.type = 'GET'
 
-    if not this.hash_changed  # no need to update url if the ajax call resulted in a hash change
-      this.update_url options, pop_state
-    else
-      this.hash_changed = false
-
+    this.update_url options, pop_state
 
     if this.handle_extra_content
       this.handle_extra_content()
@@ -208,20 +210,22 @@
         ,'', options.url
 
       else
-        this.ignore_hash_change = true  # avoids loading the page for hash changes caused by link clicks
+        this.ignore_hash_change = true  # for non histroy interface browsers: avoids loading the page for hash changes caused by link clicks
         hash = "#{options.url.replace(new RegExp(this.protocol_with_host()), '')}"
+
         base_path_regexp = this.base_path_regexp()
         if base_path_regexp
           hash = hash.replace(base_path_regexp, '')
           hash = "/#{hash}" unless hash == '' or hash.indexOf('/') == 0
+
         window.location.hash = hash
-#        this.ignore_hash_change = false
 
 
   base_path_regexp: ->
     return null unless this.base_paths
     # match starting and ending with base path, e.g. "^\/en$" (i.e. we are at the base path root) or
-    # starting with base path and continuing with '/', e.g. "^\/en\/" (i.e. we are NOT at the base path root)
+    # starting with base path and continuing with '/', e.g. "^\/en\/" (i.e. we are NOT at the base path root) or
+    # starting with base path and continuing with '?', e.g. "^\/en\?" (i.e. we are at the base path root and have query params)
     self = this
     new RegExp("^\/(#{ $.map(this.base_paths, (el) ->
       el = self.regexp_escape el
@@ -229,50 +233,59 @@
     ).join('|')})", 'i')
 
 
-  regexp_escape: (str) ->
-    str.replace new RegExp('[.\\\\+*?\\[\\^\\]$(){}=!<>|:\\-]', 'g'), '\\$&'
-
-
-  protocol_with_host: ->
-    loc = window.location
-    "#{loc.protocol}//#{loc.host}"
-
-
   correct_url: ->
     if this.active
-      if window.location.hash.indexOf('#/') == 0
+
+      if window.location.hash.indexOf('#') == 0   # if url has a '#' in it treat it as a non history interface hash based scheme url
         if !window.history.pushState
           Ajaxify.load_page_from_hash = true   # notify Ajaxify that a hash will be loaded and ignore all other calls to load until hash url is loaded
         else
-          path = window.location.pathname + window.location.hash.replace(/#\//, "")       # load proper url in case url contains #/ and browser supports history api
+          # load proper url in case browser supports history api
+          path = window.location.pathname
+          path = '' if path == '/'
+          path = path + window.location.hash.replace(/#/, "")
           window.location.href = "#{this.protocol_with_host()}#{path}"
 
-      else if !window.history.pushState
-        # move path behind # for browsers without history api
-        if window.location.pathname != '/'
-          base_path_regexp = this.base_path_regexp()
-          if base_path_regexp and (match = window.location.pathname.match(base_path_regexp))
-            if match[0] == window.location.pathname
-              if window.location.search == ''
-                return
-              else
-                path = match[0].replace(/\?/,'') + '#'
+      else if !window.history.pushState # move path behind '#' for browsers without history api
+
+        if window.location.pathname == '/'
+          if window.location.search != ''
+            window.location.href = "#{this.protocol_with_host()}/#/#{window.location.search}" # move search behind #
+            return
+
+        base_path_regexp = this.base_path_regexp()
+        if base_path_regexp and (match = window.location.pathname.match(base_path_regexp))
+          if match[0] == window.location.pathname
+            if window.location.search == ''
+              return   # we are on a base path here already, so don't do anything
             else
-              path = "#{match[0]}##{window.location.pathname}"
+              path = match[0].replace(/\?/,'') + '#'
           else
-            path = "/##{window.location.pathname}"
-
-          window.location.href = "#{this.protocol_with_host()}#{path}#{window.location.search}"
+            path = "#{match[0].replace(/\/$/,'')}#/#{window.location.pathname.replace(match[0],'')}"
         else
-          if window.location.search != ''
-            window.location.href = "#{this.protocol_with_host()}/##{window.location.search}" # move search behind #
+          path = "/##{window.location.pathname}"
+
+        window.location.href = "#{this.protocol_with_host()}#{path}#{window.location.search}"
+
 
   init: ->
     this.correct_url()
 
+
+  #
+  # utility functions
+  #
+
   is_string: (variable) ->
     Object.prototype.toString.call(variable) == '[object String]'
 
+  regexp_escape: (str) ->
+    str.replace new RegExp('[.\\\\+*?\\[\\^\\]$(){}=!<>|:\\-]', 'g'), '\\$&'
+
+  protocol_with_host: ->
+    loc = window.location
+    "#{loc.protocol}//#{loc.host}"
+
 
 jQuery ->
   Ajaxify.ajaxify()

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ajaxify_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-28 00:00:00.000000000 Z
+date: 2012-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -67,7 +67,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1242994439653128660
+      hash: 3241729094271332625
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1242994439653128660
+      hash: 3241729094271332625
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24