Refactor ActionController::TestCase cookies

Assigning cookies for test cases should now use cookies[], e.g:

  cookies[:email] = 'user@example.com'
  get :index
  assert_equal 'user@example.com', cookies[:email]

To clear the cookies, use clear, e.g:

  cookies.clear
  get :index
  assert_nil cookies[:email]

We now no longer write out HTTP_COOKIE and the cookie jar is
persistent between requests so if you need to manipulate the environment
for your test you need to do it before the cookie jar is created.

4 files changed, 19 insertions, 39 deletions

diff --git a/actionpack/lib/action_controller/test_case.rb b/actionpack/lib/action_controller/test_case.rb
index bfb820fcdf..6d85846eb3 100644
--- a/actionpack/lib/action_controller/test_case.rb
+++ b/actionpack/lib/action_controller/test_case.rb
@@ -175,10 +175,6 @@ module ActionController
     end
 
     def recycle!
-      write_cookies!
-      @env.delete('HTTP_COOKIE') if @cookies.blank?
-      @env.delete('action_dispatch.cookies')
-      @cookies = nil
       @formats = nil
       @env.delete_if { |k, v| k =~ /^(action_dispatch|rack)\.request/ }
       @env.delete_if { |k, v| k =~ /^action_dispatch\.rescue/ }
@@ -186,6 +182,7 @@ module ActionController
       @method = @request_method = nil
       @fullpath = @ip = @remote_ip = nil
       @env['action_dispatch.request.query_parameters'] = {}
+      cookie_jar.reset!
     end
   end
 
@@ -301,18 +298,17 @@ module ActionController
   # For redirects within the same controller, you can even call follow_redirect and the redirect will be followed, triggering another
   # action call which can then be asserted against.
   #
-  # == Manipulating the request collections
+  # == Manipulating session and cookie variables
   #
-  # The collections described above link to the response, so you can test if what the actions were expected to do happened. But
-  # sometimes you also want to manipulate these collections in the incoming request. This is really only relevant for sessions
-  # and cookies, though. For sessions, you just do:
+  # Sometimes you need to set up the session and cookie variables for a test.
+  # To do this just assign a value to the session or cookie collection:
   #
-  #   @request.session[:key] = "value"
-  #   @request.cookies[:key] = "value"
+  #   session[:key] = "value"
+  #   cookies[:key] = "value"
   #
-  # To clear the cookies for a test just clear the request's cookies hash:
+  # To clear the cookies for a test just clear the cookie collection:
   #
-  #   @request.cookies.clear
+  #   cookies.clear
   #
   # == \Testing named routes
   #
@@ -450,7 +446,6 @@ module ActionController
         @controller.process_with_new_base_test(@request, @response)
         @assigns = @controller.respond_to?(:view_assigns) ? @controller.view_assigns : {}
         @request.session.delete('flash') if @request.session['flash'].blank?
-        @request.cookies.merge!(@response.cookies)
         @response
       end
 
diff --git a/actionpack/lib/action_dispatch/middleware/cookies.rb b/actionpack/lib/action_dispatch/middleware/cookies.rb
index 47c4bad489..c4a83fc8cb 100644
--- a/actionpack/lib/action_dispatch/middleware/cookies.rb
+++ b/actionpack/lib/action_dispatch/middleware/cookies.rb
@@ -185,6 +185,11 @@ module ActionDispatch
         value
       end
 
+      # Removes all cookies on the client machine by calling <tt>delete</tt> for each cookie
+      def clear(options = {})
+        @cookies.each_key{ |k| delete(k, options) }
+      end
+
       # Returns a jar that'll automatically set the assigned cookies to have an expiration date 20 years from now. Example:
       #
       #   cookies.permanent[:prefers_open_id] = true
@@ -222,6 +227,11 @@ module ActionDispatch
         @delete_cookies.each { |k, v| ::Rack::Utils.delete_cookie_header!(headers, k, v) }
       end
 
+      def reset! #:nodoc:
+        @set_cookies.clear
+        @delete_cookies.clear
+      end
+
       private
 
         def write_cookie?(cookie)
diff --git a/actionpack/lib/action_dispatch/testing/test_process.rb b/actionpack/lib/action_dispatch/testing/test_process.rb
index 397bda41d5..be405c3224 100644
--- a/actionpack/lib/action_dispatch/testing/test_process.rb
+++ b/actionpack/lib/action_dispatch/testing/test_process.rb
@@ -22,7 +22,7 @@ module ActionDispatch
     end
 
     def cookies
-      @request.cookies.merge(@response.cookies).with_indifferent_access
+      @request.cookie_jar
     end
 
     def redirect_to_url
diff --git a/actionpack/lib/action_dispatch/testing/test_request.rb b/actionpack/lib/action_dispatch/testing/test_request.rb
index 822adb6a47..5c16023137 100644
--- a/actionpack/lib/action_dispatch/testing/test_request.rb
+++ b/actionpack/lib/action_dispatch/testing/test_request.rb
@@ -20,12 +20,6 @@ module ActionDispatch
       self.user_agent  = 'Rails Testing'
     end
 
-    def env
-      write_cookies!
-      delete_nil_values!
-      super
-    end
-
     def request_method=(method)
       @env['REQUEST_METHOD'] = method.to_s.upcase
     end
@@ -70,24 +64,5 @@ module ActionDispatch
       @env.delete('action_dispatch.request.accepts')
       @env['HTTP_ACCEPT'] = Array(mime_types).collect { |mime_type| mime_type.to_s }.join(",")
     end
-
-    def cookies
-      @cookies ||= super
-    end
-
-    private
-      def write_cookies!
-        unless @cookies.blank?
-          @env['HTTP_COOKIE'] = @cookies.map { |name, value| escape_cookie(name, value) }.join('; ')
-        end
-      end
-
-      def escape_cookie(name, value)
-        "#{Rack::Utils.escape(name)}=#{Rack::Utils.escape(value)}"
-      end
-
-      def delete_nil_values!
-        @env.delete_if { |k, v| v.nil? }
-      end
   end
 end