i18nliner 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c65c8bd881edfdc231120af22f283b85770bfa2befdf3495d273848101393062
-  data.tar.gz: ce466b775c3e449efc57ba5d6083f59c8c5a0a63243a0301be8515dedca6c9f0
+  metadata.gz: 15cfd420213769dbeb319a5527cf831c0d8a26a9293862cf65f1ae41d1971006
+  data.tar.gz: 4dcbbefb5e7659feccbbf268fa7ee9e9cdf920bf8a2a61b37a87074ff5c86b5f
 SHA512:
-  metadata.gz: b4e7c18f79f693a815ea3f6b6b84f46be8b56d8e739cdf7c064e0d2632cef23138cfb1e75c344077c44ace0f9c63d4b79cce32f19c8df9a79a28f7a07a71e92d
-  data.tar.gz: 8455844299eeca26b8d017e17ccfca90172d597f942b5331069e2b07e409167e425c16ceb8d59511066b5035c96bdee587f1c2fa0abe6793987fc4d40a4cc3be
+  metadata.gz: 63d0eb0cdb5fe84bb5d702c38bc52c2cf615c566e095c28a1a56a54d54ca77fc5b7f8276c2493a0ba68d644639fdd96939ec7dc4cc69f15e489c99a27cdba7ae
+  data.tar.gz: 851f0e3161a6242e063c36b88e558c52f8bb9f74c79433248f6af4fea0f513893c1129d3c96898b39656fd4e7e4c7573bb96ab5ea166c87833f12a9723d6625b

data/Rakefile

@@ -1,10 +1,12 @@
-require 'rake'
-require 'bundler/gem_tasks'
+# frozen_string_literal: true
 
-require 'rspec/core'
-require 'rspec/core/rake_task'
+require "rake"
+require "bundler/gem_tasks"
+
+require "rspec/core"
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.pattern = FileList["spec/**/*_spec.rb"]
 end
 
-task :default => :spec
+task default: :spec

data/lib/i18nliner/base.rb

@@ -1,17 +1,16 @@
-require 'i18n'
+# frozen_string_literal: true
+
+require "i18n"
 
 module I18nliner
   def self.ignore
     @ignore ||= begin
       path = File.join(base_path, ".i18nignore")
-      File.exist?(path) ?
-        File.read(path).split(/\r?\n|\r/) :
-        []
+      File.exist?(path) ? File.read(path).split(/\r?\n|\r/) : []
     end
   end
 
-  def self.translations
-  end
+  def self.translations; end
 
   def self.manual_translations
     I18n.t(:foo) # ensure backend is initialized
@@ -19,31 +18,31 @@ module I18nliner
     I18n.backend.send(:translations)[I18n.default_locale]
   end
 
-  def self.look_up(key)
+  def self.look_up(key) # rubocop:disable Naming/PredicateMethod
     I18n.exists?(I18n.locale, key)
   end
 
   def self.setting(key, value)
-    instance_eval <<-CODE
-      def #{key}=(value)
-        @#{key} = value
-      end
-
-      def #{key}(value = nil)
-        if value && block_given?
-          begin
-            value_was = @#{key}
-            @#{key} = value
-            yield
-          ensure
-            @#{key} = value_was
-          end
-        else
-          @#{key} = #{value.inspect} if @#{key}.nil?
-          @#{key}
-        end
-      end
-    CODE
+    instance_eval <<~RUBY, __FILE__, __LINE__ + 1
+      def #{key}=(value)                              # def base_path=(value)
+        @#{key} = value                               #   @base_path = value
+      end                                             # end
+                                                      #
+      def #{key}(value = nil)                         # def base_path(value = nil)
+        if value && block_given?                      #   if value && block_given?
+          begin                                       #     begin
+            value_was = @#{key}                       #       value_was = @base_path
+            @#{key} = value                           #       @base_path = value
+            yield                                     #       yield
+          ensure                                      #     ensure
+            @#{key} = value_was                       #       @base_path = value_was
+          end                                         #     end
+        else                                          #   else
+          @#{key} = #{value.inspect} if @#{key}.nil?  #     @base_path = "./" if @base_path.nil?
+          @#{key}                                     #     @base_path
+        end                                           #   end
+      end                                             # end
+    RUBY
   end
 
   setting :inferred_key_format,        :underscored_crc32

data/lib/i18nliner/call_helpers.rb

@@ -1,12 +1,16 @@
-require 'zlib'
-require 'i18n'
-require 'active_support/core_ext/string/inflections'
-require 'i18nliner/base'
+# frozen_string_literal: true
+
+require "zlib"
+require "i18n"
+require "active_support/core_ext/string/inflections"
+require "i18nliner/base"
 
 module I18nliner
   module CallHelpers
-    ALLOWED_PLURALIZATION_KEYS = [:zero, :one, :few, :many, :other]
-    REQUIRED_PLURALIZATION_KEYS = [:one, :other]
+    ALLOWED_PLURALIZATION_KEYS = %i[zero one few many other].freeze
+    REQUIRED_PLURALIZATION_KEYS = %i[one other].freeze
+
+    module_function
 
     def normalize_key(key, scope, inferred, i18n_scope)
       scope.normalize_key(key, inferred, i18n_scope)
@@ -14,8 +18,7 @@ module I18nliner
 
     def normalize_default(default, translate_options = {}, options = {})
       default = infer_pluralization_hash(default, translate_options)
-      default = normalize_whitespace(default, options)
-      default
+      normalize_whitespace(default, options)
     end
 
     def normalize_whitespace(default, options)
@@ -27,14 +30,14 @@ module I18nliner
         default.each { |key, value| default[key] = normalize_whitespace(value, options) }
         return default
       elsif default.is_a?(Array)
-        return default.map{|value| value.is_a?(String) ? normalize_whitespace(value, options) : value}
+        return default.map { |value| value.is_a?(String) ? normalize_whitespace(value, options) : value }
       end
 
       if options[:remove_whitespace]
-        default.gsub!(/\s+/, ' ')
+        default.gsub!(/\s+/, " ")
         default.strip!
       else
-        default.sub!(/\s*\n\z/, '')
+        default.sub!(/\s*\n\z/, "")
         default.lstrip!
       end
       default
@@ -43,28 +46,30 @@ module I18nliner
     def infer_pluralization_hash(default, translate_options)
       str = (default.is_a?(Array) && default.size == 1) ? default.first : default
       return default unless str.is_a?(String) &&
-                            str =~ /\A[\w\-]+\z/ &&
+                            str =~ /\A[\w-]+\z/ &&
                             translate_options.include?(:count)
-      {:one => "1 #{str}", :other => "%{count} #{str.pluralize}"}
+
+      { one: "1 #{str}", other: "%{count} #{str.pluralize}" }
     end
 
     def infer_key(default, translate_options = {})
       return unless default && (default.is_a?(String) || default.is_a?(Hash))
-      default = normalize_default(default, translate_options, :remove_whitespace => true)
+
+      default = normalize_default(default, translate_options, remove_whitespace: true)
       default = default[:other].to_s if default.is_a?(Hash)
       keyify(default)
     end
 
     def keyify_underscored(string)
-      key = I18n.transliterate(string, :locale => I18n.default_locale).to_s
+      key = I18n.transliterate(string, locale: I18n.default_locale).to_s
       key.downcase!
-      key.gsub!(/[^a-z0-9_]+/, '_')
-      key.gsub!(/\A_|_\z/, '')
+      key.gsub!(/[^a-z0-9_]+/, "_")
+      key.gsub!(/\A_|_\z/, "")
       key[0...I18nliner.underscored_key_length]
     end
 
     def keyify_underscored_crc32(string)
-      checksum = Zlib.crc32("#{string.size.to_s}:#{string}").to_s(16)
+      checksum = Zlib.crc32("#{string.size}:#{string}").to_s(16)
       "#{keyify_underscored(string)}_#{checksum}"
     end
 
