ruby_speech 0.1.0

data/lib/ruby_speech/version.rb

@@ -0,0 +1,3 @@
+module RubySpeech
+  VERSION = "0.1.0"
+end

data/lib/ruby_speech/xml.rb

@@ -0,0 +1,7 @@
+module RubySpeech
+  module XML
+    extend ActiveSupport::Autoload
+
+    autoload :Language
+  end # XML
+end # RubySpeech

data/lib/ruby_speech/xml/language.rb

@@ -0,0 +1,13 @@
+module RubySpeech
+  module XML
+    module Language
+      def language
+        read_attr :lang
+      end
+
+      def language=(l)
+        write_attr 'xml:lang', l
+      end
+    end # Language
+  end # XML
+end # RubySpeech

data/ruby_speech.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ruby_speech/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ruby_speech"
+  s.version     = RubySpeech::VERSION
+  s.authors     = ["Ben Langfeld"]
+  s.email       = ["ben@langfeld.me"]
+  s.homepage    = "https://github.com/mojolingo/ruby_speech"
+  s.summary     = %q{A ruby library for TTS & ASR document preparation}
+  s.description = %q{Prepare SSML and GRXML documents with ease}
+
+  s.rubyforge_project = "ruby_speech"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency %q<niceogiri>, [">= 0.0.4"]
+  s.add_runtime_dependency %q<activesupport>, [">= 3.0.7"]
+
+  s.add_development_dependency %q<bundler>, ["~> 1.0.0"]
+  s.add_development_dependency %q<rspec>, ["~> 2.3.0"]
+  s.add_development_dependency %q<ci_reporter>, [">= 1.6.3"]
+  s.add_development_dependency %q<yard>, ["~> 0.6.0"]
+  s.add_development_dependency %q<rake>, [">= 0"]
+  s.add_development_dependency %q<mocha>, [">= 0"]
+  s.add_development_dependency %q<i18n>, [">= 0"]
+end

data/spec/ruby_speech/ssml/break_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+module RubySpeech
+  module SSML
+    describe Break do
+      its(:name) { should == 'break' }
+
+      describe "setting options in initializers" do
+        subject { Break.new :strength => :strong, :time => 3.seconds }
+
+        its(:strength)  { should == :strong }
+        its(:time)      { should == 3.seconds }
+      end
+
+      describe "#strength" do
+        before { subject.strength = :strong }
+
+        its(:strength) { should == :strong }
+
+        it "with a valid level" do
+          lambda { subject.strength = :none }.should_not raise_error
+          lambda { subject.strength = :'x-weak' }.should_not raise_error
+          lambda { subject.strength = :weak }.should_not raise_error
+          lambda { subject.strength = :medium }.should_not raise_error
+          lambda { subject.strength = :strong }.should_not raise_error
+          lambda { subject.strength = :'x-strong' }.should_not raise_error
+        end
+
+        it "with an invalid strength" do
+          lambda { subject.strength = :something }.should raise_error(ArgumentError, "You must specify a valid strength (:none, :\"x-weak\", :weak, :medium, :strong, :\"x-strong\")")
+        end
+      end
+
+      describe "#time" do
+        context "with a valid value" do
+          before { subject.time = 3.seconds }
+
+          its(:time) { should == 3.seconds }
+        end
+
+        context "with a negative value" do
+          it do
+            lambda { subject.time = -3.seconds }.should raise_error(ArgumentError, "You must specify a valid time (positive float value in seconds)")
+          end
+        end
+
+        context "with an invalid value" do
+          it do
+            lambda { subject.time = 'blah' }.should raise_error(ArgumentError, "You must specify a valid time (positive float value in seconds)")
+          end
+        end
+      end
+
+      describe "<<" do
+        it "should always raise InvalidChildError" do
+          lambda { subject << 'anything' }.should raise_error(InvalidChildError, "A Break cannot contain children")
+        end
+      end
+
+      describe "comparing objects" do
+        it "should be equal if the content, strength and base uri are the same" do
+          Break.new(strength: :strong, time: 1.second, content: "Hello there").should == Break.new(strength: :strong, time: 1.second, content: "Hello there")
+        end
+
+        describe "when the content is different" do
+          it "should not be equal" do
+            Break.new(content: "Hello").should_not == Break.new(content: "Hello there")
+          end
+        end
+
+        describe "when the strength is different" do
+          it "should not be equal" do
+            Break.new(strength: :strong).should_not == Break.new(strength: :weak)
+          end
+        end
+
+        describe "when the time is different" do
+          it "should not be equal" do
+            Break.new(time: 1.second).should_not == Break.new(time: 2.seconds)
+          end
+        end
+      end
+    end # Break
+  end # SSML
+end # RubySpeech

