ruby_speech 0.1.4 → 0.1.5

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 0.1.5
+  Feature: Now added support for SSML <audio/>
+
 # 0.1.4
   Bugfix: Speak#+ now returns a brand new Speak rather than modifying the original object
   Bugfix: Speak#+ now re-sets the namespace on child elements to ensure no default namespace prefix is added

data/README.md

@@ -54,6 +54,7 @@ Check out the [YARD documentation](http://rdoc.info/github/benlangfeld/ruby_spee
 * `<emphasis/>`
 * `<say-as/>`
 * `<break/>`
+* `<audio/>`
 
 ## TODO:
 ### SSML
@@ -65,7 +66,6 @@ Check out the [YARD documentation](http://rdoc.info/github/benlangfeld/ruby_spee
 * `<meta/>` and `<metadata/>`
 
 #### Misc
-* `<audio/>`
 * `<mark/>`
 * `<desc/>`
 

data/lib/ruby_speech/ssml/audio.rb

@@ -0,0 +1,56 @@
+module RubySpeech
+  module SSML
+    ##
+    # The audio element supports the insertion of recorded audio files (see Appendix A for required formats) and the insertion of other audio formats in conjunction with synthesized speech output. The audio element may be empty. If the audio element is not empty then the contents should be the marked-up text to be spoken if the audio document is not available. The alternate content may include text, speech markup, desc elements, or other audio elements. The alternate content may also be used when rendering the document to non-audible output and for accessibility (see the desc element). The required attribute is src, which is the URI of a document with an appropriate MIME type.
+    #
+    # An audio element is successfully rendered:
+    #   * If the referenced audio source is played, or
+    #   * If the synthesis processor is unable to execute #1 but the alternative content is successfully rendered, or
+    #   * If the processor can detect that text-only output is required and the alternative content is successfully rendered.
+    #
+    # Deciding which conditions result in the alternative content being rendered is processor-dependent. If the audio element is not successfully rendered, a synthesis processor should continue processing and should notify the hosting environment. The processor may determine after beginning playback of an audio source that the audio cannot be played in its entirety. For example, encoding problems, network disruptions, etc. may occur. The processor may designate this either as successful or unsuccessful rendering, but it must document this behavior.
+    #
+    # http://www.w3.org/TR/speech-synthesis/#S3.3.1
+    #
+    class Audio < Element
+
+      VALID_CHILD_TYPES = [String, Audio, Break, Emphasis, Prosody, SayAs, Voice].freeze
+
+      ##
+      # Create a new SSML audio element
+      #
+      # @param [Hash] atts Key-value pairs of options mapping to setter methods
+      #
+      # @return [Break] an element for use in an SSML document
+      #
+      def self.new(atts = {}, &block)
+        super 'audio', atts, &block
+      end
+
+      ##
+      # The URI of a document with an appropriate MIME type
+      #
+      # @return [String]
+      #
+      def src
+        read_attr :src
+      end
+
+      ##
+      # @param [String] the source. Must be a valid URI
+      #
+      def src=(s)
+        write_attr :src, s
+      end
+
+      def <<(arg)
+        raise InvalidChildError, "An Audio can only accept String, Audio, Break, Emphasis, Mark, P, Phoneme, Prosody, SayAs, Sub, S, Voice as children" unless VALID_CHILD_TYPES.include? arg.class
+        super
+      end
+
+      def eql?(o)
+        super o, :src
+      end
+    end # Audio
+  end # SSML
+end # RubySpeech

data/lib/ruby_speech/ssml/emphasis.rb

@@ -8,7 +8,7 @@ module RubySpeech
     class Emphasis < Element
 
       VALID_LEVELS = [:strong, :moderate, :none, :reduced].freeze
-      VALID_CHILD_TYPES = [String, Break, Emphasis, Prosody, SayAs, Voice].freeze
+      VALID_CHILD_TYPES = [String, Audio, Break, Emphasis, Prosody, SayAs, Voice].freeze
 
       ##
       # Create a new SSML emphasis element

data/lib/ruby_speech/ssml/prosody.rb

@@ -16,7 +16,7 @@ module RubySpeech
       VALID_PITCHES     = [:'x-low', :low, :medium, :high, :'x-high', :default].freeze
       VALID_VOLUMES     = [:silent, :'x-soft', :soft, :medium, :loud, :'x-loud', :default].freeze
       VALID_RATES       = [:'x-slow', :slow, :medium, :fast, :'x-fast', :default].freeze
-      VALID_CHILD_TYPES = [String, Break, Emphasis, Prosody, SayAs, Voice].freeze
+      VALID_CHILD_TYPES = [String, Audio, Break, Emphasis, Prosody, SayAs, Voice].freeze
 
       ##
       # Create a new SSML prosody element

data/lib/ruby_speech/ssml/speak.rb

@@ -8,7 +8,7 @@ module RubySpeech
     class Speak < Element
       include XML::Language
 
-      VALID_CHILD_TYPES = [String, Break, Emphasis, Prosody, SayAs, Voice].freeze
+      VALID_CHILD_TYPES = [String, Audio, Break, Emphasis, Prosody, SayAs, Voice].freeze
 
       ##
       # Create a new SSML speak root element

data/lib/ruby_speech/ssml/voice.rb

@@ -9,7 +9,7 @@ module RubySpeech
       include XML::Language
 
       VALID_GENDERS = [:male, :female, :neutral].freeze
-      VALID_CHILD_TYPES = [String, Break, Emphasis, Prosody, SayAs, Voice].freeze
+      VALID_CHILD_TYPES = [String, Audio,Break, Emphasis, Prosody, SayAs, Voice].freeze
 
       ##
       # Create a new SSML voice element

data/lib/ruby_speech/ssml.rb

@@ -2,6 +2,7 @@ module RubySpeech
   module SSML
     extend ActiveSupport::Autoload
 
+    autoload :Audio
     autoload :Break
     autoload :Element
     autoload :Emphasis

data/lib/ruby_speech/version.rb

@@ -1,3 +1,3 @@
 module RubySpeech
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/spec/ruby_speech/ssml/audio_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+module RubySpeech
+  module SSML
+    describe Audio do
+      its(:name) { should == 'audio' }
+
+      describe "setting options in initializers" do
+        subject { Audio.new :src => 'http://whatever.you-say-boss.com', :content => 'Hello' }
+
+        its(:src)     { should == 'http://whatever.you-say-boss.com' }
+        its(:content) { should == 'Hello' }
+      end
+
+      describe "#src" do
+        before { subject.src = 'http://whatever.you-say-boss.com' }
+
+        its(:src) { should == 'http://whatever.you-say-boss.com' }
+      end
+
+      describe "#content" do
+        context "with a valid value" do
+          before { subject.content = "Hello" }
+
+          its(:content) { should == "Hello" }
+        end
+      end
+
+      describe "<<" do
+        it "should accept String" do
+          lambda { subject << 'anything' }.should_not raise_error
+        end
+
+        it "should accept Audio" do
+          lambda { subject << Audio.new }.should_not raise_error
+        end
+
+        it "should accept Break" do
+          lambda { subject << Break.new }.should_not raise_error
+        end
+
+        it "should accept Emphasis" do
+          lambda { subject << Emphasis.new }.should_not raise_error
+        end
+
+        it "should accept Mark" do
+          pending
+          lambda { subject << Mark.new }.should_not raise_error
+        end
+
+        it "should accept P" do
+          pending
+          lambda { subject << P.new }.should_not raise_error
+        end
+
+        it "should accept Phoneme" do
+          pending
+          lambda { subject << Phoneme.new }.should_not raise_error
+        end
+
+        it "should accept Prosody" do
+          lambda { subject << Prosody.new }.should_not raise_error
+        end
+
+        it "should accept SayAs" do
+          lambda { subject << SayAs.new(:interpret_as => :foo) }.should_not raise_error
+        end
+
+        it "should accept Sub" do
+          pending
+          lambda { subject << Sub.new }.should_not raise_error
+        end
+
+        it "should accept S" do
+          pending
+          lambda { subject << S.new }.should_not raise_error
+        end
+
+        it "should accept Voice" do
+          lambda { subject << Voice.new }.should_not raise_error
+        end
+
+        it "should raise InvalidChildError with non-acceptable objects" do
+          lambda { subject << 1 }.should raise_error(InvalidChildError, "An Audio can only accept String, Audio, Break, Emphasis, Mark, P, Phoneme, Prosody, SayAs, Sub, S, Voice as children")
+        end
+      end
+
+      describe "comparing objects" do
+        it "should be equal if the content, and src are the same" do
+          Audio.new(:src => "one", :content => "Hello there").should == Audio.new(:src => "one", :content => "Hello there")
+        end
+
+        describe "when the content is different" do
+          it "should not be equal" do
+            Audio.new(:content => "Hello").should_not == Audio.new(:content => "Hello there")
+          end
+        end
+
+        describe "when the src is different" do
+          it "should not be equal" do
+            Audio.new(:src => 'one').should_not == Audio.new(:src => 'two')
+          end
+        end
+      end
+    end # Break
+  end # SSML
+end # RubySpeech

data/spec/ruby_speech/ssml/emphasis_spec.rb

@@ -52,7 +52,6 @@ module RubySpeech
         end
 
         it "should accept Audio" do
-          pending
           lambda { subject << Audio.new }.should_not raise_error
         end
 

data/spec/ruby_speech/ssml/prosody_spec.rb

@@ -238,7 +238,6 @@ module RubySpeech
         end
 
         it "should accept Audio" do
-          pending
           lambda { subject << Audio.new }.should_not raise_error
         end
 

data/spec/ruby_speech/ssml/speak_spec.rb

@@ -65,7 +65,6 @@ module RubySpeech
         end
 
         it "should accept Audio" do
-          pending
           lambda { subject << Audio.new }.should_not raise_error
         end
 

data/spec/ruby_speech/ssml/voice_spec.rb

@@ -130,7 +130,6 @@ module RubySpeech
         end
 
         it "should accept Audio" do
-          pending
           lambda { subject << Audio.new }.should_not raise_error
         end
 

data/spec/ruby_speech/ssml_spec.rb

@@ -72,9 +72,19 @@ module RubySpeech
         doc = RubySpeech::SSML.draw do
           string "Hello world."
           ssml_break
+          audio :src => "hello" do
+            string "HELLO?"
+            ssml_break
+            audio :src => "hello"
+            emphasis
+            prosody
+            say_as 'date'
+            voice
+          end
           emphasis do
             string "HELLO?"
             ssml_break
+            audio :src => "hello"
             emphasis
             prosody
             say_as 'date'
@@ -83,6 +93,7 @@ module RubySpeech
           prosody :rate => :slow do
             string "H...E...L...L...O?"
             ssml_break
+            audio :src => "hello"
             emphasis
             prosody
             say_as 'date'
@@ -97,6 +108,7 @@ module RubySpeech
               "01/02/1960"
             end
             ssml_break
+            audio :src => "hello"
             emphasis do
               "I'm so old"
             end
@@ -110,8 +122,17 @@ module RubySpeech
         end
         expected_doc = SSML::Speak.new(:content => "Hello world.")
         expected_doc << SSML::Break.new
+        audio = SSML::Audio.new(:src => "hello", :content => "HELLO?")
+        audio << SSML::Break.new
+        audio << SSML::Audio.new(:src => "hello")
+        audio << SSML::Emphasis.new
+        audio << SSML::Prosody.new
+        audio << SSML::SayAs.new('date')
+        audio << SSML::Voice.new
+        expected_doc << audio
         emphasis = SSML::Emphasis.new(:content => "HELLO?")
         emphasis << SSML::Break.new
+        emphasis << SSML::Audio.new(:src => "hello")
         emphasis << SSML::Emphasis.new
         emphasis << SSML::Prosody.new
         emphasis << SSML::SayAs.new('date')
@@ -119,6 +140,7 @@ module RubySpeech
         expected_doc << emphasis
         prosody = SSML::Prosody.new(:rate => :slow, :content => "H...E...L...L...O?")
         prosody << SSML::Break.new
+        prosody << SSML::Audio.new(:src => "hello")
         prosody << SSML::Emphasis.new
         prosody << SSML::Prosody.new
         prosody << SSML::SayAs.new('date')
@@ -128,6 +150,7 @@ module RubySpeech
         voice = SSML::Voice.new(:gender => :male, :name => 'fred', :content => "Hi, I'm Fred. The time is currently ")
         voice << SSML::SayAs.new('date', :format => 'dmy', :content => "01/02/1960")
         voice << SSML::Break.new
+        voice << SSML::Audio.new(:src => "hello")
         voice << SSML::Emphasis.new(:content => "I'm so old")
         voice << SSML::Prosody.new(:rate => :fast, :content => "And yet so spritely!")
         voice << SSML::Voice.new(:age => 12, :content => "And I'm young Fred")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_speech
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-06 00:00:00.000000000 +01:00
+date: 2011-08-25 00:00:00.000000000 +01:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: niceogiri
-  requirement: &2157192140 !ruby/object:Gem::Requirement
+  requirement: &2152986200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 0.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *2157192140
+  version_requirements: *2152986200
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2157191620 !ruby/object:Gem::Requirement
+  requirement: &2152985680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 3.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *2157191620
+  version_requirements: *2152985680
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2157191140 !ruby/object:Gem::Requirement
+  requirement: &2153018720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2157191140
+  version_requirements: *2153018720
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2157190660 !ruby/object:Gem::Requirement
+  requirement: &2153018240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *2157190660
+  version_requirements: *2153018240
 - !ruby/object:Gem::Dependency
   name: ci_reporter
-  requirement: &2157190180 !ruby/object:Gem::Requirement
+  requirement: &2153017760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: 1.6.3
   type: :development
   prerelease: false
-  version_requirements: *2157190180
+  version_requirements: *2153017760
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2157183900 !ruby/object:Gem::Requirement
+  requirement: &2153017280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,10 +77,10 @@ dependencies:
         version: 0.7.0
   type: :development
   prerelease: false
-  version_requirements: *2157183900
+  version_requirements: *2153017280
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2157183320 !ruby/object:Gem::Requirement
+  requirement: &2153016800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,10 +88,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157183320
+  version_requirements: *2153016800
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2157182760 !ruby/object:Gem::Requirement
+  requirement: &2153016320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +99,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157182760
+  version_requirements: *2153016320
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2157182140 !ruby/object:Gem::Requirement
+  requirement: &2153015840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -110,7 +110,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157182140
+  version_requirements: *2153015840
 description: Prepare SSML and GRXML documents with ease
 email:
 - ben@langfeld.me
@@ -131,6 +131,7 @@ files:
 - assets/xml.xsd
 - lib/ruby_speech.rb
 - lib/ruby_speech/ssml.rb
+- lib/ruby_speech/ssml/audio.rb
 - lib/ruby_speech/ssml/break.rb
 - lib/ruby_speech/ssml/element.rb
 - lib/ruby_speech/ssml/emphasis.rb
@@ -142,6 +143,7 @@ files:
 - lib/ruby_speech/xml.rb
 - lib/ruby_speech/xml/language.rb
 - ruby_speech.gemspec
+- spec/ruby_speech/ssml/audio_spec.rb
 - spec/ruby_speech/ssml/break_spec.rb
 - spec/ruby_speech/ssml/emphasis_spec.rb
 - spec/ruby_speech/ssml/prosody_spec.rb
@@ -177,6 +179,7 @@ signing_key:
 specification_version: 3
 summary: A ruby library for TTS & ASR document preparation
 test_files:
+- spec/ruby_speech/ssml/audio_spec.rb
 - spec/ruby_speech/ssml/break_spec.rb
 - spec/ruby_speech/ssml/emphasis_spec.rb
 - spec/ruby_speech/ssml/prosody_spec.rb