text-to-noise 0.1.2 → 0.1.4

data/README.md

@@ -1,10 +1,11 @@
-TailSounds
-==========
-Ambient monitoring.
+Text-To-Noise
+=============
+Ambient log file monitoring.
 
-Imagine if your servers created ambient noise instead of silent log messages.  What if your
-application infrastructure sounded like a jungle?  Page views are the chittering of crickets,
-logins are the cackle of monkeys, and errors are the roar of a lion.
+Imagine if your servers created ambient noise instead of silent log messages.
+What if your application infrastructure sounded like a jungle? Page views are
+the chittering of crickets, logins are the cackle of monkeys, and errors are
+the roar of a lion.  This is what `text_to_noise` can do.
 
 
 Installation
@@ -12,24 +13,112 @@ Installation
 
 Stuff that I had to do to get this running:
 
-1. Install the SDL Mixer library.  I used [Homebrew][homebrew]:
-    brew install sdl sdl_mixer
+1. Install the [SDL Mixer][sdlmixer] library.  I used [Homebrew][homebrew]:
+    `brew install sdl sdl_mixer`
 
-2. Install text_to_noise via [Rubygems][rubygems]:
-    gem install rsdl text_to_noise
+2. Install `text_to_noise` via [Rubygems][rubygems]:
+    `gem install text-to-noise`
+
+
+Configuration
+=============
+
+Text-To-Noise is configured with a Ruby file. The configuration contains a set
+of rules for mapping a line of input text to a sound. Each mapping is a single
+method of the form `map( pattern ).to "sound"`.
+
+    map( /a regex matching log lines to trigger sounds/ ).to "a sound name to play"
+
+For example,
+
+    map( /Processing/ ).to "finch"
+
+will match any input line that matches `/Processing/` and play the sound of a finch chirping.
+
+A mapping may target multiple sounds for a given rule.  It can get boring to
+hear the same sound every time a page is loaded.  Specify a set of sounds for 
+a rule by passing it a list of sound names:
+
+    map( /Processing/ ).to ["canary", "finch"]
+   
+the sounds will each be played in turn for each time the rule matches.
+
+
+Dynamic Patterns
+----------------
+
+You can also apply more advanced rules for sound generation by supplying a
+block to the match rule. The block is passed the [MatchData][MatchData:RDoc]
+object returned from the regular expression match:
+
+    map( /Completed in (\d+)ms/ ) { |match_data|
+      match_data[1].to_i > 500
+    }.to "vulture"
+
+The above rule will play a vulture sound iff a line matches the expression _and_ the block
+returns true.  Applied to a Rails log, the above rule will play a vulture sound whenever a 
+page takes longer than 500ms to render.
+
+For additional details, see the Cucumber [features][Features].  Also, have a 
+look at the [sample][SampleConfig] configuration.
+
+Included Sounds
+---------------
+
+`text-to-noise` currently comes with the following sounds for use in your
+configurations:
+
+    australian_frogmouth
+    blue_amazon_macaw
+    canary
+    canary2
+    cardinal
+    chicken
+    crickets
+    crow-1
+    crow
+    finch
+    geese
+    hawk
+    lapwing
+    meadow_lark_long
+    meadow_lark_short
+    mexican_red_parrot
+    mockingbird
+    nightingale
+    owl
+    peacock
+    pigeons
+    red_lories
+    rooster
+    vulture
+    whipperwhill
+
+Soon you'll be able to add your own `wav` files for playback, but not just yet.
 
 
 Usage
 -----
 
-Pipe a log into the +tail_sound+ script and it will start chirping:
+First, create a sound mapping configuration as shown above. Then you can pipe
+a log into the `text_to_noise` script and it will start chirping:
+
+    tail -f /var/log/mylog | text_to_noise -c my.sounds.rb
 
-    tail -f /var/log/mylog | text_to_noise
+Alternatively, you can run `text_to_noise` on an existing file:
+
+    text_to_noise -c my.sounds.rb -f file.log
+    
+Text-To-Noise will cease processing when it reaches the end of the file.
 
 
 TODO
 ----
 
