moirai 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f735406747923f4a2493a81628e4cd88cf6f54d926fb31448ca5dab4ae70a8b9
-  data.tar.gz: 40f69e72824a96f13fe4e67b753a36617a745cdca04c61e691c7cc7877c55b96
+  metadata.gz: e9d7f98e48e08b3e5208041fbba3344f5b280492754b7943e159d0e90e71d075
+  data.tar.gz: d4aa78c7ae9f0c27f18c3e760def299c5d8faf054b06423e300b2c095976ef0c
 SHA512:
-  metadata.gz: 19eeb5b122adcd1f46fbfee0a39440f5d6ef9536bf28f8486f36fed40506d61449793adc6681cd3ce5eb35c10f9b5021928f97494e0c7063a5736fc8c0a2ea90
-  data.tar.gz: 9e3d8298eac29bca6008af867b57f8e663d9128c07bccf531c400c2c2889109b15515b676b6bbd0d85144fae119cc087a5ad3bb6cec83564edae67907b73543c
+  metadata.gz: cb39e17d721373254b27086f4cf351c6145a3aa921809b8de0921ca82c661d53e0a1fb38da524c4fe012c2ecfcde7ffa2ec1029432e88d0cc43cf2f067c55341
+  data.tar.gz: 601b7c5353bbc71cd094223df88b74dc9f82d07657f306f8402160bc47f4d056940a28db55b8b88f4fd2275c23e66379e2778e2856f0d93a57defd7b706dc68c

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,9 +33,17 @@ 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
+
+      - name: Archive logs
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: test.log
+          path: test/dummy/log/test.log
   lint:
     name: Lint
     runs-on: ubuntu-latest

data/CHANGELOG.md

@@ -1,6 +1,27 @@
+## 0.3.0
+
+* Added a method `I18n.translate_without_moirai` ([@oliveranthony17][])
+* Simplified stimulus setup ([@coorasse][])
+* Fixed some setup issues in test environments ([@oliveranthony17][])
+* Show original translation when deleting the whole inline editing content. ([@CuddlyBunion341][])
+
+## 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

@@ -5,12 +5,13 @@
 ### Manage translation strings in real time
 
 - Let your non-developer team members finally manage translations (yes, even Karen from marketing...).
-- See those translations live in your app, so you can make sure “Submit” isn’t overlapping the button where “**Do not press this button EVER” should be.
-- Automatically create Pull Requests based on these changes, saving your developers from yet another “small tweak” email request.
+- See those translations live in your app, so you can make sure “Submit” isn’t overlapping the button where “**Do not
+  press this button EVER” should be.
+- Automatically create Pull Requests based on these changes, saving your developers from yet another “small tweak” email
+  request.
 
 > Let the world be translated, one typo at a time.
 
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -20,11 +21,13 @@ gem "moirai"
 ```
 
 And then execute:
+
 ```bash
 bundle
 ```
 
-Next, you need to run the generator which will create the necessary files including the database migration, as well as inserting the engine in the `routes.rb` file:
+Next, you need to run the generator which will create the necessary files including the database migration,
+as well as inserting the engine in the `routes.rb` file, and importing the necessary javascript files:
 
 ```bash
 bin/rails g moirai:install
@@ -40,27 +43,51 @@ bin/rails db:migrate
 
 ### How to change translations
 
-If you mounted Moirai under "/moirai", head there and you will find a list of all the files containing texts that can be translated.
-Open a file, change the value of translations, and press ENTER to update the translation and see it immediately changed on the application.
+If you mounted Moirai under "/moirai", head there and you will find a list of all the files containing texts that can be
+translated.
+Open a file, change the value of translations, and press ENTER to update the translation and see it immediately changed
+on the application.
 
 ### 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.
+
+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
+
 module ApplicationHelper
   def moirai_edit_enabled?
