moirai 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f735406747923f4a2493a81628e4cd88cf6f54d926fb31448ca5dab4ae70a8b9
-  data.tar.gz: 40f69e72824a96f13fe4e67b753a36617a745cdca04c61e691c7cc7877c55b96
+  metadata.gz: 5cd2eae769961645bc1baa4295ed58bf261beb38a48e934c1d3d38dd083f033a
+  data.tar.gz: fd3dddd2520c7f06987d814fec2986c5e02ac113748d39a1117315296cc0aaf3
 SHA512:
-  metadata.gz: 19eeb5b122adcd1f46fbfee0a39440f5d6ef9536bf28f8486f36fed40506d61449793adc6681cd3ce5eb35c10f9b5021928f97494e0c7063a5736fc8c0a2ea90
-  data.tar.gz: 9e3d8298eac29bca6008af867b57f8e663d9128c07bccf531c400c2c2889109b15515b676b6bbd0d85144fae119cc087a5ad3bb6cec83564edae67907b73543c
+  metadata.gz: 5ae7c1af2f697ea2f7fad123f4c2451e3fa9ba86ffb048ae0b6846c2002bc532e50f762ecf000e32d76f6631d62ebd9f211288b4dca081e61e9d1bbcb05fd6ef
+  data.tar.gz: f113aa608adfe9b5fae4a073f2d23936bb30090b3fe9d544dfc7d9421663244a78e3350b7218f988fa9c413fe6aef6a6ab154dd79cb5d0160dd026205bdac30d

data/.github/workflows/test.yml

@@ -1,11 +1,12 @@
 name: Test & lint
-on: [push, pull_request]
+on: [push]
 
 env:
   RAILS_ENV: test
   PGHOST: localhost
   PGUSER: postgres
-
+  MOIRAI_GITHUB_REPO_NAME: ${{ secrets.MOIRAI_GITHUB_REPO_NAME }}
+  MOIRAI_GITHUB_ACCESS_TOKEN: ${{ secrets.MOIRAI_GITHUB_ACCESS_TOKEN }}
 jobs:
   tests:
     name: Test
@@ -14,7 +15,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        ruby: [3.1, 3.2, 3.3]
+        ruby: [3.3]
     
     runs-on: ${{ matrix.os }}
     
@@ -32,7 +33,10 @@ jobs:
         run: bundle install --jobs 4 --retry 3
       
       - name: Run tests
-        run: bin/check
+        run: bundle exec rails test
+
+      - name: Run system tests
+        run: bundle exec rails test:system
   
   
   lint:

data/CHANGELOG.md

@@ -1,6 +1,22 @@
+## Unreleased
+
+## 0.2.0
+
+* Support for strings coming from gems ([@coorasse][])
+* Support for new strings (not yet translated) ([@coorasse][])
+
+## 0.1.1
+
+* Review Stimulus controller ([@coorasse][])
+
 ## 0.1.0 
 
 * Gem structure created ([@oliveranthony17][])
+* Database tables created ([@oliveranthony17][])
+* Pull request creation ([@oliveranthony17][])
+* Dummy app for tests ([@coorasse][])
+* CRUD for translations ([@CuddlyBunion341][])
+* Inline editing ([@CuddlyBunion341][])
 
 [@coorasse]: https://github.com/coorasse
 

data/Gemfile

@@ -4,14 +4,25 @@ source "https://rubygems.org"
 
 gemspec
 
+gem "rails", "~> 7.2.0"
+gem "octokit", ">= 4.0"
+gem "importmap-rails"
+gem "stimulus-rails"
+
 group :development, :test do
   gem "puma"
   gem "sqlite3"
-  gem "minitest"
   gem "rake"
+  gem "dotenv"
+  gem "minitest"
   gem "standard"
   gem "appraisal"
   gem "better_errors"
   gem "binding_of_caller"
   gem "sprockets-rails"
 end
+
+group :test do
+  gem "capybara"
+  gem "selenium-webdriver"
+end

data/README.md

@@ -46,6 +46,7 @@ Open a file, change the value of translations, and press ENTER to update the tra
 ### Inline editing
 
 By default, inline editing is disabled. To enable it, set the `moirai=true` query parameter in the URL.
+
 If you want to only allow specific users to perform inline editing, you can override the `moirai_edit_enabled?` method in your application helper.
 
 ```ruby
@@ -56,6 +57,18 @@ module ApplicationHelper
 end
 ```
 
+You also need to have the moirai_translations_controller.js Stimulus Controller initialized.
+
+If you use importmaps:
+
+Pin the controller in `config/importmap.rb`
+
+```ruby
+pin "controllers/moirai_translation_controller", to: "moirai_translation_controller.js"
+```
+
+If you’re unsure about all the possible configuration options, you can simply copy and paste the stimulus controller into your app as a fallback. 
+
 ### Automatic PR creation with Octokit (**optional**)
 
 If you would like Moirai to automatically create a pull request on GitHub to keep translations synchronized with the codebase, 
@@ -153,6 +166,12 @@ end
 
 4. Set your environment variables using the newly created `.env` file.
 
