i18nliner 0.2.4 → 0.3.0

data/lib/i18nliner/extractors/ruby_extractor.rb

@@ -1,15 +1,17 @@
-require 'sexp_processor'
-require 'i18nliner/errors'
-require 'i18nliner/extractors/translate_call'
-require 'i18nliner/extractors/sexp_helper'
+# frozen_string_literal: true
+
+require "sexp_processor"
+require "i18nliner/errors"
+require "i18nliner/extractors/translate_call"
+require "i18nliner/extractors/sexp_helper"
 
 module I18nliner
   module Extractors
     class RubyExtractor < ::SexpProcessor
       include SexpHelper
 
-      TRANSLATE_CALLS = [:t, :translate]
-      attr_reader :current_line
+      TRANSLATE_CALLS = %i[t translate].freeze
+      attr_reader :current_line, :current_defn
 
       def self.pattern
         /(^|\W)(t|translate)(\W|$)/
@@ -26,13 +28,12 @@ module I18nliner
         process(@sexps)
       end
 
-      attr_reader :current_defn
       def process_defn(exp)
         exp.shift
         @current_defn = exp.shift
         process exp.shift until exp.empty?
         @current_defn = nil
-        s()
+        s
       end
 
       def process_call(exp)
@@ -40,7 +41,7 @@ module I18nliner
         receiver_exp = exp.shift
         receiver = nil
         if receiver_exp
-          receiver = receiver_exp[0] == :const ? receiver_exp.last : UnsupportedExpression
+          receiver = (receiver_exp[0] == :const) ? receiver_exp.last : UnsupportedExpression
           process(receiver_exp)
         end
         method = exp.shift
@@ -48,7 +49,7 @@ module I18nliner
         if extractable_call?(receiver, method)
           @current_line = exp.line
 
-          # convert s-exps into literals where possible 
+          # convert s-exps into literals where possible
           args = process_arguments(exp)
 
           process_translate_call(receiver, method, args)
@@ -61,7 +62,7 @@ module I18nliner
         s
       end
 
-     protected
+      protected
 
       def extractable_call?(receiver, method)
         TRANSLATE_CALLS.include?(method) && (receiver.nil? || receiver == :I18n)
@@ -69,15 +70,15 @@ module I18nliner
 
       def process_translate_call(receiver, method, args)
         scope = receiver ? Scope.root : @scope
-        call = TranslateCall.new(scope, @current_line, method, args, :explicit_receiver => !receiver.nil?)
-        call.translations.each &@block
+        call = TranslateCall.new(scope, @current_line, method, args, explicit_receiver: !receiver.nil?)
+        call.translations.each(&@block)
       end
 
-     private
+      private
 
       def process_arguments(args)
         values = []
-        while arg = args.shift
+        while (arg = args.shift)
           values << evaluate_expression(arg)
         end
         values
@@ -90,13 +91,14 @@ module I18nliner
         return raw(exp) if exp.sexp_type == :lit
         return string_from(exp) if stringish?(exp)
         return hash_from(exp) if exp.sexp_type == :hash
+
         process(exp)
         UnsupportedExpression
       end
 
       def hash_from(exp)
         exp.shift
-        values = exp.map{ |e| evaluate_expression(e) }
+        values = exp.map { |e| evaluate_expression(e) }
         Hash[*values]
       end
     end

data/lib/i18nliner/extractors/sexp_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module I18nliner
   module Extractors
     module SexpHelper
@@ -7,18 +9,19 @@ module I18nliner
 
       def string_concatenation?(exp)
         exp.sexp_type == :call &&
-        exp[2] == :+ &&
-        exp.last &&
-        exp.last.sexp_type == :str
+          exp[2] == :+ &&
+          exp.last &&
+          exp.last.sexp_type == :str
       end
 
       def raw(exp)
         exp.shift
-        return exp.shift
+        exp.shift
       end
 
       def string_from(exp)
         return raw(exp) if exp.sexp_type == :str
+
         exp.shift
         lhs = exp.shift
         exp.shift
@@ -33,7 +36,7 @@ module I18nliner
         end
       end
 
-      class UnsupportedExpression; end
+      UnsupportedExpression = Object.new.freeze
     end
   end
 end

data/lib/i18nliner/extractors/translate_call.rb

@@ -1,7 +1,9 @@
-require 'active_support/core_ext/string/inflections'
-require 'i18nliner/base'
-require 'i18nliner/call_helpers'
-require 'i18nliner/errors'
+# frozen_string_literal: true
+
+require "active_support/core_ext/string/inflections"
+require "i18nliner/base"
+require "i18nliner/call_helpers"
+require "i18nliner/errors"
 
 module I18nliner
   module Extractors
