talks 0.0.5 → 0.1.0

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 0.1.0
+
+  * Added bin command for wrap your commandline commands with talks hooks (@brainopia)
+
 ## 0.0.5
 
   * Added customization through your_project_folder/.talksrc file

data/README.md

@@ -2,7 +2,7 @@
 
 ### 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.
 
 If you want to HEAR some response from your code, just use this gem.
 
@@ -15,6 +15,12 @@ and you want to know when this task will ends, but don't want to check your mac
 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.
 
+You can find some examples of `talks` usage in organization [ruby-talks](https://github.com/ruby-talks):
+
+  * [rails-talks](https://github.com/ruby-talks/rails-talks)
+  * [bundler-talks](https://github.com/ruby-talks/bundler-talks)
+  * [spec-talks](https://github.com/ruby-talks/spec-talks)
+
 ## How?
 
 This gem just using native MacOS X `say` command line tool.
@@ -36,6 +42,50 @@ messages:
 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`
 
+For command-line commands you can configure default voices and hook messages:
+
+`~/.talksrc`
+```yml
+bundle:
+  voice: 'vicki'
+  before_message: 'Bundler again will do all right'
+  after_message: "Bundler's job is done here"
+```
+
+You can create your own default preferences for each command-line tool which you want to run with `talks` or `talking` command in front:
+
+`~/.talksrc`
+```yml
+ls:
+  voice: 'bad'
+  before_message: 'Now we will see what in the directory'
+  after_message: ''
+cap:
+  ...
+vim:
+  ...
+scp:
+  ...
+... and etc
+```
+
+### Using talks/talking command-line tool
+
+`talks` or `talking` command-line tool wrap your command-line commands with talks hooks:
+
+```bash
+$ 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:
+
+```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 ./
+```
+
 ### Using talks in your code
 
 ```bash
@@ -74,14 +124,18 @@ VOICES = %w(
 
 ## Who?
 
-I did it myself
+I did it by myself
 
 ### Contributors
 
-* @gazay
+  * @gazay
 
 ### A lot of thanks
 
+  * @aderyabin - idea of extended customization of talks is his.
+
+  * @brainopia - bro helps me with any my idea. He adviced me to do command line tool talks.
+
 You can help me with this fun gem and I'll gladly add you here, or above
 
 ## License

data/bin/talking

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+talks_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(talks_dir) unless $LOAD_PATH.include?(talks_dir)
+require 'talks'
+
+command = (ARGV.first == 'talks' ? ARGV[1..-1] : ARGV)
+command_with_hooks = Talks.add_hooks command
+
+exec command_with_hooks

data/bin/talks

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+exec "talking #{ARGV.join(' ')}"

data/lib/talks.rb

@@ -1,4 +1,5 @@
 require File.expand_path('../talks/configuration.rb', __FILE__)
+require File.expand_path('../talks/hooks.rb', __FILE__)
 
 module Talks
   class << self
@@ -26,6 +27,10 @@ module Talks
       `say -v #{say_voice(type, options)} #{message}`
     end
 
+    def add_hooks(command)
+      Talks::Hooks.create command
+    end
+
     TYPES.each do |type|
       define_method type do |message = nil, options = {type: type}|
         message ||= config.message(type)

data/lib/talks/configuration.rb

@@ -40,6 +40,22 @@ module Talks
       [message(type), voice(type)]
     end
 
+    def default_message_for(command_name, position = :after)
+      "#{command_name} task #{position == :before ? 'started' : 'ended'}"
+    end
+
+    def message_for(command_name, position = :after)
+      command = command_name.to_sym
+      options[command] &&
+        options[command][(position == :before ? :before_message : :after_message)]
+    end
+
+    def voice_for(command_name)
+      command = command_name.to_sym
+      options[command] &&
+        options[command][:voice]
+    end
+
     private
 
     def symbolize_hash_keys(opts)

data/lib/talks/hooks.rb

@@ -0,0 +1,74 @@
+module Talks
+  module Hooks
+    class << self
+
+      def create(args)
+        engine = check_engine
+        options, args = shift_options(args.dup)
+        command_name = command args
+        voice, before_message, after_message = 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('; ')
+      end
+
+      private
+
+      def shift_options(args, options={})
+        # Check arguments for talks
+        # one-two dashed. -v or --voice
+        if args.first =~ /^-{1,2}[\w-]+$/
+          options[args[0]] = args[1]
+          args.shift(2)
+          shift_options(args, options)
+        else
+          [options, args]
+        end
+      end
+
+      def command(args)
+        if args[0..1] == %w(bundle exec)
+          args[2]
+        else
+          args[0]
+        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) ||
+          Talks.config.default_voice
+
+        before_message = options['-bm'] || options['--before-message'] ||
+          Talks.config.message_for(command_name, :before) ||
+          Talks.config.default_message_for(command_name, :before)
+
+        after_message = options['-am'] || options['--after-message'] ||
+          Talks.config.message_for(command_name, :after) ||
+          Talks.config.default_message_for(command_name, :after)
+
+        [voice, before_message, after_message]
+      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
+      end
+
+    end
+  end
+end

data/lib/talks/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: talks
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,14 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-23 00:00:00.000000000 Z
+date: 2012-05-24 00:00:00.000000000 Z
 dependencies: []
 description: Simple gem for `say` function of mac os x
 email:
 - alex.gaziev@gmail.com
-executables: []
+executables:
+- talking
+- talks
 extensions: []
 extra_rdoc_files: []
 files:
@@ -22,8 +24,11 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- bin/talking
+- bin/talks
 - lib/talks.rb
 - lib/talks/configuration.rb
+- lib/talks/hooks.rb
 - lib/talks/runner.rb
 - lib/talks/version.rb
 - spec/talks.rb