talks 0.0.2 → 0.0.3

data/Gemfile.lock

@@ -1,70 +1,14 @@
 PATH
   remote: .
   specs:
-    gon (3.0.2)
-      actionpack (>= 2.3.0)
-      json
+    talks (0.0.2)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    actionpack (3.2.3)
-      activemodel (= 3.2.3)
-      activesupport (= 3.2.3)
-      builder (~> 3.0.0)
-      erubis (~> 2.7.0)
-      journey (~> 1.0.1)
-      rack (~> 1.4.0)
-      rack-cache (~> 1.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.1.2)
-    activemodel (3.2.3)
-      activesupport (= 3.2.3)
-      builder (~> 3.0.0)
-    activesupport (3.2.3)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    blankslate (2.1.2.4)
-    builder (3.0.0)
-    diff-lcs (1.1.3)
-    erubis (2.7.0)
-    hike (1.2.1)
-    i18n (0.6.0)
-    jbuilder (0.4.0)
-      activesupport (>= 3.0.0)
-      blankslate (>= 2.1.2.4)
-    journey (1.0.3)
-    json (1.7.1)
-    multi_json (1.2.0)
-    rabl (0.6.9)
-      activesupport (>= 2.3.14)
-      multi_json (~> 1.0)
-    rack (1.4.1)
-    rack-cache (1.2)
-      rack (>= 0.4)
-    rack-test (0.6.1)
-      rack (>= 1.0)
-    rake (0.9.2.2)
-    rspec (2.9.0)
-      rspec-core (~> 2.9.0)
-      rspec-expectations (~> 2.9.0)
-      rspec-mocks (~> 2.9.0)
-    rspec-core (2.9.0)
-    rspec-expectations (2.9.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.9.0)
-    sprockets (2.1.3)
-      hike (~> 1.2)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    tilt (1.3.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  gon!
-  jbuilder
-  rabl
-  rake
-  rspec
+  talks!

data/README.md

@@ -1 +1,79 @@
-Comming soon
+# Talks gem — now your ruby on your mac can talk with you
+
+### This is beta now
+
+## It was checked only on MacOS X. I don't know what present on linux or windows
+
+If you want to HEAR some response from your code, just use this gem.
+
+## 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.
+
+## How?
+
+This gem just using native MacOS X `say` command line tool.
+
+### Using talks in your code
+
+```bash
+$ gem install talks
+```
+
+Then in your code you can require and use Talks functions:
+
+```ruby
+require 'talks'
+
+Talks.say 'Hello bro!'
+
+# There are 4 types of voice: say or info, warn, success, error
+Talks.info 'This is info'
+# Talks.warn 'Some text'
+# Talks.success 'Some text'
+# Talks.error 'Some text'
+```
+
+`Talks.say` can be customized with type of message and voice by adding options to executing this method:
+
+```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`:
+```ruby
+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
+)
+```
+
+## Who?
+
+I did it myself
+
+### Contributors
+
+* @gazay
+
+### A lot of thanks
+
+You can help me with this fun gem and I'll gladly add you here, or above
+
+## License
+
+The MIT License
+
+Copyright (c) 2012 gazay
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/lib/talks/version.rb

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

data/lib/talks.rb

@@ -2,16 +2,16 @@ 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
+      agnes albert alex bad bahh bells boing bruce bubbles cellos
+      deranged fred good hysterical junior kathy pipe princess ralph
+      trinoids vicki victoria whisper zarvox
     )
 
     PREFS = {
-      info: 'Bruce',
-      warn: 'Whisper',
-      success: 'Fred',
-      error: 'Trinoids'
+      info: 'vicki',
+      warn: 'whisper',
+      success: 'vicki',
+      error: 'bad'
     }
 
     def voice
@@ -22,10 +22,14 @@ module Talks
       @voice ||= voice
     end
 
-    def say(message, type = voice, options = {})
-      type = type.to_sym
+    def voices
+      VOICES
+    end
+
+    def say(message, options = {})
+      type = options[:type].to_sym if options[:type]
       say_voice = \
-        if options[:voice] and VOICES.include?(options[:voice].to_downcase)
+        if options[:voice] and VOICES.include?(options[:voice].to_s)
           options[:voice]
         elsif PREFS.keys.include? type
           PREFS[type]
@@ -36,8 +40,8 @@ module Talks
     end
 
     PREFS.keys.each do |type|
-      define_method type do |message, options = {}|
-        say(message, type, options)
+      define_method type do |message, options = {type: type}|
+        say(message, options)
       end
     end
 

data/spec/talks.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: talks
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-21 00:00:00.000000000 Z
+date: 2012-05-22 00:00:00.000000000 Z
 dependencies: []
 description: Simple gem for `say` function of mac os x
 email:
@@ -25,6 +25,7 @@ files:
 - Rakefile
 - lib/talks.rb
 - lib/talks/version.rb
+- spec/talks.rb
 - talks.gemspec
 homepage: https://github.com/gazay/talks
 licenses: []
@@ -50,4 +51,5 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Simple gem for `say` function of mac os x
-test_files: []
+test_files:
+- spec/talks.rb