@@ -30,48 +32,48 @@ module I18nliner
 
       def normalize
         @key = normalize_key(@key, @scope, @options[:i18nliner_inferred_key], @options[:scope])
-        @default = normalize_default(@default, @options || {}, {:remove_whitespace => @scope.remove_whitespace?})
+        @default = normalize_default(@default, @options || {}, { remove_whitespace: @scope.remove_whitespace? })
       end
 
       def translations
         return [] unless default
+
         keys = Array(key)
         keys.inject([]) do |result, key|
           if default.is_a?(String)
             result << [key, default]
           else
-            result.concat default.map { |dk, dv| ["#{key}.#{dk}", dv] }
+            result.concat(default.map { |dk, dv| ["#{key}.#{dk}", dv] })
           end
         end
       end
 
-      def validate_key
-      end
+      def validate_key; end
 
       def validate_default
         return unless @default.is_a?(Hash)
-        if (keys = @default.keys - ALLOWED_PLURALIZATION_KEYS).size > 0
+        if (keys = @default.keys - ALLOWED_PLURALIZATION_KEYS).size.positive?
           raise InvalidPluralizationKeyError.new(@line, keys)
         elsif REQUIRED_PLURALIZATION_KEYS & (keys = @default.keys) != REQUIRED_PLURALIZATION_KEYS
           raise MissingPluralizationKeyError.new(@line, keys)
         else
-          @default.values.each do |value|
+          @default.each_value do |value|
             raise InvalidPluralizationDefaultError.new(@line, value) unless value.is_a?(String)
           end
         end
 
-        unless I18nliner.infer_interpolation_values
-          if @default.is_a?(String)
-            validate_interpolation_values(@key, @default)
-          else
-            @default.each_pair do |sub_key, default|
-              validate_interpolation_values("#{@key}.#{sub_key}", default)
-            end
+        return if I18nliner.infer_interpolation_values
+
+        if @default.is_a?(String)
+          validate_interpolation_values(@default)
+        else
+          @default.each_value do |default|
+            validate_interpolation_values(default)
           end
         end
       end
 
-     private
+      private
 
       # Possible translate signatures:
       #
@@ -85,26 +87,29 @@ module I18nliner
         @default = @options.delete(:default)
         @default = nil if @default.is_a?(Symbol)
         @default = @default.detect { |d| d.is_a?(String) } if @default.is_a?(Array)
-        raise InvalidSignatureError.new(@line, args) unless @default.nil? || @default.is_a?(String) || @default.is_a?(Hash)
+        unless @default.nil? || @default.is_a?(String) || @default.is_a?(Hash)
+          raise InvalidSignatureError.new(@line,
+                                          args)
+        end
       rescue ArgumentError
         raise InvalidSignatureError.new(@line, args)
       end
 
-      def validate_interpolation_values(key, default)
-        default.scan(/%\{([^\}]+)\}/) do |match|
+      def validate_interpolation_values(default)
+        default.scan(/%\{([^}]+)\}/) do |match|
           placeholder = match[0].to_sym
           next if @options.include?(placeholder)
+
           raise MissingInterpolationValueError.new(@line, placeholder)
         end
       end
 
       def validate_options
-        if @default.is_a?(Hash)
-          raise MissingCountValueError.new(@line) unless @options && @options.key?(:count)
-        end
+        raise MissingCountValueError, @line if @default.is_a?(Hash) && !@options&.key?(:count)
         return if @options.nil?
-        @options.keys.each do |key|
-          raise InvalidOptionKeyError.new(@line) unless key.is_a?(String) || key.is_a?(Symbol)
+
+        @options.each_key do |key|
+          raise InvalidOptionKeyError, @line unless key.is_a?(String) || key.is_a?(Symbol)
         end
       end
     end

data/lib/i18nliner/extractors/translation_hash.rb

@@ -1,12 +1,13 @@
+# frozen_string_literal: true
+
 module I18nliner
   module Extractors
     class TranslationHash < Hash
       attr_accessor :line
 
       def self.new(hash = {})
-        hash.inject(super()) do |result, (key, value)|
+        hash.each_with_object(super()) do |(key, value), result|
           result.store(key.to_s, value.is_a?(Hash) ? new(value) : value)
-          result
         end
       end
 
@@ -16,13 +17,13 @@ module I18nliner
       end
 
       def []=(key, value)
-        parts = key.split('.')
+        parts = key.split(".")
         leaf = parts.pop
         hash = self
