r18n-core 3.0.5 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 868e777a8f94095134b7addd1c4f5eea84bd30c3733b6d347b9332a52dcc87a2
-  data.tar.gz: 87772a5cee32a904f30c2fab64be0c787f713fb528caeff493c870428133909c
+  metadata.gz: 01fc9db07f902211f29b89542f1b6aacb393c85efa4ef48e0750b24b9dbbc94e
+  data.tar.gz: cf6c8d62cb4d1447bfd9b0f34fb78dde6e35ebe7ed71e3e7fb94132bb0593278
 SHA512:
-  metadata.gz: f8558a75174109289ffc43c4ebdbbbc20651069fcc3c4cf4a59398ab318b35bb9030f206220882951a3705c14804ac724faee9cf3f7582c0940657f1864994e4
-  data.tar.gz: 17dcefed65081193ec2605a6ed619f36dc3ef1ee390e19b5b9f2931b26508ae7d397612a85ee6b0410d73304e31665a4920716068e346f8b5d539846fde334fe
+  metadata.gz: de9b44856131d6d52daa7348033a6af6285bfe740f0a064ba24540071a2798a0d025976458112e6465d2386e2bfa61f5a11e40038dee4fcb77778a6103923ce0
+  data.tar.gz: 7be0bf1ccf786dd09132779852cc86bcc4d5b620ce5de7d78640a04c87e33737a0a0cb98fc5e2b85faaa2e603d5592328446d8960ef32404332109561446614e

data/README.md

