zendesk_apps_support 1.6.0 → 1.7.0

data/lib/zendesk_apps_support.rb

@@ -4,6 +4,7 @@ module ZendeskAppsSupport
   require 'zendesk_apps_support/engine'
 
   autoload :AppFile,    'zendesk_apps_support/app_file'
+  autoload :BuildTranslation, 'zendesk_apps_support/build_translation'
   autoload :I18n,       'zendesk_apps_support/i18n'
   autoload :Package,    'zendesk_apps_support/package'
   autoload :AppVersion,    'zendesk_apps_support/app_version'

data/lib/zendesk_apps_support/build_translation.rb

@@ -0,0 +1,58 @@
+module ZendeskAppsSupport
+  module BuildTranslation
+
+    I18N_TITLE_KEY  = 'title'
+    I18N_VALUE_KEY  = 'value'
+    I18N_KEYS       = [ I18N_TITLE_KEY, I18N_VALUE_KEY ]
+
+    def to_flattened_namespaced_hash(hash, prefix = nil)
+
+      hash.inject({}) do |result, (key, value)|
+        key = [ prefix, key ].compact.join('.')
+
+        if value.kind_of?(Hash)
+
+          if is_translation_hash?(value)
+            result[key] = value[I18N_VALUE_KEY]
+          else
+            result.update( to_flattened_namespaced_hash(value, key) )
+          end
+
+        else
+          result[key] = value
+        end
+        result
+      end
+
+    end
+
+    def remove_zendesk_keys(scope, translations = {})
+
+      scope.each_key do |key|
+        context = scope[key]
+
+        if context.is_a?(Hash)
+
+          if is_translation_hash?(context)
+            translations[key] = context[I18N_VALUE_KEY]
+          else
+            translations[key] ||= {}
+            translations[key] = remove_zendesk_keys(context, translations[key])
+          end
+
+        else
+          translations[key] = context
+        end
+      end
+
+      translations
+    end
+
+    private
+
+    def is_translation_hash?(hash)
+      hash.keys.sort == I18N_KEYS
+    end
+
+  end
+end

data/lib/zendesk_apps_support/package.rb

@@ -4,6 +4,7 @@ require 'json'
 
 module ZendeskAppsSupport
   class Package
+    include ZendeskAppsSupport::BuildTranslation
 
     DEFAULT_LAYOUT = Erubis::Eruby.new( File.read(File.expand_path('../assets/default_template.html.erb', __FILE__)) )
     DEFAULT_SCSS   = File.read(File.expand_path('../assets/default_styles.scss', __FILE__))
@@ -40,6 +41,14 @@ module ZendeskAppsSupport
       JSON.parse(File.read(File.join(root, "manifest.json")), :symbolize_names => true)
     end
 
+    def translations
+      JSON.parse(File.read(File.join(root, "translations/en.json")))
+    end
+
+    def app_translations
+      remove_zendesk_keys(translations)
+    end
+
     def readified_js(app_name, app_id, asset_url_prefix, settings={})
       manifest = manifest_json
       source = File.read(File.join(root, "app.js"))
@@ -47,7 +56,6 @@ module ZendeskAppsSupport
       location = manifest[:location]
       app_class_name = "app-#{app_id}"
       author = manifest[:author]
-      translations = JSON.parse(File.read(File.join(root, "translations/en.json")))
       framework_version = manifest[:frameworkVersion]
       templates = manifest[:noTemplate] ? {} : compiled_templates(app_id, asset_url_prefix)
 
@@ -60,7 +68,7 @@ module ZendeskAppsSupport
           :asset_url_prefix => asset_url_prefix,
           :app_class_name => app_class_name,
           :author => author,
-          :translations => translations,
+          :translations => app_translations,
           :framework_version => framework_version,
           :templates => templates,
           :settings => settings,

data/spec/build_translation_spec.rb

@@ -0,0 +1,104 @@
+require 'zendesk_apps_support'
+include ZendeskAppsSupport::BuildTranslation
+
+describe ZendeskAppsSupport::BuildTranslation do
+
+  let(:en_json) {
+    {
+      "app" => {
+        "description" => "Shows related tickets",
+        "title" => "Related tickets",
+        "parameters" => {
+          "disable_tooltip" => {
+            "label" => "Disable tooltip"
+          }
+        }
+      },
+      "parent_without_child" => "Foo",
+      "parent_with_child" => {
+        "child" => "Foo"
+      },
+      "parent_with_child_title" => {
+        "title" => "Foo"
+      },
+      "parent_with_zendesk_tranlation" => {
+        "title" => "Bar",
+        "value" => "Foo"
+      },
+      "parent_with_child_title_nested" => {
+        "title" => {
+          "value" => "Foo"
+        }
+      },
+      "parent_with_nested_invalid_zendesk_translation" => {
+        "title" => {
+          "title" => "Bar",
+          "desc" => "Foo"
+        }
+      },
+      "parent_with_nested_zendesk_translation" => {
+        "title" => {
+          "title" => "Bar",
+          "value" => "Foo"
+        }
+      }
+    }
+  }
+
+  describe '#market_translations' do
+
+    context "flatten translations" do
+
+      before do
+        @market_translations = to_flattened_namespaced_hash(en_json)
+      end
+
+      it "value is correct parent with a child that has an valid nested zendesk translation" do
+        @market_translations['parent_with_nested_zendesk_translation.title'].should eq 'Foo'
+      end
+
+      it "value is correct parent with a child that has an invalid nested zendesk translation" do
+        @market_translations['parent_with_nested_invalid_zendesk_translation.title.title'].should eq 'Bar'
+      end
+
+    end
+
+  end
+
+  describe '#app_translations' do
+
+    context "reformat translations" do
+
+      before do
+        @app_translations = remove_zendesk_keys(en_json)
+      end
+
+      it "value is correct parent without a child" do
+        @app_translations['parent_without_child'].should eq 'Foo'
+      end
+
+      it "value is correct parent with a child" do
+        @app_translations['parent_with_child']['child'].should eq 'Foo'
+      end
+
+      it "value is correct parent with a child with a title" do
+        @app_translations['parent_with_child_title']['title'].should eq 'Foo'
+      end
+
+      it "value is correct parent with a zendesk translation" do
+        @app_translations['parent_with_child_title_nested']['title']['value'].should eq 'Foo'
+      end
+
+      it "value is correct parent with a child that has a nested zendesk translation" do
+        @app_translations['parent_with_nested_zendesk_translation']['title'].should eq 'Foo'
+      end
+
+      it "value is correct parent with a child that has an invalid nested zendesk translation" do
+        @app_translations['parent_with_nested_invalid_zendesk_translation']['title'].should eq({ "title" => "Bar", "desc" => "Foo" })
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_support
 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-18 00:00:00.000000000 Z
+date: 2013-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -154,6 +154,7 @@ files:
 - lib/zendesk_apps_support/assets/default_styles.scss
 - lib/zendesk_apps_support/assets/default_template.html.erb
 - lib/zendesk_apps_support/assets/src.js.erb
+- lib/zendesk_apps_support/build_translation.rb
 - lib/zendesk_apps_support/engine.rb
 - lib/zendesk_apps_support/i18n.rb
 - lib/zendesk_apps_support/package.rb
@@ -179,6 +180,7 @@ files:
 - spec/app/translations/en.json
 - spec/app_file_spec.rb
 - spec/app_version_spec.rb
+- spec/build_translation_spec.rb
 - spec/i18n_spec.rb
 - spec/package_spec.rb
 - spec/validations/jshint_error_spec.rb
@@ -223,6 +225,7 @@ test_files:
 - spec/app/translations/en.json
 - spec/app_file_spec.rb
 - spec/app_version_spec.rb
+- spec/build_translation_spec.rb
 - spec/i18n_spec.rb
 - spec/package_spec.rb
 - spec/validations/jshint_error_spec.rb