dejan-espeak-ruby 0.2.3 → 0.3.0

data/README.rdoc

@@ -15,23 +15,25 @@ espeak-ruby is small Ruby API for utilizing 'espeak' and 'lame' to create Text-T
 	require 'espeak-ruby'
 
 	include ESpeak
-
-	espeak("Hello World")
-	espeak("Guten Tag", :v => "de")
+  
+	# Creates hello.mp3 file
+	espeak("hello.mp3", :text => "Hello World") 
+	
+	# Creates /home/espeak/hello-de.mp3 file
+	espeak("/home/espeak/hello-de.mp3", :text => "Hallo Welt", :voice => "de")
 
 == Features
 
 Currently only subset of espeak features is supported. 
 
-	default_options = {
-	  :v => 'en',   # use voice file of this name from espeak-data/voices
-	  :p => 50,     # pitch adjustment, 0 to 99
-	  :s => 170     # speed in words per minute, 80 to 370
-	}
+	  :voice => 'en',   # use voice file of this name from espeak-data/voices
+	  :pitch => 50,     # pitch adjustment, 0 to 99
+	  :speed => 170     # speed in words per minute, 80 to 370
+
 
 This can be easily overriden:
 
-	espeak("Zdravo svete", :v => "sr", :p => 90, :s => 200)
+	espeak("zdravo.mp3", :text => "Zdravo svete", :voice => "sr", :pitch => 90, :speed => 200)
 
 == Requirements
 

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 0
-:minor: 2
-:patch: 3
+:minor: 3
+:patch: 0
 

data/lib/espeak-ruby.rb

@@ -1,24 +1,60 @@
 require 'rubygems'
-require 'digest/sha1'
 require File.dirname(__FILE__) + "/hash_ext.rb"
 
 module ESpeak
-
-  def espeak(text, opts = {})
-    opts.symbolize_keys!
-    options = {
-      :v => 'en',   # use voice file of this name from espeak-data/voices
-      :p => 50,     # pitch adjustment, 0 to 99
-      :s => 170     # speed in words per minute, 80 to 370
-    }.merge(opts)
-    
-    sanitized_text = text.gsub(/(!|\?|"|`|\\)/, ' ')
-    filename = Digest::SHA1.hexdigest(text + options.to_s + ".mp3")
-
-    if system(%$espeak "#{sanitized_text}" --stdout -v#{options[:v]} -p#{options[:p]} -s#{options[:s]} | lame -V2 - #{filename}$)
-      filename
+  
+  # 
+  # Generates mp3 file as a result of Text-To-Speech conversion. 
+  #
+  # filename - The file that will be generated
+  # options  - Posible key, values
+  #    :voice     - use voice file of this name from espeak-data/voices. ie 'en', 'de', ...
+  #    :pitch     - pitch adjustment, 0 to 99
+  #    :speed     - speed in words per minute, 80 to 370
+  #
+  def espeak(filename, options)
+    if execute_system_command(filename, prepare_options(options))
+      nil
     else
-      raise "Error while running espeak. You don't seem to have espeak or lame installed ..." 
+      raise "Error while running espeak. You don't seem to have espeak or lame installed ..."
     end
   end
-end
+
+private
+
+  def prepare_options(options)
+    options.symbolize_keys!
+    raise "You must provide value for :text key in options" unless options[:text]
+    sanitize_text!(options[:text])
+    default_espeak_options.merge(options)
+  end
+
+  # espeak has problems handling
+  # some characters (it dies)
+  #
+  def sanitize_text!(text)
+    text.gsub!(/(!|\?|"|`|\\)/, ' ')
+  end
+
+  # Although espeak itself has default options 
+  # I'm defining them here for easier generating
+  # command (with simple hash.merge)
+  #
+  def default_espeak_options
+    { :voice => 'en',
+      :pitch => 50,
+      :speed => 170 }
+  end
+
+  def execute_system_command(filename, options)
+    system([espeak_command(options), lame_command(filename)] * " | ")
+  end
+
+  def espeak_command(options)
+    %|espeak "#{options[:text]}" --stdout -v#{options[:voice]} -p#{options[:pitch]} -s#{options[:speed]}|
+  end
+
+  def lame_command(filename)
+    "lame -V2 - #{filename}"
+  end
+end

data/spec/espeak_ruby_spec.rb

@@ -0,0 +1,61 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe ESpeak do 
+  
+  before :each do
+    @obj = Object.new
+    @obj.class_eval { include ESpeak }
+  end
+
+
+  describe "espeak" do
+    before :each do
+      @obj.stub!(:prepare_options)
+    end
+
+    it "should return nil if successfull" do
+      @obj.should_receive(:execute_system_command).and_return true
+      @obj.espeak("whatever", {}).should == nil
+    end
+
+    it "should raise if not successfull" do
+      @obj.should_receive(:execute_system_command).and_return false
+      lambda {
+        @obj.espeak("whatever", {})
+      }.should raise_error
+    end
+  end
+
+
+  describe "prepare_options" do
+    before :each do
+      @options = {:text => "Hello", 'speed' => 100}
+      @obj.stub!(:execute_system_command).and_return true
+    end
+
+    it "should symbolize keys" do
+      @obj.espeak("whatever", @options)
+      @options.should == @options.symbolize_keys
+    end
+
+    it "should raise if no value for :text key is provided" do
+      @options.delete(:text)
+      lambda {
+        @obj.espeak("whatever", @options)
+      }.should raise_error
+    end
+
+    it "should sanatize text" do
+      @obj.should_receive(:sanitize_text!).with(@options[:text])
+      @obj.espeak("whatever", @options)
+    end
+
+    it "should merge default_options with provided options" do
+      @default_options = {}
+      @obj.should_receive(:default_espeak_options).and_return(@default_options)
+      @default_options.should_receive(:merge).with(@options)
+      @obj.espeak("whatever", @options)
+    end
+  end
+
+end

data/spec/hash_ext_spec.rb

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Hash do
+  before :each do
+    @hash = {"a" => 1, "b" => 2, :c => "3"}
+  end
+
+  describe "symbolize_keys" do
+    it "should not alter instance" do
+      lambda {
+        @hash.symbolize_keys
+      }.should_not change { @hash.inspect }
+    end
+    
+    it "should return hash with same values as itself contains, but with keys as symbols" do
+      @hash.symbolize_keys.should == {:a => 1, :b => 2, :c => "3"}
+    end
+  end
+  
+  describe "symbolize_keys!" do
+    it "should alter instance such that all keys are symbols, and" do
+      @hash.symbolize_keys!
+      @hash.should == {:a => 1, :b => 2, :c => "3"}
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require File.dirname(__FILE__) + '/../lib/espeak-ruby.rb'
+
+require 'rubygems'
+require 'active_support'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dejan-espeak-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors: 
 - Dejan Simic
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-18 00:00:00 -08:00
+date: 2009-02-21 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -26,6 +26,9 @@ files:
 - VERSION.yml
 - lib/espeak-ruby.rb
 - lib/hash_ext.rb
+- spec/espeak_ruby_spec.rb
+- spec/hash_ext_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/dejan/espeak-ruby
 post_install_message: