espeak-ruby 0.4.0 → 1.0.0

data/{README.rdoc → README.md}

@@ -1,51 +1,61 @@
-= espeak-ruby
+espeak-ruby
+===========
 
-espeak-ruby is small Ruby API for utilizing 'espeak' and 'lame' to create Text-To-Speech mp3 files.
+espeak-ruby is a small Ruby API for utilizing [espeak](http://espeak.sourceforge.net) and [lame](http://lame.sourceforge.net/) to create Text-To-Speech mp3 files.
+See the [live demo](http://rors.org/demos/espeak-ruby).
 
-* eSpeak is a compact open source software speech synthesizer for English and other languages, for Linux and Windows. 
-* LAME is a high quality MPEG Audio Layer III (MP3) encoder licensed under the LGPL. 
+Install
+-------
 
-== Install
+Add _espeak-ruby_ to Gemfile
 
-  gem install espeak-ruby
+```ruby
+gem "espeak-ruby", require: "espeak"
+```
 
-== Example
+Example
+-------
 
-  require 'rubygems'
-  require 'espeak-ruby'
-
-  include ESpeak
-
-  # Creates hello.mp3 file
-  espeak("hello.mp3", :text => "Hello World") 
+```ruby
+# Speaks "YO!"
+speech = ESpeak::Speech.new("YO!")
+speech.speak # invokes espeak
   
-  # Creates /home/espeak/hello-de.mp3 file
-  espeak("/home/espeak/hello-de.mp3", :text => "Hallo Welt", :voice => "de")
+# Creates hello-de.mp3 file
+speech = ESpeak::Speech.new("Hallo Welt", voice: "de")
+speech.save("hello-de.mp3") # invokes espeak + lame
+```
 
-== Features
+Features
+--------
 
 Currently only subset of espeak features is supported. 
 
-  :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
-  :quiet => true    # prevent espeak-ruby from printing to stdout. (default false)
-
+```ruby
+: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
+```
 
 These are default values, and they can be easily overridden:
 
-  espeak("zdravo.mp3", :text => "Zdravo svete", :voice => "sr", :pitch => 90, :speed => 200)
+```ruby
+ESpeak::Speech.new("Zdravo svete", voice: "sr", pitch: 90, speed: 200).speak
+```
 
-== Requirements
+Requirements
+------------
 
-* http://espeak.sourceforge.net
-* http://lame.sourceforge.net/index.php
+* <http://espeak.sourceforge.net>
+* <http://lame.sourceforge.net>
 
-== Related
+Related
+-------
 
-* {espeak-http}[http://github.com/dejan/espeak-http] - Micro web app for Text-To-Speech conversion via HTTP powered by Ruby, Sinatra, lame, espeak and espeak-ruby
+* [espeak-http](http://github.com/dejan/espeak-http) - Micro web app for Text-To-Speech conversion via HTTP powered by Ruby, Sinatra, lame, espeak and espeak-ruby
 
-== Licence
+Licence
+-------
 
 Copyright (c) 2008 Dejan Simic
 

data/Rakefile

@@ -1,10 +1,12 @@
-require 'rake'
+require 'rake/testtask'
 
-desc 'Run all specs'
-task :spec do
-  system('spec spec')
-end
+desc 'Default: run tests'
+task :default => :test
 
-desc 'Default: run specs.'
-task :default => :spec
+desc 'Test espeak-ruby'
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
 

data/lib/espeak.rb

@@ -0,0 +1,3 @@
+module ESpeak
+  autoload :Speech, 'espeak/speech'
+end

data/lib/espeak/speech.rb

@@ -0,0 +1,72 @@
+module ESpeak
+  class Speech
+    attr_reader :options, :text
+  
+    # 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
+    #    :quiet     - remove printing to stdout. Affects only lame (default false) 
+    #    
+    def initialize(text, options={})
+      @text = text
+      @options = options
+    end
+
+    # Speaks text 
+    # 
+    def speak
+      system(espeak_command(command_options))
+    end
+
+    # Generates mp3 file as a result of 
+    # Text-To-Speech conversion. 
+    # 
+    def save(filename)
+      system(espeak_command(command_options, "--stdout") + " | " + lame_command(filename, command_options))
+    end
+
+    # espeak dies handling some chars
+    # this function sanitizes text
+    #
+    def sanitized_text
+      @text.gsub(/(!|\?|"|`|\\)/, ' ').strip
+    end
+
+    private
+
+    def command_options
+      default_options.merge(symbolize_keys(options))
+    end
+
+    # Although espeak itself has default options 
+    # I'm defining them here for easier generating
+    # command (with simple hash.merge)
+    #
+    def default_options
+      { :voice => 'en',
+        :pitch => 50,
+        :speed => 170,
+        :quiet => true }
+    end
+
+    def espeak_command(options, flags="")
+      %|espeak "#{sanitized_text}" #{flags} -v#{options[:voice]} -p#{options[:pitch]} -s#{options[:speed]}|
+    end
+
+    def lame_command(filename, options)
+      "lame -V2 - #{filename} #{'--quiet' if options[:quiet] == true}"
+    end
+
+    def execute_system_command(filename, options)
+     end
+
+    def symbolize_keys(hash)
+      hash.inject({}) do |options, (key, value)|
+        options[(key.to_sym rescue key) || key] = value
+        options
+      end
+    end
+  end
+end

data/lib/hash_ext.rb

@@ -1,13 +1,9 @@
 # from ActiveSupport
 class Hash
-  def symbolize_keys
-    inject({}) do |options, (key, value)|
-      options[(key.to_sym rescue key) || key] = value
-      options
-    end
+
   end
 
   def symbolize_keys!
     self.replace(self.symbolize_keys)
   end
-end
+end

data/test/cases/speech_test.rb

@@ -0,0 +1,20 @@
+require 'test_helper'
+require 'fileutils'
+
+class SpeechTest < Test::Unit::TestCase
+  include ESpeak
+
+  def test_sanitized_text
+    assert_equal "Hello", Speech.new("Hello!").sanitized_text
+    assert_equal "Hello World", Speech.new("Hello?World").sanitized_text
+  end
+
+  def test_save
+    FileUtils.rm_rf("test/tmp")
+    FileUtils.mkdir_p("test/tmp")
+    assert Speech.new("Hello!").save('test/tmp/test.mp3')
+    assert File.exist?("test/tmp/test.mp3"), "Mp3 file not generated"
+    FileUtils.rm_rf("test/tmp")
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'test/unit'
+require 'espeak'

metadata

@@ -1,73 +1,53 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: espeak-ruby
-version: !ruby/object:Gem::Version 
-  hash: 15
+version: !ruby/object:Gem::Version
+  version: 1.0.0
   prerelease: 
-  segments: 
-  - 0
-  - 4
-  - 0
-  version: 0.4.0
 platform: ruby
-authors: 
+authors:
 - Dejan Simic
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-04-17 00:00:00 +02:00
-default_executable: 
+date: 2013-01-12 00:00:00.000000000 Z
 dependencies: []
-
-description: "espeak-ruby is small Ruby API for utilizing \xE2\x80\x98espeak\xE2\x80\x99 and \xE2\x80\x98lame\xE2\x80\x99 to create Text-To-Speech mp3 files"
+description: espeak-ruby is small Ruby API for utilizing ‘espeak’ and ‘lame’ to create
+  Text-To-Speech mp3 files
 email: desimic@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - Rakefile
-- lib/espeak-ruby.rb
+- lib/espeak/speech.rb
+- lib/espeak.rb
 - lib/hash_ext.rb
-- spec/espeak_ruby_spec.rb
-- spec/hash_ext_spec.rb
-- spec/spec_helper.rb
-- README.rdoc
-has_rdoc: true
+- test/cases/speech_test.rb
+- test/test_helper.rb
+- README.md
 homepage: http://github.com/dejan/espeak-ruby
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: "espeak-ruby is small Ruby API for utilizing \xE2\x80\x98espeak\xE2\x80\x99 and \xE2\x80\x98lame\xE2\x80\x99 to create Text-To-Speech mp3 files"
+summary: espeak-ruby is small Ruby API for utilizing ‘espeak’ and ‘lame’ to create
+  Text-To-Speech mp3 files
 test_files: []
-

data/lib/espeak-ruby.rb

@@ -1,61 +0,0 @@
-require 'rubygems'
-require File.dirname(__FILE__) + "/hash_ext.rb"
-
-module ESpeak
-  
-  # 
-  # 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
-  #    :quiet     - remove printing to stdout. Affects only lame (default false) 
-  #
-  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 ..."
-    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, options)] * " | ")
-  end
-
-  def espeak_command(options)
-    %|espeak "#{options[:text]}" --stdout -v#{options[:voice]} -p#{options[:pitch]} -s#{options[:speed]}|
-  end
-
-  def lame_command(filename, options)
-    "lame -V2 - #{filename} #{'--quiet' if options[:quiet] == true}"
-  end
-end

data/spec/espeak_ruby_spec.rb

@@ -1,61 +0,0 @@
-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

@@ -1,26 +0,0 @@
-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

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