Merge pull request #4 from ishikawa999/develop

Add option to temporarily disable customizes #3

Author: ishikawa999

app/controllers/custom_message_settings_controller.rb

@@ -1,14 +1,13 @@
 class CustomMessageSettingsController < ApplicationController
   layout 'admin'
   before_action :require_admin, :set_custom_message_setting, :set_lang
-  require_sudo_mode :edit, :update
+  require_sudo_mode :edit, :update, :toggle_enabled
 
   def edit
   end
 
   def update
-    original_custom_messages = @setting.custom_messages
-    languages = (original_custom_messages.try(:keys) ? original_custom_messages.keys.map(&:to_s) : [])
+    languages = @setting.using_languages
 
     if setting_params.key?(:custom_messages) || params[:tab] == 'normal'
       @setting.update_with_custom_messages(setting_params[:custom_messages].try(:to_unsafe_h).try(:to_hash) || {}, @lang)
@@ -18,8 +17,7 @@ def update
 
     if @setting.errors.blank?
       flash[:notice] = l(:notice_successful_update)
-      new_custom_messages = @setting.custom_messages
-      languages += new_custom_messages.keys.map(&:to_s) if new_custom_messages.try(:keys)
+      languages += @setting.using_languages
       CustomMessageSetting.reload_translations!(languages)
 
       redirect_to edit_custom_message_settings_path(tab: params[:tab], lang: @lang)
@@ -28,6 +26,16 @@ def update
     end
   end
 
+  def toggle_enabled
+    if @setting.toggle_enabled!
+      flash[:notice] =
+        @setting.enabled? ? l(:notice_enabled_customize) : l(:notice_disabled_customize)
+      redirect_to edit_custom_message_settings_path
+    else
+      render :edit
+    end
+  end
+
   private
   def set_custom_message_setting
     @setting = CustomMessageSetting.find_or_default

app/models/custom_message_setting.rb

@@ -6,6 +6,10 @@ def self.find_or_default
     super('plugin_redmine_message_customize')
   end
 
+  def enabled?
+    !(self.value[:enabled] == 'false')
+  end
+
   def custom_messages(lang=nil)
     messages = self.value[:custom_messages] || self.value['custom_messages']
     if lang.present?
@@ -57,11 +61,35 @@ def update_with_custom_messages_yaml(yaml)
     self.save
   end
 
+  def toggle_enabled!
+    customize_files = Dir.glob(Rails.root.join('plugins', 'redmine_message_customize', 'config', 'locales', 'custom_messages', '*.rb'))
+    self.value = self.value.deep_merge({enabled: (!self.enabled?).to_s})
+
+    if result = self.save
+      if self.enabled?
+        I18n.load_path += customize_files
+      else
+        I18n.load_path -= customize_files
+      end
+      self.class.reload_translations!(self.using_languages)
+    end
+    result
+  end
+
+  def using_languages
+    messages = self.custom_messages
+    if messages.is_a?(Hash)
+      messages.keys.map(&:to_s)
+    else
+      [User.current.language]
+    end
+  end
+
   def self.available_messages(lang)
-    messages = I18n.backend.translations[self.find_language(lang).to_s.to_sym]
+    messages = I18n.backend.send(:translations)[self.find_language(lang).to_s.to_sym]
     if messages.nil?
       CustomMessageSetting.reload_translations!([lang])
-      messages = I18n.backend.translations[lang.to_s.to_sym] || {}
+      messages = I18n.backend.send(:translations)[lang.to_s.to_sym] || {}
     end
     self.flatten_hash(messages)
   end
@@ -92,7 +120,7 @@ def self.nested_hash(hash=nil)
   end
 
   def self.reload_translations!(languages)
-    paths = ::I18n.load_path.select {|path| self.find_language(languages).include?(File.basename(path, '.*').to_s)}
+    paths = I18n.load_path.select {|path| self.find_language(languages).include?(File.basename(path, '.*').to_s)}
     I18n.backend.load_translations(paths)
   end
 

app/views/custom_message_settings/edit.html.erb

@@ -6,4 +6,8 @@
 <% if @setting.errors.any? %>
   <%= error_messages_for(@setting) %>
 <% end %>
+<p class='toggle-enable'>
+  <span class='icon icon-settings'></span>
+  <%= link_to (@setting.enabled? ? l(:label_disable_customize) : l(:label_enable_customize)), toggle_enabled_custom_message_settings_path, method: :post %>
+</p>
 <%= render_tabs (@setting.errors.any? ? [] : [{name: 'normal', partial: 'normal_tab', label: 'label_normal_tab'}]) + [{name: 'yaml', partial: 'yaml_tab', label: 'label_yaml_tab'}] %>