@@ -83,27 +88,30 @@ module I18nliner
     # key, default_hash, options
     # default_string [, options]
     # default_hash, options
-    def key_provided?(key_or_default = nil, default_or_options = nil, maybe_options = nil, *others)
+    def key_provided?(key_or_default = nil, default_or_options = nil, maybe_options = nil, *)
       return false if key_or_default.is_a?(Hash)
       return true if key_or_default.is_a?(Symbol) || key_or_default.nil? || key_or_default.is_a?(Array)
-      raise ArgumentError.new("invalid key_or_default argument. expected String, Symbol, Array, Hash or nil, got #{key_or_default.class}") unless key_or_default.is_a?(String)
+
+      unless key_or_default.is_a?(String)
+        raise ArgumentError, "invalid key_or_default argument. " \
+                             "expected String, Symbol, Array, Hash or nil, got #{key_or_default.class}"
+      end
       return true if default_or_options.is_a?(String)
       return true if maybe_options
-      return true if key_or_default =~ /\A\.?(\w+\.)+\w+\z/
+      return true if /\A\.?(\w+\.)+\w+\z/.match?(key_or_default)
+
       false
     end
 
     def pluralization_hash?(hash)
       hash.is_a?(Hash) &&
-      hash.size > 0 &&
-      (hash.keys - ALLOWED_PLURALIZATION_KEYS).size == 0
+        !hash.empty? &&
+        (hash.keys - ALLOWED_PLURALIZATION_KEYS).empty?
     end
 
     def infer_arguments(args)
-      raise ArgumentError.new("wrong number of arguments (#{args.size} for 1..3)") if args.empty? || args.size > 3
-      if args.size == 2 && args[1].is_a?(Hash) && args[1][:default]
-        return args
-      end
+      raise ArgumentError, "wrong number of arguments (#{args.size} for 1..3)" if args.empty? || args.size > 3
+      return args if args.size == 2 && args[1].is_a?(Hash) && args[1][:default]
 
       has_key = key_provided?(*args)
       args.unshift nil unless has_key
@@ -115,16 +123,16 @@ module I18nliner
       end
       args << {} if args.size == 1
       options = args[1]
-      raise ArgumentError.new("invalid default translation. expected Hash or String, got #{default.class}") unless default.nil? || default.is_a?(String) || default.is_a?(Hash)
-      raise ArgumentError.new("invalid options argument. expected Hash, got #{options.class}") unless options.is_a?(Hash)
+      unless default.nil? || default.is_a?(String) || default.is_a?(Hash)
+        raise ArgumentError,
+              "invalid default translation. expected Hash or String, got #{default.class}"
+      end
+      raise ArgumentError, "invalid options argument. expected Hash, got #{options.class}" unless options.is_a?(Hash)
+
       options[:default] = default if default
       options[:i18nliner_inferred_key] = true unless has_key
-      unless has_key
-        args[0] = infer_key(default, options)
-      end
+      args[0] = infer_key(default, options) unless has_key
       args
     end
-
-    extend self
   end
 end

data/lib/i18nliner/commands/basic_formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module I18nliner
   module Commands
     module BasicFormatter

data/lib/i18nliner/commands/check.rb

@@ -1,6 +1,8 @@
-require 'i18nliner/commands/generic_command'
-require 'i18nliner/extractors/translation_hash'
-require 'active_support/core_ext/enumerable'
+# frozen_string_literal: true
+
+require "i18nliner/commands/generic_command"
+require "i18nliner/extractors/translation_hash"
+require "active_support/core_ext/enumerable"
 Dir[File.join(File.dirname(__FILE__), "../processors/*.rb")].each do |file|
   require "i18nliner/processors/#{File.basename(file)}"
 end
@@ -19,22 +21,20 @@ module I18nliner
       def processors
         @processors ||= I18nliner::Processors.all.map do |klass|
           klass.new @translations,
-                    :only => @options[:only],
-                    :translations => @translations,
-                    :checker => method(:check_file)
+                    only: @options[:only],
+                    translations: @translations,
+                    checker: method(:check_file)
         end
       end
 
       def check_files
