Spec-Zone.ru › Ruby on Rails 4.2

модуль ActionView::Helpers::AssetUrlHelper

Этот модуль предоставляет методы для генерации путей и URL-адресов к ресурсам.

image_path("rails.png")
# => "/assets/rails.png"

image_url("rails.png")
# => "http://www.example.com/assets/rails.png"

Использование хостов ресурсов

По умолчанию Rails ссылается на эти ресурсы на текущем хосте в папке public, но вы можете направить Rails на ссылку на ресурсы с выделенного сервера ресурсов, задав ActionController::Base.asset_host в конфигурации приложения, обычно в config/environments/production.rb. Например, вы бы определили assets.example.com как ваш хост ресурсов таким образом, внутри блока configure ваших файлов конфигурации для конкретной среды или config/application.rb:

config.action_controller.asset_host = "assets.example.com"

Помощники учитывают это:

image_tag("rails.png")
# => <img alt="Rails" src="http://assets.example.com/assets/rails.png" />
stylesheet_link_tag("application")
# => <link href="http://assets.example.com/assets/application.css" media="screen" rel="stylesheet" />

Браузеры обычно открывают не более двух одновременных подключений к одному хосту, что означает, что вашим ресурсам часто приходится ждать завершения загрузки других ресурсов. Вы можете смягчить это, используя %d подстановку в asset_host. Например, “assets%d.example.com”. Если эта подстановка присутствует, Rails распределяет запросы на ресурсы между соответствующими четырьмя хостами “assets0.example.com”, …, “assets3.example.com”. Благодаря этому трюку браузеры откроют восемь одновременных подключений вместо двух.

image_tag("rails.png")
# => <img alt="Rails" src="http://assets0.example.com/assets/rails.png" />
stylesheet_link_tag("application")
# => <link href="http://assets2.example.com/assets/application.css" media="screen" rel="stylesheet" />

Для этого вы можете настроить четыре фактических хоста или использовать подстановку DNS для CNAME этой подстановки на один хост ресурсов. Вы можете узнать больше о настройке записей CNAME DNS от своего интернет-провайдера.

Примечание: Это чисто оптимизация производительности браузера и не предназначено для балансировки нагрузки сервера. См. www.die.net/musings/page_load_time/ для справки.

В качестве альтернативы вы можете получить больший контроль над хостом ресурсов, задав asset_host как процедуру вот так:

ActionController::Base.asset_host = Proc.new { |source|
  "http://assets#{Digest::MD5.hexdigest(source).to_i(16) % 2 + 1}.example.com"
}
image_tag("rails.png")
# => <img alt="Rails" src="http://assets1.example.com/assets/rails.png" />
stylesheet_link_tag("application")
# => <link href="http://assets2.example.com/assets/application.css" media="screen" rel="stylesheet" />

Приведенный выше пример генерирует «assets1.example.com» и «assets2.example.com». Этот вариант полезен, например, если вам нужно меньше/больше четырех хостов, пользовательские имена хостов и т.д.

Как вы видите, процедура принимает параметр source. Это строка с абсолютным путем ресурса, например «/assets/rails.png».

 ActionController::Base.asset_host = Proc.new { |source|
   if source.ends_with?('.css')
     "http://stylesheets.example.com"
   else
     "http://assets.example.com"
   end
 }
image_tag("rails.png")
# => <img alt="Rails" src="http://assets.example.com/assets/rails.png" />
stylesheet_link_tag("application")
# => <link href="http://stylesheets.example.com/assets/application.css" media="screen" rel="stylesheet" />

Кроме того, вы можете запросить второй параметр request. Он особенно полезен для предоставления ресурсов с защищенной SSL страницей. Приведенная ниже примерная процедура отключает хостинг ресурсов для HTTPS-соединений, но по-прежнему отправляет ресурсы для обычных HTTP-запросов с хостов ресурсов. Если у вас нет сертификатов SSL для каждого хоста ресурсов, этот метод позволит вам избежать предупреждений в клиенте о смешанных ресурсах. Обратите внимание, что параметр запроса может быть не предоставлен, например, когда ресурсы предварительно скомпилированы с помощью задачи Rake. Убедитесь, что вы используете процедуру (Proc), а не лямбда-функцию, так как процедура (Proc) позволяет отсутствующие параметры и устанавливает их в значение nil.

config.action_controller.asset_host = Proc.new { |source, request|
  if request && request.ssl?
    "#{request.protocol}#{request.host_with_port}"
  else
    "#{request.protocol}assets.example.com"
  end
}

