neeto-translate-cli 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7f02f39e18528cfe0511c15be9a69c5f5b156d0ebb7497a6f68c3fc702d70be8
+  data.tar.gz: 306076cb3c777e33171135b221f745175ffcd380be3c94e2daabe6dcd334672f
+SHA512:
+  metadata.gz: b28d58ccfd9766d8d7f7660cb3e191856bcb5dcbf6d1f38a025cf925746722802d02c84319cbed03930bba33d35fc55633ca2ebb413daf67120f4eb17fc8bdb8
+  data.tar.gz: 282c29211bb41d7f32c48aec95491f7a7a22373bf90d4866144d3b950f94eb170461a4b85dce698c4b4c6fa266ea01e5048d7ef2c3c6b729c021e28c7756d6a7

data/README.md

@@ -0,0 +1,119 @@
+# neeto-translate-cli
+
+A Ruby CLI tool that extracts translation files from Rails applications and makes requests to the neeto-translate API for automated translation management.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Development](#development)
+
+## Installation
+
+Install the gem via RubyGems:
+
+```bash
+gem install neeto-translate-cli
+```
+
+Or add it to your Gemfile:
+
+```ruby
+gem 'neeto-translate-cli'
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+## Usage
+
+The `neeto-translate-cli` tool helps you manage translations by:
+
+1. Extracting translation keys from your Rails application's frontend (JSON) and backend (YAML) locale files
+2. Identifying missing translations across different languages
+3. Detecting updated translation keys since the last automated translation
+4. Sending translation requests to the neeto-translate API
+
+### Basic Usage
+
+```bash
+neeto-translate-cli [OPTIONS]
+```
+
+#### Command line options
+
+**Options:**
+
+- `--frontend PATH` - Path to frontend locales (default: `app/javascript/src/translations`)
+- `--backend PATH` - Path to backend locales (default: `config/locales`)
+- `--defaults LANGUAGES` - Comma-separated list of languages to translate (default: `en,fr,de,es`)
+- `--repo NAME` - GitHub repository name (e.g., `neetozone/neeto-cal-web`)
+
+### Examples
+
+**Custom paths:**
+
+```bash
+neeto-translate-cli --frontend src/locales --backend config/translations
+```
+
+**Specific languages:**
+
+```bash
+neeto-translate-cli --defaults "fr,de,es,it"
+```
+
+**Full example:**
+
+```bash
+neeto-translate-cli \
+  --frontend app/javascript/src/translations \
+  --backend config/locales \
+  --defaults "fr,de,es" \
+  --repo "neetozone/neeto-cal-web"
+```
+
+### Environment Variables
+
+The following environment variables can be configured:
+
+- `NEETO_TRANSLATE_URL` - Base URL for the neeto-translate API (default: `https://translate.neeto.com`)
+- `NEETO_TRANSLATE_X_TOKEN` - Authentication token for the API
+- `DEFAULT_LANGUAGES` - Comma-separated list of default languages (default: `en,fr,de,es`)
+
+### How It Works
+
+1. **Extraction**: The tool reads your English translation files (`en.json` for frontend, `en.yml` for backend)
+2. **Analysis**: It compares with other language files to identify missing translations
+3. **Change Detection**: It detects keys that have been updated since the last automated translation run
+4. **API Request**: Sends a payload to the neeto-translate API with:
+   - Current English translations
+   - Missing translation keys for each language
+   - Updated keys that need re-translation
+   - Repository metadata
+
+## Development
+
+### Setup
+
+1. Clone the repository:
+
+```bash
+git clone https://github.com/neetozone/neeto-translate.git
+cd neeto-translate/cli
+```
+
+2. Install dependencies:
+
+```bash
+bundle install
+```
+
+3. Run tests:
+
+```bash
+bundle exec rake test
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require_relative "../lib/neeto_translate_cli/cli"
+
+# 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.
+
+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/neeto-translate-cli

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/neeto_translate_cli/cli"
+
+NeetoTranslateCli::CLI.start(ARGV)

data/lib/neeto_translate_cli/api.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "json"
+
+module NeetoTranslateCli
+  class Api
+    def translate!(payload)
+      connection.post("/translation") do |request|
+        request.body = payload.to_json
+      end
+    end
+
+    private
+
+    def connection
+      @connection ||= Faraday.new(url: url, headers: headers)
+    end
+
+    def url
+      ENV["NEETO_TRANSLATE_URL"] || CLI::NEETO_TRANSLATE_URL
+    end
+
+    def headers
+      {
+        "Content-Type" => "application/json",
+        "NEETO-TRANSLATE-X-TOKEN" => ENV["NEETO_TRANSLATE_X_TOKEN"]
+      }
+    end
+  end
+end

data/lib/neeto_translate_cli/cli.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "translator"
+
+require "optparse"
+
+module NeetoTranslateCli
+  class CLI
+    DEFAULT_LANGUAGES = "en,fr,de,es"
+    NEETO_TRANSLATE_URL = "https://translate.neeto.com"
+    DEFAULT_BACKEND_LOCALE_PATH = "config/locales"
+    DEFAULT_FRONTEND_LOCALE_PATH = "app/javascript/src/translations"
+
+    def self.start(args)
+      new(args).run
+    end
+
+    def initialize(args)
+      @args = args
+    end
+
+    def run
+      options = {
+        frontend: DEFAULT_FRONTEND_LOCALE_PATH,
+        backend: DEFAULT_BACKEND_LOCALE_PATH,
+        default_languages: (ENV["DEFAULT_LANGUAGES"] || DEFAULT_LANGUAGES).to_s.split(","),
+        repo: `git rev-parse --show-toplevel`.split("/").last.strip
+      }
+
+      OptionParser.new do |opts|
+        opts.on("--frontend PATH", "Path to frontend locales.") { |path| options[:frontend] = path }
+        opts.on("--backend PATH", "Path to backend locales") { |path| options[:backend] = path }
+        opts.on("--defaults ARRAY", "An array of comma separated languages to be translated") do |languages|
+          options[:default_languages] = languages.to_s.split(",")
+        end
+        opts.on("--repo NAME", "Name of the GitHub repository (eg: neetozone/neeto-cal-web).") do |path|
+          options[:repo] = path
+        end
+      end.parse!(@args)
+
+      Translator.new(options).process!
+    end
+  end
+end

data/lib/neeto_translate_cli/payload_builder.rb

@@ -0,0 +1,119 @@
+require "json"
+require "yaml"
+
+module NeetoTranslateCli
+  class PayloadBuilder
+    COMMIT_AUTHOR = "neetobot"
+
+    attr_reader :options, :updated_keys
+
+    def initialize(options)
+      @options = options
+      commit_id = `git log --author="#{COMMIT_AUTHOR}" --grep="\[neeto-translate\]" -n 1 --pretty=format:"%H"`.strip
+      @updated_keys = commit_id.empty? ? { frontend: [], backend: [] } : find_updated_keys(commit_id)
+    end
+
+    def process!
+      {
+        frontend: { en: en_json_flattened, missing_keys: find_missing_keys_for(:frontend) },
+        backend: { en: en_yml_flattened, missing_keys: find_missing_keys_for(:backend) },
+        metadata: {
+          repo: options[:repo],
+          frontend: options[:frontend],
+          backend: options[:backend]
+        }
+      }
+    end
+
+    def no_new_changes?(payload)
+      payload[:frontend][:missing_keys].values.all?(&:empty?) && payload[:backend][:missing_keys].values.all?(&:empty?)
+    end
+
+    private
+
+    def en_json_flattened
+      @_en_json_flattened ||= flatten_hash(load_json(File.expand_path("en.json", options[:frontend])))
+    end
+
+    def en_yml_flattened
+      @_en_yml_flattened ||= flatten_hash(load_yml(File.expand_path("en.yml", options[:backend]))["en"])
+    end
+
+    def find_updated_keys(commit_id)
+      previous_en_json_content = `git show #{commit_id}:#{options[:frontend]}/en.json`
+      updated_frontend_keys = []
+      unless previous_en_json_content.empty?
+        previous_en_json = JSON.parse(previous_en_json_content)
+        flat_previous_en_json = flatten_hash(previous_en_json)
+        flat_current_en_json = en_json_flattened
+
+        updated_frontend_keys = flat_current_en_json.keys.select do |key|
+          flat_previous_en_json.key?(key) && flat_current_en_json[key] != flat_previous_en_json[key]
+        end
+      end
+
+      previous_en_yml_content = `git show #{commit_id}:#{options[:backend]}/en.yml`
+      updated_backend_keys = []
+      unless previous_en_yml_content.empty?
+        previous_en_yml = YAML.load(previous_en_yml_content, aliases: true)["en"]
+        flat_previous_en_yml = flatten_hash(previous_en_yml)
+        flat_current_en_yml = en_yml_flattened
+
+        updated_backend_keys = flat_current_en_yml.keys.select do |key|
+          flat_previous_en_yml.key?(key) && flat_current_en_yml[key] != flat_previous_en_yml[key]
+        end
+      end
+
+      { frontend: updated_frontend_keys, backend: updated_backend_keys }
+    end
+
+    def find_missing_keys_for(type)
+      dir = options[type]
+      if type == :frontend
+        ext = "json"
+        base_keys = en_json_flattened.keys
+      else
+        ext = "yml"
+        base_keys = en_yml_flattened.keys
+      end
+
+      languages.each_with_object({}) do |lang, missing|
+        file_path = File.expand_path("#{lang}.#{ext}", dir)
+        if File.file?(file_path)
+          translations = ext == "json" ? load_json(file_path) : load_yml(file_path)[lang]
+          mk = base_keys - flatten_hash(translations).keys
+        else
+          mk = base_keys
+        end
+
+        missing[lang] = (mk + updated_keys[type]).uniq
+      end
+    end
+
+    def load_json(file_path)
+      JSON.parse(File.read(file_path, encoding: "utf-8"))
+    end
+
+    def load_yml(file_path)
+      YAML.load_file(file_path, aliases: true)
+    end
+
+    def flatten_hash(hash, prefix = nil)
+      hash.each_with_object({}) do |(key, value), result|
+        current_key = prefix ? "#{prefix}.#{key}" : key.to_s
+        if value.is_a?(Hash)
+          result.merge!(flatten_hash(value, current_key))
+        else
+          result[current_key] = value
+        end
+      end
+    end
+
+    def languages
+      default_languages = options[:default_languages]
+      project_languages = Dir.glob(File.join(options[:frontend], "*.json")).map { |f| File.basename(f, ".json") }
+
+      (default_languages + project_languages).uniq - ["en"]
+    end
+  end
+end

data/lib/neeto_translate_cli/translator.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "api"
+require_relative "payload_builder"
+
+module NeetoTranslateCli
+  class Translator
+    attr_reader :api, :options, :job_id
+
+    def initialize(options)
+      @api = NeetoTranslateCli::Api.new
+      @options = options
+    end
+
+    def process!
+      translate!
+    end
+
+    private
+
+    def translate!
+      payload_builder = PayloadBuilder.new(options)
+      payload = payload_builder.process!
+
+      if payload_builder.no_new_changes?(payload)
+        puts "Nothing to see here. You are all good."
+      else
+        response = api.translate! payload
+        puts response.body
+      end
+    end
+  end
+end

data/lib/neeto_translate_cli/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module NeetoTranslateCli
+  VERSION = "0.1.1"
+end

data/test/fixtures/backend/en.yml

@@ -0,0 +1,23 @@
+en:
+  common:
+    success: "Success"
+    error: "An error occurred"
+    not_found: "Not Found"
+  activerecord:
+    models:
+      user: "User"
+      product: "Product"
+    attributes:
+      user:
+        name: "Name"
+        email: "Email"
+      product:
+        name: "Product Name"
+        price: "Price"
+  mailer:
+    welcome:
+      subject: "Welcome to our service!"
+      body: "Hi %{name}, welcome!"
+    password_reset:
+      subject: "Password Reset Request"
+      body: "Please click the link to reset your password."

data/test/fixtures/backend/es.yml

@@ -0,0 +1,15 @@
+es:
+  common:
+    success: "Éxito"
+    error: "Ocurrió un error"
+  activerecord:
+    models:
+      user: "Usuario"
+      product: "Producto"
+    attributes:
+      product:
+        name: "Nombre del Producto"
+  mailer:
+    welcome:
+      subject: "¡Bienvenido a nuestro servicio!"
+      body: "Hola %{name}, ¡bienvenido!"

data/test/fixtures/backend/jp.yml

@@ -0,0 +1,18 @@
+jp:
+  common:
+    success: "成功"
+    not_found: "見つかりません"
+  activerecord:
+    models:
+      user: "ユーザー"
+    attributes:
+      user:
+        name: "名前"
+        email: "メールアドレス"
+      product:
+        name: "製品名"
+        price: "価格"
+  mailer:
+    password_reset:
+      subject: "パスワードリセットリクエスト"
+      body: "リンクをクリックしてパスワードをリセットしてください。"

data/test/fixtures/frontend/en.json

@@ -0,0 +1,22 @@
+{
+  "common": {
+    "ok": "OK",
+    "cancel": "Cancel",
+    "submit": "Submit"
+  },
+  "login": {
+    "title": "Login",
+    "email": "Email Address",
+    "password": "Password",
+    "forgot_password": "Forgot your password?"
+  },
+  "dashboard": {
+    "title": "Dashboard",
+    "welcome_message": "Welcome, {{name,anyCase}}",
+    "stats": {
+      "users": "Users",
+      "revenue": "Revenue",
+      "orders": "Orders"
+    }
+  }
+}

data/test/fixtures/frontend/es.json

@@ -0,0 +1,13 @@
+{
+  "common": {
+    "ok": "Aceptar",
+    "submit": "Enviar"
+  },
+  "login": {
+    "title": "Iniciar Sesión"
+  },
+  "dashboard": {
+    "title": "Tablero",
+    "welcome_message": "¡Bienvenido, {{name,anyCase}}"
+  }
+}

data/test/fixtures/frontend/jp.json

@@ -0,0 +1,19 @@
+{
+  "common": {
+    "ok": "はい",
+    "cancel": "キャンセル"
+  },
+  "login": {
+    "title": "ログイン",
+    "email": "メールアドレス",
+    "password": "パスワード",
+    "forgot_password": "パスワードをお忘れですか？"
+  },
+  "dashboard": {
+    "title": "ダッシュボード",
+    "stats": {
+      "users": "ユーザー",
+      "orders": "注文"
+    }
+  }
+}

data/test/neeto_translate_cli/payload_builder_test.rb

@@ -0,0 +1,63 @@
+require "test_helper"
+
+class NeetoTranslateCli::PayloadBuilderTest < Minitest::Test
+  def setup
+    @options = {
+      frontend: "test/fixtures/frontend",
+      backend: "test/fixtures/backend",
+      default_languages: %w[es de]
+    }
+    @payload_builder = NeetoTranslateCli::PayloadBuilder.new(@options)
+    @payload = @payload_builder.process!
+  end
+
+  def test_correct_frontend_payload_is_constructured
+    en_json_path = File.expand_path("en.json", @options[:frontend])
+    en_json = JSON.parse(File.read(en_json_path, encoding: "utf-8"))
+    es_missing_keys = [
+      "common.cancel",
+      "dashboard.stats.orders",
+      "dashboard.stats.revenue",
+      "dashboard.stats.users",
+      "login.email",
+      "login.forgot_password",
+      "login.password"
+    ]
+
+    assert @payload[:frontend]
+    assert_equal flatten_hash(en_json), @payload[:frontend][:en]
+    assert_equal %w[es de jp], @payload_builder.send(:languages)
+    assert_equal es_missing_keys, @payload.dig(:frontend, :missing_keys, "es").sort
+  end
+
+  def test_correct_backend_payload_is_constructured
+    en_yml_path = File.expand_path("en.yml", @options[:backend])
+      en_yml = YAML.load_file(en_yml_path, aliases: true)["en"]
+    es_missing_keys = [
+      "activerecord.attributes.product.price",
+      "activerecord.attributes.user.email",
+      "activerecord.attributes.user.name",
+      "common.not_found",
+      "mailer.password_reset.body",
+      "mailer.password_reset.subject"
+    ]
+
+    assert @payload[:backend]
+    assert_equal flatten_hash(en_yml), @payload[:backend][:en]
+    assert_equal %w[es de jp], @payload_builder.send(:languages)
+    assert_equal es_missing_keys, @payload.dig(:backend, :missing_keys, "es").sort
+  end
+
+  private
+
+    def flatten_hash(hash, prefix = nil)
+      hash.each_with_object({}) do |(key, value), result|
+        current_key = prefix ? "#{prefix}.#{key}" : key.to_s
+        if value.is_a?(Hash)
+          result.merge!(flatten_hash(value, current_key))
+        else
+          result[current_key] = value
+        end
+      end
+    end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative "../lib/neeto_translate_cli/cli"
+
+require "minitest/autorun"
+require "pry-byebug"

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: neeto-translate-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Abhay V Ashokan
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: neeto-translate CLI tool to extract translation files and make requests
+  to the neeto-translate API
+email:
+- abhay.ashokan@bigbinary.com
+executables:
+- neeto-translate-cli
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/neeto-translate-cli
+- lib/neeto_translate_cli/api.rb
+- lib/neeto_translate_cli/cli.rb
+- lib/neeto_translate_cli/payload_builder.rb
+- lib/neeto_translate_cli/translator.rb
+- lib/neeto_translate_cli/version.rb
+- test/fixtures/backend/en.yml
+- test/fixtures/backend/es.yml
+- test/fixtures/backend/jp.yml
+- test/fixtures/frontend/en.json
+- test/fixtures/frontend/es.json
+- test/fixtures/frontend/jp.json
+- test/neeto_translate_cli/payload_builder_test.rb
+- test/test_helper.rb
+homepage: https://github.com/neetozone/neeto-translate
+licenses: []
+metadata:
+  homepage_uri: https://github.com/neetozone/neeto-translate
+  source_code_uri: https://github.com/neetozone/neeto-translate
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: neeto-translate CLI tool to extract translation files and make requests to
+  the neeto-translate API
+test_files: []