-        while part = parts.shift
+        while (part = parts.shift)
           if hash[part]
             unless hash[part].is_a?(Hash)
-              intermediate_key = key.sub((parts + [leaf]).join('.'), '')
+              intermediate_key = key.sub((parts + [leaf]).join("."), "")
               raise KeyAsScopeError, intermediate_key
             end
           else
@@ -32,11 +33,10 @@ module I18nliner
         end
         if hash[leaf]
           if hash[leaf] != value
-            if hash[leaf].is_a?(Hash)
-              raise KeyAsScopeError.new(@line, key)
-            else
-              raise KeyInUseError.new(@line, key)
-            end
+            raise KeyAsScopeError.new(@line, key) if hash[leaf].is_a?(Hash)
+
+            raise KeyInUseError.new(@line, key)
+
           end
         else
           @total_size += 1

data/lib/i18nliner/pre_processors/erb_pre_processor.rb

@@ -1,20 +1,19 @@
-require 'i18nliner/errors'
-require 'i18nliner/call_helpers'
-require 'i18nliner/extractors/sexp_helper'
-require 'nokogiri'
-require 'ruby_parser'
-require 'ruby2ruby'
+# frozen_string_literal: true
+
+require "i18nliner/errors"
+require "i18nliner/call_helpers"
+require "i18nliner/extractors/sexp_helper"
+require "nokogiri"
 
 module I18nliner
   module PreProcessors
     class ErbPreProcessor
-
       class Context
         attr_reader :buffer, :parent
 
         def initialize(parent = nil)
           @parent = parent
-          @buffer = ''
+          @buffer = +""
         end
 
         def <<(string)
@@ -35,14 +34,26 @@ module I18nliner
         include Extractors::SexpHelper
 
         DEFINITIONS = [
-          {:method => :link_to, :pattern => /link_to/, :arg => 0}
-        ]
-        RUBY2RUBY = Ruby2Ruby.new
-        PARSER = RubyParser.new
+          { method: :link_to, pattern: /link_to/, arg: 0 }
+        ].freeze
+
+        def self.parser
+          @parser ||= begin
+            require "prism"
+            Prism::Translation::RubyParser.new
+          end
+        end
+
+        def self.ruby2ruby
+          @ruby2ruby ||= begin
+            require "ruby2ruby"
+            Ruby2Ruby.new
+          end
+        end
 
         def self.match_for(string)
           DEFINITIONS.each do |info|
-            return Helper.new(info, string) if string =~ info[:pattern]
+            return Helper.new(info, string) if string&.match?(info[:pattern])
           end
           nil
         end
@@ -58,9 +69,10 @@ module I18nliner
 
         SEXP_ARG_OFFSET = 3
         def wrappable?
-          return @wrappable if !@wrappable.nil?
+          return @wrappable unless @wrappable.nil?
+
           begin
-            sexps = PARSER.parse(@source)
+            sexps = self.class.parser.parse(@source)
             @wrappable = sexps.sexp_type == :call &&
                          sexps[1].nil? &&
                          sexps[2] == @method &&
@@ -75,10 +87,10 @@ module I18nliner
           if stringish?(sexp)
             @content = string_from(sexp)
           else
-            @placeholder = RUBY2RUBY.process(sexp)
+            @placeholder = self.class.ruby2ruby.process(sexp)
           end
           sexps[@arg + SEXP_ARG_OFFSET] = Sexp.new(:str, "\\1")
-          @wrapper = RUBY2RUBY.process(sexps)
+          @wrapper = self.class.ruby2ruby.process(sexps)
         end
       end
 
@@ -93,17 +105,17 @@ module I18nliner
         def <<(string)
           case string
           when ERB_BLOCK_EXPRESSION
-            if string =~ ERB_T_BLOCK_EXPRESSION
-              TBlock.new(self, $&)
-            else
-              raise TBlockNestingError.new("can't nest block expressions inside a t block")
+            unless string =~ ERB_T_BLOCK_EXPRESSION
+              raise TBlockNestingError, "can't nest block expressions inside a t block"
             end
+
+            TBlock.new(self, $&)
+
           when ERB_STATEMENT
-            if string =~ ERB_END_STATEMENT
-              @parent << result
-            else
-              raise TBlockNestingError.new("can't nest statements inside a t block")
-            end
+            raise TBlockNestingError, "can't nest statements inside a t block" unless ERB_END_STATEMENT.match?(string)
+
+            @parent << result
+
           else
             # expressions and the like are handled a bit later
             # TODO: perhaps a tad more efficient to capture/transform them
