adhearsion-i18n 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b79e86d823fcae890f17fbaa1aba1944e1b69323
-  data.tar.gz: 0270e6e92f4829b690a8d1a2154605d94c02e711
+  metadata.gz: eb8f300e9d8e250e39920a4c1346f9723771b630
+  data.tar.gz: 4b946892c2dcb82f20b23b7a43116f74dd45dbab
 SHA512:
-  metadata.gz: ad98b93929680aed34ed0c4d36ced32f38f9208df8300262f787cf11c9bb3425939a7d0993ef92d410bdfef7917b25984fadabb81199f8626db13f6319ce05ee
-  data.tar.gz: 004ebe0363f04b5c5284f97f4295f543744bf1537bbaca051c5dd47b8ed1f496d6aad353265982adc8dbeb651115f8b694000ed1ae8ba582f8dd62ee4630bf32
+  metadata.gz: 9822ef3b0f07a72b17703e01077f7abc5772e3993cee90677ab9a001adafe61044796b9dfaad3ec920089f976aef1a80b932e45fe074cf9c19d198b4201df405
+  data.tar.gz: cc84d54b7071ae75b091f2c2a784a7135e6771e1eef275fa804a49dfe11df2912f610f958ba0316f224ee9bc00c5116946d291fe6cc1cb0eda7bcba6e3db721b

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# v0.0.3
+* [FEATURE] Add rake task to validate that all defined audio prompts are found within Adhearsion application
+* [FEATURE] Allow translation lookups to fallback if an adhearsion-i18n structure isn't found
+
+# v0.0.2
+* [FEATURE] Infer audio path from language
+* [FEATURE] Allow setting per-call default language
+* [FEATURE] Ignore missing string translations
+* [FEATURE] Make audio path configurable
+
+# v0.0.1
+* First release: Adhearsion plugin for Internationalization based on Ruby I18n

data/README.md

@@ -33,13 +33,13 @@ en.yml:
 en:
   string1:
     audio: /path/to/string1.wav
-    text: String One
+    text: 'String One'
 
   string2:
-    audio: /path/to/string2.wav
+    audio: '/path/to/string2.wav'
 
   string3:
-    text: String Three
+    text: 'String Three'
 ```
 
 example_controller.rb:
@@ -61,6 +61,60 @@ class ExampleController < Adhearsion::CallController
 end
 ```
 
