ajax 0.1.5 → 0.1.6

data/README.rdoc

@@ -10,7 +10,7 @@ As of the end of April, 2010, Ajax is being used live in production on altnet.co
 
 == Install
 
-=== Rails 3
+=== Rails 3 (untested)
 
 1. Add the gem to your <tt>Gemspec</tt>
 
@@ -60,16 +60,24 @@ As of the end of April, 2010, Ajax is being used live in production on altnet.co
   skipped: app/views/ajax/framework.html.erb exists!
   ...
 
-=== Post Install
+== Getting Started
 
-1. Create layouts in <tt>app/views/layouts/ajax/</tt> that mimic your existing layouts.  See <b>Request Handling -> Layouts</b>.
-2. Instantiate an instance of the Ajax class in <tt>application.js</tt>.  For example:
+1. Ajax looks for an alternative layout to use with AJAX requests in <tt>app/views/layouts/ajax/</tt>.  Copy existing layouts into this directory and get them ready for AJAX by removing any HTML HEAD elements, everything but the inner BODY content.
 
-      window.ajax = new Ajax({
-        default_container: '#main',
-        enabled: true,
-        lazy_load_assets: false
-      });
+   Your main layout should contain a container element that will receive page content.  Typically this would be the container below the page header.  If you don't have a static header, you can make the whole BODY element the container.
+
+   Here is an {example of converting our <tt>layouts/application.html.haml</tt> to <tt>layouts/ajax/application.html.haml</tt>}[http://gist.github.com/373133/5a80a63ef69a883ed3c5630b68330b1036ad01ec].
+
+2. Instantiate an instance of the Ajax class in <tt>public/javascripts/application.js</tt>.  For example:
+
+  // public/javascripts/application.js
+  if (typeof(Ajax) != 'undefined') {
+    window.ajax = new Ajax({
+      default_container: '#main',  // jQuery selector of your container element
+      enabled: true,               // Enable/disable the plugin
+      lazy_load_assets: false      // YMMV
+    });
+  }
 
 == Introduction
 
@@ -183,15 +191,32 @@ If you need to, you can check the state of the plugin with:
 
 Other onfiguration goes in <tt>config/initializers/ajax.rb</tt> such as indicating which links to except from the request processing.  See <b>Excepted Links</b>.
 
+<b>Our <tt>config/initializers/ajax.rb</tt> file:</b>
+
+  # config/initializers/ajax.rb
+  Ajax.enabled = true
+  Ajax.lazy_load_assets = false
+
+  # Excepted paths: allow these paths to pass through unmodified.
+  Ajax.exclude_paths %w[ /login /logout /signup /altnet-pro /my-account/edit /user-session/new /facebook_signup /facebook_login /facebook_link_account /health_check /reset-password/new]
+  Ajax.exclude_paths [%r[\/my-account\/.*]]
+  Ajax.exclude_paths [%r[\/admin.*]]
+  Ajax.exclude_paths [%r[\/newrelic.*]]
+
 == Ajax Layouts
 
 Typically AJAX content does not render a layout because we just want to update a fragment of a page.  Automatically turning off layouts when rendering AJAX is one option, but what about when we do want to use a layout?
 
-My solution is to first look in <tt>app/views/layouts/ajax/</tt> for a layout with the same name as the default layout for the current action.  If a layout is found, we use it, otherwise the default layout is used.
+Ajax looks for an alternative layout to use with AJAX requests in <tt>app/views/layouts/ajax/</tt>.  If a layout is found, we use it, otherwise the default layout is used. Copy existing layouts into this directory and get them ready for AJAX by removing any HTML HEAD elements, everything but the inner BODY content.
+
+Your main layout should contain a container element that will receive page content.  Typically this would be the container below the page header.  If you don't have a static header, you can make the whole BODY element the container.
+
+In your Ajax layouts you can define callbacks, tabs to activate or the container to receive content. Using the <tt>ajax_header</tt> method:
 
-In your Ajax layouts you can define callbacks, tabs to activate or the container to receive content.
+  # layouts/ajax/two_column.html.haml
+  ajax_header :container, '#column2'
 
-For example, our layouts:
+Our layouts:
 
   layouts/
     _assets.html.haml
@@ -203,9 +228,7 @@ For example, our layouts:
     single_column.html.haml
     two_column.html.haml
 
-Gists
-* {ajax/application.html.haml}[http://gist.github.com/373133#file_application.html.haml]
-* {ajax/two_column.html.haml}[http://gist.github.com/373133#file_two_column.html.haml]
+{Converting our <tt>layouts/application.html.haml</tt> to <tt>layouts/ajax/application.html.haml</tt>}[http://gist.github.com/373133/5a80a63ef69a883ed3c5630b68330b1036ad01ec].
 
 == Link Handling
 

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.1.6

data/app/views/ajax/_redirect_with_fragment.html.erb

@@ -0,0 +1,19 @@
+<%# Locals: url %>
+<script type="text/javascript">
+  var url = <%= url.to_json %>;
+  var hash = document.location.hash;
+
+  // Remove leading # from the fragment
+  if (hash.charAt(0) == '#') {
+    hash = hash.substr(1);
+  }
+
+  // Remove leading / from the fragment if the URL already ends in a /
+  // This prevents double-slashes.  Note we can't just replace all
+  // double-slashes because the protocol includes //.
+  if (url.charAt(url.length - 1) == '/' && hash.charAt(0) == '/') {
+    hash = hash.substr(1);
+  }
+
+  document.location.href = url + hash;
+</script>

data/lib/ajax/action_controller.rb

@@ -2,6 +2,8 @@ module Ajax
   module ActionController
     def self.included(klass)
       klass.class_eval do
+        include ClassMethods
+
         alias_method_chain :render, :ajax
         alias_method_chain :redirect_to_full_url, :ajax
 
@@ -26,7 +28,7 @@ module Ajax
         key, value = args.shift, args.shift
         value = block_given? ? Proc.new : value
 
-        prepend_after_filter(options) do |controller|
+        (self.is_a?(Class) ? self : self.class).prepend_after_filter(options) do |controller|
           if controller.request.xhr?
             value = value.is_a?(Proc) ? controller.instance_eval(&value) : value
             Ajax.set_header(controller.response, key, value)
@@ -63,15 +65,30 @@ module Ajax
         return redirect_to_full_url_without_ajax(url, status) unless Ajax.is_enabled?
         raise DoubleRenderError if performed?
 
+        special_redirect = false
         original_url = url
+
+        # If we have the full referrer in Ajax-Info, use that because it
+        # includes the fragment.
         if url == request.headers["Referer"] && !request.headers['Ajax-Info'].blank?
           url = request.headers['Ajax-Info']['referer']
           Ajax.logger.debug("[ajax] using referer #{url} from Ajax-Info")
         end
 
         if !Ajax.exclude_path?(url)
+          # Never redirect to the Ajax framework path, redirect to /
           if url =~ %r[#{Ajax.framework_path}]
             url = url.sub(%r[#{Ajax.framework_path}], '/')
+
+            # Special case:
+            #
+            # Changing protocol forces a redirect from root to root.
+            # The full request URL (including the hashed part) is
+            # in the browser.  So return JS to do the redirect and
+            # have it include the hashed part in the redirect URL.
+            if !request.xhr? && URI.parse(url).scheme != URI.parse(request.url).scheme
+              special_redirect = true
+            end
           end
 
           if !Ajax.is_hashed_url?(url)
@@ -80,11 +97,20 @@ module Ajax
         end
         Ajax.logger.info("[ajax] rewrote redirect from #{original_url} to #{url}")
 
-        session[:redirected_to] = url
-        if request.xhr?
-          render(:update) { |page| page.redirect_to(url) }
+        # Don't store session[:redirected_to] if doing a special redirect otherwise
+        # when the next request for root comes in it will think we really want
+        # to display the home page.
+        if special_redirect
+          session[:redirected_to] = nil
+          Ajax.logger.info("[ajax] returning special redirect JS")
+          render :partial => '/ajax/redirect_with_fragment', :locals => { :url => url }
         else
-          redirect_to_full_url_without_ajax(url, status)
+          session[:redirected_to] = url
+          if request.xhr?
+            render(:update) { |page| page.redirect_to(url) }
+          else
+            redirect_to_full_url_without_ajax(url, status)
+          end
         end
       end
 

data/lib/ajax/action_view.rb

@@ -38,13 +38,21 @@ module Ajax
 
           # Insert the deep link unless the URL is traditional
           if !html_options.has_key?('data-deep-link') && !html_options.delete('traditional')
-            path = url_for(options)
+            case options
+            when Hash
+              options[:only_path] = true
+              path = url_for(options)
+            else
+              path = url_for(options)
 
-            # Is this path to be excluded?
-            unless Ajax.exclude_path?(path)
-              if path.match(%r[^(http:\/\/[^\/]*)(\/?.*)])
-                path = $2
+              # Strip out the protocol and host from the URL
+              if path =~ %r[#{root_url}]
+                path.sub!(%r[#{root_url}], '/')
               end
+            end
+
+            # Don't store a data-deep-link attribute if the path is excluded
+            unless Ajax.exclude_path?(path)
               html_options['data-deep-link'] = path
             end
           end

data/lib/ajax/helpers/url_helper.rb

@@ -36,7 +36,7 @@ module Ajax
       protected
 
       def encode_and_parse_url(url)
-        URI.parse(URI.encode(url).gsub("%23", "#"))
+        URI.parse(URI.encode(url).gsub("%23", "#")) rescue URI.parse('/')
       end
 
       def url_host(url)

data/tasks/ajax_tasks.rake

@@ -8,6 +8,33 @@ namespace :ajax do
     INSTALL_FILES.map do |file|
       show_result(file) { |file| copy_unless_exists(file) }
     end
+    puts <<-END
+\nWelcome to Ajax!
+
+1. Ajax looks for an alternative layout to use with AJAX requests in
+<tt>app/views/layouts/ajax/</tt>. Copy existing layouts into this directory and get them
+ready for AJAX by removing any HTML HEAD elements, everything but the inner BODY content.
+
+ Your main layout should contain a container element that will receive page content.
+Typically this would be the container below the page header. If you don't have a static
+header, you can make the whole BODY element the container.
+
+ Here is an example of converting our layouts/application.html.haml to
+layouts/ajax/application.html.haml:
+http://gist.github.com/373133/5a80a63ef69a883ed3c5630b68330b1036ad01ec.
+
+2. Instantiate an instance of the Ajax class in public/javascripts/application.js. For
+example:
+
+  // public/javascripts/application.js
+  if (typeof(Ajax) != 'undefined') {
+    window.ajax = new Ajax({
+      default_container: '#main',  // jQuery selector of your container element
+      enabled: true,               // Enable/disable the plugin
+      lazy_load_assets: false      // YMMV
+    });
+  }
+END
   end
 
   namespace :install do

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 5
-  version: 0.1.5
+  - 6
+  version: 0.1.6
 platform: ruby
 authors: 
 - Karl Varga
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-27 00:00:00 -07:00
+date: 2010-05-13 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,6 +43,7 @@ files:
 - Rakefile
 - VERSION
 - app/controllers/ajax_controller.rb
+- app/views/ajax/_redirect_with_fragment.html.erb
 - app/views/ajax/framework.html.erb
 - config/initializers/ajax.rb
 - lib/ajax.rb