ruby-hl7 0.1.23 → 0.2.44

data/lib/ruby-hl7.rb

@@ -9,7 +9,7 @@
 #
 # License:   BSD  
 #
-#  $Id: ruby-hl7.rb 23 2007-03-18 01:33:12Z segfault $
+#  $Id: ruby-hl7.rb 44 2007-08-05 21:51:28Z segfault $
 # 
 # == License
 # see the LICENSE file 
@@ -19,9 +19,10 @@ require 'rubygems'
 require "stringio"
 require "date"
 require 'facets/core/class/cattr'
+require 'facets/core/proc/bind'
 
 module HL7 # :nodoc:
-  VERSION = "0.1.%s" % "$Rev: 23 $".gsub(/\$Rev:\s+/, '').gsub(/\s*\$$/, '')
+  VERSION = "0.2.%s" % "$Rev: 44 $".gsub(/\$Rev:\s+/, '').gsub(/\s*\$$/, '')
 end
 
 # Encapsulate HL7 specific exceptions
@@ -80,7 +81,7 @@ class HL7::Message
   # setup a new hl7 message
   # raw_msg:: is an optional object containing an hl7 message
   #           it can either be a string or an Enumerable object
-  def initialize( raw_msg=nil )
+  def initialize( raw_msg=nil, &blk )
     @segments = []
     @segments_by_name = {}
     @item_delim = "^"
@@ -88,6 +89,10 @@ class HL7::Message
     @segment_delim = "\r"
 
     parse( raw_msg ) if raw_msg
+
+    if block_given?
+      blk.call self
+    end
   end
 
   # access a segment of the message
@@ -100,7 +105,7 @@ class HL7::Message
       ret = @segments[ index ]
     elsif (index.respond_to? :to_sym)
       ret = @segments_by_name[ index.to_sym ]
-      ret = ret.first if ret.length == 1
+      ret = ret.first if ret && ret.length == 1
     end
 
     ret
@@ -117,9 +122,13 @@ class HL7::Message
 
     if index.kind_of?(Range) || index.kind_of?(Fixnum)
       @segments[ index ] = value
-    else
+    elsif index.respond_to?(:to_sym)
       (@segments_by_name[ index.to_sym ] ||= []) << value
+    else
+      raise HL7::Exception.new( "attempting to use an indice that is not a Range, Fixnum or to_sym providing object" )
     end
+
+    value.segment_parent = self
   end
 
   # return the index of the value if it exists, nil otherwise
@@ -140,10 +149,11 @@ class HL7::Message
       raise HL7::Exception.new( "attempting to append something other than an HL7 Segment" ) 
     end
 
+    value.segment_parent = self unless value.segment_parent
     (@segments ||= []) << value
     name = value.class.to_s.gsub("HL7::Message::Segment::", "").to_sym
     (@segments_by_name[ name ] ||= []) << value
-    sequence_segments # let's auto-set the set-id as we go
+    sequence_segments unless @parsing # let's auto-set the set-id as we go
   end
 
   # parse a String or Enumerable object into an HL7::Message if possible
@@ -172,15 +182,23 @@ class HL7::Message
     return unless @segments
     @segments.each { |s| yield s }
   end
+  
+  # return the segment count
+  def length
+    0 unless @segments
+    @segments.length
+  end
 
   # provide a screen-readable version of the message
-  def to_s                         
-    @segments.join( '\n' )
+  def to_s    
+    segs = @segments.collect { |s| s if s.to_s.length > 0 }
+    segs.join( "\n" )                               
   end
 
   # provide a HL7 spec version of the message
   def to_hl7
-    @segments.join( @segment_delim )
+    segs = @segments.collect { |s| s if s.to_s.length > 0 }
+    segs.join( @segment_delim ) 
   end
 
   # provide the HL7 spec version of the message wrapped in MLLP
@@ -233,27 +251,45 @@ class HL7::Message
   def generate_segments( ary )
     raise HL7::ParseError.new unless ary.length > 0
 
