extract_i18n 0.1.0

data/lib/extract_i18n/slimkeyfy/vue_transformer.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+class ExtractI18n::Slimkeyfy::VueTransformer < ExtractI18n::Slimkeyfy::SlimTransformer
+  BEFORE = /(?<before>.*[\( ^])/.freeze
+  HTML_ARGUMENTS = {
+    placeholder: /(?<html_tag>[a-z\-]*placeholder=\s*)/,
+    title: /(?<html_tag>title=\s*)/,
+    kind_of_title: /(?<html_tag>[a-z\-]+title=\s*)/,
+    label: /(?<html_tag>[a-z\-]*label=\s*)/,
+    description: /(?<html_tag>description=\s*)/,
+    alt: /(?<html_tag>alt=\s*)/,
+    prepend: /(?<html_tag>prepend=\s*)/,
+    append: /(?<html_tag>append=\s*)/,
+  }.freeze
+
+  def regex_list
+    HTML_ARGUMENTS.map { |_, regex| /#{BEFORE}#{regex}#{TRANSLATION}#{AFTER}/ }
+  end
+
+  def parse_html(&_block)
+    return @word.line if @word.line.match(TRANSLATED)
+    return @word.line if @word.tail.join(" ")[/^{{.*}}$/]
+
+    body = @word.tail.join(" ")
+    body, tagged_with_equals = ExtractI18n::Slimkeyfy::Whitespacer.convert_nbsp(body, @word.head)
+
+    tagged_with_equals = "|" if tagged_with_equals == "="
+
+    interpolate_arguments, body = extract_arguments(body)
+
+    change = ExtractI18n::SourceChange.new(
+      source_line: @word.line,
+      remove: body,
+      interpolate_arguments: interpolate_arguments,
+      interpolation_type: :vue,
+      i18n_key: "#{@file_key}.#{ExtractI18n.key(body)}",
+      i18n_string: body,
+      t_template: "#{@word.indentation}#{tagged_with_equals} {{ $t('%s'%s) }}"
+    )
+    yield(change)
+  end
+
+  def parse_html_arguments(line, token_skipped_before = nil, &block)
+    final_line = line
+    regex_list.each do |regex|
+      line.scan(regex) do |m_data|
+        next if m_data == token_skipped_before
+        before = m_data[0]
+        if before[-1] == ":" # already dynamic attribute
+          next
+        end
+        html_tag = m_data[1]
+        translation = match_string(m_data[2])
+        after = m_data[3]
+        interpolate_arguments, translation = extract_arguments(translation)
+
+        change = ExtractI18n::SourceChange.new(
+          source_line: final_line,
+          i18n_string: translation,
+          i18n_key: "#{@file_key}.#{ExtractI18n.key(translation)}",
+          remove: m_data[2],
+          interpolate_arguments: interpolate_arguments,
+          interpolation_type: :vue,
+          t_template: "#{before}:#{html_tag}\"$t('%s'%s)\"#{after}"
+        )
+        final_line = yield(change)
+        return parse_html_arguments(final_line, m_data, &block)
+      end
+    end
+    @word.indentation + final_line
+  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

data/lib/extract_i18n/slimkeyfy/whitespacer.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module ExtractI18n
+  class Slimkeyfy::Whitespacer
+    HTML = /([a-z\.]+[0-9\-]*)+/.freeze
+    HTML_TAGS = /^(?<html_tag>'|\||#{HTML})/.freeze
+
+    def self.convert_slim(string)
+      m = string.match(HTML_TAGS)
+
+      return string if m.nil? or m[:html_tag].nil?
+      return string if has_equals_tag?(string, m[:html_tag])
+      tag = m[:html_tag]
+
+      case tag
+      when /\|/
+        string.gsub("|", "=")
+      when /\'/
+        string.gsub("'", "=>")
+      when HTML
+        string.gsub(string, "#{string} =")
+      else string end
+    end
+
+    def self.convert_nbsp(body, tag)
+      lead = leading_nbsp(body)
+      trail = trailing_nsbp(body, tag)
+
+      tag = tag.gsub(tag, "#{tag}#{lead}#{trail}")
+      [body.sub(/^&nbsp;/, '').sub(/&nbsp;$/, '').gsub("&nbsp;", " "), tag.gsub("=><", "=<>")]
+    end
+
+    def self.leading_nbsp(body)
+      return "<" if body.start_with?("&nbsp;")
+    end
+
+    def self.trailing_nsbp(body, tag)
+      return '' if tag.start_with?("=>")
+      return ">" if body.end_with?("&nbsp;")
+    end
+
+    def self.has_equals_tag?(string, html_tag)
+      string.gsub(html_tag, "").strip.start_with?("=")
+    end
+  end
+end

data/lib/extract_i18n/slimkeyfy/word.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module ExtractI18n::Slimkeyfy
+  class Word
+    attr_reader :line, :tokens, :indentation
+
+    def self.for(extension)
+      if extension == 'vue'
+        JsWord
+      else
+        Word
+      end
+    end
+
+    def initialize(line)
+      @line = line
+      @indentation = " " * (@line.size - unindented_line.size)
+    end
+
+    def as_list
+      # check for div.foo-bar(foo=bar)
+      has_html_form = !!@line[/^ *[\.#]?[a-z\.#-]+\(/]
+      delimiter_items =
+        @line.
+        sub(/^(\s*\|)(\w)/, "\\1 \\2"). # add a whitespace to support "|string"
+        split(has_html_form ? /(?<=[\(])| +/ : ' '). # split by whitespace or ( but keep (
+        drop_while { |i| i == "" } # .. but that leaves leading ""
+      items = []
+      # div: div
+      delimiter_items.reverse_each do |item|
+        if item[/^([a-z]|\.[a-z]|#[a-z]).*:/] and items.length > 0
+          items[-1] = "#{item} #{items[-1]}"
+        else
+          items << item
+        end
+      end
+      items.reverse
+    end
+
+    def unindented_line
+      @line.sub(/^\s*/, "")
+    end
+
+    def head
+      as_list.first
+    end
+
+    def tail
+      as_list.drop(1)
+    end
+
+    def extract_arguments(translation)
+      args = {}
+      translation.scan(/\#{[^}]*}/).each_with_index do |arg, index|
+        stripped_arg = arg[2..-2]
+        key = arg[/\w+/]
+        key += index.to_s if index > 0
+        translation = translation.gsub(arg, "%{#{key}}")
+        args[key] = stripped_arg
+      end
+      [args, translation]
+    end
+
+    def extract_updated_key(translation_key_with_base)
+      return "" if translation_key_with_base.blank?
+      translation_key_with_base.split(".").last
+    end
+  end
+
+  class JsWord < Word
+    def initialize(*args)
+      super
+      @use_absolute_key = true
+    end
+
+    def extract_arguments(translation)
+      args = {}
+      translation.scan(/\{\{([^}]*)\}\}/).each_with_index do |stripped_arg, index|
+        arg = Regexp.last_match[0]
+        key = arg[/\w+/]
+        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/source_change.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'pastel'
+
+module ExtractI18n
+  class SourceChange
+    # Data class for a proposed source change
+
+    PASTEL = Pastel.new
+
+    attr_reader :key, :i18n_string
+
+    # @param i18n_key [String]
+    #   "models.foo.bar.button_text"
+    # @param interpolate_arguments [Hash]
+    #   { "date" => "Date.new.to_s" }
+    # @param source_line [String]
+    #   original souce line to modify for viewing purposes
+    # @param remove [String]
+    #   what piece of source_line to replace
+    # @param t_template [String]
+    #   how to format the replacement translation, use 2 placeholder %s for the string and for the optional arguments
+    # @param interpolation_type [Symbol]
+    #   :ruby or :vue
+    def initialize(
+      i18n_key:,
+      i18n_string:,
+      interpolate_arguments:,
+      source_line:,
+      remove:,
+      t_template: %{I18n.t("%s"%s)},
+      interpolation_type: :ruby
+    )
+      @i18n_string = i18n_string
+      @key = i18n_key
+      @interpolate_arguments = interpolate_arguments
+      @source_line = source_line
+      @remove = remove
+      @t_template = t_template
+      @interpolation_type = interpolation_type
+    end
+
+    def format
+      s = ""
+      s += PASTEL.cyan("replace:  ") + PASTEL.blue(@source_line).
+           gsub(@remove, PASTEL.red(@remove))
+      unless @source_line.include?("\n")
+        s += "\n"
+      end
+      s += PASTEL.cyan("with:     ") + PASTEL.blue(@source_line).
+           gsub(@remove, PASTEL.green(i18n_t))
+      unless @source_line.include?("\n")
+        s += "\n"
+      end
+      s += PASTEL.cyan("add i18n: ") + PASTEL.blue("#{@key}: #{@i18n_string}")
+      s
+    end
+
+    def i18n_t(relative: false)
+      i18n_key = if relative
+                   "." + key.split('.').last
+                 else
+                   key
+                 end
+      sprintf(@t_template, i18n_key, i18n_arguments_string)
+    end
+
+    def increment_key!
+      if @key[-1][/(.*)([0-9]+)$/]
+        rest = $1
+        number = $2.to_i
+      else
+        number = 1
+        rest = @key
+      end
+      @key = "#{rest}#{number + 1}"
+    end
+
+    def i18n_arguments_string
+      case @interpolation_type
+      when :ruby
+        if @interpolate_arguments.keys.length > 0
+          ", " + @interpolate_arguments.map { |k, v| "#{k}: (#{v})" }.join(', ')
+        else
+          ""
+        end
+      when :vue
+        if @interpolate_arguments.keys.length > 0
+          ", { " + @interpolate_arguments.map { |k, v| "#{k}: (#{v.strip})" }.join(', ') + " }"
+        else
+          ""
+        end
+      else
+        raise NotImplementedError, @interpolation_type
+      end
+    end
+  end
+end

data/lib/extract_i18n/version.rb

@@ -0,0 +1,3 @@
+module ExtractI18n
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: extract_i18n
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stefan Wienert
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: diff-lcs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Extact i18n from Ruby files using Ruby parser and slim files using regex
+  interactively
+email:
+- info@stefanwienert.de
+executables:
+- extract-i18n
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/verify.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/extract-i18n
+- extract_i18n.gemspec
+- lib/extract_i18n.rb
+- lib/extract_i18n/adapters/adapter.rb
+- lib/extract_i18n/adapters/ruby_adapter.rb
+- 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/cli.rb
+- lib/extract_i18n/file_processor.rb
+- lib/extract_i18n/slimkeyfy/slim_transformer.rb
+- lib/extract_i18n/slimkeyfy/vue_transformer.rb
+- lib/extract_i18n/slimkeyfy/whitespacer.rb
+- lib/extract_i18n/slimkeyfy/word.rb
+- lib/extract_i18n/source_change.rb
+- lib/extract_i18n/version.rb
+homepage: https://github.com/pludoni/extract_i18n
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Extact i18n from Ruby files using Ruby parser and slim files using regex
+test_files: []