espeak-ruby 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8c33c7798b51552e36abbf539dfeaf35f5301514
-  data.tar.gz: a07eaa1a0d4260c1068d9ea419e79f6288ab1c19
+SHA256:
+  metadata.gz: 9d5971c82e6e1b6f3aee1178a9c92cea060a643daa57bc606b88498ce7f17e1e
+  data.tar.gz: f668512d5fdb406c28f326d8c0bcc6a22472baf80ca024aa4612bb666abdaa07
 SHA512:
-  metadata.gz: 085cd3f429760d8a7e6d14a61ff829b35d359ec6947fc719abed96d148a52141257e9a0d31c594b58f58739d0a112e9e67b42e62ddfbe81c58c55bdcb3b77b8f
-  data.tar.gz: 7ff610fb5401de34f86da41eca76fc528ca0ecbf252a4c2aa338c35187fe01da40e56f6681e96a796b24f5f07bd1dcd131e5e411c5aef62f84319bd71f4e1cac
+  metadata.gz: f644bde0b8ebe76d934c170eb9f8a2b4705935d24c09011978bbe9d7c0b5ec3eba85913169d2d0e72fb3bef8b747f4dc3a1f1822c865e4446165681f8d1d1e6e
+  data.tar.gz: c973d3d750fef73c8c62080d4b59eccbddfc4580378f81ae062f9b966b0bef810c32340f55049efffecf4bff65c36029fb1e8089b6f80ecff265072c432fc6c8

data/README.md

@@ -1,11 +1,8 @@
-espeak-ruby
-===========
+# espeak-ruby
 
-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. It can also just speak (without saving).
-See the [live demo](http://rors.org/demos/espeak-ruby).
+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 or just speak (without saving). See [live demo](https://espeak.rors.org/).
 
-Install
--------
+## Install
 
 Add _espeak-ruby_ to Gemfile
 
@@ -13,43 +10,34 @@ Add _espeak-ruby_ to Gemfile
 gem "espeak-ruby", require: "espeak"
 ```
 
-Examples
---------
-
-First you need to include ESpeak module to access espeak API
-
-```ruby
-include ESpeak
-```
-
-Then use it like this:
+## Examples
 
 ```ruby
 # Speaks "YO!"
-speech = Speech.new("YO!")
+speech = ESpeak::Speech.new("YO!")
 speech.speak # invokes espeak
 
 # Creates hello-de.mp3 file
-speech = Speech.new("Hallo Welt", voice: "de")
+speech = ESpeak::Speech.new("Hallo Welt", voice: "de")
 speech.save("hello-de.mp3") # invokes espeak + lame
 
 # Lists voices
-Voice.all.map { |v| v.language } # ["af", "bs", "ca", "cs", "cy", "da", "de", "el", "en", "en-sc", "en-uk", "en-uk-north", "en-uk-rp", "en-uk-wmids", "en-us", "en-wi", "eo", "es", "es-la", "fi", "fr", "fr-be", "grc", "hi", "hr", "hu", "hy", "hy", "id", "is", "it", "jbo", "ka", "kn", "ku", "la", "lv", "mk", "ml", "nci", "nl", "no", "pap", "pl", "pt", "pt-pt", "ro", "ru", "sk", "sq", "sr", "sv", "sw", "ta", "tr", "vi", "zh", "zh-yue"]
+ESpeak::Voice.all.map { |v| v.language } # ["af", "bs", "ca", "cs", "cy", "da", "de", "el", "en", "en-sc", "en-uk", "en-uk-north", "en-uk-rp", "en-uk-wmids", "en-us", "en-wi", "eo", "es", "es-la", "fi", "fr", "fr-be", "grc", "hi", "hr", "hu", "hy", "hy", "id", "is", "it", "jbo", "ka", "kn", "ku", "la", "lv", "mk", "ml", "nci", "nl", "no", "pap", "pl", "pt", "pt-pt", "ro", "ru", "sk", "sq", "sr", "sv", "sw", "ta", "tr", "vi", "zh", "zh-yue"]
 
 # Find particular voice
-Voice.find_by_language('en') #<ESpeak::Voice:0x007fe1d3806be8 @language="en", @name="default", @gender="M", @file="default">
+ESpeak::Voice.find_by_language('en') #<ESpeak::Voice:0x007fe1d3806be8 @language="en", @name="default", @gender="M", @file="default">
 ```
 
-Features
---------
+## Features
 
 Currently only subset of espeak features is supported.
 
 ```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
-:capital => 170     # increase emphasis (pitch) of capitalized words, 1 to 40 (for natural sound, can go higher)
+: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
+:capital   => 170     # increase emphasis (pitch) of capitalized words, 1 to 40 (for natural sound, can go higher)
+:amplitude => 150     # amplitude (volume) adjustment, 0 to 200
 ```
 
 These are default values, and they can be easily overridden:
@@ -58,37 +46,16 @@ These are default values, and they can be easily overridden:
 Speech.new("Zdravo svete", voice: "sr", pitch: 90, speed: 200).speak
 ```
 
-Requirements
-------------
-
-* <http://espeak.sourceforge.net>
-* <http://lame.sourceforge.net>
-
-Related
--------
+## Installing dependencies
 
-* [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
+### OS X
 
-Licence
--------
+    brew install espeak lame
 
-Copyright (c) 2008 Dejan Simic
+### Ubuntu
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+    apt-get install espeak lame
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+## Licence
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+espeak-ruby is released under the [MIT License](/MIT-LICENSE).

data/Rakefile

@@ -1,12 +1,16 @@
+# frozen_string_literal: true
+
 require 'rake/testtask'
+require 'rubocop/rake_task'
 
 desc 'Default: run tests'
-task :default => :test
+task default: :test
 
 desc 'Test espeak-ruby'
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
+Rake::TestTask.new(test: :rubocop) do |t|
+  t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = true
 end
 
+RuboCop::RakeTask.new

data/lib/espeak/speech.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module ESpeak
+  # Speech represents an Text-To-Speech audio that can be played or saved to file
   class Speech
     attr_reader :options, :text
 
@@ -9,9 +12,10 @@ module ESpeak
     #    :speed     - speed in words per minute, 80 to 370
     #    :capital   - increase emphasis of capitalized letters by raising pitch by this amount
     #                 no range given in man but good range is 10-40 to start
+    #    :amplitude - amplitude adjustment, 0 to 200
     #    :quiet     - remove printing to stdout. Affects only lame (default false)
     #
-    def initialize(text, options={})
+    def initialize(text, options = {})
       @text = text
       @options = options
     end
@@ -19,9 +23,7 @@ module ESpeak
     # Speaks text
     #
     def speak
-      IO.popen(espeak_command(command_options), 'r') do |process|
-        process.read
-      end
+      IO.popen(espeak_command(command_options), 'r', &:read)
     end
 
     # Generates mp3 file as a result of
@@ -40,7 +42,7 @@ module ESpeak
     # Returns mp3 file bytes as a result of
     # Text-To-Speech conversion.
     #
-    def bytes()
+    def bytes
       speech = bytes_wav
       res = IO.popen(std_lame_command(command_options), 'r+') do |process|
         process.write(speech)
@@ -53,16 +55,14 @@ module ESpeak
     # Returns wav file bytes as a result of
     # Text-To-Speech conversion.
     #
-    def bytes_wav()
-      IO.popen(espeak_command(command_options, "--stdout"), 'r') do |process|
-        process.read
-      end
+    def bytes_wav
+      IO.popen(espeak_command(command_options, '--stdout'), 'r', &:read)
     end
 
     private
 
     def command_options
-      default_options.merge(symbolize_keys(options))
+      default_options.merge(options.transform_keys(&:to_sym))
     end
 
     # Although espeak itself has default options
@@ -70,30 +70,25 @@ module ESpeak
     # command (with simple hash.merge)
     #
     def default_options
-      { :voice => 'en',
-        :pitch => 50,
-        :speed => 170,
-        :capital => 1,
-        :quiet => true }
+      { voice: 'en',
+        pitch: 50,
+        speed: 170,
+        capital: 1,
+        amplitude: 100,
+        quiet: true }
     end
 
-    def espeak_command(options, flags="")
-      ['espeak', "#{@text}", "#{flags}", "-v#{options[:voice]}", "-p#{options[:pitch]}", "-k#{options[:capital]}", "-s#{options[:speed]}"]
+    def espeak_command(options, flags = '')
+      ['espeak', @text.to_s, flags.to_s, "-v#{options[:voice]}", "-p#{options[:pitch]}", "-k#{options[:capital]}",
+       "-s#{options[:speed]}", "-a#{options[:amplitude]}"]
     end
 
     def std_lame_command(options)
-      lame_command("-", options)
+      lame_command('-', options)
     end
 
     def lame_command(filename, options)
-      ['lame', '-V2', '-', "#{filename}", "#{'--quiet' if options[:quiet] == true}"]
-    end
-
-    def symbolize_keys(hash)
-      hash.inject({}) do |options, (key, value)|
-        options[(key.to_sym rescue key) || key] = value
-        options
-      end
+      ['lame', '-V2', '-', filename.to_s, ('--quiet' if options[:quiet] == true).to_s]
     end
   end
 end

data/lib/espeak/voice.rb

@@ -1,8 +1,10 @@
-require 'csv'
+# frozen_string_literal: true
 
 module ESpeak
+  # A voice that will be used for `Speech`
   class Voice
     attr_reader :language, :name, :gender, :file
+
     def initialize(attributes)
       @language = attributes[:language]
       @name     = attributes[:name]
@@ -12,18 +14,18 @@ module ESpeak
 
     def self.all
       voices = []
-      CSV.parse(espeak_voices, headers: :first_row, col_sep: ' ') do |row|
-        voices << Voice.new(language: row[1], gender: row[2], name: row[3], file: row[4] )
+      result = IO.popen('espeak --voices', &:read)
+      result.each_line do |line|
+        next unless line.start_with?(' ') # header
+
+        row = line.split
+        voices << Voice.new(language: row[1], gender: row[2], name: row[3], file: row[4])
       end
-      voices
+      voices.freeze
     end
 
     def self.find_by_language(lang)
       all.find { |v| v.language == lang.to_s }
     end
-
-    def self.espeak_voices
-      `espeak --voices`
-    end
   end
 end

data/lib/espeak.rb

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
 module ESpeak
   autoload :Speech, 'espeak/speech'
   autoload :Voice,  'espeak/voice'
 end
+
+ESpeak::Voice.all

data/test/cases/speech_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 require 'fileutils'
 
@@ -5,11 +7,10 @@ class SpeechTest < Test::Unit::TestCase
   include ESpeak
 
   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")
+    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/cases/voice_test.rb

@@ -1,17 +1,14 @@
-require "test_helper"
+# frozen_string_literal: true
+
+require 'test_helper'
 
 class VoiceTest < Test::Unit::TestCase
   include ESpeak
 
-  def setup
-    voices_file = File.read("test/fixtures/voices.txt")
-    Voice.expects(:espeak_voices).returns(voices_file)
-  end
-
   def test_all
     all_voices = Voice.all
-    assert all_voices.size > 0
-    assert %w(M F).include?(all_voices.first.gender)
+    assert all_voices.size.positive?
+    assert %w[M F].include?(all_voices.first.gender)
   end
 
   def test_find_by_language

data/test/test_helper.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'test/unit'
-require 'mocha/setup'
 require 'espeak'

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: espeak-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Dejan Simic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-01 00:00:00.000000000 Z
-dependencies: []
+date: 2022-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.23'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.23'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
 description: espeak-ruby is small Ruby API for utilizing ‘espeak’ and ‘lame’ to create
   Text-To-Speech mp3 files
 email: desimic@gmail.com
@@ -24,12 +66,12 @@ files:
 - lib/espeak/voice.rb
 - test/cases/speech_test.rb
 - test/cases/voice_test.rb
-- test/fixtures/voices.txt
 - test/test_helper.rb
 homepage: https://github.com/dejan/espeak-ruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -38,15 +80,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: espeak-ruby is small Ruby API for utilizing ‘espeak’ and ‘lame’ to create

data/test/fixtures/voices.txt

@@ -1,60 +0,0 @@
-Pty Language Age/Gender VoiceName       File        Other Langs
- 5  af             M  afrikaans         af          
- 5  bs             M  bosnian           bs          
- 5  ca             M  catalan           ca          
- 5  cs             M  czech             cs          
- 5  cy             M  welsh-test        cy          
- 5  da             M  danish            da          
- 5  de             M  german            de          
- 5  el             M  greek             el          
- 5  en             M  default           default     
- 5  en-sc          M  en-scottish       en/en-sc    (en 4)
- 2  en-uk          M  english           en/en       (en 2)
- 5  en-uk-north    M  lancashire        en/en-n     (en-uk 3)
- 5  en-uk-rp       M  english_rp        en/en-rp    (en-uk 4)
- 5  en-uk-wmids    M  english_wmids     en/en-wm    
- 2  en-us          M  english-us        en/en-us    (en-r 5)(en 3)
- 5  en-wi          M  en-westindies     en/en-wi    (en-uk 4)
- 5  eo             M  esperanto         eo          
- 5  es             M  spanish           es          
- 5  es-la          M  spanish-latin-american es-la       (es-mx 6)
- 5  fi             M  finnish           fi          
- 5  fr             M  french            fr          
- 5  fr-be          M  french (Belgium)  fr-be       
- 5  grc            M  greek-ancient     test/grc    
- 5  hi             M  hindi-test        hi          
- 5  hr             M  croatian          hr          (hbs 5)
- 5  hu             M  hungarian         hu          
- 5  hy             M  armenian          hy          
- 5  hy             M  armenian-west     hy-west     
- 5  id             M  indonesian-test   id          
- 5  is             M  icelandic-test    is          
- 5  it             M  italian           it          
- 5  jbo               lojban            test/jbo    
- 5  ka                georgian-test     ka          
- 5  kn                kannada           kn          
- 5  ku             M  kurdish           ku          
- 5  la             M  latin             la          
- 5  lv             M  latvian           lv          
- 5  mk             M  macedonian-test   mk          
- 5  ml             M  malayalam         ml          
- 5  nci            M  nahuatl - classical test/nci    
- 5  nl             M  dutch-test        nl          
- 5  no             M  norwegian         no          (nb 5)
- 5  pap               papiamento-test   test/pap    
- 5  pl             M  polish            pl          
- 5  pt             M  brazil            pt          (pt-br 5)
- 5  pt-pt          M  portugal          pt-pt       
- 5  ro             M  romanian          ro          
- 5  ru             M  russian_test      ru          
- 5  sk             M  slovak            sk          
- 5  sq             M  albanian          sq          
- 5  sr             M  serbian           sr          
- 5  sv             M  swedish           sv          
- 5  sw             M  swahihi-test      sw          
- 5  ta             M  tamil             ta          
- 5  tr             M  turkish           tr          
- 5  vi             M  vietnam           vi          
- 5  zh             M  Mandarin          zh          
- 5  zh-yue         M  cantonese         zh-yue      (yue 5)(zhy 5)
-