Compatible with Redmine 3.3

Author: ishikawa999

app/controllers/custom_message_settings_controller.rb

@@ -1,33 +1,29 @@
 class CustomMessageSettingsController < ApplicationController
   layout 'admin'
-  self.main_menu = false
   before_action :require_admin, :set_custom_message_setting, :set_lang
   require_sudo_mode :edit, :update
 
   def edit
-    @lang = params[:lang].presence || User.current.language
   end
 
   def update
     original_custom_messages = @setting.custom_messages
     languages = (original_custom_messages.try(:keys) ? original_custom_messages.keys.map(&:to_s) : [])
 
-    if custom_message_setting_params[:custom_messages]
-      messages = original_custom_messages.merge({@lang => CustomMessageSetting.nested_hash(custom_message_setting_params[:custom_messages].to_unsafe_h.to_hash) })
-    elsif custom_message_setting_params[:custom_messages_yaml]
-      messages = custom_message_setting_params[:custom_messages_yaml]
-    else
-      messages = {@lang => {}}
+    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)
+    elsif setting_params.key?(:custom_messages_yaml)
+      @setting.update_with_custom_messages_yaml(setting_params[:custom_messages_yaml])
     end
 
-    if @setting.update_custom_messages(messages)
+    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)
       CustomMessageSetting.reload_translations!(languages)
-      redirect_to edit_custom_message_settings_path(tab: params[:tab])
+
+      redirect_to edit_custom_message_settings_path(tab: params[:tab], lang: @lang)
     else
-      @lang ||= User.current.language
       render :edit
     end
   end
@@ -37,11 +33,11 @@ def set_custom_message_setting
     @setting = CustomMessageSetting.find_or_default
   end
 
-  def custom_message_setting_params
+  def setting_params
     params.fetch(:settings, {})
   end
 
   def set_lang
-    @lang = CustomMessageSetting.find_language(params[:lang]) if params[:lang]
+    @lang = CustomMessageSetting.find_language(params[:lang].presence || User.current.language.presence || 'en')
   end
 end

app/models/custom_message_setting.rb

@@ -1,6 +1,5 @@
 class CustomMessageSetting < Setting
-  before_validation :change_format_to_hash
-  validate :custom_message_keys_are_available
+  validate :add_errors, :convertible_to_yaml, :custom_message_keys_are_available
 
   def self.find_or_default
     super('plugin_redmine_message_customize')
@@ -28,20 +27,43 @@ def custom_messages_to_yaml
     end
   end
 
-  def update_custom_messages(messages)
+  def update_with_custom_messages(custom_messages, lang)
+    value = CustomMessageSetting.nested_hash(custom_messages)
+    original_custom_messages = self.custom_messages
+    messages =
+      if value.present?
+        original_custom_messages.merge({lang => value})
+      else
+        original_custom_messages.delete(lang)
+        original_custom_messages
+      end
+
     self.value = {custom_messages: (messages.present? ? messages : {})}
     self.save
   end
 
+  def update_with_custom_messages_yaml(yaml)
+    begin
+      messages = YAML.load(yaml)
+      @errs = {base: l(:error_invalid_yaml_format) } if messages.is_a?(Hash) == false && messages.present?
+      self.value = {custom_messages: (messages.present? ? messages : {})}
+    rescue => e
+      @errs = {base: e.message}
+      self.value = {custom_messages: yaml}
+    end
+    self.save
+  end
+
   def self.available_messages(lang='en')
-    messages = I18n.backend.translations[self.find_language(lang).to_sym] || {}
+    messages = I18n.backend.translations[self.find_language(lang).to_sym]
     if messages.nil?
       CustomMessageSetting.reload_translations!([lang])
       messages = I18n.backend.translations[lang.to_sym] || {}
     end
     self.flatten_hash(messages)
   end
 
+  # { date: { formats: { defaults: '%m/%d/%Y'}}} to {'date.formats.defaults' => '%m/%d/%Y'}
   def self.flatten_hash(hash=nil)
     hash = self.to_hash unless hash
     hash.each_with_object({}) do |(key, value), content|
@@ -52,8 +74,8 @@ def self.flatten_hash(hash=nil)
     end
   end
 