Вы также можете реализовать объект пользовательского хоста ресурсов, который отвечает на call и принимает один или два параметра, как и процедура.

config.action_controller.asset_host = AssetHostingWithMinimumSsl.new(
  "http://asset%d.example.com", "https://asset1.example.com"
)

Константы

ASSET_EXTENSIONS
ASSET_PUBLIC_DIRECTORIES

Сопоставляет типы ресурсов с общедоступной директорией.

URI_REGEXP

Публичные методы экземпляра

asset_path(source, options = {}) Show source 
# File actionview/lib/action_view/helpers/asset_url_helper.rb, line 123
def asset_path(source, options = {})
  source = source.to_s
  return "" unless source.present?
  return source if source =~ URI_REGEXP

  tail, source = source[/([\?#].+)$/], source.sub(/([\?#].+)$/, '')

  if extname = compute_asset_extname(source, options)
    source = "#{source}#{extname}"
  end

  if source[0] != ?/
    source = compute_asset_path(source, options)
  end

  relative_url_root = defined?(config.relative_url_root) && config.relative_url_root
  if relative_url_root
    source = File.join(relative_url_root, source) unless source.starts_with?("#{relative_url_root}/")
  end

  if host = compute_asset_host(source, options)
    source = File.join(host, source)
  end

  "#{source}#{tail}"
end

Вычисляет путь к ресурсу в общедоступной директории. Если задан параметр :type, к имени файла будет добавлено расширение, и он будет размещен в соответствующей общедоступной директории.

Все остальные вспомогательные функции *_path делегируют вызов этому методу.

asset_path "application.js"                     # => /assets/application.js
asset_path "application", type: :javascript     # => /assets/application.js
asset_path "application", type: :stylesheet     # => /assets/application.css
asset_path "http://www.example.com/js/xmlhr.js" # => http://www.example.com/js/xmlhr.js
Также известен как: path_to_asset
asset_url(source, options = {}) Show source 
# File actionview/lib/action_view/helpers/asset_url_helper.rb, line 161
def asset_url(source, options = {})
  path_to_asset(source, options.merge(:protocol => :request))
end

Вычисляет полный URL-адрес ресурса в общедоступной директории. Внутренне будет использовать asset_path, поэтому большая часть их поведения будет одинаковой. Если задан параметр :host, он переопределяет глобальную настройку config.action_controller.asset_host.

Все остальные параметры передаются в вызов asset_path.

asset_url "application.js"                                 # => http://example.com/assets/application.js
asset_url "application.js", host: "http://cdn.example.com" # => http://cdn.example.com/assets/application.js
Также известен как: url_to_asset
audio_path(source, options = {}) Show source 
# File actionview/lib/action_view/helpers/asset_url_helper.rb, line 333
def audio_path(source, options = {})
  path_to_asset(source, {type: :audio}.merge!(options))
end

Вычисляет путь к аудиоресурсу в общедоступной директории audios. Полные пути от корня документа будут переданы без изменений. Используется внутри audio_tag для построения пути к аудио.

audio_path("horse")                                            # => /audios/horse
audio_path("horse.wav")                                        # => /audios/horse.wav
audio_path("sounds/horse.wav")                                 # => /audios/sounds/horse.wav
audio_path("/sounds/horse.wav")                                # => /sounds/horse.wav
audio_path("http://www.example.com/sounds/horse.wav")          # => http://www.example.com/sounds/horse.wav
Также известен как: path_to_audio
audio_url(source, options = {}) Show source 
# File actionview/lib/action_view/helpers/asset_url_helper.rb, line 340
def audio_url(source, options = {})
  url_to_asset(source, {type: :audio}.merge!(options))
end

Вычисляет полный URL-адрес аудиоресурса в общедоступной директории audios. Внутренне будет использовать audio_path, поэтому большая часть их поведения будет одинаковой.

Также известен как: url_to_audio
compute_asset_extname(source, options = {}) Show source 
# File actionview/lib/action_view/helpers/asset_url_helper.rb, line 173
def compute_asset_extname(source, options = {})
  return if options[:extname] == false
  extname = options[:extname] || ASSET_EXTENSIONS[options[:type]]
  extname if extname && File.extname(source) != extname
end

Вычисляет расширение для добавления к пути ресурса. Возвращает nil, если ничего добавлять не нужно.

compute_asset_host(source = "", options = {}) Show source 
# File actionview/lib/action_view/helpers/asset_url_helper.rb, line 202
def compute_asset_host(source = "", options = {})
  request = self.request if respond_to?(:request)
  host = options[:host]
  host ||= config.asset_host if defined? config.asset_host

  if host.respond_to?(:call)
    arity = host.respond_to?(:arity) ? host.arity : host.method(:call).arity
    args = [source]
    args << request if request && (arity > 1 || arity < 0)
    host = host.call(*args)
  elsif host =~ /%d/
    host = host % (Zlib.crc32(source) % 4)
  end

  host ||= request.base_url if request && options[:protocol] == :request
  return unless host

  if host =~ URI_REGEXP
    host
  else
    protocol = options[:protocol] || config.default_asset_host_protocol || (request ? :request : :relative)
    case protocol
    when :relative
      "//#{host}"
    when :request
      "#{request.protocol}#{host}"
    else
      "#{protocol}://#{host}"
    end
  end
end

Выбирает хост для этого ресурса. Возвращает nil, если хост не задан, хост, если не задан подстановочный знак, хост, интерполированный с числами 0-3, если он содержит %d (число — это остаток от деления хэша источника на 4), или значение, возвращаемое вызовом call для объекта, отвечающего на call (proc или другой).

compute_asset_path(source, options = {}) Show source 
# File actionview/lib/action_view/helpers/asset_url_helper.rb, line 192
def compute_asset_path(source, options = {})
  dir = ASSET_PUBLIC_DIRECTORIES[options[:type]] || ""
  File.join(dir, source)
end

Вычисляет путь к ресурсу в общедоступной директории. Плагины и расширения могут переопределить этот метод, чтобы указать на пользовательские ресурсы или генерировать пути с дайджестами или строками запроса.

font_path(source, options = {}) Show source 
# File actionview/lib/action_view/helpers/asset_url_helper.rb, line 353
def font_path(source, options = {})
  path_to_asset(source, {type: :font}.merge!(options))
end

Вычисляет путь к шрифту. Полные пути от корня документа будут переданы без изменений.

font_path("font")                                           # => /fonts/font
font_path("font.ttf")                                       # => /fonts/font.ttf
font_path("dir/font.ttf")                                   # => /fonts/dir/font.ttf
font_path("/dir/font.ttf")                                  # => /dir/font.ttf
font_path("http://www.example.com/dir/font.ttf")            # => http://www.example.com/dir/font.ttf
Также известен как: path_to_font
font_url(source, options = {}) Show source 
# File actionview/lib/action_view/helpers/asset_url_helper.rb, line 360
def font_url(source, options = {})
  url_to_asset(source, {type: :font}.merge!(options))
end

Вычисляет полный URL-адрес шрифта. Внутренне будет использовать font_path, поэтому большая часть их поведения будет одинаковой.

Также известен как: url_to_font
image_path(source, options = {}) Show source 
# File actionview/lib/action_view/helpers/asset_url_helper.rb, line 291
def image_path(source, options = {})
  path_to_asset(source, {type: :image}.merge!(options))
end

Вычисляет путь к изображению. Полные пути от корня документа будут переданы без изменений. Используется внутри image_tag для построения пути к изображению:

image_path("edit")                                         # => "/assets/edit"
image_path("edit.png")                                     # => "/assets/edit.png"
image_path("icons/edit.png")                               # => "/assets/icons/edit.png"
image_path("/icons/edit.png")                              # => "/icons/edit.png"
image_path("http://www.example.com/img/edit.png")          # => "http://www.example.com/img/edit.png"

Если у вас есть изображения в качестве ресурсов приложения, этот метод может конфликтовать с их именованными маршрутами. Псевдоним path_to_image предоставлен для избежания этого. Rails использует псевдоним внутренне, и авторам плагинов рекомендуется делать то же самое.

Также известен как: path_to_image
image_url(source, options = {}) Show source 
# File actionview/lib/action_view/helpers/asset_url_helper.rb, line 298
def image_url(source, options = {})
  url_to_asset(source, {type: :image}.merge!(options))
end

Вычисляет полный URL-адрес изображения. Внутренне будет использовать image_path, поэтому большая часть их поведения будет одинаковой.

Также известен как: url_to_image
javascript_path(source, options = {}) Show source 
# File actionview/lib/action_view/helpers/asset_url_helper.rb, line 244
def javascript_path(source, options = {})
  path_to_asset(source, {type: :javascript}.merge!(options))
end

Вычисляет путь к JavaScript-ресурсу в общедоступной директории javascripts. Если имя файла source не имеет расширения, будет добавлено .js (за исключением явных URI). Полные пути от корня документа будут переданы без изменений. Используется внутри javascript_include_tag для построения пути к скрипту.

javascript_path "xmlhr"                              # => /assets/xmlhr.js
javascript_path "dir/xmlhr.js"                       # => /assets/dir/xmlhr.js
javascript_path "/dir/xmlhr"                         # => /dir/xmlhr.js
javascript_path "http://www.example.com/js/xmlhr"    # => http://www.example.com/js/xmlhr
javascript_path "http://www.example.com/js/xmlhr.js" # => http://www.example.com/js/xmlhr.js
Также известен как: path_to_javascript
javascript_url(source, options = {}) Show source 
# File actionview/lib/action_view/helpers/asset_url_helper.rb, line 251
def javascript_url(source, options = {})
  url_to_asset(source, {type: :javascript}.merge!(options))
end

Вычисляет полный URL-адрес JavaScript-ресурса в общедоступной директории javascripts. Внутренне будет использовать javascript_path, поэтому большая часть их поведения будет одинаковой.

Также известен как: url_to_javascript
path_to_asset(source, options = {})
Псевдоним для: asset_path
path_to_audio(source, options = {})
Псевдоним для: audio_path
path_to_font(source, options = {})
Псевдоним для: font_path
path_to_image(source, options = {})
Псевдоним для: image_path
path_to_javascript(source, options = {})
Псевдоним для: javascript_path
path_to_stylesheet(source, options = {})
Псевдоним для: stylesheet_path
path_to_video(source, options = {})
Псевдоним для: video_path
stylesheet_path(source, options = {}) Показать исходный код 
# File actionview/lib/action_view/helpers/asset_url_helper.rb, line 266
def stylesheet_path(source, options = {})
  path_to_asset(source, {type: :stylesheet}.merge!(options))
end

Вычисляет путь к ресурсу таблицы стилей в общедоступном каталоге таблиц стилей. Если у source имени файла нет расширения, будет добавлен .css (за исключением явных URI). Полные пути от корня документа будут переданы без изменений. Используется внутри stylesheet_link_tag для построения пути к таблице стилей.

stylesheet_path "style"                                  # => /assets/style.css
stylesheet_path "dir/style.css"                          # => /assets/dir/style.css
stylesheet_path "/dir/style.css"                         # => /dir/style.css
stylesheet_path "http://www.example.com/css/style"       # => http://www.example.com/css/style
stylesheet_path "http://www.example.com/css/style.css"   # => http://www.example.com/css/style.css
Также алиасировано как: path_to_stylesheet
stylesheet_url(source, options = {}) Показать исходный код 
# File actionview/lib/action_view/helpers/asset_url_helper.rb, line 273
def stylesheet_url(source, options = {})
  url_to_asset(source, {type: :stylesheet}.merge!(options))
end

Вычисляет полный URL-адрес ресурса таблицы стилей в общедоступном каталоге таблиц стилей. Это будет использовать stylesheet_path внутри, поэтому большинство их поведений будут одинаковыми.

Также алиасировано как: url_to_stylesheet
url_to_asset(source, options = {})
Псевдоним для: asset_url
url_to_audio(source, options = {})
Псевдоним для: audio_url
url_to_font(source, options = {})
Псевдоним для: font_url
url_to_image(source, options = {})
Псевдоним для: image_url
url_to_javascript(source, options = {})
Псевдоним для: javascript_url
url_to_stylesheet(source, options = {})
Псевдоним для: stylesheet_url
url_to_video(source, options = {})
Псевдоним для: video_url
video_path(source, options = {}) Показать исходный код 
# File actionview/lib/action_view/helpers/asset_url_helper.rb, line 312
def video_path(source, options = {})
  path_to_asset(source, {type: :video}.merge!(options))
end

Вычисляет путь к видео-ресурсу в общедоступном каталоге видео. Полные пути от корня документа будут переданы без изменений. Используется внутри video_tag для построения пути к видео.

video_path("hd")                                            # => /videos/hd
video_path("hd.avi")                                        # => /videos/hd.avi
video_path("trailers/hd.avi")                               # => /videos/trailers/hd.avi
video_path("/trailers/hd.avi")                              # => /trailers/hd.avi
video_path("http://www.example.com/vid/hd.avi")             # => http://www.example.com/vid/hd.avi
Также алиасировано как: path_to_video
video_url(source, options = {}) Показать исходный код 
# File actionview/lib/action_view/helpers/asset_url_helper.rb, line 319
def video_url(source, options = {})
  url_to_asset(source, {type: :video}.merge!(options))
end

Вычисляет полный URL-адрес видео-ресурса в общедоступном каталоге видео. Это будет использовать video_path внутри, поэтому большинство их поведений будут одинаковыми.

Также алиасировано как: url_to_video

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

Spec-Zone.ru

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