Spec-Zone.ru › Ruby on Rails 5.2

модуль ActionController::TestCase::Behavior

Включенные модули:
ActionDispatch::TestProcess, ActiveSupport::Testing::ConstantLookup, ActionController::TemplateAssertions, ActionDispatch::Assertions

Атрибуты

request[R]
response[R]

Открытые методы экземпляров

build_response(klass) Показать исходный код
# File actionpack/lib/action_controller/test_case.rb, line 587
def build_response(klass)
  klass.create
end
controller_class_name() Показать исходный код
# File actionpack/lib/action_controller/test_case.rb, line 547
def controller_class_name
  @controller.class.anonymous? ? "anonymous" : @controller.class.controller_path
end
delete(action, **args) Показать исходный код
# File actionpack/lib/action_controller/test_case.rb, line 420
def delete(action, **args)
  process(action, method: "DELETE", **args)
end

Имитирует запрос DELETE с заданными параметрами и устанавливает/возвращает ответ. См. get для получения более подробной информации.

generated_path(generated_extras) Показать исходный код
# File actionpack/lib/action_controller/test_case.rb, line 551
def generated_path(generated_extras)
  generated_extras[0]
end
get(action, **args) Показать исходный код
# File actionpack/lib/action_controller/test_case.rb, line 394
def get(action, **args)
  res = process(action, method: "GET", **args)
  cookies.update res.cookies
  res
end

Имитирует запрос GET с заданными параметрами.

  • action: Действие контроллера, которое нужно вызвать.

  • params: Хэш с HTTP-параметрами, которые нужно передать. Может быть nil.

  • body: Тело запроса со строкой, которая закодирована соответствующим образом (application/x-www-form-urlencoded или multipart/form-data).

  • session: Хэш параметров для сохранения в сессии. Может быть nil.

  • flash: Хэш параметров для сохранения во всплывающем окне. Может быть nil.

Также можно имитировать запросы POST, PATCH, PUT, DELETE и HEAD с помощью post, patch, put, delete, и head. Пример отправки параметров, сессии и установки сообщения всплывающего окна:

get :show,
  params: { id: 7 },
  session: { user_id: 1 },
  flash: { notice: 'This is flash message' }

Обратите внимание, что метод запроса не проверяется. Различные методы доступны для повышения выразительности тестов.

head(action, **args) Показать исходный код
# File actionpack/lib/action_controller/test_case.rb, line 426
def head(action, **args)
  process(action, method: "HEAD", **args)
end

Имитирует запрос HEAD с заданными параметрами и устанавливает/возвращает ответ. См. get для получения более подробной информации.

patch(action, **args) Показать исходный код
# File actionpack/lib/action_controller/test_case.rb, line 408
def patch(action, **args)
  process(action, method: "PATCH", **args)
end

Имитирует запрос PATCH с заданными параметрами и устанавливает/возвращает ответ. См. get для получения более подробной информации.

post(action, **args) Показать исходный код
# File actionpack/lib/action_controller/test_case.rb, line 402
def post(action, **args)
  process(action, method: "POST", **args)
end

Имитирует запрос POST с заданными параметрами и устанавливает/возвращает ответ. См. get для получения более подробной информации.

