Add tests

Author: ishikawa999

README.md

@@ -16,3 +16,10 @@ $ cd /your/path/redmine/plugins
 $ git clone https://github.com/ishikawa999/redmine_message_customize.git
 $ # redmine restart
 ```
+
+## Run test
+
+```
+$ cd /your/path/redmine
+$ bundle exec rake test TEST=plugins/redmine_message_customize/test RAILS_ENV=test
+```

app/helpers/custom_message_settings_helper.rb

@@ -8,7 +8,7 @@ def available_message_options(setting, lang)
 
   def normal_mode_input_fields(setting, lang)
     return '' if setting.value[:custom_messages].is_a?(String) || setting.value[:custom_messages].blank?
-    content = ''
+    content = ActiveSupport::SafeBuffer.new
     custom_messages_hash = setting.custom_messages_to_flatten_hash(lang.to_s)
     custom_messages_hash.each do |k, v|
       content += content_tag(:p) do
@@ -17,6 +17,6 @@ def normal_mode_input_fields(setting, lang)
         link_to_function('', '$(this).closest("p").remove();', class: 'icon-only icon-del clear-key-link')
       end
     end
-    content.html_safe
+    content
   end
 end

app/models/custom_message_setting.rb

@@ -6,24 +6,26 @@ def self.find_or_default
   end
 
   def custom_messages(lang=nil)
+    messages = self.value[:custom_messages] || self.value['custom_messages']
     if lang.present?
-      self.value.dig(:custom_messages, self.class.find_language(lang)) || {}
-    else
-      self.value[:custom_messages] || {}
+      messages = messages[self.class.find_language(lang)]
     end
+
+    messages.present? ? messages : {}
   end
 
   def custom_messages_to_flatten_hash(lang=nil)
     self.class.flatten_hash(custom_messages(lang))
   end
 
   def custom_messages_to_yaml
-    if self.custom_messages.blank?
+    messages = self.custom_messages
+    if messages.blank?
       ''
-    elsif self.custom_messages.is_a?(Hash)
-      YAML.dump(self.custom_messages)
+    elsif messages.is_a?(Hash)
+      YAML.dump(messages)
     else
-      self.custom_messages
+      messages
     end
   end
 
@@ -54,7 +56,7 @@ def update_with_custom_messages_yaml(yaml)
     self.save
   end
 
-  def self.available_messages(lang='en')
+  def self.available_messages(lang)
     messages = I18n.backend.translations[self.find_language(lang).to_sym]
     if messages.nil?
       CustomMessageSetting.reload_translations!([lang])
@@ -112,10 +114,10 @@ def custom_message_keys_are_available
     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)}
+    available_keys = self.class.flatten_hash(self.class.available_messages('en')).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(', ')}]")
+      self.errors.add(:base, l(:error_unavailable_keys) + " keys: [#{unavailable_keys.join(', ')}]")
       false
     end
   end
@@ -125,10 +127,11 @@ def convertible_to_yaml
   end
 
   def add_errors
-    unless @errs.blank?
+    if @errs.present?
       @errs.each do |key, value|
         self.errors.add(key, value)
       end
+      @errs = nil
       false
     end
   end

test/fixtures/custom_message_settings.yml

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

test/functional/custom_message_settings_controller_test.rb

@@ -0,0 +1,62 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class CustomMessageSettingsControllerTest < Redmine::ControllerTest
+  fixtures :custom_message_settings
+  include Redmine::I18n
+
+  def setup
+    @request.session[:user_id] = 1 # admin
+    CustomMessageSetting.reload_translations!('en')
+  end
+
+  # custom_message_settings/edit
+  def test_edit
+    get :edit
+    assert_response :success
+
+    assert_select 'h2', :text => l(:label_custom_messages)
+    assert_select 'div.tabs' do
+      assert_select 'a#tab-normal'
+      assert_select 'a#tab-yaml'
+    end
+  end
+  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.'
+  end
+
+  def test_update_with_custom_messages
+    assert_equal 'Home1', l(:label_home)
+
+    get :update, params: { settings: {'custom_messages'=>{'label_home' => 'Home3'}}, lang: 'en', tab: 'normal' }
+
+    assert_equal 'Home3', l(:label_home)
+    assert_redirected_to edit_custom_message_settings_path(lang: 'en', tab: 'normal')
+    assert_equal l(:notice_successful_update), flash[:notice]
+  end
+  def test_update_with_custom_messages_yaml
+    assert_equal 'Home1', l(:label_home)
+
+    get :update, params: { settings: {'custom_messages_yaml'=>"---\nen:\n  label_home: Home3"}, tab: 'yaml' }
+
+    assert_equal 'Home3', l(:label_home)
+    assert_redirected_to edit_custom_message_settings_path(lang: 'en', tab: 'yaml')
+    assert_equal l(:notice_successful_update), flash[:notice]
+  end
+  def test_update_with_invalid_params
+    get :update, params: { settings: {'custom_messages'=>{'foobar'=>'foobar'}, lang: 'en' }}
+
+    assert_response 200
+    assert_select 'h2', :text => l(:label_custom_messages)
+    assert_select 'div#errorExplanation'
+  end
+  def test_edit_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.'
+  end
+end

test/test_helper.rb

@@ -0,0 +1,3 @@
+# Load the normal Rails helper
+require File.expand_path(File.dirname(__FILE__) + '/../../../test/test_helper')
+ActiveRecord::FixtureSet.create_fixtures(File.dirname(__FILE__) + '/fixtures', 'custom_message_settings')

test/unit/custom_message_setting_test.rb

@@ -0,0 +1,83 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class CustomMessageSettingTest < ActiveSupport::TestCase
+  fixtures :custom_message_settings
+  include Redmine::I18n
+
+  def setup
+    @custom_message_setting = CustomMessageSetting.find(1)
+  end
+
+  def test_validate_with_not_available_keys_should_return_false
+    @custom_message_setting.value = { custom_messages: { 'en' => {'foobar' => 'foobar' }} }
+    assert_not @custom_message_setting.save
+    assert_equal "#{l(:error_unavailable_keys)} keys: [foobar]", @custom_message_setting.errors[:base].first
+  end
+
+  def test_find_or_default
+    assert_equal @custom_message_setting, CustomMessageSetting.find_or_default
+  end
+
+  def test_custom_messages
+    assert_equal @custom_message_setting.value['custom_messages'], @custom_message_setting.custom_messages
+    assert_equal ({'label_home' => 'Home1'}), @custom_message_setting.custom_messages('en')
+    assert_equal ({}), @custom_message_setting.custom_messages('foo')
+  end
+
+  def test_custom_messages_to_yaml
+    assert_equal "---\nen:\n  label_home: Home1\nja:\n  label_home: Home2\n", @custom_message_setting.custom_messages_to_yaml
+
+    @custom_message_setting.value = { custom_messages: {} }
+    assert_equal '', @custom_message_setting.custom_messages_to_yaml
+
+    @custom_message_setting.value = { custom_messages: 'test' }
+    assert_equal 'test', @custom_message_setting.custom_messages_to_yaml
+  end
+
+  def test_update_with_custom_messages_if_custom_messages_is_present
+    flatten_hash = {'label_home' => 'Home3', 'time.am' => 'foo'}
+
+    assert @custom_message_setting.update_with_custom_messages(flatten_hash, 'en')
+    assert_equal ({'label_home' => 'Home3', 'time' => { 'am' => 'foo'}}), @custom_message_setting.custom_messages('en')
+  end
+  def test_update_with_custom_messages_if_custom_messages_is_blank
+    assert @custom_message_setting.update_with_custom_messages({}, 'en')
+    assert_not @custom_message_setting.custom_messages.key('en')
+  end
+
+  def test_update_with_custom_messages_yaml_if_yaml_is_valid
+    yaml = "---\nen:\n  label_home: Home3"
+    assert @custom_message_setting.update_with_custom_messages_yaml(yaml)
+    assert_equal ({ 'label_home' => 'Home3' }), @custom_message_setting.custom_messages('en')
+  end
+  def test_update_with_custom_messages_yaml_if_yaml_is_invalid
+    yaml = "---\nen:\n  label_home: Home3\ninvalid-string"
+    assert_not @custom_message_setting.update_with_custom_messages_yaml(yaml)
+    assert_equal "(<unknown>): could not find expected ':' while scanning a simple key at line 4 column 1", @custom_message_setting.errors[:base].first
+  end
+
+  def test_available_messages_should_flatten_translations
+    flatten_hash = CustomMessageSetting.available_messages('en')
+    assert_equal 'am', flatten_hash[:'time.am']
+
+    # Language 'ar' not loaded
+    flatten_hash = CustomMessageSetting.available_messages('ar')
+    assert_equal "صباحا", flatten_hash[:'time.am']
+  end
+
+  def test_flatten_hash_should_return_hash_with_flat_keys
+    flatten_hash = CustomMessageSetting.flatten_hash({time: {am: 'foo'}})
+    assert_equal ({:'time.am' => 'foo'}), flatten_hash
+  end
+
+  def test_flatten_hash_should_return_nest_hash
+    nested_hash = CustomMessageSetting.nested_hash({:'time.am' => 'foo'})
+    assert_equal ({'time' => {'am' => 'foo'}}), nested_hash
+  end
+
+  def test_reload_translations!
+    assert_nil I18n.backend.translations[:fr]
+    CustomMessageSetting.reload_translations!(['fr'])
+    assert_not_nil I18n.backend.translations[:fr]
+  end
+end