extract_i18n 0.3.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d5459b5c55363dfd1893ecafd4d3eb0bea7db570a54da421782a36750dfc50c
-  data.tar.gz: a9a335109c2ad690a9234f95e7bfe5a24fff8f5a5eb7d642031d3a402773a223
+  metadata.gz: 1d6886c7a13cbbe6698326a72004018aaea5f57e753a9fab278f4025181bdd01
+  data.tar.gz: 10172e9a05996706d92f314291137c13bb8c957a0a974e9d9852cd295cb45ceb
 SHA512:
-  metadata.gz: 756c430da5da81bf5e1a1211c43b1039cd17863e46f64b239d5eaf42c57fe45bc98dfc5f63a4974310a7ed77fa26efb1441d5aa2f036df655ea836589626d598
-  data.tar.gz: 98b61188778616f1cb643310e3dfd1d76f7cfc6e4b7d5b4b41b10296d26aa438034639133d4cedc5c43f2faacae69bed46fa94e33692519bbd5c22f720c06463
+  metadata.gz: dcc33ec2bfab6ec9970508beebb22f57266679c20df3d97ee1eeaea2650c97f052a037ee4ce46de109bc09984b96df7df6a3097edfcb66772e6156c330a466e6
+  data.tar.gz: 7d75f557e0a6e1074e504931fa4ea6985153589dd0307fdd08d51faf3d6173ae6a29a0c15c146fee2bbc490d4a201628c067ba5de12257d7999e6a1b13c0bc86

data/.github/workflows/verify.yml

@@ -22,8 +22,8 @@ jobs:
         run: bundle exec rspec
       - name: Build and publish gem
         uses: jstastny/publish-gem-to-github@master
+        continue-on-error: true
         with:
-          continue-on-error: true
           token: ${{ secrets.GITHUB_TOKEN }}
           owner: pludoni
 

data/README.md

