moirai 0.4.2 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1ccb1de7355ee89f7ab7c774ef50df313d18e76073cdfca05274c90ffc1b00e
-  data.tar.gz: 2baade3d17dd785693a3770687bf16555624508936db76cc65346ad83f143319
+  metadata.gz: 47104e0b041ca51bf1ea9211f52cb8ccd362d5458903a734a6596189ed8da6d3
+  data.tar.gz: 1a183a9d886321f9930d921068741a78c358ea81846fe4355a7d1271aac315af
 SHA512:
-  metadata.gz: 86aaf468fff8de8cdd1c0de8f3af40bccc4fab4ef14c752bea1773d5c5cb7dd3e0a2a1d89616c295265a1d9407398f3c7d31a5a6c8b04185358b02202cebf7c0
-  data.tar.gz: d822eed2aae03aa6f1eaa4274d2a187d724125ab7b64b8dac6344b5235208ce5995e1703012d905d8384ec7634cb9d191ebd215266147437ab3962b263379bde
+  metadata.gz: 6d42da4c494dd4e9272014b54771dbc60297d019489ae44da09416820fc0f68a892508f991a8709a05f61bad09c4a77b5a5b6717d44d2605c0fb02b6990a2b39
+  data.tar.gz: f81cab05487087ecb4efa1b6c4b82b2e4ea3667d1bcb5a0e8654cb56c89e9e5e106685fbc912a208ec3be4d4d9c599c04d88ba01f86f3b4fc4538a09cb0d2400

data/CHANGELOG.md

@@ -1,10 +1,18 @@
+## 0.4.4
+
+* Allow to configure the root_path of moirai
+
+## 0.4.3
+
+* Do not initialize moirai if we don't have a database connection. ([@coorasse][])
+
 ## 0.4.2
 
-* Fix bug when the params is defined but is `nil`
+* Fix bug when the params is defined but is `nil`. ([@coorasse][])
 
 ## 0.4.1
 
-* Fix bug when the string is not a string, but a boolean
+* Fix bug when the string is not a string, but a boolean. ([@coorasse][])
 
 ## 0.4.0 - Breaking Changes ⚠️
 
@@ -16,7 +24,7 @@ config.moirai.enable_inline_editing = ->(params:) { your_options_here }
 
 move in here the conditions you had previously defined in the helper.
 
-* Moirai now works also in emails. That's why we have a breaking change.
+* Moirai now works also in emails. That's why we have a breaking change. ([@coorasse][])
 
 ## 0.3.1
 

data/README.md

@@ -41,6 +41,15 @@ bin/rails db:migrate
 
 ## Usage
 
+### Mount path
+
+By default, Moirai is mounted under `/moirai`. You can change it by specifying the `root_path` option in `config/initializers/moirai.rb`:
+
+```ruby
+# config/initializers/moirai.rb
+config.root_path = '/my_translations'
+```
+
 ### 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
@@ -104,12 +113,13 @@ Then run `bundle install`.
 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).
