twine 0.9.1 → 0.10.0

data/test/test_twine_definition.rb

@@ -0,0 +1,111 @@
+require 'twine_test'
+
+class TestTwineDefinition < TwineTest
+  class TestTags < TwineTest
+    def setup
+      super
+      @definition = Twine::TwineDefinition.new 'key'
+    end
+
+    def test_include_untagged
+      assert @definition.matches_tags?([[rand(100000).to_s]], true)
+    end
+
+    def test_matches_no_given_tags
+      assert @definition.matches_tags?([], false)
+    end
+
+    def test_matches_tag
+      @definition.tags = ['tag1']
+
+      assert @definition.matches_tags?([['tag1']], false)
+    end
+
+    def test_matches_any_tag
+      @definition.tags = ['tag1']
+
+      assert @definition.matches_tags?([['tag0', 'tag1', 'tag2']], false)
+    end
+
+    def test_matches_all_tags
+      @definition.tags = ['tag1', 'tag2']
+
+      assert @definition.matches_tags?([['tag1'], ['tag2']], false)
+    end
+
+    def test_does_not_match_all_tags
+      @definition.tags = ['tag1']
+
+      refute @definition.matches_tags?([['tag1'], ['tag2']], false)
+    end
+
+    def test_does_not_match_excluded_tag
+      @definition.tags = ['tag1']
+
+      refute @definition.matches_tags?([['~tag1']], false)
+    end
+
+    def test_matches_excluded_tag
+      @definition.tags = ['tag2']
+
+      assert @definition.matches_tags?([['~tag1']], false)
+    end
+
+    def test_complex_rules
+      @definition.tags = ['tag1', 'tag2', 'tag3']
+
+      assert @definition.matches_tags?([['tag1']], false)
+      assert @definition.matches_tags?([['tag1', 'tag4']], false)
+      assert @definition.matches_tags?([['tag1'], ['tag2'], ['tag3']], false)
+      refute @definition.matches_tags?([['tag1'], ['tag4']], false)
+
+      assert @definition.matches_tags?([['tag4', '~tag5']], false)
+    end
+  end
+
+  class TestReferences < TwineTest
+    def setup
+      super
+
+      @reference = Twine::TwineDefinition.new 'reference-key'
+      @reference.comment = 'reference comment'
+      @reference.tags = ['ref1']
+      @reference.translations['en'] = 'ref-value'
+
+      @definition = Twine::TwineDefinition.new 'key'
+      @definition.reference_key = @reference.key
+      @definition.reference = @reference
+    end
+
+    def test_reference_comment_used
+      assert_equal 'reference comment', @definition.comment
+    end
+
+    def test_reference_comment_override
+      @definition.comment = 'definition comment'
+
+      assert_equal 'definition comment', @definition.comment
+    end
+
+    def test_reference_tags_used
+      assert @definition.matches_tags?([['ref1']], false)
+    end
+
+    def test_reference_tags_override
+      @definition.tags = ['tag1']
+
+      refute @definition.matches_tags?([['ref1']], false)
+      assert @definition.matches_tags?([['tag1']], false)
+    end
+
+    def test_reference_translation_used
+      assert_equal 'ref-value', @definition.translation_for_lang('en')
+    end
+
+    def test_reference_translation_override
+      @definition.translations['en'] = 'value'
+
+      assert_equal 'value', @definition.translation_for_lang('en')
+    end
+  end
+end

data/test/test_twine_file.rb