-        processors.each &:check_files
+        processors.each(&:check_files)
       end
 
       def check_file(file)
-        if yield file
-          print green(".") unless @options[:silent]
-        end
-      rescue SyntaxError, StandardError, ExtractionError
-        @errors << "#{$!}\n#{file}"
+        print green(".") if yield(file) && !@options[:silent]
+      rescue SyntaxError, StandardError, ExtractionError => e
+        @errors << "#{e}\n#{file}"
         print red("F") unless @options[:silent]
       end
 
@@ -49,7 +49,7 @@ module I18nliner
         print "\n\n"
 
         @errors.each_with_index do |error, i|
-          puts "#{i+1})"
+          puts "#{i + 1})"
           puts red(error)
           print "\n"
         end
@@ -59,7 +59,7 @@ module I18nliner
         puts success? ? green(summary) : red(summary)
       end
 
-      def run
+      def run # rubocop:disable Naming/PredicateMethod
         check_files
         print_summary unless @options[:silent]
         success?

data/lib/i18nliner/commands/color_formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module I18nliner
   module Commands
     module ColorFormatter

data/lib/i18nliner/commands/dump.rb

@@ -1,5 +1,7 @@
-require 'ya2yaml'
-require 'fileutils'
+# frozen_string_literal: true
+
+require "ya2yaml"
+require "fileutils"
 
 module I18nliner
   module Commands
@@ -10,14 +12,12 @@ module I18nliner
         super
         @translations = @options[:translations]
         @yml_file = @options[:file] ||
-          File.join(I18nliner.base_path, "config", "locales", "generated", "#{I18n.default_locale}.yml")
+                    File.join(I18nliner.base_path, "config", "locales", "generated", "#{I18n.default_locale}.yml")
       end
 
       def run
         FileUtils.mkdir_p File.dirname(yml_file)
-        File.open(yml_file, "w") do |file|
-          file.write({I18n.default_locale.to_s => @translations}.ya2yaml(:syck_compatible => true))
-        end
+        File.write(yml_file, { I18n.default_locale.to_s => @translations }.ya2yaml(syck_compatible: true))
         puts "Wrote default translations to #{yml_file}" unless @options[:silent]
       end
     end

data/lib/i18nliner/commands/generic_command.rb

@@ -1,5 +1,7 @@
-require 'i18nliner/commands/basic_formatter'
-require 'i18nliner/commands/color_formatter'
+# frozen_string_literal: true
+
+require "i18nliner/commands/basic_formatter"
+require "i18nliner/commands/color_formatter"
 
 module I18nliner
   module Commands

data/lib/i18nliner/controller_scope.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "i18nliner/scope"
 
 module I18nliner

data/lib/i18nliner/errors.rb

@@ -1,17 +1,18 @@
+# frozen_string_literal: true
+
 module I18nliner
   class ExtractionError < StandardError
     def initialize(line, detail = nil)
+      super()
       @line = line
       @detail = detail
     end
 
     def to_s
       error = self.class.name.underscore.humanize
-      error.gsub!(/\AI18nliner\/| error\z/, '')
+      error.gsub!(%r{\AI18nliner/| error\z}, "")
       error = "#{error} on line #{@line}"
-      @detail ?
-        error + " (got #{@detail.inspect})" :
-        error
+      @detail ? error + " (got #{@detail.inspect})" : error
     end
   end
 

data/lib/i18nliner/erubi.rb

@@ -1,12 +1,13 @@
-require 'action_view/template'
-require 'i18nliner/pre_processors/erb_pre_processor'
+# frozen_string_literal: true
+
+require "action_view/template"
+require "i18nliner/pre_processors/erb_pre_processor"
 
 module I18nliner
   class Erubi < ::ActionView::Template::Handlers::ERB::Erubi
     def initialize(source, options = {})
       source = I18nliner::PreProcessors::ErbPreProcessor.new(source).result
-      super(source, options)
+      super
     end
   end
 end
-

data/lib/i18nliner/erubis.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "i18nliner/erubi"
 
 module I18nliner

