phrase 0.3.1 → 0.3.2

data/lib/phrase/tool.rb

@@ -37,4 +37,4 @@ class Phrase::Tool
     end
     command.execute!
   end
-end
+end

data/lib/phrase/tool/commands/base.rb

@@ -70,4 +70,4 @@ module Phrase::Tool::Commands
       self.class.exit_command
     end
   end
-end
+end

data/lib/phrase/tool/commands/init.rb

@@ -6,13 +6,18 @@ class Phrase::Tool::Commands::Init < Phrase::Tool::Commands::Base
   end
   
   def execute!
-    secret = options.get(:secret)
+    secret = get_option(:secret)
     if secret.present?
       config.secret = secret
       print_message "Wrote secret to config file .phrase"
-      default_locale_name = options.get(:default_locale)    
-      create_locale(default_locale_name)
-      make_locale_default(default_locale_name)
+      config.default_locale = get_option(:default_locale)
+      create_locale(config.default_locale)
+      make_locale_default(config.default_locale)
+      config.format = get_option(:format)
+      config.target_directory = get_option(:target_directory)
+      config.domain = get_option(:domain)
+      config.locale_directory = get_option(:locale_directory)
+      config.locale_filename = get_option(:locale_filename)
     else
       print_auth_token_error
       exit_command
@@ -20,6 +25,9 @@ class Phrase::Tool::Commands::Init < Phrase::Tool::Commands::Base
   end
   
 private
+  def get_option(symbol)
+    options.get symbol
+  end
   
   def create_locale(name)
     begin
@@ -44,4 +52,4 @@ private
     print_error "No auth token was given"
     print_error "Please provide the --secret=YOUR_SECRET parameter."
   end
-end
+end

data/lib/phrase/tool/commands/pull.rb

@@ -1,10 +1,8 @@
 # -*- encoding : utf-8 -*-
 
 class Phrase::Tool::Commands::Pull < Phrase::Tool::Commands::Base
-  
   ALLOWED_DOWNLOAD_FORMATS = %w(yml po xml strings json resx ts qph ini plist properties xlf)
   DEFAULT_DOWNLOAD_FORMAT = "yml"
-  DEFAULT_TARGET_FOLDER = "phrase/locales/"
   
   def initialize(options, args)
     super(options, args)
@@ -12,8 +10,10 @@ class Phrase::Tool::Commands::Pull < Phrase::Tool::Commands::Base
     
     @locale = @args[1]
     
-    @format = @options.get(:format) || DEFAULT_DOWNLOAD_FORMAT
-    @target = @options.get(:target) || DEFAULT_TARGET_FOLDER
+    # TODO: remove DEFAULT_DOWNLOAD_FORMAT when phrase app has been updated
+    @format = @options.get(:format) || config.format || DEFAULT_DOWNLOAD_FORMAT
+    @target = @options.get(:target)
+    @target ||= Phrase::Tool::Formats.target_directory(@format) if format_valid?(@format)
   end
   
   def execute!
@@ -25,7 +25,6 @@ class Phrase::Tool::Commands::Pull < Phrase::Tool::Commands::Base
   end
   
 private
-  
   def fetch_translations_for_locale(locale, format)
     begin
       content = api_client.download_translations_for_locale(locale.name, format)
@@ -46,12 +45,16 @@ private
       File.open(target, "w") do |file|
         file.write(content)
       end
-      print_message "Saved to #{target}".green
+      print_message "Saved to #{clean_path target}".green
     rescue
       print_error("Cannot write file to target folder (#{path})")
       exit_command
     end
   end
+
+  def clean_path(str)
+    str.gsub("/./", "/")
+  end
   
   def fetch_locales
     begin
@@ -64,7 +67,7 @@ private
   end
   
   def format_valid?(format)
-    ALLOWED_DOWNLOAD_FORMATS.include?(format)
+    format.nil? or ALLOWED_DOWNLOAD_FORMATS.include?(format)
   end
   
   def base_directory
@@ -96,4 +99,4 @@ private
   def user_specified_a_locale?
     @locale and @locale.strip != ''
   end
-end
+end

data/lib/phrase/tool/commands/push.rb

@@ -1,7 +1,7 @@
 # -*- encoding : utf-8 -*-
 
 class Phrase::Tool::Commands::Push < Phrase::Tool::Commands::Base
-  ALLOWED_FILE_TYPES = %w(yml pot po xml strings json resx ts qph ini plist properties xlf)
+  ALLOWED_FILE_TYPES = %w(yml po pot xml strings json resx ts qph ini plist properties xlf)
   FORMATS_CONTAINING_LOCALE = %q(po yml qph ts xlf)
   RAILS_DEFAULT_FOLDER = "./config/locales/"
   
@@ -77,7 +77,12 @@ private
       begin
         tagged = " (tagged: #{@tags.join(", ")})" if @tags.size > 0
         print_message "Uploading #{file}#{tagged}..."
