class I18n::Config

Public Instance Methods

available_locales ()

Returns an array of locales for which translations are available. Unless you explicitly set these through I18n.available_locales= the call will be delegated to the backend.

# File lib/i18n/config.rb, line 43
def available_locales
  @@available_locales ||= nil
  @@available_locales || backend.available_locales
end
available_locales= (locales)

Sets the available locales.

# File lib/i18n/config.rb, line 57
def available_locales=(locales)
  @@available_locales = Array(locales).map { |locale| locale.to_sym }
  @@available_locales = nil if @@available_locales.empty?
  @@available_locales_set = nil
end
available_locales_initialized? ()

Returns true if the available_locales have been initialized

# File lib/i18n/config.rb, line 64
def available_locales_initialized?
  ( !!defined?(@@available_locales) && !!@@available_locales )
end
backend ()

Returns the current backend. Defaults to Backend::Simple.

# File lib/i18n/config.rb, line 20
def backend
  @@backend ||= Backend::Simple.new
end
backend= (backend)

Sets the current backend. Used to set a custom backend.

# File lib/i18n/config.rb, line 25
def backend=(backend)
  @@backend = backend
end
default_locale ()

Returns the current default locale. Defaults to :‘en’

# File lib/i18n/config.rb, line 30
def default_locale
  @@default_locale ||= :en
end
default_locale= (locale)

Sets the current default locale. Used to set a custom default locale.

# File lib/i18n/config.rb, line 35
def default_locale=(locale)
  I18n.enforce_available_locales!(locale)
  @@default_locale = locale && locale.to_sym
end
default_separator ()

Returns the current default scope separator. Defaults to ‘.’

# File lib/i18n/config.rb, line 75
def default_separator
  @@default_separator ||= '.'
end
default_separator= (separator)

Sets the current default scope separator.

# File lib/i18n/config.rb, line 80
def default_separator=(separator)
  @@default_separator = separator
end
enforce_available_locales () 
# File lib/i18n/config.rb, line 141
def enforce_available_locales
  @@enforce_available_locales
end
enforce_available_locales= (enforce_available_locales) 
# File lib/i18n/config.rb, line 145
def enforce_available_locales=(enforce_available_locales)
  @@enforce_available_locales = enforce_available_locales
end
exception_handler ()

Returns the current exception handler. Defaults to an instance of I18n::ExceptionHandler.

# File lib/i18n/config.rb, line 86
def exception_handler
  @@exception_handler ||= ExceptionHandler.new
end
exception_handler= (exception_handler)

Sets the exception handler.

# File lib/i18n/config.rb, line 91
def exception_handler=(exception_handler)
  @@exception_handler = exception_handler
end
interpolation_patterns ()

Returns the current interpolation patterns. Defaults to I18n::DEFAULT_INTERPOLATION_PATTERNS.

# File lib/i18n/config.rb, line 151
def interpolation_patterns
  @@interpolation_patterns ||= I18n::DEFAULT_INTERPOLATION_PATTERNS.dup
end
interpolation_patterns= (interpolation_patterns)

Sets the current interpolation patterns. Used to set a interpolation patterns.

E.g. using {{}} as a placeholder like “{{hello}}, world!”:

I18n.config.interpolation_patterns << /\{\{(\w+)\}\}/

# File lib/i18n/config.rb, line 161
def interpolation_patterns=(interpolation_patterns)
  @@interpolation_patterns = interpolation_patterns
end
load_path ()

Allow clients to register paths providing translation data sources. The backend defines acceptable sources.

E.g. the provided SimpleBackend accepts a list of paths to translation files which are either named *.rb and contain plain Ruby Hashes or are named *.yml and contain YAML data. So for the SimpleBackend clients may register translation files like this:

I18n.load_path << 'path/to/locale/en.yml'

# File lib/i18n/config.rb, line 126
def load_path
  @@load_path ||= []
end
load_path= (load_path)

Sets the load path instance. Custom implementations are expected to behave like a Ruby Array.

# File lib/i18n/config.rb, line 132
def load_path=(load_path)
  @@load_path = load_path
  @@available_locales_set = nil
  backend.reload!
end
locale ()

The only configuration value that is not global and scoped to thread is :locale. It defaults to the default_locale.

# File lib/i18n/config.rb, line 9
def locale
  defined?(@locale) && @locale != nil ? @locale : default_locale
end
locale= (locale)

Sets the current locale pseudo-globally, i.e. in the Thread.current hash.

# File lib/i18n/config.rb, line 14
def locale=(locale)
  I18n.enforce_available_locales!(locale)
  @locale = locale && locale.to_sym
end
missing_interpolation_argument_handler ()

Returns the current handler for situations when interpolation argument is missing. MissingInterpolationArgument will be raised by default.

# File lib/i18n/config.rb, line 97
def missing_interpolation_argument_handler
  @@missing_interpolation_argument_handler ||= lambda do |missing_key, provided_hash, string|
    raise MissingInterpolationArgument.new(missing_key, provided_hash, string)
  end
end
missing_interpolation_argument_handler= (exception_handler)

Sets the missing interpolation argument handler. It can be any object that responds to call. The arguments that will be passed to call are the same as for MissingInterpolationArgument initializer. Use Proc.new if you don’t care about arity.

Example: ↑

You can suppress raising an exception and return string instead:

I18n.config.missing_interpolation_argument_handler = Proc.new do |key|
  "#{key} is missing"
end

# File lib/i18n/config.rb, line 114
def missing_interpolation_argument_handler=(exception_handler)
  @@missing_interpolation_argument_handler = exception_handler
end