moirai 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 775bc4dc3ad8a1021e5f9fc135e911f15347a169763a37785df5f88c79c7f2ec
-  data.tar.gz: b06e0bb4358f53307ff4be4455edce37c2438161670adfb92169b071efa805cf
+  metadata.gz: bcf7d211078453364a7a3ca5204323c965ea6e09e5b205fba26ea9bf9ef3d207
+  data.tar.gz: 774cb76d82a08a3eb8871aceb8870c0082c7d6d14c1a17bcc95ca799e043c3b7
 SHA512:
-  metadata.gz: 5399d555d3e9c7cd53e9388a366d8653b4fbec5289cc1ee9fda529150a2d09269e3af8945eae6fb8327169263bfe8fe7bdf8df8ff914f3fb0899a12835e0e240
-  data.tar.gz: 4040556f71c127529bb4b30f6342d8cdf13add2d6b2cc9f98eb704a46ead8e3490243c0aca8c1dc1756bd3445643d076c6244b5b32ef16c0554445d015feb7e2
+  metadata.gz: 7135800ff08e27916dcb69e95c63744e95d0c46e6c71e0bb6a36b1c22b2677a0dc8acef5f9579b8d795316ce1200d392306b21e67ab0d3ec028875fddf7f9f2d
+  data.tar.gz: 07ad0bf102451aeaace50563cbf8e83f57dd6c202903ad0fb71b3f64d0b745754a330f61d7fa08dcac49cf82406b56b087bc26f24747dbf418f29f0b3d8a0a0c

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## Unreleased
+
+## 0.4.6
+
+* Allows to access `current_user` and other controller available methods in the `enable_inline_editing` function. ([@coorasse][])
+* Improved project setup.  ([@simon-isler][])
+* Various bug fixes
+
 ## 0.4.5
 
 * Fixes issue when inline editing is disabled. ([@nicogaldamez][])
@@ -68,3 +76,5 @@ move in here the conditions you had previously defined in the helper.
 [@CuddlyBunion341]: https://github.com/CuddlyBunion341
 
 [@nicogaldamez]: https://github.com/nicogaldamez
+
+[@simon-isler]:  https://github.com/simon-isler

data/README.md

@@ -43,11 +43,12 @@ bin/rails db:migrate
 
 ### Mount path
 
-By default, Moirai is mounted under `/moirai`. You can change it by specifying the `root_path` option in `config/initializers/moirai.rb`:
+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'
+config.root_path = "/my_translations"
 ```
 
 ### How to change translations
@@ -62,7 +63,7 @@ on the application.
 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' }
+config.moirai.enable_inline_editing = ->(params:) { params[:moirai] == "true" }
 ```
 
 If you set `moirai=true` query parameter in the URL, inline editing will appear in your page.
@@ -70,7 +71,7 @@ If you set `moirai=true` query parameter in the URL, inline editing will appear
 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? }
+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. Read below how to:
@@ -103,7 +104,7 @@ You will also need to create a **Personal Access Token** on GitHub, and configur
 First, add Octokit to your project’s Gemfile:
 
 ```
-gem 'octokit'
+gem "octokit"
 ```
 
 Then run `bundle install`.
@@ -169,7 +170,7 @@ See the following example:
 
 ```ruby
 authenticated :user, lambda { |u| u.role == "admin" } do
-  mount Moirai::Engine => '/moirai', as: 'moirai'
+  mount Moirai::Engine => "/moirai", as: "moirai"
 end
 ```
 
@@ -181,19 +182,16 @@ end
     cd moirai
     ```
 
-2. Run the setup script to install dependencies:
+2. Run the setup script to install dependencies and prepare the env variables:
     ```bash
     bin/setup
     ```
 
-3. Copy the example environment variables file to create your own `.env` file:
-    ```bash
-    cp .env.example .env
-    ```
+3. Set your environment variables using the newly created `.env` file.
 
-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
+You will need a repository to test against and a token. The repository is just a dummy repo. It does not need anything
+special.
+Generate a new Fine-Grained Personal access token and give the
 necessary permissions to your repository.
 See the image below as an example:
 
@@ -204,6 +202,10 @@ See the image below as an example:
     bin/check
     ```
 
