blinkenlights 0.0.3 → 0.0.4

data/CHANGES

@@ -1,3 +1,8 @@
+2006-06-09 - 0.0.4  * Added unit tests.
+                    * Disabled autorequire in Rakefile
+                    * closed BlinkenLights instances now throw IO::Error on
+                      Windows, too.
+                    * Improved documentation further.
 2006-06-08 - 0.0.3  * Added support for Windows. The relevant code parts were
                       contributed by Dave Burt <dave@burt.id.au>. Thanks a lot!
 2005-10-18 - 0.0.2  * Some small bugs fixed

data/Rakefile

@@ -12,6 +12,7 @@ task :install  do
   ruby 'install.rb'
 end
 
+desc "Creating documentation"
 task :doc do
   ruby 'make_doc.rb'
 end
@@ -22,6 +23,11 @@ task :clean do
   rm_rf 'coverage'
 end
 
+desc "Testing library"
+task :test do
+  ruby '-I lib tests/test.rb'
+end
+
 spec = Gem::Specification.new do |s|
   #### Basic information.
 
@@ -44,7 +50,7 @@ spec = Gem::Specification.new do |s|
   #### Load-time details: library and application (you will need one or both).
 
   s.require_path = 'lib'                         # Use these for libraries.
-  s.autorequire = 'blinkenlights'
+  #s.autorequire = 'blinkenlights'
 
   #s.bindir = "bin"                               # Use these for applications.
   #s.executables = ["bla.rb"]
@@ -55,7 +61,7 @@ spec = Gem::Specification.new do |s|
   s.has_rdoc = true
   #s.extra_rdoc_files = rd.rdoc_files.reject { |fn| fn =~ /\.rb$/ }.to_a
   s.rdoc_options << '--title' <<  'BlinkenLights in Ruby' << '--main' << 'BlinkenLights'
-  #s.test_files << 'tests/runner.rb'
+  s.test_files << 'tests/test.rb'
 
   #### Author and project details.
 

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/lib/blinkenlights.rb

@@ -112,13 +112,29 @@ class BlinkenLights
     LED_ALL     = 7
 
     if defined? ::Win32API
-      # Mapping from Unix LEDs to Windows LEDs
-      WINDOWS_LEDS = { LED_SCR => 0x91, LED_NUM => 0x90, LED_CAP => 0x14 }
+      # Windows Virtual Key code for caps lock
+      VK_CAPITAL  = 0x14
 
-      # Windows key released
-      WIN_KEY_UP = 0x26
+      # Windows Virtual Key code for num lock
+      VK_NUMLOCK  = 0x90
+
+      # Windows Virtual Key code for scroll lock
+      VK_SCROLL   = 0x91
+
+      # Mapping from UNIX LEDs to Windows Virtual Key codes
+      WINDOWS_LEDS = {
+        LED_SCR => VK_SCROLL,
+        LED_NUM => VK_NUMLOCK,
+        LED_CAP => VK_CAPITAL
+      }
 
+      # Windows key released: Windows keybd_event() constant KEYEVENTF_KEYUP
+      WIN_KEY_UP = 0x26
+     
+      # Win32API GetKeyState function
       GetKeyState = ::Win32API.new("user32", "GetKeyState", ["i"], "i")
+
+      # Win32API Keybd_event function
       Keybd_event = ::Win32API.new("user32", "keybd_event", %w[i i i i], "v")
     end
   end
@@ -153,9 +169,15 @@ class BlinkenLights
   # the BlinkenLights#close method is called.
   def self.open(tty = DEF_TTY, delay = DEF_DELAY)
     obj = new(tty, delay)
-    yield obj
-  ensure
-    obj.close if obj
+    if block_given?
+      begin
+        yield obj
+      ensure
+        obj.close if obj
+      end
+    else
+      obj
+    end
   end
 
   # Close the open console tty after resetting LEDs to the original state.
@@ -165,6 +187,10 @@ class BlinkenLights
     self
   end
 
+  def closed?
+    @tty.closed?
+  end
+
   # Resets the LED state to the starting state (when the BlinkenLights object
   # was created).
   def reset
@@ -194,8 +220,8 @@ class BlinkenLights
 
   # Set LEDs to _number_ in binary digital mode.
   def digital=(number)
-    number  %= 8
-    setting  = 0
+    number %= 8
+    setting = 0
     0.upto(2) do |i|
       if number[i] == 1
         setting |= 1 << DIGITAL.index(LEDS[2 - i])
@@ -419,6 +445,7 @@ class BlinkenLights
 
   if defined? ::Win32API
     def set(number) # :nodoc:
+      raise IOError, 'closed stream' if closed?
       WINDOWS_LEDS.each do |nix, win|
         if (number & nix != 0) ^ (GetKeyState.call(win) != 0)
           Keybd_event.call(win, 0, 0, 0)
@@ -430,6 +457,7 @@ class BlinkenLights
     end
 
     def get # :nodoc:
+      raise IOError, 'closed stream' if closed?
       WINDOWS_LEDS.inject(0) do |sum, (nix, win)|
         sum | ((GetKeyState.call(win) != 0) ? nix : 0)
       end

data/tests/test.rb

