midiator 0.1.0

data/misc/rake/testing.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+#
+# Rake tasks related to testing.
+#
+# == Authors
+#
+# * Ben Bleything <ben@bleything.net>
+#
+# == Copyright
+#
+# Copyright (c) 2008 Ben Bleything
+#
+# This code released under the terms of the MIT license.
+#
+
+require 'spec/rake/spectask'
+
+desc "Run the RSpec suite"
+Spec::Rake::SpecTask.new( :spec ) do |r|
+	r.libs      = SPEC_FILES
+	r.spec_opts = %w(--format specdoc --color)
+end
+
+namespace :spec do
+	### Run the specifications and generate coverage information
+	Spec::Rake::SpecTask.new( :coverage ) do |r|
+		r.rcov      = true
+		r.rcov_dir  = 'coverage'
+		r.rcov_opts = %w( -x Library\/Ruby,^spec )
+		r.libs      = SPEC_FILES
+	end
+end

data/spec/driver_registry_spec.rb

@@ -0,0 +1,115 @@
+#!/usr/bin/env ruby
+#
+# Contains the specifications for the MIDIator::DriverRegistry class.
+#
+# == Authors
+#
+# * Ben Bleything <ben@bleything.net>
+#
+# == Copyright
+#
+# Copyright (c) 2008 Ben Bleything
+#
+# This code released under the terms of the MIT license.
+#
+
+require File.join( File.dirname(__FILE__), 'lib', 'spec_helper.rb' )
+
+describe MIDIator::DriverRegistry do
+	before( :all ) do
+		# alias MIDIator::Driver's inherited method out of the way and
+		# redefine it as a no-op.  This prevents MIDIator::Driver from trying
+		# to auto-register subclasses.
+		MIDIator::Driver.instance_eval {
+			class << self
+				alias_method :old_inherited, :inherited
+			end
+
+			def self::inherited( klass )
+				# no-op
+			end
+		}
+	end
+
+	after( :all ) do
+		# move MIDIator::Driver's inherited method back into place
+		MIDIator::Driver.instance_eval {
+			class << self
+				alias_method :inherited, :old_inherited
+			end
+		}
+	end
+
+	before( :each ) do
+		@registry = MIDIator::DriverRegistry.instance
+
+		@driver_fixture = {
+			:a => "is for apple",
+			:b => "is for bunches of apples"
+		}
+	end
+
+	after( :each ) do
+		@registry.instance_variable_set( :@drivers, nil )
+	end
+
+	it "is a Singleton" do
+		lambda { MIDIator::DriverRegistry.new }.should raise_error
+		MIDIator::DriverRegistry.should respond_to( :instance )
+	end
+
+	it "knows how many drivers are registered" do
+		@registry.instance_variable_set( :@drivers, @driver_fixture )
+		@registry.size.should == @driver_fixture.size
+	end
+
+	it "can be dereferenced as though it was a hash" do
+		@registry.instance_variable_set( :@drivers, @driver_fixture )
+		@driver_fixture.keys.each do |key|
+			@registry[ key ].should == @driver_fixture[ key ]
+		end
+	end
+
+	it "aliases #register_driver to #register and #<<" do
+		register_driver = @registry.method( :register_driver )
+
+		@registry.method( :<< ).should == register_driver
+		@registry.method( :register ).should == register_driver
+	end
+
+	it "keeps track of registered drivers by name" do
+		Bees       = Class.new( MIDIator::Driver )
+		Sandwiches = Class.new( MIDIator::Driver )
+		Guns       = Class.new( MIDIator::Driver )
+
+		@registry.register( :bees,       Bees       )
+		@registry.register( :sandwiches, Sandwiches )
+		@registry.register( :guns,       Guns       )
+
+		@registry[ :bees       ].should be( Bees       )
+		@registry[ :sandwiches ].should be( Sandwiches )
+		@registry[ :guns       ].should be( Guns       )
+	end
+
+	it "prevents anything other than a MIDIator::Driver subclass from being registered" do
+		lambda {
+			@registry.register( :failboat, String )
+		}.should raise_error( ArgumentError, "Attempted to register something that is not a MIDIator::Driver" )
+
+		lambda {
+			@registry.register( :great_success, Class.new( MIDIator::Driver ) )
+		}.should_not raise_error
+	end
+
+	it "prevents a single driver from being registered multiple times" do
+		klass = Class.new( MIDIator::Driver )
+
+		lambda {
+			@registry.register( :first_try, klass )
+		}.should_not raise_error
+
+		lambda {
+			@registry.register( :second_try, klass )
+		}.should raise_error( ArgumentError, "Already registered #{klass.to_s} as 'first_try'." )
+	end
+end