data/spec/ruby_speech/ssml/emphasis_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+module RubySpeech
+  module SSML
+    describe Emphasis do
+      its(:name) { should == 'emphasis' }
+
+      describe "setting options in initializers" do
+        subject { Emphasis.new :level => :strong }
+
+        its(:level) { should == :strong }
+      end
+
+      describe "#level" do
+        before { subject.level = :strong }
+
+        its(:level) { should == :strong }
+
+        it "with a valid level" do
+          lambda { subject.level = :strong }.should_not raise_error
+          lambda { subject.level = :moderate }.should_not raise_error
+          lambda { subject.level = :none }.should_not raise_error
+          lambda { subject.level = :reduced }.should_not raise_error
+        end
+
+        it "with an invalid level" do
+          lambda { subject.level = :something }.should raise_error(ArgumentError, "You must specify a valid level (:strong, :moderate, :none, :reduced)")
+        end
+      end
+
+      describe "comparing objects" do
+        it "should be equal if the content and level are the same" do
+          Emphasis.new(level: :strong, content: "Hello there").should == Emphasis.new(level: :strong, content: "Hello there")
+        end
+
+        describe "when the content is different" do
+          it "should not be equal" do
+            Emphasis.new(content: "Hello").should_not == Emphasis.new(content: "Hello there")
+          end
+        end
+
+        describe "when the level is different" do
+          it "should not be equal" do
+            Emphasis.new(level: :strong).should_not == Emphasis.new(level: :reduced)
+          end
+        end
+      end
+
+      describe "<<" do
+        it "should accept String" do
+          lambda { subject << 'anything' }.should_not raise_error
+        end
+
+        it "should accept Audio" do
+          pending
+          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 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 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 Emphasis can only accept String, Audio, Break, Emphasis, Mark, Phoneme, Prosody, SayAs, Sub, Voice as children")
+        end
+      end
+    end # Emphasis
+  end # SSML
+end # RubySpeech

data/spec/ruby_speech/ssml/prosody_spec.rb

