r18n-core 2.2.0 → 3.0.0

data/lib/r18n-core/translated.rb

@@ -1,21 +1,21 @@
-=begin
-Add i18n support to any class.
-
-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
+# frozen_string_literal: true
+
+# Add i18n support to any class.
+#
+# 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/>.
 
 module R18n
   # Module to add i18n support to any class. It will be useful for ORM or
@@ -112,64 +112,63 @@ module R18n
       #   translation :desciption, type: 'markdown'
       def translation(name, options = {})
         if options[:methods]
-          @unlocalized_getters[name] = R18n::Utils.
-            hash_map(options[:methods]) { |l, i| [ l.to_s, i.to_s ] }
+          @unlocalized_getters[name] = R18n::Utils
+            .hash_map(options[:methods]) { |l, i| [l.to_s, i.to_s] }
           unless options[:no_write]
-            @unlocalized_setters[name] = R18n::Utils.
-              hash_map(options[:methods]) { |l, i| [ l.to_s, i.to_s + '=' ] }
+            @unlocalized_setters[name] = R18n::Utils
+              .hash_map(options[:methods]) { |l, i| [l.to_s, i.to_s + '='] }
           end
         end
 
         @translation_types[name] = options[:type]
-        params = options[:no_params] ? '' : ', *params'
-
-        class_eval <<-EOS, __FILE__, __LINE__
-          def #{name}(*params)
-            unlocalized = self.class.unlocalized_getters(#{name.inspect})
-            result = nil
-
-            r18n.locales.each do |locale|
-              code = locale.code
-              next unless unlocalized.has_key? code
-              result = send unlocalized[code]#{params}
-              next unless result
-
-              path = "\#{self.class.name}##{name}"
-              type = self.class.translation_types[#{name.inspect}]
-              if type
-                return r18n.filter_list.process(:all, type, result, locale,
-                                                    path, params)
-              elsif result.is_a? String
-                result = TranslatedString.new(result, locale, path)
-                return r18n.filter_list.process_string(:all, result, path,
-                                                           params)
-              else
-                return result
-              end
+
+        define_method name do |*params|
+          unlocalized = self.class.unlocalized_getters(name)
+          result = nil
+
+          r18n.locales.each do |locale|
+            code = locale.code
+            next unless unlocalized.key? code
+            result = send(
+              unlocalized[code], *(params unless options[:no_params])
+            )
+            next unless result
+
+            path = "#{self.class.name}##{name}"
+            type = self.class.translation_types[name]
+            if type
+              return r18n.filter_list.process(
+                :all, type, result, locale, path, params
+              )
+            elsif result.is_a? String
+              result = TranslatedString.new(result, locale, path)
+              return r18n.filter_list.process_string(
+                :all, result, path, params
+              )
+            else
+              return result
             end
+          end
+
+          result
+        end
 
-            result
+        return if options[:no_write]
+
+        define_method "#{name}=" do |*params|
+          unlocalized = self.class.unlocalized_setters(name)
+          r18n.locales.each do |locale|
+            code = locale.code
+            next unless unlocalized.key? code
+            return send unlocalized[code], *params
           end
-        EOS
-
-        unless options[:no_write]
-          class_eval <<-EOS, __FILE__, __LINE__
-            def #{name}=(*params)
-              unlocalized = self.class.unlocalized_setters(#{name.inspect})
-              r18n.locales.each do |locale|
-                code = locale.code
-                next unless unlocalized.has_key? code
-                return send unlocalized[code], *params
-              end
-            end
-          EOS
         end
       end
 
       # Return array of methods to find +unlocalized_getters+ or
       # +unlocalized_setters+.
       def unlocalized_methods
-        self.instance_methods
+        instance_methods
       end
 
       # Return Hash of locale code to getter method for proxy +method+. If you
@@ -177,9 +176,9 @@ module R18n
       # automatically.
       def unlocalized_getters(method)
         matcher = Regexp.new('^' + Regexp.escape(method.to_s) + '_(\w+)$')
-        unless @unlocalized_getters.has_key? method
+        unless @unlocalized_getters.key? method
           @unlocalized_getters[method] = {}
-          self.unlocalized_methods.reject { |i| not i =~ matcher }.each do |i|
+          unlocalized_methods.select { |i| i =~ matcher }.each do |i|
             @unlocalized_getters[method][i.to_s.match(matcher)[1]] = i.to_s
           end
         end
@@ -191,9 +190,9 @@ module R18n
       # automatically.
       def unlocalized_setters(method)
         matcher = Regexp.new('^' + Regexp.escape(method.to_s) + '_(\w+)=$')
-        unless @unlocalized_setters.has_key? method
+        unless @unlocalized_setters.key? method
           @unlocalized_setters[method] = {}
-          self.unlocalized_methods.reject { |i| not i =~ matcher }.each do |i|
+          unlocalized_methods.select { |i| i =~ matcher }.each do |i|
             @unlocalized_setters[method][i.to_s.match(matcher)[1]] = i.to_s
           end
         end

data/lib/r18n-core/translated_string.rb

@@ -1,21 +1,21 @@
-=begin
-Translation string 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
+# frozen_string_literal: true
+
+# Translation string 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/>.
 
 module R18n
   # String, which is translated to some locale and loading from Translation.
@@ -36,7 +36,7 @@ module R18n
     end
 
     # Return self for translated string.
-    def |(default)
+    def |(_other)
       self
     end
 
@@ -60,18 +60,18 @@ module R18n
     end
 
     # Define `as_json` for ActiveSupport compatibility.
-    def as_json(options = nil)
+    def as_json(_options = nil)
       to_str
     end
 
     # Override marshal_dump to avoid Marshalizing filter procs
-    def _dump(limit)
-      [@locale.code, @path, to_str].join(":")
+    def _dump(_limit)
+      [@locale.code, @path, to_str].join(':')
     end
 
     # Load object from Marshalizing.
     def self._load(str)
-      arr = str.split(":", 3)
+      arr = str.split(':', 3)
       new arr[2], R18n.locale(arr[0]), arr[1]
     end
 
@@ -83,7 +83,7 @@ module R18n
     end
 
     # Return untranslated, when user try to go deeper in translation.
-    def method_missing(name, *params)
+    def method_missing(name, *_params)
       get_untranslated(name.to_s)
     end
   end

data/lib/r18n-core/translation.rb

@@ -1,23 +1,21 @@
-=begin
-Translation to i18n support.
+# frozen_string_literal: true
 
-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'
+# Translation to 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/>.
 
 module R18n
   # Struct to containt translation with some type for filter.
@@ -83,13 +81,15 @@ module R18n
     # Add another hash with +translations+ for some +locale+. Current data is
     # more priority, that new one in +translations+.
     def merge!(translations, locale)
-      (translations || { }).each_pair do |name, value|
-        if not @data.has_key? name
+      (translations || {}).each_pair do |name, value|
+        if !@data.key?(name)
           path = @path.empty? ? name : "#{@path}.#{name}"
           case value
           when Hash
-            value = Translation.new(@locale, path,
-              locale: locale, translations: value, filters: @filters)
+            value = Translation.new(
+              @locale, path,
+              locale: locale, translations: value, filters: @filters
+            )
           when String
             c = { locale: locale, path: path }
             v = @filters.process_string(:passive, value, c, [])
@@ -98,11 +98,11 @@ module R18n
             value.locale = locale
             value.path   = path
             unless @filters.passive(value.type).empty?
-              value = @filters.process_typed(:passive, value, { })
+              value = @filters.process_typed(:passive, value, {})
             end
           end
           @data[name] = value
-        elsif @data[name].is_a? Translation and value.is_a? Hash
+        elsif @data[name].is_a?(Translation) && value.is_a?(Hash)
           @data[name].merge! value, locale
         end
       end
@@ -110,8 +110,9 @@ module R18n
 
     # Use untranslated filter to print path.
     def to_s
-      @filters.process(:all, Untranslated, @path, @locale, @path,
-                      [@path, '', @path])
+      @filters.process(
+        :all, Untranslated, @path, @locale, @path, [@path, '', @path]
+      )
     end
 
     # Override inspect to easy debug.
@@ -136,8 +137,8 @@ module R18n
     end
 
     # Return +default+.
-    def |(default)
-      default
+    def |(other)
+      other
     end
 
     # Return translation with special +name+.
@@ -146,7 +147,7 @@ module R18n
     # <tt>%2</tt>, etc in translations file and set values in next +params+.
     def [](name, *params)
       unless [String, Integer, TrueClass, FalseClass]
-             .any? { |klass| name.is_a?(klass) }
+          .any? { |klass| name.is_a?(klass) }
         name = name.to_s
       end
       value = @data[name]

data/lib/r18n-core/unsupported_locale.rb

@@ -1,21 +1,21 @@
-=begin
-Locale withou information file to 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
+# frozen_string_literal: true
+
+# Locale withou information file to 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/>.
 
 module R18n
   # Locale without information file. Contain only it code, empty title and data
@@ -26,7 +26,7 @@ module R18n
 
     # Create object for unsupported locale with +code+ and load other locale
     # data from +base+ locale.
-    def initialize(code, base = nil)
+    def initialize(code, _base = nil)
       @code = code
       @base = Locale.load(I18n.default) if @code != I18n.default
     end
@@ -42,9 +42,7 @@ module R18n
     end
 
     # Locale RFC 3066 code.
-    def code
-      @code
-    end
+    attr_reader :code
 
     # Locale code as title.
     def title
@@ -52,8 +50,8 @@ module R18n
     end
 
     # Is another locale has same code.
-    def ==(locale)
-      @code.downcase == locale.code.downcase
+    def ==(other)
+      @code.casecmp(other.code).zero?
     end
 
     #  Proxy to default locale object.

data/lib/r18n-core/untranslated.rb

@@ -1,21 +1,21 @@
-=begin
-Untranslation string 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
+# frozen_string_literal: true
+
+# Untranslation string 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/>.
 
 module R18n
   # Return if translation isn’t exists. Unlike nil, it didn’t raise error when
@@ -63,20 +63,20 @@ module R18n
     end
 
     # Override marshal_dump to avoid Marshalizing filter procs
-    def _dump(limit)
-      [@locale.code, @translated_path, @untranslated_path].join(":")
+    def _dump(_limit)
+      [@locale.code, @translated_path, @untranslated_path].join(':')
     end
 
     # Load object from Marshalizing.
     def self._load(str)
-      arr = str.split(":", 3)
+      arr = str.split(':', 3)
       new arr[1], arr[2], R18n.locale(arr[0]), GlobalFilterList.instance
     end
 
-    def method_missing(name, *params)
+    def method_missing(name, *_params)
       # It is need to fix some hack in specs
       if name == :to_ary
-        raise NoMethodError, "undefined method `to_ary' for #{to_s}"
+        raise NoMethodError, "undefined method `to_ary' for #{self}"
       end
 
       self[name]
@@ -87,23 +87,25 @@ module R18n
                        @locale, @filters)
     end
 
-    def |(default)
-      default
+    def |(other)
+      other
     end
 
     def to_s
-      @filters.process(:all, Untranslated, path, @locale, path,
-                      [@translated_path, @untranslated_path, path])
+      @filters.process(
+        :all, Untranslated, path, @locale, path,
+        [@translated_path, @untranslated_path, path]
+      )
     end
 
-    alias :to_str :to_s
+    alias to_str to_s
 
     # Is another locale has same code.
-    def ==(untrsl)
-      return false unless untrsl.is_a? Untranslated
-      return false unless locale            == untrsl.locale
-      return false unless translated_path   == untrsl.translated_path
-      return false unless untranslated_path == untrsl.untranslated_path
+    def ==(other)
+      return false unless other.is_a? Untranslated
+      return false unless locale            == other.locale
+      return false unless translated_path   == other.translated_path
+      return false unless untranslated_path == other.untranslated_path
       true
     end
   end