moirai 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecb41a395f21cd347b67e6e0233bd776a80493be4bf98d423077b7fd7cbe2005
-  data.tar.gz: 1335f5ca28ab8804459172894841f71cb8ac88740ce0b94d21096bc3a1713386
+  metadata.gz: 95cf427b4c903e4a772cad00b3165fc9a285d019678870996d6afd122ff9c4bf
+  data.tar.gz: ae20e09390c869f1971f309c2e049fddce6557f0122069175d7f9886e8719ea1
 SHA512:
-  metadata.gz: 927bd40a31ce569fca7b6d6a68194106db7616bf3a733009dd84669a387450a4808bc650aeff8f7f1d6aefe630d859db0c0486972008189e183f957247fada80
-  data.tar.gz: c8a831cd233bf06ff6160acd096346afb3ab8b1209b3bda7a5a4c7ccbecffe263fadaffd4829508d5f13cb3f4201fdf3658ef46ddcb1ae14c16d46ca4c85c324
+  metadata.gz: cd8ead3d31114b762f706f115102bc8f36f4d1d9082911e34ac37ac57ab26d9ebb1621c57f4bf3d91626b0e3ddac67d96ca65b60e0e239650b824b4d2bac64bd
+  data.tar.gz: 0db74b1d99fcd721b378ff9371f2342051f022e4bdd02023d04c73516733f3f76a091d65ad4f653d4411c17819e3a40d675605c4eee29c4622ac88b3aba43ee1

data/.semaphore/semaphore.yml

@@ -9,9 +9,10 @@ auto_cancel:
     when: "true"
 
 blocks:
-  - name: tests
+  - name: linter
     execution_time_limit:
       minutes: 10
+    dependencies: []
     task:
       secrets:
         - name: moirai
@@ -26,6 +27,21 @@ blocks:
         - name: linter
           commands:
             - bundle exec standardrb
+  - name: tests sqlite
+    execution_time_limit:
+      minutes: 10
+    dependencies: []
+    task:
+      secrets:
+        - name: moirai
+      prologue:
+        commands:
+          - checkout --use-cache
+          - cache restore
+          - bundle config set path 'vendor/bundle'
+          - bundle install -j 4
+          - cache store
+      jobs:
         - name: tests sqlite
           env_vars:
             - name: TARGET_DB
@@ -35,6 +51,22 @@ blocks:
           commands:
             - bin/rails db:create db:schema:load
             - bin/check
+  - name: tests postgres
+    execution_time_limit:
+      minutes: 10
+    dependencies:
+      - 'tests sqlite'
+    task:
+      secrets:
+        - name: moirai
+      prologue:
+        commands:
+          - checkout --use-cache
+          - cache restore
+          - bundle config set path 'vendor/bundle'
+          - bundle install -j 4
+          - cache store
+      jobs:
         - name: tests postgres
           env_vars:
             - name: TARGET_DB

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.4.0 - Breaking Changes ⚠️
+
+* Inline editing is now disabled by default. To enable it, specify the following in `application.rb`:
+
+```ruby
+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.
+
 ## 0.3.1
 
 * Fixes a problem when running a rake command and no database exists yet using postgres. ([@coorasse][])

data/README.md

@@ -50,21 +50,21 @@ 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.
+By default, inline editing is disabled. To enable it, specify the following in `application.rb`:
 
 ```ruby
