From 0f2535223ec87532485ca6d445682b6acb5dd86c Mon Sep 17 00:00:00 2001 From: Sebastian Ludwig Date: Sat, 27 Feb 2016 19:49:01 -0600 Subject: [PATCH] Removed Abstract::write_file, since formatters should focus on formatting. format_file is used directly instead. --- lib/twine/formatters/abstract.rb | 36 ++++++++++++++++++------------- lib/twine/formatters/android.rb | 2 +- lib/twine/formatters/django.rb | 4 ++-- lib/twine/formatters/flash.rb | 4 ++++ lib/twine/formatters/gettext.rb | 2 +- lib/twine/formatters/jquery.rb | 6 ++++-- lib/twine/formatters/tizen.rb | 2 +- lib/twine/runner.rb | 26 ++++++++++++---------- test/test_formatters.rb | 35 ++++++++++++------------------ test/test_generate_loc_drop.rb | 4 ++-- test/test_generate_string_file.rb | 14 ++++++------ 11 files changed, 72 insertions(+), 63 deletions(-) diff --git a/lib/twine/formatters/abstract.rb b/lib/twine/formatters/abstract.rb index efe4e14..dbbc0c2 100644 --- a/lib/twine/formatters/abstract.rb +++ b/lib/twine/formatters/abstract.rb @@ -87,11 +87,16 @@ module Twine raise NotImplementedError.new("You must implement read_file in your formatter class.") end - def format_file(strings, lang) + def format_file(lang) + output_processor = Processors::OutputProcessor.new(@strings, @options) + processed_strings = output_processor.process(lang) + + return nil if processed_strings.strings_map.empty? + header = format_header(lang) result = "" result += header + "\n" if header - result += format_sections(strings, lang) + result += format_sections(processed_strings, lang) end def format_header(lang) @@ -154,16 +159,6 @@ module Twine text.gsub('"', '\\\\"') end - def write_file(path, lang) - output_processor = Processors::OutputProcessor.new(@strings, @options) - processed_strings = output_processor.process(lang) - - encoding = @options[:output_encoding] || 'UTF-8' - File.open(path, "w:#{encoding}") do |f| - f.puts format_file(processed_strings, lang) - end - end - def write_all_files(path) file_name = @options[:file_name] || default_file_name if @options[:create_folders] @@ -173,7 +168,13 @@ module Twine FileUtils.mkdir_p(output_path) file_path = File.join(output_path, file_name) - write_file(file_path, lang) + + output = format_file(lang) + + # TODO print warning unless output + + encoding = @options[:output_encoding] || 'UTF-8' + File.open(file_path, "w:#{encoding}") { |f| f.puts output } end else language_written = false @@ -186,8 +187,13 @@ module Twine lang = determine_language_given_path(item) next unless lang - file_path = File.join(item, file_name) - write_file(file_path, lang) + output = format_file(lang) + + # TODO print warning unless output + + encoding = @options[:output_encoding] || 'UTF-8' + File.open(File.join(item, file_name), "w:#{encoding}") { |f| f.puts output } + language_written = true end diff --git a/lib/twine/formatters/android.rb b/lib/twine/formatters/android.rb index b7c8401..96de694 100644 --- a/lib/twine/formatters/android.rb +++ b/lib/twine/formatters/android.rb @@ -108,7 +108,7 @@ module Twine result += super + "\n" - result += '' + result += "\n" end def format_section_header(section) diff --git a/lib/twine/formatters/django.rb b/lib/twine/formatters/django.rb index 2417eaf..d0b5083 100644 --- a/lib/twine/formatters/django.rb +++ b/lib/twine/formatters/django.rb @@ -94,8 +94,8 @@ module Twine end end - def format_file(strings, lang) - @default_lang = strings.language_codes[0] + def format_file(lang) + @default_lang = @strings.language_codes[0] result = super @default_lang = nil result diff --git a/lib/twine/formatters/flash.rb b/lib/twine/formatters/flash.rb index db8ccf1..c0dbada 100644 --- a/lib/twine/formatters/flash.rb +++ b/lib/twine/formatters/flash.rb @@ -74,6 +74,10 @@ module Twine end end + def format_sections(strings, lang) + super + "\n" + end + def format_header(lang) "## Flash Strings File\n## Generated by Twine #{Twine::VERSION}\n## Language: #{lang}" end diff --git a/lib/twine/formatters/gettext.rb b/lib/twine/formatters/gettext.rb index e08d934..d49bc4a 100644 --- a/lib/twine/formatters/gettext.rb +++ b/lib/twine/formatters/gettext.rb @@ -64,7 +64,7 @@ module Twine end end - def format_file(strings, lang) + def format_file(lang) @default_lang = strings.language_codes[0] result = super @default_lang = nil diff --git a/lib/twine/formatters/jquery.rb b/lib/twine/formatters/jquery.rb index a6968c2..badab5a 100644 --- a/lib/twine/formatters/jquery.rb +++ b/lib/twine/formatters/jquery.rb @@ -44,8 +44,10 @@ module Twine end end - def format_file(strings, lang) - "{\n#{super}\n}" + def format_file(lang) + result = super + return result unless result + "{\n#{super}\n}\n" end def format_sections(strings, lang) diff --git a/lib/twine/formatters/tizen.rb b/lib/twine/formatters/tizen.rb index 5ec6716..c4abd99 100644 --- a/lib/twine/formatters/tizen.rb +++ b/lib/twine/formatters/tizen.rb @@ -101,7 +101,7 @@ module Twine result += super + "\n" - result += '' + result += "\n" end def format_section_header(section) diff --git a/lib/twine/runner.rb b/lib/twine/runner.rb index f113a11..17b68ce 100644 --- a/lib/twine/runner.rb +++ b/lib/twine/runner.rb @@ -48,7 +48,10 @@ module Twine lang = nil lang = @options[:languages][0] if @options[:languages] - write_string_file(@options[:output_path], lang) + formatter, lang = prepare_read_write(@options[:output_path], lang) + output = formatter.format_file(lang) + + IO.write(@options[:output_path], output, encoding: encoding) end def generate_all_string_files @@ -111,7 +114,7 @@ module Twine File.delete(@options[:output_path]) end - Dir.mktmpdir do |dir| + Dir.mktmpdir do |temp_dir| Zip::File.open(@options[:output_path], Zip::File::CREATE) do |zipfile| zipfile.mkdir('Locales') @@ -119,10 +122,13 @@ module Twine @strings.language_codes.each do |lang| if @options[:languages] == nil || @options[:languages].length == 0 || @options[:languages].include?(lang) file_name = lang + formatter.extension - real_path = File.join(dir, file_name) + temp_path = File.join(temp_dir, file_name) zip_path = File.join('Locales', file_name) - formatter.write_file(real_path, lang) - zipfile.add(zip_path, real_path) + output = formatter.format_file(lang) + next unless output + # TODO: report warning unless output + IO.write(temp_path, output, encoding: encoding) + zipfile.add(zip_path, temp_path) end end end @@ -204,6 +210,10 @@ module Twine private + def encoding + @options[:output_encoding] || 'UTF-8' + end + def require_rubyzip begin require 'zip' @@ -235,15 +245,9 @@ module Twine end formatter, lang = prepare_read_write(path, lang) - formatter.read_file(path, lang) end - def write_string_file(path, lang) - formatter, lang = prepare_read_write(path, lang) - formatter.write_file(path, lang) - end - def prepare_read_write(path, lang) formatter_for_path = find_formatter { |f| f.extension == File.extname(path) } formatter = formatter_for_format(@options[:format]) || formatter_for_path diff --git a/test/test_formatters.rb b/test/test_formatters.rb index a26587d..b9ebe28 100644 --- a/test/test_formatters.rb +++ b/test/test_formatters.rb @@ -67,11 +67,10 @@ class TestAndroidFormatter < FormatterTest assert_equal '@value', @strings.strings_map['key1'].translations['en'] end - def test_write_file_output_format + def test_format_file formatter = Twine::Formatters::Android.new formatter.strings = @twine_file - formatter.write_file @output_path, 'en' - assert_equal content('formatter_android.xml'), output_content + assert_equal content('formatter_android.xml'), formatter.format_file('en') end def test_format_key_with_space @@ -130,11 +129,10 @@ class TestAppleFormatter < FormatterTest assert_file_contents_read_correctly end - def test_write_file_output_format + def test_format_file formatter = Twine::Formatters::Apple.new formatter.strings = @twine_file - formatter.write_file @output_path, 'en' - assert_equal content('formatter_apple.strings'), output_content + assert_equal content('formatter_apple.strings'), formatter.format_file('en') end def test_format_key_with_space @@ -162,11 +160,10 @@ class TestJQueryFormatter < FormatterTest assert_translations_read_correctly end - def test_write_file_output_format + def test_format_file formatter = Twine::Formatters::JQuery.new formatter.strings = @twine_file - formatter.write_file @output_path, 'en' - assert_equal content('formatter_jquery.json'), output_content + assert_equal content('formatter_jquery.json'), formatter.format_file('en') end def test_format_value_with_newline @@ -192,11 +189,10 @@ class TestGettextFormatter < FormatterTest assert_equal 'multiline\nstring', @strings.strings_map['key1'].translations['en'] end - def test_write_file_output_format + def test_format_file formatter = Twine::Formatters::Gettext.new formatter.strings = @twine_file - formatter.write_file @output_path, 'en' - assert_equal content('formatter_gettext.po'), output_content + assert_equal content('formatter_gettext.po'), formatter.format_file('en') end end @@ -214,11 +210,10 @@ class TestTizenFormatter < FormatterTest assert_file_contents_read_correctly end - def test_write_file_output_format + def test_format_file formatter = Twine::Formatters::Tizen.new formatter.strings = @twine_file - formatter.write_file @output_path, 'en' - assert_equal content('formatter_tizen.xml'), output_content + assert_equal content('formatter_tizen.xml'), formatter.format_file('en') end end @@ -234,11 +229,10 @@ class TestDjangoFormatter < FormatterTest assert_file_contents_read_correctly end - def test_write_file_output_format + def test_format_file formatter = Twine::Formatters::Django.new formatter.strings = @twine_file - formatter.write_file @output_path, 'en' - assert_equal content('formatter_django.po'), output_content + assert_equal content('formatter_django.po'), formatter.format_file('en') end end @@ -253,10 +247,9 @@ class TestFlashFormatter < FormatterTest assert_file_contents_read_correctly end - def test_write_file_output_format + def test_format_file formatter = Twine::Formatters::Flash.new formatter.strings = @twine_file - formatter.write_file @output_path, 'en' - assert_equal content('formatter_flash.properties'), output_content + assert_equal content('formatter_flash.properties'), formatter.format_file('en') end end diff --git a/test/test_generate_loc_drop.rb b/test/test_generate_loc_drop.rb index 6894323..639da91 100644 --- a/test/test_generate_loc_drop.rb +++ b/test/test_generate_loc_drop.rb @@ -20,7 +20,7 @@ class TestGenerateLocDrop < CommandTestCase def test_generates_zip_file @runner.generate_loc_drop - assert File.exists?(@output_path), "language folder should not be created" + assert File.exists?(@output_path), "zip file should exist" end def test_zip_file_structure @@ -37,7 +37,7 @@ class TestGenerateLocDrop < CommandTestCase def test_uses_formatter formatter = prepare_mock_formatter Twine::Formatters::Apple - formatter.expects(:write_file).twice.with() { |path, lang| FileUtils.touch path } + formatter.expects(:format_file).twice @runner.generate_loc_drop end diff --git a/test/test_generate_string_file.rb b/test/test_generate_string_file.rb index f36e1e1..a9efe55 100644 --- a/test/test_generate_string_file.rb +++ b/test/test_generate_string_file.rb @@ -12,31 +12,31 @@ class TestGenerateStringFile < CommandTestCase Twine::Runner.new(options, strings) end - def prepare_mock_write_file_formatter(formatter_class) + def prepare_mock_format_file_formatter(formatter_class) formatter = prepare_mock_formatter(formatter_class) - formatter.expects(:write_file) + formatter.expects(:format_file).returns(true) end def test_deducts_android_format_from_output_path - prepare_mock_write_file_formatter Twine::Formatters::Android + prepare_mock_format_file_formatter Twine::Formatters::Android new_runner('fr', 'fr.xml').generate_string_file end def test_deducts_apple_format_from_output_path - prepare_mock_write_file_formatter Twine::Formatters::Apple + prepare_mock_format_file_formatter Twine::Formatters::Apple new_runner('fr', 'fr.strings').generate_string_file end def test_deducts_jquery_format_from_output_path - prepare_mock_write_file_formatter Twine::Formatters::JQuery + prepare_mock_format_file_formatter Twine::Formatters::JQuery new_runner('fr', 'fr.json').generate_string_file end def test_deducts_gettext_format_from_output_path - prepare_mock_write_file_formatter Twine::Formatters::Gettext + prepare_mock_format_file_formatter Twine::Formatters::Gettext new_runner('fr', 'fr.po').generate_string_file end @@ -44,7 +44,7 @@ class TestGenerateStringFile < CommandTestCase def test_deducts_language_from_output_path random_language = KNOWN_LANGUAGES.sample formatter = prepare_mock_formatter Twine::Formatters::Android - formatter.expects(:write_file).with(anything, random_language) + formatter.expects(:format_file).with(random_language).returns(true) new_runner(nil, "#{random_language}.xml").generate_string_file end