win32-sound 0.4.0 → 0.4.1

data/CHANGES

@@ -1,3 +1,9 @@
+== 0.4.1 - 27-Jul-2007
+* Changed SoundError to Sound::Error.
+* Added a Rakefile with tasks for installation and testing.
+* Removed the install.rb file. Installation is now handled via a rake task.
+* Documentation updates.
+
 == 0.4.0 - 26-Feb-2006
 * Now pure Ruby only.
 * Documentation updates and reorganization.

data/MANIFEST

@@ -1,11 +1,8 @@
-MANIFEST
-CHANGES
-README
-install.rb
-win32-sound.gempsec
-
-examples/sound_test.rb
-
-lib/win32/sound.rb
-
-test/tc_sound.rb
+* MANIFEST
+* CHANGES
+* README
+* Rakefile
+* win32-sound.gempsec
+* examples/sound_test.rb
+* lib/win32/sound.rb
+* test/tc_sound.rb

data/README

@@ -2,68 +2,64 @@
    A package for playing with sound on Windows.
 
 == Prerequisites
-   This package requires Ruby 1.8.0 or later.
+   This package requires Ruby 1.8.0 or later. Ruby 1.8.2 or later is
+   recommended.
 
 == Installation instructions
-=== Gem installation
-   ruby win32-sound.gemspect
-   gem install win32-sound-X.X.X.gem
-
-=== Manual installation
-   ruby install.rb
-   ri lib\win32\sound.rb (to generate documentation)
+   rake test (optional)
+   rake install (non-gem) or rake install_gem (gem)
 
 == Synopsis
-   require "win32/sound"
+   require 'win32/sound'
    include Win32
-	
+
    # Get the current volume of the waveform-audio output device.
    p Sound.volume.join(", ") # left channel, right channel
-	
+
    # Play a system sound
    Sound.play("SystemAsterisk",Sound::ALIAS)
-	
+
    # Play a wav file
    Sound.play("somefile.wav")
 
 == Acknowledgements
    API ideas derived (or not) from Perl's Win32::Sound module and Python's
    winsound package.
-	
+
 == Known Bugs
-   None that I'm aware of.  Please report any bugs on the Win32 Utils home
+   None that I'm aware of. Please report any bugs on the Win32 Utils home
    page at http://rubyforge.org/projects/win32utils.
    
 == Questions and Comments
    Please post questions and/or comments on one of the forums on the project
-   page at http://rubyforge.org/projects/win32utils.  Click the 'Forums' tab.
+   page at http://rubyforge.org/projects/win32utils. Click the 'Forums' tab.
 	
 == Future Plans
    Add ability to retrieve information about WAV files.
    Add MIDI support?
-	
+
 == Developer's Notes
    The MessageBeep() function, which the Python "winsound" module contains,
-   is intentionally omitted here.  I felt it was redundant, because you can
+   is intentionally omitted here. I felt it was redundant, because you can
    achieve the same effect with something like
    Sound.play("SystemAsterisk", Sound::ALIAS).
 	
 == License
    Ruby's
-	
+
 == Copyright
-   (C) 2004-2006, Daniel J. Berger, All Rights Reserved
-	
+   (C) 2004-2007, Daniel J. Berger, All Rights Reserved
+
 == Warranty
    This package is provided "as is" and without any express or
    implied warranties, including, without limitation, the implied
    warranties of merchantability and fitness for a particular purpose.
-	
+
 == Author(s)
    Daniel Berger
-   djberg96 at gmail dot com
-   imperator/mok on IRC (irc.freenode.net)
-	
+   djberg96 at nospam at gmail dot com
+   imperator on IRC (irc.freenode.net)
+
    Park Heesob
-   phasis at nownuri dot net
+   phasis at nospam at nownuri dot net
    phasis68 on IRC (irc.freenode.net)

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+
+desc "Install the win32-sound package (non-gem)"
+task :install do
+   dest = File.join(Config::CONFIG['sitelibdir'], 'win32')
+   Dir.mkdir(dest) unless File.exists? dest
+   cp 'lib/win32/sound.rb', dest, :verbose => true
+end
+
+desc "Install the win32-sound package as a gem"
+task :install_gem do
+   ruby 'win32-sound.gemspec'
+   file = Dir["*.gem"].first
+   sh "gem install #{file}"
+end
+
+Rake::TestTask.new do |t|
+   t.libs << 'lib'
+   t.warning = true
+   t.test_files = FileList['test/tc*']
+end

data/lib/win32/sound.rb

@@ -1,8 +1,9 @@
 require 'Win32API'
 module Win32
-   class SoundError < StandardError; end
    class Sound
-      VERSION        = '0.4.0'
+      class Error < StandardError; end
+
+      VERSION        = '0.4.1'
       LOW_FREQUENCY  = 37
       HIGH_FREQUENCY = 32767
       MAX_VOLUME     = 0xFFFF
@@ -49,7 +50,7 @@ module Win32
             0.upto(@@auxGetNumDevs.call){ |i| devs << "AUX#{i}" }
             0.upto(@@mixerGetNumDevs.call){ |i| devs << "MIXER#{i}" }
          rescue Exception => err
-            raise SoundError, get_last_error
+            raise Error, get_last_error
          end
          
          devs
@@ -62,11 +63,11 @@ module Win32
       # The duration is in milliseconds.
       def self.beep(frequency, duration)
          if frequency > HIGH_FREQUENCY || frequency < LOW_FREQUENCY
-            raise SoundError, 'invalid frequency'
+            raise Error, 'invalid frequency'
          end
          
          if 0 == @@Beep.call(frequency, duration)
-            raise SoundError, get_last_error
+            raise Error, get_last_error
          end        
          self
       end
