twine 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46fb29dd5d1ec899c427901e72e40c081fa8c6c4
-  data.tar.gz: 3faf58c634c4d1903fda10a1ece3cace658dc761
+  metadata.gz: ebc7f372d107cb4c3b9a12da92b792c510209d59
+  data.tar.gz: 72ccda8290612adfc0f7ac75f86756bc1d945333
 SHA512:
-  metadata.gz: 6ec4b6098a24520cba05e4bb2bd0ea16602c9b52382abfeb45e9bf0308a4b1c03287251160cdec49cb26f44ccd69ff96d17f5dd0c9d56b7612068435c750dfb2
-  data.tar.gz: b1a85e5a3fb56e20a790e7beb8649784f5ffab42f4e8b6db7132680a634275caad8ab698a09369d9b46821c873bf8a51c416f941337d1b101ad079f6bd6d2960
+  metadata.gz: 44bf1d87f0b3e88e70cc8962dd708a35866a74710e95706ae5e4061c02995b00afb6175acb1d5219605ec391b60ceeddf01edb83bd253d73e14681847cd8aac6
+  data.tar.gz: ea504d997033b778bb9f458fb33ef1f75bfb4d57c6da1771685f092c3fa1b2362f8bdf82d2a85cbcaade440c42617f21e130c7baab7767f5522f27843f78ca5f

data/lib/twine.rb

@@ -23,11 +23,11 @@ module Twine
 
   require 'twine/plugin'
   require 'twine/cli'
+  require 'twine/stringsfile'
   require 'twine/encoding'
   require 'twine/output_processor'
   require 'twine/placeholders'
   require 'twine/formatters'
   require 'twine/runner'
-  require 'twine/stringsfile'
   require 'twine/version'
 end

data/lib/twine/cli.rb

@@ -46,7 +46,7 @@ module Twine
         opts.on('-u', '--untagged', 'If you have specified tags using the --tags flag, then only those tags will be selected. If you also want to select all strings that are untagged, then you can specify this option to do so.') do |u|
           options[:untagged] = true
         end
-        formats = Formatters.formatters.map { |f| f::FORMAT_NAME }
+        formats = Formatters.formatters.map(&:format_name)
         opts.on('-f', '--format FORMAT', "The file format to read or write (#{formats.join(', ')}). Additional formatters can be placed in the formats/ directory.") do |format|
           unless formats.include?(format.downcase)
             raise Twine::Error.new "Invalid format: #{format}"
@@ -89,6 +89,12 @@ module Twine
           end
           options[:output_encoding] = e
         end
+        opts.on('--validate', 'Validate the strings file before formatting it') do
+          options[:validate] = true
+        end
+        opts.on('-p', '--pedantic', 'When validating a strings file, perform additional checks that go beyond pure validity (like presence of tags)') do
+          options[:pedantic] = true
+        end
         opts.on('-h', '--help', 'Show this message.') do |h|
           puts opts.help
           exit

data/lib/twine/formatters.rb

@@ -1,15 +1,6 @@
-require 'twine/formatters/abstract'
-require 'twine/formatters/android'
-require 'twine/formatters/apple'
-require 'twine/formatters/flash'
-require 'twine/formatters/gettext'
-require 'twine/formatters/jquery'
-require 'twine/formatters/django'
-require 'twine/formatters/tizen'
-
 module Twine
   module Formatters
-    @formatters = [Formatters::Apple, Formatters::Android, Formatters::Gettext, Formatters::JQuery, Formatters::Flash, Formatters::Django, Formatters::Tizen]
+    @formatters = []
 
     class << self
       attr_reader :formatters
@@ -22,9 +13,12 @@ module Twine
       # returns array of active formatters
       #
       def register_formatter formatter_class
-        raise "#{formatter_class} already registered" if @formatters.include? formatter_class
-        @formatters << formatter_class
+        @formatters << formatter_class.new
       end
     end
   end
-end
+end
+
+Dir[File.join(File.dirname(__FILE__), 'formatters', '*.rb')].each do |file|
+  require file
+end

data/lib/twine/formatters/abstract.rb

@@ -3,17 +3,28 @@ require 'fileutils'
 module Twine
   module Formatters
     class Abstract
-      attr_reader :strings
-      attr_reader :options
+      attr_accessor :strings
+      attr_accessor :options
 
-      def self.can_handle_directory?(path)
-        return false
+      def initialize
+        @strings = StringsFile.new
+        @options = {}
       end
 
-      def initialize(strings, options)
-        @strings = strings
-        @options = options
-        @output_processor = Processors::OutputProcessor.new @strings, @options
+      def format_name
+        raise NotImplementedError.new("You must implement format_name in your formatter class.")
+      end
+
+      def extension
+        raise NotImplementedError.new("You must implement extension in your formatter class.")
+      end
+
+      def can_handle_directory?(path)
+        raise NotImplementedError.new("You must implement can_handle_directory? in your formatter class.")
+      end
+
+      def default_file_name
+        raise NotImplementedError.new("You must implement default_file_name in your formatter class.")
       end
 
       def set_translation_for_key(key, lang, value)