-        locale = @locale || detect_locale_name_from_file_path(file)
+        unless force_use_of_default_locale?(file)
+          locale = detect_locale_name_from_file_path(file)
+        else
+          locale = Phrase::Tool::Locale.find_default_locale.try(:name)
+        end
+        locale = @locale if @locale
         api_client.upload(file, file_content(file), @tags, locale)
         print_message "OK".green
       rescue Exception => e
@@ -93,6 +98,10 @@ private
     content
   end
   
+  def force_use_of_default_locale?(file_path)
+    not Phrase::Tool::Formats.file_format_exposes_locale?(file_path)
+  end
+  
   def utf16_to_utf8(string)
     string.encode("UTF-8", "UTF-16")
   end

data/lib/phrase/tool/config.rb

@@ -23,7 +23,61 @@ class Phrase::Tool::Config
     config["secret"] = new_secret
     save_config!
   end
+
+  def default_locale
+    config["default_locale"]
+  end
+
+  def default_locale=(new_default_locale)
+    config["default_locale"] = new_default_locale
+    save_config!
+  end
+
+  def domain
+    config["domain"] || 'phrase'
+  end
+
+  def domain=(new_domain)
+    config["domain"] = new_domain
+    save_config!
+  end
+
+  def format
+    config["format"]
+  end
+
+  def format=(new_domain)
+    config["format"] = new_domain
+    save_config!
+  end
   
+  def target_directory
+    config["target_directory"]
+  end
+
+  def target_directory=(new_domain)
+    config["target_directory"] = new_domain
+    save_config!
+  end
+
+  def locale_directory
+    config["locale_directory"]
+  end
+
+  def locale_directory=(new_domain)
+    config["locale_directory"] = new_domain
+    save_config!
+  end
+
+  def locale_filename
+    config["locale_filename"]
+  end
+
+  def locale_filename=(new_domain)
+    config["locale_filename"] = new_domain
+    save_config!
+  end
+
 private  
   def config
     @config ||= {}
@@ -34,4 +88,4 @@ private
       file.write(JSON.pretty_generate(config))
     end
   end
-end
+end

data/lib/phrase/tool/encoding_detector.rb

@@ -6,10 +6,12 @@ class Phrase::Tool::EncodingDetector
   end
   
   def self.file_seems_to_be_utf16_be?(file)
-    IO.read(file, 2).bytes.to_a == [0xFE, 0xFF]
+    input = IO.read(file, 2)
+    input and input.bytes.to_a == [0xFE, 0xFF]
   end
   
   def self.file_seems_to_be_utf16_le?(file)
-    IO.read(file, 2).bytes.to_a == [0xFF, 0xFE]
+    input = IO.read(file, 2)
+    input and input.bytes.to_a == [0xFF, 0xFE]
   end
 end

data/lib/phrase/tool/formats.rb

@@ -4,6 +4,7 @@ module Phrase::Tool::Formats
   autoload :Base, 'phrase/tool/formats/base'
   autoload :Yaml, 'phrase/tool/formats/yaml'
   autoload :Gettext, 'phrase/tool/formats/gettext'
+  autoload :GettextPot, 'phrase/tool/formats/gettext_pot'
   autoload :Xml, 'phrase/tool/formats/xml'
   autoload :Strings, 'phrase/tool/formats/strings'
   autoload :Xliff, 'phrase/tool/formats/xliff'
@@ -14,10 +15,13 @@ module Phrase::Tool::Formats
   autoload :Ini, 'phrase/tool/formats/ini'
   autoload :Properties, 'phrase/tool/formats/properties'
   autoload :Plist, 'phrase/tool/formats/plist'
+  autoload :Custom, 'phrase/tool/formats/custom'
   
   SUPPORTED_FORMATS = {
+    custom: Phrase::Tool::Formats::Custom,
     yml: Phrase::Tool::Formats::Yaml,
     po: Phrase::Tool::Formats::Gettext,
+    pot: Phrase::Tool::Formats::GettextPot,
     xml: Phrase::Tool::Formats::Xml,
     strings: Phrase::Tool::Formats::Strings,
     xlf: Phrase::Tool::Formats::Xliff,
@@ -27,17 +31,42 @@ module Phrase::Tool::Formats
     resx: Phrase::Tool::Formats::Resx,
     ini: Phrase::Tool::Formats::Ini,
     properties: Phrase::Tool::Formats::Properties,
-    plist: Phrase::Tool::Formats::Plist
+    plist: Phrase::Tool::Formats::Plist,
   }
+
+  def self.config
+    @config ||= get_config
+  end
+
+  def self.get_config
+    config = Phrase::Tool::Config.new
+    config.load
+  end
+
+  def self.custom_handler
+    handler_class_for_format(:custom)
+  end
+
+  def self.target_directory(format_name)
+    handler = handler_class_for_format(format_name)
+    custom_handler.target_directory || handler.target_directory
+  end
   
   def self.directory_for_locale_in_format(locale, format_name)
     handler = handler_class_for_format(format_name)
