added the NOTES file

fixed the version generation code
proxy server now outputs some information
the rakefile can now deploy the project


git-svn-id: svn://hasno.info/ruby-hl7/trunk@23 72d81af0-b0fa-4b65-b54c-2b622d79b57a

Author: segfault

NOTES

@@ -0,0 +1,4 @@
+$Id$
+== Ruby-HL7 v0.1.23 Release Notes
+ Initial public release, please see the 
+ README for information about the project.

README

@@ -1,7 +1,8 @@
 =Ruby HL7 Library README
 
 A simple way to parse and create hl7 2.x messages with ruby.
-Examples can be found in lib/ruby-hl7.rb
+Examples can be found in HL7::Message
+The version id can be found in the HL7::VERSION constant.
 
 * Bug tracking: http://trac.hasno.info/ruby-hl7
 * Subversion: svn://hasno.info/ruby-hl7

Rakefile

@@ -5,12 +5,41 @@ require 'rake/testtask'
 require 'rake/rdoctask'
 require 'rake/packagetask'
 require 'rake/gempackagetask'
+require 'rake/contrib/sshpublisher'
+require 'rbconfig'
+require 'rubyforge'
+
 $: << './lib'
 require 'ruby-hl7'
 
+# Many of these tasks were garnered from zenspider's Hoe
+# just forced to work my way
+
+
+spec = Gem::Specification.new do |s| 
+  s.name = "Ruby-HL7"
+  s.version = HL7::VERSION
+  s.author = "Mark Guzman"
+  s.email = "[email protected]"
+  s.homepage = "http://rubyforge.org/ruby-hl7"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Ruby HL7 Library"
+  s.rubyforge_project = "ruby-hl7"
+  s.description = "A simple library to parse and generate HL7 2.x messages"
+  s.files = FileList["{bin,lib,test_data}/**/*"].to_a
+  s.require_path = "lib"
+  s.autorequire = "ruby-hl7"
+  s.test_files = FileList["{test}/**/test*.rb"].to_a
+  s.has_rdoc = true
+  s.extra_rdoc_files = %w[README LICENSE]
+  s.add_dependency("facets", ">= 1.8.51")
+  s.add_dependency("rake", ">= #{RAKEVERSION}")
+  s.add_dependency("rubyforge", ">= #{::RubyForge::VERSION}")
+end
+
 
 Rake::TestTask.new do |t|
-  t.test_files = FileList[ 'test/test*.rb' ]
+  t.test_files = FileList[ 'test/test*.rb', 'test/*test.rb' ]
   t.verbose = true
 end
 
@@ -28,30 +57,75 @@ namespace :test do
   task :heckle do
     system("heckle HL7::Message")
   end
+
+  desc 'Show which test files fail when run alone.'
+  task :deps do
+    tests = Dir["test/**/test_*.rb"]  +  Dir["test/**/*_test.rb"]
+
+    tests.each do |test|
+      if not system "ruby -Ibin:lib:test #{test} &> /dev/null" then
+        puts "Dependency Issues: #{test}"
+      end
+    end
+  end
 end
 
 Rake::RDocTask.new do |rd|
   rd.main = "README"
   rd.rdoc_files.include("README", "LICENSE", "lib/**/*.rb")
+  rd.title = "%s (%s) Documentation" % [ spec.name, spec.version ]
+  rd.rdoc_dir = 'doc'
 end
 
-spec = Gem::Specification.new do |s| 
-  s.name = "Ruby-HL7"
-  s.version = HL7::VERSION
-  s.author = "Mark Guzman"
-  s.email = "[email protected]"
-  s.homepage = "http://rubyforge.org/ruby-hl7"
-  s.platform = Gem::Platform::RUBY
-  s.summary = "Ruby HL7 Library"
-  s.files = FileList["{bin,lib,test_data}/**/*"].to_a
-  s.require_path = "lib"
-  s.autorequire = "ruby-hl7"
-  s.test_files = FileList["{test}/**/test*.rb"].to_a
-  s.has_rdoc = true
-  s.extra_rdoc_files = %w[README LICENSE]
-  s.add_dependency("facets", ">= 0.0.0")
-end
- 
+
 Rake::GemPackageTask.new(spec) do |pkg| 
   pkg.need_tar = true 
 end 