+## String interpolations
+
+adhearsion-i18n supports string interpolations just as i18n itself does. However there are some guidelines we recommend:
+
+* When you want to craft TTS strings that contain variable data, use SSML instead
+* Use interpolations only for audio files, not for TTS text strings
+
+The reason for this is that it is not practical to assume that you can interpolate text into a recorded audio file. Thus while your app may start with TTS-only today, following this practice will ensure that you can more easily convert to recorded audio in the future.
+
+Example:
+
+Bad:
+
+```Ruby
+play t(:hello, name: 'Ben')
+```
+
+Good:
+
+```Ruby
+play t(:hello), 'Ben'
+```
+
+Further discussion on this issue can be found in [issue #3](https://github.com/adhearsion/adhearsion-i18n/issues/3).
+
+## Verifying audio prompts
+
+adhearsion-i18n adds a rake task to Adhearsion applications that will check to ensure each defined audio file is present in the application.  This assumes that the audio files are kept in the Adhearsion application itself and not hosted externally.
+
+Given a YAML locale file like:
+
+```yaml
+en:
+  hello:
+    audio: hello.wav
+  missing_prompt:
+    audio: missing_prompt.wav
+```
+
+Assuming the default location of `#{Adhearsion.root}/audio`, this example assumes that `hello.wav` is present, but `missing_prompt.wav` is missing.
+
+Then run the rake task to validate the prompts and see output like this:
+
+```Bash
+$ rake i18n:validate_files
+[2014-05-07 16:03:00.792] DEBUG AdhearsionI18n::Plugin: Adding /Users/bklang/myapp/config/locales to the I18n load path
+[2014-05-07 16:03:00.792] INFO  AdhearsionI18n::Plugin: Adhearsion I18n loaded
+
+Adhearsion configured environment: development
+[2014-05-07 16:03:00.833] INFO  Object: [en] Missing audio file: /Users/bklang/myapp/audio/en/missing_prompt.wav
+[2014-05-07 16:03:00.833] ERROR Object: Errors detected! Number of errors by locale:
+[2014-05-07 16:03:00.833] ERROR Object: [en]: 1 missing prompts
+```
+
 ## Credits
 
 Copyright (C) 2014 The Adhearsion Foundation

data/Rakefile

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new :spec
+
+task default: :spec

data/adhearsion-i18n.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency 'activesupport', [">= 3.0.0", "< 5.0.0"]
-  s.add_runtime_dependency 'adhearsion', ["~> 2.0"]
+  s.add_runtime_dependency 'adhearsion', ["~> 2.5"]
   s.add_runtime_dependency 'i18n', ["~> 0.6"]
 
   s.add_development_dependency 'rspec', ["~> 2.11"]

data/lib/adhearsion-i18n/call_controller_methods.rb

@@ -7,6 +7,11 @@ module AdhearsionI18n::CallControllerMethods
     prompt = ::I18n.t "#{key}.audio", options
     text   = ::I18n.t "#{key}.text", options
 
+    if prompt.empty? && text.empty?
+      # Look for a translation key that doesn't follow the Adhearsion-I18n structure
+      text = ::I18n.t key, options
+    end
+
     unless prompt.empty?
       prompt = "#{config['audio_path']}/#{this_locale}/#{prompt}"
     end

data/lib/adhearsion-i18n/plugin.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+require 'yaml'
 
 class AdhearsionI18n::Plugin < Adhearsion::Plugin
   init :i18n do
@@ -20,4 +21,45 @@ class AdhearsionI18n::Plugin < Adhearsion::Plugin
       Base path from which audio files can be found. May be a filesystem path or some other URL (like HTTP)
     __
   end
+
+  tasks do
+    namespace :i18n do
+      desc "Validate configured audio prompt files exist"
+      task :validate_files do
+        config = Adhearsion.config.i18n
+        locale_files = Dir.glob(I18n.load_path)
+
+        locale_errors = {}
+        locale_files.each do |locale_file|
+          # We only support YAML for now
+          next unless locale_file =~ /\.ya?ml$/
+          prompts = YAML.load File.read(locale_file)
+
+          locale = prompts.keys.first
+          prompts = prompts[locale]
+
+          prompts.each_pair do |key, mapping|
+            # Not all prompts will have audio files
+            next unless mapping['audio']
+
+            file = File.absolute_path "#{config['audio_path']}/#{locale}/#{mapping['audio']}"
+            unless File.exist?(file)
+              logger.info "[#{locale}] Missing audio file: #{file}"
+              locale_errors[locale] ||= 0
+              locale_errors[locale] += 1
+            end
+          end
+        end
+
+        if locale_errors.keys.count > 0
+          logger.error "Errors detected! Number of errors by locale:"
+          locale_errors.each_pair do |locale, err_count|
+            logger.error "[#{locale}]: #{err_count} missing prompts"
+          end
+        else
+          logger.info "All configured prompt files successfully validated."
+        end
+      end
+    end
+  end
 end

data/lib/adhearsion-i18n/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 class AdhearsionI18n
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/call_controller_methods_spec.rb

@@ -80,5 +80,12 @@ describe AdhearsionI18n::CallControllerMethods do
         end
       end
     end
+
+    it 'should fall back to a text translation if the locale structure does not break out audio vs. tts' do
+      ssml = controller.t :seventeen, locale: 'it'
+      ssml.should == RubySpeech::SSML.draw(language: 'it') do
+        string 'diciassette'
+      end
+    end
   end
 end

data/spec/fixtures/locale/en.yml

@@ -8,3 +8,6 @@ en:
 
   many_people_out_today:
     text: There are many people out today
+
+  # Simulating an external, non adhearsion-i18n translation:
+  seventeen: seventeen

data/spec/fixtures/locale/it.yml

@@ -8,3 +8,6 @@ it:
 
   many_people_out_today:
     text: Ci sono molti persone fuori oggi
+
+  # Simulating an external, non adhearsion-i18n translation:
+  seventeen: diciassette

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adhearsion-i18n
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ben Klang
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-24 00:00:00.000000000 Z
+date: 2014-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -37,14 +37,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -81,9 +81,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
+- Rakefile
 - adhearsion-i18n.gemspec
 - lib/adhearsion-i18n.rb
 - lib/adhearsion-i18n/call_controller_methods.rb
@@ -113,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Internationalization helpers for Adhearsion applications