ajaxify_rails 0.0.8 → 0.0.9

data/README.md

@@ -2,22 +2,24 @@
 
 No more full page reloads for your Rails app! Yay! 
 
-Automatically makes your app loading content in the background via ajax.
+Automatically makes your app loading content in the background via Ajax.
 
-Works by turning all internal links into ajax links that trigger an update of the page's content area. 
-Also form submissions are automatically turned into ajax requests.
+Works by turning all internal links into Ajax links that trigger an update of the page's content area. 
+Also form submissions are automatically turned into Ajax requests.
 
 Features: 
 
-- Uses the html5 history interface for changing the url and making the browser's back and forward buttons work with ajax.
-- Falls back to a hash based approach for browsers without the history interface (like Internet Explorer version <10)
+- Uses the html5 history interface for changing the url and making the browser's back and forward buttons work with Ajax.
+- 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.
-- Tested with Chrome, Firefox, Safari and Internet Explorer 8+
+- Tested with Chrome, Firefox, Safari and Internet Explorer 8+.
 
-Demo: http://ajaxify-demo.herokuapp.com/
+Demo: http://ajaxify-demo.herokuapp.com/ (the first page load might take a while, as heroku needs to spin up a dyno)
 
-Inspired by the pjax_rails gem (https://github.com/rails/pjax_rails)
+Blog Post: http://rubyandrails.posterous.com/introducing-the-ajaxify-rails-gem
+
+Inspired by the pjax_rails gem (https://github.com/rails/pjax_rails).
 
 ## Requirements
 
@@ -64,16 +66,16 @@ You can change the content wrapper in your javascript by setting
     
 ### Loader Animation
 
-You probably like to have a loader image to be displayed to the user while content loads via ajax.
+You probably like to have a loader image to be displayed to the user while content loads via Ajax.
 This is simple. Ajaxify automatically inserts a loader div with the class `ajaxify_loader` into
-the content wrapper before starting an ajax request. So just supply styles for `.ajaxify_loader` in your css, with an
+the content wrapper before starting an Ajax request. So just supply styles for `.ajaxify_loader` in your css, with an
 animated gif as a background.
     
 
 ### Page Title
 
-If you define a method called `page_title` in your application controller, Ajaxify will automatically
-update the page's title tag after the main content has changed.
+If you define a method called `page_title` in your application controller, returning the current page's title, Ajaxify will
+use it to automatically update the title tag after the main content has changed.
 
 ### Navigation and other Layout Updates
 
@@ -87,24 +89,24 @@ updates of the page's main content. Just hook into it in your javascript and mak
 
 ### Flash Messages
 
-Ajaxify Rails correctly displays your flash messages after ajaxified requests. To do so it stores them in cookies.
+Ajaxify correctly displays your flash messages after ajaxified requests.
 By default, only `flash[:notice]` is supported. If you are using for example `flash[:warning]` as well you have to set:
 
     Ajaxify.flash_types = ['notice', 'warning']
     
-Also make sure that you supply invisible wrapper tags in your layout with the flash type as its id, e.g.:
+Also make sure that you supply invisible wrapper tags in your layout for each flash type you use, with the id set to the type, e.g.:
 
     #notice{ style: "#{'display:none' unless flash[:notice]}" }
       = flash[:notice] 
     
-### Links that need to trigger full Page Reloads
+### Links or Forms that need to trigger full Page Reloads
 
-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.
+Sometimes requests change the layout of the page so significantly that loading only the main content via Ajax
+and doing some minor layout tweaks here and there are simply not sufficient.
 
-There might also be links and forms which already have 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:
+For these cases you can turn off Ajaxify, by simply adding the class `no_ajaxify` directly to links or forms:
 
     = link_to 'Change everything!', re_render_it_all_path, class: 'no_ajaxify'
 
@@ -156,7 +158,7 @@ Here is a reference of all options and callbacks you can set on the client side
 
     Option/Callback        Default      Description
 
-    active                 true         Toggles link ajaxification.
+    active                 true         Switches Ajaxify on or off. Needs to be set before Ajaxify.init() is called.
     content_container     'main'        Id of the container to insert the main content into ("yield wrapper").
     base_paths             null         Base path segments for applications with root url redirects.
 

data/lib/ajaxify_rails.rb

@@ -1,4 +1,5 @@
 require "ajaxify_rails/version"
+require "ajaxify_rails/action_controller_additions"
 
 module AjaxifyRails
 
@@ -11,74 +12,4 @@ module AjaxifyRails
     include ActionControllerAdditions
   end
 
-  module ActionControllerAdditions
-
-    def self.included(controller)
-      controller.class_eval do
-
-        private
-
-        def ajaxified?
-          request.xhr? and params[:ajaxified]
-        end
-
-
-        def render *args, &block
-          if ajaxified?
-            args = _normalize_args(*args, &block)
-            layout = args[:layout] || current_layout
-            layout = (layout == 'application' or layout == true) ? false : layout
-            args[:layout] = layout
-
-            flash.keys.each do |key|
-              cookies["flash_#{key}"] = flash[key]
-              flash[key] = nil
-            end
-
-            extra_content = (respond_to?(:ajaxify_extra_content) ? ajaxify_extra_content : '')
-
-            super args
-
-            # Store current path for redirect url changes. Also used to remove the ajaxify parameter that gets added to some auto generated urls
-            # like e.g. pagination links see (ajaxify.js -> on_ajaxify_success())
-            #
-            current_url_tag = view_context.content_tag(:span, request.fullpath.sub(/\?ajaxified=true&(.*)/, '?\1').sub(/(&|\?)ajaxified=true/, ''),
-                                                       id: 'ajaxify_location')
-
-            response_body[0] += view_context.content_tag(:div, current_url_tag + extra_content,
-                                                         id: 'ajaxify_content', style: 'display:none',
-                                                         data: { page_title: respond_to?(:page_title) ? page_title : nil })
-            response.body = self.response_body[0]
-            return
-          end
-          super
-        end
-
-
-        def current_layout
-          return @current_layout if @current_layout
-          @current_layout = _layout
-          @current_layout = File.basename(@current_layout.identifier).split('.').first unless @current_layout.instance_of? String
-          @current_layout
-        end
-
-
-        def redirect_to(options = {}, response_status = {})
-          request.referer.sub!('#/', '') if request.referer  # make redirect to back work for browsers without history api
-
-          super
-
-          ajaxify_params = "ajaxified=true&ajaxify_redirect=true"
-          self.location += "#{self.location =~ /\?/ ? '&' : '?'}#{ajaxify_params}" if request.xhr?  # to avoid the full layout from being rendered
-        end
-
-
-        def ajaxify_redirect_to url
-          render inline: "<%= javascript_tag(\"Ajaxify.load({url: '#{url}'});\") %>", layout: true
-        end
-      end
-
-    end
-  end
-
 end

data/lib/ajaxify_rails/action_controller_additions.rb

@@ -0,0 +1,83 @@
+module ActionControllerAdditions
+
+  def self.included(controller)
+    controller.class_eval do
+
+      # override in your controller
+      def page_title
+        nil
+      end
+
+      # override in your controller
+      def ajaxify_extra_content
+        ''
+      end
+
+
+      private
+
+      def ajaxified?
+        request.xhr? and params[:ajaxified]
+      end
+
+
+      def render *args, &block
+        if ajaxified?
+          args = _normalize_args(*args, &block)
+          layout = args[:layout] || current_layout
+          layout = (layout == 'application' or layout == true) ? false : layout
+          args[:layout] = layout
+
+          flashes = {}
+          flash.keys.each do |key|
+            flashes[key] = flash[key]
+            flash[key] = nil
+          end
+
+
+          extra_content = ajaxify_extra_content
+
+          super args
+
+          # Store current path for redirect url changes. Also used to remove the ajaxify parameter that gets added to some auto generated urls
+          # like e.g. pagination links see (ajaxify.js -> on_ajaxify_success())
+          #
+          current_url_tag = view_context.content_tag(:span, request.fullpath.sub(/\?ajaxified=true&(.*)/, '?\1').sub(/(&|\?)ajaxified=true/, ''),
+                                                     id: 'ajaxify_location')
+
+          response_body[0] += view_context.content_tag(:div, current_url_tag + extra_content,
+                                                       id: 'ajaxify_content', style: 'display:none',
+                                                       data: { page_title: page_title,
+                                                               flashes: flashes.to_json } )
+          response.body = self.response_body[0]
+          return
+        end
+        super
+      end
+
+
+      def current_layout
+        return @current_layout if @current_layout
+        @current_layout = _layout
+        @current_layout = File.basename(@current_layout.identifier).split('.').first unless @current_layout.instance_of? String
+        @current_layout
+      end
+
+
+      def redirect_to(options = {}, response_status = {})
+        request.referer.sub!('#/', '') if request.referer  # make redirect to back work for browsers without history api
+
+        super
+
+        ajaxify_params = "ajaxified=true&ajaxify_redirect=true"
+        self.location += "#{self.location =~ /\?/ ? '&' : '?'}#{ajaxify_params}" if request.xhr?  # to avoid the full layout from being rendered
+      end
+
+
+      def ajaxify_redirect_to url
+        render inline: "<%= javascript_tag(\"Ajaxify.load({url: '#{url}'});\") %>", layout: true
+      end
+    end
+
+  end
+end

data/lib/ajaxify_rails/version.rb

@@ -1,3 +1,3 @@
 module AjaxifyRails
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/vendor/assets/javascripts/{ajaxify_rails/ajaxify_rails.js.coffee → ajaxify_rails.js.coffee}

@@ -12,7 +12,6 @@
   on_before_load: null
   on_success: null
   on_success_once: null
-  on_before_correct_url: null
 
   # flash
   #
@@ -141,13 +140,11 @@
           self.on_ajaxify_success data, status, jqXHR, pop_state, options
 
 
-  show_flash: () ->
+  show_flashes: (flashes) ->
     self = this
     $.each this.flash_types, ->
-      cookie_name = "flash_#{this}"
-      if $.cookie cookie_name
-        $("##{this}").html $.cookie(cookie_name)
-        $.cookie cookie_name, null
+      if flashes and flashes[this]
+        $("##{this}").html flashes[this]
         $("##{this}").show()
         if self.flash_effect
           if self.clear_flash_effect
@@ -162,12 +159,13 @@
     $("##{this.content_container}").html data
 
     title = $('#ajaxify_content').data('page-title')
+    flashes = $('#ajaxify_content').data('flashes')
 
     # Correct the url after a redirect and when it has the ajaxify param in it.
     # The latter can happen e.g. for pagination links that are auto generated.
-    current_url = $('#ajaxify_content #ajaxify_location').text()
+    current_url = $('#ajaxify_content #ajaxify_location').html()
     if options.url != current_url
-      options.url = current_url.replace(/(&|\?)ajaxify_redirect=true/,'')
+      options.url = current_url.replace(/(&|&|\?)ajaxify_redirect=true/,'')
       options.type = 'GET'
 
     this.update_url options, pop_state
@@ -180,7 +178,7 @@
     if title
       document.title = title.replace /&/, '&'   # Todo: need to figure out what else needs to be unescaped
 
-    this.show_flash()
+    this.show_flashes(flashes)
 
     if this.on_success
       this.on_success( data, status, jqXHR, options.url )
@@ -237,6 +235,9 @@
     if this.active
 
       if window.location.hash.indexOf('#') == 0   # if url has a '#' in it treat it as a non history interface hash based scheme url
+
+        return unless window.location.hash.match(/^#(\/|\?)/) # check hash format
+
         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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ajaxify_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-29 00:00:00.000000000 Z
+date: 2012-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -49,10 +49,9 @@ files:
 - Rakefile
 - ajaxify_rails.gemspec
 - lib/ajaxify_rails.rb
+- lib/ajaxify_rails/action_controller_additions.rb
 - lib/ajaxify_rails/version.rb
-- vendor/assets/javascripts/ajaxify_rails/ajaxify_rails.js.coffee
-- vendor/assets/javascripts/ajaxify_rails/index.js
-- vendor/assets/javascripts/ajaxify_rails/jquery_cookie.js
+- vendor/assets/javascripts/ajaxify_rails.js.coffee
 homepage: https://github.com/ncri/ajaxify_rails
 licenses: []
 post_install_message: 
@@ -67,7 +66,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3891379638515987853
+      hash: -4098210962024842492
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -76,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3891379638515987853
+      hash: -4098210962024842492
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24

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

@@ -1,2 +0,0 @@
-//= require ./jquery_cookie
-//= require ./ajaxify_rails

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

@@ -1,61 +0,0 @@
-/*jshint eqnull:true */
-/*!
- * jQuery Cookie Plugin v1.1
- * https://github.com/carhartl/jquery-cookie
- *
- * Copyright 2011, Klaus Hartl
- * Dual licensed under the MIT or GPL Version 2 licenses.
- * http://www.opensource.org/licenses/mit-license.php
- * http://www.opensource.org/licenses/GPL-2.0
- */
-(function($, document) {
-
-	var pluses = /\+/g;
-	function raw(s) {
-		return s;
-	}
-	function decoded(s) {
-		return decodeURIComponent(s.replace(pluses, ' '));
-	}
-
-	$.cookie = function(key, value, options) {
-
-		// key and at least value given, set cookie...
-		if (arguments.length > 1 && (!/Object/.test(Object.prototype.toString.call(value)) || value == null)) {
-			options = $.extend({}, $.cookie.defaults, options);
-
-			if (value == null) {
-				options.expires = -1;
-			}
-
-			if (typeof options.expires === 'number') {
-				var days = options.expires, t = options.expires = new Date();
-				t.setDate(t.getDate() + days);
-			}
-
-			value = String(value);
-
-			return (document.cookie = [
-				encodeURIComponent(key), '=', options.raw ? value : encodeURIComponent(value),
-				options.expires ? '; expires=' + options.expires.toUTCString() : '', // use expires attribute, max-age is not supported by IE
-				options.path    ? '; path=' + options.path : '',
-				options.domain  ? '; domain=' + options.domain : '',
-				options.secure  ? '; secure' : ''
-			].join(''));
-		}
-
-		// key and possibly options given, get cookie...
-		options = value || $.cookie.defaults || {};
-		var decode = options.raw ? raw : decoded;
-		var cookies = document.cookie.split('; ');
-		for (var i = 0, parts; (parts = cookies[i] && cookies[i].split('=')); i++) {
-			if (decode(parts.shift()) === key) {
-				return decode(parts.join('='));
-			}
-		}
-		return null;
-	};
-
-	$.cookie.defaults = {};
-
-})(jQuery, document);