+
+desc 'Clean up all the extras'
+task :clean => [ :clobber_rdoc, :clobber_package ] do
+  %w[*.gem ri coverage*].each do |pattern|
+    files = Dir[pattern]
+    rm_rf files unless files.empty?
+  end
+end
+
+desc 'Publish RDoc to RubyForge'
+task :publish_docs => [:clean, :rdoc] do
+  config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
+  host = "#{config["username"]}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{spec.rubyforge_project}"
+  local_dir = 'doc'
+  sh %{rsync -av --delete #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Package and upload the release to rubyforge.'
+task :release => [:clean, :package] do |t|
+  v = ENV["VERSION"] or abort "Must supply VERSION=x.y.z"
+  abort "Versions don't match #{v} vs #{spec.version}" if v != spec.version
+  pkg = "pkg/#{spec.name}-#{spec.version}"
+
+  if $DEBUG then
+    puts "release_id = rf.add_release #{spec.rubyforge_project.inspect}, #{spec.name.inspect}, #{version.inspect}, \"#{pkg}.tgz\""
+    puts "rf.add_file #{spec.rubyforge_project.inspect}, #{spec.name.inspect}, release_id, \"#{pkg}.gem\""
+  end
+
+  rf = RubyForge.new
+  puts "Logging in"
+  rf.login
+
+  c = rf.userconfig
+  c["release_notes"] = spec.description if spec.description
+  c["release_changes"] = changes if changes
+  c["preformatted"] = true
+
+  files = ["#{pkg}.tgz", "#{pkg}.gem"].compact
+
+  puts "Releasing #{spec.name} v. #{spec.version}"
+  rf.add_release spec.rubyforge_project, spec.name, spec.version, *files
+end
+
+desc 'Install the package as a gem'
+task :install_gem => [:clean, :package] do
+  sh "sudo gem install pkg/*.gem"
+end

examples/proxy_server.rb

@@ -1,18 +1,23 @@
 # $Id$
 # Ruby-HL7 Proxy Server Example
+require 'rubygems'
 require 'ruby-hl7'
 require 'thread'
 require 'socket'
 
-srv = TCPServer.new(2402)
+PORT = 2402
 target_ip = "127.0.0.1"
 target_port = 5900
 
+srv = TCPServer.new(PORT)
+puts "proxy_server listening on port: %i" % PORT
+puts "proxying for: %s:%i" % [ target_ip, target_port ]
 while true
   sok = srv.accept
   Thread.new( sok ) do |my_socket|
     raw_inp = my_socket.readlines
     msg = HL7::Message.new( raw_input )
+    puts "forwarding message:\n%s" % msg.to_s
     soc = TCPSocket.open( target_ip, target_port )
     soc.write msg.to_mllp
     soc.close

lib/ruby-hl7.rb

@@ -21,7 +21,7 @@
 require 'facets/core/class/cattr'
 
 module HL7 # :nodoc:
-  VERSION = "0.1.%s" % "$Rev$".gsub(/\$Rev:\s+/, '').gsub(/\$$/, '')
+  VERSION = "0.1.%s" % "$Rev$".gsub(/\$Rev:\s+/, '').gsub(/\s*\$$/, '')
 end
 
 # Encapsulate HL7 specific exceptions
@@ -261,6 +261,20 @@ def generate_segments( ary )
 # The segments can be setup to provide aliases to specific fields with
 # optional validation code that is run when the field is modified
 # The segment field data is also accessible via the e<number> method.
+#
+# == Defining a New Segment
+#  class HL7::Message::Segment::NK1 < HL7::Message::Segment
+#    wieght 100 # segments are sorted ascendingly
+#    add_field :name=>:something_you_want       # assumes :idx=>1
+#    add_field :name=>:something_else, :idx=>6  # :idx=>6 and field count=6
+#    add_field :name=>:something_more           # :idx=>7
+#    add_field :name=>:block_example do |value|
+#      raise HL7::InvalidDataError.new unless value.to_i < 100 && value.to_i > 10
+#      return value
+#    end 
+#    # this block will be executed when seg.block_example= is called
+#    # and when seg.block_example is called
+#      
 class HL7::Message::Segment
   attr :element_delim
   attr :item_delim