text-to-noise 0.1.4 → 0.2.0

data/bin/play_noise

@@ -7,10 +7,17 @@ require 'text_to_noise'
 
 player = TextToNoise::Player.new
 
-ARGV.each do |sound|
-  sound += ".wav" unless sound =~ /\.wav$/
-  player.play sound
-  sleep 1
+begin
+  ARGV.each do |sound|
+    sound += ".wav" unless sound =~ /\.wav$/
+    player.play sound
+    sleep 1
+  end
+rescue TextToNoise::Player::SoundNotFound => e
+  $stderr.puts e.message
+  $stderr.puts "Sorry, but I know how to play these sounds:\n"
+  $stderr.print "\t"
+  $stderr.puts player.available_sounds.join( "\n\t" )
 end
 
 sleep 1 while player.playing?

data/bin/text_to_noise

@@ -12,15 +12,64 @@ options = {
   :config => "sample.sounds.rb"
 }
 
-OptionParser.new do |opts|
+arg_parser = OptionParser.new do |opts|
   opts.banner = "Usage: #{$0} [options]"
-
+  opts.separator ""
+  opts.separator "Options:"
+  
   opts.on( "-f", "--file FILE",
     "Read input from FILE.  Defaults to stdin" ) { |f| options[:input] = File.open( f, "r" ) }
   opts.on( "-c", "--config MAPPING_CONFIG",
     "Read input to sound mapping configuration from MAPPING_CONFIG" ) { |c| options[:config] = c }
   opts.on( "-m", "--mute",
     "Don't play any sounds, just print what matched" ) { options[:mute] = true }
-end.parse!
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end
+
+arg_parser.parse!
+
+begin
+  TextToNoise::CommandLine.new( options ).run
+rescue ArgumentError
+  $stderr.puts arg_parser
+  $stderr.puts <<-EOS
+
+ERROR!
+
+Could not locate a noise configuration.
+Specify a configuration with the -c option.
+
+Try this one if you're processing a Rails log:
+
+  match /Rendered/  => %w(crickets canary)
+  match /Rendering/ => "cardinal"
+  match /User Load/ => "nightingale"
+  match /Processing/ => "finch"
+  match /SessionsController#new/ => "owl"
+  match /404 Not Found/ => "hawk"
+
+Or maybe you're watching your ssh access:
+
+  match /sshd.*Accepted/ => %w[rooster hawk chicken crow]
+
+Copy one of those into a file and pass it along to text_to_noise.
+
+For example:
+
+  echo 'match /sshd.*Accepted/ => %w[rooster hawk chicken crow]' > ssh.sounds.rb
+  tail -f /var/log/secure.log | text_to_noise -c ssh.sounds.rb
+
+Still having problems?
+  Try logging an issue at https://github.com/tobytripp/text_to_noise/issues
+  or try bothering me on Twitter http://twitter.com/tobytripp
+
+
+Thanks for playing!
+
 
-TextToNoise::CommandLine.new( options ).run
+EOS
+  exit 1
+end

data/features/commandline.feature

@@ -0,0 +1,33 @@
+Feature: Running text_to_noise
+
+  Use the command-line to tell text-to-noise where to find your config file, the
+  input to parse, and whether it should actually make any noise.
+
+  Scenario: Calling with no arguments
+    When I run `text_to_noise`
+
+    Then the output should contain:
+    """
+    Could not locate a noise configuration.
+    Specify a configuration with the -c option.
+
+    Try this one if you're processing a Rails log:
+
+      match /Rendered/  => %w(crickets canary)
+      match /Rendering/ => "cardinal"
+      match /User Load/ => "nightingale"
+      match /Processing/ => "finch"
+      match /SessionsController#new/ => "owl"
+      match /404 Not Found/ => "hawk"
+
+    Or maybe you're watching your ssh access:
+
+      match /sshd.*Accepted/ => %w[rooster hawk chicken crow]
+
+    Copy one of those into a file and pass it along to text_to_noise.
+
+    For example:
+
+      echo 'match /sshd.*Accepted/ => %w[rooster hawk chicken crow]' > ssh.sounds.rb
+      tail -f /var/log/secure.log | text_to_noise -c ssh.sounds.rb
+    """