@@ -281,6 +281,25 @@ alarm: !!textile
 t.alarm #=> "<p>It will delete <em>all</em> users!</p>"
 ```
 
+#### Named variables
+
+After enabling built-in `named_variables` filter, you can use named variables
+in all translations:
+
+```yaml
+greeting: "Hi, %{name}"
+users: !!pl
+  1: One user
+  n: {{count}} users
+```
+
+```ruby
+Filters.on(:named_variables)
+
+t.greeting(name: 'John') #=> "Hi, John"
+t.users(count: 5)        #=> "5 users"
+```
+
 ### Localization
 
 You can print numbers and floats according to the rules of the user locale:

data/lib/r18n-core/filters.rb

@@ -262,6 +262,22 @@ module R18n
     end
   end
 
+  Filters.add(String, :named_variables) do |content, config, params|
+    if params.is_a? Hash
+      content = content.clone
+      params.each_pair do |name, value|
+        value = config[:locale].localize(value)
+        if defined? ActiveSupport::SafeBuffer
+          value = ActiveSupport::SafeBuffer.new + value
+        end
+        content.gsub! "%{#{name}}",  value
+        content.gsub! "{{#{name}}}", value
+      end
+    end
+    content
+  end
+  Filters.off(:named_variables)
+
   Filters.add(Untranslated, :untranslated) do |_v, _c, translated, untranslated|
     "#{translated}[#{untranslated}]"
   end

data/lib/r18n-core/locale.rb

@@ -170,12 +170,13 @@ module R18n
 
         type = obj.is_a?(Date) && !obj.is_a?(DateTime) ? 'date' : 'time'
         format ||= :standard
+        format_method_name = "format_#{type}_#{format}"
 
-        unless %i[human full standard].include? format
+        unless respond_to? format_method_name
           raise ArgumentError, "Unknown time formatter #{format}"
         end
 
-        send "format_#{type}_#{format}", obj, *params
+        send format_method_name, obj, *params
       else
         obj.to_s
       end

data/lib/r18n-core/version.rb

@@ -2,5 +2,5 @@
 
 # Version of R18n Core
 module R18n
-  VERSION = '3.0.5'.freeze unless defined? R18n::VERSION
+  VERSION = '3.1.1'.freeze unless defined? R18n::VERSION
 end

data/r18n-core.gemspec

@@ -19,11 +19,11 @@ Gem::Specification.new do |s|
 
   s.files            = `git ls-files`.split("\n")
   s.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.extra_rdoc_files = ['README.md', 'LICENSE', 'ChangeLog.md']
+  s.extra_rdoc_files = ['README.md', 'LICENSE']
   s.require_path     = 'lib'
 
   s.author   = 'Andrey Sitnik'
   s.email    = 'andrey@sitnik.ru'
   s.homepage = 'https://github.com/ai/r18n'
-  s.license  = 'LGPL-3'
+  s.license  = 'LGPL-3.0'
 end

data/spec/filters_spec.rb

@@ -190,6 +190,21 @@ describe R18n::Filters do
     )
   end
 
+  it 'interpolates named variables' do
+    R18n::Filters.off(:named_variables)
+    expect(@i18n.echo(value: 'R18n')).to eq 'Value is %{value}'
+
+    R18n::Filters.on(:named_variables)
+    expect(@i18n.echo(value: 'R18n')).to eq 'Value is R18n'
+    expect(@i18n.echo(value: -5.5)).to   eq 'Value is −5.5'
+    expect(@i18n.echo(value: 5000)).to   eq 'Value is 5,000'
+    expect(@i18n.echo(value: '<b>')).to eq 'Value is <b>'
+    expect(@i18n.echo).to eq 'Value is %{value}'
+
+    expect(@i18n.echo2(value: 'R18n')).to eq 'Value2 is R18n'
+    expect(@i18n.echo2).to eq 'Value2 is {{value}}'
+  end
+
   it 'formats untranslated' do
     expect(@i18n.in.not.to_s).to   eq('in.[not]')
     expect(@i18n.in.not.to_str).to eq('in.[not]')
@@ -292,16 +307,18 @@ describe R18n::Filters do
 
   it 'escapes variables if ActiveSupport is loaded' do
     expect(@i18n.escape_params('<br>')).to eq('<b><br></b>')
-    require 'active_support'
-    expect(@i18n.escape_params('<br>')).to eq('<b>&lt;br&gt;</b>')
-  end
 
-  it 'uses SafeBuffer if it is loaded' do
     require 'active_support'
 
+    expect(@i18n.escape_params('<br>')).to eq('<b>&lt;br&gt;</b>')
+
     R18n::Filters.on(:global_escape_html)
     @i18n.reload!
 
     expect(@i18n.greater('<b>'.html_safe)).to eq('1 &lt; 2 is <b>')
+
+    R18n::Filters.on(:named_variables)
+
+    expect(@i18n.echo(value: '<b>')).to eq 'Value is &lt;b&gt;'
   end
 end

data/spec/locale_spec.rb

@@ -175,6 +175,16 @@ describe R18n::Locale do
     expect(@ru.localize(Time.at(0), :human)).to eq(Time.at(0).to_s)
   end
 
+  it 'localizes date in custom formatter if exists' do
+    allow(@en).to receive(:format_date_my_own_way) do |date|
+      date == Date.today ? 'DOOMSDAY!' : 'Just another day'
+    end
+
+    expect(@en.localize(Date.today, :my_own_way)).to eq('DOOMSDAY!')
+    expect(@en.localize(Date.today + 1, :my_own_way)).to eq('Just another day')
+    expect(@en.localize(Date.today - 1, :my_own_way)).to eq('Just another day')
+  end
+
   it 'raises error on unknown formatter' do
     expect do
       @ru.localize(Time.at(0).utc, R18n::I18n.new('ru'), :unknown)

data/spec/translations/general/en.yml

@@ -39,6 +39,9 @@ textile:
   simple: !!textile _Hi!_
   html: !!textile _Hi!_<br />
 
+echo: Value is %{value}
+echo2: Value2 is {{value}}
+
 boolean:
   true: Boolean is true
   false: Boolean is false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r18n-core
 version: !ruby/object:Gem::Version
-  version: 3.0.5
+  version: 3.1.1
 platform: ruby
 authors:
 - Andrey Sitnik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-19 00:00:00.000000000 Z
+date: 2018-08-20 00:00:00.000000000 Z
 dependencies: []
 description: |2
       R18n is a i18n tool to translate your Ruby application.
@@ -22,10 +22,8 @@ extensions: []
 extra_rdoc_files:
 - README.md
 - LICENSE
-- ChangeLog.md
 files:
 - ".rspec"
-- ChangeLog.md
 - LICENSE
 - README.md
 - Rakefile
@@ -156,7 +154,7 @@ files:
 - spec/yaml_loader_spec.rb
 homepage: https://github.com/ai/r18n
 licenses:
-- LGPL-3
+- LGPL-3.0
 metadata: {}
 post_install_message: 
 rdoc_options: []

data/ChangeLog.md

@@ -1,323 +0,0 @@
-# Change Log
-
-## 3.0.5 (ب)
-* Fix Farsi locale name (by @iriman).
-
-## 3.0.4 (𐤀)
-* Fix `Translated` compatibility with `Hash` (by Alexander Popov).
-
-## 3.0.3 (〥)
-* Fix missed filters in `Untranslted` initialization (by Alexander Popov).
-
-## 3.0.2 (Ё)
-* Fix `Untranslted.to_s` (by Patrik Rak).
-
-## 3.0.1 (Brooklyn)
-* Fix `no` locale deprecation warning.
-
-## 3.0 (New York)
-* Deprecate `no` locale, use `nb` instead (by Alexander Popov).
-* Remove unsafe `!!proc` filter.
-* Reduce `eval` calls (by Alexander Popov).
-
-## 2.2 (La Habana)
-* Change date format in `en` locale to `YYYY-MM-DD` (by Alexander Popov).
-* Add `TranslatedString#as_json` for ActiveSupport compatibility (by Tim Craft).
-* Fix `TranslatedString#html_safe?` behaviour (by Tim Craft).
-* Fix unsupported `LANG` environment (by Chris Poirier).
-* Fix `Locale#localize` method for `DateTime` objects (by Alexander Popov).
-
-## 2.1.8 (Ѣ)
-* Fix `true` and `false` keys support (by Alexander Popov).
-
-## 2.1.7 (Sewe)
-* Add Afrikaans locale (by Llewellyn van der Merwe).
-
-## 2.1.6 (Berlin)
-* Better `TranslatedString` → `String` converting (by Patrik Rak).
-* Add Ruby on Rails 5 support.
-
-## 2.1.5 (මාතර)
-* Fix Ruby 2.4 support (by Alexander Popov)
-
-## 2.1.4 (Bakı)
-* Add Azerbaijani locale (by Adil Aliyev).
-
-## 2.1.3 (Seoul)
-* Add Korean locale (by Patrick Cheng).
-
-## 2.1.2 (Wien)
-* Fix Ruby 2.3 support.
-
-## 2.1.1 (Barcelona)
-* Better sanity check for Accept-Language header (by Viktors Rotanovs).
-
-## 2.1 (Một)
-* Add Vietnamese locale (by Nguyễn Văn Được).
-* Add Persian locale.
-* Allow to change date/time order in locales.
-* Fix pluralization in locales without plural forms.
-* Fix Mongolian base translations.
-
-## 2.0.4 (Ikkuna)
-* Fix Windows support (by janahanEDH).
-
-## 2.0.3 (Hévíz)
-* Fix Thai locale (by Kasima Tharnpipitchai).
-
-## 2.0.2 (Budapest)
-* Fix array support in translations.
-* Fix Rails support for dialect locales.
-
-## 2.0.1 (Amsterdam)
-* Fix Dutch locale.
-
-## 2.0.0 (Москва)
-* Remove Ruby 1.8 and 1.9 support.
-* Add JRuby 9000 support.
-
-### 1.1.11 (São Paulo)
-* Allow to set Proc as `default` option in Rails I18n backend.
-
-### 1.1.10 (十)
-* Fix Esperanto locale by Larry Gilbert.
-* Fix Chinese locale (by 刘当一).
-
-### 1.1.9 (Не знайдено)
-* Fix Rails 4.0.4 support. Prevent loop on `enforce_available_locales`.
-
-### 1.1.8 (Osam)
-* Add Croatian locale (by Dino Kovač).
-* Add Serbian latin locale (by Dino Kovač).
-
-### 1.1.7 (Tujuh)
-* Return `nil` on untranslated in models with Translated.
-* Add `transliterate` method to I18n backend.
-* Add Indonesian locale (by Guntur Akhmad).
-
-### 1.1.6 (Vitebsk)
-* Return `TranslatedString` after global String filters.
-* Fix path in global String filters.
-
-### 1.1.5 (Hilo)
-* Fix Sinatra plugin under multithreaded web-server (by Viktors Rotanovs).
-* Fix BigDecimal localizing (by François Beausoleil).
-* Add American American Spanish locale (by renemarcelo).
-
-### 1.1.4 (Bokmål)
-* Add Norwegian “no” locale as gateway to Bokmål or Nynorsk.
-* Fix Norwegian Bokmål locale code.
-* Fix hungarian time format (Kővágó Zoltán).
-
-### 1.1.3 (Saint Petersburg)
-* Fix memory leak from cache key missmatch in Rails plugin (by silentshade).
-
-### 1.1.2 (Marshal)
-* Fix translation and untranslated marshalizing (by silentshade).
-* Allow to compare untranslated strings.
-* Fix untranslated strings output in tests.
-
-### 1.1.1 (Dunhuang)
-* Don’t change YAML parser in Ruby 1.9.
-* Allow to change locale by argument in R18n Rails backend.
-* Set also Rails I18n locale in Rails autodetect filter.
-* Fix caching with custom filters (by Anton Onyshchenko).
-* Fix translation variables with `%1` text inside (by Taras Kunch).
-* Fix Latvian locale (by Aleksandrs Ļedovskis).
-
-### 1.1.0 (Leipzig)
-* A lot of fixes in Rails I18n compatibility (thanks for Stephan Schubert).
-* Return Untranslted, when user try to call another translation key on
-  already translated string.
-* Add `Translation#to_hash` to get raw translation.
-* Add `Translation#inspect` to easy debug.
-* Return translation, when pluralization filter didn’t get count.
-* Set R18n backend on Rails plugin init, to use it in console.
-* Allow to use Integer in translation keys.
-
-### 1.0.1 (Phuket Town)
-* Fix translation reloading in Rails and Sinatra.
-* Use global R18n settings for Sinatra extension.
-* Allow to override desktop autodetect by LANG environment on all platforms.
-* Add support for JRuby in 1.9 mode.
-* Rename `R18n.reset` to `R18n.reset!` and add `R18n.clear_cache!`.
-* Fix Sinatra with loaded ActiveSupport.
-* Add Mongolian locale (by Elias Klughammer).
-
-### 1.0.0 (Bangkok)
-* Add `R18n.default_places`.
-* Rails SafeBuffer support.
-* Allow in Rails app to put filters to `app/i18n` reload them in development.
-* Move `R18n::I18n.available_locales` to `R18n.available_locales`.
-* Rename `_keys` to `translation_keys`.
-* Use Kramdown instead of Maruku for Markdown.
-* Allow to use R18n for Rails without mailer.
-* Allow to overwrite I18n object for models.
-* Autoload R18n::Translated.
-* Set default locale to R18n on Rails start to easy use in Rails console.
-* Use env language in Rails console.
-* Mark untranslated part as red in Rails console.
-* Allow to temporary change locale by `R18n.change`.
-* Add `R18n.locale` shortcut.
-* Allow return from setter block locale code, instead of I18n object.
-* Allow to set custom filters for I18n object.
-* Add Galician locale (by Eduard Giménez).
-* Add Traditional Chinese and Simplified Chinese (by Francis Chong).
-* Fix Norsk locale (by Peter Haza).
-
-### 0.4.14 (üç)
-* Fix support for Ruby 1.9.3.
-* Added Turkish locale (by Ahmet Özkaya).
-* Fix Swedish locale (by Pär Wieslander).
-
-### 0.4.13 (Sti)
-* Fix Pathname to String error in r18n-desktop.
-* Add Norwegian locale (by Oddmund Strømme).
-
-### 0.4.12 (Шлях)
-* Fix Pathname to String convertion error.
-* Fix model translation for non-ActiveRecord (by Szymon Przybył).
-* Add Ukrainian locale (by Ярослав Руденок).
-
-### 0.4.11 (Nancy)
-* Support for Sinatra 1.3.
-* Fix JRuby support by Paul Walker.
-* Add R18n helpers to Rails mailer by Alexey Medvedev.
-
-### 0.4.10 (Kvantum)
-* Add R18n.set(locales, places), R18n.t and R18n.l shortcuts.
-* Convert float to number on pluralization.
-* Fix loading empty translation file.
-* Add Portuguese locale.
-* Add Dutch locale (by Sander Heilbron).
-* Add Swedish locale (by Magnus Hörberg).
-
-### 0.4.9 (Kazan)
-* Add support for Psych YAML parser (thanks for Ravil Bayramgalin).
-* Fix ActiveRecord support in Translated.
-* Fix Translated to return non-string values.
-* Fix human time localization.
-* Add Bulgarian locale (by Mitko Kostov).
-* Add Australian English locale (by Dave Sag).
-
-### 0.4.8 (En ni to)
-* Fix support for Ruby 1.9.2.
-* Fix caching issue (by Viktors Rotanovs).
-* Add Danish locale (by Hans Czajkowski Jørgensen)
-* Fix Italian locale (by Viktors Rotanovs).
-* Move untranslated filters with html highlight to r18n-core.
-
-### 0.4.7.1 (Kyū)
-* Fix Japanese locale in Ruby 1.9.1.
-
-### 0.4.7 (Mado)
-* Fix autodetect locale in Windows and Ruby 1.9.1 (by Marvin Gülker).
-* Fix autodetect locale in JRuby (by Kővágó, Zoltán).
-* Fix human time format on 60 minutes.
-* Add Hungarian locale (by Kővágó, Zoltán).
-* Add Japanese locale (by hryk).
-* Fix Polish locale (by Piotr Szotkowski).
-
-### 0.4.6 (Trinity)
-* Add support for new interpolation syntax in Rails 3.
-* Add Catalian locale (by Jordi Romero).
-* Add Finish locale (by Laura Guillén).
-* Add British locale (by JP Hastings-Spital).
-* Add Latvian locale (by Iļja Ketris).
-* Fix Spanish (by Jordi Romero), German, French, Esperanto (by Iļja Ketris) and
-  Polish locales.
-* Fix documentation (by Iļja Ketris and felix).
-* Remove RubyGems from plugins requires.
-
-### 0.4.5 (Annual)
-* Filters for several types.
-* Global HTML escaping run before Markdown and Textile formatting.
-* Fix active filters after passive filters.
-* Fix human time formatting for dates with same month days.
-
-### 0.4.4 (Frank)
-* Use before filter to lazy set I18n object in Sinatra extension.
-* Set I18n object to thread (by Simon Hafner).
-* Add to l Rails helper R18n syntax.
-* Add common helpers.
-* Clear cache in R18n.reset.
-* Clean up code and fix bug (by Akzhan Abdulin).
-* Add Thai locale (by Felix Hanley).
-
-### 0.4.3 (Flange)
-* Add R18n style methods to Rails controllers.
-* Fix for non-string translations in Rails I18n.
-* Use default locale from Rails I18n config.
-* Load translations recursively.
-* Add Slovak locale (by Ahmed Al Hafoudh)
-
-### 0.4.2 (EMS)
-* Fixes for Ruby 1.8.6 (by Akzhan Abdulin).
-* Add method to get translation keys.
-
-### 0.4.1 (Lazy Boole)
-* Add passive filters.
-* Receive filter position as option Hash.
-* Fix base translations (by Pavel Kunc).
-
-### 0.4 (D-Day)
-* Rails I18n compatibility.
-* Rewrite a lot of core code to fast and cleanup version.
-* Custom translation loaders.
-* Add reload! method to I18n.
-* Add t and l helpers to Sinatra and desktop plugins.
-* Syntax sugar for default values.
-* Named variables.
-* New locale API.
-* Change API for extension translations.
-
-### 0.3.2 (Pidgin)
-* Print path of untranslated string by filters.
-* Add Italian locale (by Guido De Rosa).
-* Fix Polish locale (by Adrian Pacała).
-* Fix American English locale (by Max Aller).
-
-### 0.3.1 (Yield)
-* Add Chinese locale (by Ilia Zayats).
-* Add Spanish locale (by Andre O Moura).
-* Add Brazilian Portuguese locale (by Andre O Moura).
-* Remove RubyGems requires.
-
-### 0.3 (Vladivostok)
-* Translated mixin to add i18n support to model or any other class.
-* New cool time formatters.
-* Filters for translations.
-* Add filters to escape HTML, Markdown and Textile syntax.
-* Pluralization and variables is now filters and can be replaced.
-* I18n#locales now contain all detected locales, used to load translations,
-  instead of just received from user.
-* Bugfix in locale code case.
-* Add Czech locale (by Josef Pospíšil).
-
-### 0.2.3 (Shanghai eclipse)
-* R18n will return path string if translation isn’t exists.
-* Add UnsupportedLocale class for locale without information file.
-* Load absent locale information from default locale.
-* Add Polish locale (by Tymon Tobolski).
-
-### 0.2.2 (Clone Wars)
-* Localize numbers in pluralization.
-* Bugfix in translation variables.
-
-### 0.2.1 (Neun)
-* Ruby 1.9 compatibility.
-* Add German locale (by Benjamin Meichsner).
-
-### 0.2 (Freedom of Language)
-* Locale class can be extended for special language (for example, Indian locale
-  may has another digits grouping).
-* Load translations from several dirs.
-* Add French locale.
-* Add Kazakh locale.
-
-### 0.1.1 (Saluto)
-* Loading i18n object without translations.
-* Add output for standalone month name.
-* Don’t call procedures from translations if it isn’t secure.
-* Add Esperanto locale.
-* English locale now contain UK date standards.