@@ -81,7 +82,7 @@ module Win32
          end
          
          if 0 == @@PlaySound.call(0, 0, flags)
-            raise SoundError, get_last_error
+            raise Error, get_last_error
          end
          self
       end
@@ -134,7 +135,7 @@ module Win32
 	  #   until the sound ends.
       def self.play(sound, flags = 0)
          if 0 == @@PlaySound.call(sound, 0, flags)
-            raise SoundError, get_last_error
+            raise Error, get_last_error
          end
          self
       end
@@ -153,7 +154,7 @@ module Win32
          volume = lvolume | rvolume << 16
          
          if @@waveOutSetVolume.call(-1, volume) != 0
-            raise SoundError, get_last_error
+            raise Error, get_last_error
          end
          self
       end
@@ -163,7 +164,7 @@ module Win32
       def self.wave_volume
          volume = [0].pack('L')
          if @@waveOutGetVolume.call(-1, volume) != 0
-            raise SoundError, get_last_error
+            raise Error, get_last_error
          end
          volume = volume.unpack('L').first
          [low_word(volume), high_word(volume)]
@@ -199,4 +200,4 @@ module Win32
          buf.split(0.chr).first.chomp
       end
    end
-end
+end

data/test/tc_sound.rb

@@ -1,16 +1,9 @@
-###########################################
+##########################################################################
 # tc_sound.rb
 #
-# Test suite for the win32-sound package.
-############################################
-base = File.basename(Dir.pwd)
-
-if base == "test" || base =~ /win32-sound/
-	Dir.chdir("..") if base == "test"
-	$LOAD_PATH.unshift Dir.pwd + '/lib'
-	Dir.chdir("test") if base =~ /win32-sound/
-end
-
+# Test suite for the win32-sound package. You should run this test case
+# via the 'rake test' task.
+##########################################################################
 puts "You may hear some funny noises - don't panic"
 sleep 1
 
@@ -24,14 +17,14 @@ class TC_Sound < Test::Unit::TestCase
    end
    
    def test_version
-      assert_equal("0.4.0", Sound::VERSION)
+      assert_equal("0.4.1", Sound::VERSION)
    end
    
    def test_beep
       assert_respond_to(Sound, :beep)
       assert_nothing_raised{ Sound.beep(55,100) }
       
-      assert_raises(SoundError){ Sound.beep(0,100) }
+      assert_raises(Sound::Error){ Sound.beep(0,100) }
       assert_raises(ArgumentError){ Sound.beep }
       assert_raises(ArgumentError){ Sound.beep(500) }
       assert_raises(ArgumentError){ Sound.beep(500,500,5) }
@@ -72,7 +65,7 @@ class TC_Sound < Test::Unit::TestCase
    end
    
    def test_expected_errors
-      assert_raises(SoundError){ Sound.beep(-1, 1) }
+      assert_raises(Sound::Error){ Sound.beep(-1, 1) }
    end
    
    def test_constants
@@ -92,4 +85,4 @@ class TC_Sound < Test::Unit::TestCase
    def teardown
       @wav = nil
    end
-end
+end

data/win32-sound.gemspec

@@ -0,0 +1,27 @@
+require "rubygems"
+
+spec = Gem::Specification.new do |gem|
+	gem.name         = "win32-sound"
+	gem.version      = "0.4.1"
+	gem.author       = "Daniel J. Berger"
+	gem.email        = "djberg96@gmail.com"
+	gem.homepage     = "http://www.rubyforge.org/projects/win32utils"
+	gem.platform     = Gem::Platform::RUBY
+	gem.summary      = "A library for playing with sound on MS Windows."
+	gem.description  = "A library for playing with sound on MS Windows."
+	gem.test_file    = "test/tc_sound.rb"
+	gem.has_rdoc     = true
+	gem.require_path = "lib"
+	gem.extra_rdoc_files  = ['CHANGES', 'README', 'MANIFEST']
+	gem.rubyforge_project = "win32utils"
+	
+	files = Dir["doc/*"] + Dir["examples/*"] + Dir["lib/win32/*"]
+	files += Dir["test/*"] + Dir["[A-Z]*"]
+	files.delete_if{ |item| item.include?("CVS") }
+	gem.files = files
+end
+
+if $0 == __FILE__
+   Gem.manage_gems
+   Gem::Builder.new(spec).build
+end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+rubygems_version: 0.9.2
 specification_version: 1
 name: win32-sound
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
-date: 2006-02-26 00:00:00 -07:00
-summary: A package for playing with sound on Windows.
+  version: 0.4.1
+date: 2007-07-27 00:00:00 -06:00
+summary: A library for playing with sound on MS Windows.
 require_paths: 
 - lib
 email: djberg96@gmail.com
 homepage: http://www.rubyforge.org/projects/win32utils
 rubyforge_project: win32utils
-description: A package for playing with sound on Windows.
+description: A library for playing with sound on MS Windows.
 autorequire: 
 default_executable: 
 bindir: bin
@@ -25,6 +25,7 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
 platform: ruby
 signing_key: 
 cert_chain: 
+post_install_message: 
 authors: 
 - Daniel J. Berger
 files: 
@@ -32,8 +33,13 @@ files:
 - lib/win32/sound.rb
 - test/tc_sound.rb
 - CHANGES
+- examples
+- lib
 - MANIFEST
+- Rakefile
 - README
+- test
+- win32-sound.gemspec
 test_files: 
 - test/tc_sound.rb
 rdoc_options: []
@@ -41,6 +47,7 @@ rdoc_options: []
 extra_rdoc_files: 
 - CHANGES
 - README
+- MANIFEST
 executables: []
 
 extensions: []