talks 0.0.3 → 0.0.4

data/README.md

@@ -1,11 +1,13 @@
-# Talks gem — now your ruby on your mac can talk with you
+# Talks gem — now your ruby can talk with you
 
-### This is beta now
+### Now it works only on MacOS X, soon we'll add support for linux and maybe windows through eSpeak or festival
 
-## It was checked only on MacOS X. I don't know what present on linux or windows
+### This is beta now
 
 If you want to HEAR some response from your code, just use this gem.
 
+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
@@ -17,6 +19,23 @@ choose from MacOS X `say` function collection.
 
 This gem just using native MacOS X `say` command line tool.
 
+### Configuration
+
+You can configure default voices and messages for `talks` with `~/.talksrc` file. It should be written in YAML format:
+
+`~/.talksrc`
+```yml
+default_voice: 'whisper'
+voices:
+  info: 'pipe'
+messages:
+  info: 'hello'
+  warn: 'WE GONNA DIE!!!'
+```
+
+The same you can do in your code dynamicly through Talks.config instance.
+Soon I'll add configuration with dotfile project-wide.
+
 ### Using talks in your code
 
 ```bash

data/lib/talks.rb

@@ -1,3 +1,5 @@
+require File.expand_path('../talks/configuration.rb', __FILE__)
+
 module Talks
   class << self
 
@@ -7,19 +9,12 @@ module Talks
       trinoids vicki victoria whisper zarvox
     )
 
-    PREFS = {
-      info: 'vicki',
-      warn: 'whisper',
-      success: 'vicki',
-      error: 'bad'
-    }
+    TYPES = [:info, :warn, :success, :error]
 
-    def voice
-      @voice ||= :info
-    end
+    attr :config
 
-    def voice=(voice = :info)
-      @voice ||= voice
+    def configure(options)
+      @config = Talks::Configuration.new(options)
     end
 
     def voices
@@ -27,23 +22,30 @@ module Talks
     end
 
     def say(message, options = {})
-      type = options[:type].to_sym if options[:type]
-      say_voice = \
-        if options[:voice] and VOICES.include?(options[:voice].to_s)
-          options[:voice]
-        elsif PREFS.keys.include? type
-          PREFS[type]
-        else
-          PREFS[voice]
-        end
-      `say -v #{say_voice} #{message}`
+      type = options[:type] || :default
+      `say -v #{say_voice(type, options)} #{message}`
     end
 
-    PREFS.keys.each do |type|
-      define_method type do |message, options = {type: type}|
+    TYPES.each do |type|
+      define_method type do |message = nil, options = {type: type}|
+        message ||= config.message(type)
         say(message, options)
       end
     end
 
+    private
+
+    def say_voice(type, options)
+      if options[:voice] and VOICES.include?(options[:voice].to_s)
+        options[:voice]
+      elsif TYPES.include? type
+        config.voice type
+      else
+        config.default_voice
+      end
+    end
+
   end
 end
+
+require File.expand_path('../talks/runner.rb', __FILE__)

data/lib/talks/configuration.rb

@@ -0,0 +1,55 @@
+require 'yaml'
+
+module Talks
+  class Configuration
+
+    DEFAULT_VOICES = {
+      info: 'vicki',
+      warn: 'whisper',
+      success: 'vicki',
+      error: 'bad'
+    }
+
+    DEFAULT_MESSAGES = {
+      info: 'Information note',
+      warn: 'Warning',
+      success: 'Success',
+      error: 'Error'
+    }
+
+    attr_accessor :voices, :messages, :default_voice, :options
+
+    def initialize(opts)
+      @options = symbolize_hash_keys(opts)
+      @default_voice = options[:default_voice] || 'vicki'
+      @voices = options[:voices] && DEFAULT_VOICES.merge(options[:voices]) ||
+        DEFAULT_VOICES
+      @messages = options[:messages] && DEFAULT_MESSAGES.merge(options[:messages]) ||
+        DEFAULT_MESSAGES
+    end
+
+    def voice(type)
+      voices[type] if voices.keys.include?(type)
+    end
+
+    def message(type)
+      messages[type] if messages.keys.include?(type)
+    end
+
+    def talk(type)
+      [message(type), voice(type)]
+    end
+
+    private
+
+    def symbolize_hash_keys(opts)
+      sym_opts = {}
+      opts.each do |key, value|
+        sym_opts[key.to_sym] = \
+          value.is_a?(Hash) ? symbolize_hash_keys(value) : value
+      end
+      sym_opts
+    end
+
+  end
+end

data/lib/talks/runner.rb

@@ -0,0 +1,20 @@
+# What file is used for talks startup configuration.
+unless defined?(OPTS_INITFILE)
+  if RUBY_PLATFORM =~ /mswin/
+    # Of course MS Windows has to be different
+    OPTS_INITFILE = 'talks.ini'
+    HOME_DIR =  (ENV['HOME'] ||
+    ENV['HOMEDRIVE'].to_s + ENV['HOMEPATH'].to_s).to_s
+  else
+    OPTS_INITFILE = '.talksrc'
+    HOME_DIR = ENV['HOME'].to_s
+  end
+end
+
+initfile = File.join(HOME_DIR, OPTS_INITFILE)
+
+if File.exist?(initfile)
+  Talks.configure(YAML.load_file(initfile))
+else
+  Talks.configure({})
+end

data/lib/talks/version.rb

@@ -1,3 +1,3 @@
 module Talks
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/spec/talks.rb

@@ -2,11 +2,24 @@ require File.expand_path('../../lib/talks.rb', __FILE__)
 
 Talks.voices.each do |v|
   p v
-  Talks.say 'Tests start', nil, voice: 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: talks
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-22 00:00:00.000000000 Z
+date: 2012-05-23 00:00:00.000000000 Z
 dependencies: []
 description: Simple gem for `say` function of mac os x
 email:
@@ -20,10 +20,11 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - lib/talks.rb
+- lib/talks/configuration.rb
+- lib/talks/runner.rb
 - lib/talks/version.rb
 - spec/talks.rb
 - talks.gemspec

data/Gemfile.lock

@@ -1,14 +0,0 @@
-PATH
-  remote: .
-  specs:
-    talks (0.0.2)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  talks!