moirai 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9d7f98e48e08b3e5208041fbba3344f5b280492754b7943e159d0e90e71d075
-  data.tar.gz: d4aa78c7ae9f0c27f18c3e760def299c5d8faf054b06423e300b2c095976ef0c
+  metadata.gz: 95cf427b4c903e4a772cad00b3165fc9a285d019678870996d6afd122ff9c4bf
+  data.tar.gz: ae20e09390c869f1971f309c2e049fddce6557f0122069175d7f9886e8719ea1
 SHA512:
-  metadata.gz: cb39e17d721373254b27086f4cf351c6145a3aa921809b8de0921ca82c661d53e0a1fb38da524c4fe012c2ecfcde7ffa2ec1029432e88d0cc43cf2f067c55341
-  data.tar.gz: 601b7c5353bbc71cd094223df88b74dc9f82d07657f306f8402160bc47f4d056940a28db55b8b88f4fd2275c23e66379e2778e2856f0d93a57defd7b706dc68c
+  metadata.gz: cd8ead3d31114b762f706f115102bc8f36f4d1d9082911e34ac37ac57ab26d9ebb1621c57f4bf3d91626b0e3ddac67d96ca65b60e0e239650b824b4d2bac64bd
+  data.tar.gz: 0db74b1d99fcd721b378ff9371f2342051f022e4bdd02023d04c73516733f3f76a091d65ad4f653d4411c17819e3a40d675605c4eee29c4622ac88b3aba43ee1

data/.ruby-version

@@ -0,0 +1 @@
+3.2.1

data/.semaphore/main-deploy.yml

@@ -0,0 +1,18 @@
+version: v1.0
+name: main-deploy
+agent:
+  machine:
+    type: e1-standard-2
+    os_image: ubuntu2004
+
+blocks:
+  - name: main-deploy
+    task:
+      secrets:
+        - name: rubygems-deploy
+      jobs:
+        - name: main-deploy
+          commands:
+            - checkout --use-cache
+            - gem build moirai
+            - gem push moirai-*.gem

data/.semaphore/semaphore.yml

@@ -0,0 +1,82 @@
+version: "v1.0"
+name: moirai
+agent:
+  machine:
+    type: e1-standard-2
+    os_image: ubuntu2004
+auto_cancel:
+  running:
+    when: "true"
+
+blocks:
+  - name: linter
+    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: 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
+              value: sqlite
+            - name: RAILS_ENV
+              value: test
+          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
+              value: postgres
+            - name: RAILS_ENV
+              value: test
+          commands:
+            - sem-service start postgres 14 --username=semaphore
+            - bin/rails db:create db:schema:load
+            - bin/check
+promotions:
+  - name: main
+    pipeline_file: main-deploy.yml

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 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][])
+
 ## 0.3.0
 
 * Added a method `I18n.translate_without_moirai` ([@oliveranthony17][])
@@ -5,6 +21,8 @@
 * Fixed some setup issues in test environments ([@oliveranthony17][])
 * Show original translation when deleting the whole inline editing content. ([@CuddlyBunion341][])
 
+* Support for html translations ([@CuddlyBunion341][])
+=======
 ## 0.2.0
 
 * Support for strings coming from gems ([@coorasse][])

data/Gemfile

@@ -12,6 +12,7 @@ gem "stimulus-rails"
 group :development, :test do
   gem "puma"
   gem "sqlite3"
+  gem "pg"
   gem "rake"
   gem "dotenv"
   gem "minitest"

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/app/views/moirai/translation_files/_form.html.erb

@@ -1,9 +1,9 @@
 <span 
-  contenteditable 
+  contenteditable
   data-action="blur->moirai-translation#submit click->moirai-translation#click"
-  style="border: 1px dashed #1d9f74; min-width: 30px; display: inline-block;" 
+  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">
-  <%= value %>
+  <%= value.to_s.gsub("<", "&lt;").gsub(">", "&gt;").html_safe %>
 </span>

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

@@ -30,8 +30,7 @@
                          method: :post do |f| %>
               <%= f.hidden_field :key %>
               <%= f.hidden_field :locale %>
-              <%= f.text_area :value, class: 'translation-textarea' %>
-              <%= f.submit 'Update', style: 'display: none;' %>
+              <%= f.text_field :value, class: 'translation-textarea' %>
             <% end %>
           </td>
           <td>

data/lib/moirai/engine.rb

@@ -8,43 +8,34 @@ module Moirai
       generator.orm :active_record
     end
 
+    config.moirai = ActiveSupport::OrderedOptions.new
+
     config.after_initialize do
       I18n.original_backend = I18n.backend
-      if ActiveRecord::Base.connection.data_source_exists?("moirai_translations") || ENV["RAILS_ENV"] == "test"
+      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
+          false
+        end
+      if table_created
         I18n.backend = I18n::Backend::Chain.new(I18n::Backend::Moirai.new, I18n.backend)
       else
         Rails.logger.warn("moirai disabled: tables have not been generated yet.")
       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)
-
-            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,
-                         value: value})
-            else
-              value
-            end
-          end
-
-          alias_method :t, :translate
-
-          def moirai_edit_enabled?
-            params[:moirai] == "true"
-          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.0"
+  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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moirai
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Alessandro Rodi
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-22 00:00:00.000000000 Z
+date: 2024-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,8 +38,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/CODEOWNERS"
-- ".github/workflows/test.yml"
 - ".gitignore"
+- ".ruby-version"
+- ".semaphore/main-deploy.yml"
+- ".semaphore/semaphore.yml"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
@@ -63,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
@@ -83,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

data/.github/workflows/test.yml

@@ -1,65 +0,0 @@
-name: Test & lint
-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
-    
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest]
-        ruby: [3.3]
-    
-    runs-on: ${{ matrix.os }}
-    
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-      
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-      
-      - name: Install dependencies
-        run: bundle install --jobs 4 --retry 3
-      
-      - name: Run tests
-        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
-    
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-      
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 3.3
-          bundler-cache: true
-      
-      - name: Install dependencies
-        run: bundle install --jobs 4 --retry 3
-      
-      - name: Run linters
-        run: bin/fastcheck