zendesk_apps_tools 1.6.0 → 1.7.0

data/lib/zendesk_apps_tools/translate.rb

@@ -2,35 +2,58 @@ require 'thor'
 require 'json'
 require 'zendesk_apps_tools/common'
 require 'zendesk_apps_tools/locale_identifier'
+require 'zendesk_apps_support'
+require 'yaml'
 
 module ZendeskAppsTools
   class Translate < Thor
     include Thor::Shell
     include Thor::Actions
     include ZendeskAppsTools::Common
+    include ZendeskAppsSupport::BuildTranslation
 
-    CHARACTERS_TO_ESCAPE = %w[ " ]
     LOCALE_ENDPOINT = "https://support.zendesk.com/api/v2/locales/agent.json"
 
-    desc 'create', 'Create Zendesk translation file from en.json'
-    def create
-      manifest = JSON.parse(File.open('manifest.json').read)
+    desc 'to_yml', 'Create Zendesk translation file from en.json'
+    method_option :path, :default => './', :required => false
+    def to_yml
+      setup_path(options[:path]) if options[:path]
+      manifest = JSON.parse(File.open("#{destination_root}/manifest.json").read)
       app_name = manifest['name']
 
       unless app_name
         app_name = get_value_from_stdin('What is the name of this app?', :error_msg => "Invalid name, try again:")
       end
 
-      package = get_value_from_stdin('What is the package name for this app?', :valid_regex => /^[a-z_]+$/, :error_msg => "Invalid package name, try again:")
+      en_json = JSON.parse(File.open("#{destination_root}/translations/en.json").read)
 
-      write_yaml(app_name, package)
+      package = en_json["app"]["package"]
+      say('No package defined inside en.json! Abort.', :red) and exit 1 unless package
+      en_json["app"].delete("package")
+
+      write_yml(en_json, app_name, package)
+    end
+
+    desc 'to_json', 'Convert Zendesk translation yml to I18n formatted json'
+    method_option :path, :default => './', :required => false
+    def to_json
+      setup_path(options[:path]) if options[:path]
+      en_yml = YAML.load_file("#{destination_root}/translations/en.yml")
+      en_yml['parts'][0]['translation']['key'] =~ /^txt.apps.([^\.]+)/
+      package = $1
+      translations = en_yml['parts'].map { |part| part['translation'] }
+      en_json = array_to_nested_hash(translations)['txt']['apps'][package]
+      en_json['app']['package'] = package
+
+      write_json("translations/en.json", en_json)
     end
 
     desc 'update', 'Update translation files from Zendesk'
+    method_option :path, :default => './', :required => false
     def update(request_builder = Faraday.new)
+      setup_path(options[:path]) if options[:path]
       app_package = get_value_from_stdin("What is the package name for this app? (without app_)", :valid_regex => /^[a-z_]+$/, :error_msg => "Invalid package name, try again:")
 
-      user = "#{user}/token"
       key_prefix = "txt.apps.#{app_package}."
 
       say("Fetching translations...")
@@ -40,12 +63,12 @@ module ZendeskAppsTools
         locales = JSON.parse(locale_response.body)["locales"]
 
         locales.each do |locale|
-          locale_url = "#{locale["url"]}?include=translations&packages=app_#{app_package}"
+          locale_url      = "#{locale["url"]}?include=translations&packages=app_#{app_package}"
           locale_response = api_request(locale_url, request_builder).body
-          translations = JSON.parse(locale_response)['locale']['translations']
+          translations    = JSON.parse(locale_response)['locale']['translations']
 
           locale_name = ZendeskAppsTools::LocaleIdentifier.new(locale['locale']).language_id
-          write_json(locale_name, nest_translations_hash(translations, key_prefix))
+          write_json("#{destination_root}/translations/#{locale_name}.json", nest_translations_hash(translations, key_prefix))
         end
         say("Translations updated", :green)
 
@@ -60,17 +83,21 @@ module ZendeskAppsTools
 
     no_commands do
 
-      def write_json(locale_name, translations_hash)
-        create_file("translations/#{locale_name}.json", JSON.pretty_generate(translations_hash))
+      def setup_path(path)
+        @destination_stack << relative_to_original_destination_root(path) unless @destination_stack.last == path
+      end
+
+      def write_json(filename, translations_hash)
+        create_file(filename, JSON.pretty_generate(translations_hash))
       end
 
       def nest_translations_hash(translations_hash, key_prefix)
         result = {}
 
         translations_hash.each do |full_key, value|
-          parts = full_key.gsub(key_prefix, '').split('.')
+          parts       = full_key.gsub(key_prefix, '').split('.')
           parts_count = parts.size - 1
-          context = result
+          context     = result
 
           parts.each_with_index do |part, i|
 
@@ -86,52 +113,30 @@ module ZendeskAppsTools
         result
       end
 
-      def write_yaml(app_name, package)
-        user_translations = JSON.parse(File.open('translations/en.json').read)
-        translations = user_translations.keys.inject({}) do |translations, key|
-          translations.merge( get_translations_for(user_translations, key) )
-        end
-        @escaped_translations = escape_values(translations)
-
-        @app_name = app_name
-        @package_name = package
+      def write_yml(en_json, app_name, package_name)
+        titles        = to_flattened_namespaced_hash(en_json, I18N_TITLE_KEY)
+        values        = to_flattened_namespaced_hash(en_json, I18N_VALUE_KEY)
+        @translations = titles.each { |k, v| titles[k] = {"title" => v, "value" => escape_special_characters(values[k]) }}
+        @app_name     = app_name
+        @package_name = package_name
         template(File.join(Translate.source_root, 'templates/translation.erb.tt'), "translations/en.yml")
       end
 
-      def escape_values(translations)
-        result = {}
-        translations.each do |key, value|
-          CHARACTERS_TO_ESCAPE.each do |char|
-            result[key] = value.gsub(char, "\\#{char}")
-          end
-        end
-
-        result
+      def escape_special_characters(v)
+        v.gsub('"', '\"')
       end
 
-      def get_translations_for(scope, scope_key, keys = [], translations = {})
-        hash_or_value = scope[scope_key]
-
-        if hash_or_value.is_a?(Hash)
-          keys << scope_key
-          hash_or_value.each_key do |key|
-
-            if hash_or_value[key].is_a?(Hash)
-              get_translations_for(hash_or_value, key, keys, translations)
-              keys = keys[0...-1]
-            else
-              translation_key = (keys + [key]).join('.')
-              translations[translation_key] = hash_or_value[key]
-            end
-
+      def array_to_nested_hash(array)
+        array.inject({}) do |result, item|
+          keys = item['key'].split('.')
+          current = result
+          keys[0..-2].each do |key|
+            current = (current[key] ||= {})
           end
-        else
-          translations[scope_key] = hash_or_value
+          current[keys[-1]] = {'title' => item['title'], 'value' => item['value']}
+          result
         end
-
-        translations
       end
-
     end
   end
 end

data/templates/translation.erb.tt

@@ -5,9 +5,9 @@ packages:
   - app_<%= @package_name %>
 
 parts:
-<% @escaped_translations.each do |key, value| -%>
+<% @translations.each do |key, title_value| -%>
   - translation:
       key: "txt.apps.<%= @package_name %>.<%= key %>"
-      title: ""
-      value: "<%= value %>"
-<% end %>
+      title: "<%= title_value["title"] %>"
+      value: "<%= title_value["value"] %>"
+<% end %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_tools
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-28 00:00:00.000000000 Z
+date: 2013-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -85,7 +85,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -93,7 +93,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.7.1
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -191,7 +191,6 @@ files:
 - features/package.feature
 - features/step_definitions/app_steps.rb
 - features/support/env.rb
-- features/translate.feature
 - features/validate.feature
 homepage: http://github.com/zendesk/zendesk_apps_tools
 licenses:
@@ -225,5 +224,4 @@ test_files:
 - features/package.feature
 - features/step_definitions/app_steps.rb
 - features/support/env.rb
-- features/translate.feature
 - features/validate.feature

data/features/translate.feature

@@ -1,36 +0,0 @@
-Feature: Translate app strings
-  As a Zendesk admin
-  To enable many languages
-  I want to be able to map between json and yaml
-
-  Scenario: Attempt to generate invalid package name
-    Given an app is created in directory "tmp/aruba"
-    When I run "cd tmp/aruba && zat translate create" command with the following details:
-      | package name | This is wrong |
-    Then the command output should contain "Invalid package name, try again:"
-
-  Scenario: Generate template yaml from en.json
-    Given an app is created in directory "tmp/aruba"
-    And the fixture "quote_character_translation.json" is used for "translations/en.json"
-    When I run "cd tmp/aruba && zat translate create" command with the following details:
-      | package name | test_package |
-    Then the app file "tmp/aruba/translations/en.yml" is created with:
-    """
-    ---
-    title: "John Test App"
-    packages:
-      - default
-      - app_test_package
-
-    parts:
-      - translation:
-        key: "txt.apps.test_package.app.description"
-        title: ""
-        value: "Play the famous zen tunes in your help desk."
-      - translation:
-        key: "txt.apps.test_package.app.name"
-        title: ""
-        value: "Buddha \"Machine\""
-
-    """
-