+    @parsing = true
+    last_seg = nil
     ary.each do |elm|
+      last_seg = generate_segment( elm, last_seg )
+    end
+    @parsing = nil
+  end
+
+  def generate_segment( elm, last_seg )
       seg_parts = elm.split( @element_delim, -1 )
       raise HL7::ParseError.new unless seg_parts && (seg_parts.length > 0)
 
       seg_name = seg_parts[0]
-      begin
+      if HL7::Message::Segment.constants.index(seg_name) # do we have an implementation?
         kls = eval("HL7::Message::Segment::%s" % seg_name)
-      rescue Exception
+      else
         # we don't have an implementation for this segment
         # so lets just preserve the data
         kls = HL7::Message::Segment::Default
       end
       new_seg = kls.new( elm )
+      new_seg.segment_parent = self
+      
+      if last_seg && last_seg.respond_to?(:children) && last_seg.accepts?( seg_name )
+        last_seg.children << new_seg
+        new_seg.is_child_segment = true
+        return last_seg
+      end
+        
       @segments << new_seg
 
       # we want to allow segment lookup by name
-      seg_sym = seg_name.to_sym
-      @segments_by_name[ seg_sym ] ||= []
-      @segments_by_name[ seg_sym ] << new_seg
-    end
+      if seg_name && (seg_name.strip.length > 0)
+        seg_sym = seg_name.to_sym
+        @segments_by_name[ seg_sym ] ||= []
+        @segments_by_name[ seg_sym ] << new_seg
+      end
 
+      new_seg 
   end
 end                
 
@@ -276,6 +312,7 @@ end
 #    # and when seg.block_example is called
 #      
 class HL7::Message::Segment
+  attr :segment_parent, true
   attr :element_delim
   attr :item_delim
   attr :segment_weight
@@ -283,10 +320,11 @@ class HL7::Message::Segment
   # setup a new HL7::Message::Segment
   # raw_segment:: is an optional String or Array which will be used as the
   #               segment's field data
-  def initialize(raw_segment="")
+  def initialize(raw_segment="", &blk)
     @segments_by_name = {}
     @element_delim = '|'
     @field_total = 0
+    @is_child = false
 
     if (raw_segment.kind_of? Array)
       @elements = raw_segment
@@ -297,6 +335,27 @@ class HL7::Message::Segment
         @elements << ""
       end
     end
+
+    if block_given?
+      callctx = eval( "self", blk )
+      def callctx.__seg__(val=nil)
+        @__seg_val__ ||= val
+      end
+      callctx.__seg__(self)
+      # TODO: find out if this pollutes the calling namespace permanently...
+      
+      to_do = <<-END
+      def method_missing( sym, *args, &blk )
+        __seg__.send( sym, args, blk )  
+      end
+      END
+
+      eval( to_do, blk )
+      yield self 
+      eval( "undef method_missing", blk )
+      #eval( "undef __seg__", blk )
+      #eval( "remove_instance_variable '@__seg_val__'", blk )
+    end
   end
 
   def to_info
@@ -330,10 +389,17 @@ class HL7::Message::Segment
     if sym.to_s.include?( "=" )
       write_field( base_sym, args )
     else
-      read_field( base_sym )
+
+      if args.length > 0
+        write_field( base_sym, args )
+      else
+        read_field( base_sym )
+      end
+
     end
   end
 
+  # sort-compare two Segments, 0 indicates equality
   def <=>( other ) 
     return nil unless other.kind_of?(HL7::Message::Segment)
 
@@ -349,12 +415,29 @@ class HL7::Message::Segment
     self.class.weight
   end
 
+
+  # return true if the segment has a parent 
+  def is_child_segment?
+    (@is_child_segment ||= false)
+  end
+
+  # indicate whether or not the segment has a parent
+  def is_child_segment=(val)
+    @is_child_segment = val
+  end
+
+  # get the length of the segment (number of fields it contains)
+  def length
+    0 unless @elements
+    @elements.length
+  end
+
+
   private
   def self.singleton #:nodoc:
     class << self; self end
   end
 
