module LokaliseRails

Constants

VERSION

Attributes

api_token[RW]

branch[W]

export_opts[W]

file_ext_regexp[W]

import_opts[W]

import_safe_mode[W]

lang_iso_inferer[W]

locales_path[W]

max_retries_export[W]

max_retries_import[W]

project_id[RW]

skip_file_export[W]

timeouts[W]

translations_converter[W]

translations_loader[W]

Public Class Methods

branch() click to toggle source

Project branch to use

# File lib/lokalise_rails.rb, line 27
def branch
  @branch || 'master'
end

config() { |self| ... } click to toggle source

Main interface to provide configuration options for rake tasks

# File lib/lokalise_rails.rb, line 17
def config
  yield self
end

export_opts() click to toggle source

Options for export rake task

# File lib/lokalise_rails.rb, line 64
def export_opts
  @export_opts || {}
end

file_ext_regexp() click to toggle source

Regular expression used to select translation files with proper extensions

# File lib/lokalise_rails.rb, line 47
def file_ext_regexp
  @file_ext_regexp || /\.ya?ml\z/i
end

import_opts() click to toggle source

Options for import rake task

# File lib/lokalise_rails.rb, line 52
def import_opts
  @import_opts || {
    format: 'yaml',
    placeholder_format: :icu,
    yaml_include_root: true,
    original_filenames: true,
    directory_prefix: '',
    indentation: '2sp'
  }
end

import_safe_mode() click to toggle source

Enables safe mode for import. When enabled, will check whether the target folder is empty or not

# File lib/lokalise_rails.rb, line 69
def import_safe_mode
  @import_safe_mode.nil? ? false : @import_safe_mode
end

lang_iso_inferer() click to toggle source

Infers lang ISO for the given translation file

# File lib/lokalise_rails.rb, line 88
def lang_iso_inferer
  @lang_iso_inferer || ->(data) { YAML.safe_load(data)&.keys&.first }
end

locales_path() click to toggle source

Full path to directory with translation files

# File lib/lokalise_rails.rb, line 22
def locales_path
  @locales_path || "#{Rails.root}/config/locales"
end

max_retries_export() click to toggle source

Maximum number of retries for file exporting

# File lib/lokalise_rails.rb, line 37
def max_retries_export
  @max_retries_export || 5
end

max_retries_import() click to toggle source

Maximum number of retries for file importing

# File lib/lokalise_rails.rb, line 42
def max_retries_import
  @max_retries_import || 5
end

skip_file_export() click to toggle source

Additional file skip criteria to apply when performing export

# File lib/lokalise_rails.rb, line 74
def skip_file_export
  @skip_file_export || ->(_) { false }
end

timeouts() click to toggle source

Set request timeouts for the Lokalise API client

# File lib/lokalise_rails.rb, line 32
def timeouts
  @timeouts || {}
end

translations_converter() click to toggle source

Converts translations data to the proper format

# File lib/lokalise_rails.rb, line 83
def translations_converter
  @translations_converter || ->(raw_data) { raw_data.to_yaml }
end

translations_loader() click to toggle source

# File lib/lokalise_rails.rb, line 78
def translations_loader
  @translations_loader || ->(raw_data) { YAML.safe_load raw_data }
end