data/lib/text_to_noise.rb

@@ -2,11 +2,12 @@ LIB_DIR   = File.dirname File.expand_path( __FILE__ )
 APP_ROOT  = File.join LIB_DIR,  '..'
 $LOAD_PATH << LIB_DIR
 
+require 'logger'
+
 Dir["#{LIB_DIR}/text_to_noise/*.rb"].each { |lib|
   lib =~ %r<lib/(.*)\.rb$>
   require $1
 }
-require 'logger'
 
 module TextToNoise
   def self.player

data/lib/text_to_noise/command_line.rb

@@ -1,11 +1,17 @@
+require 'text_to_noise/logging'
+
 module TextToNoise
   class CommandLine
+    include Logging
     attr_reader :options, :mapping
     
     def initialize( options={} )
       @options = {
         :input  =>  $stdin
       }.merge options
+
+      raise ArgumentError, "No configuration file provided." unless @options[:config]
+      
       @mapping = Mapper.parse File.read( @options[:config] )
       TextToNoise.player = self.player
     rescue Errno::ENOENT => e
@@ -14,7 +20,7 @@ module TextToNoise
     
     def run
       LogReader.new( options[:input], mapping ).call
-      puts "Input processing complete.  Waiting for playback to finish..."
+      info "Input processing complete.  Waiting for playback to finish..."
       while TextToNoise.player.playing?
         sleep 1
       end

data/lib/text_to_noise/player.rb

@@ -10,14 +10,7 @@ module TextToNoise
     end
     
     def initialize()
-      begin
-        require 'rubygame'
-      rescue LoadError
-        require 'rubygems'
-        require 'rubygame'
-      end
-
-      raise "No Mixer found!  Make sure sdl_mixer is installed." unless defined? Rubygame::Sound
+      self.class.load_rubygame
       
       Rubygame::Sound.autoload_dirs << SOUND_DIR
       themes = Dir.new(SOUND_DIR).entries.reject { |e| e =~ /[.]/ }
@@ -41,5 +34,30 @@ module TextToNoise
       @sounds = @sounds.select &:playing?
       not @sounds.empty?
     end
+
+    def available_sounds()
+      Rubygame::Sound.autoload_dirs.map do |dir|
+        Dir[ "#{dir}/*.wav" ].map { |f| File.basename f }
+      end.flatten
+    end
+
+    def self.load_rubygame()
+      old_verbose, $VERBOSE = $VERBOSE, nil
+      old_stream, stream = $stdout.dup, $stdout
+      stream.reopen '/dev/null'
+      stream.sync = true
+      
+      begin
+        require 'rubygame'
+      rescue LoadError
+        require 'rubygems'
+        require 'rubygame'
+      end
+      
+      raise "No Mixer found!  Make sure sdl_mixer is installed." unless defined? Rubygame::Sound
+    ensure
+      $VERBOSE = old_verbose
+      stream.reopen(old_stream)
+    end
   end
 end

data/lib/text_to_noise/version.rb

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

data/spec/text_to_noise/command_line_spec.rb

@@ -1,70 +1,76 @@
 require 'spec_helper'
 
 module TextToNoise
-describe TextToNoise::CommandLine do
-  let( :mapping ) { double( Mapping ) }
-  let( :reader  ) { double( LogReader, :call => nil ) }
-  
-  before :each do
-    Mapper.stub!( :parse ).and_return mapping
-    LogReader.stub!( :new ).and_return reader
-    File.stub!( :read ).with( "sound_map.rb" ).and_return "config"
-  end
-
-  describe "#initialize" do
-    it "accepts an options object" do
-      CommandLine.new( {} )
+  describe TextToNoise::CommandLine do
+    let( :mapping ) { double( Mapping ) }
+    let( :reader  ) { double( LogReader, :call => nil ) }
+    
+    before :each do
+      Mapper.stub!( :parse ).and_return mapping
+      LogReader.stub!( :new ).and_return reader
+      File.stub!( :read ).with( "sound_map.rb" ).and_return "config"
     end
 
