fest 1.1.10 → 1.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9237e21fc231d0ba30b76d23b80d12496ab47ae
-  data.tar.gz: 2ada0f7803419ef8be89927e9944b3bc5bc63df6
+  metadata.gz: 7d50c7542a471b18e485824b82e1b2bb9167a731
+  data.tar.gz: dba013463a29ac9cc600d8a5409cbb31ae9b2a41
 SHA512:
-  metadata.gz: d3eaf3e2d54049daefc46eff64c1207248784dc53ea30d365762f6e798695f301285136310a25149ac42618659aaaa6493f4ee239f3dd0598f76fd849ab44d3b
-  data.tar.gz: 95b7e5c453789a106c7094e0445e83e2ef405b66eb08180abf03e028e950d006194b33ab2dc6289368b6678d3d86086e66fd76f48d503ed3ba48a66578037a93
+  metadata.gz: a5b23bba2ab84449c1d0f39fc860e42ebdc6cd44d07b6e970ee404e953a012e803af17448e4325b3e1ac8def3ab080b57aa816d61a2b3602e038f4ad2f3b7fb4
+  data.tar.gz: f986e9e00655b709cf5cb7fba4c82599be713bfba578c80ed4729f54a4bdc8dc86c2d2532c43d7e0dc3a8230f5a0938799b123e88f3446927c7025b3b98b37e3

data/.gitignore

@@ -216,3 +216,5 @@ pip-log.txt
 
 # my
 *.*~
+Gemfile.lock
+coverage/

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.3
+  - 2.1.4
+  - ruby-head
+before_install:
+  - 'echo ''gem: --no-ri --no-rdoc'' > ~/.gemrc'
+install: bundle install
+after_success:
+  - coveralls

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in fest.gemspec
 gemspec
+gem 'coveralls', require: false

data/README.md

@@ -0,0 +1,96 @@
+## FEST
+
+[![Gem Version](https://badge.fury.io/rb/fest.svg)](http://badge.fury.io/rb/fest)
+[![Build Status](https://travis-ci.org/AfsmNGhr/fest.svg)](https://travis-ci.org/AfsmNGhr/fest)
+[![Coverage Status](https://coveralls.io/repos/AfsmNGhr/fest/badge.svg?branch=master)](https://coveralls.io/r/AfsmNGhr/fest?branch=master)
+[![License](https://img.shields.io/packagist/l/doctrine/orm.svg)](https://github.com/AfsmNGhr/fest)
+
+Ruby wrapper use [Festival](https://wiki.archlinux.org/index.php/Festival_%28%D0%A0%D1%83%D1%81%D1%81%D0%BA%D0%B8%D0%B9%29) for speak of the text and scripts ...
+
+## Requirements
+
+- *nix* or OS X ...
+- [Festival](https://wiki.archlinux.org/index.php/Festival_%28%D0%A0%D1%83%D1%81%D1%81%D0%BA%D0%B8%D0%B9%29) and necessary languages ...
+- [Pulseaudio](https://wiki.archlinux.org/index.php/PulseAudio_%28%D0%A0%D1%83%D1%81%D1%81%D0%BA%D0%B8%D0%B9%29)
+- xbacklight ([backlight](https://wiki.archlinux.org/index.php/Backlight_%28%D0%A0%D1%83%D1%81%D1%81%D0%BA%D0%B8%D0%B9%29))
+
+## Install
+
+```.ruby
+# Gemfile
+gem 'fest'
+```
+or
+```.ruby
+$ gem install fest
+```
+
+## Used
+### Call methods
+```.ruby
+require 'fest'
+
+@fest = Fest.new
+@fest.say("Пример")
+# => Say "Пример"
+
+# Expanded option
+@fest.params = {:language => "cmu_us_slt_arctic_hts"}
+@fest.say("This is an example")
+# => Say "This is an example"
+
+# All options
+# params || default value
+params[:path] || "/tmp"
+params[:min_volume] || 20
+params[:max_volume] || 60
+params[:step] || 4
+params[:backlight] || nil # disable check backlight
+params[:language] || "voice_msu_ru_nsh_clunits"
+
+# Declension
+text = @fest.pluraform(2, %w(Сообщение Сообщения Сообщений))
+puts text
+# => "Сообщения"
+```
+
+## Сustomization
+
+```.ruby
+@fest.init(params)
+# check @current_volume
+# @path, @index, @min_volume, @max_volume ...
+
+@fest.check_conditions
+# @fest.check_say_wav
+# check_light и check_home_theater
+
+@fest.check_light # (with xbacklight)
+# exit if backlight equal 0
+
+@fest.check_home_theater
+# exit if run (vlc, kodi(xbmc))
+
+@fest.make_wav(text)
+
+@fest.expect_if_paplay_now
+# wait if paplay active ...
+
+@fest.play_wav
+# @fest.check_optimal_volume (optimize min_volume and max_volume)
+# @fest.turn_down_volume (with @step)
+# @volume = @current_volume - @current_volume / 10 * @step
+# play wav ... with @optimize_volume
+# @fest.return_current_volume (with @step)
+# delete_wav
+```
+
+## Issues
+### Level of loudness doesn't dump after an exit
+
+```.bash
+#!/bin/bash
+
+vlc.run --play-and-exit $*
+amixer set Master 30% > /dev/null 2>&1
+```

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/changelog.org

@@ -1,3 +1,7 @@
+** 1.2.10 (2015-03-11 Ср)
+- say without params
+- attr_accessor params
+- add specs and modules
 ** 1.1.10 (2015-02-21 Сб)
 - fix expect_if_paplay_now
 - translation

data/fest.gemspec

@@ -1,16 +1,21 @@
-Gem::Specification.new do |s|
-  s.name = "fest"
-  s.version = "1.1.10"
-  s.authors = ["Alexsey Ermolaev"]
-  s.email = %q{afay.zangetsu@gmail.com}
-  s.homepage = %q{https://github.com/AfsmNGhr/fest}
-  s.description = %q{Ruby wrapper for festival scripts}
-  s.summary = %q{Ruby wrapper for festival speech engine}
-  s.license = 'MIT'
+Gem::Specification.new do |gem|
+  gem.name = 'fest'
+  gem.version = '1.2.10'
+  gem.authors = 'Alexsey Ermolaev'
+  gem.email = 'afay.zangetsu@gmail.com'
+  gem.homepage = 'https://github.com/AfsmNGhr/fest'
+  gem.description = 'Ruby wrapper for festival scripts'
+  gem.summary = 'Ruby wrapper for festival speech engine'
+  gem.license = 'MIT'
 
-  s.files = `git ls-files`.split("\n")
-  s.require_paths = ["lib"]
+  gem.add_development_dependency 'rake', '~> 0'
+  gem.add_development_dependency 'rspec', '3.2.0'
 
-  s.requirements = ['*nix* or OS X', 'Pulseaudio sound server',
-                    'Festival speech engine', 'xbacklight']
+  gem.files = `git ls-files`.split("\n")
+  gem.require_paths = ['lib']
+  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
+
+  gem.extra_rdoc_files = ['License.org', 'README.md']
+  gem.requirements = ['*nix* or OS X', 'Pulseaudio sound server',
+                      'Festival snpeech engine', 'xbacklight']
 end

data/lib/fest/conditions.rb

@@ -0,0 +1,19 @@
+# coding: utf-8
+#
+module Conditions
+  def check_conditions
+    check_light
+    check_home_theater
+  end
+
+  def check_light
+    exit if @params[:backlight].nil? && `xbacklight`.to_i == 0
+  end
+
+  def check_home_theater
+    xbmc = `ps -el | grep xbmc | wc -l`.to_i
+    vlc = `ps -el | grep vlc | wc -l`.to_i
+    kodi = `ps -el | grep kodi | wc -l`.to_i
+    exit if xbmc > 0 || vlc > 0 || kodi > 0
+  end
+end

data/lib/fest/params.rb

@@ -0,0 +1,32 @@
+# coding: utf-8
+#
+module Params
+  def path
+    @path = @params[:path] || '/tmp'
+  end
+
+  def current_volume
+    @current_volume = `amixer | grep -o '[0-9]*' | sed "5 ! d"`.to_i
+  end
+
+  def index
+    @index = `ls -r #{@path} | grep -o '[0-9]*' | sed "1 ! d"`.to_i
+    @index > 0 ? @index += 1 : @index = 1
+  end
+
+  def min_volume
+    @min_volume = @params[:min_volume] || 20
+  end
+
+  def max_volume
+    @max_volume = @params[:max_volume] || 60
+  end
+
+  def step
+    @step = @params[:step] || 4
+  end
+
+  def language
+    @language = @params[:language] || 'voice_msu_ru_nsh_clunits'
+  end
+end

data/lib/fest/volume.rb

@@ -0,0 +1,45 @@
+# coding: utf-8
+#
+module Volume
+  def check_optimal_volume
+    @volume = @current_volume - @current_volume / 10 * @step
+  end
+
+  def optimize_volume
+    @optimize_volume = (
+    if @current_volume > @max_volume
+      @max_volume
+    elsif @current_volume < @min_volume
+      @min_volume
+    else
+      @current_volume
+    end
+    )
+  end
+
+  def inputs
+    @inputs = `pactl list sink-inputs | grep № | grep -o '[0-9]*'`.split("\n")
+  end
+
+  def turn_down_volume
+    @inputs.each do |input|
+      volume = @current_volume
+      loop do
+        system("pactl set-sink-input-volume #{input} '#{volume * 655}'")
+        volume -= @step
+        break if volume < @volume
+      end
+    end
+  end
+
+  def return_current_volume
+    @inputs.each do |input|
+      volume = @volume
+      loop do
+        system("pactl set-sink-input-volume #{input} '#{volume * 655}'")
+        volume += @step
+        break if volume > @current_volume
+      end
+    end
+  end
+end

data/lib/fest.rb

@@ -1,71 +1,39 @@
 # coding: utf-8
+# Ruby wrapper for Festival speech engine
+# author Alexsey Ermolaev afay.zangetsu@gmail.com
+
+require_relative './fest/params'
+require_relative './fest/volume'
+require_relative './fest/conditions'
 #
 class Fest
-  def say(string, params = {})
-    init(params)
+  include Params
+  include Volume
+  include Conditions
+  attr_accessor :params
+
+  def say(string)
+    init
     check_conditions
     make_wav(string)
     expect_if_paplay_now
-    check_optimal_volume
     play_wav
   end
 
-  def init(params)
-    @params = params
-    @path = @params[:path] || '/tmp'
-    @current_volume = `amixer | grep -o '[0-9]*' | sed "5 ! d"`.to_i
-    @index = `ls -r #{@path} | grep -o '[0-9]*' | sed "1 ! d"`.to_i
-    @min_volume = @params[:down_volume[0]] || 20
-    @max_volume = @params[:down_volume[1]] || 60
-    @step = @params[:down_volume[2]] || 4
-  end
-
-  def check_optimal_volume
-    @volume = @current_volume - @current_volume / 10 * @step
-    optimize_min_and_max_volume
-  end
-
-  def optimize_min_and_max_volume
-    @optimize_volume = (
-    if @current_volume > @max_volume
-      @max_volume
-    elsif @current_volume < @min_volume
-      @min_volume
-    else
-      @current_volume
-    end
-    )
-  end
-
-  def check_conditions
-    check_light
-    check_home_theater
-    check_say_wav
-  end
-
-  def check_light
-    exit if @params[:backlight].nil? && `xbacklight`.to_i == 0
-  end
-
-  def check_home_theater
-    xbmc = `ps -el | grep xbmc | wc -l`.to_i
-    vlc = `ps -el | grep vlc | wc -l`.to_i
-    kodi = `ps -el | grep kodi | wc -l`.to_i
-    exit if xbmc > 0 || vlc > 0 || kodi > 0
-  end
-
-  def check_say_wav
-    @index > 0 ? @index += 1 : @index = 1
+  def init
+    @params ||= {}
+    current_volume
+    min_volume
+    max_volume
+    language
+    index
+    path
+    step
   end
 
   def make_wav(string)
     system("echo '#{string}' | text2wave -o #{@path}/say_#{@index}.wav \
-      -eval '(#{@params[:language] || 'voice_msu_ru_nsh_clunits'})' \
-      > /dev/null 2>&1")
-  end
-
-  def change_volume(volume)
-    system("amixer set Master #{volume}% > /dev/null 2>&1")
+      -eval '(#{@language})' > /dev/null 2>&1")
   end
 
   def expect_if_paplay_now
@@ -75,38 +43,14 @@ class Fest
     end
   end
 
-  def turn_down_volume
-    @inputs = `pactl list sink-inputs | grep № | grep -o '[0-9]*'`.split("\n")
-    @inputs.each do |input|
-      volume = @current_volume
-      loop do
-        system("pactl set-sink-input-volume #{input} '#{volume * 655}'")
-        volume -= @step
-        break if volume < @volume
-      end
-    end
-  end
-
   def play_wav
+    check_optimal_volume
+    optimize_volume
+    inputs
     turn_down_volume
     system("paplay #{@path}/say_#{@index}.wav \
       --volume='#{@optimize_volume * 655}' > /dev/null 2>&1")
     return_current_volume
-    delete_wav
-  end
-
-  def return_current_volume
-    @inputs.each do |input|
-      volume = @volume
-      loop do
-        system("pactl set-sink-input-volume #{input} '#{volume * 655}'")
-        volume += @step
-        break if volume > @current_volume
-      end
-    end
-  end
-
-  def delete_wav
     system("rm -f #{@path}/say_#{@index}.wav")
   end
 

data/spec/custom_params_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+RSpec.describe Fest do
+  before(:each) do
+    @fest = Fest.new
+    @fest.params = {:language => 'cmu_us_slt_arctic_hts',
+                    :min_volume => 30,
+                    :max_volume => 70,
+                    :step => 3,
+                    :path => '~/'}
+  end
+
+  it 'check custom params' do
+    params = {:language => 'cmu_us_slt_arctic_hts',
+              :min_volume => 30,
+              :max_volume => 70,
+              :step => 3,
+              :path => '~/'}
+    expect(@fest.params).to eq(params)
+  end
+
+  it 'check custom path in params' do
+    expect(@fest.path).to eq('~/')
+  end
+
+  it 'check custom min volume' do
+    expect(@fest.min_volume).to eq(30)
+  end
+
+  it 'check custom max volume' do
+    expect(@fest.max_volume).to eq(70)
+  end
+
+  it 'check custom step' do
+    expect(@fest.step).to eq(3)
+  end
+
+  it 'check custom language' do
+    expect(@fest.language).to eq('cmu_us_slt_arctic_hts')
+  end
+end

data/spec/default_params_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+RSpec.describe Fest do
+  before(:each) do
+    @fest = Fest.new
+    @fest.params = {}
+  end
+
+  it 'check default params' do
+    expect(@fest.params).to eq({})
+  end
+
+  it 'check default path' do
+    expect(@fest.path).to eq('/tmp')
+  end
+
+  it 'check current volume' do
+    vol = `amixer | grep -o '[0-9]*' | sed "5 ! d"`.to_i
+    expect(@fest.current_volume).to eq(vol)
+  end
+
+  it 'check index' do
+    i = `ls -r #{@path} | grep -o '[0-9]*' | sed "1 ! d"`.to_i
+    expect(@fest.index).not_to eq(i)
+  end
+
+  it 'check default min volume' do
+    expect(@fest.min_volume).to eq(20)
+  end
+
+  it 'check default max volume' do
+    expect(@fest.max_volume).to eq(60)
+  end
+
+  it 'check default step' do
+    expect(@fest.step).to eq(4)
+  end
+
+  it 'check default language' do
+    expect(@fest.language).to eq('voice_msu_ru_nsh_clunits')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+# coding: utf-8
+require_relative '../lib/fest'
+require 'coveralls'
+require 'rspec'
+
+Coveralls.wear!

metadata

@@ -1,28 +1,66 @@
 --- !ruby/object:Gem::Specification
 name: fest
 version: !ruby/object:Gem::Version
-  version: 1.1.10
+  version: 1.2.10
 platform: ruby
 authors:
 - Alexsey Ermolaev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-21 00:00:00.000000000 Z
-dependencies: []
+date: 2015-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
 description: Ruby wrapper for festival scripts
 email: afay.zangetsu@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- License.org
+- README.md
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
-- MIT-license.org
-- README.org
+- License.org
+- README.md
+- Rakefile
 - changelog.org
 - fest.gemspec
 - lib/fest.rb
+- lib/fest/conditions.rb
+- lib/fest/params.rb
+- lib/fest/volume.rb
+- spec/custom_params_spec.rb
+- spec/default_params_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/AfsmNGhr/fest
 licenses:
 - MIT
@@ -44,12 +82,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - "*nix* or OS X"
 - Pulseaudio sound server
-- Festival speech engine
+- Festival snpeech engine
 - xbacklight
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for festival speech engine
-test_files: []
+test_files:
+- spec/custom_params_spec.rb
+- spec/default_params_spec.rb
+- spec/spec_helper.rb
 has_rdoc: 

data/README.org

@@ -1,88 +0,0 @@
-** FEST
-Ruby wrapper use [[https://wiki.archlinux.org/index.php/Festival_%28%D0%A0%D1%83%D1%81%D1%81%D0%BA%D0%B8%D0%B9%29][Festival]] for speak of the text and scripts ...
-** Requirements
-- *nix* or OS X ...
-- [[https://wiki.archlinux.org/index.php/Festival_%28%D0%A0%D1%83%D1%81%D1%81%D0%BA%D0%B8%D0%B9%29][Festival]] and necessary languages ...
-- [[https://wiki.archlinux.org/index.php/PulseAudio_%28%D0%A0%D1%83%D1%81%D1%81%D0%BA%D0%B8%D0%B9%29][Pulseaudio]]
-- xbacklight ([[https://wiki.archlinux.org/index.php/Backlight_%28%D0%A0%D1%83%D1%81%D1%81%D0%BA%D0%B8%D0%B9%29][backlight]])
-** Установка
-#+begin_src ruby
-# Gemfile
-gem 'fest'
-#+end_src
-or
-#+begin_src ruby
-$ gem install fest
-#+end_src
-** Used
-***** Call methods
-#+begin_src ruby
-require 'fest'
-
-@fest = Fest.new
-text = "Пример"
-@fest.say(text)
-# => Say "Пример"
-
-# Expanded option
-params = {:language => "cmu_us_slt_arctic_hts"}
-text = "This is an example"
-@fest.say(text, params)
-# => Say "This is an example" ...
-
-# All options
-# params || default value
-params[:path] || "/tmp"
-params[:down_volume] || [20,60,4] # [min, max, step]
-params[:backlight] || nil # disable check backlight
-params[:language] || "voice_msu_ru_nsh_clunits"
-
-# Declension
-text = @fest.pluraform(2, %w(Сообщение Сообщения Сообщений))
-puts text
-# => "Сообщения"
-#+end_src
-
-** Сustomization
-#+begin_src ruby
-@fest.init(params)
-# check @current_volume
-# @path, @index, @min_volume, @max_volume ...
-
-@fest.check_optimal_volume
-# @volume = @current_volume - @down_volume
-
-@fest.optimize_min_and_max_volume(min_volume, max_volume)
-
-@fest.check_conditions
-# @fest.check_say_wav
-# check_light и check_home_theater
-
-@fest.check_light # (with xbacklight)
-# exit if backlight equal 0
-
-@fest.check_home_theater
-# exit if run (vlc, kodi(xbmc))
-
-@fest.make_wav(text)
-
-@fest.change_volume(volume)
-
-@fest.expect_if_paplay_now
-# wait if paplay active ...
-
-@fest.play_wav
-# @fest.turn_down_volume (with @step)
-# @volume = @current_volume - @current_volume / 10 * @step
-# play wav ... with @optimize_volume
-# @fest.return_current_volume (with @step)
-# @fest.delete_wav
-#+end_src
-** Issues
-***** Level of loudness doesn't dump after an exit
-#+begin_src bash
-#!/bin/bash
-
-vlc.run --play-and-exit $*
-amixer set Master 30% > /dev/null 2>&1
-#+end_src