data/spec/driver_spec.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+#
+# Contains the specifications for the MIDIator::Driver class.
+#
+# == Authors
+#
+# * Ben Bleything <ben@bleything.net>
+#
+# == Copyright
+#
+# Copyright (c) 2008 Ben Bleything
+#
+# This code released under the terms of the MIT license.
+#
+
+require File.join( File.dirname(__FILE__), 'lib', 'spec_helper.rb' )
+
+describe MIDIator::Driver do
+	it "automatically registers subclasses" do
+		SomeCoolDriver = Class.new
+		SomeCoolDriver.should_receive( :< ).with( MIDIator::Driver ).and_return( true )
+
+		# call inherited directly since we can't set up expectations ahead of
+		# time with Class.new( MIDIator::Driver )
+		MIDIator::Driver.inherited( SomeCoolDriver )
+
+		MIDIator::DriverRegistry.instance[ "some_cool_driver" ].should be( SomeCoolDriver )
+	end
+end

data/spec/interface_spec.rb

@@ -0,0 +1,128 @@
+#!/usr/bin/env ruby
+#
+# Contains the specifications for the MIDIator::Interface class.
+#
+# == Authors
+#
+# * Ben Bleything <ben@bleything.net>
+#
+# == Copyright
+#
+# Copyright (c) 2008 Ben Bleything
+#
+# This code released under the terms of the MIT license.
+#
+
+require File.join( File.dirname(__FILE__), 'lib', 'spec_helper.rb' )
+
+describe MIDIator::Interface do
+	before( :each ) do
+		@driver_name = 'i_like_bees'
+
+		@interface = MIDIator::Interface.new
+		@driver_class = mock( "driver class" )
+	end
+
+	describe "auto-detects the correct driver for your platform" do
+		before( :all ) do
+			# remember RUBY_PLATFORM so we can reset it later
+			@ruby_platform = RUBY_PLATFORM
+
+			$stderr.puts "*" * 72
+			$stderr.puts "NOTE: constant redefinition warnings are normal for these specs"
+			$stderr.puts "*" * 72
+		end
+
+		after( :all ) do
+			# reset RUBY_PLATFORM to whatever is correct for our platform
+			RUBY_PLATFORM = @ruby_platform
+
+			$stderr.puts "*" * 72
+			$stderr.puts "NOTE: you shouldn't see any more warnings"
+			$stderr.puts "*" * 72
+		end
+
+		it "selects WinMM for Windows" do
+			RUBY_PLATFORM = "i386-win32"
+			@interface.should_receive( :use ).with( :winmm )
+
+			@interface.autodetect_driver
+		end
+
+		it "selects CoreMIDI for OSX" do
+			RUBY_PLATFORM = "universal-darwin9.0"
+			@interface.should_receive( :use ).with( :core_midi )
+
+			@interface.autodetect_driver
+		end
+
+		it "selects ALSA for Linux" do
+			RUBY_PLATFORM = "i486-linux"
+			@interface.should_receive( :use ).with( :alsa )
+
+			@interface.autodetect_driver
+		end
+	end
+
+	describe "provides the #use method to load/specify a MIDI driver" do
+		it "requires the driver's file from midiator/drivers" do
+			path = "midiator/drivers/#{@driver_name}"
+			@interface.should_receive( :require ).with( path )
+
+			# stub out the rest of #use
+			Object.should_receive( :module_eval ).and_return( 
+				mock( 'foo', :null_object => true )
+			)
+
+			@interface.use( @driver_name )
+		end
+
+		it "captures a LoadError and gives the user a slightly better message" do
+			@interface.should_receive( :require ).and_raise( LoadError )
+
+			lambda {
+				@interface.use( @driver_name )
+			}.should raise_error( LoadError, "Could not load driver '#{@driver_name.to_s}'.")
+		end
+
+		it "instantiates the driver's class" do
+			@interface.stub!( :require )
+
+			Object.should_receive( :module_eval ).with(
+				"::MIDIator::Driver::ILikeBees"
+			).and_return( Class.new )
+
+			@interface.use( @driver_name )
+		end
+
+		it "correctly spells MIDI if the driver name includes it" do
+			@interface.stub!( :require )
+
+			Object.should_receive( :module_eval ).with(
+				"::MIDIator::Driver::SomeClassThatHasMIDIInItsName"
+			).and_return( Class.new )
+
+			@interface.use( "some_class_that_has_midi_in_its_name" )
+		end
+
+		it "correctly spells ALSA when the ALSA driver is requested" do
+			@interface.stub!( :require )
+
+			Object.should_receive( :module_eval ).with(
+				"::MIDIator::Driver::ALSA"
+			).and_return( Class.new )
+
+			@interface.use( :alsa )
+		end
+
+		it "correctly spells WinMM when the WinMM driver is requested" do
+			@interface.stub!( :require )
+
+			Object.should_receive( :module_eval ).with(
+				"::MIDIator::Driver::WinMM"
+			).and_return( Class.new )
+
+			@interface.use( :winmm )
+		end
+	end
+end