+- Go to [GitHub Token Settings](https://github.com/settings/personal-access-tokens/).
+- Click Generate New Token in Fine Grained Tokens.
+- Give your token a name (e.g., "moirai").
+- Under Repository Permissions, select:
+    - Actions - Read/Write
+    - Contents - Read/Write
+    - Pull Request - Read/Write
 - Generate the token and copy it immediately as it will be shown only once.
 
 #### 3. Set Up Environment Variables

data/app/assets/javascripts/moirai_translation_controller.js

@@ -2,6 +2,7 @@ import { Controller } from "@hotwired/stimulus"
 
 export default class MoiraiTranslationController extends Controller {
   static values = {
+    rootPath: { type: String, default: '/moirai' },
     key: String,
     locale: String
   }
@@ -13,7 +14,7 @@ export default class MoiraiTranslationController extends Controller {
   submit(event) {
     const csrfToken = document.querySelector('meta[name="csrf-token"]').content
 
-    fetch('/moirai/translation_files', {
+    fetch(`${this.rootPathValue}/translation_files`, {
       method: 'POST',
       headers: {
         'X-CSRF-Token': csrfToken,

data/app/models/moirai/translation.rb

@@ -14,5 +14,10 @@ module Moirai
       key_finder = KeyFinder.new
       all.select { |translation| key_finder.file_paths_for(translation.key, locale: translation.locale).include?(file_path) }
     end
+
+    def in_sync_with_file?
+      translation_without_moirai = I18n.translate_without_moirai(key, locale)
+      translation_without_moirai.present? && translation_without_moirai == value
+    end
   end
 end

data/app/models/moirai/translation_sync.rb

@@ -0,0 +1,15 @@
+module Moirai
+  class TranslationSync
+    def initialize
+      @translations = Moirai::Translation.all
+    end
+
+    def synchronize
+      Rails.logger.info "Synchronizing translations..."
+      @translations.each do |translation|
+        translation.destroy if translation.in_sync_with_file?
+      end
+      Rails.logger.info "Synchronization complete."
+    end
+  end
+end

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

@@ -1,9 +1,10 @@
-<span 
+<span
   contenteditable
   data-action="blur->moirai-translation#submit click->moirai-translation#click"
-  style="outline: 1px solid #1d9f74; min-width: 30px; display: inline-block; <%= 'color: red;' if is_missing_translation %>" 
+  style="outline: 1px solid #1d9f74; min-width: 30px; display: inline-block; <%= 'color: red;' if is_missing_translation %>"
   data-moirai-translation-key-value="<%= key %>"
   data-moirai-translation-locale-value="<%= locale %>"
-  data-controller="moirai-translation">
+  data-controller="moirai-translation"
+  data-moirai-translation-root-path-value="<%= Moirai.configuration.root_path %>">
   <%= value.to_s.gsub("<", "&lt;").gsub(">", "&gt;").html_safe %>
 </span>

data/lib/generators/moirai/install_generator.rb

@@ -24,14 +24,17 @@ module Moirai
         end
       end
 
-      private
-
       def using_js_bundling?
         Rails.root.join("app/javascript/controllers").exist?
       end
 
       def mount_engine
-        route 'mount Moirai::Engine => "/moirai", as: "moirai"'
+        route "mount Moirai::Engine, at: Moirai.configuration.root_path, as: 'moirai'"
+      end
+
+      def add_initializer
+        say "Copying Moirai initializer"
+        template "initializers/moirai.tt", "config/initializers/moirai.rb"
       end
 
       private

data/lib/generators/moirai/templates/initializers/moirai.tt

@@ -0,0 +1,5 @@
+# The values displayed here are the default ones. Change them to fit your needs.
+Moirai.configure do |config|
+  ## == Routing ==
+  config.root_path = '/moirai'
+end

data/lib/i18n/extensions/i18n.rb

@@ -8,6 +8,10 @@ module I18n
   def self.translate_without_moirai(key, locale, **)
     raise "Original backend is not set" unless original_backend
 
-    original_backend.translate(locale, key, **)
+    begin
+      original_backend.translate(locale, key, **)
+    rescue
+      nil
+    end
   end
 end

data/lib/moirai/configuration.rb

@@ -0,0 +1,21 @@
+module Moirai
+  class Configuration
+    attr_accessor :root_path
+
+    def initialize
+      @root_path = '/moirai'
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configuration=(config)
+    @configuration = config
+  end
+
+  def self.configure
+    yield configuration
+  end
+end

data/lib/moirai/engine.rb

@@ -10,18 +10,27 @@ module Moirai
 
     config.moirai = ActiveSupport::OrderedOptions.new
 
+    def self.on_sqlite?
+      defined?(ActiveRecord::ConnectionAdapters::SQLite3Adapter) &&
+        ActiveRecord::Base.connection.is_a?(ActiveRecord::ConnectionAdapters::SQLite3Adapter)
+    end
+
+    def self.on_postgres?
+      ActiveRecord::Base.connection.table_exists?("moirai_translations")
+    end
+
     config.after_initialize do
       I18n.original_backend = I18n.backend
       table_created =
         begin
-          (defined?(ActiveRecord::ConnectionAdapters::SQLite3Adapter) &&
-            ActiveRecord::Base.connection.is_a?(ActiveRecord::ConnectionAdapters::SQLite3Adapter)) ||
-            ActiveRecord::Base.connection.table_exists?("moirai_translations")
-        rescue ActiveRecord::NoDatabaseError
+          on_sqlite? || on_postgres?
+        rescue ActiveRecord::NoDatabaseError, ActiveRecord::ConnectionNotEstablished
           false
         end
       if table_created
         I18n.backend = I18n::Backend::Chain.new(I18n::Backend::Moirai.new, I18n.backend)
+        Rails.logger.info("moirai has been enabled.")
+        Moirai::TranslationSync.new.synchronize
       else
         Rails.logger.warn("moirai disabled: tables have not been generated yet.")
       end
@@ -38,5 +47,9 @@ module Moirai
         require "moirai/translation_helper"
       end
     end
+
+    initializer "moirai.assets" do |app|
+      app.config.assets.precompile += %w[moirai/application.css]
+    end
   end
 end

data/lib/moirai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Moirai
-  VERSION = "0.4.2"
+  VERSION = "0.4.4"
 end

data/lib/moirai.rb

@@ -4,6 +4,7 @@ require "moirai/version"
 require "i18n/extensions/i18n"
 require "i18n/backend/moirai"
 require "moirai/engine"
+require "moirai/configuration"
 require "moirai/pull_request_creator"
 
 module Moirai

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: moirai
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.4
 platform: ruby
 authors:
 - Alessandro Rodi
 - Oliver Anthony
 - Daniel Bengl
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-26 00:00:00.000000000 Z
+date: 2024-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -65,6 +65,7 @@ files:
 - app/models/moirai/translation.rb
 - app/models/moirai/translation_dumper.rb
 - app/models/moirai/translation_file_handler.rb
+- app/models/moirai/translation_sync.rb
 - app/views/application_mailer/test.html.erb
 - app/views/layouts/moirai/application.html.erb
 - app/views/moirai/translation_files/_form.html.erb
@@ -80,10 +81,12 @@ files:
 - lib/generators/moirai/install_generator.rb
 - lib/generators/moirai/migration_generator.rb
 - lib/generators/moirai/templates/create_moirai_translations.rb.erb
+- lib/generators/moirai/templates/initializers/moirai.tt
 - lib/generators/moirai/templates/make_moirai_translations_file_path_not_required.rb.erb
 - lib/i18n/backend/moirai.rb
 - lib/i18n/extensions/i18n.rb
 - lib/moirai.rb
+- lib/moirai/configuration.rb
 - lib/moirai/engine.rb
 - lib/moirai/pull_request_creator.rb
 - lib/moirai/translation_helper.rb
@@ -98,7 +101,7 @@ metadata:
   changelog_uri: https://github.com/renuo/moirai/CHANGELOG.md
   steep_types: sig
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -113,8 +116,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Manage translation strings in real time
 test_files: []