Module: LocaliseRails

Extended by:
ActiveSupport::Autoload
Defined in:
lib/localise_rails.rb,
lib/localise_rails/config.rb,
lib/localise_rails/logger.rb,
lib/localise_rails/update.rb,
lib/localise_rails/railtie.rb,
lib/localise_rails/version.rb,
lib/localise_rails/fetch_localise_cache.rb,
lib/localise_rails/request_store_translations.rb,
lib/localise_rails/seed_translations_to_request_store.rb

Defined Under Namespace

Classes: Config, FetchLocaliseCache, Railtie, RequestStoreTranslations, SeedTranslationsToRequestStore, Update

Constant Summary collapse

DATA_CACHE_KEY = 
'localise/data'.freeze
UPDATED_AT_CACHE_KEY = 
'localise/updated_at'.freeze
VERSION = 
'0.1.5'.freeze

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.logger ⇒ Object

Returns the value of attribute logger.



5
6
7
 
# File 'lib/localise_rails/logger.rb', line 5

def logger
  @logger
end

Class Method Details

.config ⇒ Object 



24
25
26
 
# File 'lib/localise_rails.rb', line 24

def self.config
  @config ||= LocaliseRails::Config.new
end

.configure {|config| ... } ⇒ Object

Lets you set global configuration options.

All available options and their defaults are in the example below: LocaliseRails.configure do |config|

config.api_key = "LOCALISE_KEY"

# all options https://localise.biz/api/docs/export/exportall
config.options = {
  filter: 'backend',
  fallback: 'en-US'
}

config.rename_locales = {
  'en-US' => 'en'
}

# set prefix for locales
# config.prefix = 'localise'

# all options https://github.com/redis/redis-rb
# config.redis_options = {
#   host: "127.0.0.1",
#   port: 6379,
#   db: 1,
#   url: "redis://:[email protected]:6379/1"
# }

end

Examples:

Initializer for Rails

Yields:



57
58
59
60
 
# File 'lib/localise_rails.rb', line 57

def self.configure
  yield(config) if block_given?
  config.redis = Redis.new(config.redis_options)
end

.update ⇒ Object 



20
21
22
 
# File 'lib/localise_rails.rb', line 20

def self.update
  LocaliseRails::Update.call
end