data/spec/string_extensions_spec.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+#
+# Contains the specifications for the extensions to Ruby's built-in String
+# class.
+#
+# == Authors
+#
+# * Ben Bleything <ben@bleything.net>
+#
+# == Copyright
+#
+# Copyright (c) 2008 Ben Bleything
+#
+# This code released under the terms of the MIT license.
+#
+
+require File.join( File.dirname(__FILE__), 'lib', 'spec_helper.rb' )
+
+describe "MIDIator's extensions to Ruby's String class" do
+	it "converts under_scored strings to CamelCase" do
+		"this_is_some_strings".camelize.should == "ThisIsSomeStrings"
+	end
+
+	it "converts file path strings to module paths" do
+		"some/file/lives/here".camelize.should == "Some::File::Lives::Here"
+	end
+
+	it "converts CamelCase strings to under_scored" do
+		"TheseStringsBeCamelly".underscore.should == "these_strings_be_camelly"
+	end
+
+	it "converts module path strings to file paths" do
+		"This::Is::A::Module".underscore.should == "this/is/a/module"
+	end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: midiator
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ben Bleything
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-19 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: MIDIator provides an OS-agnostic way to send live MIDI messages to your machine's MIDI playback system.
+email: ben@bleything.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- spec/driver_registry_spec.rb
+- spec/driver_spec.rb
+- spec/interface_spec.rb
+- spec/string_extensions_spec.rb
+- lib/midiator/driver.rb
+- lib/midiator/driver_registry.rb
+- lib/midiator/drivers/alsa.rb
+- lib/midiator/drivers/core_midi.rb
+- lib/midiator/drivers/winmm.rb
+- lib/midiator/drums.rb
+- lib/midiator/exceptions.rb
+- lib/midiator/interface.rb
+- lib/midiator/notes.rb
+- lib/midiator/timer.rb
+- lib/midiator.rb
+- lib/string_extensions.rb
+- examples/chromatic_scale.rb
+- examples/metronome.rb
+- misc/rake/packaging.rb
+- misc/rake/rdoc.rb
+- misc/rake/testing.rb
+has_rdoc: true
+homepage: http://projects.bleything.net/projects/show/midiator
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: midiator
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: MIDIator - A a nice Ruby interface to your system's MIDI services.
+test_files: 
+- spec/driver_registry_spec.rb
+- spec/driver_spec.rb
+- spec/interface_spec.rb
+- spec/string_extensions_spec.rb