r18n-core 2.2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 710530bf79e2d31499094507a16c89fecda6c4be
-  data.tar.gz: 2fd094bdbc14d67b78bddb7b827ce384f16320c0
+SHA256:
+  metadata.gz: 832545b20bcd716bdbad20fcc65c3d1e64ccfd18475c23c55fdedb00e57ad6a7
+  data.tar.gz: d3a3476380d2a6579f2033298b3a4cdcab6d4995616e73f8e04f973d6f7bd04f
 SHA512:
-  metadata.gz: 3e65ed82bdf22bdce12a170f7ac84512a8b9ad6d7c758bc090da96a03f9d0ccdf2038c81e33da1669c54847c1babcd85d4744a142d7f8d967d0162deb89e5efc
-  data.tar.gz: d6b7573f5739b1723681a9aab973a8acf816b9fdbfd22233bf724b214eeadcb71096ee77b4f40478f3195631649eb2713a178175573c3fa95d3ae67e7a8eb46e
+  metadata.gz: 617afab79d7fc3a2193a74e276f862524c1571eaed8efd264aaab659d3a18c0605d1b7d7572d196ce251beda5feca86ff367d5d55c1e87cb91a646c4bc37c36c
+  data.tar.gz: 2dcb2f81f3a54a086bd6d4d207cb61e13789643d649507496a1924bc686902a53cc1b032c1ae8880eb084f93b167106d877a04520845024248659c49077e68b4

data/.rspec

@@ -1 +1 @@
---format documentation --colour
+--format documentation --colour --warnings --require spec_helper

data/ChangeLog.md

@@ -1,11 +1,16 @@
 # Change Log
 
+## 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).s
+* Fix `Locale#localize` method for `DateTime` objects (by Alexander Popov).
 
 ## 2.1.8 (Ѣ)
 * Fix `true` and `false` keys support (by Alexander Popov).

data/README.md