@@ -119,7 +131,7 @@ module I18nliner
           result = "<%= t :#{key}, #{default}"
           result << ", " << options if options
           result << ", " << wrappers if wrappers
-          result << (@lines > 0 ? "\n" * @lines : " ")
+          result << (@lines.positive? ? "\n" * @lines : " ")
           result << "%>"
         end
 
@@ -127,10 +139,10 @@ module I18nliner
         # expression
         def infer_interpolation_key(string, others)
           key = string.downcase
-          key.sub!(/\.html_safe\z/, '')
-          key.gsub!(/[^a-z0-9]/, ' ')
+          key.delete_suffix!(".html_safe")
+          key.gsub!(/[^a-z0-9]/, " ")
           key.strip!
-          key.gsub!(/ +/, '_')
+          key.gsub!(/ +/, "_")
           key.slice!(20)
           i = 0
           base_key = key
@@ -143,12 +155,11 @@ module I18nliner
 
         def extract_wrappers!(source, wrappers, placeholder_map)
           source = extract_html_wrappers!(source, wrappers, placeholder_map)
-          source = extract_helper_wrappers!(source, wrappers, placeholder_map)
-          source
+          extract_helper_wrappers!(source, wrappers, placeholder_map)
         end
 
         def find_or_add_wrapper(wrapper, wrappers)
-          unless pos = wrappers.index(wrapper)
+          unless (pos = wrappers.index(wrapper))
             pos = wrappers.size
             wrappers << wrapper
           end
@@ -157,12 +168,12 @@ module I18nliner
 
         # incidentally this converts entities to their corresponding values
         def extract_html_wrappers!(source, wrappers, placeholder_map)
-          default = ''
+          default = +""
           nodes = Nokogiri::HTML.fragment(source).children
           nodes.each do |node|
             if node.is_a?(Nokogiri::XML::Text)
               default << node.content
-            elsif text = extract_text(node)
+            elsif (text = extract_text(node))
               wrapper = node.to_s.sub(text, "\\\\1")
               wrapper = prepare_wrapper(wrapper, placeholder_map)
               pos = find_or_add_wrapper(wrapper, wrappers)
@@ -201,16 +212,16 @@ module I18nliner
         end
 
         def extract_temp_placeholders!
-          extract_placeholders!(@buffer, ERB_EXPRESSION, false) do |str, map|
+          extract_placeholders!(@buffer, ERB_EXPRESSION, wrap_placeholder: false) do |str, map|
             ["__I18NLINER_#{map.size}__", str]
           end
         end
 
-        def extract_placeholders!(buffer = @buffer, pattern = ERB_EXPRESSION, wrap_placeholder = true)
+        def extract_placeholders!(buffer = @buffer, pattern = ERB_EXPRESSION, wrap_placeholder: true)
           map = {}
-          buffer.gsub!(pattern) do |str|
-            key, str = yield($~[:content], map)
-            map[key] = str
+          buffer.gsub!(pattern) do
+            key, str2 = yield($~[:content], map)
+            map[key] = str2
             wrap_placeholder ? "%{#{key}}" : key
           end
           map
@@ -227,7 +238,7 @@ module I18nliner
           end
 
           default.strip!
-          default.gsub!(/\s+/, ' ')
+          default.gsub!(/\s+/, " ")
 
           key = infer_key(default, options)
           default = default.inspect
@@ -239,21 +250,23 @@ module I18nliner
         def options_to_ruby(options)
           options["i18nliner_inferred_key"] = "true"
           options.map do |key, value|
-            ":" << key << " => (" << value << ")"
+            ":#{key} => (#{value})"
           end.join(", ")
         end
 
         def wrappers_to_ruby(wrappers)
-          return if wrappers.size == 0
-          ":wrappers => [" << wrappers.join(", ") << "]"
+          return if wrappers.empty?
+
+          ":wrappers => [#{wrappers.join(", ")}]"
         end
 
         def extract_text(root_node)
           text = nil
           nodes = root_node.children.to_a
-          while node = nodes.shift
+          while (node = nodes.shift)
             if node.is_a?(Nokogiri::XML::Text) && !node.content.strip.empty?
-              raise UnwrappableContentError.new "multiple text nodes in html markup" if text
+              raise UnwrappableContentError, "multiple text nodes in html markup" if text
+
               text = node.content
             else
               nodes.concat node.children
@@ -264,7 +277,7 @@ module I18nliner
 
         def wrap(text, index)
           delimiter = "*" * index
-          "" << delimiter << text << delimiter
+          "#{delimiter}#{text}#{delimiter}"
         end
 
         def infer_wrappers(source)
