blinkenlights 0.0.4 → 0.1.0

data/CHANGES

@@ -1,3 +1,6 @@
+2009-07-19 - 0.1.0  * Some cleanup.
+                    * Added VERSION constants.
+                    * Build gemspec file.
 2006-06-09 - 0.0.4  * Added unit tests.
                     * Disabled autorequire in Rakefile
                     * closed BlinkenLights instances now throw IO::Error on

data/Rakefile

@@ -1,11 +1,25 @@
-require 'rake/gempackagetask'
+begin
+  require 'rake/gempackagetask'
+rescue LoadError
+end
+require 'rake/clean'
 require 'rbconfig'
-
 include Config
 
 PKG_NAME = 'blinkenlights'
 PKG_VERSION = File.read('VERSION').chomp
-PKG_FILES = FileList["**/*"].exclude(/CVS|^pkg|^coverage|^doc/)
+PKG_FILES = FileList['**/*'].exclude(/^(doc|CVS|pkg|coverage)/)
+CLEAN.include 'coverage', 'doc'
+
+desc "Run unit tests"
+task :test do
+  sh %{RUBYOPT="-Ilib $RUBYOPT" testrb tests/*.rb}
+end
+
+desc "Testing library with coverage"
+task :coverage do
+  sh 'rcov -x tests -Ilib tests/*.rb'
+end
 
 desc "Installing library"
 task :install  do
@@ -17,64 +31,63 @@ task :doc do
   ruby 'make_doc.rb'
 end
 
-desc "Removing generated files"
-task :clean do
-  rm_rf 'doc'
-  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.
+if defined? Gem
+  spec_src = <<GEM
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name = '#{PKG_NAME}'
+  s.version = '#{PKG_VERSION}'
+  s.summary = 'Control the Blinkenlights on your keyboard with Ruby'
+  s.description =
+    'This library allows you to turn the keyboard LEDs on and of with Ruby.'
 
-  s.name = 'blinkenlights'
-  s.version = PKG_VERSION
-  s.summary = "Control the Blinkenlights on your keyboard from Ruby"
-  s.description = ""
+  s.files = #{PKG_FILES.to_a.sort.inspect}
 
-  #### Dependencies and requirements.
-
-  #s.add_dependency('log4r', '> 1.0.4')
-  #s.requirements << ""
-
-  s.files = PKG_FILES
-
-  #### C code extensions.
-
-  #s.extensions << "ext/extconf.rb"
-
-  #### Load-time details: library and application (you will need one or both).
-
-  s.require_path = 'lib'                         # Use these for libraries.
-  #s.autorequire = 'blinkenlights'
-
-  #s.bindir = "bin"                               # Use these for applications.
-  #s.executables = ["bla.rb"]
-  #s.default_executable = "bla.rb"
-
-  #### Documentation and testing.
+  s.require_path = 'lib'
 
   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.rdoc_options << '--title' <<  'BlinkenLights in Ruby' << '--main' << 'doc-main.txt'
+  s.extra_rdoc_files << 'doc-main.txt'
   s.test_files << 'tests/test.rb'
 
-  #### Author and project details.
-
   s.author = "Florian Frank"
   s.email = "flori@ping.de"
-  s.homepage = "http://blinkenlights.rubyforge.org"
-  s.rubyforge_project = "blinkenlights"
+  s.homepage = "http://#{PKG_NAME}.rubyforge.org"
+  s.rubyforge_project = "#{PKG_NAME}"
+end
+GEM
+
+  desc 'Create a gemspec file'
+  task :gemspec do
+    File.open("#{PKG_NAME}.gemspec", 'w') do |f|
+      f.puts spec_src
+    end
+  end
+
+  spec = eval(spec_src)
+  Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.need_tar = true
+    pkg.package_files += PKG_FILES
+  end
 end
 
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.need_tar = true
-  pkg.package_files += PKG_FILES
+desc m = "Writing version information for #{PKG_VERSION}"
+task :version do
+  puts m
+  File.open(File.join('lib', PKG_NAME, 'version.rb'), 'w') do |v|
+    v.puts <<EOT
+class BlinkenLights
+  # BlinkenLights version
+  VERSION         = '#{PKG_VERSION}'
+  VERSION_ARRAY   = VERSION.split(/\\./).map { |x| x.to_i } # :nodoc:
+  VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
+  VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:
+  VERSION_BUILD   = VERSION_ARRAY[2] # :nodoc:
+end
+EOT
+  end
 end
 
-task :release => [ :clean, :package ]
-  # vim: set et sw=2 ts=2:
+task :default => [ :version, :gemspec, :test ]
+
+task :release => [ :clean, :version, :gemspec, :package ]

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.1.0

data/blinkenlights.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name = 'blinkenlights'
+  s.version = '0.1.0'
+  s.summary = 'Control the Blinkenlights on your keyboard with Ruby'
+  s.description =
+    'This library allows you to turn the keyboard LEDs on and of with Ruby.'
+
+  s.files = ["CHANGES", "COPYING", "README", "Rakefile", "VERSION", "blinkenlights.gemspec", "examples", "examples/loadbar.rb", "examples/netblinker.rb", "install.rb", "lib", "lib/blinkenlights", "lib/blinkenlights.rb", "lib/blinkenlights/version.rb", "make_doc.rb", "tests", "tests/test.rb"]
+
+  s.require_path = 'lib'
+
+  s.has_rdoc = true
+  s.rdoc_options << '--title' <<  'BlinkenLights in Ruby' << '--main' << 'doc-main.txt'
+  s.extra_rdoc_files << 'doc-main.txt'
+  s.test_files << 'tests/test.rb'
+
+  s.author = "Florian Frank"
+  s.email = "flori@ping.de"
+  s.homepage = "http://blinkenlights.rubyforge.org"
+  s.rubyforge_project = "blinkenlights"
+end

data/doc-main.txt

@@ -0,0 +1,56 @@
+== BlinkenLights - Controlling the keyboard LEDs from Ruby
+
+=== Author
+
+Florian Frank mailto:flori@ping.de
+
+=== License
+
+This is free software; you can redistribute it and/or modify it under the
+terms of the GNU General Public License Version 2 as published by the Free
+Software Foundation: www.gnu.org/copyleft/gpl.html
+
+=== Download
+
+The latest version of <b>blinkenlights</b> can be found at
+
+* http://rubyforge.org/frs/?group_id=1021
+
+The homepage of this library is located at
+
+* http://blinkenlights.rubyforge.org
+
+=== Description
+
+This Ruby library is named after an old joke, see
+  http://catb.org/~esr/jargon/html/B/blinkenlights.html
+
+It enables you to control the LEDs on your keyboard to signal digital numbers
+between 0 and 7, events like received/transmitted network packets, or just
+let them blink in visually pleasing patterns.
+
+*Beware*: If you use BlinkenLights under Windows, not only the leds are
+switched on/off but also the related keys are pressed/unpressed! This could
+be quite confusing. ;)
+
+=== Examples
+
+The block form opens the TTY, that controls the LEDs, and closes/resets
+the LEDs  it after the block has been processed:
+ require 'blinkenlights'
+ BlinkenLights.open do |bl|
+   bl.off
+   bl.circle
+ end
+
+It's also possible to manually close the object:
+ require 'blinkenlights'
+ bl = BlinkenLights.new
+ bl.off
+ 100.times { bl.random }
+ bl.close
+
+There are also two short examples examples/netblinker.rb and
+examples/loadbar.rb in the distribution directory of this library, that show
+how to let the lights blink if network packets are received/transmitted on
+your host or to indicate how high the cpu load average is.

data/install.rb

@@ -9,4 +9,3 @@ dest = CONFIG["sitelibdir"]
 mkdir_p(dest)
 file = 'lib/blinkenlights.rb'
 install(file, dest)
-    # vim: set et sw=4 ts=4:

data/lib/blinkenlights.rb

@@ -2,69 +2,15 @@ begin
   require 'Win32API'
 rescue LoadError
 end
+require 'blinkenlights/version'
 
-# = blinkenlights.rb - Controlling the keyboard LEDs from Ruby
-#
-# == Author
-#
-# Florian Frank mailto:flori@ping.de
-#
-# == License
-#
-# This is free software; you can redistribute it and/or modify it under the
-# terms of the GNU General Public License Version 2 as published by the Free
-# Software Foundation: www.gnu.org/copyleft/gpl.html
-#
-# == Download
-#
-# The latest version of <b>blinkenlights</b> can be found at
-#
-# * http://rubyforge.org/frs/?group_id=1021
-#
-# The homepage of this library is located at
-#
-# * http://blinkenlights.rubyforge.org
-#
-# == Description
-#
-# This Ruby library is named after an old joke, see
-#   http://catb.org/~esr/jargon/html/B/blinkenlights.html
-#
-# It enables you to control the LEDs on your keyboard to signal digital numbers
-# between 0 and 7, events like received/transmitted network packets, or just
-# let them blink in visually pleasing patterns.
-#
-# *Beware*: If you use BlinkenLights under Windows, not only the leds are
-# switched on/off but also the related keys are pressed/unpressed! This could
-# be quite confusing. ;)
-# 
-# == Examples
-#
-# The block form opens the TTY, that controls the LEDs, and closes/resets
-# the LEDs  it after the block has been processed:
-#  require 'blinkenlights'
-#  BlinkenLights.open do |bl|
-#    bl.off
-#    bl.circle
-#  end
-#
-# It's also possible to manually close the object:
-#  require 'blinkenlights'
-#  bl = BlinkenLights.new
-#  bl.off
-#  100.times { bl.random }
-#  bl.close
-#
-# There are also two short examples examples/netblinker.rb and
-# examples/loadbar.rb in the distribution directory of this library, that show
-# how to let the lights blink if network packets are received/transmitted on
-# your host or to indicate how high the cpu load average is.
+# Class that implements the functionality of the BlinkenLights library.
 class BlinkenLights
 
   # Module to hold the BlinkenLights constants.
   module Constants
     # The default tty. It happens to be the one, I run X on. ;)
-    DEF_TTY   = '/dev/tty8'
+    DEF_TTY   = ENV['BLINKENLIGHTS_TTY'] || '/dev/tty7'
 
     # DEF_DELAY is the default standard delay in seconds, that is slept
     # everytime the LED state is changed. If it is too small your keyboard may
@@ -187,6 +133,7 @@ class BlinkenLights
     self
   end
 
+  # Return true if the constants tty has been closed.
   def closed?
     @tty.closed?
   end

data/lib/blinkenlights/version.rb

@@ -0,0 +1,8 @@
+class BlinkenLights
+  # BlinkenLights version
+  VERSION         = '0.1.0'
+  VERSION_ARRAY   = VERSION.split(/\./).map { |x| x.to_i } # :nodoc:
+  VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
+  VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:
+  VERSION_BUILD   = VERSION_ARRAY[2] # :nodoc:
+end

data/make_doc.rb

@@ -3,5 +3,4 @@
 require 'rbconfig'
 bindir = Config::CONFIG['bindir']
 
-system "#{bindir}/ruby #{bindir}/rdoc -m BlinkenLights lib/blinkenlights.rb"
-    # vim: set et sw=4 ts=4:
+system "#{bindir}/ruby #{bindir}/rdoc -d -m doc-main.txt doc-main.txt lib/blinkenlights.rb"

data/tests/test.rb

@@ -1,206 +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:
+#!/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

@@ -1,61 +1,71 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
-specification_version: 1
 name: blinkenlights
 version: !ruby/object:Gem::Version 
-  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
-email: flori@ping.de
-homepage: http://blinkenlights.rubyforge.org
-rubyforge_project: blinkenlights
-description: ""
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.1.0
 platform: ruby
-signing_key: 
-cert_chain: 
 authors: 
 - Florian Frank
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-19 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: This library allows you to turn the keyboard LEDs on and of with Ruby.
+email: flori@ping.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- doc-main.txt
 files: 
-- examples
-- install.rb
-- GPL
+- CHANGES
+- COPYING
+- README
 - Rakefile
 - VERSION
-- tests
-- CHANGES
-- lib
-- make_doc.rb
-- README.en
-- examples/netblinker.rb
+- blinkenlights.gemspec
 - examples/loadbar.rb
-- tests/test.rb
+- examples/netblinker.rb
+- install.rb
 - lib/blinkenlights.rb
-test_files: 
+- lib/blinkenlights/version.rb
+- make_doc.rb
 - tests/test.rb
+- doc-main.txt
+has_rdoc: true
+homepage: http://blinkenlights.rubyforge.org
+licenses: []
+
+post_install_message: 
 rdoc_options: 
 - --title
 - BlinkenLights in Ruby
 - --main
-- BlinkenLights
-extra_rdoc_files: []
-
-executables: []
-
-extensions: []
-
+- doc-main.txt
+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: []
 
-dependencies: []
-
+rubyforge_project: blinkenlights
+rubygems_version: 1.3.2
+signing_key: 
+specification_version: 3
+summary: Control the Blinkenlights on your keyboard with Ruby
+test_files: 
+- tests/test.rb