+    > ⚠️ **Note:** The first time you run the tests, one test will fail because the Italian translation file is missing by default in the dummy app.
+    > But don't worry, a pull request should now be created on your repository with the missing translations.
+    > After merging the pull request, all the tests should pass.
+
 6. To view the engine in a dummy app:
     ```bash
     bin/rails s
@@ -216,6 +218,7 @@ See the image below as an example:
 * Support for count variants
 * Better inline editing tool
 * Support for fallbacks: it should detect when a fallback string is in use and prevent attempts to override its value.
+* Support inline editing when translation is used as a value of an attribute
 
 ## License
 

data/lib/moirai/engine.rb

@@ -12,7 +12,8 @@ module Moirai
 
     def self.on_sqlite?
       defined?(ActiveRecord::ConnectionAdapters::SQLite3Adapter) &&
-        ActiveRecord::Base.connection.is_a?(ActiveRecord::ConnectionAdapters::SQLite3Adapter)
+        ActiveRecord::Base.connection.is_a?(ActiveRecord::ConnectionAdapters::SQLite3Adapter) &&
+        ActiveRecord::Base.connection.table_exists?("moirai_translations")
     end
 
     def self.on_postgres?

data/lib/moirai/translation_helper.rb

@@ -27,7 +27,7 @@ module ActionView::Helpers::TranslationHelper # rubocop:disable Lint/ConstantDef
   def moirai_edit_enabled?
     return false unless Moirai.enable_inline_editing.present?
 
-    Moirai.enable_inline_editing.call(params: defined?(params) ? (params || {}) : {})
+    instance_exec(params: defined?(params) ? (params || {}) : {}, &Moirai.enable_inline_editing)
   end
 
   private

data/lib/moirai/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moirai
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - Alessandro Rodi
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-30 00:00:00.000000000 Z
+date: 2025-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -37,28 +37,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/CODEOWNERS"
-- ".gitignore"
-- ".ruby-version"
-- ".semaphore/main-deploy.yml"
-- ".semaphore/semaphore.yml"
-- Appraisals
 - CHANGELOG.md
-- Gemfile
 - README.md
-- Rakefile
 - app/assets/config/moirai_manifest.js
-- app/assets/images/moirai/.keep
 - app/assets/javascripts/moirai_translation_controller.js
 - app/assets/stylesheets/moirai/application.css
 - app/assets/stylesheets/translation_files.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
@@ -72,11 +61,6 @@ files:
 - 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
-- bin/rails
-- bin/setup
 - config/routes.rb
 - lib/generators/moirai/install_generator.rb
 - lib/generators/moirai/migration_generator.rb
@@ -91,7 +75,6 @@ files:
 - lib/moirai/pull_request_creator.rb
 - lib/moirai/translation_helper.rb
 - lib/moirai/version.rb
-- moirai.gemspec
 homepage: https://github.com/renuo/moirai
 licenses:
 - MIT
@@ -116,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Manage translation strings in real time

data/.github/CODEOWNERS

@@ -1 +0,0 @@
-* @renuo/moirai

data/.gitignore

@@ -1,18 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/log/*.log
-/pkg/
-/tmp/
-/test/dummy/db/*.sqlite3
-/test/dummy/db/*.sqlite3-*
-/test/dummy/log/*.log
-/test/dummy/storage/
-/test/dummy/tmp/
-
-.env
-/Gemfile.lock
-*.gem
-.idea/

data/.ruby-version

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

data/.semaphore/main-deploy.yml

@@ -1,18 +0,0 @@
-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

@@ -1,82 +0,0 @@
-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/Appraisals

@@ -1,15 +0,0 @@
-appraise "rails_7_2" do
-  gem "rails", "~> 7.2"
-end
-
-appraise "rails_7_1" do
-  gem "rails", "~> 7.1"
-end
-
-appraise "rails_7_0" do
-  gem "rails", "~> 7.0"
-end
-
-appraise "rails_6_1" do
-  gem "rails", "~> 6.1"
-end

data/Gemfile

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-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 "pg"
-  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/Rakefile

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
-load "rails/tasks/engine.rake"
-load "rails/tasks/statistics.rake"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/test_*.rb"]
-end
-
-task default: :test

data/bin/check

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

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'moirai'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/fastcheck

@@ -1,17 +0,0 @@
-#!/bin/sh
-
-set -e
-
-if ! bundle exec standardrb
-then
-  echo '\n Standard detected issues! Attempting to fix...'
-
-  if ! bundle exec standardrb --fix
-  then
-    echo '\n Tried to auto correct the issues, but some must be reviewed manually. Commit aborted.'
-    exit 1
-  fi
-
-  echo '\n Auto-corrected issues, but you should review changes before committing.'
-  exit 1
-fi

data/bin/rails

@@ -1,16 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-# This command will automatically be run when you run "rails" with Rails gems
-# installed from the root of your application.
-
-ENGINE_ROOT = File.expand_path('..', __dir__)
-ENGINE_PATH = File.expand_path('../lib/moirai/engine', __dir__)
-APP_PATH = File.expand_path('../test/dummy/config/application', __dir__)
-
-# Set up gems listed in the Gemfile.
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
-require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
-
-require 'rails/all'
-require 'rails/engine/commands'

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/moirai.gemspec

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/moirai/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "moirai"
-  spec.version = Moirai::VERSION
-  spec.authors = ["Alessandro Rodi", "Oliver Anthony", "Daniel Bengl"]
-  spec.email = %w[alessandro.rodi@renuo.ch oliver.anthony@renuo.ch daniel.bengl@renuo.ch]
-
-  spec.summary = "Manage translation strings in real time"
-  spec.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.'
-  spec.homepage = "https://github.com/renuo/moirai"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/renuo/moirai"
-  spec.metadata["changelog_uri"] = "https://github.com/renuo/moirai/CHANGELOG.md"
-  spec.metadata["steep_types"] = "sig"
-
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|docs)/}) || f.end_with?(".gem") }
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.required_ruby_version = ">= 2.7.0"
-  spec.add_dependency "rails", ">= 6.1"
-
-  spec.license = "MIT"
-  spec.metadata["rubygems_mfa_required"] = "true"
-end