Class: ActionView::FileSystemResolver

Inherits:
PathResolver show all
Defined in:
lib/action_view/template/resolver.rb

Overview

A resolver that loads files from the filesystem. It allows setting your own resolving pattern. Such pattern can be a glob string supported by some variables.

Examples

Default pattern, loads views the same way as previous versions of rails, eg. when you’re looking for users/new it will produce query glob: users/new{.{en},}{.{html,js},}{.{erb,haml},}

FileSystemResolver.new("/path/to/views", ":prefix/:action{.:locale,}{.:formats,}{+:variants,}{.:handlers,}")

This one allows you to keep files with different formats in separate subdirectories, eg. users/new.html will be loaded from users/html/new.erb or users/new.html.erb, users/new.js from users/js/new.erb or users/new.js.erb, etc.

FileSystemResolver.new("/path/to/views", ":prefix/{:formats/,}:action{.:locale,}{.:formats,}{+:variants,}{.:handlers,}")

If you don’t specify a pattern then the default will be used.

In order to use any of the customized resolvers above in a Rails application, you just need to configure ActionController::Base.view_paths in an initializer, for example:

ActionController::Base.view_paths = FileSystemResolver.new(
  Rails.root.join("app/views"),
  ":prefix/:action{.:locale,}{.:formats,}{+:variants,}{.:handlers,}",
)

Pattern format and variables

Pattern has to be a valid glob string, and it allows you to use the following variables:

  • :prefix - usually the controller path

  • :action - name of the action

  • :locale - possible locale versions

  • :formats - possible request formats (for example html, json, xml…)

  • :variants - possible request variants (for example phone, tablet…)

  • :handlers - possible handlers (for example erb, haml, builder…)

Constant Summary

Constants inherited from PathResolver

PathResolver::DEFAULT_PATTERN, PathResolver::EXTENSIONS

Instance Method Summary collapse

Methods inherited from Resolver

#clear_cache, #find_all, #find_all_anywhere, #find_all_with_query

Constructor Details

#initialize(path, pattern = nil) ⇒ FileSystemResolver

Returns a new instance of FileSystemResolver.

Raises:

  • (ArgumentError) 


346
347
348
349
350
 
# File 'lib/action_view/template/resolver.rb', line 346

def initialize(path, pattern = nil)
  raise ArgumentError, "path already is a Resolver class" if path.is_a?(Resolver)
  super(pattern)
  @path = File.expand_path(path)
end

Instance Method Details

#eql?(resolver) ⇒ Boolean Also known as: ==

Returns:

  • (Boolean) 


357
358
359
 
# File 'lib/action_view/template/resolver.rb', line 357

def eql?(resolver)
  self.class.equal?(resolver.class) && to_path == resolver.to_path
end

#to_s ⇒ Object Also known as: to_path 



352
353
354
 
# File 'lib/action_view/template/resolver.rb', line 352

def to_s
  @path.to_s
end