@@ -0,0 +1,286 @@
+require 'spec_helper'
+
+module RubySpeech
+  module SSML
+    describe Prosody do
+      its(:name) { should == 'prosody' }
+
+      describe "setting options in initializers" do
+        subject { Prosody.new :pitch => :medium, :contour => "something", :range => '20Hz', :rate => 2, :duration => 10.seconds, :volume => :loud }
+
+        its(:pitch)     { should == :medium }
+        its(:contour)   { should == 'something' }
+        its(:range)     { should == '20Hz' }
+        its(:rate)      { should == 2 }
+        its(:duration)  { should == 10.seconds }
+        its(:volume)    { should == :loud }
+      end
+
+      describe "#pitch" do
+        context "with a pre-defined value" do
+          before { subject.pitch = :medium }
+
+          its(:pitch) { should == :medium }
+
+          it "with a valid value" do
+            lambda { subject.pitch = :'x-low' }.should_not raise_error
+            lambda { subject.pitch = :low }.should_not raise_error
+            lambda { subject.pitch = :medium }.should_not raise_error
+            lambda { subject.pitch = :high }.should_not raise_error
+            lambda { subject.pitch = :'x-high' }.should_not raise_error
+            lambda { subject.pitch = :default }.should_not raise_error
+          end
+
+          it "with an invalid value" do
+            lambda { subject.pitch = :something }.should raise_error(ArgumentError, "You must specify a valid pitch (\"[positive-number]Hz\", :\"x-low\", :low, :medium, :high, :\"x-high\", :default)")
+          end
+        end
+
+        context "with a Hertz value" do
+          describe "with a valid value" do
+            before { subject.pitch = '440Hz' }
+
+            its(:pitch) { should == '440Hz' }
+          end
+
+          it "with a negative value" do
+            lambda { subject.pitch = "-100Hz" }.should raise_error(ArgumentError, "You must specify a valid pitch (\"[positive-number]Hz\", :\"x-low\", :low, :medium, :high, :\"x-high\", :default)")
+          end
+
+          it "when missing 'hz'" do
+            lambda { subject.pitch = "440" }.should raise_error(ArgumentError, "You must specify a valid pitch (\"[positive-number]Hz\", :\"x-low\", :low, :medium, :high, :\"x-high\", :default)")
+          end
+        end
+      end
+
+      describe "#contour" do
+        before { subject.contour = "blah" }
+
+        its(:contour) { should == "blah" }
+      end
+
+      describe "#range" do
+        context "with a pre-defined value" do
+          before { subject.range = :medium }
+
+          its(:range) { should == :medium }
+
+          it "with a valid value" do
+            lambda { subject.range = :'x-low' }.should_not raise_error
+            lambda { subject.range = :low }.should_not raise_error
+            lambda { subject.range = :medium }.should_not raise_error
+            lambda { subject.range = :high }.should_not raise_error
+            lambda { subject.range = :'x-high' }.should_not raise_error
+            lambda { subject.range = :default }.should_not raise_error
+          end
+
+          it "with an invalid value" do
+            lambda { subject.range = :something }.should raise_error(ArgumentError, "You must specify a valid range (\"[positive-number]Hz\", :\"x-low\", :low, :medium, :high, :\"x-high\", :default)")
+          end
+        end
+
+        context "with a Hertz value" do
+          describe "with a valid value" do
+            before { subject.range = '440Hz' }
+
+            its(:range) { should == '440Hz' }
+          end
+
+          it "with a negative value" do
+            lambda { subject.range = "-100Hz" }.should raise_error(ArgumentError, "You must specify a valid range (\"[positive-number]Hz\", :\"x-low\", :low, :medium, :high, :\"x-high\", :default)")
+          end
+
+          it "when missing 'hz'" do
+            lambda { subject.range = "440" }.should raise_error(ArgumentError, "You must specify a valid range (\"[positive-number]Hz\", :\"x-low\", :low, :medium, :high, :\"x-high\", :default)")
+          end
+        end
+      end
+
+      describe "#rate" do
+        context "with a pre-defined value" do
+          before { subject.rate = :medium }
+
+          its(:rate) { should == :medium }
+
+          it "with a valid value" do
+            lambda { subject.rate = :'x-slow' }.should_not raise_error
+            lambda { subject.rate = :slow }.should_not raise_error
+            lambda { subject.rate = :medium }.should_not raise_error
+            lambda { subject.rate = :fast }.should_not raise_error
+            lambda { subject.rate = :'x-fast' }.should_not raise_error
+            lambda { subject.rate = :default }.should_not raise_error
+          end
+
+          it "with an invalid value" do
+            lambda { subject.rate = :something }.should raise_error(ArgumentError, "You must specify a valid rate ([positive-number](multiplier), :\"x-slow\", :slow, :medium, :fast, :\"x-fast\", :default)")
+          end
+        end
+
+        context "with a multiplier value" do
+          describe "with a valid value" do
+            before { subject.rate = 1.5 }
+
+            its(:rate) { should == 1.5 }
+          end
+
+          it "with a negative value" do
+            lambda { subject.rate = -100 }.should raise_error(ArgumentError, "You must specify a valid rate ([positive-number](multiplier), :\"x-slow\", :slow, :medium, :fast, :\"x-fast\", :default)")
+          end
+        end
+      end
+
+      describe "#duration" do
+        context "with a valid value" do
+          before { subject.duration = 3.seconds }
+
+          its(:duration) { should == 3.seconds }
+        end
+
+        context "with a negative value" do
+          it do
+            lambda { subject.duration = -3.seconds }.should raise_error(ArgumentError, "You must specify a valid duration (positive float value in seconds)")
+          end
+        end
+
+        context "with an invalid value" do
+          it do
+            lambda { subject.duration = 'blah' }.should raise_error(ArgumentError, "You must specify a valid duration (positive float value in seconds)")
+          end
+        end
+      end
+
+      describe "#volume" do
+        context "with a pre-defined value" do
+          before { subject.volume = :medium }
+
+          its(:volume) { should == :medium }
+
+          it "with a valid value" do
+            lambda { subject.volume = :silent }.should_not raise_error
+            lambda { subject.volume = :'x-soft' }.should_not raise_error
+            lambda { subject.volume = :soft }.should_not raise_error
+            lambda { subject.volume = :medium }.should_not raise_error
+            lambda { subject.volume = :loud }.should_not raise_error
+            lambda { subject.volume = :'x-loud' }.should_not raise_error
+            lambda { subject.volume = :default }.should_not raise_error
+          end
+
+          it "with an invalid value" do
+            lambda { subject.volume = :something }.should raise_error(ArgumentError, "You must specify a valid volume ([positive-number](0.0 -> 100.0), :silent, :\"x-soft\", :soft, :medium, :loud, :\"x-loud\", :default)")
+          end
+        end
+
+        context "with a multiplier" do
+          describe "with a valid value" do
+            before { subject.volume = 1.5 }
+
+            its(:volume) { should == 1.5 }
+          end
+
+          it "with a negative value" do
+            lambda { subject.volume = -1.5 }.should raise_error(ArgumentError, "You must specify a valid volume ([positive-number](0.0 -> 100.0), :silent, :\"x-soft\", :soft, :medium, :loud, :\"x-loud\", :default)")
+            lambda { subject.volume = 100.5 }.should raise_error(ArgumentError, "You must specify a valid volume ([positive-number](0.0 -> 100.0), :silent, :\"x-soft\", :soft, :medium, :loud, :\"x-loud\", :default)")
+          end
+        end
+      end
+
+      describe "comparing objects" do
+        it "should be equal if the content, strength and base uri are the same" do
+          Prosody.new(pitch: :medium, contour: "something", range: '20Hz', rate: 2, duration: 10.seconds, volume: :loud, content: "Hello there").should == Prosody.new(pitch: :medium, contour: "something", range: '20Hz', rate: 2, duration: 10.seconds, volume: :loud, content: "Hello there")
+        end
+
+        describe "when the content is different" do
+          it "should not be equal" do
+            Prosody.new(content: "Hello").should_not == Prosody.new(content: "Hello there")
+          end
+        end
+
+        describe "when the pitch is different" do
+          it "should not be equal" do
+            Prosody.new(pitch: :medium).should_not == Prosody.new(pitch: :high)
+          end
+        end
+
+        describe "when the contour is different" do
+          it "should not be equal" do
+            Prosody.new(contour: 'foo').should_not == Prosody.new(contour: 'bar')
+          end
+        end
+
+        describe "when the range is different" do
+          it "should not be equal" do
+            Prosody.new(range: '20Hz').should_not == Prosody.new(range: '30Hz')
+          end
+        end
+
+        describe "when the rate is different" do
+          it "should not be equal" do
+            Prosody.new(rate: 2).should_not == Prosody.new(rate: 3)
+          end
+        end
+
+        describe "when the duration is different" do
+          it "should not be equal" do
+            Prosody.new(duration: 10.seconds).should_not == Prosody.new(duration: 20.seconds)
+          end
+        end
+
+        describe "when the volume is different" do
+          it "should not be equal" do
+            Prosody.new(volume: :loud).should_not == Prosody.new(volume: :soft)
+          end
+        end
+      end
+
+      describe "<<" do
+        it "should accept String" do
+          lambda { subject << 'anything' }.should_not raise_error
+        end
+
+        it "should accept Audio" do
+          pending
+          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 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 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, "A Prosody can only accept String, Audio, Break, Emphasis, Mark, P, Phoneme, Prosody, SayAs, Sub, S, Voice as children")
+        end
+      end
+    end # Prosody
+  end # SSML
+end # RubySpeech