-    params[:moirai] == "true" || current_user&.admin?
+    params[:moirai] == "true" && current_user&.admin?
   end
 end
 ```
 
+You also need to have the moirai_translations_controller.js Stimulus Controller initialized.
+
+#### Importmap
+
+The command `bin/rails g moirai:install` should have already pinned the necessary controller for you in importmap.rb, so
+no further steps are needed.
+
+#### jsbulding
+
+The command `bin/rails g moirai:install` should have already copied the necessary controller for you in
+`app/javascripts/controllers`, so no further steps are needed.
+
+#### More?
+
+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, 
+If you would like Moirai to automatically create a pull request on GitHub to keep translations synchronized with the
+codebase,
 you need to set up [Octokit](https://github.com/octokit/octokit.rb).
-You will also need to create a **Personal Access Token** on GitHub, and configure the access in the appropriate **environment variables** (this is explained below).
+You will also need to create a **Personal Access Token** on GitHub, and configure the access in the appropriate *
+*environment variables** (this is explained below).
 
 #### 1. Add Octokit to Your Gemfile
 
@@ -74,22 +101,23 @@ Then run `bundle install`.
 
 #### 2. Create a Personal Access Token (PAT) on GitHub
 
-You will need a Personal Access Token (PAT) with the `Content - Write` permission to allow Octokit to create branches and pull requests.
+You will need a Personal Access Token (PAT) with the `Content - Write` permission to allow Octokit to create branches
+and pull requests.
 
--	Go to GitHub Token Settings.
--	Click Generate New Token.
--	Give your token a name (e.g., “Moirai”).
--	Under Scopes, select:
-     -	repo (for full control of private repositories, including writing content).
-     -	content (for read/write access to code, commit statuses, and pull requests).
--	Generate the token and copy it immediately as it will be shown only once.
+- Go to GitHub Token Settings.
+- Click Generate New Token.
+- Give your token a name (e.g., “Moirai”).
+- Under Scopes, select:
+    - repo (for full control of private repositories, including writing content).
+    - content (for read/write access to code, commit statuses, and pull requests).
+- Generate the token and copy it immediately as it will be shown only once.
 
 #### 3. Set Up Environment Variables
 
 You need to configure the following environment variables in your application:
 
--	`MOIRAI_GITHUB_REPO_NAME`: The name of the repository where the pull request will be created.
--	`MOIRAI_GITHUB_ACCESS_TOKEN`: The Personal Access Token (PAT) you created earlier.
+- `MOIRAI_GITHUB_REPO_NAME`: The name of the repository where the pull request will be created.
+- `MOIRAI_GITHUB_ACCESS_TOKEN`: The Personal Access Token (PAT) you created earlier.
 
 For example, in your `.env` file:
 
@@ -98,7 +126,8 @@ MOIRAI_GITHUB_REPO_NAME=your-organization/your-repo
 MOIRAI_GITHUB_ACCESS_TOKEN=your-generated-token
 ```
 
-We also support Rails credentials. The environment variables need to be stored in a slightly different way to adhere to convention. For example:
+We also support Rails credentials. The environment variables need to be stored in a slightly different way to adhere to
+convention. For example:
 
 ```env
 moirai:
@@ -108,13 +137,14 @@ moirai:
 
 #### 4. Triggering the pull request creation
 
-Moirai will now be able to use this Personal Access Token to create a pull request on GitHub when a translation is updated.
+Moirai will now be able to use this Personal Access Token to create a pull request on GitHub when a translation is
+updated.
 
 To trigger this, you can press the `Create or update PR` button once you have made your changes.
 
 ### Authentication
 
-Moirai allows you to use basic HTTP authentication to protect the engine. 
+Moirai allows you to use basic HTTP authentication to protect the engine.
 To enable this, you need to set the following environment variables:
 
 ```env
@@ -124,11 +154,11 @@ MOIRAI_BASICAUTH_PASSWORD=moirai
 
 > ⚠️ Remember to protect Moirai. You don't want to give everyone the possibility to change strings in the application.
 
-If you have authenticated users, you can leverage the Rails Routes protection mechanism to protect the engine. 
+If you have authenticated users, you can leverage the Rails Routes protection mechanism to protect the engine.
 See the following example:
 
 ```ruby
-authenticated :user, lambda {|u| u.role == "admin"} do
+authenticated :user, lambda { |u| u.role == "admin" } do
   mount Moirai::Engine => '/moirai', as: 'moirai'
 end
 ```
@@ -153,6 +183,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,10 +205,10 @@ 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).
 
 ## Copyright

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,41 @@
+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
+        }
+      })
+    })
+    .then(response => response.json())
+    .then(data => {
+      if (data?.fallback_translation) {
+        event.target.innerText = data.fallback_translation
+      }
+    })
+    .catch(error => {
+      console.error('Error:', error);
+    });
+  }
+}

data/app/assets/stylesheets/moirai/application.css

@@ -12,4 +12,6 @@
  *
  *= require_tree .
  *= require_self
+ *= require translation_files
+
  */

data/app/assets/stylesheets/translation_files.css

@@ -0,0 +1,22 @@
+td {
+  height: 100px;
+  width: 200px;
+  vertical-align: top;
+}
+
+form {
+  height: 100%;
+  display: flex;
+  align-items: stretch;
+}
+
+textarea.translation-textarea {
+  width: 100%;
+  height: auto;
+  resize: vertical;
+  min-height: 3em;
+  overflow: hidden;
+  margin-bottom: 0;
+}
+
+/*# TODO: this isn't coming through */

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,11 +37,19 @@ 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)
+        respond_to do |format|
+          format.json do
+            render json: {
+              fallback_translation: get_fallback_translation
+            }
+          end
+          format.html do
+            flash.notice = "Translation #{translation.key} was successfully deleted."
+            redirect_to_translation_file(translation.file_path)
+          end
+        end
         return
       end
 
@@ -51,26 +59,41 @@ 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
 
+      if translation_params[:value].blank? && request.format.json?
+        return render json: {fallback_translation: get_fallback_translation}
+      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
+          flash.discard
+          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 +101,41 @@ 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
+
+    def get_fallback_translation
+      file_paths = KeyFinder.new.file_paths_for(translation_params[:key], locale: translation_params[:locale])
+
+      return "" if file_paths.empty?
+      return "" unless file_paths.all? { |file_path| File.exist?(file_path) }
+
+      @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