@@ -64,10 +75,6 @@ module Twine
         end
       end
 
-      def default_file_name
-        raise NotImplementedError.new("You must implement default_file_name in your formatter class.")
-      end
-
       def determine_language_given_path(path)
         raise NotImplementedError.new("You must implement determine_language_given_path in your formatter class.")
       end
@@ -92,21 +99,25 @@ module Twine
 
       def format_sections(strings, lang)
         sections = strings.sections.map { |section| format_section(section, lang) }
-        sections.join("\n")
+        sections.compact.join("\n")
       end
 
       def format_section_header(section)
       end
 
+      def should_include_row(row, lang)
+        row.translated_string_for_lang(lang)
+      end
+
       def format_section(section, lang)
-        rows = section.rows.dup
+        rows = section.rows.select { |row| should_include_row(row, lang) }
+        return if rows.empty?
 
         result = ""
-        unless rows.empty?
-          if section.name && section.name.length > 0
-            section_header = format_section_header(section)
-            result += "\n#{section_header}" if section_header
-          end
+
+        if section.name && section.name.length > 0
+          section_header = format_section_header(section)
+          result += "\n#{section_header}" if section_header
         end
 
         rows.map! { |row| format_row(row, lang) }
@@ -115,16 +126,8 @@ module Twine
         result += rows.join
       end
 
-      def row_pattern
-        "%{comment}%{key_value}"
-      end
-
       def format_row(row, lang)
-        return nil unless row.translated_string_for_lang(lang)
-
-        result = row_pattern.scan(/%\{([a-z_]+)\}/).flatten
-        result.map! { |element| send("format_#{element}".to_sym, row, lang) }
-        result.flatten.join
+        [format_comment(row, lang), format_key_value(row, lang)].compact.join
       end
 
       def format_comment(row, lang)
@@ -152,10 +155,10 @@ module Twine
       end
 
       def write_file(path, lang)
