talks 0.1.0 → 0.2.0

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode
+# uncomment this line if your project needs to run something other than `rake`:
+# script: bundle exec rspec spec

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 0.2.0
+
+  * Added espeak support
+
 ## 0.1.0
 
   * Added bin command for wrap your commandline commands with talks hooks (@brainopia)

data/Gemfile

@@ -2,3 +2,5 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in gon.gemspec
 gemspec
+
+gem 'rake'

data/README.md

@@ -1,10 +1,12 @@
-# Talks gem — now your ruby can talk with you
+# Talks gem — now your ruby and command-line tools can talk with you
 
-### Now it works only on MacOS X, soon we'll add support for linux and maybe windows through eSpeak or festival
+### This is beta now.
 
-### This is beta now. Specs are really needed.
+### Build Status ![http://travis-ci.org/ruby-talks/talks](https://secure.travis-ci.org/ruby-talks/talks.png)
 
-If you want to HEAR some response from your code, just use this gem.
+If you want to HEAR some response from your code or command-line tools, just use this gem.
+
+You can use this gem on MacOS X and on other linux/unix systems with installed [espeak](http://espeak.sourceforge.net).
 
 Sponsored by Evil Martians <http://evilmartians.com>
 
@@ -13,7 +15,7 @@ Sponsored by Evil Martians <http://evilmartians.com>
 For example - some really long task and you just get some coffee, read book or surf internet
 and you want to know when this task will ends, but don't want to check your mac or terminal each minute -
 you can just add small hook in the end of your code and when it will ends - you will hear it with voice that you
-choose from MacOS X `say` function collection.
+choose from MacOS X `say` function collection or from `espeak` collection.
 
 You can find some examples of `talks` usage in organization [ruby-talks](https://github.com/ruby-talks):
 
@@ -23,7 +25,10 @@ You can find some examples of `talks` usage in organization [ruby-talks](https:/
 
 ## How?
 
-This gem just using native MacOS X `say` command line tool.
+On MacOS X this gem just using native MacOS X `say` command line tool.
+On linix/unix this gem using espeak speech synthesis.
+
+### In all examples below I used MacOS X voice types. For espeak you can read section [Using talks with espeak](https://github.com/ruby-talks/talks#using-talks-with-espeak)
 
 ### Configuration
 
@@ -32,6 +37,7 @@ You can configure default voices and messages for `talks` with `~/.talksrc` file
 `~/.talksrc`
 ```yml
 default_voice: 'whisper'
+engine: 'say'
 voices:
   info: 'pipe'
 messages:
@@ -122,6 +128,28 @@ VOICES = %w(
 )
 ```
 
+### Using talks with espeak
+
+You can configure your `talks` usage even on MacOS X for using [espeak](http://espeak.sourceforge.net):
+
+`~/.talksrc`
+```yml
+engine: 'espeak'
+```
+
+Otherwise `talks` will set engine by default to `say` on MacOS X and to `espeak` on all other OS if command `which espeak` returns something than empty string.
+
+For espeak you have different set of voices and many languages (which this gem not support yet). Voices for espeak:
+
+```ruby
+Talks.voices[:espeak]
+# =>
+  [
+    'en+m1', 'en+m2', 'en+m3', 'en+m4', 'en+m5', 'en+m6', 'en+m7',
+    'en+f1', 'en+f2', 'en+f3', 'en+f4', 'en+f5', 'en+f6', 'en+f7'
+  ]
+```
+
 ## Who?
 
 I did it by myself

data/Rakefile

@@ -7,3 +7,32 @@ desc 'Run all tests by default'
 task :default do
   system("rspec spec")
 end
+
+desc 'Run if you want to hear all types of Talks.say'
+task :all do
+  require File.expand_path('../lib/talks.rb', __FILE__)
+
+  Talks.voices.each do |v|
+    p v
+    Talks.say 'Tests start', :voice => v
+  end
+
+  p 'say `say`'
+  Talks.say 'say'
+  p 'info `say again`'
+  Talks.info 'say again'
+  p 'warn `I warn you`'
+  Talks.warn 'I warn you'
+  p 'error `This is how error sounds`'
+  Talks.error 'This is how error sounds'
+  p 'success `This is success!`'
+  Talks.success 'This is success!'
+  p 'info `default`'
+  Talks.info
+  p 'warn `default`'
+  Talks.warn
+  p 'warn `error`'
+  Talks.error
+  p 'warn `success`'
+  Talks.success
+end

data/lib/talks.rb

@@ -4,11 +4,16 @@ require File.expand_path('../talks/hooks.rb', __FILE__)
 module Talks
   class << self
 
-    VOICES = %w(
-      agnes albert alex bad bahh bells boing bruce bubbles cellos
-      deranged fred good hysterical junior kathy pipe princess ralph
-      trinoids vicki victoria whisper zarvox
-    )
+    VOICES = {
+      :say => %w(
+        agnes albert alex bad bahh bells boing bruce bubbles cellos
+        deranged fred good hysterical junior kathy pipe princess ralph
+        trinoids vicki victoria whisper zarvox
+      ),
+      :espeak => %w(en+m1 en+m2 en+m3 en+m4 en+m5 en+m6 en+m7
+        en+f1 en+f2 en+f3 en+f4 en+f5 en+f6 en+f7
+      )
+    }
 
     TYPES = [:info, :warn, :success, :error]
 
@@ -24,7 +29,14 @@ module Talks
 
     def say(message, options = {})
       type = options[:type] || :default
-      `say -v #{say_voice(type, options)} #{message}`
+      case config.engine
+      when 'say'
+        `say -v #{say_voice(type, options)} '#{message}'`
+      when 'espeak'
+        `espeak -v #{say_voice(type, options)} '#{message}'`
+      else
+        abort "Don't know that engine now: #{config.engine}"
+      end
     end
 
     def add_hooks(command)
@@ -41,7 +53,7 @@ module Talks
     private
 
     def say_voice(type, options)
-      if options[:voice] and VOICES.include?(options[:voice].to_s)
+      if options[:voice] and VOICES[config.engine.to_sym].include?(options[:voice].to_s)
         options[:voice]
       elsif TYPES.include? type
         config.voice type

data/lib/talks/configuration.rb

@@ -4,26 +4,35 @@ module Talks
   class Configuration
 
     DEFAULT_VOICES = {
-      info: 'vicki',
-      warn: 'whisper',
-      success: 'vicki',
-      error: 'bad'
+      :say => {
+        :info    => 'vicki',
+        :warn    => 'whisper',
+        :success => 'vicki',
+        :error   => 'bad'
+      },
+      :espeak => {
+        :info    => 'english',
+        :warn    => 'english',
+        :success => 'english',
+        :error   => 'english'
+      }
     }
 
     DEFAULT_MESSAGES = {
-      info: 'Information note',
-      warn: 'Warning',
-      success: 'Success',
-      error: 'Error'
+      :info    => 'Information note',
+      :warn    => 'Warning',
+      :success => 'Success',
+      :error   => 'Error'
     }
 
-    attr_accessor :voices, :messages, :default_voice, :options
+    attr_accessor :voices, :messages, :default_voice, :options, :engine
 
     def initialize(opts)
       @options = symbolize_hash_keys(opts)
-      @default_voice = options[:default_voice] || 'vicki'
-      @voices = options[:voices] && DEFAULT_VOICES.merge(options[:voices]) ||
-        DEFAULT_VOICES
+      @engine = options[:engine] || default_engine_for_os
+      @default_voice = options[:default_voice] || default_voice_for(engine)
+      @voices = options[:voices] && DEFAULT_VOICES[engine.to_sym].merge(options[:voices]) ||
+        DEFAULT_VOICES[engine.to_sym]
       @messages = options[:messages] && DEFAULT_MESSAGES.merge(options[:messages]) ||
         DEFAULT_MESSAGES
     end
@@ -58,6 +67,27 @@ module Talks
 
     private
 
+    def default_voice_for(talks_engine)
+      case talks_engine
+      when 'say'
+        'vicki'
+      when 'espeak'
+        'en+f3'
+      else
+        abort "Don't know this engine now: #{talks_engine}"
+      end
+    end
+
+    def default_engine_for_os
+      if RUBY_PLATFORM =~ /darwin/i
+        'say'
+      elsif !(`which espeak`.empty?)
+        'espeak'
+      else
+        abort 'Now talks can work only on MacOS X, you can help with support other OS'
+      end
+    end
+
     def symbolize_hash_keys(opts)
       sym_opts = {}
       opts.each do |key, value|

data/lib/talks/hooks.rb

@@ -3,7 +3,7 @@ module Talks
     class << self
 
       def create(args)
-        engine = check_engine
+        engine = Talks.config.engine
         options, args = shift_options(args.dup)
         command_name = command args
         voice, before_message, after_message = parse options, command_name
@@ -37,14 +37,6 @@ module Talks
         end
       end
 
-      def check_engine
-        if RUBY_PLATFORM =~ /darwin/i
-          'say'
-        else
-          abort 'Now talks can work only on MacOS X, you can help with support other OS'
-        end
-      end
-
       def parse(options, command_name)
         voice = options['-v'] || options['--voice'] ||
           Talks.config.voice_for(command_name.to_sym) ||
@@ -62,11 +54,7 @@ module Talks
       end
 
       def hook(engine, voice, message)
-        if engine == 'say'
-          "say #{message} -v #{voice}"
-        else
-          abort 'Now you can use talks gem only on mac with say'
-        end
+        "#{engine} -v #{voice} '#{message}'"
       end
 
     end

data/lib/talks/runner.rb

@@ -1,7 +1,9 @@
 # What file is used for talks startup configuration.
 initfile = if File.exists?('./.talksrc')
   './.talksrc'
-elsif !defined?(OPTS_INITFILE)
+elsif defined?(OPTS_INITFILE)
+  OPTS_INITFILE
+else
   if RUBY_PLATFORM =~ /mswin/
     # Of course MS Windows has to be different
     OPTS_INITFILE = 'talks.ini'

data/lib/talks/version.rb

@@ -1,3 +1,3 @@
 module Talks
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/talks/basic_spec.rb

@@ -0,0 +1,76 @@
+OPTS_INITFILE = 'spec/test_data/talksrc'
+require 'talks'
+
+describe Talks do
+
+  it 'should have default methods' do
+    [:add_hooks, :info, :error, :success, :warn, :say, :config].each do |method|
+      Talks.methods.include?(method).should be_true
+    end
+  end
+
+  describe '#config' do
+
+    it 'should load initfile' do
+      Talks.config.options.should_not be_empty
+    end
+
+    it 'should load default values from initfile' do
+      Talks.config.default_voice.should == 'agnes'
+    end
+
+    it 'should contain default values for voices and messages' do
+      Talks.config.voices.keys.should_not be_empty
+      Talks.config.messages.keys.should_not be_empty
+    end
+
+    it 'should return voice for type' do
+      Talks.config.voice(:info).should == 'vicki'
+    end
+
+    it 'should return message for type' do
+      Talks.config.message(:info).should == 'Information note'
+    end
+
+    it 'should return message for command if it is in .talksrc' do
+      Talks.config.message_for(:bundle, :before).should == 'Bundle before message'
+      Talks.config.message_for(:bundle, :after).should == 'Bundle after message'
+    end
+
+    it 'should return voice for command if it is in .talksrc' do
+      Talks.config.voice_for(:bundle).should == 'bad'
+    end
+
+    it 'should return default message for command' do
+      Talks.config.default_message_for(:bundle, :before).should == 'bundle task started'
+      Talks.config.default_message_for(:bundle, :after).should == 'bundle task ended'
+    end
+
+  end
+
+  context 'hooks' do
+
+    it 'should create hooks for any command by default' do
+      Talks.add_hooks(['ls']).should == "say -v agnes 'ls task started'; ls; say -v agnes 'ls task ended'"
+    end
+
+    it 'should create preconfigured hooks for command from .talksrc' do
+      Talks.add_hooks(['bundle']).should == "say -v bad 'Bundle before message'; bundle; say -v bad 'Bundle after message'"
+    end
+
+    it 'should change voice if option sended' do
+      Talks.add_hooks(['-v', 'vicki', 'ls']).should == "say -v vicki 'ls task started'; ls; say -v vicki 'ls task ended'"
+    end
+
+    it 'should change messages if option sended' do
+      Talks.add_hooks(['-bm', 'test', 'ls']).should == "say -v agnes 'test'; ls; say -v agnes 'ls task ended'"
+      Talks.add_hooks(['-am', 'test', 'ls']).should == "say -v agnes 'ls task started'; ls; say -v agnes 'test'"
+    end
+
+    it 'should create hooks for command inside `bundle exec` by default' do
+      Talks.add_hooks(['bundle', 'exec', 'ls']).should == "say -v agnes 'ls task started'; bundle exec ls; say -v agnes 'ls task ended'"
+    end
+
+  end
+
+end

data/spec/test_data/talksrc

@@ -0,0 +1,5 @@
+default_voice: 'agnes'
+bundle:
+  voice: 'bad'
+  before_message: 'Bundle before message'
+  after_message: 'Bundle after message'

data/talks.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['gazay']
   s.email       = ['alex.gaziev@gmail.com']
-  s.homepage    = "https://github.com/gazay/talks"
-  s.summary     = %q{Simple gem for `say` function of mac os x}
-  s.description = %q{Simple gem for `say` function of mac os x}
+  s.homepage    = "https://github.com/ruby-talks/talks"
+  s.summary     = %q{Gem for talking ruby code and command-line tools}
+  s.description = %q{This gem can be used for wraping command-lines with `talks` command or for adding hooks in ruby code which would tell you something}
 
   s.rubyforge_project = "talks"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: talks
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,9 +9,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-24 00:00:00.000000000 Z
+date: 2012-05-26 00:00:00.000000000 Z
 dependencies: []
-description: Simple gem for `say` function of mac os x
+description: This gem can be used for wraping command-lines with `talks` command or
+  for adding hooks in ruby code which would tell you something
 email:
 - alex.gaziev@gmail.com
 executables:
@@ -20,6 +21,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - README.md
@@ -31,9 +33,10 @@ files:
 - lib/talks/hooks.rb
 - lib/talks/runner.rb
 - lib/talks/version.rb
-- spec/talks.rb
+- spec/talks/basic_spec.rb
+- spec/test_data/talksrc
 - talks.gemspec
-homepage: https://github.com/gazay/talks
+homepage: https://github.com/ruby-talks/talks
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -56,6 +59,7 @@ rubyforge_project: talks
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Simple gem for `say` function of mac os x
+summary: Gem for talking ruby code and command-line tools
 test_files:
-- spec/talks.rb
+- spec/talks/basic_spec.rb
+- spec/test_data/talksrc

data/spec/talks.rb

@@ -1,25 +0,0 @@
-require File.expand_path('../../lib/talks.rb', __FILE__)
-
-Talks.voices.each do |v|
-  p v
-  Talks.say 'Tests start', voice: v
-end
-
-p 'say `say`'
-Talks.say 'say'
-p 'info `say again`'
-Talks.info 'say again'
-p 'warn `I warn you`'
-Talks.warn 'I warn you'
-p 'error `This is how error sounds`'
-Talks.error 'This is how error sounds'
-p 'success `This is success!`'
-Talks.success 'This is success!'
-p 'info `default`'
-Talks.info
-p 'warn `default`'
-Talks.warn
-p 'warn `error`'
-Talks.error
-p 'warn `success`'
-Talks.success