ajax 1.0.8 → 1.1.0

data/Gemfile

@@ -1,10 +1,12 @@
 source "http://rubygems.org"
 
-gem 'activesupport', '=2.3.11'
-gem 'actionpack', '=2.3.11', :require => 'action_controller'
+gem 'activesupport', '=3.0.4'
+gem 'actionpack', '=3.0.4', :require => 'action_controller'
 gem 'jeweler', '=1.4.0'
+gem 'ajax', :path => "./"
+
 gem 'ruby-debug', '=0.10.3'
 gem 'ruby-debug-base', '=0.10.3'
 gem 'rspec', '~>1.3.1', :require => 'spec'
+gem 'mocha', '~>0.9.10'
 gem 'test-unit', '=1.2.3'
-gem 'ajax', :path => "./"

data/Gemfile.lock

@@ -1,27 +1,51 @@
 PATH
   remote: ./
   specs:
-    ajax (1.0.7)
+    ajax (1.1.0)
+      json
+      rack
 
 GEM
   remote: http://rubygems.org/
   specs:
-    actionpack (2.3.11)
-      activesupport (= 2.3.11)
-      rack (~> 1.1.0)
-    activesupport (2.3.11)
+    abstract (1.0.0)
+    actionpack (3.0.4)
+      activemodel (= 3.0.4)
+      activesupport (= 3.0.4)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.4)
+      activesupport (= 3.0.4)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activesupport (3.0.4)
+    builder (2.1.2)
     columnize (0.3.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
     gemcutter (0.7.0)
     git (1.2.5)
     hoe (2.9.1)
       rake (>= 0.8.7)
+    i18n (0.5.0)
     jeweler (1.4.0)
       gemcutter (>= 0.1.0)
       git (>= 1.2.5)
       rubyforge (>= 2.0.0)
+    json (1.5.1)
     json_pure (1.5.1)
     linecache (0.43)
-    rack (1.1.2)
+    mocha (0.9.12)
+    rack (1.2.2)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
     rake (0.8.7)
     rspec (1.3.1)
     ruby-debug (0.10.3)
@@ -33,15 +57,17 @@ GEM
       json_pure (>= 1.1.7)
     test-unit (1.2.3)
       hoe (>= 1.5.1)
+    tzinfo (0.3.25)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  actionpack (= 2.3.11)
-  activesupport (= 2.3.11)
+  actionpack (= 3.0.4)
+  activesupport (= 3.0.4)
   ajax!
   jeweler (= 1.4.0)
+  mocha (~> 0.9.10)
   rspec (~> 1.3.1)
   ruby-debug (= 0.10.3)
   ruby-debug-base (= 0.10.3)

data/README.rdoc

@@ -8,6 +8,71 @@ The beauty of Ajax is that your Rails application only ever sees traditional req
 
 As of May 2010 Ajax is being used live in production on kazaa.com[http://www.kazaa.com].  Try it out and create some wicked playlists while you're at it!
 
+== Changelog
+
+* v1.1.0: Rails 3 supported!
+
+== Install
+
+=== Rails 3
+
+1. Add the gem to your <tt>Gemspec</tt>
+
+     gem 'ajax'
+
+2. <tt>bundle</tt>
+3. <tt>rake ajax:install</tt>
+4. The framework route will automatically be added to your application but if you have catch-all routes they will take precedence.  If that is the case, you can add the route to <tt>config/routes.rb</tt> like so:
+
+    YourAppName::Application.routes.draw do
+      Ajax::Routes.draw(self)
+    end
+
+=== Rails 2
+
+<b> As a Gem</b>
+
+1. Add the gem as a dependency in your <tt>config/environment.rb</tt>
+
+     config.gem 'ajax'
+
+2. <tt>rake gems:install</tt>
+
+3. Add to your <tt>Rakefile</tt>
+
+     begin
+       require 'ajax/tasks'
+     rescue Exception => e
+       puts "Warning, couldn't load gem tasks: #{e.message}! Skipping..."
+     end
+
+4. <tt>rake ajax:install</tt> to install required files.  This command is safe to run multiple times.  It will skip existing files.
+
+4. Add a route for the framework path to your <tt>config/routes.rb</tt>
+
+    ActionController::Routing::Routes.draw do |map|
+      Ajax::Routes.draw(map)
+    end
+
+<b> As a Plugin</b>
+
+  ./script/plugin install http://github.com/kjvarga/ajax.git
+
+=== Sample Output
+
+  $ rake ajax:install
+  created: app/controllers/ajax_controller.rb
+  created: app/views/ajax/framework.html.erb
+  created: config/initializers/ajax.rb
+  created: public/javascripts/ajax.js
+  created: public/javascripts/jquery.address-1.3.js
+  created: public/javascripts/jquery.address-1.3.min.js
+  created: public/javascripts/jquery.json-2.2.min.js
+  created: public/images/ajax-loading.gif
+
+  $ rake ajax:install:specs
+  already exists: spec/integration/ajax_spec.rb
+
 == Getting Started
 
 1. Ajax looks for a layout to use for an Ajax request in <tt>app/views/layouts/ajax/</tt>.  It looks for a layout with the same name as the default Rails layout for that action.  So copy your existing layouts into <tt>layouts/ajax/</tt> and get them ready for Ajax by removing any excess HTML, leaving just the content that will be inserted into the container.
@@ -66,62 +131,10 @@ As of May 2010 Ajax is being used live in production on kazaa.com[http://www.kaz
 7. Specify paths that should bypass the Ajax framework.  I.e. accessing these paths using a full URL (not a hashed URL), will render the page like in a traditional Rails app.  If that path was not excepted the Ajax framework would have forced a redirect to the hashed version of the URL before rendering the page contents using Ajax.  See <i>Excepted Links</i>.
 
    For example:
-   
+
       # config/initializers/ajax.rb
       Ajax.exclude_paths %w[ /login /logout /signup ]
 
-== Install
-
-=== Rails 3 (untested)
-
-1. Add the gem to your <tt>Gemspec</tt>
-
-     gem 'ajax'
-
-2. <tt>bundle install</tt>
-3. <tt>rake ajax:install</tt>
-
-=== Rails 2.x.x
-
-<b> As a Gem</b>
-
-1. Add the gem as a dependency in your <tt>config/environment.rb</tt>
-
-     config.gem 'ajax'
-
-2. <tt>rake gems:install</tt>
-
-3. Add to your <tt>Rakefile</tt>
-
-     begin
-       require 'ajax/tasks'
-     rescue Exception => e
-       puts "Warning, couldn't load gem tasks: #{e.message}! Skipping..."
-     end
-
-4. <tt>rake ajax:install</tt> to install required files.  This command is safe to run multiple times.  It will skip existing files.
-
-<b> As a Plugin</b>
-
-  ./script/plugin install http://github.com/kjvarga/ajax.git
-
-=== Sample Output
-
-  $ rake ajax:install
-  created: app/controllers/ajax_controller.rb
-  created: app/views/ajax/framework.html.erb
-  created: config/initializers/ajax.rb
-  created: public/javascripts/ajax.js
-  created: public/javascripts/jquery.address-1.2rc.js
-  created: public/javascripts/jquery.address-1.2rc.min.js
-  created: public/javascripts/jquery.json-2.2.min.js
-  created: public/images/ajax-loading.gif
-
-  $ rake ajax:install
-  skipped: app/controllers/ajax_controller.rb exists!
-  skipped: app/views/ajax/framework.html.erb exists!
-  ...
-
 == Introduction
 
 === Features and Support
@@ -188,28 +201,28 @@ If you need to expose external APIs you can do so using a regular expression tha
 
 == Compatibility
 
-You must be running <b>jQuery 1.4.2</b> to use this plugin.  Sorry, Prototype users.
+You must be running <b>jQuery >= 1.4.2</b> to use this plugin.  Sorry, Prototype users.
 
 The following JavaScript libraries are required and included in the plugin:
 
-* {jQuery Address 1.2RC}[http://www.asual.com/jquery/address/]
+* {jQuery Address 1.3}[http://www.asual.com/jquery/address/]
 * jQuery JSON 2.2
 
 === Ruby and Rails:
 
-  * Rails 2.3.4 running Ruby 1.8.7 and Ruby 1.9
-  * Rails 2.3.5 running Ruby 1.8.7 and Ruby 1.9
+* Rails 2.3.4, 2.3.5, 3.0.5, 3.0.7
+* Ruby 1.8.7, 1.9.1, 1.9.2
 
 === Browsers:
 
 (See {jQuery address supported browsers}[http://www.asual.com/jquery/address/docs/].)
 
-  * Internet Explorer 6.0+
-  * Mozilla Firefox 1.0+
-  * Safari 1.3+
-  * Opera 9.5+
-  * Chrome 1.0+
-  * Camino 1.0+
+* Internet Explorer 6.0+
+* Mozilla Firefox 1.0+
+* Safari 1.3+
+* Opera 9.5+
+* Chrome 1.0+
+* Camino 1.0+
 
 = Documentation
 

data/Rakefile

@@ -10,9 +10,11 @@ begin
     gem.email = "kjvarga@gmail.com"
     gem.homepage = "http://github.com/kjvarga/ajax"
     gem.authors = ["Karl Varga"]
-    gem.files =  FileList["[A-Z]*", "{app,config,lib,public,rails,spec,tasks}/**/*"]
+    gem.files =  FileList["[A-Z]*", "init.rb", "{app,config,lib,public,rails,tasks}/**/*"] - FileList['spec/rails*/**/*']
     gem.test_files = []
     gem.add_development_dependency "rspec"
+    gem.add_dependency "json"
+    gem.add_dependency "rack"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-1.0.8
+1.1.0

data/app/controllers/ajax_controller.rb

@@ -1,6 +1,12 @@
 class AjaxController < ApplicationController
   after_filter :clear_return_to
 
+  def framework
+    render
+  end
+  
+  private
+  
   # Don't return to the framework path, return to root
   def clear_return_to
     return unless Ajax.is_enabled?

data/init.rb

@@ -0,0 +1,6 @@
+begin
+  require File.expand_path('../lib/ajax', __FILE__) # From here
+rescue LoadError
+  require 'ajax' # from gem
+end
+Ajax.app.init

data/lib/ajax.rb

@@ -1,15 +1,22 @@
+require 'rack-ajax'
 require 'ajax/helpers'
+require 'ajax/application'
+require 'ajax/routes'
+require 'ajax/rspec'
+require 'pathname'
+# require railties at the end
 
 module Ajax
   include Ajax::Helpers
 
   class << self
+    attr_accessor :app
     attr_writer :logger, :framework_path
   end
 
   # Return the full path to the root of the Ajax plugin/gem directory.
   def self.root
-    @root ||= File.expand_path(File.join(File.dirname(__FILE__), '..'))
+    @root ||= Pathname.new(File.expand_path('../../', __FILE__))
   end
 
   # Return a logger instance.
@@ -88,29 +95,11 @@ module Ajax
     @mocked = !!value
   end
 
-  # Installs Ajax for Rails.
-  #
-  # This method is called by <tt>init.rb</tt>, which is run by Rails on startup.
-  #
-  # Customize rendering.  Include custom headers and don't render the layout for AJAX.
-  # Insert the Rack::Ajax middleware to rewrite and handle requests.
-  # Add custom attributes to outgoing links.
-  def self.install_for_rails
-    if defined?(Rails)
-      Ajax.logger = Rails.logger
-
-      # Customize rendering.  Include custom headers and don't render the layout for AJAX.
-      ::ActionController::Base.send(:include, Ajax::ActionController)
-
-      # Insert the Rack::Ajax middleware to rewrite and handle requests
-      ::ActionController::Dispatcher.middleware.insert_before(Rack::Head, Rack::Ajax)
-
-      # Add custom attributes to outgoing links
-      ::ActionView::Base.send(:include, Ajax::ActionView)
-    end
-  end
-
   def self.version
     @version ||= File.read(File.join(File.dirname(__FILE__), '..', 'VERSION')).strip
   end
-end
+
+  self.app = Ajax::Application.new
+end
+
+require 'ajax/railtie' if Ajax.app.rails?(3)

data/lib/ajax/action_controller.rb

@@ -2,17 +2,14 @@ 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
-
-        append_after_filter :process_response_headers
+        extend MirrorMethods
+        include MirrorMethods
+        after_filter :serialize_ajax_info
+        include InstanceMethods
       end
-      klass.extend(ClassMethods)
     end
 
-    module ClassMethods
+    module MirrorMethods
 
       # Set a custom response header if the request is AJAX.
       #
@@ -46,13 +43,23 @@ module Ajax
       end
     end
 
-    protected
+    module InstanceMethods
+      protected
+
+      if Ajax.app.rails?(3)
+        # Rails 3 hook.  Rails < 3 is handled using redirect_to_full_url.  See
+        # those docs for info.
+        def redirect_to(url={}, status={})
+          super
+          self.location = nil if _ajax_redirect(url, status) # clear any location set by super
+        end
+      end
 
       # Redirect to hashed URLs unless the path is excepted.
       #
       # Store the URL that we are redirecting to in the session.
       # If we then have a request for the root URL we know
-      # to render this URL into it.
+      # to render this URL instead.
       #
       # If redirecting back to the referer, use the referer
       # in the Ajax-Info header because it includes the
@@ -61,9 +68,17 @@ module Ajax
       #
       # For AJAX requests, respond with an AJAX-suitable
       # redirect.
-      def redirect_to_full_url_with_ajax(url, status)
-        return redirect_to_full_url_without_ajax(url, status) unless Ajax.is_enabled?
-        raise DoubleRenderError if performed?
+      #
+      # This method only applies to Rails < 3
+      def redirect_to_full_url(url, status)
+        super unless _ajax_redirect(url, status) # Only call super if we didn't handle it
+      end
+
+      # Perform special processing on the response if we need to.
+      # Return true if an Ajax "redirect" was performed, and false
+      # otherwise.
+      def _ajax_redirect(url, status)
+        return false unless Ajax.is_enabled?
 
         special_redirect = false
         original_url = url
@@ -103,7 +118,26 @@ module Ajax
         if special_redirect
           session[:redirected_to] = nil
           Ajax.logger.info("[ajax] returning special redirect JS")
-          render :partial => '/ajax/redirect_with_fragment', :locals => { :url => url }
+          self.response_body = <<END
+<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>
+END
         else
           session[:redirected_to] = url
           if request.xhr? && Ajax.is_hashed_url?(url)
@@ -111,20 +145,22 @@ module Ajax
             redirect_path = URI.parse(url).select(:fragment).first
             Ajax.logger.info("[ajax] redirect path is #{redirect_path}")
             Ajax.set_header(response, :soft_redirect, redirect_path)
-            render :text => <<-END
-              <script type="text/javascript">
-                window.location.href = #{url.to_json};
-              </script>
-            END
+            self.response_body = <<END
+<script type="text/javascript">
+  window.location.href = #{url.to_json};
+</script>
+END
           else
             Ajax.logger.info("[ajax] not detecting we are xhr. Hard redirect!")
-            redirect_to_full_url_without_ajax(url, status)
+            return false
           end
         end
+        true
       end
 
       # Convert the Ajax-Info hash to JSON before the request is sent.
-      def process_response_headers
+      # Invoked as an after filter.
+      def serialize_ajax_info
         case response.headers['Ajax-Info']
         when Hash
           response.headers['Ajax-Info'] = response.headers['Ajax-Info'].to_json
@@ -134,63 +170,82 @@ module Ajax
       #
       # Intercept rendering to customize the headers and layout handling
       #
-      def render_with_ajax(options = nil, extra_options = {}, &block)
-        return render_without_ajax(options, extra_options, &block) unless Ajax.is_enabled?
-
-        original_args = [options, extra_options]
-        if request.xhr?
-
-          # Options processing taken from ActionController::Base#render
-          if options.nil?
-            options = { :template => default_template, :layout => true }
-          elsif options == :update
-            options = extra_options.merge({ :update => true })
-          elsif options.is_a?(String) || options.is_a?(Symbol)
-            case options.to_s.index('/')
-            when 0
-              extra_options[:file] = options
-            when nil
-              extra_options[:action] = options
-            else
-              extra_options[:template] = options
+      if !Ajax.app.rails?(3)
+        def render(options = nil, extra_options = {}, &block)
+          return super unless Ajax.is_enabled?
+
+          original_args = [options, extra_options]
+          if request.xhr?
+
+            # Options processing taken from ActionController::Base#render
+            if options.nil?
+              options = { :template => default_template, :layout => true }
+            elsif options == :update
+              options = extra_options.merge({ :update => true })
+            elsif options.is_a?(String) || options.is_a?(Symbol)
+              case options.to_s.index('/')
+              when 0
+                extra_options[:file] = options
+              when nil
+                extra_options[:action] = options
+              else
+                extra_options[:template] = options
+              end
+              options = extra_options
+            elsif !options.is_a?(Hash)
+              extra_options[:partial] = options
+              options = extra_options
             end
-            options = extra_options
-          elsif !options.is_a?(Hash)
-            extra_options[:partial] = options
-            options = extra_options
+
+            default = pick_layout(options)
+            default = default.path_without_format_and_extension unless default.nil?
+            ajax_layout = _layout_for_ajax(default)
+            ajax_layout = ajax_layout.path_without_format_and_extension unless ajax_layout.nil?
+            options[:layout] = ajax_layout unless ajax_layout.nil?
+
+            # Send the current layout and controller in a custom response header
+            Ajax.set_header(response, :layout, ajax_layout)
+            Ajax.set_header(response, :controller, self.class.controller_name)
           end
+          super(options, extra_options, &block)
+        end
+      else
+        def render_to_body(options = {})
+          return super if !request.xhr? || !Ajax.is_enabled?
+          _process_options(options)
 
-          default = pick_layout(options)
-          default = default.path_without_format_and_extension unless default.nil?
-          ajax_layout = layout_for_ajax(default)
-          ajax_layout = ajax_layout.path_without_format_and_extension unless ajax_layout.nil?
-          options[:layout] = ajax_layout unless ajax_layout.nil?
+          if ajax_layout = _layout_for_ajax(options[:layout])
+            options[:layout] = ajax_layout.virtual_path
+          end
 
           # Send the current layout and controller in a custom response header
-          Ajax.set_header(response, :layout, ajax_layout)
+          Ajax.set_header(response, :layout, options[:layout])
           Ajax.set_header(response, :controller, self.class.controller_name)
+
+          _render_template(options)
         end
-        render_without_ajax(options, extra_options, &block)
       end
 
-      # Return the layout to use for an AJAX request, or the default layout if one
-      # cannot be found.  If no default is known, <tt>layouts/ajax/application</tt> is used.
+      # Return the layout to use for an AJAX request, or nil if the default should be used.
       #
       # If no ajax_layout is set, look for the default layout in <tt>layouts/ajax</tt>.
       # If the layout cannot be found, use the default.
-      #
-      # FIXME: Use hard-coded html layout extension because <tt>default_template_format</tt>
-      # is sometimes :js which means the layout isn't found.
-      def layout_for_ajax(default) #:nodoc:
+      def _layout_for_ajax(default) #:nodoc:
         ajax_layout = self.class.read_inheritable_attribute(:ajax_layout)
-        if ajax_layout.nil? || !(ajax_layout =~ /^layouts\/ajax/)
-          find_layout("layouts/ajax/#{default.sub(/layouts(\/)?/, '')}", 'html') unless default.nil?
-        else
-          ajax_layout
-        end
+        ajax_layout = if ajax_layout.nil? && default.nil?
+            nil
+          elsif ajax_layout.nil? && !default.nil? # look for one with the default name in layouts/ajax
+            "layouts/ajax/#{default.sub(/layouts(\/)?/, '')}"
+          elsif ajax_layout && !(ajax_layout =~ /^layouts\/ajax/) # look for it in layouts/ajax
+            "layouts/ajax/#{ajax_layout}"
+          else # look as is
+            ajax_layout
+          end
+        Ajax.app.rails?(3) ? find_template(ajax_layout) : find_layout(ajax_layout, 'html') if !ajax_layout.nil?
       rescue ::ActionView::MissingTemplate
-        Ajax.logger.info("[ajax] no layout found in layouts/ajax using #{default}")
-        default
+        Ajax.logger.info("[ajax] no layout found in layouts/ajax.  Using #{default}.")
+        nil
       end
+    end
   end
-end
+end