-    it "raises an error if the config file cannot be found" do
-      File.stub!( :read ).and_raise Errno::ENOENT
-      lambda {
-        CommandLine.new :config => "not_found"
-      }.should raise_error( ArgumentError )
-    end
+    describe "#initialize" do
+      it "accepts an options object" do
+        CommandLine.new( { :config => "sound_map.rb" } )
+      end
+      
+      it "throws an error if no config file is given" do
+        lambda {
+          CommandLine.new
+        }.should raise_error( ArgumentError )
+      end
+      
+      it "raises an error if the config file cannot be found" do
+        File.stub!( :read ).and_raise Errno::ENOENT
+        lambda {
+          CommandLine.new :config => "not_found"
+        }.should raise_error( ArgumentError )
+      end
 
-    context "when given a 'config' option" do
-      it "instantiates a Mapping object with the specified configuration" do
-        File.should_receive( :read ).with( "sound_map.rb" ).and_return "config"
-        Mapper.should_receive( :parse ).with( "config" )
-        
-        CommandLine.new :config => "sound_map.rb"
+      context "when given a 'config' option" do
+        it "instantiates a Mapping object with the specified configuration" do
+          File.should_receive( :read ).with( "sound_map.rb" ).and_return "config"
+          Mapper.should_receive( :parse ).with( "config" )
+          
+          CommandLine.new :config => "sound_map.rb"
+        end
       end
-    end
 
-    context "when given the 'mute' option" do
-      it "sets the global Player to an instance of MutePlayer" do
-        TextToNoise.should_receive( :player= ).with instance_of( MutePlayer )
-        CommandLine.new :mute => true
+      context "when given the 'mute' option" do
+        it "sets the global Player to an instance of MutePlayer" do
+          TextToNoise.should_receive( :player= ).with instance_of( MutePlayer )
+          CommandLine.new :mute => true, :config => "sound_map.rb"
+        end
       end
     end
-  end
 
-  describe "#run" do
-    let( :options ) { Hash[:input, :io, :config, "sound_map.rb"] }
-    
-    subject { CommandLine.new( options ) }
+    describe "#run" do
+      let( :options ) { Hash[:input, :io, :config, "sound_map.rb"] }
+      
+      subject { CommandLine.new( options ) }
 
-    
-    it "creates a new LogReader object" do
-      LogReader.should_receive( :new )
-      subject.run
-    end
+      
+      it "creates a new LogReader object" do
+        LogReader.should_receive( :new )
+        subject.run
+      end
 
-    it "passes the contents of the file in :input option to the reader" do
-      LogReader.should_receive( :new ).with( :io, anything )
-      subject.run      
-    end
+      it "passes the contents of the file in :input option to the reader" do
+        LogReader.should_receive( :new ).with( :io, anything )
+        subject.run      
+      end
 
-    it "passes an instance of a Mapping to the LogReader" do
-      LogReader.should_receive( :new ).with( anything, mapping )
-      subject.run
-    end
+      it "passes an instance of a Mapping to the LogReader" do
+        LogReader.should_receive( :new ).with( anything, mapping )
+        subject.run
+      end
 
-    it "calls #call on the LogReader" do
-      reader.should_receive :call
-      subject.run
+      it "calls #call on the LogReader" do
+        reader.should_receive :call
+        subject.run
+      end
     end
   end
 end
-end

metadata

@@ -2,7 +2,7 @@
 name: text-to-noise
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors: 
 - Toby Tripp
@@ -77,6 +77,7 @@ files:
 - bin/play_noise
 - bin/text_to_noise
 - cucumber.yml
+- features/commandline.feature
 - features/configuration.feature
 - features/step_definitions/debugger_steps.rb
 - features/support/env.rb
@@ -155,6 +156,7 @@ signing_key:
 specification_version: 3
 summary: Play sounds based on string matches.
 test_files: 
+- features/commandline.feature
 - features/configuration.feature
 - features/step_definitions/debugger_steps.rb
 - features/support/env.rb