@@ -282,7 +295,7 @@ module I18nliner
         <%=
         .*?
         (\sdo|\{)
-        (\s*\|[^\|]+\|)?
+        (\s*\|[^|]+\|)?
         \s*
         %>
         \z
@@ -326,7 +339,8 @@ module I18nliner
         #    since it's a no-go
         # TODO get line numbers for errors
         ctx = @source.split(ERB_TOKENIZER).inject(Context.new, :<<)
-        raise MalformedErbError.new('possibly unterminated block expression') if ctx.parent
+        raise MalformedErbError, "possibly unterminated block expression" if ctx.parent
+
         ctx.result
       end
     end

data/lib/i18nliner/processors/abstract_processor.rb

@@ -1,6 +1,8 @@
-require 'globby'
-require 'i18nliner/base'
-require 'i18nliner/processors'
+# frozen_string_literal: true
+
+require "globby"
+require "i18nliner/base"
+require "i18nliner/processors"
 
 module I18nliner
   module Processors
@@ -31,7 +33,9 @@ module I18nliner
       def check_files
         Dir.chdir(I18nliner.base_path) do
           files.each do |file|
-            @checker.call file, &method(:check_file)
+            @checker.call(file) do |file|
+              check_file(file)
+            end
           end
         end
       end
@@ -42,6 +46,7 @@ module I18nliner
       end
 
       def self.inherited(klass)
+        super
         Processors.register klass
       end
 

data/lib/i18nliner/processors/erb_processor.rb

@@ -1,15 +1,17 @@
-if defined?(::Rails)
-  require 'i18nliner/erubi'
+# frozen_string_literal: true
+
+if defined?(Rails)
+  require "i18nliner/erubi"
 else
-  require 'erubi'
+  require "erubi"
 end
-require 'i18nliner/processors/ruby_processor'
-require 'i18nliner/pre_processors/erb_pre_processor'
+require "i18nliner/processors/ruby_processor"
+require "i18nliner/pre_processors/erb_pre_processor"
 
 module I18nliner
   module Processors
     class ErbProcessor < RubyProcessor
-      default_pattern '*.erb'
+      default_pattern "*.erb"
 
       if defined?(::Rails) # block expressions and all that jazz
         def pre_process(source)
@@ -26,8 +28,8 @@ module I18nliner
       def scope_for(path)
         scope = path.dup
         if scope.sub!(VIEW_PATH, '\2')
-          scope = scope.gsub(/\/_?/, '.')
-          Scope.new(scope, :allow_relative => true, :remove_whitespace => true, :context => self)
+          scope = scope.gsub(%r{/_?}, ".")
+          Scope.new(scope, allow_relative: true, remove_whitespace: true, context: self)
         else
           Scope.root
         end

data/lib/i18nliner/processors/ruby_processor.rb

@@ -1,16 +1,19 @@
-require 'i18nliner/processors/abstract_processor'
-require 'i18nliner/extractors/ruby_extractor'
-require 'i18nliner/scope'
-require 'i18nliner/controller_scope'
+# frozen_string_literal: true
+
+require "i18nliner/processors/abstract_processor"
+require "i18nliner/extractors/ruby_extractor"
+require "i18nliner/scope"
+require "i18nliner/controller_scope"
 
 module I18nliner
   module Processors
     class RubyProcessor < AbstractProcessor
-      default_pattern '*.rb'
+      default_pattern "*.rb"
 
       def check_contents(source, scope = Scope.new)
-        return if source !~ Extractors::RubyExtractor.pattern
-        sexps = RubyParser.new.parse(pre_process(source))
+        return unless source&.match?(Extractors::RubyExtractor.pattern)
+
+        sexps = Prism::Translation::RubyParser.new.parse(pre_process(source))
         extractor = Extractors::RubyExtractor.new(sexps, scope)
         extractor.each_translation do |key, value|
           @translation_count += 1
@@ -28,14 +31,14 @@ module I18nliner
         def scope_for(path)
           scope = path.dup
           if scope.sub!(CONTROLLER_PATH, '\2')
-            scope = scope.gsub(/\/_?/, '.')
-            ControllerScope.new(scope, :allow_relative => true, :context => self)
+            scope = scope.gsub(%r{/_?}, ".")
+            ControllerScope.new(scope, allow_relative: true, context: self)
           else
             Scope.root
           end
         end
       else
-        def scope_for(path)
+        def scope_for(_path)
           Scope.root
         end
       end

data/lib/i18nliner/processors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module I18nliner
   module Processors
     def self.register(klass)