-
   # DSL element to define a segment's sort weight
   # returns the segment's current weight by default
   # segments are sorted ascending
@@ -374,19 +457,32 @@ class HL7::Message::Segment
 
   # allows a segment to store other segment objects
   # used to handle associated lists like one OBR to many OBX segments
-  def self.has_children
+  def self.has_children(child_types)
+    @child_types = child_types
+    define_method(:child_types) do
+      @child_types
+    end
+
     self.class_eval do
       define_method(:children) do
         unless @my_children
+          p = self
           @my_children ||= []
           @my_children.instance_eval do
+            @parental = p
             alias :old_append :<<
 
             def <<(value)
               unless (value && value.kind_of?(HL7::Message::Segment))
                 raise HL7::Exception.new( "attempting to append non-segment to a segment list" )
               end
-        
+
+              value.segment_parent = @parental
+              k = @parental
+              while (k && k.segment_parent && !k.segment_parent.kind_of?(HL7::Message))
+                k = k.segment_parent
+              end
+              k.segment_parent << value if k && k.segment_parent
               old_append( value )
             end
           end
@@ -395,20 +491,12 @@ class HL7::Message::Segment
         @my_children
       end
 
-      alias :my_to_s :to_s
-      define_method(:to_s) do
-        out = my_to_s
-        if @my_children
-          @my_children.each do |seg|
-            out << '\r'
-            out << seg.to_s
-          end
-        end
-        out
+      define_method('accepts?') do |t|
+        t = t.to_sym if t && (t.to_s.length > 0) && t.respond_to?(:to_sym)
+        child_types.index t
       end
-    end
-      
-  end
+    end 
+  end 
 
   # define a field alias 
   # * options is a hash of parameters 
@@ -435,8 +523,13 @@ class HL7::Message::Segment
     end
 
     self.class_eval <<-END