+config.moirai.enable_inline_editing = ->(params:) { params[:moirai] == 'true' }
+```
 
-module ApplicationHelper
-  def moirai_edit_enabled?
-    params[:moirai] == "true" && current_user&.admin?
-  end
-end
+If you set `moirai=true` query parameter in the URL, inline editing will appear in your page.
+
+You probably want to only allow specific users to perform inline editing, this is an example of how you can do it:
+
+```ruby
+config.moirai.enable_inline_editing = ->(params:) { (params[:moirai] == 'true') && current_user&.admin? }
 ```
 
-You also need to have the moirai_translations_controller.js Stimulus Controller initialized.
+You also need to have the moirai_translations_controller.js Stimulus Controller initialized. Read below how to:
 
 #### Importmap
 

data/app/views/application_mailer/test.html.erb

@@ -0,0 +1 @@
+<%= t('email.welcome') %>

data/lib/moirai/engine.rb

@@ -8,6 +8,8 @@ module Moirai
       generator.orm :active_record
     end
 
+    config.moirai = ActiveSupport::OrderedOptions.new
+
     config.after_initialize do
       I18n.original_backend = I18n.backend
       table_created =
@@ -25,47 +27,15 @@ module Moirai
       end
     end
 
-    # TODO: how to do this without rewriting the entire method?
-    # https://github.com/rails/rails/blob/main/actionview/lib/action_view/helpers/translation_helper.rb#L122
+    initializer "rails_api_logger.config" do
+      config.moirai.each do |name, value|
+        Moirai.public_send(:"#{name}=", value)
+      end
+    end
+
     initializer "moirai.override_translation_helper" do
       ActiveSupport.on_load(:action_view) do
-        module ActionView::Helpers::TranslationHelper # rubocop:disable Lint/ConstantDefinitionInBlock
-          alias_method :original_translate, :translate
-
-          def translate(key, **options)
-            value = original_translate(key, **options)
-
-            is_missing_translation = value.include?('class="translation_missing"')
-            if value.is_a?(String) && is_missing_translation
-              value = extract_inner_content(value)
-            end
-
-            if moirai_edit_enabled?
-              @key_finder ||= Moirai::KeyFinder.new
-
-              render(partial: "moirai/translation_files/form",
-                locals: {key: scope_key_by_partial(key),
-                         locale: I18n.locale,
-                         is_missing_translation: is_missing_translation,
-                         value: value})
-            else
-              value
-            end
-          end
-
-          alias_method :t, :translate
-
-          def moirai_edit_enabled?
-            params[:moirai] == "true"
-          end
-
-          private
-
-          def extract_inner_content(html)
-            match = html.match(/<[^>]+>([^<]*)<\/[^>]+>/)
-            match ? match[1] : nil
-          end
-        end
+        require "moirai/translation_helper"
       end
     end
   end

data/lib/moirai/translation_helper.rb

@@ -0,0 +1,37 @@
+module ActionView::Helpers::TranslationHelper # rubocop:disable Lint/ConstantDefinitionInBlock
+  alias_method :original_translate, :translate
+
+  def translate(key, **)
+    value = original_translate(key, **)
+
+    is_missing_translation = value.include?('class="translation_missing"')
+    if value.is_a?(String) && is_missing_translation
+      value = extract_inner_content(value)
+    end
+
+    if moirai_edit_enabled?
+      @key_finder ||= Moirai::KeyFinder.new
+
+      render(partial: "moirai/translation_files/form",
+        locals: {key: scope_key_by_partial(key),
+                 locale: I18n.locale,
+                 is_missing_translation: is_missing_translation,
+                 value: value})
+    else
+      value
+    end
+  end
+
+  alias_method :t, :translate
+
+  def moirai_edit_enabled?
+    Moirai.enable_inline_editing.call(params: params || {})
+  end
+
+  private
+
+  def extract_inner_content(html)
+    match = html.match(/<[^>]+>([^<]*)<\/[^>]+>/)
+    match ? match[1] : nil
+  end
+end

data/lib/moirai/version.rb

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

data/lib/moirai.rb

@@ -7,5 +7,5 @@ require "moirai/engine"
 require "moirai/pull_request_creator"
 
 module Moirai
-  # Your code goes here...
+  mattr_accessor :enable_inline_editing
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: moirai
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Alessandro Rodi
 - Oliver Anthony
 - Daniel Bengl
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
 date: 2024-11-26 00:00:00.000000000 Z
@@ -65,6 +65,7 @@ files:
 - app/models/moirai/translation.rb
 - app/models/moirai/translation_dumper.rb
 - app/models/moirai/translation_file_handler.rb
+- app/views/application_mailer/test.html.erb
 - app/views/layouts/moirai/application.html.erb
 - app/views/moirai/translation_files/_form.html.erb
 - app/views/moirai/translation_files/index.html.erb
@@ -85,6 +86,7 @@ files:
 - lib/moirai.rb
 - lib/moirai/engine.rb
 - lib/moirai/pull_request_creator.rb
+- lib/moirai/translation_helper.rb
 - lib/moirai/version.rb
 - moirai.gemspec
 homepage: https://github.com/renuo/moirai
@@ -96,7 +98,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
@@ -111,8 +113,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: []