r18n-core 3.2.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea9e0df5d7d9a6465ecbb70590f24b69578fe9bcf703a825f7f861dae17ab8d5
-  data.tar.gz: ce67040d879d2edd3e14bb17d5b3cebff9a4824a25ace0d4caf15d5c4292a6e2
+  metadata.gz: 8a07951d2b74c13c824f759f496022ba65a190760e6b681958bfd037304713e2
+  data.tar.gz: 118665d95730bc8984258f0c0d29ab1d174acc99631319633f475bd3374aca70
 SHA512:
-  metadata.gz: ed567f238f886118551f5243c409fea38722c3508733943731489840bb69507613edb9f5d46031bfbe230d1f339d1c7f757d3cdc5adb102d92559df07b3c18d4
-  data.tar.gz: 825933ccff178daf0648cf78f1f8b9378149cb151bfcddf2835165c66c7dec0bb785368910b6ec0435ccfb39331d953de6d9029b8e5f916ee7420e53fa0b6cab
+  metadata.gz: f7fe8b6c0ab1bb0804050d24c6ca85f0b47b388d83a4ce8c459b76e232c3bc1a9635e87ebd23e044280e4e68d189ca87910a4a57fab6153a763254707a29248e
+  data.tar.gz: b8cf0b271f94bdccefcd3d5e10351a05837c5d483cf0fc78bad43cf687a8c2742701ef38c4874e5c8720c1726690eb9c758f9f815ef982bdae07a1789385c5fb

data/README.md

@@ -10,11 +10,11 @@ Use `r18n-rails` or `sinatra-r18n` to localize Web applications and
 * Nice Ruby-style syntax.
 * Filters.
 * Model Translation (or any Ruby object).
-* Autodetect user locales.
+* Auto-detect user locales.
 * Flexible locales.
 * Total flexibility.
 