-      def #{name}()
-        read_field( :#{namesym} )
+      def #{name}(val=nil)
+        unless val
+          read_field( :#{namesym} )
+        else
+          write_field( :#{namesym}, val )
+          val # this matches existing n= method functionality
+        end
       end
 
       def #{name}=(value)
@@ -491,7 +584,6 @@ class HL7::Message::Segment
 
   @elements = []
 
-
 end
 
 # parse an hl7 formatted date

data/lib/segments/obr.rb

@@ -1,8 +1,8 @@
-# $Id: obr.rb 16 2007-03-14 05:06:36Z segfault $
+# $Id: obr.rb 38 2007-06-27 04:56:09Z segfault $
 require 'ruby-hl7'
 class HL7::Message::Segment::OBR < HL7::Message::Segment
   weight 89 # obr.weight-1
-  has_children
+  has_children [:OBX]
   add_field :name=>:set_id
   add_field :name=>:placer_order_number
   add_field :name=>:filler_order_number

data/lib/segments/obx.rb

@@ -1,7 +1,8 @@
-# $Id: obx.rb 16 2007-03-14 05:06:36Z segfault $
+# $Id: obx.rb 38 2007-06-27 04:56:09Z segfault $
 require 'ruby-hl7'
 class HL7::Message::Segment::OBX < HL7::Message::Segment
   weight 90
+  has_children [:NTE]
   add_field :name=>:set_id
   add_field :name=>:value_type
   add_field :name=>:observation_id

data/lib/segments/pid.rb

@@ -1,4 +1,4 @@
-# $Id: pid.rb 21 2007-03-17 04:49:50Z segfault $
+# $Id: pid.rb 29 2007-05-06 23:13:04Z segfault $
 require 'ruby-hl7'
 class HL7::Message::Segment::PID < HL7::Message::Segment
   weight 1
@@ -10,7 +10,7 @@ class HL7::Message::Segment::PID < HL7::Message::Segment
   add_field :name=>:mother_maiden_name
   add_field :name=>:patient_dob
   add_field :name=>:admin_sex do |sex|
-    unless /^[FMOUAN]$/.match(sex) || sex == nil
+    unless /^[FMOUAN]$/.match(sex) || sex == nil || sex == ""
       raise HL7::InvalidDataError.new( "bad administrative sex value (not F|M|O|U|A|N)" )
     end
     sex = "" unless sex

data/test/test_basic_parsing.rb

@@ -1,4 +1,4 @@
-# $Id: test_basic_parsing.rb 21 2007-03-17 04:49:50Z segfault $
+# $Id: test_basic_parsing.rb 41 2007-06-30 08:06:04Z segfault $
 $: << '../lib'
 require 'test/unit'
 require 'ruby-hl7'
@@ -6,6 +6,8 @@ require 'ruby-hl7'
 class BasicParsing < Test::Unit::TestCase
   def setup
     @simple_msh_txt = open( './test_data/test.hl7' ).readlines.first
+    @empty_txt = open( './test_data/empty.hl7' ).readlines.first
+    @empty_segments_txt = open( './test_data/empty_segments.hl7' ).readlines.first
     @base_msh = "MSH|^~\\&|LAB1||DESTINATION||19910127105114||ORU^R03|LAB1003929"
   end
 
@@ -31,10 +33,14 @@ class BasicParsing < Test::Unit::TestCase
     end
   end
 
+  def test_parse_empty
+    msg = HL7::Message.new @empty_txt
+  end
+
   def test_message_to_string
     msg = HL7::Message.new
     msg.parse @simple_msh_txt
-    orig = @simple_msh_txt.gsub( /\r/, '\n' )
+    orig = @simple_msh_txt.gsub( /\r/, "\n" )
     assert_equal( orig, msg.to_s )
   end
 
@@ -73,6 +79,14 @@ class BasicParsing < Test::Unit::TestCase
     end
   end
 
+  def test_segment_missing_accessor
+    msg = HL7::Message.new
+    msg.parse @simple_msh_txt
+    assert_nothing_raised do
+      assert_equal( nil, msg[:does_not_exist] )
+    end
+  end
+
   def test_segment_string_mutator
     msg = HL7::Message.new
     msg.parse @simple_msh_txt
@@ -262,6 +276,7 @@ class BasicParsing < Test::Unit::TestCase
     #multible obr's with multiple obx's
     msg = HL7::Message.parse( @simple_msh_txt )
     orig_output = msg.to_hl7
+    orig_obx_cnt = msg[:OBX].length
     (1..10).each do |obr_id|
       obr = HL7::Message::Segment::OBR.new
       msg << obr
@@ -274,7 +289,7 @@ class BasicParsing < Test::Unit::TestCase
     assert_not_nil( msg[:OBR] )
     assert_equal( 11, msg[:OBR].length )
     assert_not_nil( msg[:OBX] )
-    assert_equal( 2, msg[:OBX].length ) 
+    assert_equal( 102, msg[:OBX].length ) 
     assert_equal( "2", msg[:OBR][4].children[1].set_id ) # confirm the id's
     assert_equal( "2", msg[:OBR][5].children[1].set_id ) # confirm the id's
 
@@ -303,4 +318,9 @@ class BasicParsing < Test::Unit::TestCase
     end
   end
 
+  def test_empty_segment
+    msg = HL7::Message.new @empty_segments_txt
+
+  end
+
 end

data/test/test_child_segment.rb

@@ -0,0 +1,54 @@
+# $Id: test_child_segment.rb 41 2007-06-30 08:06:04Z segfault $
+$: << '../lib'
+require 'test/unit'
+require 'ruby-hl7'
+
+class ChildSegment < Test::Unit::TestCase
+  def setup
+    @base = open( './test_data/obxobr.hl7' ).readlines
+  end
+
+  def test_access_children
+    msg = HL7::Message.new @base
+    assert_not_nil msg
+    assert_not_nil msg[:OBR]
+    assert_equal( 3, msg[:OBR].length ) 
+    assert_not_nil msg[:OBR].first.children
+    assert_equal( 5, msg[:OBR].first.children.length )
+
+    msg[:OBR].first.children.each do |x|
+      assert_not_nil x
+    end
+  end
+
+  def test_add_children
+    msg = HL7::Message.new @base
+    assert_not_nil msg
+    assert_not_nil msg[:OBR]
+    ob = HL7::Message::Segment::OBR.new
+    assert_not_nil ob
+    
+    msg << ob
+    assert_not_nil ob.children
+    assert_not_nil ob.segment_parent
+    assert_equal(msg, ob.segment_parent)
+    orig_cnt = msg.length
+    
+    (1..4).each do |x|
+      m = HL7::Message::Segment::OBX.new
+      m.observation_value = "taco"
+      assert_not_nil m
+      assert_not_nil /taco/.match( m.to_s )
+      ob.children << m
+      assert_equal(x, ob.children.length)
+      assert_not_nil m.segment_parent
+      assert_equal(ob, m.segment_parent)
+    end
+    
+    assert_not_equal( @base, msg.to_hl7 )
+    assert_not_equal( orig_cnt, msg.length )
+    text_ver = msg.to_hl7
+    assert_not_nil /taco/.match( text_ver )
+  end
+end
+

data/test/test_default_segment.rb

@@ -1,4 +1,4 @@
-# $Id: test_default_segment.rb 20 2007-03-16 04:17:52Z segfault $
+# $Id: test_default_segment.rb 40 2007-06-30 01:29:19Z segfault $
 $: << '../lib'
 require 'test/unit'
 require 'ruby-hl7'

data/test/test_dynamic_segment_def.rb

@@ -0,0 +1,42 @@
+# $Id: test_dynamic_segment_def.rb 40 2007-06-30 01:29:19Z segfault $
+$: << '../lib'
+require 'test/unit'
+require 'ruby-hl7'
+
+class DynamicSegmentDefinition < Test::Unit::TestCase
+  def setup
+  end
+
+  def test_block_definition
+    seg = HL7::Message::Segment.new do |s|
+      s.e0 = "MSK"
+      s.e1 = "1234"
+      s.e2 = "5678"
+    end
+
+    assert_equal( "MSK|1234|5678", seg.to_s )
+  end
+
+  def test_ruby_block_initializer 
+    seg = HL7::Message::Segment.new do
+      e0 "MSK"
+      e1 "1234"
+      e2 "5678"
+    end
+
+    assert_equal( "MSK|1234|5678", seg.to_s )
+  end
+
+  def test_shouldnt_pollute_caller_namespace
+    seg = HL7::Message::Segment.new do |s|
+      s.e0 = "MSK"
+      s.e1 = "1234"
+      s.e2 = "5678"
+    end
+
+    assert_raises(NoMethodError) do
+      e3 "TEST"
+    end
+    assert_equal( "MSK|1234|5678", seg.to_s )
+  end
+end

data/test/test_msa_segment.rb

@@ -1,4 +1,4 @@
-# $Id: test_msa_segment.rb 18 2007-03-15 01:23:10Z segfault $
+# $Id: test_msa_segment.rb 40 2007-06-30 01:29:19Z segfault $
 $: << '../lib'
 require 'test/unit'
 require 'ruby-hl7'

data/test/test_obr_segment.rb

@@ -1,4 +1,4 @@
-# $Id: test_obr_segment.rb 18 2007-03-15 01:23:10Z segfault $
+# $Id: test_obr_segment.rb 40 2007-06-30 01:29:19Z segfault $
 $: << '../lib'
 require 'test/unit'
 require 'ruby-hl7'

data/test/test_obx_segment.rb

@@ -1,4 +1,4 @@
-# $Id: test_obx_segment.rb 18 2007-03-15 01:23:10Z segfault $
+# $Id: test_obx_segment.rb 40 2007-06-30 01:29:19Z segfault $
 $: << '../lib'
 require 'test/unit'
 require 'ruby-hl7'

data/test/test_pid_segment.rb

@@ -1,4 +1,4 @@
-# $Id: test_pid_segment.rb 21 2007-03-17 04:49:50Z segfault $
+# $Id: test_pid_segment.rb 40 2007-06-30 01:29:19Z segfault $
 $: << '../lib'
 require 'test/unit'
 require 'ruby-hl7'
@@ -15,6 +15,7 @@ class PidSegment < Test::Unit::TestCase
       vals.each do |x|
         pid.admin_sex = x
       end
+      pid.admin_sex = ""
     end
 
     assert_raises( HL7::InvalidDataError ) do

data/test/test_speed_parsing.rb

@@ -0,0 +1,19 @@
+# $Id$
+$: << '../lib'
+require 'time'
+require 'test/unit'
+require 'ruby-hl7'
+
+class SpeedParsing < Test::Unit::TestCase
+  def setup
+    @msg = open( "./test_data/lotsunknowns.hl7" ).readlines
+  end
+
+  def test_large_unknown_segments
+    start = Time.now
+    doc = HL7::Message.new @msg
+    assert_not_nil doc
+    ends = Time.now
+    assert ((ends-start) < 1)
+  end 
+end                                               

data/test_data/empty_segments.hl7

@@ -0,0 +1 @@
+MSH|^~\&|LAB1||DESTINATION||19910127105114||ORU^R03|LAB1003929
 

data/test_data/lotsunknowns.hl7

@@ -0,0 +1,2 @@
+MSH|^~\&|MESA_OP|XYZ_HOSPITAL|MESA_OF|XYZ_RADIOLOGY|||ORM^O01|241104|P|2.3.1||||||||
+

data/test_data/obxobr.hl7

@@ -0,0 +1 @@
+MSH|^~\&|RADIS1||DMCRES||19940502161633||ORU|19940502161633|D|2.2|964||AL|AL

data/test_data/test.hl7

@@ -1 +1 @@
-MSH|^~\&|LAB1||DESTINATION||19910127105114||ORU^R03|LAB1003929
 
+MSH|^~\&|LAB1||DESTINATION||19910127105114||ORU^R03|LAB1003929

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.1
+rubygems_version: 0.9.4
 specification_version: 1
 name: ruby-hl7
 version: !ruby/object:Gem::Version 
-  version: 0.1.23
-date: 2007-03-18 00:00:00 -04:00
+  version: 0.2.44
+date: 2007-08-05 00:00:00 -04:00
 summary: Ruby HL7 Library
 require_paths: 
 - lib
@@ -44,6 +44,10 @@ files:
 - lib/segments/qrd.rb
 - lib/segments/qrf.rb
 - test_data/adt_a01.hl7
+- test_data/empty.hl7
+- test_data/empty_segments.hl7
+- test_data/lotsunknowns.hl7
+- test_data/obxobr.hl7
 - test_data/rqi_r04.hl7
 - test_data/test.hl7
 - test_data/test2.hl7
@@ -51,11 +55,14 @@ files:
 - LICENSE
 test_files: 
 - test/test_basic_parsing.rb
+- test/test_child_segment.rb
 - test/test_default_segment.rb
+- test/test_dynamic_segment_def.rb
 - test/test_msa_segment.rb
 - test/test_obr_segment.rb
 - test/test_obx_segment.rb
 - test/test_pid_segment.rb
+- test/test_speed_parsing.rb
 rdoc_options: []
 
 extra_rdoc_files: 
@@ -84,7 +91,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.7.2
+        version: 0.7.3
     version: 
 - !ruby/object:Gem::Dependency 
   name: rubyforge
@@ -93,5 +100,5 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.4.1
+        version: 0.4.3
     version: