zendesk_apps_support 1.7.0 → 1.7.1

data/config/locales/en.yml

@@ -36,6 +36,7 @@ en:
             duplicate_parameters: ! 'Duplicate app parameters defined: %{duplicate_parameters}'
             translation:
               invalid_locale: ! '%{file} is not a valid locale.'
+              invalid_format: ! '%{field} is invalid for translation.'
               not_json: ! '%{file} is not valid JSON. %{errors}'
               not_json_object: ! '%{file} is not a JSON object.'
             stylesheet_error: ! 'Sass error: %{sass_error}'

data/config/locales/translations/zendesk_apps_support.yml

@@ -91,6 +91,10 @@ parts:
       key: "txt.apps.admin.error.app_build.translation.invalid_locale"
       title: "App builder job: invalid locale file name"
       value: "%{file} is not a valid locale."
+  - translation:
+      key: "txt.apps.admin.error.app_build.translation.invalid_format"
+      title: "App builder job: file format is invalid for translation"
+      value: "%{field} is invalid for translation."
   - translation:
       key: "txt.apps.admin.error.app_build.translation.not_json"
       title: "App builder job: translation file is invalid json"

data/lib/zendesk_apps_support/build_translation.rb

@@ -1,29 +1,24 @@
 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)
+    I18N_TITLE_KEY = 'title'
+    I18N_VALUE_KEY = 'value'
+    I18N_KEYS      = [I18N_TITLE_KEY, I18N_VALUE_KEY]
 
+    def to_flattened_namespaced_hash(hash, target_key = nil, prefix = nil)
       hash.inject({}) do |result, (key, value)|
-        key = [ prefix, key ].compact.join('.')
-
+        key = [prefix, key].compact.join('.')
         if value.kind_of?(Hash)
-
-          if is_translation_hash?(value)
-            result[key] = value[I18N_VALUE_KEY]
+          if target_key && is_translation_hash?(value)
+            result[key] = value[target_key]
           else
-            result.update( to_flattened_namespaced_hash(value, key) )
+            result.update(to_flattened_namespaced_hash(value, target_key, key))
           end
-
         else
           result[key] = value
         end
         result
       end
-
     end
 
     def remove_zendesk_keys(scope, translations = {})

data/lib/zendesk_apps_support/validations/translations.rb

@@ -4,7 +4,10 @@ module ZendeskAppsSupport
   module Validations
     module Translations
       TRANSLATIONS_PATH = %r{^translations/(.*)\.json$}
-      VALID_LOCALE = /^[a-z]{2}(-\w{2,3})?$/
+      VALID_LOCALE      = /^[a-z]{2}(-\w{2,3})?$/
+
+      class TranslationFormatError < StandardError
+      end
 
       class << self
         def call(package)
@@ -25,12 +28,36 @@ module ZendeskAppsSupport
 
         def json_error(file)
           json = MultiJson.load(file.read)
-          return nil if json.kind_of?(Hash)
-          ValidationError.new('translation.not_json_object', :file => file.relative_path)
+          if json.kind_of?(Hash)
+            if json["app"] && json["app"]["package"]
+              json["app"].delete("package")
+              begin
+                validate_translation_format(json)
+                return
+              rescue TranslationFormatError => e
+                ValidationError.new('translation.invalid_format', :field => e.message)
+              end
+            end
+          else
+            ValidationError.new('translation.not_json_object', :file => file.relative_path)
+          end
         rescue MultiJson::DecodeError => e
           ValidationError.new('translation.not_json', :file => file.relative_path, :errors => e)
         end
 
+        def validate_translation_format(json)
+          json.keys.each do |key|
+            raise TranslationFormatError.new("'#{key}': '#{json[key]}'") unless json[key].kind_of? Hash
+
+            if json[key].keys.sort == BuildTranslation::I18N_KEYS &&
+              json[key][BuildTranslation::I18N_TITLE_KEY].class == String &&
+              json[key][BuildTranslation::I18N_VALUE_KEY].class == String
+              next
+            else
+              validate_translation_format(json[key])
+            end
+          end
+        end
       end
     end
   end

data/spec/build_translation_spec.rb

@@ -6,99 +6,85 @@ describe ZendeskAppsSupport::BuildTranslation do
   let(:en_json) {
     {
       "app" => {
-        "description" => "Shows related tickets",
-        "title" => "Related tickets",
-        "parameters" => {
-          "disable_tooltip" => {
-            "label" => "Disable tooltip"
-          }
+        "abc" => {
+          "title" => "description for abc field",
+          "value" => "value of abc"
         }
       },
-      "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"
+      "a"   => {
+        "a1" => {
+          "title" => "description for a1 field",
+          "value" => "value of a1"
+        },
+        "b"  => {
+          "b1" => {
+            "title" => "description for b1 field",
+            "value" => "value of b1"
+          }
         }
       }
     }
   }
 
-  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
+  describe '#to_flattened_namespaced_hash' do
+
+    context "not zendesk i18n format" do
+      it "should flatten hash without removing zendesk keys" do
+        expected = {
+          "app.abc.title" => "description for abc field",
+          "app.abc.value" => "value of abc",
+          "a.a1.title"    => "description for a1 field",
+          "a.a1.value"    => "value of a1",
+          "a.b.b1.title"  => "description for b1 field",
+          "a.b.b1.value"  => "value of b1"
+        }
 
-      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'
+        to_flattened_namespaced_hash(en_json).should == expected
       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
+    context 'zendesk i18n format' do
+      context 'flatten value keys' do
+        it "should flatten hash by removing zendesk title keys" do
+          expected = {
+            "app.abc" => "value of abc",
+            "a.a1"    => "value of a1",
+            "a.b.b1"  => "value of b1"
+          }
 
-      it "value is correct parent with a zendesk translation" do
-        @app_translations['parent_with_child_title_nested']['title']['value'].should eq 'Foo'
+          to_flattened_namespaced_hash(en_json, I18N_VALUE_KEY).should == expected
+        end
       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
+      context 'flatten title keys' do
+        it "should flatten hash by removing zendesk value keys" do
+          expected = {
+            "app.abc" => "description for abc field",
+            "a.a1"    => "description for a1 field",
+            "a.b.b1"  => "description for b1 field"
+          }
 
-      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" })
+          to_flattened_namespaced_hash(en_json, I18N_TITLE_KEY).should == expected
+        end
       end
-
     end
 
   end
 
+  describe '#remove_zendesk_keys' do
+    it "should remove zendesk translation keys" do
+      expected = {
+        "app" => {
+          "abc" => "value of abc"
+        },
+        "a"   => {
+          "a1" => "value of a1",
+          "b"  => {
+            "b1" => "value of b1"
+          }
+        }
+      }
+      remove_zendesk_keys(en_json).should == expected
+    end
+  end
 end

data/spec/i18n_spec.rb

@@ -16,7 +16,7 @@ describe 'translations' do
     project_root = Pathname.new(File.expand_path('../../', __FILE__))
     zendesk_version  = project_root.join('config/locales/translations/zendesk_apps_support.yml')
     standard_version = project_root.join('config/locales/en.yml')
-    File.mtime(zendesk_version).should be <= File.mtime(standard_version)
+    File.mtime(zendesk_version).to_i.should be <= File.mtime(standard_version).to_i
   end
 
 end

data/spec/validations/fixture/invalid_en.json

@@ -0,0 +1,20 @@
+{
+  "app": {
+    "package" : "my_app",
+    "abc" : {
+      "title" : "description for abc field",
+      "value" : "value of abc"
+    }
+  },
+  "a": {
+    "a1": {
+      "title": "description for a1 field",
+      "value": "value of a1"
+    },
+    "b": {
+      "b1": {
+        "value": "value of b1"
+      }
+    }
+  }
+}

data/spec/validations/fixture/valid_en.json

@@ -0,0 +1,21 @@
+{
+  "app": {
+    "package" : "my_app",
+    "abc" : {
+      "title" : "description for abc field",
+      "value" : "value of abc"
+    }
+  },
+  "a": {
+    "a1": {
+      "title": "description for a1 field",
+      "value": "value of a1"
+    },
+    "b": {
+      "b1": {
+        "title": "description for b1 field",
+        "value": "value of b1"
+      }
+    }
+  }
+}

data/spec/validations/translations_spec.rb

@@ -1,6 +1,10 @@
 require 'zendesk_apps_support'
 require 'json'
 
+def read_fixture_file(file)
+  File.read("#{File.dirname(__FILE__)}/fixture/#{file}")
+end
+
 describe ZendeskAppsSupport::Validations::Translations do
 
   let(:package) { mock('Package', :files => translation_files) }
@@ -15,7 +19,7 @@ describe ZendeskAppsSupport::Validations::Translations do
 
   context 'when there is file with invalid JSON' do
     let(:translation_files) do
-      [ mock('AppFile', :relative_path => 'translations/en.json', :read => '}') ]
+      [mock('AppFile', :relative_path => 'translations/en.json', :read => '}')]
     end
 
     it 'should report the error' do
@@ -26,7 +30,7 @@ describe ZendeskAppsSupport::Validations::Translations do
 
   context 'when there is file with JSON representing a non-Object' do
     let(:translation_files) do
-      [ mock('AppFile', :relative_path => 'translations/en.json', :read => '"foo bar"') ]
+      [mock('AppFile', :relative_path => 'translations/en.json', :read => '"foo bar"')]
     end
 
     it 'should report the error' do
@@ -37,7 +41,7 @@ describe ZendeskAppsSupport::Validations::Translations do
 
   context 'when there is a file with an invalid locale for a name' do
     let(:translation_files) do
-      [ mock('AppFile', :relative_path => 'translations/en-US-1.json', :read => '{}') ]
+      [mock('AppFile', :relative_path => 'translations/en-US-1.json', :read => '{}')]
     end
 
     it 'should report the error' do
@@ -48,11 +52,34 @@ describe ZendeskAppsSupport::Validations::Translations do
 
   context 'when there is a file with a valid locale containing valid JSON' do
     let(:translation_files) do
-      [ mock('AppFile', :relative_path => 'translations/en-US.json', :read => '{}') ]
+      [mock('AppFile', :relative_path => 'translations/en-US.json', :read => '{}')]
     end
 
     it 'should be valid' do
       subject.length.should == 0
     end
   end
-end
+
+  context 'validate translation format when "package" is defined inside "app"' do
+    context 'all the leaf nodes have defined "title" and "value"' do
+      let(:translation_files) do
+        [mock('AppFile', :relative_path => 'translations/en-US.json', :read => read_fixture_file("valid_en.json"))]
+      end
+
+      it 'should be valid' do
+        subject.length.should == 0
+      end
+    end
+
+    context 'when the "title" field is not defined on one leaf node' do
+      let(:translation_files) do
+        [mock('AppFile', :relative_path => 'translations/en-US.json', :read => read_fixture_file("invalid_en.json"))]
+      end
+
+      it 'should be invalid' do
+        subject.length.should == 1
+        subject[0].to_s.should =~ /is invalid for translation/
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_support
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.7.1
   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-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -67,17 +67,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: erubis
   requirement: !ruby/object:Gem::Requirement
@@ -183,6 +183,8 @@ files:
 - spec/build_translation_spec.rb
 - spec/i18n_spec.rb
 - spec/package_spec.rb
+- spec/validations/fixture/invalid_en.json
+- spec/validations/fixture/valid_en.json
 - spec/validations/jshint_error_spec.rb
 - spec/validations/manifest_spec.rb
 - spec/validations/source_spec.rb
@@ -228,6 +230,8 @@ test_files:
 - spec/build_translation_spec.rb
 - spec/i18n_spec.rb
 - spec/package_spec.rb
+- spec/validations/fixture/invalid_en.json
+- spec/validations/fixture/valid_en.json
 - spec/validations/jshint_error_spec.rb
 - spec/validations/manifest_spec.rb
 - spec/validations/source_spec.rb