-See full features in [main README](https://github.com/ai/r18n/blob/master/README.md).
+See full features in [main README](https://github.com/r18n/r18n/blob/master/README.md).
 
 ## Usage
 
@@ -47,7 +47,8 @@ To set locale only for current thread use `R18n.thread_set`.
 
 Translation files are in YAML format by default and have names like
 `en.yml` (English) or `en-us.yml` (USA English dialect) with
-language/country code (RFC 3066).
+language/country code (RFC 3066). Upcased region (`en-US`) and
+`.yaml` file extension are also allowed.
 
 In your translation files you can use:
 
@@ -96,7 +97,7 @@ t.post.add     #=> "Add post"
 t[:post][:add] #=> "Add post"
 ```
 
-If the locale isn’t found in the user’s requested locale, R18n will search for
+If the locale isn't found in the user's requested locale, R18n will search for
 it in sublocales or in another locale, which the user also can accept:
 
 ```ruby
@@ -104,7 +105,7 @@ t.not.in.english #=> "В английском нет"
 ```
 
 The translated string has a `locale` method for determining its locale (Locale
-instance or code string if locale is’t supported in R18n):
+instance or code string if locale is't supported in R18n):
 
 ```ruby
 i18n.not.in.english.locale #=> Locale ru (Русский)
@@ -128,8 +129,8 @@ t.robots(1)  #=> "One robot"
 t.robots(50) #=> "50 robots"
 ```
 
-If there isn’t a pluralization for a particular number, translation will be use
-`n`. If there isn’t a locale file for translation, it will use the English
+If there isn't a pluralization for a particular number, translation will be use
+`n`. If there isn't a locale file for translation, it will use the English
 pluralization rule (`0`, `1` and `n`).
 
 You can check if the key has a translation:
@@ -193,7 +194,7 @@ To create a filter you pass the following to `R18n::Filters.add`:
 * Optional filter name, to disable, enable or delete it later by
   `R18n::Filters.off`, `R18n::Filters.on` and
   `R18n::Filters.delete`.
-* Hash with options:
+* `Hash` with options:
   * `passive: true` to filter translations only on load;
   * `:position` within the list of current filters of this type
     (by default a new filter will be inserted into last position).
@@ -201,7 +202,7 @@ To create a filter you pass the following to `R18n::Filters.add`:
 The filter will receive at least two arguments:
 * Translation (possibly already filtered by other filters for this type earlier
   in the list).
-* A Hash with translation `locale` and `path`.
+* A `Hash` with translation `locale` and `path`.
 * Parameters from translation request will be in the remaining arguments.
 
 In Rails application put your filters to `app/i18n/filters.rb`, it will be
@@ -254,7 +255,7 @@ hi: !!markdown
 t.hi #=> "<p><strong>Hi</strong>, people!</p>"
 ```
 
-If you can’t use Kramdown you can redefine Markdown filter
+If you can't use Kramdown you can redefine Markdown filter
 to use your own parser:
 
 ```ruby
@@ -270,7 +271,7 @@ end
 
 #### Textile
 
-To use Textile in your translations you must install the RedCloth gem:
+To use Textile in your translations you must install the `RedCloth` gem:
 
 ```yaml
 alarm: !!textile
@@ -311,8 +312,8 @@ l -12000.5 #=> "−12,000.5"
 Number and float formatters will also put real typographic minus and put
 non-breakable thin spaces (for locale, which use it as digit separator).
 
-You can translate months and week day names in Time, Date and DateTime by the
-`strftime` method:
+You can translate months and week day names in `Time`, `Date` and `DateTime`
+by the `strftime` method:
 
 ```ruby
 l Time.now, '%B'  #=> "September"
@@ -330,8 +331,8 @@ l Time.now.to_date #=> "2009-08-09"
 
 ### Model
 
-You can add i18n support to any classes, including ORM models (ActiveRecord,
-DataMapper, MongoMapper, Mongoid or others):
+You can add i18n support to any classes, including ORM models (`ActiveRecord`,
+`Sequel`, `DataMapper`, `MongoMapper`, `Mongoid` or others):
 
 ```ruby
 class Product
@@ -361,9 +362,9 @@ See `R18n::Translated` for documentation.
 
 ### Locale
 
-All supported locales are stored in R18n gem in `locales` directory. If you want
-to add your locale, please fork this project and send a pull request or email me
-at <andrey@sitnik.ru>.
+All supported locales are stored in `r18n-core` gem in `locales/` directory.
+If you want to add your locale, please see the ["Add Locale"](#add-locale)
+section.
 
 To get information about a locale create an `R18n::Locale` instance:
 
@@ -398,7 +399,7 @@ You can load translations from anywhere, not just from YAML files. To load
 translation you must create loader class with 2 methods:
 
 * `available` – return array of locales of available translations;
-* `load(locale)` – return Hash of translation.
+* `load(locale)` – return `Hash` of translation.
 
 Pass its instance to `R18n.default_places` or `R18n.set(locales, loaders)`
 
@@ -448,32 +449,37 @@ R18n.extension_places << R18n::Loader::YAML.new('./error_messages/')
 
 ## Add Locale
 
-If R18n hasn’t got locale file for your language, please add it. It’s very
+If R18n has not got locale file for your language, please add it. It's very
 simple:
 
-* Create the file <tt><i>code</i>.rb</tt> in the `locales/` directory for your
-  language and describe locale. Just copy from another locale and change the
+* Create the file `%{code}.rb` for your language and describe locale, then
+  require it in the project. Just copy from another locale and change the
   values.
   * If your country has alternate languages (for example, in exUSSR countries
     most people also know Russian), add
-    <tt>sublocales %w[<i>another_locale</i> en]</tt>.
-* Create in `base/` file <tt><i>code</i>.yml</tt>  for your language and
-  translate the base messages. Just copy file from language, which you know,
-  and rewrite values.
+    `sublocales %w[%{another_locale} en]`.
 * If your language needs some special logic (for example, different
   pluralization or time formatters) you can extend `R18n::Locale` class methods.
-* Send a pull request via GitHub <http://github.com/ai/r18n> or just write email
-  with the files to me <andrey@sitnik.ru>.
 
-*Code* is RFC 3066 code for your language (for example, “en” for English and
-“fr-CA” for Canadian French). Email me with any questions you may have, you will
-find other contact addresses at http://sitnik.ru.
+If you want to send a pull request:
+
+* Move your `%{code}.rb` file in the `locales/` directory.
+* Create `%{code}.yml` file for your language in the `base/` directory and
+  translate the base messages. Just copy file from language, which you know,
+  and rewrite values.
+* Send a pull request via GitHub <http://github.com/r18n/r18n> or just write
+  email with the files to [Andrey Sitnik](mailto:andrey@sitnik.ru)
+  or [Alexander Popov](mailto:alex.wayfer@gmail.com).
+
+`%{code}` is RFC 3066 code for your language (for example, `en` for English and
+`fr-CA` for Canadian French). Email me with any questions you may have, you will
+find other contact addresses at [sitnik.ru](https://sitnik.ru/).
 
 ## License
 
 R18n is licensed under the GNU Lesser General Public License version 3.
-See the LICENSE file or http://www.gnu.org/licenses/lgpl.html.
+See the LICENSE file or [www.gnu.org/licenses/lgpl-3.0.html](https://www.gnu.org/licenses/lgpl-3.0.html).
 
 ## Author
 
-Andrey “A.I.” Sitnik <andrey@sitnik.ru>
+Andrey “A.I.” Sitnik [andrey@sitnik.ru](mailto:andrey@sitnik.ru)

data/lib/r18n-core.rb

@@ -39,8 +39,8 @@ module R18n
   autoload :Translated, 'r18n-core/translated'
 
   class << self
-    # Set I18n object globally. You can miss translation +places+, it will be
-    # taken from <tt>R18n.default_places</tt>.
+    # Set I18n object globally. You can miss translation `places`, it will be
+    # taken from `R18n.default_places`.
     def set(i18n = nil, places = R18n.default_places, &block)
       @i18n =
         if block_given?
@@ -90,41 +90,55 @@ module R18n
       Thread.current
     end
 
-    # Translate message. Alias for <tt>R18n.get.t</tt>.
+    # Translate message. Alias for `R18n.get.t`.
     def t(*params)
       get.t(*params)
     end
 
-    # Localize object. Alias for <tt>R18n.get.l</tt>.
+    # Localize object. Alias for `R18n.get.l`.
     def l(*params)
       get.l(*params)
     end
 
-    # Return I18n object for +locale+. Useful to temporary change locale,
+    # Return I18n object for `locale`. Useful to temporary change locale,
     # for example, to show text in locales list:
     #
     #   - R18n.available_locales.each do |locale|
     #     - R18n.change(locale).t.language_title
+    #
+    # It also can be used with block:
+    #
+    #   - R18n.change(locale) { t.language_title }
     def change(locale)
       locale = locale.code if locale.is_a? Locale
       exists = get ? get.locales.map(&:code) : []
       places = get ? get.translation_places : R18n.default_places
-      R18n::I18n.new([locale] + exists, places)
+
+      i18n = R18n::I18n.new([locale] + exists, places)
+
+      if block_given?
+        old_thread_i18n = thread[:r18n_i18n]
+        thread_set i18n
+        yield
+        thread[:r18n_i18n] = old_thread_i18n
+      end
+
+      i18n
     end
 
-    # Return Locale object by locale code. It’s shortcut for
-    # <tt>R18n::Locale.load(code)</tt>.
+    # Return Locale object by locale code. It's shortcut for
+    # `R18n::Locale.load(code)`.
     def locale(code)
       R18n::Locale.load(code)
     end
 
-    # Return Array of locales with available translations. You can miss
-    # translation +places+, it will be taken from <tt>R18n.default_places</tt>.
+    # Return `Array` of locales with available translations. You can miss
+    # translation `places`, it will be taken from `R18n.default_places`.
     def available_locales(places = R18n.default_places)
       R18n::I18n.convert_places(places).map(&:available).flatten.uniq
     end
 
-    # Default places for <tt>R18n.set</tt> and <tt>R18n.available_locales</tt>.
+    # Default places for `R18n.set` and `R18n.available_locales`.
     #
     # You can set block to calculate places dynamically:
     #   R18n.default_places { settings.i18n_places }
@@ -140,15 +154,15 @@ module R18n
       end
     end
 
-    # Default loader class, which will be used if you didn’t send loader to
-    # +I18n.new+ (object with +available+ and +load+ methods).
+    # Default loader class, which will be used if you didn't send loader to
+    # `I18n.new` (object with `available` and `load` methods).
     attr_accessor :default_loader
 
     # Loaders with extension translations. If application translations with
-    # same locale isn’t exists, extension file willn’t be used.
+    # same locale isn't exists, extension file willn't be used.
     attr_accessor :extension_places
 
-    # Hash of hash-like (see Moneta) object to store loaded translations.
+    # `Hash` of hash-like (see Moneta) object to store loaded translations.
     attr_accessor :cache
   end
 

data/lib/r18n-core/filter_list.rb

@@ -18,10 +18,10 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 module R18n
-  # Superclass for +GlobalFilterList+ and +CustomFilterList+ with filters
+  # Superclass for `GlobalFilterList` and `CustomFilterList` with filters
   # processing.
   class FilterList
-    # Process +value+ by filters in +enabled+.
+    # Process `value` by filters in `enabled`.
     def process(filters_type, type, value, locale, path, params)
       config = { locale: locale, path: path }
 
@@ -39,15 +39,17 @@ module R18n
 
     # Shortcut to process `R18n::Typed`.
     def process_typed(filters_type, typed_value, params)
-      process(filters_type,
-              typed_value.type,
-              typed_value.value,
-              typed_value.locale,
-              typed_value.path,
-              params)
+      process(
+        filters_type,
+        typed_value.type,
+        typed_value.value,
+        typed_value.locale,
+        typed_value.path,
+        params
+      )
     end
 
-    # Process +value+ by global filters in +enabled+.
+    # Process `value` by global filters in `enabled`.
     def process_string(filters_type, value, config, params)
       config = { locale: value.locale, path: config } if config.is_a? String
 
@@ -62,7 +64,7 @@ module R18n
       end
     end
 
-    # Array of enabled filters with +filters_type+ for +type+.
+    # `Array` of enabled filters with `filters_type` for `type`.
     def enabled(filters_type, type)
       if filters_type == :passive
         passive(type)
@@ -137,6 +139,7 @@ module R18n
     def passive(type)
       enabled = Filters.passive_enabled[type]
       return enabled unless @changed_passive.include? type
+
       enabled = enabled.reject { |i| @off_by_type[type].include? i }
       enabled + @on_by_type[type].select(&:passive)
     end
@@ -144,6 +147,7 @@ module R18n
     def active(type)
       enabled = Filters.active_enabled[type]
       return enabled unless @changed_active.include? type
+
       enabled = enabled.reject { |i| @off_by_type[type].include? i }
       enabled + @on_by_type[type].reject(&:passive)
     end
@@ -151,6 +155,7 @@ module R18n
     def all(type)
       enabled = Filters.enabled[type]
       return enabled unless @changed_types.include? type
+
       enabled = enabled.reject { |i| @off_by_type[type].include? i }
       enabled + @on_by_type[type]
     end

data/lib/r18n-core/filters.rb

@@ -42,14 +42,14 @@ module R18n
   #
   #   i18n.filtered('_') #=> "This_content_will_be_processed_by_filter!"
   #
-  # Use String class as type to add global filter for all translated strings:
+  # Use `String` class as type to add global filter for all translated strings:
   #
   #   R18n::Filters.add(String, :escape_html) do |content, config, params|
   #     escape_html(content)
   #   end
   #
   # Filter config contain two parameters: translation locale and path. But it is
-  # Hash and you can add you own parameter to cross-filter communications:
+  # `Hash` and you can add you own parameter to cross-filter communications:
   #
   #   R18n::Filters.add(String, :hide_truth) do |content, config|
   #     return content if config[:censorship_check]
@@ -74,28 +74,28 @@ module R18n
   #   i18n.filtered('_') #=> "This_content_will_be_processed_by_filter!"
   #   R18n::Filters.delete(:no_space)
   #
-  # You can enabled/disabled filters only for special I18n object:
+  # You can enabled/disabled filters only for special `I18n` object:
   #
   #   R18n::I18n.new('en', nil, on_filters: [:untranslated_html, :no_space],
   #                             off_filters: :untranslated )
   module Filters
     class << self
-      # Hash of filter names to Filters.
+      # `Hash` of filter names to Filters.
       attr_accessor :defined
 
-      # Hash of types to all Filters.
+      # `Hash` of types to all Filters.
       attr_accessor :by_type
 
-      # Hash of types to enabled active filters.
+      # `Hash` of types to enabled active filters.
       attr_accessor :active_enabled
 
-      # Hash of types to enabled passive filters.
+      # `Hash` of types to enabled passive filters.
       attr_accessor :passive_enabled
 
-      # Hash of types to enabled passive and active filters.
+      # `Hash` of types to enabled passive and active filters.
       attr_accessor :enabled
 
-      # Rebuild +active_enabled+ and +passive_enabled+ for +type+.
+      # Rebuild `active_enabled` and `passive_enabled` for `type`.
       def rebuild_enabled!(type)
         @passive_enabled[type] = []
         @active_enabled[type] = []
@@ -103,6 +103,7 @@ module R18n
 
         @by_type[type].each do |filter|
           next unless filter.enabled?
+
           @enabled[type] << filter
           if filter.passive?
             @passive_enabled[type] << filter
@@ -112,17 +113,17 @@ module R18n
         end
       end
 
-      # Add new filter for +type+ with +name+ and return filter object. You
-      # can use String class as +type+ to add global filter for all translated
+      # Add new filter for `type` with `name` and return filter object. You
+      # can use `String` class as `type` to add global filter for all translated
       # string.
       #
-      # Filter content will be sent to +block+ as first argument, struct with
+      # Filter content will be sent to `block` as first argument, struct with
       # config as second and filters parameters will be in next arguments.
       #
       # Options:
-      # * +position+ – change order on processing several filters for same type.
+      # * `position` – change order on processing several filters for same type.
       #    Note that passive filters will be always run before active.
-      # * +passive+ – if +true+, filter will process only on translation
+      # * `passive` – if `true`, filter will process only on translation
       #   loading. Note that you must add all passive before load translation.
       def add(types, name = nil, options = {}, &block)
         if name.is_a? Hash
@@ -161,7 +162,7 @@ module R18n
         filter
       end
 
-      # Delete +filter+ by name or Filter object.
+      # Delete `filter` by name or Filter object.
       def delete(filter)
         filter = @defined[filter] unless filter.is_a? Filter
         return unless filter
@@ -173,7 +174,7 @@ module R18n
         end
       end
 
-      # Disable +filter+ by name or Filter object.
+      # Disable `filter` by name or Filter object.
       def off(filter)
         filter = @defined[filter] unless filter.is_a? Filter
         return unless filter
@@ -182,7 +183,7 @@ module R18n
         filter.types.each { |type| rebuild_enabled! type }
       end
 
-      # Turn on disabled +filter+ by name or Filter object.
+      # Turn on disabled `filter` by name or Filter object.
       def on(filter)
         filter = @defined[filter] unless filter.is_a? Filter
         return unless filter
@@ -191,7 +192,7 @@ module R18n
         filter.types.each { |type| rebuild_enabled! type }
       end
 
-      # Return filters, which be added inside +block+.
+      # Return filters, which be added inside `block`.
       def listen(&_block)
         filters = []
         @new_filter_listener = proc { |i| filters << i }
@@ -222,12 +223,6 @@ module R18n
     end
   end
 
-  Filters.add('proc', :procedure) do |content, _config, *params|
-    # rubocop:disable Security/Eval
-    eval("proc { #{content} }", nil, __FILE__, __LINE__).call(*params)
-    # rubocop:enable Security/Eval
-  end
-
   # Class to mark unpluralized translation.
   class UnpluralizetedTranslation < Translation
   end
@@ -310,8 +305,9 @@ module R18n
     content
   end
 
-  Filters.add([String, 'markdown', 'textile'],
-              :global_escape_html, passive: true) do |html, config|
+  Filters.add(
+    [String, 'markdown', 'textile'], :global_escape_html, passive: true
+  ) do |html, config|
     if config[:dont_escape_html]
       html
     else