Class: Tml::Config

Inherits:
Object
  • Object
show all
Defined in:
lib/tml/config.rb

Overview

Acts as a global singleton that holds all Tml configuration The class can be extended with a different implementation, as long as the interface is supported

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Config

Returns a new instance of Config.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/tml/config.rb', line 88

def initialize
  @enabled = true
  @default_level  = 0
  @format = :html
  @auto_init = true
  @source_separator = '@:@'

  @api_client = {
    class: Tml::Api::Client,
    timeout: 5,
    open_timeout: 2
  }

  @locale = {
    default:      'en',       # default locale
    method:       'current_locale', # method to use for user selected locale, if nil, the rest will be a fallback
    param:        'locale',   # the way to name the param
    strategy:     'param',    # approach param, pre-path, pre-domain, custom-domain
    redirect:     true,       # if TML should handle locale logic redirects
    skip_default: false,      # if the default locales should not be visible
    browser:      true,       # if you want to use a browser header to determine the locale
    cookie:       true,       # if you want to store user selected locale in the cookie
    # default_host: '',         # if user wants to not display default locale, we need to know the default host
    # mapping: {                # domain to locale mapping
    #   en: '',
    #   ru: '',
    # }
  }

  @agent = {
    enabled: true,
    type:    'agent',
    cache:   86400  # timeout every 24 hours
  }

  # if running from IRB, make it default to TRUE
  @submit_missing_keys_realtime = (%w(irb pry).include?($0 || ''))

  @current_locale_method = :current_locale
  @current_user_method = :current_user

  @application = nil
  @postoffice = nil

  @translator_options = {
    debug: false,
    debug_format_html: "<span style='font-size:20px;color:red;'>{</span> {$0} <span style='font-size:20px;color:red;'>}</span>",
    debug_format: '{{{{$0}}}}',
    split_sentences: false,
    nodes: {
      ignored:    %w(),
      scripts:    %w(style script code pre),
      inline:     %w(a span i b img strong s em u sub sup),
      short:      %w(i b),
      splitters:  %w(br hr)
    },
    attributes: {
      labels:     %w(title alt)
    },
    name_mapping: {
      b:    'bold',
      i:    'italic',
      a:    'link',
      img:  'picture'
    },
    data_tokens: {
      special: {
        enabled: true,
        regex: /(&[^;]*;)/
      },
      date: {
        enabled: false,
        formats: [
          [/((Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s+\d+,\s+\d+)/, "{month} {day}, {year}"],
          [/((January|February|March|April|May|June|July|August|September|October|November|December)\s+\d+,\s+\d+)/, "{month} {day}, {year}"],
          [/(\d+\s+(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec),\s+\d+)/, "{day} {month}, {year}"],
          [/(\d+\s+(January|February|March|April|May|June|July|August|September|October|November|December),\s+\d+)/, "{day} {month}, {year}"]
        ],
        name: 'date'
      },
      rules: [
        {enabled: false, name: 'time',     regex: /(\d{1,2}:\d{1,2}\s+([A-Z]{2,3}|am|pm|AM|PM)?)/},
        {enabled: false, name: 'phone',    regex: /((\d{1}-)?\d{3}-\d{3}-\d{4}|\d?\(\d{3}\)\s*\d{3}-\d{4}|(\d.)?\d{3}.\d{3}.\d{4})/},
        {enabled: false, name: 'email',    regex: /([-a-z0-9~!$%^&*_=+}{\'?]+(\.[-a-z0-9~!$%^&*_=+}{\'?]+)*@([a-z0-9_][-a-z0-9_]*(\.[-a-z0-9_]+)*\.(aero|arpa|biz|com|coop|edu|gov|info|int|mil|museum|name|net|org|pro|travel|io|mobi|[a-z][a-z])|([0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}))(:[0-9]{1,5})?)/},
        {enabled: false, name: 'price',    regex: /(\$\d*(,\d*)*(\.\d*)?)/},
        {enabled: false, name: 'fraction', regex: /(\d+\/\d+)/},
        {enabled: false, name: 'num',      regex: /(\b\d*(,\d*)*(\.\d*)?%?\b)/}
      ]
    }
  }

  @context_rules = {
    :number => {
      :variables => {
      }
    },
    :gender => {
      :variables => {
          '@gender' => 'gender',
      }
    },
    :genders => {
      :variables => {
        '@genders' => lambda{|list| list.collect do |u|
            u.is_a?(Hash) ? (u['gender'] || u[:gender]) : u.gender
        end
        },
        '@size' => lambda{ |list| list.size }
      }
    },
    :date => {
      :variables => {
      }
    },
    :time => {
      :variables => {
      }
    },
    :list => {
      :variables => {
        '@count' => lambda{|list| list.size}
      }
    },
  }

  @cache = nil

  @logger  = {
    :enabled        => false,
    :path           => './log/tml.log',
    :level          => 'debug',
    :secure         => true
  }

  @default_tokens = {
    :html => {
      :data => {
        :ndash  =>  '&ndash;',       # –
        :mdash  =>  '&mdash;',       # —
        :iexcl  =>  '&iexcl;',       # ¡
        :iquest =>  '&iquest;',      # ¿
        :quot   =>  '&quot;',        # '
        :ldquo  =>  '&ldquo;',       # “
        :rdquo  =>  '&rdquo;',       # ”
        :lsquo  =>  '&lsquo;',       # ‘
        :rsquo  =>  '&rsquo;',       # ’
        :laquo  =>  '&laquo;',       # «
        :raquo  =>  '&raquo;',       # »
        :nbsp   =>  '&nbsp;',        # space
        :lsaquo =>  '&lsaquo;',      # ‹
        :rsaquo =>  '&rsaquo;',      # ›
        :br     =>  '<br/>',         # line break
        :lbrace =>  '{',
        :rbrace =>  '}',
        :trade  =>  '&trade;',       # TM
      },
      :decoration => {
        :anchor =>  "<a href='{$href}'>{$0}</a>",
        :strong =>  '<strong>{$0}</strong>',
        :bold   =>  '<strong>{$0}</strong>',
        :b      =>  '<strong>{$0}</strong>',
        :em     =>  '<em>{$0}</em>',
        :italic =>  '<i>{$0}</i>',
        :i      =>  '<i>{$0}</i>',
        :link   =>  "<a href='{$href}' class='{$class}' style='{$style}' title='{$title}'>{$0}</a>",
        :br     =>  '<br>{$0}',
        :strike =>  '<strike>{$0}</strike>',
        :div    =>  "<div id='{$id}' class='{$class}' style='{$style}'>{$0}</div>",
        :span   =>  "<span id='{$id}' class='{$class}' style='{$style}'>{$0}</span>",
        :h1     =>  '<h1>{$0}</h1>',
        :h2     =>  '<h2>{$0}</h2>',
        :h3     =>  '<h3>{$0}</h3>',
      }
    },
    :text => {
      :data => {
        :ndash  =>  '–',
        :mdash  =>  '-',
        :iexcl  =>  '¡',
        :iquest =>  '¿',
        :quot   =>  "'",
        :ldquo  =>  '“',
        :rdquo  =>  '”',
        :lsquo  =>  '‘',
        :rsquo  =>  '’',
        :laquo  =>  '«',
        :raquo  =>  '»',
        :nbsp   =>  ' ',
        :lsaquo =>  '‹',
        :rsaquo =>  '›',
        :br     =>  '\n',
        :lbrace =>  '{',
        :rbrace =>  '}',
        :trade  =>  '™',
      },
      :decoration => {
        :anchor =>  '{$0}',
        :strong =>  '{$0}',
        :bold   =>  '{$0}',
        :b      =>  '{$0}',
        :em     =>  '{$0}',
        :italic =>  '{$0}',
        :i      =>  '{$0}',
        :link   =>  '{$0}:{$1}',
        :br     =>  '\n{$0}',
        :strike =>  '{$0}',
        :div    =>  '{$0}',
        :span   =>  '{$0}',
        :h1     =>  '{$0}',
        :h2     =>  '{$0}',
        :h3     =>  '{$0}',
      }
    }
  }

  @localization = {
    :default_day_names        => %w(Sunday Monday Tuesday Wednesday Thursday Friday Saturday),
    :default_abbr_day_names   => %w(Sun Mon Tue Wed Thu Fri Sat),
    :default_month_names      => %w(January February March April May June July August September October November December),
    :default_abbr_month_names => %w(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec),
    :custom_date_formats      =>  {
      :default                => '%m/%d/%Y',            # 07/4/2008
      :short_numeric          => '%m/%d',               # 07/4
      :short_numeric_year     => '%m/%d/%y',            # 07/4/08
      :long_numeric           => '%m/%d/%Y',            # 07/4/2008
      :verbose                => '%A, %B %d, %Y',       # Friday, July  4, 2008
      :monthname              => '%B %d',               # July 4
      :monthname_year         => '%B %d, %Y',           # July 4, 2008
      :monthname_abbr         => '%b %d',               # Jul 4
      :monthname_abbr_year    => '%b %d, %Y',           # Jul 4, 2008
      :date_time              => '%m/%d/%Y at %H:%M',   # 01/03/1010 at 5:30
    },
    :token_mapping => {
      '%a' => '{short_week_day_name}',
      '%A' => '{week_day_name}',
      '%b' => '{short_month_name}',
      '%B' => '{month_name}',
      '%p' => '{am_pm}',
      '%d' => '{days}',
      '%e' => '{day_of_month}',
      '%j' => '{year_days}',
      '%m' => '{months}',
      '%W' => '{week_num}',
      '%w' => '{week_days}',
      '%y' => '{short_years}',
      '%Y' => '{years}',
      '%l' => '{trimed_hour}',
      '%H' => '{full_hours}',
      '%I' => '{short_hours}',
      '%M' => '{minutes}',
      '%S' => '{seconds}',
      '%s' => '{since_epoch}'
    }
  }
end

Instance Attribute Details

#agent ⇒ Object

Returns the value of attribute agent.



83
84
85
 
# File 'lib/tml/config.rb', line 83

def agent
  @agent
end

#api_client ⇒ Object

Returns the value of attribute api_client.



83
84
85
 
# File 'lib/tml/config.rb', line 83

def api_client
  @api_client
end

#application ⇒ Object

Configuration Attributes



78
79
80
 
# File 'lib/tml/config.rb', line 78

def application
  @application
end

#auto_init ⇒ Object

Returns the value of attribute auto_init.



79
80
81
 
# File 'lib/tml/config.rb', line 79

def auto_init
  @auto_init
end

#cache ⇒ Object

Configuration Attributes



78
79
80
 
# File 'lib/tml/config.rb', line 78

def cache
  @cache
end

#context_rules ⇒ Object

Configuration Attributes



78
79
80
 
# File 'lib/tml/config.rb', line 78

def context_rules
  @context_rules
end

#current_locale_method ⇒ Object

Used by Rails and Sinatra extensions



82
83
84
 
# File 'lib/tml/config.rb', line 82

def current_locale_method
  @current_locale_method
end

#current_user_method ⇒ Object

Used by Rails and Sinatra extensions



82
83
84
 
# File 'lib/tml/config.rb', line 82

def current_user_method
  @current_user_method
end

#default_level ⇒ Object

Configuration Attributes



78
79
80
 
# File 'lib/tml/config.rb', line 78

def default_level
  @default_level
end

#default_tokens ⇒ Object

Configuration Attributes



78
79
80
 
# File 'lib/tml/config.rb', line 78

def default_tokens
  @default_tokens
end

#domain ⇒ Object

Returns the value of attribute domain.



79
80
81
 
# File 'lib/tml/config.rb', line 79

def domain
  @domain
end

#enabled ⇒ Object

Configuration Attributes



78
79
80
 
# File 'lib/tml/config.rb', line 78

def enabled
  @enabled
end

#format ⇒ Object

Configuration Attributes



78
79
80
 
# File 'lib/tml/config.rb', line 78

def format
  @format
end

#i18n_backend ⇒ Object

Used by Rails and Sinatra extensions



82
83
84
 
# File 'lib/tml/config.rb', line 82

def i18n_backend
  @i18n_backend
end

#invalidator ⇒ Object

Returns the value of attribute invalidator.



83
84
85
 
# File 'lib/tml/config.rb', line 83

def invalidator
  @invalidator
end

#locale ⇒ Object

Configuration Attributes



78
79
80
 
# File 'lib/tml/config.rb', line 78

def locale
  @locale
end

#localization ⇒ Object

Configuration Attributes



78
79
80
 
# File 'lib/tml/config.rb', line 78

def localization
  @localization
end

#logger ⇒ Object

Configuration Attributes



78
79
80
 
# File 'lib/tml/config.rb', line 78

def logger
  @logger
end

#postoffice ⇒ Object

Configuration Attributes



78
79
80
 
# File 'lib/tml/config.rb', line 78

def postoffice
  @postoffice
end

#source_separator ⇒ Object

Returns the value of attribute source_separator.



79
80
81
 
# File 'lib/tml/config.rb', line 79

def source_separator
  @source_separator
end

#submit_missing_keys_realtime ⇒ Object

Used for IRB only



86
87
88
 
# File 'lib/tml/config.rb', line 86

def submit_missing_keys_realtime
  @submit_missing_keys_realtime
end

#translator_options ⇒ Object

Used by Rails and Sinatra extensions



82
83
84
 
# File 'lib/tml/config.rb', line 82

def translator_options
  @translator_options
end

Instance Method Details

#access_token ⇒ Object 



455
456
457
 
# File 'lib/tml/config.rb', line 455

def access_token
  @application[:token] || @application[:access_token] || ''
end

#agent_locale_strategy ⇒ Object 



360
361
362
 
# File 'lib/tml/config.rb', line 360

def agent_locale_strategy
  locale.merge(param: locale_param)
end

#cache_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


400
401
402
 
# File 'lib/tml/config.rb', line 400

def cache_enabled?
   not cache.nil?
end

#decorator_class ⇒ Object

Decorations



463
464
465
466
 
# File 'lib/tml/config.rb', line 463

def decorator_class
  return Tml::Decorators::Html if @format == :html
  Tml::Decorators::Default
end

#default_abbr_day_name(index) ⇒ Object 



498
499
500
 
# File 'lib/tml/config.rb', line 498

def default_abbr_day_name(index)
  '' + default_abbr_day_names[index]
end

#default_abbr_day_names ⇒ Object 



494
495
496
 
# File 'lib/tml/config.rb', line 494

def default_abbr_day_names
  localization[:default_abbr_day_names]
end

#default_abbr_month_name(index) ⇒ Object 



514
515
516
 
# File 'lib/tml/config.rb', line 514

def default_abbr_month_name(index)
  '' + default_abbr_month_names[index]
end

#default_abbr_month_names ⇒ Object 



510
511
512
 
# File 'lib/tml/config.rb', line 510

def default_abbr_month_names
  localization[:default_abbr_month_names]
end

#default_application ⇒ Object 



451
452
453
 
# File 'lib/tml/config.rb', line 451

def default_application
  @default_application ||= Tml::Application.new(:host => Tml::Api::Client::API_HOST)
end

#default_date_formats ⇒ Object 



518
519
520
 
# File 'lib/tml/config.rb', line 518

def default_date_formats
  localization[:custom_date_formats]
end

#default_day_name(index) ⇒ Object 



490
491
492
 
# File 'lib/tml/config.rb', line 490

def default_day_name(index)
  '' + default_day_names[index]
end

#default_day_names ⇒ Object 



486
487
488
 
# File 'lib/tml/config.rb', line 486

def default_day_names
  localization[:default_day_names]
end

#default_language ⇒ Object 



444
445
446
447
448
449
 
# File 'lib/tml/config.rb', line 444

def default_language
  @default_language ||= begin
    file = File.expand_path(File.join(File.dirname(__FILE__), '..', 'tml', 'languages', "#{Tml.config.default_locale}.json"))
    Tml::Language.new(JSON.parse(File.read(file)))
  end
end

#default_locale ⇒ Object 



440
441
442
 
# File 'lib/tml/config.rb', line 440

def default_locale
  @locale[:default] || 'en'
end

#default_month_name(index) ⇒ Object 



506
507
508
 
# File 'lib/tml/config.rb', line 506

def default_month_name(index)
  '' + default_month_names[index]
end

#default_month_names ⇒ Object 



502
503
504
 
# File 'lib/tml/config.rb', line 502

def default_month_names
  localization[:default_month_names]
end

#default_token_value(token_name, type = :data, format = :html) ⇒ Object 



468
469
470
 
# File 'lib/tml/config.rb', line 468

def default_token_value(token_name, type = :data, format = :html)
  default_tokens[format.to_sym][type.to_sym][token_name.to_sym]
end

#disabled? ⇒ Boolean

Returns:

  • (Boolean) 


348
349
350
 
# File 'lib/tml/config.rb', line 348

def disabled?
  not enabled?
end

#enabled? ⇒ Boolean

Returns:

  • (Boolean) 


344
345
346
 
# File 'lib/tml/config.rb', line 344

def enabled?
  enabled
end

#locale_browser_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


379
380
381
 
# File 'lib/tml/config.rb', line 379

def locale_browser_enabled?
  locale[:browser].nil? || locale[:browser]
end

#locale_cookie_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


372
373
374
375
376
377
 
# File 'lib/tml/config.rb', line 372

def locale_cookie_enabled?
  if %w(pre-domain custom-domain).include?(locale[:strategy])
    return false
  end
  locale[:cookie].nil? || locale[:cookie]
end

#locale_expression ⇒ Object 



352
353
354
 
# File 'lib/tml/config.rb', line 352

def locale_expression
  /^[a-z]{2}(-[A-Z]{2,3})?$/
end

#locale_param ⇒ Object 



364
365
366
 
# File 'lib/tml/config.rb', line 364

def locale_param
  locale[:param] || 'locale'
end

#locale_redirect_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


383
384
385
 
# File 'lib/tml/config.rb', line 383

def locale_redirect_enabled?
  locale[:redirect].nil? || locale[:redirect]
end

#locale_strategy ⇒ Object 



356
357
358
 
# File 'lib/tml/config.rb', line 356

def locale_strategy
  locale[:strategy] || 'param'
end

#nested_value(hash, key, default_value = nil) ⇒ Object 



387
388
389
390
391
392
393
394
 
# File 'lib/tml/config.rb', line 387

def nested_value(hash, key, default_value = nil)
  parts = key.split('.')
  parts.each do |part|
    return default_value unless hash[part.to_sym]
    hash = hash[part.to_sym]
  end
  hash
end

#set_default_token(token_name, value, type = :data, format = :html) ⇒ Object 



472
473
474
475
476
 
# File 'lib/tml/config.rb', line 472

def set_default_token(token_name, value, type = :data, format = :html)
  default_tokens[format.to_sym] ||= {}
  default_tokens[format.to_sym][type.to_sym] ||= {}
  default_tokens[format.to_sym][type.to_sym][token_name.to_sym] = value
end

#strftime_symbol_to_token(symbol) ⇒ Object

Localization



482
483
484
 
# File 'lib/tml/config.rb', line 482

def strftime_symbol_to_token(symbol)
  localization[:token_mapping][symbol]
end

#translator_option(key) ⇒ Object 



396
397
398
 
# File 'lib/tml/config.rb', line 396

def translator_option(key)
  nested_value(self.translator_options, key)
end

#xmessage_decoration_tokens ⇒ Object 



436
437
438
 
# File 'lib/tml/config.rb', line 436

def xmessage_decoration_tokens
  @xmessage_tokens ||= @default_tokens[:html][:decoration].keys
end

#xmessage_rule_key_mapping ⇒ Object

def default_level

return Tml.session.application.default_level if Tml.session.application
@default_level

end



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/tml/config.rb', line 414

def xmessage_rule_key_mapping
  @rule_key_mapping ||= {
      number: {
          one: 'singular',
          few: 'few',
          many: 'many',
          other: 'plural'
      },
      gender: {
          male: 'male',
          female: 'female',
          neutral: 'neutral',
          other: 'other',
      },
      date: {
          future: 'future',
          present: 'present',
          past: 'past'
      }
  }
end