data/lib/i18nliner/extensions/controller.rb

@@ -1,6 +1,8 @@
-require 'i18nliner/base'
-require 'i18nliner/call_helpers'
-require 'i18nliner/extensions/inferpolation'
+# frozen_string_literal: true
+
+require "i18nliner/base"
+require "i18nliner/call_helpers"
+require "i18nliner/extensions/inferpolation"
 
 module I18nliner
   module Extensions
@@ -15,11 +17,9 @@ module I18nliner
         options[:i18nliner_scope] = i18nliner_scope
         super(key, **options)
       end
-      alias :t :translate
-      alias :t! :translate
-      alias :translate! :translate
+      alias_method :t, :translate
+      alias_method :t!, :translate
+      alias_method :translate!, :translate
     end
   end
 end
-
-

data/lib/i18nliner/extensions/core.rb

@@ -1,6 +1,8 @@
-require 'i18nliner/scope'
-require 'i18nliner/call_helpers'
-require 'active_support/core_ext/string/output_safety'
+# frozen_string_literal: true
+
+require "i18nliner/scope"
+require "i18nliner/call_helpers"
+require "active_support/core_ext/string/output_safety"
 
 module I18nliner
   module Extensions
@@ -12,7 +14,7 @@ module I18nliner
         inferred_key = options.delete(:i18nliner_inferred_key)
         key = CallHelpers.normalize_key(key, scope, inferred_key, options[:scope])
 
-        if default = options[:default]
+        if (default = options[:default])
           options[:default] = CallHelpers.normalize_default(default, options)
         end
 
@@ -26,24 +28,20 @@ module I18nliner
         # If you are actually using nonprintable characters in your source string, you should feel ashamed
         result = result.gsub("\\\\", "\uE124").gsub("\\*", "\uE123")
         result = result.html_safe if was_html_safe
-        if wrappers
-          result = apply_wrappers(result, wrappers)
-        end
+        result = apply_wrappers(result, wrappers) if wrappers
         was_html_safe = result.html_safe?
-        result = result.gsub("\uE123", '*').gsub("\uE124", "\\")
+        result = result.tr("\uE123\uE124", "*\\")
         result = result.html_safe if was_html_safe
 
         result
-      rescue ArgumentError
-        raise
       end
-      alias :t :translate
-      alias :t! :translate
-      alias :translate! :translate
+      alias_method :t, :translate
+      alias_method :t!, :translate
+      alias_method :translate!, :translate
 
       # can't super this one yet :-/
       def interpolate_hash_with_html_safety(string, values)
-        if string.html_safe? || values.values.any?{ |v| v.is_a?(ActiveSupport::SafeBuffer) }
+        if string.html_safe? || values.values.any?(ActiveSupport::SafeBuffer)
           string = ERB::Util.h(string) unless string.html_safe?
           values.each do |key, value|
             values[key] = ERB::Util.h(value) unless value.html_safe?
@@ -61,22 +59,22 @@ module I18nliner
         end
       end
 
-     private
+      private
 
       def apply_wrappers(string, wrappers)
         string = string.html_safe? ? string.dup : ERB::Util.h(string)
         unless wrappers.is_a?(Hash)
           wrappers = Array(wrappers)
-          wrappers = Hash[wrappers.each_with_index.map{ |w, i| ['*' * (1 + i), w]}]
+          wrappers = wrappers.each_with_index.to_h { |w, i| ["*" * (1 + i), w] }
         end
         # If you are actually using nonprintable characters in your source string, you should feel ashamed
         string.gsub!("\\\\", 26.chr)
         string.gsub!("\\*", 27.chr)
-        wrappers.sort_by{ |k, v| -k.length }.each do |k, v|
+        wrappers.sort_by { |k, _v| -k.length }.each do |k, v|
           pattern = pattern_for(k)
           string.gsub!(pattern, v)
         end
-        string.gsub!(27.chr, '*')
+        string.gsub!(27.chr, "*")
         string.gsub!(26.chr, "\\")
         string.html_safe
       end