-    handler.directory_for_locale(locale)
+    custom_directory = custom_handler.directory_for_locale(locale, format_name)
+    custom_directory || handler.directory_for_locale(locale)
   end
   
   def self.filename_for_locale_in_format(locale, format_name)
     handler = handler_class_for_format(format_name)
-    handler.filename_for_locale(locale)
+    custom_filename = custom_handler.filename_for_locale(locale, format_name)
+    custom_filename || handler.filename_for_locale(locale)
+  end
+  
+  def self.file_format_exposes_locale?(file_path)
+    format = guess_possible_file_format_from_file_path(file_path)
+    format.nil? ? false : handler_class_for_format(format).locale_aware?
   end
   
   def self.detect_locale_name_from_file_path(file_path)
@@ -55,4 +84,4 @@ module Phrase::Tool::Formats
     return SUPPORTED_FORMATS.has_key?(extension.to_sym) ? extension.to_sym : nil
   end
   private_class_method :guess_possible_file_format_from_file_path
-end
+end

data/lib/phrase/tool/formats/base.rb

@@ -12,4 +12,26 @@ class Phrase::Tool::Formats::Base
   def self.extract_locale_name_from_file_path(file_path)
     nil
   end
-end
+  
+  def self.default_locale_name
+    Phrase::Tool::Locale.find_default_locale.try(:name)
+  end
+  
+  def self.locale_aware?
+    false
+  end
+
+  def self.target_directory
+    "phrase/locales/"
+  end
+  
+  def self.config
+    @config ||= get_config
+  end
+
+  def self.get_config
+    config = Phrase::Tool::Config.new
+    config.load
+  end
+  private_class_method :config
+end

data/lib/phrase/tool/formats/custom.rb

@@ -0,0 +1,38 @@
+class Phrase::Tool::Formats::Custom < Phrase::Tool::Formats::Base
+  def self.directory_for_locale(locale, format)
+    setting = config.locale_directory
+    return unless setting
+    parse(setting, locale, format)
+  end
+
+  def self.filename_for_locale(locale, format)
+    setting = config.locale_filename
+    return unless setting 
+    parse(setting, locale, format)
+  end
+  
+  def self.target_directory
+    config.target_directory
+  end
+
+  def self.parse(str, locale, format)
+    str.gsub(/#{regexp(locale, format)}/) do |match|
+      replacements(locale, format)[match]
+    end
+  end
+  private_class_method :parse
+
+  def self.regexp(locale, format)
+    "(#{replacements(locale, format).keys.join('|')})"
+  end
+
+  def self.replacements(locale, format)
+    {
+      '<domain>' => config.domain,
+      '<format>' => format,
+      '<locale.name>' => locale.name,
+      '<locale.code>' => locale.code,
+      '<locale>' => locale.name
+    }
+  end
+end

data/lib/phrase/tool/formats/gettext.rb

@@ -1,7 +1,19 @@
 # -*- encoding : utf-8 -*-
 
 class Phrase::Tool::Formats::Gettext < Phrase::Tool::Formats::Base
+  def self.directory_for_locale(locale)
+    "./#{locale.name}/"
+  end
+
   def self.filename_for_locale(locale)
-    "phrase.#{locale.name}.po"
+    "#{config.domain}.po"
+  end
+
+  def self.target_directory
+    "locales/"
+  end
+  
+  def self.locale_aware?
+    true
   end
-end
+end

data/lib/phrase/tool/formats/gettext_pot.rb

@@ -0,0 +1,11 @@
+# -*- encoding : utf-8 -*-
+
+class Phrase::Tool::Formats::GettextPot < Phrase::Tool::Formats::Base
+  def self.filename_for_locale(locale)
+    "phrase.pot"
+  end
+
+  def self.locale_aware?
+    false
+  end
+end

data/lib/phrase/tool/formats/ini.rb

@@ -4,4 +4,8 @@ class Phrase::Tool::Formats::Ini < Phrase::Tool::Formats::Base
   def self.filename_for_locale(locale)
     "phrase.#{locale.name}.ini"
   end
+  
+  def self.locale_aware?
+    true
+  end
 end

data/lib/phrase/tool/formats/json.rb

@@ -4,4 +4,8 @@ class Phrase::Tool::Formats::Json < Phrase::Tool::Formats::Base
   def self.filename_for_locale(locale)
     "phrase.#{locale.name}.json"
   end
+  
+  def self.locale_aware?
+    true
+  end
 end

data/lib/phrase/tool/formats/plist.rb

@@ -4,4 +4,8 @@ class Phrase::Tool::Formats::Plist < Phrase::Tool::Formats::Base
   def self.filename_for_locale(locale)
     "phrase.#{locale.name}.plist"
   end
-end
+  
+  def self.locale_aware?
+    true
+  end
+end

data/lib/phrase/tool/formats/properties.rb

@@ -4,4 +4,8 @@ class Phrase::Tool::Formats::Properties < Phrase::Tool::Formats::Base
   def self.filename_for_locale(locale)
     "phrase.#{locale.name}.properties"
   end
+  
+  def self.locale_aware?
+    true
+  end
 end