Merge pull request #34 from ishikawa999/task/30

Only allow plugin text to be overwritten when there is 35_change_load_order_locales

Author: ishikawa999

README.md

@@ -12,7 +12,8 @@ $ cp plugins/redmine_message_customize/35_change_load_order_locales.rb config/in
 $ # redmine restart
 ```
 
-:warning: In order to customize messages of other plugins, it is necessary to copy redmine_message_customize/35_change_load_order_locales.rb into redmine/config/initializers.
+:warning: In order to customize messages of other plugins, it is necessary to copy redmine_message_customize/35_change_load_order_locales.rb into redmine/config/initializers.  
+If you don't have redmine/config/initializers/35_change_load_order_locales.rb, you can customize only messages other than plugins.
 
 ## Usage
 

app/views/custom_message_settings/edit.html.erb

@@ -12,8 +12,14 @@
 <% if @setting.errors.any? %>
   <%= error_messages_for(@setting) %>
 <% end %>
-<p class='toggle-enable'>
+<div class='message-customize-menu'>
   <%= link_to (@setting.enabled? ? l(:label_disable_customize) : l(:label_enable_customize)), toggle_enabled_custom_message_settings_path, method: :post, class: 'icon icon-settings' %> /
   <%= open_default_messages_window_link(@lang) %>
-</p>
+
+  <% unless MessageCustomize::Locale.customizable_plugin_messages? %>
+    <p>
+      <%= l(:text_unable_to_customize_plugin_messages) %>
+    </p>
+  <% end %>
+</div>
 <%= 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

@@ -36,6 +36,11 @@
   color: white;
 }
 
-p.toggle-enable {
+div.message-customize-menu {
   text-align: right;
+}
+div.message-customize-menu p {
+  color: gray;
+  font-size: 10px;
+  margin: 5px 0px;
 }

config/locales/en.yml

@@ -8,7 +8,8 @@ en:
   text_placeholder_choose_key: Please select the message you want to change.
   text_description_of_search_box: You can enter search terms in the search box to narrow down the results.
   text_for_your_reference: If you do not know how to write, please refer to "%{value}".
-  text_disabled_customize: Message customization by this plugin is disabled.
+  text_disabled_customize: All message customizations are disabled.
+  text_unable_to_customize_plugin_messages: Impossible to customize the messages of the plugins.
 
   error_unused_keys: The keys not present in Redmine are used.
   error_unavailable_languages: The languages not present in Redmine are used.

config/locales/ja.yml

@@ -8,7 +8,8 @@ ja:
   text_placeholder_choose_key: 変更したい文言を選択してください。
   text_description_of_search_box: 検索ボックスにキーワードを入力することで、選択肢を絞り込むことが出来ます。
   text_for_your_reference: "もし書き方がわからない場合は、「%{value}」が参考になるはずです。"
-  text_disabled_customize: このプラグインによるメッセージのカスタマイズは無効になっています。
+  text_disabled_customize: メッセージのカスタマイズはすべて無効になっています。
+  text_unable_to_customize_plugin_messages: Redmineに入っているプラグインのメッセージはカスタマイズできません。
 
   error_unused_keys: Redmineに存在しないキーが利用されています。
   error_unavailable_languages: Redmineで利用できない言語が利用されています。

lib/message_customize/locale.rb

@@ -1,6 +1,7 @@
 module MessageCustomize
   module Locale
     @available_messages = {}
+    CHANGE_LOAD_ORDER_LOCALES_FILE_PATH = 'config/initializers/35_change_load_order_locales.rb'
 
     class << self
       def available_locales
@@ -11,7 +12,16 @@ def reload!(*languages)
         available_languages = self.find_language(languages.flatten)
         paths = I18n.load_path.select {|path| available_languages.include?(File.basename(path, '.*').to_s)}
         I18n.backend.load_translations(paths)
-        available_languages.each{|lang| @available_messages[:"#{lang}"] = I18n.backend.send(:translations)[:"#{lang}"] || {}}
+        if customizable_plugin_messages?
+          available_languages.each{|lang| @available_messages[:"#{lang}"] = I18n.backend.send(:translations)[:"#{lang}"] || {}}
+        else
+          available_languages.each do |lang|
+            redmine_root_locale_path = Rails.root.join('config', 'locales', "#{lang}.yml")
+            if File.exist?(redmine_root_locale_path)
+              @available_messages[:"#{lang}"] = (I18n.backend.send(:load_yml, redmine_root_locale_path)[lang] || {}).deep_symbolize_keys
+            end
+          end
+        end
       end
 
       def find_language(language=nil)
@@ -29,6 +39,10 @@ def available_messages(lang)
         self.reload!(lang) if @available_messages[lang].blank?
         @available_messages[lang] || {}
       end
+
+      def customizable_plugin_messages?
+        @customizable_plugin_messages ||= File.exist?(Rails.root.join(CHANGE_LOAD_ORDER_LOCALES_FILE_PATH))
+      end
     end
   end
 end

test/unit/lib/message_customize/locale_test.rb

@@ -30,17 +30,44 @@ def test_available_locales
     assert_equal locales.uniq.sort.map(&:to_sym), MessageCustomize::Locale.available_locales
   end
 
-  def test_available_messages_should_return_translations
+  def test_available_messages_if_customizable_plugin_messages
+    MessageCustomize::Locale.stubs(:customizable_plugin_messages?).returns(true)
+
     # Reset @available_messages
     MessageCustomize::Locale.instance_variable_set(:@available_messages, {})
 
     en_available_messages = MessageCustomize::Locale.available_messages('en')
     assert_equal 'am', en_available_messages[:time][:am]
+    assert_equal 'Message customize', en_available_messages[:label_custom_messages] # plugin messages
     assert_equal [:en], MessageCustomize::Locale.instance_variable_get(:@available_messages).keys
 
-    # Language 'ar' not loaded
-    ar_available_messages = MessageCustomize::Locale.available_messages('ar')
-    assert_equal "صباحا", ar_available_messages[:time][:am]
-    assert_equal [:en, :ar], MessageCustomize::Locale.instance_variable_get(:@available_messages).keys
+    # Language 'ja' not loaded
+    ja_available_messages = MessageCustomize::Locale.available_messages('ja')
+    assert_equal "午前", ja_available_messages[:time][:am]
+    assert_equal 'メッセージのカスタマイズ', ja_available_messages[:label_custom_messages] # plugin messages
+    assert_equal [:en, :ja], MessageCustomize::Locale.instance_variable_get(:@available_messages).keys
+  end
+
+  def test_available_messages_should_return_messages_without_plugin_messages_if_not_customizable_plugin_messages
+    MessageCustomize::Locale.stubs(:customizable_plugin_messages?).returns(false)
+
+    # Reset @available_messages
+    MessageCustomize::Locale.instance_variable_set(:@available_messages, {})
+
+    en_available_messages = MessageCustomize::Locale.available_messages('en')
+    assert_equal 'am', en_available_messages[:time][:am]
+    assert_nil en_available_messages[:label_custom_messages] # plugin messages
+    assert_equal [:en], MessageCustomize::Locale.instance_variable_get(:@available_messages).keys
+
+    # Language 'ja' not loaded
+    ja_available_messages = MessageCustomize::Locale.available_messages('ja')
+    assert_equal "午前", ja_available_messages[:time][:am]
+    assert_nil ja_available_messages[:label_custom_messages] # plugin messages
+    assert_equal [:en, :ja], MessageCustomize::Locale.instance_variable_get(:@available_messages).keys
+  end
+
+  def test_customizable_plugin_messages?
+    expect = File.exist?(Rails.root.join(MessageCustomize::Locale::CHANGE_LOAD_ORDER_LOCALES_FILE_PATH))
+    assert_equal expect, MessageCustomize::Locale.customizable_plugin_messages?
   end
 end