data/lib/i18nliner/extensions/inferpolation.rb

@@ -1,32 +1,36 @@
+# frozen_string_literal: true
+
 module I18nliner
   module Extensions
     module Inferpolation
       def inferpolate(options)
         default = options[:default]
         return options unless default
+
         if default.is_a?(Hash)
-          default.each { |key, value| inferpolate_value!(value, options) }
+          default.each_value { |value| inferpolate_value(value, options) }
         else
-          inferpolate_value!(default, options)
+          options[:default] = inferpolate_value(default, options)
         end
 
         options
       end
 
-      def inferpolate_value!(value, options)
-        value.gsub!(/%\{((@)?\w+(.\w+)*)\}/).each do
-          match = $~
+      def inferpolate_value(value, options)
+        value.gsub(/%\{((@)?\w+(.\w+)*)\}/) do |match|
           key = $1
           ivar = $2
           next match if options[key] || options[key.to_sym]
-          parts = key.split('.')
+
+          parts = key.split(".")
           receiver = ivar ? instance_variable_get(parts.shift) : self
           value = parts.inject(receiver) do |obj, message|
             obj.respond_to?(message) ? obj.send(message) : nil
           end
 
           next match if value.nil?
-          new_key = key.sub(/\@/, '').gsub('.', '_')
+
+          new_key = key.delete("@").tr(".", "_")
           options[new_key.to_sym] = value
           "%{#{new_key}}"
         end

data/lib/i18nliner/extensions/model.rb

@@ -1,6 +1,8 @@
-require 'i18nliner/base'
-require 'i18nliner/call_helpers'
-require 'i18nliner/extensions/inferpolation'
+# frozen_string_literal: true
+
+require "i18nliner/base"
+require "i18nliner/call_helpers"
+require "i18nliner/extensions/inferpolation"
 
 module I18nliner
   module Extensions
@@ -15,14 +17,14 @@ module I18nliner
         options[:i18nliner_scope] = i18nliner_scope
         I18n.translate(key, **options)
       end
-      alias :t :translate
-      alias :t! :translate
-      alias :translate! :translate
+      alias_method :t, :translate
+      alias_method :t!, :translate
+      alias_method :translate!, :translate
 
-      def localize(*args)
-        I18n.localize(*args)
+      def localize(*)
+        I18n.localize(*)
       end
-      alias :l :localize
+      alias_method :l, :localize
 
       def self.included(klass)
         klass.extend(self)
@@ -30,4 +32,3 @@ module I18nliner
     end
   end
 end
-

data/lib/i18nliner/extensions/view.rb

@@ -1,6 +1,8 @@
-require 'i18nliner/base'
-require 'i18nliner/call_helpers'
-require 'i18nliner/extensions/inferpolation'
+# frozen_string_literal: true
+
+require "i18nliner/base"
+require "i18nliner/call_helpers"
+require "i18nliner/extensions/inferpolation"
 
 module I18nliner
   module Extensions
@@ -13,17 +15,19 @@ module I18nliner
         # if a block gets through to here, it either means:
         # 1. the user did something weird (e.g. <%= t{ "haha" } %>)
         # 2. the erb pre processor missed it somehow (bug)
-        raise InvalidBlockUsageError.new("block translate calls need to be output (i.e. `<%=`) and the block body must be of the form `%>your string<%`") if block_given?
+        if block_given?
+          raise InvalidBlockUsageError, "block translate calls need to be output (i.e. `<%=`) " \
+                                        "and the block body must be of the form `%>your string<%`"
+        end
+
         key, options = CallHelpers.infer_arguments(args)
         options = inferpolate(options) if I18nliner.infer_interpolation_values
         options[:i18nliner_scope] = i18nliner_scope
         super(key, **options)
-      rescue ArgumentError
-        raise
       end
-      alias :t :translate
-      alias :t! :translate
-      alias :translate! :translate
+      alias_method :t, :translate
+      alias_method :t!, :translate
+      alias_method :translate!, :translate
     end
   end
 end