@@ -0,0 +1,58 @@
+require 'twine_test'
+
+class TestTwineFile < TwineTest
+  class Reading < TwineTest
+    def setup
+      super
+
+      @twine_file = Twine::TwineFile.new
+      @twine_file.read fixture_path('twine_accent_values.txt')
+    end
+
+    def test_reading_keeps_leading_accent
+      assert_equal '`value', @twine_file.definitions_by_key['value_with_leading_accent'].translations['en']
+    end
+
+    def test_reading_keeps_trailing_accent
+      assert_equal 'value`', @twine_file.definitions_by_key['value_with_trailing_accent'].translations['en']
+    end
+
+    def test_reading_keeps_leading_space
+      assert_equal ' value', @twine_file.definitions_by_key['value_with_leading_space'].translations['en']
+    end
+
+    def test_reading_keeps_trailing_space
+      assert_equal 'value ', @twine_file.definitions_by_key['value_with_trailing_space'].translations['en']
+    end
+
+    def test_reading_keeps_wrapping_spaces
+      assert_equal ' value ', @twine_file.definitions_by_key['value_wrapped_by_spaces'].translations['en']
+    end
+
+    def test_reading_keeps_wrapping_accents
+      assert_equal '`value`', @twine_file.definitions_by_key['value_wrapped_by_accents'].translations['en']
+    end
+  end
+
+  class Writing < TwineTest
+
+    def test_accent_wrapping
+      @twine_file = build_twine_file 'en' do
+        add_section 'Section' do
+          add_definition value_with_leading_accent: '`value'
+          add_definition value_with_trailing_accent: 'value`'
+          add_definition value_with_leading_space: ' value'
+          add_definition value_with_trailing_space: 'value '
+          add_definition value_wrapped_by_spaces: ' value '
+          add_definition value_wrapped_by_accents: '`value`'
+        end
+      end
+
+      @twine_file.write @output_path
+
+      assert_equal content('twine_accent_values.txt'), File.read(@output_path)
+    end
+
+  end
+
+end

data/test/test_validate_twine_file.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+
+require 'command_test'
+
+class TestValidateTwineFile < CommandTest
+  def setup
+    super
+    @options = { twine_file: 'input.txt' }
+
+    @twine_file = build_twine_file 'en' do
+      add_section 'Section 1' do
+        add_definition key1: 'value1', tags: ['tag1']
+        add_definition key2: 'value2', tags: ['tag1']
+      end
+
+      add_section 'Section 2' do
+        add_definition key3: 'value3', tags: ['tag1', 'tag2']
+        add_definition key4: 'value4', tags: ['tag2']
+      end
+    end
+  end
+
+  def random_definition
+    @twine_file.definitions_by_key[@twine_file.definitions_by_key.keys.sample]
+  end
+
+  def test_recognizes_valid_file
+    Twine::Runner.new(@options, @twine_file).validate_twine_file
+    assert_equal "input.txt is valid.\n", Twine::stdout.string
+  end
+
+  def test_reports_duplicate_keys
+    @twine_file.sections[0].definitions << random_definition
+
+    assert_raises Twine::Error do
+      Twine::Runner.new(@options, @twine_file).validate_twine_file
+    end
+  end
+
+  def test_reports_invalid_characters_in_keys
+    random_definition.key[0] = "!?;:,^`´'\"\\|/(){}[]~-+*=#$%".chars.to_a.sample
+
+    assert_raises Twine::Error do
+      Twine::Runner.new(@options, @twine_file).validate_twine_file
+    end
+  end
+
+  def test_does_not_reports_missing_tags_by_default
+    random_definition.tags.clear
+
+    Twine::Runner.new(@options, @twine_file).validate_twine_file
+  end
+
+  def test_reports_missing_tags
+    random_definition.tags.clear
+
+    assert_raises Twine::Error do
+      Twine::Runner.new(@options.merge(pedantic: true), @twine_file).validate_twine_file
+    end
+  end
+end

data/test/twine_file_dsl.rb

@@ -1,6 +1,6 @@
 module TwineFileDSL
   def build_twine_file(*languages)
-    @currently_built_twine_file = Twine::StringsFile.new
+    @currently_built_twine_file = Twine::TwineFile.new
     @currently_built_twine_file.language_codes.concat languages
     yield
     result = @currently_built_twine_file
@@ -10,37 +10,37 @@ module TwineFileDSL
 
   def add_section(name)
     return unless @currently_built_twine_file
