Merge pull request #212 from 6temes/feature/auto-reload-translations-in-development

Add automatic reloading of .po/.mo files in development

Author: grosser

CHANGELOG.md

@@ -2,11 +2,15 @@
 
 ## Unreleased
 
+- Add automatic reloading of .po and .mo files in development mode
+
 ## 2.0.0
+
 - change how model attributes are looked up (class first, then sti root)
 - drop support for old rubies
 
 ## v1.13.0
+
 - Use subclasses instead of direct_descendants on rails 7 and above
 
 ## v1.12.0

Gemfile.lock

@@ -109,6 +109,7 @@ GEM
     marcel (1.0.2)
     method_source (1.0.0)
     mini_mime (1.1.2)
+    mini_portile2 (2.8.9)
     minitest (5.18.0)
     net-imap (0.3.4)
       date
@@ -120,11 +121,8 @@ GEM
     net-smtp (0.3.3)
       net-protocol
     nio4r (2.5.9)
-    nokogiri (1.15.2-arm64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.15.2-x86_64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.15.2-x86_64-linux)
+    nokogiri (1.15.2)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     prime (0.1.2)
       forwardable
@@ -178,9 +176,8 @@ GEM
     slim (4.1.0)
       temple (>= 0.7.6, < 0.9)
       tilt (>= 2.0.6, < 2.1)
-    sqlite3 (1.7.3-arm64-darwin)
-    sqlite3 (1.7.3-x86_64-darwin)
-    sqlite3 (1.7.3-x86_64-linux)
+    sqlite3 (1.7.3)
+      mini_portile2 (~> 2.8.0)
     temple (0.8.2)
     text (1.3.1)
     thor (1.2.2)
@@ -197,6 +194,7 @@ PLATFORMS
   arm64-darwin-21
   arm64-darwin-23
   arm64-darwin-24
+  arm64-darwin-25
   x86_64-darwin-22
   x86_64-linux
 

Readme.md

@@ -296,6 +296,23 @@ Rails.application.config.gettext_i18n_rails.use_for_active_record_attributes = f
 
 And now you can use your I18n yaml files instead.
 
+Auto-reload translations in development
+========================================
+
+By default, .po and .mo files are automatically reloaded in development mode when they change, so you don't need to restart the Rails server after editing translations.
+
+This feature is enabled by default in development. You can configure it in any environment file:
+
+```Ruby
+# To disable in development
+config.gettext_i18n_rails.auto_reload = false
+
+# To enable in production (not recommended)
+config.gettext_i18n_rails.auto_reload = true
+```
+
+The auto-reload feature uses `ActiveSupport::FileUpdateChecker` to monitor changes to translation files in your `locale/` directory and reloads them only when they've been modified, ensuring minimal performance impact.
+
 Using your translations from javascript
 =======================================
 

lib/gettext_i18n_rails/railtie.rb

@@ -5,6 +5,7 @@ class Railtie < ::Rails::Railtie
     config.gettext_i18n_rails.msgcat = nil
     config.gettext_i18n_rails.xgettext = nil
     config.gettext_i18n_rails.use_for_active_record_attributes = true
+    config.gettext_i18n_rails.auto_reload = Rails.env.development?
 
     rake_tasks do
       if Gem::Specification.find_all_by_name("gettext", ">= 3.0.2").any?
@@ -18,6 +19,20 @@ class Railtie < ::Rails::Railtie
           require 'gettext_i18n_rails/active_model'
         end
       end
+
+      # Auto-reload .po and .mo files when they change
+      if app.config.gettext_i18n_rails.auto_reload
+        po_files = Dir[Rails.root.join("locale/**/*.{po,mo}")]
+
+        reloader = ActiveSupport::FileUpdateChecker.new(po_files) do
+          FastGettext.translation_repositories.each_value(&:reload)
+          Rails.logger.info "Reloaded gettext translations"
+        end
+
+        app.executor.to_run do
+          reloader.execute_if_updated
+        end
+      end
     end
   end
 end

spec/gettext_i18n_rails/railtie_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe GettextI18nRails::Railtie do
+  describe 'auto-reload configuration' do
+    it 'can be set to true or false' do
+      config = GettextI18nRails::Railtie.config.gettext_i18n_rails
+      config.auto_reload = true
+      config.auto_reload.should == true
+    end
+
+    it 'can be disabled' do
+      config = GettextI18nRails::Railtie.config.gettext_i18n_rails
+      config.auto_reload = false
+      config.auto_reload.should == false
+    end
+  end
+end

spec/spec_helper.rb

@@ -7,11 +7,35 @@
 require 'tempfile'
 require 'active_support'
 require 'active_support/core_ext/string/output_safety'
+require 'rails/railtie'
 require 'active_record'
 require 'action_controller'
 require 'action_mailer'
 require 'fast_gettext'
+
+# Define minimal Rails stub for library compatibility
+# Rails::VERSION::MAJOR is checked by action_controller.rb at load time
+module Rails
+  module VERSION
+    MAJOR = 7
+  end
+
+  def self.root
+    File.dirname(__FILE__)
+  end
+
+  def self.env
+    ActiveSupport::StringInquirer.new('test')
+  end
+end
+
 require 'gettext_i18n_rails'
+
+# Manually load ActiveRecord/ActiveModel extensions since we're not running full Rails initialization
+# In a real Rails app, these would be loaded via the Railtie's after_initialize hook
+require 'gettext_i18n_rails/active_model'
+require 'gettext_i18n_rails/active_record'
+
 require 'temple'
 
 if ActiveSupport::VERSION::MAJOR >= 3
@@ -38,12 +62,6 @@ def method_missing(name, engine, options = {})
   end
 end
 
-module Rails
-  def self.root
-    File.dirname(__FILE__)
-  end
-end
-
 def with_file(content, extension = '')
   Tempfile.open(['gettext_i18n_rails_specs', extension]) do |f|
     f.write(content)