-        encoding = @options[:output_encoding] || 'UTF-8'
-
-        processed_strings = @output_processor.process(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
@@ -169,7 +172,8 @@ module Twine
 
             FileUtils.mkdir_p(output_path)
 
-            write_file(File.join(output_path, file_name), lang)
+            file_path = File.join(output_path, file_name)
+            write_file(file_path, lang)
           end
         else
           language_written = false
@@ -182,7 +186,8 @@ module Twine
             lang = determine_language_given_path(item)
             next unless lang
 
-            write_file(File.join(item, file_name), lang)
+            file_path = File.join(item, file_name)
+            write_file(file_path, lang)
             language_written = true
           end
 

data/lib/twine/formatters/android.rb

@@ -7,9 +7,6 @@ module Twine
     class Android < Abstract
       include Twine::Placeholders
 
-      FORMAT_NAME = 'android'
-      EXTENSION = '.xml'
-      DEFAULT_FILE_NAME = 'strings.xml'
       LANG_CODES = Hash[
         'zh' => 'zh-Hans',
         'zh-rCN' => 'zh-Hans',
@@ -20,12 +17,20 @@ module Twine
         # TODO: spanish
       ]
 
-      def self.can_handle_directory?(path)
+      def format_name
+        'android'
+      end
+
+      def extension
+        '.xml'
+      end
+
+      def can_handle_directory?(path)
         Dir.entries(path).any? { |item| /^values.*$/.match(item) }
       end
 
       def default_file_name
-        return DEFAULT_FILE_NAME
+        return 'strings.xml'
       end
 
       def determine_language_given_path(path)
@@ -135,3 +140,5 @@ module Twine
     end
   end
 end
+
+Twine::Formatters.formatters << Twine::Formatters::Android.new

data/lib/twine/formatters/apple.rb

@@ -1,16 +1,20 @@
 module Twine
   module Formatters
     class Apple < Abstract
-      FORMAT_NAME = 'apple'
-      EXTENSION = '.strings'
-      DEFAULT_FILE_NAME = 'Localizable.strings'
+      def format_name
+        'apple'
+      end
+
+      def extension
+        '.strings'
+      end
 
-      def self.can_handle_directory?(path)
+      def can_handle_directory?(path)
         Dir.entries(path).any? { |item| /^.+\.lproj$/.match(item) }
       end
 
       def default_file_name
-        return DEFAULT_FILE_NAME
+        return 'Localizable.strings'
       end
 
       def determine_language_given_path(path)
@@ -111,3 +115,5 @@ module Twine
     end
   end
 end
+
+Twine::Formatters.formatters << Twine::Formatters::Apple.new

data/lib/twine/formatters/django.rb

@@ -1,16 +1,20 @@
 module Twine
   module Formatters
     class Django < Abstract
-      FORMAT_NAME = 'django'
-      EXTENSION = '.po'
-      DEFAULT_FILE_NAME = 'strings.po'
+      def format_name
+        'django'
+      end
+
+      def extension
+        '.po'
+      end
 
-      def self.can_handle_directory?(path)
-      Dir.entries(path).any? { |item| /^.+\.po$/.match(item) }
+      def can_handle_directory?(path)
+        Dir.entries(path).any? { |item| /^.+\.po$/.match(item) }
       end
 
       def default_file_name
-        return DEFAULT_FILE_NAME
+        return 'strings.po'
       end
 
       def determine_language_given_path(path)
@@ -92,7 +96,9 @@ module Twine
 
       def format_file(strings, lang)
         @default_lang = strings.language_codes[0]
-        super
+        result = super
+        @default_lang = nil
+        result
       end
 
       def format_header(lang)
@@ -103,11 +109,11 @@ module Twine
         "#--------- #{section.name} ---------#\n"
       end
 
-      def row_pattern
-        "%{comment}%{base_translation}%{key_value}"
+      def format_row(row, lang)
+        [format_comment(row, lang), format_base_translation(row), format_key_value(row, lang)].compact.join
       end
 
-      def format_base_translation(row, lang)
+      def format_base_translation(row)
         base_translation = row.translations[@default_lang]
         "# base translation: \"#{base_translation}\"\n" if base_translation
       end
@@ -131,3 +137,5 @@ module Twine
     end
   end
 end
+
+Twine::Formatters.formatters << Twine::Formatters::Django.new

data/lib/twine/formatters/flash.rb

@@ -1,16 +1,20 @@
 module Twine
   module Formatters
     class Flash < Abstract
-      FORMAT_NAME = 'flash'
-      EXTENSION = '.properties'
-      DEFAULT_FILE_NAME = 'resources.properties'
+      def format_name
+        'flash'
+      end
+
+      def extension
+        '.properties'
+      end
 
-      def self.can_handle_directory?(path)
+      def can_handle_directory?(path)
         return false
       end
 
       def default_file_name
-        return DEFAULT_FILE_NAME
+        return 'resources.properties'
       end
 
       def determine_language_given_path(path)
@@ -93,3 +97,5 @@ module Twine
     end
   end
 end
+
+Twine::Formatters.formatters << Twine::Formatters::Flash.new

data/lib/twine/formatters/gettext.rb

@@ -3,16 +3,20 @@
 module Twine
   module Formatters
     class Gettext < Abstract
-      FORMAT_NAME = 'gettext'
-      EXTENSION = '.po'
-      DEFAULT_FILE_NAME = 'strings.po'
+      def format_name
+        'gettext'
+      end
+
+      def extension
+        '.po'
+      end
 
-      def self.can_handle_directory?(path)
+      def can_handle_directory?(path)
         Dir.entries(path).any? { |item| /^.+\.po$/.match(item) }
       end
 
       def default_file_name
-        return DEFAULT_FILE_NAME
+        return 'strings.po'
       end
 
       def determine_language_given_path(path)
@@ -62,7 +66,9 @@ module Twine
 
       def format_file(strings, lang)
         @default_lang = strings.language_codes[0]
-        super
+        result = super
+        @default_lang = nil
+        result
       end
 
       def format_header(lang)
@@ -73,31 +79,32 @@ module Twine
         "# SECTION: #{section.name}"
       end
 
-      def row_pattern
-        "%{comment}%{key}%{base_translation}%{value}"
-      end
-
-      def format_row(row, lang)
-        return nil unless row.translated_string_for_lang(@default_lang)
-
-        super
+      def should_include_row(row, lang)
+        super and row.translated_string_for_lang(@default_lang)
       end
 
       def format_comment(row, lang)
         "#. \"#{escape_quotes(row.comment)}\"\n" if row.comment
       end
 
-      def format_key(row, lang)
-        "msgctxt \"#{row.key.dup}\"\n"
+      def format_key_value(row, lang)
+        value = row.translated_string_for_lang(lang)
+        [format_key(row.key.dup), format_base_translation(row), format_value(value.dup)].compact.join
+      end
+
+      def format_key(key)
+        "msgctxt \"#{key}\"\n"
       end
 
-      def format_base_translation(row, lang)
+      def format_base_translation(row)
         "msgid \"#{row.translations[@default_lang]}\"\n"
       end
 
-      def format_value(row, lang)
-        "msgstr \"#{row.translated_string_for_lang(lang)}\"\n"
+      def format_value(value)
+        "msgstr \"#{value}\"\n"
       end
     end
   end
 end
+
+Twine::Formatters.formatters << Twine::Formatters::Gettext.new

data/lib/twine/formatters/jquery.rb

@@ -1,16 +1,20 @@
 module Twine
   module Formatters
     class JQuery < Abstract
-      FORMAT_NAME = 'jquery'
-      EXTENSION = '.json'
-      DEFAULT_FILE_NAME = 'localize.json'
+      def format_name
+        'jquery'
+      end
+
+      def extension
+        '.json'
+      end
 
-      def self.can_handle_directory?(path)
+      def can_handle_directory?(path)
         Dir.entries(path).any? { |item| /^.+\.json$/.match(item) }
       end
 
       def default_file_name
-        return DEFAULT_FILE_NAME
+        return 'localize.json'
       end
 
       def determine_language_given_path(path)
@@ -71,15 +75,8 @@ module Twine
       def format_value(value)
         escape_quotes(value)
       end
-
-      def write_file(path, lang)
-        begin
-          require "json"
-        rescue LoadError
-          raise Twine::Error.new "You must run 'gem install json' in order to read or write jquery-localize files."
-        end
-        super
-      end
     end
   end
 end
+
+Twine::Formatters.formatters << Twine::Formatters::JQuery.new

data/lib/twine/formatters/tizen.rb

@@ -7,9 +7,6 @@ module Twine
     class Tizen < Abstract
       include Twine::Placeholders
 
-      FORMAT_NAME = 'tizen'
-      EXTENSION = '.xml'
-      DEFAULT_FILE_NAME = 'strings.xml'
       LANG_CODES = Hash[
         'eng-GB' => 'en',
         'rus-RU' => 'ru',
@@ -22,39 +19,21 @@ module Twine
         'por-PT' => 'pt',
         'ukr-UA' => 'uk'
       ]
-      DEFAULT_LANG_CODES = Hash[
-      ]
 
-      def self.can_handle_directory?(path)
-        Dir.entries(path).any? { |item| /^values.*$/.match(item) }
+      def format_name
+        'tizen'
       end
 
-      def default_file_name
-        return DEFAULT_FILE_NAME
+      def extension
+        '.xml'
       end
 
-      def write_all_files(path)
-        if !File.directory?(path)
-          raise Twine::Error.new("Directory does not exist: #{path}")
-        end
+      def can_handle_directory?(path)
+        Dir.entries(path).any? { |item| /^values.*$/.match(item) }
+      end
 
-        langs_written = []
-        Dir.foreach(path) do |item|
-          if item == "." or item == ".."
-            next
-          end
-          item = File.join(path, item)
-          if !File.directory?(item)
-            lang = determine_language_given_path(item)
-            if lang
-              write_file(item, lang)
-              langs_written << lang
-            end
-          end
-        end
-        if langs_written.empty?
-          raise Twine::Error.new("Failed to genertate any files: No languages found at #{path}")
-        end
+      def default_file_name
+        return 'strings.xml'
       end
 
       def determine_language_given_path(path)
@@ -156,3 +135,5 @@ module Twine
     end
   end
 end
+
+Twine::Formatters.formatters << Twine::Formatters::Tizen.new

data/lib/twine/runner.rb

@@ -43,13 +43,17 @@ module Twine
     end
 
     def generate_string_file
+      validate_strings_file if @options[:validate]
+
       lang = nil
       lang = @options[:languages][0] if @options[:languages]
 
-      read_write_string_file(@options[:output_path], false, lang)
+      write_string_file(@options[:output_path], lang)
     end
 
     def generate_all_string_files
+      validate_strings_file if @options[:validate]
+
       if !File.directory?(@options[:output_path])
         if @options[:create_folders]
           FileUtils.mkdir_p(@options[:output_path])
@@ -58,13 +62,13 @@ module Twine
         end
       end
 
-      format = @options[:format] || determine_format_given_directory(@options[:output_path])
-      unless format
+      formatter_for_directory = find_formatter { |f| f.can_handle_directory?(@options[:output_path]) }
+      formatter = formatter_for_format(@options[:format]) || formatter_for_directory
+      
+      unless formatter
         raise Twine::Error.new "Could not determine format given the contents of #{@options[:output_path]}"
       end
 
-      formatter = formatter_for_format(format)
-
       formatter.write_all_files(@options[:output_path])
     end
 
@@ -74,7 +78,7 @@ module Twine
         lang = @options[:languages][0]
       end
 
-      read_write_string_file(@options[:input_path], true, lang)
+      read_string_file(@options[:input_path], lang)
       output_path = @options[:output_path] || @options[:strings_file]
       write_strings_data(output_path)
     end
@@ -87,7 +91,7 @@ module Twine
       Dir.glob(File.join(@options[:input_path], "**/*")) do |item|
         if File.file?(item)
           begin
-            read_write_string_file(item, true, nil)
+            read_string_file(item)
           rescue Twine::Error => e
             Twine::stderr.puts "#{e.message}"
           end
@@ -98,35 +102,9 @@ module Twine
       write_strings_data(output_path)
     end
 
-    def read_write_string_file(path, is_read, lang)
-      if is_read && !File.file?(path)
-        raise Twine::Error.new("File does not exist: #{path}")
-      end
-
-      format = @options[:format] || determine_format_given_path(path)
-      unless format
-        raise Twine::Error.new "Unable to determine format of #{path}"
-      end
-
-      formatter = formatter_for_format(format)
-
-      lang = lang || determine_language_given_path(path) || formatter.determine_language_given_path(path)
-      unless lang
-        raise Twine::Error.new "Unable to determine language for #{path}"
-      end
-
-      if !@strings.language_codes.include? lang
-        @strings.language_codes << lang
-      end
-
-      if is_read
-        formatter.read_file(path, lang)
-      else
-        formatter.write_file(path, lang)
-      end
-    end
-
     def generate_loc_drop
+      validate_strings_file if @options[:validate]
+      
       require_rubyzip
 
       if File.file?(@options[:output_path])
@@ -140,7 +118,7 @@ module Twine
           formatter = formatter_for_format(@options[:format])
           @strings.language_codes.each do |lang|
             if @options[:languages] == nil || @options[:languages].length == 0 || @options[:languages].include?(lang)
-              file_name = lang + formatter.class::EXTENSION
+              file_name = lang + formatter.extension
               real_path = File.join(dir, file_name)
               zip_path = File.join('Locales', file_name)
               formatter.write_file(real_path, lang)
@@ -166,7 +144,7 @@ module Twine
               FileUtils.mkdir_p(File.dirname(real_path))
               zipfile.extract(entry.name, real_path)
               begin
-                read_write_string_file(real_path, true, nil)
+                read_string_file(real_path)
               rescue Twine::Error => e
                 Twine::stderr.puts "#{e.message}"
               end
@@ -207,10 +185,12 @@ module Twine
         errors << "Found duplicate string key(s):\n#{join_keys.call(duplicate_keys)}"
       end
 
-      if keys_without_tags.length == total_strings
-        errors << "None of your strings have tags."
-      elsif keys_without_tags.length > 0
-        errors << "Found strings without tags:\n#{join_keys.call(keys_without_tags)}"
+      if @options[:pedantic]
+        if keys_without_tags.length == total_strings
+          errors << "None of your strings have tags."
+        elsif keys_without_tags.length > 0
+          errors << "Found strings without tags:\n#{join_keys.call(keys_without_tags)}"
+        end
       end
 
       unless invalid_keys.empty?
@@ -222,34 +202,64 @@ module Twine
       Twine::stdout.puts "#{@options[:strings_file]} is valid."
     end
 
+    private
+
+    def require_rubyzip
+      begin
+        require 'zip'
+      rescue LoadError
+        raise Twine::Error.new "You must run 'gem install rubyzip' in order to create or consume localization drops."
+      end
+    end
+
     def determine_language_given_path(path)
       code = File.basename(path, File.extname(path))
       return code if @strings.language_codes.include? code
     end
 
-    def determine_format_given_path(path)
-      formatter = Formatters.formatters.find { |f| f::EXTENSION == File.extname(path) }
-      return formatter::FORMAT_NAME if formatter
+    def formatter_for_format(format)
+      find_formatter { |f| f.format_name == format }
     end
 
-    def determine_format_given_directory(directory)
-      formatter = Formatters.formatters.find { |f| f.can_handle_directory?(directory) }
-      return formatter::FORMAT_NAME if formatter
+    def find_formatter(&block)
+      formatter = Formatters.formatters.find &block
+      return nil unless formatter
+      formatter.strings = @strings
+      formatter.options = @options
+      formatter
     end
 
-    def formatter_for_format(format)
-      formatter = Formatters.formatters.find { |f| f::FORMAT_NAME == format }
-      return formatter.new(@strings, @options) if formatter
+    def read_string_file(path, lang = nil)
+      unless File.file?(path)
+        raise Twine::Error.new("File does not exist: #{path}")
+      end
+
+      formatter, lang = prepare_read_write(path, lang)
+
+      formatter.read_file(path, lang)
     end
 
-    private
+    def write_string_file(path, lang)
+      formatter, lang = prepare_read_write(path, lang)
+      formatter.write_file(path, lang)
+    end
 
-    def require_rubyzip
-      begin
-        require 'zip'
-      rescue LoadError
-        raise Twine::Error.new "You must run 'gem install rubyzip' in order to create or consume localization drops."
+    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
+      
+      unless formatter
+        raise Twine::Error.new "Unable to determine format of #{path}"
+      end      
+
+      lang = lang || determine_language_given_path(path) || formatter.determine_language_given_path(path)
+      unless lang
+        raise Twine::Error.new "Unable to determine language for #{path}"
       end
+
+      @strings.language_codes << lang unless @strings.language_codes.include? lang
+
+      return formatter, lang
     end
   end
 end

data/lib/twine/version.rb

@@ -1,3 +1,3 @@
 module Twine
-  VERSION = '0.8.0'
+  VERSION = '0.8.1'
 end

data/test/command_test_case.rb

@@ -5,8 +5,10 @@ class CommandTestCase < TwineTestCase
     strings = Twine::StringsFile.new
     strings.language_codes.concat KNOWN_LANGUAGES
 
-    formatter = formatter_class.new(strings, {})
-    formatter_class.stubs(:new).returns(formatter)
+    formatter = formatter_class.new
+    formatter.strings = strings
+    Twine::Formatters.formatters.clear
+    Twine::Formatters.formatters << formatter
     formatter
   end
 end

data/test/fixtures/formatter_django.po

@@ -1,6 +1,6 @@
 ##
  # Django Strings File
- # Generated by Twine 0.7.0
+ # Generated by Twine <%= Twine::VERSION %>
  # Language: en
 
 

data/test/fixtures/formatter_flash.properties

@@ -1,5 +1,5 @@
 ## Flash Strings File
-## Generated by Twine 0.7.0
+## Generated by Twine <%= Twine::VERSION %>
 ## Language: en
 
 ## Section 1 ##

data/test/test_abstract_formatter.rb

@@ -12,7 +12,8 @@ class TestAbstractFormatter < TwineTestCase
         end
       end
 
-      @formatter = Twine::Formatters::Abstract.new(@strings, {})
+      @formatter = Twine::Formatters::Abstract.new
+      @formatter.strings = @strings
     end
 
     def test_set_translation_updates_existing_value
@@ -46,7 +47,9 @@ class TestAbstractFormatter < TwineTestCase
     end
 
     def test_set_translation_consume_all_adds_new_key
-      formatter = Twine::Formatters::Abstract.new(@strings, { consume_all: true })
+      formatter = Twine::Formatters::Abstract.new
+      formatter.strings = @strings
+      formatter.options = { consume_all: true }
       formatter.set_translation_for_key 'new-key', 'en', 'new-key-english'
 
       assert_equal 'new-key-english', @strings.strings_map['new-key'].translations['en']
@@ -54,14 +57,18 @@ class TestAbstractFormatter < TwineTestCase
 
     def test_set_translation_consume_all_adds_tags
       random_tag = SecureRandom.uuid
-      formatter = Twine::Formatters::Abstract.new(@strings, { consume_all: true, tags: [random_tag] })
+      formatter = Twine::Formatters::Abstract.new
+      formatter.strings = @strings
+      formatter.options = { consume_all: true, tags: [random_tag] }
       formatter.set_translation_for_key 'new-key', 'en', 'new-key-english'
 
       assert_equal [random_tag], @strings.strings_map['new-key'].tags
     end
 
     def test_set_translation_adds_new_keys_to_category_uncategoriezed
-      formatter = Twine::Formatters::Abstract.new(@strings, { consume_all: true })
+      formatter = Twine::Formatters::Abstract.new
+      formatter.strings = @strings
+      formatter.options = { consume_all: true }
       formatter.set_translation_for_key 'new-key', 'en', 'new-key-english'
 
       assert_equal 'Uncategorized', @strings.sections[0].name 
@@ -80,7 +87,8 @@ class TestAbstractFormatter < TwineTestCase
         end
       end
 
-      @formatter = Twine::Formatters::Abstract.new(@strings, {})
+      @formatter = Twine::Formatters::Abstract.new
+      @formatter.strings = @strings
     end
 
     def test_set_translation_does_not_add_unchanged_translation
@@ -108,14 +116,17 @@ class TestAbstractFormatter < TwineTestCase
     end
 
     def test_set_comment_for_key_does_not_update_comment
-      formatter = Twine::Formatters::Abstract.new(@strings, {})
+      formatter = Twine::Formatters::Abstract.new
+      formatter.strings = @strings
       formatter.set_comment_for_key('key', 'comment')
 
       assert_nil formatter.strings.strings_map['key'].comment
     end
 
     def test_set_comment_for_key_updates_comment_with_update_comments
-      formatter = Twine::Formatters::Abstract.new(@strings, { consume_comments: true })
+      formatter = Twine::Formatters::Abstract.new
+      formatter.strings = @strings
+      formatter.options = { consume_comments: true }
       formatter.set_comment_for_key('key', 'comment')
 
       assert_equal 'comment', formatter.strings.strings_map['key'].comment
@@ -133,7 +144,9 @@ class TestAbstractFormatter < TwineTestCase
         end
       end
 
-      @formatter = Twine::Formatters::Abstract.new(@strings, { consume_comments: true })
+      @formatter = Twine::Formatters::Abstract.new
+      @formatter.strings = @strings
+      @formatter.options = { consume_comments: true }
     end
 
     def test_set_comment_does_not_add_unchanged_comment

data/test/test_cli.rb

@@ -21,6 +21,11 @@ class CLITestCase < TwineTestCase
       assert_equal @strings_file_path, @options[:strings_file]
     end
 
+    def test_pedantic
+      parse "validate-strings-file #{@strings_file_path} --pedantic"
+      assert @options[:pedantic]
+    end
+
     def test_missing_parameter
       assert_raises Twine::Error do
         parse 'validate-strings-file'
@@ -49,6 +54,11 @@ class CLITestCase < TwineTestCase
       end
     end
 
+    def test_validate
+      parse "generate-string-file #{@strings_file_path} #{@output_path} --validate"
+      assert @options[:validate]
+    end
+
     def test_extra_parameter
       assert_raises Twine::Error do
         parse 'generate-string-file strings output extra'
@@ -77,6 +87,11 @@ class CLITestCase < TwineTestCase
       end
     end
 
+    def test_validate
+      parse "generate-all-string-files #{@strings_file_path} #{@output_dir} --validate"
+      assert @options[:validate]
+    end
+
     def test_extra_parameter
       assert_raises Twine::Error do
         parse "generate-all-string-files strings output extra"
@@ -149,6 +164,11 @@ class CLITestCase < TwineTestCase
       end
     end
 
+    def test_validate
+      parse "generate-loc-drop #{@strings_file_path} #{@output_path} --format apple --validate"
+      assert @options[:validate]
+    end
+
     def test_extra_parameter
       assert_raises Twine::Error do
         parse "generate-loc-drop strings output extra --format apple"
@@ -246,13 +266,13 @@ class CLITestCase < TwineTestCase
     end
 
     def test_format
-      random_format = Twine::Formatters.formatters.sample::FORMAT_NAME
+      random_format = Twine::Formatters.formatters.sample.format_name
       parse_with "--format #{random_format}"
       assert_equal random_format, @options[:format]
     end
 
     def test_format_ignores_case
-      random_format = Twine::Formatters.formatters.sample::FORMAT_NAME
+      random_format = Twine::Formatters.formatters.sample.format_name
       parse_with "--format #{random_format.upcase}"
       assert_equal random_format, @options[:format]
     end

data/test/test_formatters.rb

@@ -17,7 +17,9 @@ class FormatterTest < TwineTestCase
     end
 
     @strings = Twine::StringsFile.new
-    @formatter = formatter_class.new @strings, { consume_all: true, consume_comments: true }
+    @formatter = formatter_class.new
+    @formatter.strings = @strings
+    @formatter.options = { consume_all: true, consume_comments: true }
   end
 
   def assert_translations_read_correctly
@@ -66,7 +68,8 @@ class TestAndroidFormatter < FormatterTest
   end
 
   def test_write_file_output_format
-    formatter = Twine::Formatters::Android.new @twine_file, {}
+    formatter = Twine::Formatters::Android.new
+    formatter.strings = @twine_file
     formatter.write_file @output_path, 'en'
     assert_equal content('formatter_android.xml'), output_content
   end
@@ -111,7 +114,8 @@ class TestAppleFormatter < FormatterTest
   end
 
   def test_write_file_output_format
-    formatter = Twine::Formatters::Apple.new @twine_file, {}
+    formatter = Twine::Formatters::Apple.new
+    formatter.strings = @twine_file
     formatter.write_file @output_path, 'en'
     assert_equal content('formatter_apple.strings'), output_content
   end
@@ -142,7 +146,8 @@ class TestJQueryFormatter < FormatterTest
   end
 
   def test_write_file_output_format
-    formatter = Twine::Formatters::JQuery.new @twine_file, {}
+    formatter = Twine::Formatters::JQuery.new
+    formatter.strings = @twine_file
     formatter.write_file @output_path, 'en'
     assert_equal content('formatter_jquery.json'), output_content
   end
@@ -171,7 +176,8 @@ class TestGettextFormatter < FormatterTest
   end
 
   def test_write_file_output_format
-    formatter = Twine::Formatters::Gettext.new @twine_file, {}
+    formatter = Twine::Formatters::Gettext.new
+    formatter.strings = @twine_file
     formatter.write_file @output_path, 'en'
     assert_equal content('formatter_gettext.po'), output_content
   end
@@ -192,7 +198,8 @@ class TestTizenFormatter < FormatterTest
   end
 
   def test_write_file_output_format
-    formatter = Twine::Formatters::Tizen.new @twine_file, {}
+    formatter = Twine::Formatters::Tizen.new
+    formatter.strings = @twine_file
     formatter.write_file @output_path, 'en'
     assert_equal content('formatter_tizen.xml'), output_content
   end
@@ -211,7 +218,8 @@ class TestDjangoFormatter < FormatterTest
   end
 
   def test_write_file_output_format
-    formatter = Twine::Formatters::Django.new @twine_file, {}
+    formatter = Twine::Formatters::Django.new
+    formatter.strings = @twine_file
     formatter.write_file @output_path, 'en'
     assert_equal content('formatter_django.po'), output_content
   end
@@ -229,7 +237,8 @@ class TestFlashFormatter < FormatterTest
   end
 
   def test_write_file_output_format
-    formatter = Twine::Formatters::Flash.new @twine_file, {}
+    formatter = Twine::Formatters::Flash.new
+    formatter.strings = @twine_file
     formatter.write_file @output_path, 'en'
     assert_equal content('formatter_flash.properties'), output_content
   end

data/test/test_generate_all_string_files.rb

@@ -8,13 +8,13 @@ class TestGenerateAllStringFiles < CommandTestCase
       options[:format] = 'apple'
       options[:create_folders] = create_folders
 
-      @twine_file = build_twine_file 'en', 'es' do
+      twine_file = build_twine_file 'en', 'es' do
         add_section 'Section' do
           add_row key: 'value'
         end
       end
 
-      Twine::Runner.new(options, @twine_file)
+      Twine::Runner.new(options, twine_file)
     end
 
     def test_fails_if_output_folder_does_not_exist
@@ -41,4 +41,36 @@ class TestGenerateAllStringFiles < CommandTestCase
       assert File.exists?(File.join(@output_dir, 'es.lproj')), "language folder 'es.lproj' should be created"
     end
   end
+
+  class TestDeliberate < CommandTestCase
+    def new_runner(validate)
+      Dir.mkdir File.join @output_dir, 'values-en'
+
+      options = {}
+      options[:output_path] = @output_dir
+      options[:format] = 'android'
+      options[:validate] = validate
+
+      twine_file = build_twine_file 'en' do
+        add_section 'Section' do
+          add_row key: 'value'
+          add_row key: 'value'
+        end
+      end
+
+      Twine::Runner.new(options, twine_file)
+    end
+
+    def test_does_not_validate_strings_file
+      prepare_mock_formatter Twine::Formatters::Android
+
+      new_runner(false).generate_all_string_files
+    end
+
+    def test_validates_strings_file_if_validate
+      assert_raises Twine::Error do
+        new_runner(true).generate_all_string_files
+      end
+    end
+  end
 end

data/test/test_generate_loc_drop.rb

@@ -41,4 +41,34 @@ class TestGenerateLocDrop < CommandTestCase
 
     @runner.generate_loc_drop
   end
+
+  class TestDeliberate < CommandTestCase
+    def new_runner(validate)
+      options = {}
+      options[:output_path] = @output_path
+      options[:format] = 'android'
+      options[:validate] = validate
+
+      twine_file = build_twine_file 'en' do
+        add_section 'Section' do
+          add_row key: 'value'
+          add_row key: 'value'
+        end
+      end
+
+      Twine::Runner.new(options, twine_file)
+    end
+
+    def test_does_not_validate_strings_file
+      prepare_mock_formatter Twine::Formatters::Android
+
+      new_runner(false).generate_loc_drop
+    end
+
+    def test_validates_strings_file_if_validate
+      assert_raises Twine::Error do
+        new_runner(true).generate_loc_drop
+      end
+    end
+  end
 end

data/test/test_generate_string_file.rb

@@ -6,10 +6,10 @@ class TestGenerateStringFile < CommandTestCase
     options[:output_path] = File.join(@output_dir, file) if file
     options[:languages] = language if language
 
-    @strings = Twine::StringsFile.new
-    @strings.language_codes.concat KNOWN_LANGUAGES
+    strings = Twine::StringsFile.new
+    strings.language_codes.concat KNOWN_LANGUAGES
 
-    Twine::Runner.new(options, @strings)
+    Twine::Runner.new(options, strings)
   end
 
   def prepare_mock_write_file_formatter(formatter_class)
@@ -48,4 +48,35 @@ class TestGenerateStringFile < CommandTestCase
 
     new_runner(nil, "#{random_language}.xml").generate_string_file
   end
+
+  class TestDeliberate < CommandTestCase
+    def new_runner(validate)
+      options = {}
+      options[:output_path] = @output_path
+      options[:languages] = ['en']
+      options[:format] = 'android'
+      options[:validate] = validate
+
+      twine_file = build_twine_file 'en' do
+        add_section 'Section' do
+          add_row key: 'value'
+          add_row key: 'value'
+        end
+      end
+
+      Twine::Runner.new(options, twine_file)
+    end
+
+    def test_does_not_validate_strings_file
+      prepare_mock_formatter Twine::Formatters::Android
+
+      new_runner(false).generate_string_file
+    end
+
+    def test_validates_strings_file_if_validate
+      assert_raises Twine::Error do
+        new_runner(true).generate_string_file
+      end
+    end
+  end
 end

data/test/test_validate_strings_file.rb

@@ -37,19 +37,25 @@ class TestValidateStringsFile < CommandTestCase
     end
   end
 
-  def test_reports_missing_tags
-    random_row.tags.clear
+  def test_reports_invalid_characters_in_keys
+    random_row.key[0] = "!?;:,^`´'\"\\|/(){}[]~-+*=#$%".chars.to_a.sample
 
     assert_raises Twine::Error do
       Twine::Runner.new(@options, @twine_file).validate_strings_file
     end
   end
 
-  def test_reports_invalid_characters_in_keys
-    random_row.key[0] = "!?;:,^`´'\"\\|/(){}[]~-+*=#$%".chars.to_a.sample
+  def test_does_not_reports_missing_tags_by_default
+    random_row.tags.clear
+
+    Twine::Runner.new(@options, @twine_file).validate_strings_file
+  end
+
+  def test_reports_missing_tags
+    random_row.tags.clear
 
     assert_raises Twine::Error do
-      Twine::Runner.new(@options, @twine_file).validate_strings_file
+      Twine::Runner.new(@options.merge(pedantic: true), @twine_file).validate_strings_file
     end
   end
 end

data/test/twine_test_case.rb

@@ -15,12 +15,17 @@ class TwineTestCase < Minitest::Test
     super
     Twine::stdout = StringIO.new
     Twine::stderr = StringIO.new
+
+    @formatters = Twine::Formatters.formatters.dup
+
     @output_dir = Dir.mktmpdir
     @output_path = File.join @output_dir, SecureRandom.uuid
   end
 
   def teardown
     FileUtils.remove_entry_secure @output_dir if File.exists? @output_dir
+    Twine::Formatters.formatters.clear
+    Twine::Formatters.formatters.concat @formatters
     super
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twine
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Sebastian Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-12 00:00:00.000000000 Z
+date: 2016-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -150,7 +150,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="