extract_i18n 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e3434dc96f1e175bb499bfcdf6d4bf1b5dcc5a1a76190639c8689c0eee069820
+  data.tar.gz: a6bd0093f55639253d1f9dd5589f9ebdefda5197e4ccb04d9b01dd1ce2fade88
+SHA512:
+  metadata.gz: 82b5167ce206cc40b507d9e7eafae30f8b04384670483ed328c8a924498c252581a87bf02cf03fa103e7591c13090b6a8c97046028af974c18f15489e328b23a
+  data.tar.gz: 0e94e6d16ffe2e67d18be3d5a06d82051c3a713fdd03e0be8983b4f4a5f2097777f68935437605ef0cd788025c8dd5d4a0fbeb9c209c3d8074b07cf7915211c6

data/.github/workflows/verify.yml

@@ -0,0 +1,23 @@
+name: Verify
+on: [push]
+
+jobs:
+  tests:
+    name: Tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        # ruby: [ '2.5', '2.6', '2.7' ]
+        ruby: [ '2.6' ]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install gems
+        run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+      - name: Run tests
+        run: bundle exec rspec
+

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+spec/.examples.txt

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,35 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+
+
+Style:
+  Enabled: false
+Metrics:
+  Enabled: false
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - "lib/extract_i18n/adapters/slim_adapter_wip.rb"
+
+Naming/PredicateName:
+  Enabled: false
+Layout/DotPosition:
+  EnforcedStyle: trailing
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+Lint/MissingCopEnableDirective:
+  Enabled: false
+Lint/MixedRegexpCaptureTypes:
+  Enabled: false
+Layout/LineLength:
+  Exclude:
+    - "spec/**/*.rb"

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in extract_i18n.gemspec
+gemspec
+
+gem 'pry'
+gem 'rake'
+gem 'rspec'
+gem 'rubocop'
+gem 'solargraph'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Stefan Wienert
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# ExtractI18n
+
+CLI helper program to automatically extract bare text strings into Rails I18n interactively.
+
+Useful when adding i18n to a medium/large Rails app.
+
+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)
+- Vue Pug views
+  - Pug is very similar to slim and thus relatively good extractable via Regexp.
+
+CURRENTLY THERE IS **NO SUPPORT** FOR:
+
+- erb ( integrating/forking https://github.com/zigzag/ready_for_i18n or https://github.com/ProGM/i18n-html_extractor)
+- 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!
+
+I strongly recommend using a Source-Code-Management (Git) and ``i18n-tasks`` for checking the key consistency.
+I've created a scanner to make that work with vue $t structures too: https://gist.github.com/zealot128/e6ec1767a40a6c3d85d7f171f4d88293
+
+## Installation
+
+install:
+
+    $ gem install extract_i18n
+
+## Usage
+
+DO USE A SOURCE-CODE-MANAGEMENT-SYSTEM (Git). There is no guarantee that programm will not destroy your workspace :)
+
+
+```
+extract-i18n --helper
+
+extract-i18n --locale de --yaml config/locales/unsorted.de.yml app/views/user
+```
+
+If you prefer relative keys in slim views use ``--slim-relative``, e.g. ``t('.title')`` instead of ``t('users.index.title')``.
+I prefer absolute keys, as it makes copy pasting/ moving files much safer.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/zealot128/extract_i18n.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "extract_i18n"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/extract-i18n

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require 'extract_i18n/cli'
+
+result = ExtractI18n::CLI.new.run
+exit(result ? 0 : 1)

data/extract_i18n.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "extract_i18n/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "extract_i18n"
+  spec.version       = ExtractI18n::VERSION
+  spec.authors       = ["Stefan Wienert"]
+  spec.email         = ["info@stefanwienert.de"]
+
+  spec.summary       = %q{Extact i18n from Ruby files using Ruby parser and slim files using regex}
+  spec.description   = %q{Extact i18n from Ruby files using Ruby parser and slim files using regex interactively}
+  spec.homepage      = "https://github.com/pludoni/extract_i18n"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'parser', '>= 2.6'
+  spec.add_runtime_dependency 'slim'
+  spec.add_runtime_dependency 'tty-prompt'
+  spec.add_runtime_dependency 'zeitwerk'
+  spec.add_dependency "diff-lcs"
+  spec.add_dependency "diffy"
+end

data/lib/extract_i18n.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "extract_i18n/version"
+
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.setup # ready!
+
+module ExtractI18n
+  class << self
+    attr_accessor :strip_path, :ignore_hash_keys, :ignore_functions, :ignorelist
+  end
+
+  self.strip_path = %r{^app/(javascript|controllers|views)|^lib|^src|^app}
+
+  # ignore for .rb files: ignore those file types
+  self.ignore_hash_keys = %w[class_name foreign_key join_table association_foreign_key key]
+  self.ignore_functions = %w[where order group select sql]
+  self.ignorelist = [
+    '_',
+    '::'
+  ]
+
+  def self.key(string, length: 25)
+    string.strip.
+      unicode_normalize(:nfkd).gsub(/(\p{Letter})\p{Mark}+/, '\\1').
+      gsub(/\W+/, '_').downcase[0..length].
+      gsub(/_+$|^_+/, '')
+  end
+
+  def self.file_key(path)
+    path.gsub(strip_path, '').
+      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('/', '.').
+      tr("-", "_").downcase
+  end
+end
+
+require 'extract_i18n/file_processor'