+You will need a repository to test against and a token. Generate a new Fine-GRained Personal access token and give the necessary permissions to your repository.
+See the image below as an example:
+
+![](docs/github_settings.png)
+
+
 5. Run the tests:
     ```bash
     bin/check
@@ -169,8 +188,7 @@ end
 * Support for interpolation
 * Support for count variants
 * Better inline editing tool
-* Performance of translations lookup
-* Support for translations and strings coming from other gems
+* Support for fallbacks: it should detect when a fallback string is in use and prevent attempts to override its value.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/assets/config/moirai_manifest.js

@@ -1,2 +1 @@
 //= link_directory ../stylesheets/moirai .css
-//= link_directory ../javascripts/moirai .js

data/app/assets/javascripts/moirai_translation_controller.js

@@ -0,0 +1,32 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class MoiraiTranslationController extends Controller {
+  static values = {
+    key: String,
+    locale: String
+  }
+
+  click(event) {
+    event.preventDefault()
+  }
+
+  submit(event) {
+    const csrfToken = document.querySelector('meta[name="csrf-token"]').content
+
+    fetch('/moirai/translation_files', {
+      method: 'POST',
+      headers: {
+        'X-CSRF-Token': csrfToken,
+        'Content-Type': 'application/json',
+        'Accept': 'application/json'
+      },
+      body: JSON.stringify({
+        translation: {
+          key: this.keyValue,
+          locale: this.localeValue,
+          value: event.target.innerText
+        }
+      })
+    });
+  }
+}

data/app/controllers/moirai/translation_files_controller.rb

@@ -14,13 +14,13 @@ module Moirai
     end
 
     def show
-      @translation_keys = @file_handler.parse_file(@decoded_path)
+      @translation_keys = @file_handler.parse_file(@file_path)
+      @locale = @file_handler.get_first_key(@file_path)
+      @translations = Moirai::Translation.by_file_path(@file_path)
     end
 
     def create_or_update
-      if (translation = Translation.find_by(file_path: translation_params[:file_path],
-        key: translation_params[:key],
-        locale: @file_handler.get_first_key(translation_params[:file_path])))
+      if (translation = Translation.find_by(key: translation_params[:key], locale: translation_params[:locale]))
         handle_update(translation)
       else
         handle_create
@@ -28,7 +28,7 @@ module Moirai
     end
 
     def open_pr
-      flash.notice = "I created an amazing PR"
+      flash.notice = "I created an amazing Pull Request"
       changes = Moirai::TranslationDumper.new.call
       Moirai::PullRequestCreator.new.create_pull_request(changes)
       redirect_back_or_to(root_path)
@@ -37,8 +37,7 @@ module Moirai
     private
 
     def handle_update(translation)
-      translation_from_file = @file_handler.parse_file(translation_params[:file_path])
-      if translation_from_file[translation.key] == translation_params[:value] || translation_params[:value].blank?
+      if translation_params[:value].blank? || translation_same_as_current?
         translation.destroy
         flash.notice = "Translation #{translation.key} was successfully deleted."
         redirect_to_translation_file(translation.file_path)
@@ -51,26 +50,36 @@ module Moirai
         flash.alert = translation.errors.full_messages.join(", ")
       end
 
-      redirect_to_translation_file(translation.file_path)
+      success_response(translation)
     end
 
     def handle_create
-      translation_from_file = @file_handler.parse_file(translation_params[:file_path])
-      if translation_from_file[translation_params[:key]] == translation_params[:value]
+      if translation_same_as_current?
         flash.alert = "Translation #{translation_params[:key]} already exists."
-        redirect_to_translation_file(translation_params[:file_path])
+        redirect_back_or_to moirai_translation_files_path, status: :unprocessable_entity
         return
       end
 
       translation = Translation.new(translation_params)
-      translation.locale = @file_handler.get_first_key(translation_params[:file_path])
+
       if translation.save
         flash.notice = "Translation #{translation.key} was successfully created."
+        success_response(translation)
       else
         flash.alert = translation.errors.full_messages.join(", ")
+        redirect_back_or_to moirai_translation_files_path, status: :unprocessable_entity
       end
+    end
 
-      redirect_to_translation_file(translation.file_path)
+    def success_response(translation)
+      respond_to do |format|
+        format.json do
+          render json: {}
+        end
+        format.all do
+          redirect_to_translation_file(translation.file_path)
+        end
+      end
     end
 
     def redirect_to_translation_file(file_path)
@@ -78,16 +87,32 @@ module Moirai
     end
 
     def set_translation_file
-      @file_path = @file_handler.file_hashes[params[:id]]
-      @decoded_path = CGI.unescape(@file_path)
+      @file_path = @file_handler.file_hashes[params[:hashed_file_path]]
+      if @file_path.nil?
+        flash.alert = "File not found"
+        redirect_to moirai_translation_files_path, status: :not_found
+      end
     end
 
     def translation_params
-      params.require(:translation).permit(:key, :locale, :value, :file_path)
+      params.require(:translation).permit(:key, :locale, :value)
     end
 
     def load_file_handler
       @file_handler = Moirai::TranslationFileHandler.new
     end
+
+    # TODO: to resolve the last point of the TODOs we could look at the current translation (without moirai)
+    # I quickly tried but I need to use the original backend instead of the moirai one
+    # The problem is that if we set a value that is the same as currently being used via fallback,
+    # it will create an entry in the database, and afterwards will try to add it in the PR, which we don't want.
+    def translation_same_as_current?
+      file_paths = KeyFinder.new.file_paths_for(translation_params[:key], locale: translation_params[:locale])
+
+      return false if file_paths.empty?
+      return false unless file_paths.all? { |file_path| File.exist?(file_path) }
+
+      translation_params[:value] == @file_handler.parse_file(file_paths.first)[translation_params[:key]]
+    end
   end
 end

data/app/controllers/moirai/translations_controller.rb

@@ -0,0 +1,7 @@
+module Moirai
+  class TranslationsController < ApplicationController
+    def index
+      @translations = Translation.order(created_at: :desc).pluck(:locale, :key, :value)
+    end
+  end
+end

data/app/models/moirai/change.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Prepares a certain file to be changefd in a Pull Request.
+# It takes care of adjusting the file_path and content
+module Moirai
+  class Change
+    attr_reader :file_path, :content
+
+    def initialize(file_path, content)
+      @file_path = file_path
+      @file_path = file_path.to_s.start_with?("./") ? file_path : "./#{file_path}"
+      @content = content.to_s.end_with?("\n") ? content : "#{content}\n"
+    end
+  end
+end

data/app/models/moirai/key_finder.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Moirai
+  class KeyFinder
+    include I18n::Backend::Base
+
+    # Mutex to ensure that concurrent translations loading will be thread-safe
+    MUTEX = Mutex.new
+
+    def initialize
+      load_translations
+    end
+
+    # TODO: remove locale default
+    # Returns all the file_paths where the key is found, including gems.
+    def file_paths_for(key, locale: I18n.locale)
+      return [] if key.blank?
+
+      locale ||= I18n.locale
+      moirai_translations[locale.to_sym].select do |_filename, data|
+        data.dig(*key.split(".")).present?
+      end.map { |k, _| k }.sort { |file_path| file_path.start_with?(Rails.root.to_s) ? 0 : 1 }
+    end
+
+    def store_moirai_translations(filename, locale, data, options)
+      moirai_translations[locale] ||= Concurrent::Hash.new
+
+      locale = locale.to_sym
+      moirai_translations[locale] ||= Concurrent::Hash.new
+      moirai_translations[locale][filename] = data.with_indifferent_access
+    end
+
+    def moirai_translations(do_init: false)
+      @moirai_translations ||= Concurrent::Hash.new do |h, k|
+        MUTEX.synchronize do
+          h[k] = Concurrent::Hash.new
+        end
+      end
+    end
+
+    def load_file(filename)
+      type = File.extname(filename).tr(".", "").downcase
+      raise I18n::UnknownFileType.new(type, filename) unless respond_to?(:"load_#{type}", true)
+      data, keys_symbolized = send(:"load_#{type}", filename)
+      unless data.is_a?(Hash)
+        raise I18n::InvalidLocaleData.new(filename, "expects it to return a hash, but does not")
+      end
+      data.each do |locale, d|
+        store_moirai_translations(filename, locale, d || {}, skip_symbolize_keys: keys_symbolized)
+      end
+
+      data
+    end
+  end
+end

data/app/models/moirai/translation.rb

@@ -2,13 +2,17 @@
 
 module Moirai
   class Translation < Moirai::ApplicationRecord
-    validates_presence_of :key, :locale, :file_path
-    validate :file_path_must_exist
+    validates_presence_of :key, :locale, :value
 
-    private
+    # what if the key is present in multiple file_paths?
+    def file_path
+      @key_finder ||= KeyFinder.new
+      @key_finder.file_paths_for(key, locale: locale).first
+    end
 
-    def file_path_must_exist
-      errors.add(:file_path, "must exist") unless file_path && File.exist?(file_path)
+    def self.by_file_path(file_path)
+      key_finder = KeyFinder.new
+      all.select { |translation| key_finder.file_paths_for(translation.key, locale: translation.locale).include?(file_path) }
     end
   end
 end

data/app/models/moirai/translation_dumper.rb

@@ -1,24 +1,51 @@
 module Moirai
   class TranslationDumper
+    def initialize
+      @key_finder = KeyFinder.new
+    end
+
+    # @return Array[Moirai::Change]
     def call
-      project_root = Rails.root.to_s
-      Moirai::Translation.pluck(:file_path).uniq.map do |file_path|
-        absolute_file_path = File.expand_path(file_path, project_root)
-        next unless absolute_file_path.start_with?(project_root)
-
-        updated_file_contents = get_updated_file_contents(file_path)
-        {
-          file_path: file_path.sub(project_root, "."),
-          content: updated_file_contents
-        }
-      end.compact
+      translations_by_file_path = group_translations_by_file_path
+      changes = []
+      translations_by_file_path.each do |file_path, translations|
+        relative_file_path = Pathname.new(file_path).relative_path_from(Rails.root)
+        changes << Change.new(relative_file_path, get_updated_file_contents(file_path, translations))
+      end
+      changes
+    end
+
+    def best_file_path_for(key, locale)
+      file_paths = @key_finder.file_paths_for(key, locale: locale)
+      file_paths.filter! { |p| p.start_with?(Rails.root.to_s) }
+      if file_paths.any?
+        file_paths.first
+      elsif key.split(".").size > 1
+        parent_key = key.split(".")[0..-2].join(".")
+        best_file_path_for(parent_key, locale)
+      else
+        "./config/locales/#{locale}.yml"
+      end
     end
 
     private
 
-    def get_updated_file_contents(file_path)
-      translations = Moirai::Translation.where(file_path: file_path)
+    def group_translations_by_file_path
+      translations_grouped_by_file_path = {}
+      Moirai::Translation.order(created_at: :asc).each do |translation|
+        file_path = best_file_path_for(translation.key, translation.locale)
+        absolute_file_path = File.expand_path(file_path, Rails.root)
+
+        # skip file paths that don't belong to the project
+        next unless absolute_file_path.to_s.start_with?(Rails.root.to_s)
+
+        translations_grouped_by_file_path[absolute_file_path] ||= []
+        translations_grouped_by_file_path[absolute_file_path] << translation
+      end
+      translations_grouped_by_file_path
+    end
 
+    def get_updated_file_contents(file_path, translations)
       yaml = YAML.load_file(file_path)
 
       translations.each do |translation|

data/app/views/layouts/moirai/application.html.erb

@@ -6,7 +6,6 @@
   <%= csp_meta_tag %>
 
   <%= stylesheet_link_tag    "moirai/application", media: "all" %>
-  <%= javascript_include_tag "moirai/application", "data-turoblinks-track": "reload", type: "module" %>
   <link rel="stylesheet" href="https://cdn.simplecss.org/simple.min.css">
   <link rel="icon" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAMAAABEpIrGAAAC/VBMVEUAAACcnKyEcFGLlc/AuavOyr+tm3zCrIGTgmaDbkypnojJw6rQv5jNv6TX5fLl8v+fiGatmnPFtpKXgWKVgF2Tg2WVfFmhkG+ejG2kjmmrmXqiloGGb0urnH+pnonDupyNdVHSyamempOSe1q5sqSQioqkk2yThmuWeVONeVaPgmeIdFXItIvArYaMdlOSfVm3qIKxo3+unXijjmePgWeXhmmSfFrEs5C8rozQw5zUxqSelIC2o33Nw6Sgi2imlnuZi3SfiGewoYStn4eVhGquopWampXJw66VlZWqqp6He2aYj3q6rJKqo5GWj3+Nf2VmWUXAuaSlnYqhmoidl4aSineThW2OhG2CemiFdFh7ZUXJxbLFv6q5taSjno2wpIusoIaalYakmICik3qWjXqOhXOViG+Kgm5+dGCRfFqFb01lWklvXkXd2MTBuqa5sp20rZqwqpi8sJetp5S2qZCdmIm2p4ieloKqnIGak4GtnoCdlX+OiHeik3SYi3SKhHSRhnKdjnGciGWTgWSbhGCDd2CMfF5/c153cF56b1uBcVh1a1h+cFWHc1SPd1OKdFNxZ1N7a1J1aFJoYE9uYUt0Y0pxYkptX0diVkRbUEDX0LrIwau9uKi8t6PAs5WzqpSyqJCpoIy/rYWgl4WXk4OWkYOpmXySjXycknu4oXedkHe1nHGMgnGGf3CJf2yShGqkj2l9dmV4c2OWg2CTf1+HeF6CdV2Wf1yKeFqJeFd4a1WBb1GKck90Z0/V0cLOy7nPyLLLwqvKv6PCt568tJ6/s5q4sJinpZTMuZC9sI+uoYinnIWmlniBfW+gjmyPgmqEe2msk2iXhmiJe2SgiGKFeGCVgV9zbV6jiVxwalmQeVeDcVR5Z01qXEl+Z0VzXkBIPzHi38zExbnFw7TTyrLe0ajCvai0saHWxp7NvJqZl47UuYWim4XKsoSmmoC0oX6ym3aZjXSnlG+Wg2Ssj2J9cluYflKVeU90YkNtWz90Xj5mUjhXSThYSzdqUjbGwv6GAAAASnRSTlMACv4FHBL9+OaxWUU7KQwG6+Pg4NzW1sO1qZ2Zl5BtbGxYSTYkE/78/Pr4+PTw8O/t5djYy8rKxsG/sKunnZGBcG1qYFc8MC8pFazVjw8AAAMwSURBVDjLlZNTcFxhGEC32zRJU6S2bdvGXds2Ytu2bdtO6sa2k9o2p707yaTNtA85r+fM/Jjvg0yAydOOz9mmoqKy/eBKpX/p1YeV88t8AgZK3fvyZi9fN97POLJBPgBYi3S0SYQYwoeS2Wcm/+WnzZFYG6NE2sj7N7h+sJeRrUF5Syb96XfJnR5Ut1R04aOS+T2FKc/SPnflLx4rLu4OImdYZHcPhghQIlqGRVr3x0BnROeJUT/pkLvY6Ok9EvVnf44WDRnyzkuIsRJzXTedGwlWJhrGUhqqaJqBAYw7ScNyEh1jJCN1uHksWK/wU/a413tSOQ1WGrhMukZouABHCw7JbPLxrqCeVgSrS3KyqOj4CI1HV8KxJoxQDf5zgV4GzKvPHX1Acc9jgTpomdXdUDjnqjaTAcuJvglEmpGxXB9ft61rwRP2ypjBzXqaj1OQYUiGyDtOcLvJJtwPhsFZu6BWgX+40y3OKFcz9YWEqUMjA9W8dH0WhyFzQiBklpbLfgfToYAbBkF3bKcwr2g5w96S/JLpV8nEqDA/19q6qWDg4UTg02Ho1iCCZq6zGN0TEoSIH2bd8PY3vc1SBFAXbIxLMNvU1P9HbpW+A54AlX/7jg5GA0TdaDCYsUMcZ4SrNDS0saNgr9s0M7VcbYuk3kISm2fGXga+YgGQHoOtiW3kWQivsR3MDTCAXaOnb60+qjA6FXwFZHGBCcCKNTU2ViaawfjpBpjM/GxJQJ0uHA7fshYM1MqxKEv9J0JhohNCz8Tc4FabxL5TToQbwrn7FD+5fh5KzzdRubDYw/ohHofkVHZQ7Irs7QuM2VmnIApWSMw5PIpPe7YDPgJvkHBLXOzYW57mmPxm/uWReVhIRdRw7YpsgWs4HXxClEO/LdQzpcV/oxpkhAuzoFksooV9akTSdZN4s1KvvJLe959cl47N7ZpZX4k29a/bzLVuIhMIvmW2Umk55ehMUI0WcwcdC165aOvC+UmCUqkXdah4KejHuLTI80ugKEw3Eoa08h+SBqiuUB+/WWoLN5ehLHlksnOFh6pis8ajfv7kovnzVOfuX3JWCfI/ZiopTVGHTIhfmYNNrIltIWMAAAAASUVORK5CYII=">
 </head>

data/app/views/moirai/translation_files/_form.html.erb

@@ -1,9 +1,9 @@
 <span 
   contenteditable 
-  data-action="blur->moirai-translation#submit click->moirai-translation#click" 
+  data-action="blur->moirai-translation#submit click->moirai-translation#click"
   style="border: 1px dashed #1d9f74; min-width: 30px; display: inline-block;" 
-  data-key="<%= key %>" 
-  data-file-path="<%= file_path %>" 
+  data-moirai-translation-key-value="<%= key %>"
+  data-moirai-translation-locale-value="<%= locale %>"
   data-controller="moirai-translation">
   <%= value %>
 </span>

data/app/views/moirai/translation_files/index.html.erb

@@ -2,7 +2,7 @@
   <h1>Translation files</h1>
 
 <% if Moirai::PullRequestCreator.available? %>
-  <%= button_to "Create or update PR", moirai_open_pr_path %>
+  <%= button_to "Create or update Pull Request", moirai_open_pr_path %>
 <% else %>
   <p>PR creation is not available. Add the gem octokit to your gemfile to enable this feature</p>
 <% end %>

data/app/views/moirai/translation_files/show.html.erb

@@ -13,7 +13,7 @@
     </thead>
     <tbody>
       <% @translation_keys.each do |key, value| %>
-        <% translation = Moirai::Translation.find_by(key: key, file_path: @decoded_path) %>
+        <% translation = @translations.find { |t| t.key == key } %>
 
         <tr>
           <td>
@@ -24,10 +24,10 @@
             <% end %>
           </td>
           <td>
-            <%= form_for Moirai::Translation.new, url: moirai_create_or_update_translation_path do |f| %>
-              <%= f.hidden_field :key, value: key %>
-              <%= f.hidden_field :file_path, value: @decoded_path %>
-              <%= f.text_field :value, value: translation&.value || value %>
+            <%= form_for translation&.presence || Moirai::Translation.new(key: key, locale: @locale, value: value), url: moirai_create_or_update_translation_path, method: :post do |f| %>
+              <%= f.hidden_field :key %>
+              <%= f.hidden_field :locale %>
+              <%= f.text_field :value %>
               <%= f.submit 'Update', style: 'display: none;' %>
             <% end %>
           </td>

data/app/views/moirai/translations/index.html.erb

@@ -0,0 +1,7 @@
+<% @translations.each do |locale, key, value| %>
+  <div class="card">
+    <p><strong>Locale:</strong> <%=locale %></p>
+    <p><strong>Key:</strong> <%=key %></p>
+    <p><strong>Value:</strong> <%= value %></p>
+  </div>
+<% end %>

data/bin/check

@@ -1,4 +1,6 @@
 #!/usr/bin/env bash
 
+set -e
+
 bundle exec rails test
-#bundle exec rails test:system
+bundle exec rails test:system

data/config/routes.rb

@@ -3,7 +3,8 @@
 Moirai::Engine.routes.draw do
   root to: "translation_files#index"
 
-  resources :translation_files, only: %i[index show], as: "moirai_translation_files"
+  resources :translations, only: %i[index]
+  resources :translation_files, only: %i[index show], as: "moirai_translation_files", param: :hashed_file_path
   post "/translation_files/open_pr", to: "translation_files#open_pr", as: "moirai_open_pr"
   post "/translation_files", to: "translation_files#create_or_update", as: "moirai_create_or_update_translation"
 end

data/lib/generators/moirai/install_generator.rb

@@ -11,8 +11,7 @@ module Moirai
       end
 
       def mount_engine
-        route 'mount Moirai::Engine => "/moirai", as: "moirai"
-        '
+        route 'mount Moirai::Engine => "/moirai", as: "moirai"'
       end
     end
   end

data/lib/generators/moirai/migration_generator.rb

@@ -11,7 +11,11 @@ module Moirai
       source_root File.expand_path("templates", __dir__)
 
       def create_migration_file
-        migration_template "migration.rb.erb", "db/migrate/create_moirai_translations.rb", migration_version: migration_version
+        migration_template "create_moirai_translations.rb.erb", "db/migrate/create_moirai_translations.rb", migration_version: migration_version
+      end
+
+      def file_path_migration_file
+        migration_template "make_moirai_translations_file_path_not_required.rb.erb", "db/migrate/make_moirai_translations_file_path_not_required.rb", migration_version: migration_version
       end
 
       private

data/lib/generators/moirai/templates/make_moirai_translations_file_path_not_required.rb.erb

@@ -0,0 +1,5 @@
+class MakeMoiraiTranslationsFilePathNotRequired < ActiveRecord::Migration<%= migration_version %>
+  def change
+    change_column_null :moirai_translations, :file_path, true
+  end
+end

data/lib/i18n/backend/moirai.rb

@@ -1,6 +1,6 @@
 module I18n
   module Backend
-    class Moirai < I18n::Backend::Simple # TODO: no need to extend the simple one. It does too much
+    class Moirai < I18n::Backend::Simple
       # TODO: mega inefficient. we don't want to perform a SQL query for each key!
       def translate(locale, key, options = EMPTY_HASH)
         overridden_translation = ::Moirai::Translation.find_by(locale: locale, key: key)
@@ -8,58 +8,6 @@ module I18n
           overridden_translation.value
         end
       end
-
-      def store_moirai_translations(filename, locale, data, options)
-        moirai_translations[locale] ||= Concurrent::Hash.new
-        flatten_data = flatten_hash(filename, data)
-        flatten_data = Utils.deep_symbolize_keys(flatten_data) unless options.fetch(:skip_symbolize_keys, false)
-        Utils.deep_merge!(moirai_translations[locale], flatten_data)
-      end
-
-      def moirai_translations(do_init: false)
-        @moirai_translations ||= Concurrent::Hash.new do |h, k|
-          MUTEX.synchronize do
-            h[k] = Concurrent::Hash.new
-          end
-        end
-      end
-
-      def flatten_hash(filename, hash, parent_key = "", result = {})
-        hash.each do |key, value|
-          new_key = parent_key.empty? ? key.to_s : "#{parent_key}.#{key}"
-          case value
-          when Hash
-            flatten_hash(filename, value, new_key, result)
-          when Array
-            value.each_with_index do |item, index|
-              array_key = "#{new_key}.#{index}"
-              if item.is_a?(Hash)
-                flatten_hash(filename, item, array_key, result)
-              else
-                result[array_key] = filename
-              end
-            end
-          else
-            result[new_key] = filename
-          end
-        end
-        result
-      end
-
-      def load_file(filename)
-        type = File.extname(filename).tr(".", "").downcase
-        raise UnknownFileType.new(type, filename) unless respond_to?(:"load_#{type}", true)
-        data, keys_symbolized = send(:"load_#{type}", filename)
-        unless data.is_a?(Hash)
-          raise InvalidLocaleData.new(filename, "expects it to return a hash, but does not")
-        end
-        data.each do |locale, d|
-          store_translations(locale, d || {}, skip_symbolize_keys: keys_symbolized)
-          store_moirai_translations(filename, locale, d || {}, skip_symbolize_keys: keys_symbolized)
-        end
-
-        data
-      end
     end
   end
 end

data/lib/moirai/engine.rb

@@ -9,9 +9,7 @@ module Moirai
     end
 
     config.after_initialize do
-      moirai_backend = I18n::Backend::Moirai.new
-      moirai_backend.eager_load!
-      I18n.backend = I18n::Backend::Chain.new(moirai_backend, I18n.backend)
+      I18n.backend = I18n::Backend::Chain.new(I18n::Backend::Moirai.new, I18n.backend)
     end
 
     # TODO: how to do this without rewriting the entire method?
@@ -25,12 +23,11 @@ module Moirai
             value = original_translate(key, **options)
 
             if moirai_edit_enabled?
-              moirai_translations = I18n.backend.backends.find { |b| b.respond_to?(:moirai_translations) }.moirai_translations
-              file_path = moirai_translations[I18n.locale][scope_key_by_partial(key)]
+              @key_finder ||= Moirai::KeyFinder.new
 
               render(partial: "moirai/translation_files/form",
                 locals: {key: scope_key_by_partial(key),
-                         file_path: file_path,
+                         locale: I18n.locale,
                          value: value})
             else
               value

data/lib/moirai/pull_request_creator.rb

@@ -1,41 +1,43 @@
 class Moirai::PullRequestCreator
-  BRANCH_NAME = "moirai-translations"
-
   def self.available?
-    defined?(Octokit)
+    !!defined?(Octokit)
   end
 
+  BRANCH_PREFIX = "moirai-translations-"
+
+  attr_reader :github_repo_name, :github_access_token, :github_client, :github_repository, :branch_name
+
   def initialize
     @github_repo_name = ENV["MOIRAI_GITHUB_REPO_NAME"] || Rails.application.credentials.dig(:moirai, :github_repo_name)
     @github_access_token = ENV["MOIRAI_GITHUB_ACCESS_TOKEN"] || Rails.application.credentials.dig(:moirai, :github_access_token)
-    @client = Octokit::Client.new(
-      access_token: @github_access_token
-    )
+    @github_client = Octokit::Client.new(access_token: github_access_token)
+    @github_repository = github_client.repo(github_repo_name)
   end
 
-  def create_pull_request(translations_array)
-    repo = @client.repo(@github_repo_name)
-    default_branch = repo.default_branch
+  # @param changes Array[Moirai::Change]
+  def create_pull_request(changes)
+    @branch_name = "#{BRANCH_PREFIX}#{Time.current.strftime("%F-%H-%M-%S")}-#{rand(1000..9999)}"
+    default_branch = github_repository.default_branch
 
-    if branch_exists?
-      puts "Branch #{BRANCH_NAME} already exists - the branch will be updated with the new changes"
+    if moirai_branch_exists?
+      Rails.logger.debug { "Branch #{branch_name} already exists - the branch will be updated with the new changes" }
     else
-      puts "Branch #{BRANCH_NAME} does not exist - creating branch"
-      default_branch_ref = @client.ref(@github_repo_name, "heads/#{default_branch}")
+      Rails.logger.debug { "Branch #{branch_name} does not exist - creating branch" }
+      default_branch_ref = @github_client.ref(@github_repo_name, "heads/#{default_branch}")
       latest_commit_sha = default_branch_ref.object.sha
 
-      @client.create_ref(@github_repo_name, "heads/#{BRANCH_NAME}", latest_commit_sha)
+      @github_client.create_ref(@github_repo_name, "heads/#{branch_name}", latest_commit_sha)
     end
 
-    translations_array.each do |translation_hash|
-      update_file(translation_hash[:file_path], translation_hash[:content])
+    changes.each do |change|
+      update_file(change.file_path, change.content)
     end
 
-    unless pull_request_exists?
-      pull_request = @client.create_pull_request(
+    unless existing_open_pull_request.present?
+      pull_request = @github_client.create_pull_request(
         @github_repo_name,
         default_branch,
-        BRANCH_NAME,
+        branch_name,
         "Adding new content by Moirai",
         "BODY - This is a pull request created by Moirai"
       )
@@ -44,40 +46,47 @@ class Moirai::PullRequestCreator
     end
   end
 
-  def branch_exists?
-    @client.ref(@github_repo_name, "heads/#{BRANCH_NAME}")
+  def moirai_branch_exists?
+    @github_client.ref(@github_repo_name, "heads/#{branch_name}")
     true
   rescue Octokit::NotFound
     false
   end
 
+  def existing_open_pull_request
+    @github_client.pull_requests(@github_repo_name).find do |pull_request|
+      pull_request.head.ref.start_with?(BRANCH_PREFIX) && (pull_request.state == "open")
+    end
+  end
+
+  def cleanup
+    pr = existing_open_pull_request
+    @github_client.close_pull_request(@github_repo_name, pr.number)
+    @github_client.delete_branch(@github_repo_name, pr.head.ref)
+  end
+
+  private
+
   def update_file(path, content)
     # TODO: check what happens if branch exists
-
-    file = @client.contents(@github_repo_name, path: path, ref: BRANCH_NAME)
+    file = @github_client.contents(@github_repo_name, path: path, ref: branch_name)
     file_sha = file.sha
 
-    @client.update_contents(
+    @github_client.update_contents(
       @github_repo_name,
       path,
       "Updating translations for #{path} by Moirai",
       file_sha,
       content,
-      branch: BRANCH_NAME
+      branch: branch_name
     )
   rescue Octokit::NotFound
-    @client.create_contents(
+    @github_client.create_contents(
       @github_repo_name,
       path,
       "Creating translations for #{path} by Moirai",
       content,
-      branch: BRANCH_NAME
+      branch: branch_name
     )
   end
-
-  def pull_request_exists?
-    @client.pull_requests(@github_repo_name).any? do |pull_request|
-      pull_request.head.ref == BRANCH_NAME
-    end
-  end
 end

data/moirai.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "moirai"
-  spec.version = "0.1.0"
+  spec.version = "0.2.0"
   spec.authors = ["Alessandro Rodi", "Oliver Anthony", "Daniel Bengl"]
   spec.email = %w[alessandro.rodi@renuo.ch oliver.anthony@renuo.ch daniel.bengl@renuo.ch]
 
@@ -25,11 +25,6 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.7.0"
   spec.add_dependency "rails", ">= 6.1"
-  spec.add_development_dependency "octokit", ">= 4.0"
-  spec.add_development_dependency "capybara"
-  spec.add_development_dependency "selenium-webdriver"
-  spec.add_development_dependency "rails", "~> 7.2.0"
-  spec.add_development_dependency "dotenv"
 
   spec.license = "MIT"
   spec.metadata["rubygems_mfa_required"] = "true"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moirai
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alessandro Rodi
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-23 00:00:00.000000000 Z
+date: 2024-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -26,76 +26,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.1'
-- !ruby/object:Gem::Dependency
-  name: octokit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: capybara
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: selenium-webdriver
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 7.2.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 7.2.0
-- !ruby/object:Gem::Dependency
-  name: dotenv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: |-
   This gem allows you to manage translation strings in real time,
       viewing the live changes in the browser, with the changes then converted to a PR opened on the repository.
@@ -117,17 +47,18 @@ files:
 - Rakefile
 - app/assets/config/moirai_manifest.js
 - app/assets/images/moirai/.keep
-- app/assets/javascripts/moirai/application.js
-- app/assets/javascripts/moirai/controllers/moirai_translation_controller.js
-- app/assets/javascripts/moirai/stimulus/init.js
+- app/assets/javascripts/moirai_translation_controller.js
 - app/assets/stylesheets/moirai/application.css
 - app/controllers/concerns/.keep
 - app/controllers/moirai/application_controller.rb
 - app/controllers/moirai/translation_files_controller.rb
+- app/controllers/moirai/translations_controller.rb
 - app/helpers/moirai/application_helper.rb
 - app/jobs/moirai/application_job.rb
 - app/models/concerns/.keep
 - app/models/moirai/application_record.rb
+- app/models/moirai/change.rb
+- app/models/moirai/key_finder.rb
 - app/models/moirai/translation.rb
 - app/models/moirai/translation_dumper.rb
 - app/models/moirai/translation_file_handler.rb
@@ -135,6 +66,7 @@ files:
 - app/views/moirai/translation_files/_form.html.erb
 - app/views/moirai/translation_files/index.html.erb
 - app/views/moirai/translation_files/show.html.erb
+- app/views/moirai/translations/index.html.erb
 - bin/check
 - bin/console
 - bin/fastcheck
@@ -143,7 +75,8 @@ files:
 - config/routes.rb
 - lib/generators/moirai/install_generator.rb
 - lib/generators/moirai/migration_generator.rb
-- lib/generators/moirai/templates/migration.rb.erb
+- lib/generators/moirai/templates/create_moirai_translations.rb.erb
+- lib/generators/moirai/templates/make_moirai_translations_file_path_not_required.rb.erb
 - lib/i18n/backend/moirai.rb
 - lib/moirai.rb
 - lib/moirai/engine.rb

data/app/assets/javascripts/moirai/application.js

@@ -1,2 +0,0 @@
-//= require ./stimulus/init
-//= require ./controllers/moirai_translation_controller

data/app/assets/javascripts/moirai/controllers/moirai_translation_controller.js

@@ -1,27 +0,0 @@
-Stimulus.register(
-  "moirai-translation",
-  class extends Controller {
-    click(event) {
-      event.preventDefault()
-    }
-
-    submit(event) {
-      const {filePath, key} = event.target.dataset
-
-      const csrfToken = document.querySelector('meta[name="csrf-token"]').content  
-
-      const formObject = new FormData()
-      formObject.append('translation[key]', key)
-      formObject.append('translation[file_path]', filePath)
-      formObject.append('translation[value]', event.target.innerText)
-
-      fetch(`/moirai/translation_files`, {
-        method: 'POST',
-        headers: {
-          'X-CSRF-Token': csrfToken
-        },
-        body: formObject
-      })
-    }
-  }
-);

data/app/assets/javascripts/moirai/stimulus/init.js

@@ -1,5 +0,0 @@
-import {
-  Application,
-  Controller,
-} from "https://unpkg.com/@hotwired/stimulus/dist/stimulus.js";
-window.Stimulus = Application.start();