@@ -12,15 +12,17 @@ This Gem **supports** the following source files:
 
 - Ruby files (controllers, models etc.) via Ruby-Parser, e.g. walking all Ruby Strings
 - Slim Views (via Regexp parser by [SlimKeyfy](https://github.com/phrase/slimkeyfy) (MIT License))
+- Vue templates
+  - will scan all texts and common string-attributes such as title, alt etc. for static strings and replace with vue-i18n's $t
+  - Caveats: because of limitations of the HTML/XML parser it will slightly transform the HTML, for example, self closing tags are expanded (e.g. ``<Component />`` will become ``<Component></Component>``). Also multi-line arrangements of attributes, tags etc. might produce unexpected results, so make sure to use Git and diff the result.
 - Vue Pug views
-  - Pug is very similar to slim and thus relatively good extractable via Regexp.
+  - Pug is very similar to slim and thus relatively well extractable via Regexp.
 - ERB views
   - by vendoring/extending https://github.com/ProGM/i18n-html_extractor (MIT License)
 
 CURRENTLY THERE IS **NO SUPPORT** FOR:
 
 - haml ( integrating https://github.com/shaiguitar/haml-i18n-extractor)
-- vue html templates ([Check out my vue pug converting script](https://gist.github.com/zealot128/6c41df1d33a810856a557971a04989f6))
 
 But I am open to integrating PRs for those!
 

data/lib/extract_i18n/adapters/adapter.rb

@@ -6,7 +6,12 @@ module ExtractI18n::Adapters
       case file_path
       when /\.rb$/ then RubyAdapter
       when /\.slim$/ then SlimAdapter
-      when /\.vue$/ then VueAdapter
+      when /\.vue$/
+        if File.read(file_path)[/lang=.pug./]
+          VuePugAdapter
+        else
+          VueAdapter
+        end
       end
     end
 

data/lib/extract_i18n/adapters/vue_adapter.rb

@@ -1,31 +1,138 @@
-# frozen_string_literal: true
-
+require 'nokogiri'
 module ExtractI18n::Adapters
-  class VueAdapter < SlimAdapter
-    def process_line(old_line)
-      @mode ||= :template
-      if old_line[/^<template/]
-        @mode = :template
-      elsif old_line[/^<script/]
-        @mode = :script
-      elsif old_line[/^<style/]
-        @mode = :style
-      end
-      if @mode != :template
-        return old_line
-      end
-      word = ExtractI18n::Slimkeyfy::Word.for('.vue').new(old_line)
-      ExtractI18n::Slimkeyfy::VueTransformer.new(word, @file_key).transform do |change|
-        if change.nil? # nothing to do
-          return old_line
+  class VueAdapter < Adapter
+    ATTRIBUTES_WITH_TEXT = %w[
+      title
+      alt
+      placeholder
+      label
+      description
+    ]
+    def run(original_content)
+      content2, replace_pairs = replace_camelcase_attributes(original_content)
+
+      doc = Nokogiri::HTML5.fragment(content2)
+      template = doc.at('template')
+      return original_content unless template
+      return original_content if template['lang']
+
+      nodes = template.xpath(".//text() | text()").select { |i| i.to_s.strip.length > 0 }
+
+      nodes.each do |node|
+        process_change(node)
+      end
+
+      ATTRIBUTES_WITH_TEXT.each do |attr|
+        template.search("*[#{attr}]").each do |node|
+          process_attribute_change(node, attr)
+        end
+      end
+
+      out = unreplace_camelcase_attributes(doc.to_s, replace_pairs)
+      out.gsub!(/ (\w+)=""/) do |all_match|
+        m = $1
+        if original_content[/ #{m}[^=]/]
+          " #{m}"
+        else
+          all_match
         end
+      end
+      out
+    end
 
-        if @on_ask.call(change)
-          change.i18n_t
+    # nokogir::html can parse @click.prevent stuff, but transforms all CamelCase Attributes to kebab-case by default
+    # To keep the original case, we replace it with a placeholder and unreplace it back
+    def replace_camelcase_attributes(text)
+      cc = 1
+      pairs = []
+      replaced = text.gsub(/ ([a-zA-Z:]+=)/) { |pp|
+        match = Regexp.last_match
+        cc += 1
+        # kebab-case
+        if pp[/[A-Z]/]
+          kebab = match[1].gsub(/([A-Z])/) { |i| "-#{i.downcase}" }
+          hack = " :camelcase-nokogiri-hack-#{cc}-#{kebab}"
+          pairs << [hack, " " + match[1]]
+          hack
         else
-          old_line
+          pp
         end
+      }
+      # tags
+      replaced.scan(/<([a-zA-Z0-9]+)/).flatten.each do |pp|
+        next pp unless pp[/[A-Z]/]
+
+        cc += 1
+
+        kebab = pp.gsub(/([A-Z])/) { |i| "-#{i.downcase}" }.sub(/^-/, '')
+        hack = "camelcase-nokogiri-hack-#{cc}-#{kebab}"
+        replaced.gsub!(/<#{pp}/, "<#{hack}")
+        replaced.gsub!(/<\/ *#{pp}/, "</#{hack}")
+        pairs << ["<#{hack}", "<#{pp}"]
+        pairs << ["</#{hack}", "</#{pp}"]
+      end
+      [replaced, pairs]
+    end
+
+    def unreplace_camelcase_attributes(text, pairs)
+      txt = text.dup
+      pairs.each do |hack, camel|
+        txt.gsub!(hack, camel)
+      end
+      txt
+    end
+
+    def process_attribute_change(node, attr)
+      _, ws_before, content, ws_after = node[attr].to_s.match(/(\s*)(.*?)(\s*)$/m).to_a
+
+      interpolate_arguments, content = extract_arguments(content)
+
+      change = ExtractI18n::SourceChange.new(
+        i18n_key: "#{@file_key}.#{ExtractI18n.key(content)}",
+        i18n_string: content,
+        source_line: node.to_s,
+        remove: content,
+        t_template: %[$t('%s'%s)],
+        interpolation_type: :vue,
+        interpolate_arguments: interpolate_arguments,
+      )
+      if @on_ask.call(change)
+        node.remove_attribute "title"
+        node[":" + attr] = "#{ws_before}#{change.i18n_t}#{ws_after}"
+      end
+    end
+
+    def process_change(node)
+      _, ws_before, content, ws_after = node.to_s.match(/(\s*)(.*?)(\s*)$/m).to_a
+
+      return if content.include?("{{")
+
+      interpolate_arguments, content = extract_arguments(content)
+
+      change = ExtractI18n::SourceChange.new(
+        i18n_key: "#{@file_key}.#{ExtractI18n.key(content)}",
+        i18n_string: content,
+        source_line: node.parent.to_s,
+        remove: content,
+        t_template: %[{{ $t('%s'%s) }}],
+        interpolation_type: :vue,
+        interpolate_arguments: interpolate_arguments,
+      )
+      if @on_ask.call(change)
+        node.replace("#{ws_before}#{change.i18n_t}#{ws_after}")
+      end
+    end
+
+    def extract_arguments(translation)
+      args = {}
+      translation.scan(/\{\{([^}]*)\}\}/).each_with_index do |stripped_arg, index|
+        arg = Regexp.last_match[0]
+        key = ExtractI18n.key(arg)
+        key = key + index.to_s if index > 0
+        translation = translation.gsub(arg, "{#{key}}")
+        args[key] = stripped_arg[0]
       end
+      [args, translation]
     end
   end
 end

data/lib/extract_i18n/adapters/vue_pug_adapter.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ExtractI18n::Adapters
+  class VuePugAdapter < SlimAdapter
+    def process_line(old_line)
+      @mode ||= :template
+      if old_line[/^<template/]
+        @mode = :template
+      elsif old_line[/^<script/]
+        @mode = :script
+      elsif old_line[/^<style/]
+        @mode = :style
+      end
+      if @mode != :template
+        return old_line
+      end
+      word = ExtractI18n::Slimkeyfy::Word.for('.vue').new(old_line)
+      ExtractI18n::Slimkeyfy::VueTransformer.new(word, @file_key).transform do |change|
+        if change.nil? # nothing to do
+          return old_line
+        end
+
+        if @on_ask.call(change)
+          change.i18n_t
+        else
+          old_line
+        end
+      end
+    end
+  end
+end

data/lib/extract_i18n/cli.rb

@@ -27,7 +27,7 @@ module ExtractI18n
         end
 
         opts.on('-nNAMESPACE', '--namespace=NAMESPACE', 'Locale base key to wrap locations in') do |f|
-          @options[:base_key] = f
+          @options[:namespace] = f
         end
 
         opts.on('-r', '--slim-relative', 'When activated, will use relative keys like t(".title")') do |f|

data/lib/extract_i18n/slimkeyfy/slim_transformer.rb

@@ -23,8 +23,8 @@ module ExtractI18n
       append: /(?<html_tag>append:\s*)/,
       label: /(?<html_tag>[a-z]*_?label:\s*)/,
       optionals: /(?<html_tag>(default|include_blank|alt):\s*)/,
-      input: /(?<html_tag>[a-z]*\.?input:?\s*)/,
-      button: /(?<html_tag>[a-z]*\.?button:?\s*(\:[a-z]+\s*,\s*)?)/,
+      input: /(?<html_tag>[a-z]*\.?input:\s*)/,
+      button: /(?<html_tag>[a-z]*\.?button:\s*(\:[a-z]+\s*,\s*)?)/,
       tag: /(?<html_tag>(submit|content)_tag[\:\(]?\s*)/,
       data_naive: /(?<html_tag>data:\s*\{\s*(confirm|content):\s*)/
     }.freeze

data/lib/extract_i18n/source_change.rb

@@ -47,8 +47,12 @@ module ExtractI18n
       unless @source_line.include?("\n")
         s += "\n"
       end
-      s += PASTEL.cyan("with:     ") + PASTEL.blue(@source_line).
-           gsub(@remove, PASTEL.green(i18n_t))
+      if @source_line[@remove]
+        s += PASTEL.cyan("with:     ") + PASTEL.blue(@source_line).
+          gsub(@remove, PASTEL.green(i18n_t))
+      else
+        s += PASTEL.cyan("with:     ") + PASTEL.green(i18n_t)
+      end
       unless @source_line.include?("\n")
         s += "\n"
       end
@@ -66,7 +70,7 @@ module ExtractI18n
     end
 
     def increment_key!
-      if @key[-1][/(.*)([0-9]+)$/]
+      if @key[/(.+)([0-9]+)$/]
         rest = $1
         number = $2.to_i
       else

data/lib/extract_i18n/version.rb

@@ -1,3 +1,3 @@
 module ExtractI18n
-  VERSION = "0.3.0"
+  VERSION = "0.6.0"
 end

data/lib/extract_i18n.rb

@@ -21,7 +21,8 @@ module ExtractI18n
   self.ignore_functions = %w[where order group select sql]
   self.ignorelist = [
     '_',
-    '::'
+    '::',
+    %r{^/}
   ]
   self.html_fields_with_plaintext = %w[title placeholder alt label aria-label modal-title]
 
@@ -37,6 +38,7 @@ module ExtractI18n
       gsub(%r{^/|/$}, '').
       gsub(/\.(vue|rb|html\.slim|\.slim)$/, '').
       gsub(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2').gsub(/([a-z\d])([A-Z])/, '\1_\2').
+      gsub('/_', '.').
       gsub('/', '.').
       tr("-", "_").downcase
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: extract_i18n
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Stefan Wienert
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-15 00:00:00.000000000 Z
+date: 2022-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -136,6 +136,7 @@ files:
 - lib/extract_i18n/adapters/slim_adapter.rb
 - lib/extract_i18n/adapters/slim_adapter_wip.rb
 - lib/extract_i18n/adapters/vue_adapter.rb
+- lib/extract_i18n/adapters/vue_pug_adapter.rb
 - lib/extract_i18n/cli.rb
 - lib/extract_i18n/file_processor.rb
 - lib/extract_i18n/html_extractor/erb_document.rb
@@ -157,7 +158,7 @@ homepage: https://github.com/pludoni/extract_i18n
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -172,9 +173,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Extact i18n from Ruby files using Ruby parser and slim files using regex
 test_files: []