ajax 1.1.4 → 1.1.5

data/README.rdoc

@@ -10,11 +10,12 @@ As of May 2010 Ajax is being used live in production on kazaa.com[http://www.kaz
 
 == Changelog
 
+* v1.1.5: Fix inclusion of +controller+ and +layout+ in <tt>Ajax-Info</tt> response header.  Improve RSpec 1.* integration
 * v1.1.4: Fix RSpec 2 integration
 * v1.1.3: Guard against possible nil values for the redirect_to url and the referrers
 * v1.1.2: Fix Rails 3 render hook so it doesn't break rendering with no layout e.g. <tt>render :json => ...</tt>
 * v1.1.1: Backwards compatibility fix for Rails < 3
-* v1.1.0: Rails 3 supported!
+* <b>v1.1.0: Rails 3 supported!</b>
 
 == Install
 
@@ -26,7 +27,7 @@ As of May 2010 Ajax is being used live in production on kazaa.com[http://www.kaz
 
 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:
+4. Run <tt>rake routes</tt> to verify that the <tt>/ajax/framework</tt> path is being routed correctly.  The route will automatically be added to your application but if you have catch-all routes they will take precedence, so if that is the case, you can add the route to <tt>config/routes.rb</tt> manually like so:
 
     YourAppName::Application.routes.draw do
       Ajax::Routes.draw(self)
@@ -58,11 +59,19 @@ As of May 2010 Ajax is being used live in production on kazaa.com[http://www.kaz
       Ajax::Routes.draw(map)
     end
 
+5. Run <tt>rake routes</tt> to verify that the <tt>/ajax/framework</tt> path is being routed correctly.
+
 <b> As a Plugin</b>
 
-  ./script/plugin install http://github.com/kjvarga/ajax.git
+1.  ./script/plugin install http://github.com/kjvarga/ajax.git
+2.  Run <tt>rake routes</tt> to verify that the <tt>/ajax/framework</tt> path is being routed correctly.
+
+=== Rake Tasks
 
-=== Sample Output
+  $ rake -T ajax
+  rake ajax:install            # Install required Ajax files.
+  rake ajax:install:specs      # Copy Ajax integration spec into spec/integration/ajax_spec.rb.
+  rake ajax:update:javascript  # Overwrite public/javascripts/ajax.js with the latest version.
 
   $ rake ajax:install
   created: app/controllers/ajax_controller.rb
@@ -77,8 +86,15 @@ As of May 2010 Ajax is being used live in production on kazaa.com[http://www.kaz
   $ rake ajax:install:specs
   already exists: spec/integration/ajax_spec.rb
 
+  $ rake ajax:update:javascript
+  created: public/javascripts/ajax.js
+
 == Getting Started
 
+1. Include the JavaScript assets in your <tt>app/views/layouts/application.html.erb</tt> file.  For example:
+
+    <%= javascript_include_tag 'jquery', 'jquery.address-1.3', 'ajax', 'application' %>
+
 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.
 
    Your main layout should contain a container element to receive page content.  Typically this would be a container below your page header.  If you don't have a static header, you can make the whole BODY element the container.
@@ -98,7 +114,7 @@ As of May 2010 Ajax is being used live in production on kazaa.com[http://www.kaz
 
 3. Add a <tt>data-deep-link</tt> attribute to links that you want to load using the Ajax framework.  A jQuery live event automatically intercepts all clicks on links with this attribute and loads their content using the framework.
 
-   By default all links that use the Rails link helpers will include this attribute.  When a link with this attribute is clicked, content is requested using AJAX and goes through the Ajax framework.  Rails receives a request for content at the <tt>data-deep-link</tt> location.  The content is rendered using the default layout for the action but from the <tt>app/views/layouts/ajax</tt> directory.  The rendered content is received client-side and special Ajax headers are processed.  The content is then inserted into the specified container, or the <tt>default_container</tt> defined in your Ajax JS class above.
+   By default all links that use the Rails link helpers will include this attribute, so you won't need to do anything.  When a link with this attribute is clicked, content is requested using AJAX and goes through the Ajax framework.  Rails receives a request for content at the <tt>data-deep-link</tt> location.  The content is rendered using the default layout for the action but from the <tt>app/views/layouts/ajax</tt> directory.  The rendered content is received client-side and special Ajax headers are processed.  The content is then inserted into the specified container, or the <tt>default_container</tt> defined in your Ajax JS class above.
 
 4. To submit forms using the Ajax framework, or to manually request content using various request methods, you can call <tt>window.ajax.loadPage</tt>, passing in options like _url_, _method_ and _data_.
 
@@ -451,9 +467,25 @@ To ease some of the pain, observe some of the following advice:
 
 == Testing
 
-* We use RSpec
-* See <tt>Ajax::Spec::Helpers</tt> and <tt>Ajax::Spec::Extension</tt> {in the rdocs}[http://rdoc.info/projects/kjvarga/ajax]
-* Copy <tt>ajax/spec/integration/ajax_spec.rb</tt> into your project to ensure that the Ajax integration always works.
+Ajax comes with RSpec integration tests for RSpec 1 and 2 and <tt>ActiveSupport::TestCase</tt>.  You don't have to add anything to your <tt>spec/spec_helper.rb</tt> file.  Just run the rake task to copy
+the integration spec into <tt>spec/integration/ajax_spec.rb</tt>:
+
+  rake ajax:install:specs
+
+If you want to do add your own specs, you can make use of helper methods defined
+in the <tt>Ajax::RSpec::Extension</tt> module.  To make these methods available
+to all your specs just add a require to your <tt>spec/spec_helper.rb</tt>:
+
+  # spec/spec_helper.rb
+  require 'ajax/rspec'
+
+If <tt>ajax/rspec</tt> has been required before the testing framework has
+been defined (Spec, RSpec or ActiveSupport::TestCase) the extension methods will
+not have been integrated.  In this case you can force re-integration by calling:
+
+  Ajax::RSpec.setup
+
+* See <tt>Ajax::RSpec::Helpers</tt> and <tt>Ajax::RSpec::Extension</tt> {in the rdocs}[http://rdoc.info/projects/kjvarga/ajax]
 
 == Contributions
 

data/VERSION

@@ -1 +1 @@
-1.1.4
+1.1.5

data/lib/ajax.rb

@@ -2,7 +2,6 @@ require 'rack-ajax'
 require 'ajax/helpers'
 require 'ajax/application'
 require 'ajax/routes'
-require 'ajax/rspec'
 require 'pathname'
 # require railties at the end
 

data/lib/ajax/action_controller.rb

@@ -106,14 +106,9 @@ module Ajax
           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
         render_without_ajax(options, extra_options, &block)
       end
-
     end
 
     module Rails3
@@ -145,11 +140,16 @@ module Ajax
 
     # Convert the Ajax-Info hash to JSON before the request is sent.
     # Invoked as an after filter.
+    #
+    # Adds the current +layout+ and +controller+ to the hash.
+    # These values will be sent in future requests using the Ajax-Info header.
+    #
+    # +controller+ is the result of calling ActionController#controller_name, so
+    # if your controller is ApplicationController the value will be <tt>'application'</tt>.
     def serialize_ajax_info
-      case response.headers['Ajax-Info']
-      when Hash
-        response.headers['Ajax-Info'] = response.headers['Ajax-Info'].to_json
-      end
+      Ajax.set_header(response, :layout, Ajax.app.rails?(3) ? _layout : active_layout)
+      Ajax.set_header(response, :controller, self.class.controller_name)
+      response.headers['Ajax-Info'] = Ajax.send(:serialize_hash, response.headers['Ajax-Info'])
     end
 
     # Perform special processing on the response if we need to.

data/lib/ajax/helpers/request_helper.rb

@@ -27,32 +27,25 @@ module Ajax
         headers = object.is_a?(Hash) ? object : object.headers # ::ActionController::Response
         key = key.to_s
 
-        info = case headers["Ajax-Info"]
-        when String
-          JSON.parse(headers["Ajax-Info"]) rescue {}
-        when Hash
-          headers["Ajax-Info"]
-        else
-          {}
-        end
+        headers["Ajax-Info"] = serialize_hash(headers["Ajax-Info"]) do |info|
+          # Deep merge hashes
+          if info.has_key?(key) &&
+              value.is_a?(Hash) &&
+              info[key].is_a?(Hash)
+            value = value.stringify_keys!
+            value = info[key].merge(value, &DEEP_MERGE)
+          end
 
-        # Deep merge hashes
-        if info.has_key?(key) &&
-            value.is_a?(Hash) &&
-            info[key].is_a?(Hash)
-          value = value.stringify_keys!
-          value = info[key].merge(value, &DEEP_MERGE)
-        end
+          # Concat arrays
+          if info.has_key?(key) &&
+              value.is_a?(Array) &&
+              info[key].is_a?(Array)
+            value = info[key].concat(value)
+          end
 
-        # Concat arrays
-        if info.has_key?(key) &&
-            value.is_a?(Array) &&
-            info[key].is_a?(Array)
-          value = info[key].concat(value)
+          # Set the value for this key
+          info[key] = value
         end
-
-        info[key] = value
-        headers["Ajax-Info"] = info.to_json
       end
 
       # Return the value at key <tt>key</tt> from the <tt>Ajax-Info</tt> header
@@ -62,17 +55,7 @@ module Ajax
       # <tt>key</tt> Symbol or String hash key, converted to String
       def get_header(object, key)
         headers = object.is_a?(Hash) ? object : object.headers # ::ActionController::Request
-        key = key.to_s
-
-        info = case headers["Ajax-Info"]
-        when String
-          JSON.parse(headers["Ajax-Info"]) rescue {}
-        when Hash
-          headers["Ajax-Info"]
-        else
-          {}
-        end
-        info[key]
+        unserialize_hash(headers["Ajax-Info"])[key.to_s]
       end
 
       # Set one or more paths that can be accessed directly without the AJAX framework.
@@ -111,6 +94,27 @@ module Ajax
           !!excluded.match(path)
         end)
       end
+
+      # Return JSON given a Hash or JSON string.  If a block is given, yields
+      # the Hash to the block so that the block can modify it before it is
+      # converted to JSON.
+      def serialize_hash(hash, &block)
+        info = unserialize_hash(hash)
+        yield info if block_given?
+        info.to_json
+      end
+
+      # Return a Hash given JSON or a Hash.
+      def unserialize_hash(hash)
+        case hash
+        when String
+          JSON.parse(hash) rescue {}
+        when Hash
+          hash
+        else
+          {}
+        end
+      end
     end
   end
-end
+end

data/lib/ajax/rspec.rb

@@ -1,3 +1,31 @@
 require 'ajax/rspec/extension'
 require 'ajax/rspec/helpers'
-require 'ajax/rspec/integration'
+
+# RSpec integration.  Add a before filter to disable Ajax before all tests.
+# Make the methods in Ajax::RSpec::Extension available in your example groups.
+#
+# Call <tt>Ajax::RSpec.setup</tt> to retry adding the test integration.
+# This can be useful if RSpec is not defined at the time that Ajax is initialized.
+module Ajax::RSpec
+  def self.setup
+    if defined?(::RSpec)
+      ::RSpec.configure do |c|
+        c.include(Ajax::RSpec::Extension)
+        c.before :all do
+          Ajax.enabled = false
+        end
+      end
+    elsif defined?(::Spec::Runner)
+      ::Spec::Runner.configure do |c|
+        c.include(Ajax::RSpec::Extension)
+        c.before :all do
+          Ajax.enabled = false
+        end
+      end
+    elsif defined?(ActiveSupport::TestCase)
+      ActiveSupport::TestCase.send(:include, Ajax::RSpec::Extension) unless ActiveSupport::TestCase.include?(Ajax::RSpec::Extension)
+    end
+  end
+end
+
+Ajax::RSpec.setup

data/lib/ajax/rspec/integration.rb

@@ -1,25 +0,0 @@
-# Only require integration module when extensions are included.
-# RSpec integration.  Add a before filter to disable Ajax before all tests.
-module Ajax::RSpec::Integration
-  if defined?(::RSpec)
-    ::RSpec.configure do |c|
-      c.include(Ajax::RSpec::Extension)
-      c.before :all do
-        disable_ajax
-      end
-    end
-  elsif defined?(::Spec)
-    ::Spec::Runner.configure do |c|
-      c.before :all do
-        disable_ajax
-      end
-    end
-  end
-end
-
-# ActiveSupport::TestCase integration
-module ActiveSupport
-  class TestCase
-    include Ajax::RSpec::Extension
-  end
-end

data/lib/rack-ajax.rb

@@ -27,16 +27,10 @@ module Rack
       return @app.call(env) unless ::Ajax.is_enabled?
 
       # Parse the Ajax-Info header
-      if env["HTTP_AJAX_INFO"].nil?
-        env["Ajax-Info"] = {}
-      elsif env["HTTP_AJAX_INFO"].is_a?(String)
-        env["Ajax-Info"] = (JSON.parse(env['HTTP_AJAX_INFO']) rescue {})
-      end
-
+      env["Ajax-Info"] = ::Ajax.unserialize_hash(env['HTTP_AJAX_INFO'])
       @parser = Parser.new(env)
       rack_response = @parser.instance_eval(&@decision_tree)
 
-
       # Clear the value of session[:redirected_to]
       unless env['rack.session'].nil?
         env['rack.session']['redirected_to'] = env['rack.session'][:redirected_to] = nil
@@ -69,4 +63,4 @@ module Rack
       env.to_yaml(:Encoding => :Utf8)
     end
   end
-end
+end

data/tasks/ajax_tasks.rake

@@ -40,7 +40,7 @@ END
   end
 
   namespace :install do
-    desc "Copy Ajax integration spec tests into spec/integration."
+    desc "Copy Ajax integration spec into spec/integration/ajax_spec.rb."
     task :specs do
       file = (Ajax.app.root + 'spec/integration/ajax_spec.rb').to_s
       if File.exist?(file)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ajax
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 1
   - 1
-  - 4
-  version: 1.1.4
+  - 5
+  version: 1.1.5
 platform: ruby
 authors: 
 - Karl Varga
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-06 00:00:00 -07:00
+date: 2011-05-08 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency