talks 0.2.0 → 0.3.0

data/.gitignore

@@ -0,0 +1 @@
+coverage/

data/.travis.yml

@@ -8,4 +8,4 @@ rvm:
   - rbx-18mode
   - rbx-19mode
 # uncomment this line if your project needs to run something other than `rake`:
-# script: bundle exec rspec spec
+ script: rake 

data/README.md

@@ -1,21 +1,33 @@
 # Talks gem — now your ruby and command-line tools can talk with you
 
-### This is beta now.
-
 ### 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 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).
+You can use this gem on MacOS X and on other linux/unix systems with [espeak](http://espeak.sourceforge.net) installed.
+
+Now with support for notifiers through [notifier](https://github.com/fnando/notifier) gem!
+Check the notifier's
+[README](https://github.com/fnando/notifier/blob/master/README.rdoc) and
+find what notifier you want to use - there is support for every OS!
+
+I added in all sections of this readme notes about usage notifier
+functionality.
 
 Sponsored by Evil Martians <http://evilmartians.com>
 
 ## Why?
 
-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 or from `espeak` collection.
+### Example
+
+You're running some really long task and you leave the desk to drink some coffee, read a book or surf the internet
+and you want to be notified that the task has finished its execution. You don't want to check your machine each minute. With this gem
+you can just add a little hook at the end of your code and when the execution ends - you will hear it in voice
+that you have chosen from MacOS X `say` function collection or from `espeak` collection.
+
+Now if you forgot power on you sound on machine you can always see
+notifications by notifiers like Growl, Kdialog, Knotify, etc. Full list of notifiers is
+[here](https://github.com/fnando/notifier/blob/master/README.rdoc).
 
 You can find some examples of `talks` usage in organization [ruby-talks](https://github.com/ruby-talks):
 
@@ -25,10 +37,12 @@ You can find some examples of `talks` usage in organization [ruby-talks](https:/
 
 ## How?
 
-On MacOS X this gem just using native MacOS X `say` command line tool.
-On linix/unix this gem using espeak speech synthesis.
+On MacOS X this gem is just using the native MacOS X `say` command line tool.
+On linix/unix this gem is using espeak speech synthesis.
+
+For notifications this gem uses [notifier](https://github.com/fnando/notifier/blob/master/README.rdoc) gem.
 
-### 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)
+### In all examples below I've 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
 
@@ -38,6 +52,7 @@ You can configure default voices and messages for `talks` with `~/.talksrc` file
 ```yml
 default_voice: 'whisper'
 engine: 'say'
+notifier: 'off' # if this option passed - you will not receive notifications at all
 voices:
   info: 'pipe'
 messages:
@@ -45,8 +60,9 @@ messages:
   warn: 'WE GONNA DIE!!!'
 ```
 
-The same you can do in your code dynamicly through Talks.config instance.
-You can configure now only default voice for `say` method and voices and messages for 4 types of talks: `info, warn, success, error`
+You can also do it in your code dynamically through Talks.config instance.
+
+You can configure only the default voice for `say` method and voices and messages for 4 types of talks: `info, warn, success, error`
 
 For command-line commands you can configure default voices and hook messages:
 
@@ -56,6 +72,9 @@ bundle:
   voice: 'vicki'
   before_message: 'Bundler again will do all right'
   after_message: "Bundler's job is done here"
+  before_notify: 'This will go to notification before `before_message`'
+  after_notify: 'This will go to notification after `after_message`'
+# notifier: 'off' # this option will turn off notifications for this command
 ```
 
 You can create your own default preferences for each command-line tool which you want to run with `talks` or `talking` command in front:
@@ -65,7 +84,10 @@ You can create your own default preferences for each command-line tool which you
 ls:
   voice: 'bad'
   before_message: 'Now we will see what in the directory'
-  after_message: ''
+  after_message: '.'
+  before_notify: 'This will go to notification before `before_message`'
+  after_notify: 'This will go to notification after `after_message`'
+# notifier: 'off' # this option will turn off notifications for this command
 cap:
   ...
 vim:
@@ -84,13 +106,20 @@ $ talking bundle install
 ```
 
 After that `talks` will wrap execution of this command with voice messages. By default messages will be like 'command_name task started/ended'.
-You can preconfigure messages in your `~/.talksrc` file or you can send options right in talking command:
+You can preconfigure messages in your `~/.talksrc` file or you can send options right in the talking command:
 
 ```bash
 $ talking -v agnes -bm 'We gonna die!' -am 'Not sure if we can hear that' rm -rf ./
 # the same
 $ talking --voice agnes --before-message 'We...' --after-message 'Not...' rm -rf ./
 ```
+The same with notifications:
+
+```bash
+$ talking -v agnes -bn 'We gonna die!' -an 'Not sure if we can hear that' rm -rf ./
+# the same
+$ talking --voice agnes --before-notify 'We...' --after-notify 'Not...' rm -rf ./
+```
 
 ### Using talks in your code
 
@@ -110,16 +139,17 @@ Talks.info 'This is info'
 # Talks.warn 'Some text'
 # Talks.success 'Some text'
 # Talks.error 'Some text'
+Talks.notify 'This will be shown to you by your notifier'
 ```
 
-`Talks.say` can be customized with type of message and voice by adding options to executing this method:
+`Talks.say` can be customized with type of message and voice by adding options to this method parameters:
 
 ```ruby
 Talks.say 'Hello like pipe', voice: 'pipe'
 Talks.say 'Hello like error', type: :error # the same as using Talks.error
 ```
 
-All voices which I found in manual for `say`:
+All voices which I've found in `say` manual:
 ```ruby
 VOICES = %w(
   agnes albert alex bad bahh bells boing bruce bubbles cellos
@@ -130,16 +160,16 @@ VOICES = %w(
 
 ### Using talks with espeak
 
-You can configure your `talks` usage even on MacOS X for using [espeak](http://espeak.sourceforge.net):
+You can configure your `talks` engine even to tell MacOS X to use [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.
+Otherwise `talks` will set engine by default. It will be set to `say` on MacOS X and to `espeak` on all other OS-es if command `which espeak` returns non-empty string.
 
-For espeak you have different set of voices and many languages (which this gem not support yet). Voices for espeak:
+You can even configure your language in espeak (this gem still doesn't support different languages). Voices for espeak:
 
 ```ruby
 Talks.voices[:espeak]
@@ -152,7 +182,7 @@ Talks.voices[:espeak]
 
 ## Who?
 
-I did it by myself
+I did it myself.
 
 ### Contributors
 
@@ -160,11 +190,15 @@ I did it by myself
 
 ### A lot of thanks
 
-  * @aderyabin - idea of extended customization of talks is his.
+  * @kossnocorp - for idea with notifiers.
+
+  * @shime - for grammar fixes in readme and better explanation of my idea.
+
+  * @aderyabin - extended customization of talks is his idea.
 
-  * @brainopia - bro helps me with any my idea. He adviced me to do command line tool talks.
+  * @brainopia - bro helps me with any idea of mine. He advised me to do command line tool talks.
 
-You can help me with this fun gem and I'll gladly add you here, or above
+You can help me with this fun gem and I'll gladly add you here, or above.
 
 ## License
 

data/bin/talking

@@ -7,4 +7,4 @@ require 'talks'
 command = (ARGV.first == 'talks' ? ARGV[1..-1] : ARGV)
 command_with_hooks = Talks.add_hooks command
 
-exec command_with_hooks
+Talks.execute command_with_hooks

data/lib/talks.rb

@@ -1,8 +1,9 @@
 require File.expand_path('../talks/configuration.rb', __FILE__)
 require File.expand_path('../talks/hooks.rb', __FILE__)
+require 'notifier'
 
 module Talks
-  class << self
+  extend self
 
     VOICES = {
       :say => %w(
@@ -35,10 +36,21 @@ module Talks
       when 'espeak'
         `espeak -v #{say_voice(type, options)} '#{message}'`
       else
-        abort "Don't know that engine now: #{config.engine}"
+        abort "Undefined engine: #{config.engine}"
       end
     end
 
+    def notify(message, options = {})
+      Notifier.notify message: message, title: 'Talks', image: ''
+    end
+
+    def execute(command)
+      before_notify, command, after_notify = command
+      Talks.notify before_notify if before_notify
+      system command
+      Talks.notify after_notify if after_notify
+    end
+
     def add_hooks(command)
       Talks::Hooks.create command
     end
@@ -62,7 +74,6 @@ module Talks
       end
     end
 
-  end
 end
 
 require File.expand_path('../talks/runner.rb', __FILE__)

data/lib/talks/configuration.rb

@@ -11,10 +11,10 @@ module Talks
         :error   => 'bad'
       },
       :espeak => {
-        :info    => 'english',
-        :warn    => 'english',
-        :success => 'english',
-        :error   => 'english'
+        :info    => 'en+f3',
+        :warn    => 'en+m1',
+        :success => 'en+f3',
+        :error   => 'en+m3'
       }
     }
 
@@ -25,7 +25,7 @@ module Talks
       :error   => 'Error'
     }
 
-    attr_accessor :voices, :messages, :default_voice, :options, :engine
+    attr_accessor :voices, :messages, :default_voice, :options, :engine, :notifier
 
     def initialize(opts)
       @options = symbolize_hash_keys(opts)
@@ -59,6 +59,19 @@ module Talks
         options[command][(position == :before ? :before_message : :after_message)]
     end
 
+    def notifier_for(command_name)
+      command = command_name.to_sym
+      (options[:notifier] != 'off') &&
+        options[command] &&
+        (options[command][:notifier] != 'off')
+    end
+
+    def notify_message_for(command_name, position = :after)
+      command = command_name.to_sym
+      options[command] &&
+        options[command][(position == :before ? :before_notify : :after_notify)]
+    end
+
     def voice_for(command_name)
       command = command_name.to_sym
       options[command] &&
@@ -84,7 +97,7 @@ module Talks
       elsif !(`which espeak`.empty?)
         'espeak'
       else
-        abort 'Now talks can work only on MacOS X, you can help with support other OS'
+        abort 'Talks is supported on Mac OS X and linux only, but you can help with support for other OSes'
       end
     end
 

data/lib/talks/hooks.rb

@@ -6,13 +6,14 @@ module Talks
         engine = Talks.config.engine
         options, args = shift_options(args.dup)
         command_name = command args
-        voice, before_message, after_message = parse options, command_name
+        voice, before_message, after_message, before_notify, after_notify = \
+          parse options, command_name
 
         before_hook = hook(engine, voice, before_message)
         after_hook = hook(engine, voice, after_message)
         command = args.join(' ')
 
-        [before_hook, command, after_hook].join('; ')
+        [before_notify, [before_hook, command, after_hook].join('; '), after_notify]
       end
 
       private
@@ -50,7 +51,21 @@ module Talks
           Talks.config.message_for(command_name, :after) ||
           Talks.config.default_message_for(command_name, :after)
 
-        [voice, before_message, after_message]
+        before_notify = Talks.config.notifier_for(command_name) &&
+          (
+            options['-bn'] || options['--before-notify'] ||
+            Talks.config.notify_message_for(command_name, :before) ||
+            Talks.config.default_message_for(command_name, :before)
+          )
+
+        after_notify = Talks.config.notifier_for(command_name) &&
+          (
+            options['-an'] || options['--after-notify'] ||
+            Talks.config.notify_message_for(command_name, :after) ||
+            Talks.config.default_message_for(command_name, :after)
+          )
+
+        [voice, before_message, after_message, before_notify, after_notify]
       end
 
       def hook(engine, voice, message)

data/lib/talks/version.rb

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

data/spec/talks/basic_spec.rb

@@ -1,6 +1,13 @@
+require 'simplecov'
+SimpleCov.start
+
 OPTS_INITFILE = 'spec/test_data/talksrc'
 require 'talks'
 
+def talk_command
+  Talks.config.engine
+end
+
 describe Talks do
 
   it 'should have default methods' do
@@ -25,7 +32,8 @@ describe Talks do
     end
 
     it 'should return voice for type' do
-      Talks.config.voice(:info).should == 'vicki'
+      Talks.config.voice(:info).should == 'vicki' if talk_command == 'say'
+      Talks.config.voice(:info).should == 'en+f3' if talk_command == 'espeak'
     end
 
     it 'should return message for type' do
@@ -51,24 +59,24 @@ describe Talks do
   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'"
+      Talks.add_hooks(['ls']).should == "#{talk_command} -v agnes 'ls task started'; ls; #{talk_command} -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'"
+      Talks.add_hooks(['bundle']).should == "#{talk_command} -v bad 'Bundle before message'; bundle; #{talk_command} -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'"
+      Talks.add_hooks(['-v', 'vicki', 'ls']).should == "#{talk_command} -v vicki 'ls task started'; ls; #{talk_command} -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'"
+      Talks.add_hooks(['-bm', 'test', 'ls']).should == "#{talk_command} -v agnes 'test'; ls; #{talk_command} -v agnes 'ls task ended'"
+      Talks.add_hooks(['-am', 'test', 'ls']).should == "#{talk_command} -v agnes 'ls task started'; ls; #{talk_command} -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'"
+      Talks.add_hooks(['bundle', 'exec', 'ls']).should == "#{talk_command} -v agnes 'ls task started'; bundle exec ls; #{talk_command} -v agnes 'ls task ended'"
     end
 
   end

data/talks.gemspec

@@ -14,6 +14,11 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "talks"
 
+  s.add_dependency("notifier")
+
+  s.add_development_dependency("rspec")
+  s.add_development_dependency("simplecov")
+
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: talks
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,56 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-26 00:00:00.000000000 Z
-dependencies: []
+date: 2012-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: notifier
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 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:
@@ -21,6 +69,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - .travis.yml
 - CHANGELOG.md
 - Gemfile