@@ -281,25 +281,6 @@ alarm: !!textile
 t.alarm #=> "<p>It will delete <em>all</em> users!</p>"
 ```
 
-#### Lambdas
-
-You can use lambdas in your translations.
-
-```yaml
-sum: !!proc |x, y| x + y
-```
-
-```ruby
-t.sum(1, 2) #=> 3
-```
-
-If this is unsafe in your application (for example, user can change
-translations), you can disable it:
-
-```ruby
-R18n::Filters.off(:procedure)
-```
-
 ### Localization
 
 You can print numbers and floats according to the rules of the user locale:
@@ -456,7 +437,7 @@ simple:
   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>.
+    <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.

data/Rakefile

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 require 'bundler/setup'
 Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new
-task :default => :spec
+task default: :spec
 
 task :clobber_package do
-  rm_r 'pkg' rescue nil
+  rm_rf 'pkg'
 end
-task :clobber => [:clobber_package]
+task clobber: [:clobber_package]

data/lib/r18n-core.rb

@@ -1,55 +1,56 @@
-=begin
-Main file to load all neccessary classes for i18n support.
-
-Copyright (C) 2008 Andrey “A.I.” Sitnik <andrey@sitnik.ru>
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU Lesser General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU Lesser General Public License for more details.
-
-You should have received a copy of the GNU Lesser General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
-=end
-
-require 'pathname'
-
-dir = Pathname(__FILE__).dirname.expand_path + 'r18n-core'
-require dir.join('version').to_s
-require dir.join('utils').to_s
-require dir.join('locale').to_s
-require dir.join('unsupported_locale').to_s
-require dir.join('translated_string').to_s
-require dir.join('untranslated').to_s
-require dir.join('translation').to_s
-require dir.join('filters').to_s
-require dir.join('filter_list').to_s
-require dir.join('yaml_methods').to_s
-require dir.join('yaml_loader').to_s
-require dir.join('i18n').to_s
-require dir.join('helpers').to_s
+# frozen_string_literal: true
+
+# Main file to load all neccessary classes for i18n support.
+#
+# Copyright (C) 2008 Andrey “A.I.” Sitnik <andrey@sitnik.ru>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+%w[
+  version
+  utils
+  locale
+  unsupported_locale
+  translated_string
+  untranslated
+  translation
+  filters
+  filter_list
+  yaml_methods
+  yaml_loader
+  i18n
+  helpers
+].each do |file|
+  require_relative File.join('r18n-core', file)
+end
 
 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>.
     def set(i18n = nil, places = R18n.default_places, &block)
-      if block_given?
-        @setter = block
-        @i18n   = nil
-      elsif i18n.is_a? I18n
-        @i18n = i18n
-      else
-        @i18n = I18n.new(i18n, places)
-      end
+      @i18n =
+        if block_given?
+          @setter = block
+          nil
+        elsif i18n.is_a? I18n
+          i18n
+        else
+          I18n.new(i18n, places)
+        end
     end
 
     # Set I18n object to current thread.
@@ -65,14 +66,14 @@ module R18n
     # Get I18n object for current thread.
     def get
       thread[:r18n_i18n] ||
-      (thread[:r18n_setter] && thread_set(thread[:r18n_setter].call)) ||
-      @i18n ||
-      (@setter && set(@setter.call))
+        (thread[:r18n_setter] && thread_set(thread[:r18n_setter].call)) ||
+        @i18n ||
+        (@setter && set(@setter.call))
     end
 
     # Clean translations cache.
     def clear_cache!
-      self.cache = { }
+      self.cache = {}
     end
 
     # Delete I18n object from current thread and global variable.
@@ -82,7 +83,7 @@ module R18n
     end
 
     # Deprecated.
-    alias :reset :reset!
+    alias reset reset!
 
     # Get the current thread.
     def thread
@@ -106,7 +107,7 @@ module R18n
     #     - R18n.change(locale).t.language_title
     def change(locale)
       locale = locale.code if locale.is_a? Locale
-      exists = get ? get.locales.map { |i| i.code } : []
+      exists = get ? get.locales.map(&:code) : []
       places = get ? get.translation_places : R18n.default_places
       R18n::I18n.new([locale] + exists, places)
     end
@@ -120,14 +121,14 @@ module R18n
     # Return Array of locales with available translations. You can miss
     # translation +places+, it will be taken from <tt>R18n.default_places</tt>.
     def available_locales(places = R18n.default_places)
-      R18n::I18n.convert_places(places).map { |i| i.available }.flatten.uniq
+      R18n::I18n.convert_places(places).map(&:available).flatten.uniq
     end
 
     # Default places for <tt>R18n.set</tt> and <tt>R18n.available_locales</tt>.
     #
     # You can set block to calculate places dynamically:
     #   R18n.default_places { settings.i18n_places }
-    attr_accessor :default_places
+    attr_writer :default_places
 
     def default_places(&block)
       if block_given?
@@ -151,9 +152,8 @@ module R18n
     attr_accessor :cache
   end
 
-  dir = Pathname(__FILE__).dirname.expand_path
   self.default_loader   = R18n::Loader::YAML
   self.default_places   = nil
-  self.extension_places = [Loader::YAML.new(dir + '../base')]
-  self.clear_cache!
+  self.extension_places = [Loader::YAML.new(File.join(__dir__, '..', 'base'))]
+  clear_cache!
 end

data/lib/r18n-core/filter_list.rb

@@ -1,21 +1,21 @@
-=begin
-Filters for translations content.
-
-Copyright (C) 2012 Andrey “A.I.” Sitnik <andrey@sitnik.ru>
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU Lesser General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU Lesser General Public License for more details.
-
-You should have received a copy of the GNU Lesser General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
-=end
+# frozen_string_literal: true
+
+# Filters for translations content.
+#
+# Copyright (C) 2012 Andrey “A.I.” Sitnik <andrey@sitnik.ru>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 module R18n
   # Superclass for +GlobalFilterList+ and +CustomFilterList+ with filters
@@ -49,9 +49,8 @@ module R18n
 
     # Process +value+ by global filters in +enabled+.
     def process_string(filters_type, value, config, params)
-      if config.is_a? String
-        config = { locale: value.locale, path: config }
-      end
+      config = { locale: value.locale, path: config } if config.is_a? String
+
       enabled(filters_type, String).each do |f|
         value = f.call(value, config, *params)
       end
@@ -75,17 +74,17 @@ module R18n
     end
 
     # List of enable passive filters.
-    def passive(type)
+    def passive(_type)
       []
     end
 
     # List of enable active filters.
-    def active(type)
+    def active(_type)
       []
     end
 
     # List of enable filters.
-    def all(type)
+    def all(_type)
       []
     end
   end
@@ -109,16 +108,15 @@ module R18n
 
   # Filter list for I18n object with custom disabled/enabled filters.
   class CustomFilterList < FilterList
-
     def initialize(on, off)
       @on  = Array(on).map  { |i| Filters.defined[i] }
       @off = Array(off).map { |i| Filters.defined[i] }
-      @changed_types = (@on + @off).map { |i| i.types }.flatten.uniq
+      @changed_types = (@on + @off).map(&:types).flatten.uniq
 
-      @changed_passive = (@on + @off).reject { |i| !i.passive? }.
-        map { |i| i.types }.flatten.uniq
-      @changed_active  = (@on + @off).reject { |i|  i.passive? }.
-        map { |i| i.types }.flatten.uniq
+      @changed_passive = (@on + @off).select(&:passive?)
+        .map(&:types).flatten.uniq
+      @changed_active  = (@on + @off).reject(&:passive?)
+        .map(&:types).flatten.uniq
 
       @on_by_type = {}
       @on.each do |filter|
@@ -139,22 +137,22 @@ 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].reject { |i| !i.passive }
+      enabled = enabled.reject { |i| @off_by_type[type].include? i }
+      enabled + @on_by_type[type].select(&:passive)
     end
 
     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 { |i|  i.passive }
+      enabled = enabled.reject { |i| @off_by_type[type].include? i }
+      enabled + @on_by_type[type].reject(&:passive)
     end
 
     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]
+      enabled = enabled.reject { |i| @off_by_type[type].include? i }
+      enabled + @on_by_type[type]
     end
 
     def hash

data/lib/r18n-core/filters.rb

@@ -1,24 +1,25 @@
-=begin
-Filters for translations content.
-
-Copyright (C) 2009 Andrey “A.I.” Sitnik <andrey@sitnik.ru>
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU Lesser General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU Lesser General Public License for more details.
-
-You should have received a copy of the GNU Lesser General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
-=end
+# frozen_string_literal: true
+
+# Filters for translations content.
+#
+# Copyright (C) 2009 Andrey “A.I.” Sitnik <andrey@sitnik.ru>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'ostruct'
 
+# R18n filters definition
 module R18n
   # Filter is a way, to process translations: escape HTML entries, convert from
   # Markdown syntax, etc.
@@ -101,13 +102,12 @@ module R18n
         @enabled[type] = []
 
         @by_type[type].each do |filter|
-          if filter.enabled?
-            @enabled[type] << filter
-            if filter.passive?
-              @passive_enabled[type] << filter
-            else
-              @active_enabled[type] << filter
-            end
+          next unless filter.enabled?
+          @enabled[type] << filter
+          if filter.passive?
+            @passive_enabled[type] << filter
+          else
+            @active_enabled[type] << filter
           end
         end
       end
@@ -125,25 +125,29 @@ module R18n
       # * +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)
-        options, name = name, nil if name.is_a? Hash
+        if name.is_a? Hash
+          options = name
+          name = nil
+        end
         types = Array(types)
 
-        unless name
+        if name
+          delete(name)
+        else
           @last_auto_name ||= 0
-          begin
+          loop do
             @last_auto_name += 1
             name = @last_auto_name
-          end while defined.has_key? name
-        else
-          delete(name)
+            break unless defined.key? name
+          end
         end
 
         filter = Filter.new(name, types, block, true, options[:passive])
         @defined[name] = filter
 
         types.each do |type|
-          @by_type[type] = [] unless @by_type.has_key? type
-          if options.has_key? :position
+          @by_type[type] = [] unless @by_type.key? type
+          if options.key? :position
             @by_type[type].insert(options[:position], filter)
           else
             @by_type[type] << filter
@@ -151,7 +155,9 @@ module R18n
           rebuild_enabled! type
         end
 
-        @new_filter_listener.call(filter) if @new_filter_listener
+        if defined?(@new_filter_listener) && @new_filter_listener.is_a?(Proc)
+          @new_filter_listener.call(filter)
+        end
         filter
       end
 
@@ -186,7 +192,7 @@ module R18n
       end
 
       # Return filters, which be added inside +block+.
-      def listen(&block)
+      def listen(&_block)
         filters = []
         @new_filter_listener = proc { |i| filters << i }
         yield
@@ -202,14 +208,24 @@ module R18n
     Filters.enabled         = Hash.new([])
 
     Filter = Struct.new(:name, :types, :block, :enabled, :passive) do
-      def call(*params); block.call(*params); end
-      def enabled?; enabled; end
-      def passive?; passive; end
+      def call(*params)
+        block.call(*params)
+      end
+
+      def enabled?
+        enabled
+      end
+
+      def passive?
+        passive
+      end
     end
   end
 
-  Filters.add('proc', :procedure) do |content, config, *params|
-    eval("proc { #{content} }").call(*params)
+  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.
@@ -220,11 +236,13 @@ module R18n
     param = param.to_i if param.is_a? Float
     if param.is_a? Numeric
       type = config[:locale].pluralize(param)
-      type = 'n' if not content.has_key? type
+      type = 'n' unless content.key? type
       content[type]
     else
-      UnpluralizetedTranslation.new(config[:locale], config[:path],
-        locale: config[:locale], translations: content)
+      UnpluralizetedTranslation.new(
+        config[:locale], config[:path],
+        locale: config[:locale], translations: content
+      )
     end
   end
 
@@ -244,25 +262,24 @@ module R18n
     end
   end
 
-  Filters.add(Untranslated, :untranslated) do |v, c, translated, untranslated|
+  Filters.add(Untranslated, :untranslated) do |_v, _c, translated, untranslated|
     "#{translated}[#{untranslated}]"
   end
 
-  Filters.add(Untranslated, :untranslated_bash) do |v, c, transl, untransl|
+  Filters.add(Untranslated, :untranslated_bash) do |_v, _c, transl, untransl|
     "#{transl}\e[0;31m[#{untransl}]\e[0m"
   end
   Filters.off(:untranslated_bash)
 
-  Filters.add(Untranslated, :untranslated_html) do |v, c, transl, untransl|
+  Filters.add(Untranslated, :untranslated_html) do |_v, _c, transl, untransl|
     prefix  = '<span style="color: red">['
     postfix = ']</span>'
     if prefix.respond_to? :html_safe
       prefix  = prefix.html_safe
       postfix = postfix.html_safe
-      transl  << prefix << untransl << postfix
+      transl + prefix + untransl + postfix
     else
-      Utils.escape_html(transl) <<
-        prefix << Utils.escape_html(untransl) << postfix
+      Utils.escape_html(transl) + prefix + Utils.escape_html(untransl) + postfix
     end
   end
   Filters.off(:untranslated_html)
@@ -288,12 +305,12 @@ module R18n
   end
   Filters.off(:global_escape_html)
 
-  Filters.add('markdown', :kramdown, passive: true) do |content, config|
+  Filters.add('markdown', :kramdown, passive: true) do |content, _config|
     require 'kramdown'
     ::Kramdown::Document.new(content).to_html
   end
 
-  Filters.add('textile', :redcloth, passive: true) do |content, config|
+  Filters.add('textile', :redcloth, passive: true) do |content, _config|
     require 'redcloth'
     ::RedCloth.new(content).to_html
   end