process(action, method: "GET", params: {}, session: nil, body: nil, flash: {}, format: nil, xhr: false, as: nil) Показать исходный код
# File actionpack/lib/action_controller/test_case.rb, line 460
def process(action, method: "GET", params: {}, session: nil, body: nil, flash: {}, format: nil, xhr: false, as: nil)
  check_required_ivars

  http_method = method.to_s.upcase

  @html_document = nil

  cookies.update(@request.cookies)
  cookies.update_cookies_from_jar
  @request.set_header "HTTP_COOKIE", cookies.to_header
  @request.delete_header "action_dispatch.cookies"

  @request          = TestRequest.new scrub_env!(@request.env), @request.session, @controller.class
  @response         = build_response @response_klass
  @response.request = @request
  @controller.recycle!

  if body
    @request.set_header "RAW_POST_DATA", body
  end

  @request.set_header "REQUEST_METHOD", http_method

  if as
    @request.content_type = Mime[as].to_s
    format ||= as
  end

  parameters = params.symbolize_keys

  if format
    parameters[:format] = format
  end

  generated_extras = @routes.generate_extras(parameters.merge(controller: controller_class_name, action: action.to_s))
  generated_path = generated_path(generated_extras)
  query_string_keys = query_parameter_names(generated_extras)

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

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

  if xhr
    @request.set_header "HTTP_X_REQUESTED_WITH", "XMLHttpRequest"
    @request.fetch_header("HTTP_ACCEPT") do |k|
      @request.set_header k, [Mime[:js], Mime[:html], Mime[:xml], "text/xml", "*/*"].join(", ")
    end
  end

  @request.fetch_header("SCRIPT_NAME") do |k|
    @request.set_header k, @controller.config.relative_url_root
  end

  begin
    @controller.recycle!
    @controller.dispatch(action, @request, @response)
  ensure
    @request = @controller.request
    @response = @controller.response

    if @request.have_cookie_jar?
      unless @request.cookie_jar.committed?
        @request.cookie_jar.write(@response)
        cookies.update(@request.cookie_jar.instance_variable_get(:@cookies))
      end
    end
    @response.prepare!

    if flash_value = @request.flash.to_session_value
      @request.session["flash"] = flash_value
    else
      @request.session.delete("flash")
    end

    if xhr
      @request.delete_header "HTTP_X_REQUESTED_WITH"
      @request.delete_header "HTTP_ACCEPT"
    end
    @request.query_string = ""

    @response.sent!
  end

  @response
end

Имитирует HTTP-запрос к action, указав метод запроса, параметры и установив/возвратив ответ.

  • action: Действие контроллера, которое нужно вызвать.

  • method: Метод запроса, используемый для отправки HTTP-запроса. Возможные значения GET, POST, PATCH, PUT, DELETE, HEAD. По умолчанию GET. Может быть символом.

  • params: Хэш с HTTP-параметрами, которые нужно передать. Может быть nil.

  • body: Тело запроса со строкой, которая закодирована соответствующим образом (application/x-www-form-urlencoded или multipart/form-data).

  • session: Хэш параметров для сохранения в сессии. Может быть nil.

  • flash: Хэш параметров для сохранения во всплывающем окне. Может быть nil.

  • format: Формат запроса. По умолчанию nil. Может быть строкой или символом.

  • as: Тип содержимого. По умолчанию nil. Должен быть символом, соответствующим MIME-типу.

Пример вызова действия create и отправки двух параметров:

process :create,
  method: 'POST',
  params: {
    user: { name: 'Gaurish Sharma', email: 'user@example.com' }
  },
  session: { user_id: 1 },
  flash: { notice: 'This is flash message' }

Для имитации GET, POST, PATCH, PUT, DELETE и HEAD запросов предпочтительнее использовать методы get, post, patch, put, delete и head соответственно, что сделает тесты более выразительными.

Обратите внимание, что метод запроса не проверяется.

put(action, **args) Показать исходный код
# File actionpack/lib/action_controller/test_case.rb, line 414
def put(action, **args)
  process(action, method: "PUT", **args)
end

Имитирует запрос PUT с заданными параметрами и устанавливает/возвращает ответ. См. get для получения более подробной информации.

query_parameter_names(generated_extras) Показать исходный код
# File actionpack/lib/action_controller/test_case.rb, line 555
def query_parameter_names(generated_extras)
  generated_extras[1] + [:controller, :action]
end
setup_controller_request_and_response() Показать исходный код
# File actionpack/lib/action_controller/test_case.rb, line 559
def setup_controller_request_and_response
  @controller = nil unless defined? @controller

  @response_klass = ActionDispatch::TestResponse

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

  @request          = TestRequest.create(@controller.class)
  @response         = build_response @response_klass
  @response.request = @request

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

© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API