data/lib/extract_i18n/adapters/adapter.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ExtractI18n::Adapters
+  class Adapter
+    def self.for(file_path)
+      case file_path
+      when /\.rb$/ then RubyAdapter
+      when /\.slim$/ then SlimAdapter
+      when /\.vue$/ then VueAdapter
+      end
+    end
+
+    attr_reader :on_ask, :file_path, :file_key, :options
+
+    def initialize(file_key:, on_ask:, options: {})
+      @on_ask = on_ask
+      @file_key = file_key
+      @options = options
+    end
+
+    def run(content)
+      raise NotImplementedError
+    end
+
+    def self.supports_relative_keys?
+      false
+    end
+
+    private
+
+    def original_content
+      @original_content ||= File.read(file_path)
+    end
+  end
+end

data/lib/extract_i18n/adapters/ruby_adapter.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require 'parser/current'
+require 'tty-prompt'
+require 'pry'
+require 'pastel'
+require 'yaml'
+require 'extract_i18n/source_change'
+
+module ExtractI18n::Adapters
+  class RubyAdapter < Adapter
+    def run(original_content)
+      buffer        = Parser::Source::Buffer.new('(example)')
+      buffer.source = original_content
+      temp = Parser::CurrentRuby.parse(original_content)
+      rewriter = ExtractI18n::Adapters::Rewriter.new(
+        file_key: file_key,
+        on_ask: on_ask
+      )
+      # Rewrite the AST, returns a String with the new form.
+      rewriter.rewrite(buffer, temp)
+      # rescue StandardError => e
+      #   puts 'Parsing error'
+      #   puts e.inspect
+    end
+  end
+
+  class Rewriter < Parser::TreeRewriter
+    PROMPT = TTY::Prompt.new
+    PASTEL = Pastel.new
+
+    def initialize(file_key:, on_ask:)
+      @file_key = file_key
+      @on_ask = on_ask
+    end
+
+    def process(node)
+      @nesting ||= []
+      @nesting.push(node)
+      super
+      @nesting.pop
+    end
+
+    def on_dstr(node)
+      if ignore?(node, parent: @nesting[-2])
+        return
+      end
+      interpolate_arguments = {}
+      out_string = ""
+      node.children.each do |i|
+        if i.type == :str
+          out_string += i.children.first
+        else
+          inner_source = i.children[0].loc.expression.source.gsub(/^#\{|}$/, '')
+          interpolate_key = ExtractI18n.key(inner_source)
+          out_string += "%{#{interpolate_key}}"
+          interpolate_arguments[interpolate_key] = inner_source
+        end
+      end
+
+      i18n_key = ExtractI18n.key(node.children.select { |i| i.type == :str }.map { |i| i.children[0] }.join(' '))
+
+      ask_and_continue(
+        i18n_key: i18n_key, i18n_string: out_string, interpolate_arguments: interpolate_arguments, node: node,
+      )
+    end
+
+    def on_str(node)
+      string = node.children.first
+      if ignore?(node, parent: @nesting[-2])
+        return
+      end
+      ask_and_continue(i18n_key: ExtractI18n.key(string), i18n_string: string, node: node)
+    end
+
+    private
+
+    def ask_and_continue(i18n_key:, i18n_string:, interpolate_arguments: {}, node:)
+      change = ExtractI18n::SourceChange.new(
+        i18n_key: "#{@file_key}.#{i18n_key}",
+        i18n_string: i18n_string,
+        interpolate_arguments: interpolate_arguments,
+        source_line: node.location.expression.source_line,
+        remove: node.loc.expression.source
+      )
+      if @on_ask.call(change)
+        replace_content(node, change.i18n_t)
+      end
+    end
+
+    def log(string)
+      puts string
+    end
+
+    def replace_content(node, content)
+      if node.loc.is_a?(Parser::Source::Map::Heredoc)
+        replace(node.loc.expression.join(node.loc.heredoc_end), content)
+      else
+        replace(node.loc.expression, content)
+      end
+    end
+
+    def ignore?(node, parent: nil)
+      unless node.respond_to?(:children)
+        return false
+      end
+      if parent && ignore_parent?(parent)
+        return true
+      end
+      if node.type == :str
+        ExtractI18n.ignorelist.any? { |item| node.children[0][item] }
+      else
+        node.children.any? { |child|
+          ignore?(child)
+        }
+      end
+    end
+
+    def ignore_parent?(node)
+      node.children[1] == :require ||
+        node.type == :regexp ||
+        (node.type == :pair && ExtractI18n.ignore_hash_keys.include?(node.children[0].children[0].to_s)) ||
+        (node.type == :send && ExtractI18n.ignore_functions.include?(node.children[1].to_s))
+    end
+  end
+end