-    @currently_built_twine_file_section = Twine::StringsSection.new name
+    @currently_built_twine_file_section = Twine::TwineSection.new name
     @currently_built_twine_file.sections << @currently_built_twine_file_section
     yield
     @currently_built_twine_file_section = nil
   end
 
-  def add_row(parameters)
+  def add_definition(parameters)
     return unless @currently_built_twine_file
     return unless @currently_built_twine_file_section
 
     # this relies on Ruby preserving the order of hash elements
     key, value = parameters.first
-    row = Twine::StringsRow.new(key.to_s)
+    definition = Twine::TwineDefinition.new(key.to_s)
     if value.is_a? Hash
       value.each do |language, translation|
-        row.translations[language.to_s] = translation
+        definition.translations[language.to_s] = translation
       end
     elsif !value.is_a? Symbol
       language = @currently_built_twine_file.language_codes.first
-      row.translations[language] = value
+      definition.translations[language] = value
     end
 
-    row.comment = parameters[:comment] if parameters[:comment]
-    row.tags = parameters[:tags] if parameters[:tags]
+    definition.comment = parameters[:comment] if parameters[:comment]
+    definition.tags = parameters[:tags] if parameters[:tags]
     if parameters[:ref] || value.is_a?(Symbol)
       reference_key = (parameters[:ref] || value).to_s
-      row.reference_key = reference_key
-      row.reference = @currently_built_twine_file.strings_map[reference_key]
+      definition.reference_key = reference_key
+      definition.reference = @currently_built_twine_file.definitions_by_key[reference_key]
     end
 
-    @currently_built_twine_file_section.rows << row
-    @currently_built_twine_file.strings_map[row.key] = row
+    @currently_built_twine_file_section.definitions << definition
+    @currently_built_twine_file.definitions_by_key[definition.key] = definition
   end
 end

data/test/{twine_test_case.rb → twine_test.rb}

@@ -6,7 +6,7 @@ require 'stringio'
 require 'twine'
 require 'twine_file_dsl'
 
-class TwineTestCase < Minitest::Test
+class TwineTest < Minitest::Test
   include TwineFileDSL
 
   KNOWN_LANGUAGES = %w(en fr de es)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twine
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Sebastian Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-01 00:00:00.000000000 Z
+date: 2017-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -110,10 +110,10 @@ files:
 - lib/twine/placeholders.rb
 - lib/twine/plugin.rb
 - lib/twine/runner.rb
-- lib/twine/stringsfile.rb
+- lib/twine/twine_file.rb
 - lib/twine/version.rb
-- test/command_test_case.rb
-- test/fixtures/consume_loc_drop.zip
+- test/command_test.rb
+- test/fixtures/consume_localization_archive.zip
 - test/fixtures/enc_utf16be.dummy
 - test/fixtures/enc_utf16be_bom.dummy
 - test/fixtures/enc_utf16le.dummy
@@ -130,19 +130,19 @@ files:
 - test/fixtures/twine_accent_values.txt
 - test/test_abstract_formatter.rb
 - test/test_cli.rb
-- test/test_consume_loc_drop.rb
-- test/test_consume_string_file.rb
+- test/test_consume_localization_archive.rb
+- test/test_consume_localization_file.rb
 - test/test_formatters.rb
-- test/test_generate_all_string_files.rb
-- test/test_generate_loc_drop.rb
-- test/test_generate_string_file.rb
+- test/test_generate_all_localization_files.rb
+- test/test_generate_localization_archive.rb
+- test/test_generate_localization_file.rb
 - test/test_output_processor.rb
 - test/test_placeholders.rb
-- test/test_strings_file.rb
-- test/test_strings_row.rb
-- test/test_validate_strings_file.rb
+- test/test_twine_definition.rb
+- test/test_twine_file.rb
+- test/test_validate_twine_file.rb
 - test/twine_file_dsl.rb