@@ -0,0 +1,206 @@
+#!/usr/bin/env ruby
+
+base = File.basename(Dir.pwd)
+if base == 'tests' || base =~ /file-tail/
+	Dir.chdir('..') if base == 'tests'
+	$LOAD_PATH.unshift(File.join(Dir.pwd, 'lib'))
+end
+
+require 'test/unit'
+require 'blinkenlights'
+
+class TC_BlinkenLights < Test::Unit::TestCase
+  def setup
+    @bl = BlinkenLights.new
+    @old_leds = get_leds
+  end
+
+  def get_leds
+    [ @bl.left, @bl.middle, @bl.right ]
+  end
+
+  def teardown
+    @bl.close unless @bl.closed?
+  end
+
+  def test_close
+    assert !@bl.closed?
+    @bl.close
+    assert @bl.closed?
+    assert_raises(IOError) { @bl.flash }
+  end
+  
+  def test_block_open
+    bl2 = BlinkenLights.open do |bl|
+      assert !bl.closed?
+      assert bl.flash
+      :foo
+    end
+    assert_equal :foo, bl2
+  end
+
+  def test_no_block_open
+    bl2 = BlinkenLights.open
+    assert_kind_of BlinkenLights, bl2
+    assert bl2.close
+  end
+
+  def test_reset
+    @bl.random
+    @bl.reset
+    assert_equal get_leds, @old_leds
+  end
+
+  def test_off
+    @bl.random
+    @bl.off
+    assert !@bl.left
+    assert !@bl.middle
+    assert !@bl.right
+  end
+
+  def test_on
+    @bl.random
+    @bl.on
+    assert @bl.left
+    assert @bl.middle
+    assert @bl.right
+  end
+
+  def test_on
+    @bl.random
+    @bl.flash
+    assert !@bl.left
+    assert !@bl.middle
+    assert !@bl.right
+  end
+
+  def test_digital
+    @bl.random
+    for i in 0..8
+      @bl.digital = i
+      assert_equal i % 8, @bl.digital
+    end
+  end
+
+  def test_left_to_right
+    @bl.random
+    @bl.left_to_right
+    assert !@bl.left
+    assert !@bl.middle
+    assert @bl.right
+  end
+
+  def test_right_to_left
+    @bl.random
+    @bl.right_to_left
+    assert @bl.left
+    assert !@bl.middle
+    assert !@bl.right
+  end
+
+  def test_circle
+    @bl.random
+    @bl.circle
+    assert @bl.left
+    assert !@bl.middle
+    assert !@bl.right
+  end
+
+  def test_reverse_circle
+    @bl.random
+    @bl.reverse_circle
+    assert !@bl.left
+    assert !@bl.middle
+    assert @bl.right
+  end
+
+  def test_converge
+    @bl.random
+    @bl.converge
+    assert !@bl.left
+    assert @bl.middle
+    assert !@bl.right
+  end
+  
+  def test_diverge
+    @bl.random
+    @bl.diverge
+    assert @bl.left
+    assert !@bl.middle
+    assert @bl.right
+  end
+
+  def test_left
+    @bl.random
+    @bl.left = false
+    assert !@bl.left
+    @bl.left = true
+    assert @bl.left
+    @bl.toggle_left
+    assert !@bl.left
+    @bl.toggle_left
+    assert @bl.left
+  end
+
+  def test_middle
+    @bl.random
+    @bl.middle = false
+    assert !@bl.middle
+    @bl.middle = true
+    assert @bl.middle
+    @bl.toggle_middle
+    assert !@bl.middle
+    @bl.toggle_middle
+    assert @bl.middle
+  end
+
+  def test_right
+    @bl.random
+    @bl.right = false
+    assert !@bl.right
+    @bl.right = true
+    assert @bl.right
+    @bl.toggle_right
+    assert !@bl.right
+    @bl.toggle_right
+    assert @bl.right
+  end
+
+  def test_num
+    @bl.random
+    @bl.num = false
+    assert !@bl.num
+    @bl.num = true
+    assert @bl.num
+    @bl.toggle_num
+    assert !@bl.num
+    @bl.toggle_num
+    assert @bl.num
+  end
+
+  def test_cap
+    @bl.random
+    @bl.cap = false
+    assert !@bl.cap
+    @bl.cap = true
+    assert @bl.cap
+    @bl.toggle_cap
+    assert !@bl.cap
+    @bl.toggle_cap
+    assert @bl.cap
+  end
+
+  def test_scr
+    @bl.random
+    @bl.scr = false
+    assert !@bl.scr
+    @bl.scr = true
+    assert @bl.scr
+    @bl.toggle_scr
+    assert !@bl.scr
+    @bl.toggle_scr
+    assert @bl.scr
+  end
+end
+  # vim: set noet sw=2 ts=2:

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: blinkenlights
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
-date: 2006-04-08 00:00:00 +02:00
+  version: 0.0.4
+date: 2006-04-09 00:00:00 +02:00
 summary: Control the Blinkenlights on your keyboard from Ruby
 require_paths: 
 - lib
@@ -12,7 +12,7 @@ email: flori@ping.de
 homepage: http://blinkenlights.rubyforge.org
 rubyforge_project: blinkenlights
 description: ""
-autorequire: blinkenlights
+autorequire: 
 default_executable: 
 bindir: bin
 has_rdoc: true
@@ -33,15 +33,17 @@ files:
 - GPL
 - Rakefile
 - VERSION
+- tests
 - CHANGES
 - lib
 - make_doc.rb
 - README.en
 - examples/netblinker.rb
 - examples/loadbar.rb
+- tests/test.rb
 - lib/blinkenlights.rb
-test_files: []
-
+test_files: 
+- tests/test.rb
 rdoc_options: 
 - --title
 - BlinkenLights in Ruby