Module: ActionController::TestCase::Behavior

Extended by:
ActiveSupport::Concern
Includes:
ActionDispatch::TestProcess, ActiveSupport::Testing::ConstantLookup
Included in:
ActionController::TestCase
Defined in:
lib/action_controller/test_case.rb

Defined Under Namespace

Modules: ClassMethods

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ActionDispatch::TestProcess

#assigns, #cookies, #fixture_file_upload, #flash, #redirect_to_url, #session

Instance Attribute Details

#requestObject (readonly)

Returns the value of attribute request


408
409
410
# File 'lib/action_controller/test_case.rb', line 408

def request
  @request
end

#responseObject (readonly)

Returns the value of attribute response


408
409
410
# File 'lib/action_controller/test_case.rb', line 408

def response
  @response
end

Instance Method Details

#build_requestObject


605
606
607
# File 'lib/action_controller/test_case.rb', line 605

def build_request
  TestRequest.new
end

#build_responseObject


609
610
611
# File 'lib/action_controller/test_case.rb', line 609

def build_response
  TestResponse.new
end

#delete(action, *args) ⇒ Object

Simulate a DELETE request with the given parameters and set/volley the response. See get for more details.


492
493
494
# File 'lib/action_controller/test_case.rb', line 492

def delete(action, *args)
  process(action, "DELETE", *args)
end

#get(action, *args) ⇒ Object

Simulate a GET request with the given parameters.

  • action: The controller action to call.

  • parameters: The HTTP parameters that you want to pass. This may be nil, a hash, or a string that is appropriately encoded (application/x-www-form-urlencoded or multipart/form-data).

  • session: A hash of parameters to store in the session. This may be nil.

  • flash: A hash of parameters to store in the flash. This may be nil.

You can also simulate POST, PATCH, PUT, DELETE, HEAD, and OPTIONS requests with post, patch, put, delete, head, and options.

Note that the request method is not verified. The different methods are available to make the tests more expressive.


468
469
470
# File 'lib/action_controller/test_case.rb', line 468

def get(action, *args)
  process(action, "GET", *args)
end

#head(action, *args) ⇒ Object

Simulate a HEAD request with the given parameters and set/volley the response. See get for more details.


498
499
500
# File 'lib/action_controller/test_case.rb', line 498

def head(action, *args)
  process(action, "HEAD", *args)
end

#paramify_values(hash_or_array_or_value) ⇒ Object


512
513
514
515
516
517
518
519
520
521
522
523
# File 'lib/action_controller/test_case.rb', line 512

def paramify_values(hash_or_array_or_value)
  case hash_or_array_or_value
  when Hash
    Hash[hash_or_array_or_value.map{|key, value| [key, paramify_values(value)] }]
  when Array
    hash_or_array_or_value.map {|i| paramify_values(i)}
  when Rack::Test::UploadedFile, ActionDispatch::Http::UploadedFile
    hash_or_array_or_value
  else
    hash_or_array_or_value.to_param
  end
end

#patch(action, *args) ⇒ Object

Simulate a PATCH request with the given parameters and set/volley the response. See get for more details.


480
481
482
# File 'lib/action_controller/test_case.rb', line 480

def patch(action, *args)
  process(action, "PATCH", *args)
end

#post(action, *args) ⇒ Object

Simulate a POST request with the given parameters and set/volley the response. See get for more details.


474
475
476
# File 'lib/action_controller/test_case.rb', line 474

def post(action, *args)
  process(action, "POST", *args)
end

#process(action, http_method = 'GET', *args) ⇒ Object


525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
# File 'lib/action_controller/test_case.rb', line 525

def process(action, http_method = 'GET', *args)
  check_required_ivars
  http_method, args = handle_old_process_api(http_method, args, caller)

  if args.first.is_a?(String) && http_method != 'HEAD'
    @request.env['RAW_POST_DATA'] = args.shift
  end

  parameters, session, flash = args

  # Ensure that numbers and symbols passed as params are converted to
  # proper params, as is the case when engaging rack.
  parameters = paramify_values(parameters) if html_format?(parameters)

  @html_document = nil

  unless @controller.respond_to?(:recycle!)
    @controller.extend(Testing::Functional)
    @controller.class.class_eval { include Testing }
  end

  @request.recycle!
  @response.recycle!
  @controller.recycle!

  @request.env['REQUEST_METHOD'] = http_method

  parameters ||= {}
  controller_class_name = @controller.class.anonymous? ?
    "anonymous" :
    @controller.class.controller_path

  @request.assign_parameters(@routes, controller_class_name, action.to_s, parameters)

  @request.session.update(session) if session
  @request.flash.update(flash || {})

  @controller.request  = @request
  @controller.response = @response

  build_request_uri(action, parameters)

  name = @request.parameters[:action]

  @controller.process(name)

  if cookies = @request.env['action_dispatch.cookies']
    cookies.write(@response)
  end
  @response.prepare!

  @assigns = @controller.respond_to?(:view_assigns) ? @controller.view_assigns : {}
  @request.session['flash'] = @request.flash.to_session_value
  @request.session.delete('flash') if @request.session['flash'].blank?
  @response
end

#put(action, *args) ⇒ Object

Simulate a PUT request with the given parameters and set/volley the response. See get for more details.


486
487
488
# File 'lib/action_controller/test_case.rb', line 486

def put(action, *args)
  process(action, "PUT", *args)
end

#setup_controller_request_and_responseObject


582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
# File 'lib/action_controller/test_case.rb', line 582

def setup_controller_request_and_response
  @request          = build_request
  @response         = build_response
  @response.request = @request

  @controller = nil unless defined? @controller

  if klass = self.class.controller_class
    unless @controller
      begin
        @controller = klass.new
      rescue
        warn "could not construct controller #{klass}" if $VERBOSE
      end
    end
  end

  if @controller
    @controller.request = @request
    @controller.params = {}
  end
end

#xml_http_request(request_method, action, parameters = nil, session = nil, flash = nil) ⇒ Object Also known as: xhr


502
503
504
505
506
507
508
509
# File 'lib/action_controller/test_case.rb', line 502

def xml_http_request(request_method, action, parameters = nil, session = nil, flash = nil)
  @request.env['HTTP_X_REQUESTED_WITH'] = 'XMLHttpRequest'
  @request.env['HTTP_ACCEPT'] ||=  [Mime::JS, Mime::HTML, Mime::XML, 'text/xml', Mime::ALL].join(', ')
  __send__(request_method, action, parameters, session, flash).tap do
    @request.env.delete 'HTTP_X_REQUESTED_WITH'
    @request.env.delete 'HTTP_ACCEPT'
  end
end