-- test/twine_test_case.rb
+- test/twine_test.rb
 homepage: https://github.com/mobiata/twine
 licenses:
 - BSD-3-Clause
@@ -166,18 +166,18 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: Manage strings and their translations for your iOS and Android projects.
+summary: Manage strings and their translations for your iOS, Android and other projects.
 test_files:
 - test/test_abstract_formatter.rb
 - test/test_cli.rb
-- test/test_consume_loc_drop.rb
-- test/test_consume_string_file.rb
+- test/test_consume_localization_archive.rb
+- test/test_consume_localization_file.rb
 - test/test_formatters.rb
-- test/test_generate_all_string_files.rb
-- test/test_generate_loc_drop.rb
-- test/test_generate_string_file.rb
+- test/test_generate_all_localization_files.rb
+- test/test_generate_localization_archive.rb
+- test/test_generate_localization_file.rb
 - test/test_output_processor.rb
 - test/test_placeholders.rb
-- test/test_strings_file.rb
-- test/test_strings_row.rb
-- test/test_validate_strings_file.rb
+- test/test_twine_definition.rb
+- test/test_twine_file.rb
+- test/test_validate_twine_file.rb

data/test/test_consume_loc_drop.rb

@@ -1,27 +0,0 @@
-require 'command_test_case'
-
-class TestConsumeLocDrop < CommandTestCase
-  def setup
-    super
-
-    options = {}
-    options[:input_path] = fixture_path 'consume_loc_drop.zip'
-    options[:output_path] = @output_path
-    options[:format] = 'apple'
-
-    @twine_file = build_twine_file 'en', 'es' do
-      add_section 'Section' do
-        add_row key1: 'value1'
-      end
-    end
-
-    @runner = Twine::Runner.new(options, @twine_file)
-  end
-
-  def test_consumes_zip_file
-    @runner.consume_loc_drop
-
-    assert @twine_file.strings_map['key1'].translations['en'], 'value1-english'
-    assert @twine_file.strings_map['key1'].translations['es'], 'value1-spanish'
-  end
-end

data/test/test_strings_file.rb

@@ -1,58 +0,0 @@
-require 'twine_test_case'
-
-class TestStringsFile < TwineTestCase
-  class Reading < TwineTestCase
-    def setup
-      super
-
-      @strings = Twine::StringsFile.new
-      @strings.read fixture_path('twine_accent_values.txt')
-    end
-
-    def test_reading_keeps_leading_accent
-      assert_equal '`value', @strings.strings_map['value_with_leading_accent'].translations['en']
-    end
-
-    def test_reading_keeps_trailing_accent
-      assert_equal 'value`', @strings.strings_map['value_with_trailing_accent'].translations['en']
-    end
-
-    def test_reading_keeps_leading_space
-      assert_equal ' value', @strings.strings_map['value_with_leading_space'].translations['en']
-    end
-
-    def test_reading_keeps_trailing_space
-      assert_equal 'value ', @strings.strings_map['value_with_trailing_space'].translations['en']
-    end
-
-    def test_reading_keeps_wrapping_spaces
-      assert_equal ' value ', @strings.strings_map['value_wrapped_by_spaces'].translations['en']
-    end
-
-    def test_reading_keeps_wrapping_accents
-      assert_equal '`value`', @strings.strings_map['value_wrapped_by_accents'].translations['en']
-    end
-  end
-
-  class Writing < TwineTestCase
-
-    def test_accent_wrapping
-      @strings = build_twine_file 'en' do
-        add_section 'Section' do
-          add_row value_with_leading_accent: '`value'
-          add_row value_with_trailing_accent: 'value`'
-          add_row value_with_leading_space: ' value'
-          add_row value_with_trailing_space: 'value '
-          add_row value_wrapped_by_spaces: ' value '
-          add_row value_wrapped_by_accents: '`value`'
-        end
-      end
-
-      @strings.write @output_path
-
-      assert_equal content('twine_accent_values.txt'), File.read(@output_path)
-    end
-
-  end
-
-end