+  # {'date.formats.defaults' => '%m/%d/%Y'} to { date: { formats: { defaults: '%m/%d/%Y'}}}
   def self.nested_hash(hash=nil)
-    hash = self.to_hash unless hash
     new_hash = {}
     hash.each do |key, value|
       h = value
@@ -87,27 +109,27 @@ def custom_message_keys_are_available
     return false if self.value[:custom_messages].is_a?(Hash) == false || self.errors.present?
 
     custom_messages_hash = {}
-    custom_messages.values.each do |hash|
-      custom_messages_hash = self.class.flatten_hash(custom_messages_hash.merge(hash))
+    custom_messages.values.compact.each do |val|
+      custom_messages_hash = self.class.flatten_hash(custom_messages_hash.merge(val)) if val.is_a?(Hash)
     end
     available_keys = self.class.flatten_hash(self.class.available_messages).keys
     unavailable_keys = custom_messages_hash.keys.reject{|k|available_keys.include?(k.to_sym)}
     if unavailable_keys.present?
       self.errors.add(:base, l(:error_unavailable_keys) + "keys: [#{unavailable_keys.join(', ')}]")
-      return false
+      false
     end
   end
 
-  def change_format_to_hash
-    if self.value[:custom_messages].is_a?(Hash)
-      YAML.dump(self.value[:custom_messages])
-    else
-      custom_messages = YAML.load(self.value[:custom_messages])
-      raise l(:error_invalid_yaml_format) unless custom_messages.is_a?(Hash)
-      self.value = {custom_messages: custom_messages}
+  def convertible_to_yaml
+    YAML.dump(self.value[:custom_messages])
+  end
+
+  def add_errors
+    unless @errs.blank?
+      @errs.each do |key, value|
+        self.errors.add(key, value)
+      end
+      false
     end
-  rescue => e
-    self.errors.add(:base, e.message)
-    false
   end
 end

app/views/custom_message_settings/_messages.html.erb

@@ -1,4 +1,3 @@
-<% lang ||= 'en' %>
 <div><%= select_tag 'select-key', available_message_options(@setting, lang), id: 'key-selector' %></div>
 <br>
 <div class='tabular'>

app/views/custom_message_settings/_normal_tab.html.erb

@@ -1,4 +1,4 @@
-<%= form_tag custom_message_settings_path, method: :patch do %>
+<%= form_tag custom_message_settings_path, method: :post do %>
   <%= hidden_field_tag :tab, 'normal' %>
   <label><%= l(:field_language) %>: </label><%= select_tag 'lang', options_for_select(languages_options, @lang), include_blank: true, data: {remote: true, url: url_for(action: :edit)} %>
   <hr>

app/views/custom_message_settings/_yaml_tab.html.erb

@@ -1,4 +1,4 @@
-<%= form_tag custom_message_settings_path, method: :patch do %>
+<%= form_tag custom_message_settings_path, method: :post do %>
   <%= hidden_field_tag :tab, 'yaml' %>
   <div class='help-message wiki'>
     <p><%= l(:text_help_for_input_format) %></p>

config/locales/custom_messages/bg.rb

@@ -1 +1 @@
-{ bg: CustomizeMessagesSetting.find_or_default.custom_messages('bg') }
+{ bg: CustomMessageSetting.find_or_default.custom_messages('bg') }

config/routes.rb

@@ -1,6 +1,6 @@
 Rails.application.routes.draw do
   resources :custom_message_settings, only: [] do
     get :edit, on: :collection
-    patch :update, on: :collection
+    post :update, on: :collection
   end
 end

init.rb

@@ -1,9 +1,10 @@
 p = Redmine::Plugin.register :redmine_message_customize do
   name 'Redmine customize messages plugin'
   description 'This is a plugin that allows messages in Redmine to be overwritten from the admin view'
-  settings :default => { custom_messages: {} }
+  settings default: { custom_messages: {} }
   menu :admin_menu, :custom_messages, { controller: 'custom_message_settings', action: 'edit' },
          caption: :label_custom_messages, html: { class: 'icon icon-edit' }
+  requires_redmine version_or_higher: '3.3.0'
 end
 
 Rails.application.config.i18n.load_path += Dir.glob(File.join(p.directory, 'config', 'locales', 'custom_messages', '*.rb'))