assets/stylesheets/custom_messages.css

@@ -34,4 +34,8 @@
 }
 .select2-container--default .select2-results__option[aria-disabled=true] span {
   color: white;
+}
+
+p.toggle-enable {
+  text-align: right;
 }

config/locales/en.yml

@@ -10,5 +10,9 @@ en:
   error_unavailable_keys: The keys not present in Redmine are used.
   error_unavailable_languages: The languages not present in Redmine are used.
   error_invalid_yaml_format: The format of yaml is invalid.
+  notice_enabled_customize: Successful in enable messages customization.
+  notice_disabled_customize: Successful in disable messages customization.
   label_normal_tab: Normal mode
-  label_yaml_tab: YAML mode
+  label_yaml_tab: YAML mode
+  label_enable_customize: Enable customize
+  label_disable_customize: Disable customize

config/locales/ja.yml

@@ -10,5 +10,9 @@ ja:
   error_unavailable_keys: Redmineに存在しないキーが利用されています。
   error_unavailable_languages: Redmineで利用できない言語が利用されています。
   error_invalid_yaml_format: YAMLの形式が正しくありません。
+  notice_enabled_customize: メッセージのカスタマイズを有効に変更しました。
+  notice_disabled_customize: メッセージのカスタマイズを無効に変更しました。
   label_normal_tab: 通常モード
-  label_yaml_tab: YAMLモード
+  label_yaml_tab: YAMLモード
+  label_enable_customize: カスタマイズを有効にする
+  label_disable_customize: カスタマイズを無効にする

config/routes.rb

@@ -2,5 +2,6 @@
   resources :custom_message_settings, only: [] do
     get :edit, on: :collection
     post :update, on: :collection
+    post :toggle_enabled, on: :collection
   end
 end

init.rb

@@ -7,8 +7,6 @@
   requires_redmine version_or_higher: '3.2'
 end
 
-Rails.application.config.i18n.load_path += Dir.glob(File.join(p.directory, 'config', 'locales', 'custom_messages', '*.rb'))
-
-class Redmine::I18n::Backend
-  public :translations
+if CustomMessageSetting.find_or_default.enabled?
+  Rails.application.config.i18n.load_path += Dir.glob(File.join(p.directory, 'config', 'locales', 'custom_messages', '*.rb'))
 end

test/fixtures/custom_message_settings.yml

@@ -1,4 +1,7 @@
 one:
   id: 1
   name: plugin_redmine_message_customize
-  value: { custom_messages: { en: { label_home: 'Home1' }, ja: { label_home: 'Home2' }}}
+  value: {
+    custom_messages: { en: { label_home: 'Home1' }, ja: { label_home: 'Home2' }},
+    enabled: 'true'
+    }

test/functional/custom_message_settings_controller_test.rb

@@ -7,6 +7,7 @@ class CustomMessageSettingsControllerTest < Redmine::ControllerTest
   def setup
     @request.session[:user_id] = 1 # admin
     CustomMessageSetting.reload_translations!('en')
+    I18n.load_path = (I18n.load_path + Dir.glob(Rails.root.join('plugins', 'redmine_message_customize', 'config', 'locales', 'custom_messages', '*.rb'))).uniq
   end
 
   # custom_message_settings/edit
@@ -23,8 +24,7 @@ def test_edit
   def test_edit_except_admin_user
     @request.session[:user_id] = 2
     get :edit
-    assert_response 403
-    assert_select 'p#errorExplanation', text: 'You are not authorized to access this page.'
+    assert_redirected_to (/#{signin_path}/)
   end
 
   def test_update_with_custom_messages
@@ -52,11 +52,25 @@ def test_update_with_invalid_params
     assert_select 'h2', :text => l(:label_custom_messages)
     assert_select 'div#errorExplanation'
   end
-  def test_edit_except_admin_user
+  def test_update_except_admin_user
     @request.session[:user_id] = 2
     get :update, params: { settings: {'custom_messages'=>{'label_home' => 'Home3'}}, lang: 'en', tab: 'normal' }
 
-    assert_response 403
-    assert_select 'p#errorExplanation', text: 'You are not authorized to access this page.'
+    assert_redirected_to (/#{signin_path}/)
+  end
+
+  def test_toggle_enabled
+    patch :toggle_enabled
+    assert_redirected_to edit_custom_message_settings_path
+    assert_equal l(:notice_disabled_customize), flash[:notice]
+
+    patch :toggle_enabled
+    assert_equal l(:notice_enabled_customize), flash[:notice]
+  end
+  def test_toggle_enabled_except_admin_user
+    @request.session[:user_id] = 2
+    patch :toggle_enabled
+
+    assert_redirected_to (/#{signin_path}/)
   end
 end