+At the moment, this only supports playing some free bird songs that are included in the gem.
+Highest priority is the ability to add your own sound sets for playback.
+
+  * Add sounds to the available noises for playback
   * Automatically refresh configurations
   * Add generators to create stub configurations
   * Support sound themes?
@@ -37,3 +126,7 @@ TODO
 
 [Homebrew]:http://mxcl.github.com/homebrew
 [Rubygems]:http://rubygems.org
+[sdlmixer]:http://www.libsdl.org/projects/SDL_mixer/
+[MatchData:RDoc]:http://ruby-doc.org/core/classes/MatchData.html
+[Features]:https://github.com/tobytripp/text_to_noise/blob/master/features/configuration.feature
+[SampleConfig]:https://github.com/tobytripp/text_to_noise/blob/master/sample.sounds.rb

data/bin/play_noise

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path( '../../lib/', __FILE__ )
+$:.unshift lib unless $:.include?( lib )
+
+require 'text_to_noise'
+
+player = TextToNoise::Player.new
+
+ARGV.each do |sound|
+  sound += ".wav" unless sound =~ /\.wav$/
+  player.play sound
+  sleep 1
+end
+
+sleep 1 while player.playing?

data/features/configuration.feature

@@ -62,3 +62,19 @@ Feature: Mapping input lines to sounds for playback
     
     Then the output should contain "Playing slow_query.wav"
      And the output should not contain "Playing slow_request.wav"
+
+  Scenario: Inputs that match multiple rules should fire all sounds
+    Given a file named "sound_mapping.rb" with:
+    """
+    map /caw/ => "crow", /bakawk/ => "chicken"
+    """
+
+    And a file named "input.log" with:
+    """
+    caw    bakawk!
+    """
+
+    When I run `text_to_noise -c sound_mapping.rb -f input.log -m`
+
+    Then the output should contain "Playing crow.wav"
+     And the output should contain "Playing chicken.wav"

data/lib/text_to_noise/version.rb

@@ -1,3 +1,3 @@
 module TextToNoise
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end

data/text_to_noise.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "rubygame", "~> 2.6.4"
 
+  spec.requirements << "SDL_mixer [http://www.libsdl.org/projects/SDL_mixer/]"
+
   spec.add_development_dependency "cucumber"
   spec.add_development_dependency "aruba"
   spec.add_development_dependency "rspec"

metadata

@@ -2,7 +2,7 @@
 name: text-to-noise
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors: 
 - Toby Tripp
@@ -11,8 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-30 00:00:00 -05:00
-default_executable: 
+date: 2011-04-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rubygame
@@ -61,7 +60,7 @@ dependencies:
 description: Pipe a file, like a log file, into text_to_noise and it will play sound effects triggered by regex matches in the input.
 email: toby.tripp+tailsounds@gmail.com
 executables: 
-- play
+- play_noise
 - text_to_noise
 extensions: []
 
@@ -75,7 +74,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- bin/play
+- bin/play_noise
 - bin/text_to_noise
 - cucumber.yml
 - features/configuration.feature
@@ -128,7 +127,6 @@ files:
 - text_to_noise.gemspec
 - ts.gems
 - watchr.rb
-has_rdoc: true
 homepage: https://github.com/tobytripp/text_to_noise
 licenses: []
 
@@ -149,10 +147,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version 
       version: 1.3.6
-requirements: []
-
+requirements: 
+- SDL_mixer [http://www.libsdl.org/projects/SDL_mixer/]
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Play sounds based on string matches.

data/bin/play

@@ -1,12 +0,0 @@
-#!/usr/bin/env ruby
-
-require './lib/text_to_noise'
-
-player = TailSounds::Player.new
-
-ARGV.each do |sound|
-  player.play sound
-  sleep 1
-end
-
-sleep 1 while player.playing?