ruby-hl7 1.3.3 → 1.4.0

data/lib/segment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Ruby Object representation of an hl7 2.x message segment
 # The segments can be setup to provide aliases to specific fields with
 # optional validation code that is run when the field is modified
@@ -19,12 +21,12 @@
 #
 class HL7::Message::Segment
   extend HL7::Message::SegmentListStorage
+  extend TimeFormatterHelper
+
   include HL7::Message::SegmentFields
 
   attr_accessor :segment_parent
-  attr_reader :element_delim
-  attr_reader :item_delim
-  attr_reader :segment_weight
+  attr_reader :element_delim, :item_delim, :segment_weight
 
   METHOD_MISSING_FOR_INITIALIZER = <<-END
     def method_missing( sym, *args, &blk )
@@ -38,7 +40,7 @@ class HL7::Message::Segment
   # delims:: an optional array of delimiters, where
   #               delims[0] = element delimiter
   #               delims[1] = item delimiter
-  def initialize(raw_segment="", delims=[], &blk)
+  def initialize(raw_segment = "", delims = [], &blk)
     @segments_by_name = {}
     @field_total = 0
     @is_child = false
@@ -47,31 +49,31 @@ class HL7::Message::Segment
 
     @elements = elements_from_segment(raw_segment)
 
-    if block_given?
-      callctx = eval( "self", blk.binding )
-      def callctx.__seg__(val=nil)
-        @__seg_val__ ||= val
-      end
-      callctx.__seg__(self)
-      # TODO: find out if this pollutes the calling namespace permanently...
+    return unless block_given?
 
-      eval( METHOD_MISSING_FOR_INITIALIZER, blk.binding )
-      yield self
-      eval( "class << self; remove_method :method_missing;end", blk.binding )
+    callctx = eval("self", blk.binding, __FILE__, __LINE__)
+    def callctx.__seg__(val = nil)
+      @__seg_val__ ||= val
     end
+    callctx.__seg__(self)
+    # TODO: find out if this pollutes the calling namespace permanently...
+
+    eval(METHOD_MISSING_FOR_INITIALIZER, blk.binding)
+    yield self
+    eval("class << self; remove_method :method_missing;end", blk.binding, __FILE__, __LINE__)
   end
 
   # Breaks the raw segment into elements
   # raw_segment:: is an optional String or Array which will be used as the
   #               segment's field data
   def elements_from_segment(raw_segment)
-    if (raw_segment.kind_of? Array)
+    if raw_segment.is_a? Array
       elements = raw_segment
     else
-      elements = HL7::MessageParser.split_by_delimiter( raw_segment,
-                                                        @element_delim )
+      elements = HL7::MessageParser.split_by_delimiter(raw_segment,
+        @element_delim)
       if raw_segment == ""
-        elements[0] = self.class.to_s.split( "::" ).last
+        elements[0] = self.class.to_s.split("::").last
         elements << ""
       end
     end
@@ -79,26 +81,26 @@ class HL7::Message::Segment
   end
 
   def to_info
-    "%s: empty segment >> %s" % [ self.class.to_s, @elements.inspect ]
+    format("%s: empty segment >> %s", self.class.to_s, @elements.inspect)
   end
 
   # output the HL7 spec version of the segment
   def to_s
-    @elements.join( @element_delim )
+    @elements.join(@element_delim)
   end
 
   # at the segment level there is no difference between to_s and to_hl7
-  alias :to_hl7 :to_s
+  alias_method :to_hl7, :to_s
 
   # handle the e<number> field accessor
   # and any aliases that didn't get added to the system automatically
-  def method_missing( sym, *args, &blk )
-    base_str = sym.to_s.gsub( "=", "" )
+  def method_missing(sym, *args, &blk)
+    base_str = sym.to_s.delete("=")
     base_sym = base_str.to_sym
 
-    if self.class.fields.include?( base_sym )
+    if self.class.fields.include?(base_sym)
       # base_sym is ok, let's move on
-    elsif /e([0-9]+)/.match( base_str )
+    elsif /e([0-9]+)/ =~ base_str
       # base_sym should actually be $1, since we're going by
       # element id number
       base_sym = $1.to_i
@@ -106,26 +108,25 @@ class HL7::Message::Segment
       super
     end
 
-    if sym.to_s.include?( "=" )
-      write_field( base_sym, args )
+    if sym.to_s.include?("=")
+      write_field(base_sym, args)
+    elsif args.length.positive?
+      write_field(base_sym, args.flatten.select {|arg| arg })
     else
-      if args.length > 0
-        write_field( base_sym, args.flatten.select { |arg| arg } )
-      else
-        read_field( base_sym )
-      end
+      read_field(base_sym)
     end
   end
 
   # sort-compare two Segments, 0 indicates equality
-  def <=>( other )
-    return nil unless other.kind_of?(HL7::Message::Segment)
+  def <=>(other)
+    return nil unless other.is_a?(HL7::Message::Segment)
 
     # per Comparable docs: http://www.ruby-doc.org/core/classes/Comparable.html
-    diff = self.weight - other.weight
-    return -1 if diff > 0
-    return 1 if diff < 0
-    return 0
+    diff = weight - other.weight
+    return -1 if diff.positive?
+    return 1 if diff.negative?
+
+    0
   end
 
   # get the defined sort-weight of this segment class
@@ -147,6 +148,7 @@ class HL7::Message::Segment
   # yield each element in the segment
   def each # :yields: element
     return unless @elements
+
     @elements.each { |e| yield e }
   end
 
@@ -157,25 +159,26 @@ class HL7::Message::Segment
   end
 
   def has_children?
-    self.respond_to?(:children)
+    respond_to?(:children)
   end
 
-  private
-  def self.singleton #:nodoc:
+private
+
+  def self.singleton # :nodoc:
     class << self; self end
   end
 
   def setup_delimiters(delims)
-    delims = [ delims ].flatten
+    delims = [delims].flatten
 
-    @element_delim = ( delims.length>0 ) ? delims[0] : "|"
-    @item_delim = ( delims.length>1 ) ? delims[1] : "^"
+    @element_delim = delims.length.positive? ? delims[0] : "|"
+    @item_delim = delims.length > 1 ? delims[1] : "^"
   end
 
   # DSL element to define a segment's sort weight
   # returns the segment's current weight by default
   # segments are sorted ascending
-  def self.weight(new_weight=nil)
+  def self.weight(new_weight = nil)
     if new_weight
       singleton.module_eval do
         @my_weight = new_weight
@@ -184,12 +187,25 @@ class HL7::Message::Segment
 
     singleton.module_eval do
       return 999 unless @my_weight
+
       @my_weight
     end
   end
 
-  def self.convert_to_ts(value) #:nodoc:
-    value.respond_to?(:to_hl7) ? value.to_hl7 : value
+  def self.convert_to_ts(value) # :nodoc:
+    if value.is_a?(Time) || value.is_a?(DateTime)
+      hl7_formatted_timestamp(value)
+    elsif value.is_a?(Date)
+      hl7_formatted_date(value)
+    else
+      value
+    end
   end
 
+  def self.sanitize_admin_sex!(value)
+    raise HL7::InvalidDataError, "bad administrative sex value (not F|M|O|U|A|N|C)" unless /^[FMOUANC]$/.match(value) || value.nil? || value == ""
+
+    value ||= ""
+    value
+  end
 end

data/lib/segment_default.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Provide a catch-all information preserving segment
 # * nb: aliases are not provided BUT you can use the numeric element accessor
 #
@@ -7,12 +9,12 @@
 #  seg.e2 = "KIN HERE"
 #
 class HL7::Message::Segment::Default < HL7::Message::Segment
-  def initialize(raw_segment="", delims=[])
-    segs = [] if (raw_segment == "")
+  def initialize(raw_segment = "", delims = [])
+    segs = [] if raw_segment == ""
     segs ||= raw_segment
-    super( segs, delims )
+    super(segs, delims)
   end
 end
 
 # load our segments
-Dir["#{File.dirname(__FILE__)}/segments/*.rb"].each { |ext| load ext }
+Dir["#{File.dirname(__FILE__)}/segments/*.rb"].each {|ext| load ext }

data/lib/segment_fields.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #  SegmentFields
 #  class HL7::Message::Segment::NK1 < HL7::Message::Segment
 #    weight 100 # segments are sorted ascendingly
@@ -20,8 +22,8 @@ module HL7::Message::SegmentFields
     # * blk is an optional validation/convertion proc which MUST
     #   take a parameter and always return a value for the field (it will be
     #    used on read/write calls)
-    def add_field( name, options={}, &blk )
-      options = { :idx =>-1, :blk =>blk}.merge!( options )
+    def add_field(name, options = {}, &blk)
+      options = { :idx => -1, :blk => blk }.merge!(options)
       name ||= :id
       namesym = name.to_sym
       @field_cnt ||= 1
@@ -32,10 +34,10 @@ module HL7::Message::SegmentFields
 
       singleton.module_eval do
         @fields ||= {}
-        @fields[ namesym ] = options
+        @fields[namesym] = options
       end
 
-      self.class_eval <<-END
+      class_eval <<-END, __FILE__, __LINE__ + 1
         def #{name}(val=nil)
           unless val
             read_field( :#{namesym} )
@@ -51,14 +53,14 @@ module HL7::Message::SegmentFields
       END
     end
 
-    def fields #:nodoc:
+    def fields # :nodoc:
       singleton.module_eval do
         (@fields ||= [])
       end
     end
 
     def alias_field(new_field_name, old_field_name)
-      self.class_eval <<-END
+      class_eval <<-END, __FILE__, __LINE__ + 1
         def #{new_field_name}(val=nil)
           raise HL7::InvalidDataError.new unless self.class.fields[:#{old_field_name}]
           unless val
@@ -76,50 +78,50 @@ module HL7::Message::SegmentFields
     end
   end
 
-  def field_info( name ) #:nodoc:
+  def field_info(name) # :nodoc:
     field_blk = nil
     idx = name # assume we've gotten a integer
-    unless name.kind_of?(Integer)
-      fld_info = self.class.fields[ name ]
+    unless name.is_a?(Integer)
+      fld_info = self.class.fields[name]
       idx = fld_info[:idx].to_i
       field_blk = fld_info[:blk]
     end
 
-    [ idx, field_blk ]
+    [idx, field_blk]
   end
 
-  def []( index )
+  def [](index)
     @elements[index]
   end
 
-  def []=( index, value )
+  def []=(index, value)
     @elements[index] = value.to_s
   end
 
-  def read_field( name ) #:nodoc:
-    idx, field_blk = field_info( name )
+  def read_field(name) # :nodoc:
+    idx, field_blk = field_info(name)
     return nil unless idx
-    return nil if (idx >= @elements.length)
+    return nil if idx >= @elements.length
 
-    ret = @elements[ idx ]
-    ret = ret.first if (ret.kind_of?(Array) && ret.length == 1)
-    ret = field_blk.call( ret ) if field_blk
+    ret = @elements[idx]
+    ret = ret.first if ret.is_a?(Array) && ret.length == 1
+    ret = field_blk.call(ret) if field_blk
     ret
   end
 
-  def write_field( name, value ) #:nodoc:
-    idx, field_blk = field_info( name )
+  def write_field(name, value) # :nodoc:
+    idx, field_blk = field_info(name)
     return nil unless idx
 
-    if (idx >= @elements.length)
+    if idx >= @elements.length
       # make some space for the incoming field, missing items are assumed to
       # be empty, so this is valid per the spec -mg
-      missing = ("," * (idx-@elements.length)).split(',',-1)
+      missing = ("," * (idx - @elements.length)).split(",", -1)
       @elements += missing
     end
 
-    value = value.first if (value && value.kind_of?(Array) && value.length == 1)
-    value = field_blk.call( value ) if field_blk
-    @elements[ idx ] = value.to_s
+    value = value.first if value.is_a?(Array) && value.length == 1
+    value = field_blk.call(value) if field_blk
+    @elements[idx] = value.to_s
   end
 end

data/lib/segment_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Class for grouping the messages delimiter
 class HL7::Message::Delimiter
   attr_accessor :item, :element, :segment
@@ -11,9 +13,7 @@ end
 
 # Methods for creating segments in Message
 class HL7::Message::SegmentGenerator
-
-  attr_reader :element, :last_seg
-  attr_reader :delimiter
+  attr_reader :element, :last_seg, :delimiter
 
   attr_accessor :seg_parts, :seg_name
 
@@ -22,24 +22,21 @@ class HL7::Message::SegmentGenerator
     @last_seg = last_seg
     @delimiter = delimiter
 
-    @seg_parts = HL7::MessageParser.split_by_delimiter( element,
-                                                        delimiter.element )
+    @seg_parts = HL7::MessageParser.split_by_delimiter(element,
+      delimiter.element)
   end
 
   def valid_segments_parts?
-    return true if @seg_parts && @seg_parts.length > 0
+    return true if @seg_parts&.length&.positive?
 
-    if HL7.ParserConfig[:empty_segment_is_error]
-      raise HL7::EmptySegmentNotAllowed
-    else
-      return false
-    end
+    raise HL7::EmptySegmentNotAllowed if HL7.configuration.empty_segment_is_error
+
+    false
   end
 
   def build
     klass = get_segment_class
-    new_seg = klass.new( @element, [@delimiter.element, @delimiter.item] )
-    new_seg
+    klass.new(@element, [@delimiter.element, @delimiter.item])
   end
 
   def get_segment_class
@@ -47,9 +44,9 @@ class HL7::Message::SegmentGenerator
     segment_to_search = @seg_name if RUBY_VERSION < "1.9"
 
     if HL7::Message::Segment.constants.index(segment_to_search)
-      eval("HL7::Message::Segment::%s" % @seg_name)
+      eval(format("HL7::Message::Segment::%s", @seg_name))
     else
       HL7::Message::Segment::Default
     end
   end
-end
+end

data/lib/segment_list_storage.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This module includes methods for storing segments inside segments.
 # has_children(child_types) defines three methods dynamically.
 
@@ -8,11 +10,12 @@ module HL7::Message::SegmentListStorage
     if defined?(@child_types)
       @child_types << child_type.to_sym
     else
-      has_children [ child_type.to_sym ]
+      has_children [child_type.to_sym]
     end
   end
 
-  private
+private
+
   # allows a segment to store other segment objects
   # used to handle associated lists like one OBR to many OBX segments
   def has_children(child_types)
@@ -30,8 +33,8 @@ module HL7::Message::SegmentListStorage
   end
 
   def define_method_accepts
-    self.class_eval do
-      define_method('accepts?') do |t|
+    class_eval do
+      define_method(:accepts?) do |t|
         t = t.to_sym if t.respond_to?(:to_sym)
         !!child_types.index(t)
       end
@@ -39,7 +42,7 @@ module HL7::Message::SegmentListStorage
   end
 
   def define_method_children
-    self.class_eval do
+    class_eval do
       define_method(:children) do
         unless defined?(@my_children)
           p = self
@@ -48,27 +51,25 @@ module HL7::Message::SegmentListStorage
             @parental = p
             alias :old_append :<<
 
-            def <<( value )
+            def <<(value)
               # do nothing if value is nil
               return unless value
 
               # make sure it's an array
               value = [value].flatten
-              value.map{|item| append(item)}
+              value.map {|item| append(item) }
             end
 
             def append(value)
-              unless (value && value.kind_of?(HL7::Message::Segment))
-                raise HL7::Exception.new( "attempting to append non-segment to a segment list" )
+              unless value.is_a?(HL7::Message::Segment)
+                raise HL7::Exception, "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 )
+              k = k.segment_parent while k&.segment_parent && !k.segment_parent.is_a?(HL7::Message)
+              k.segment_parent << value if k&.segment_parent
+              old_append(value)
             end
           end
         end

data/lib/segments/aig.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class HL7::Message::Segment::AIG < HL7::Message::Segment
   weight 1
   add_field :set_id

data/lib/segments/ail.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class HL7::Message::Segment::AIL < HL7::Message::Segment
   weight 0
   add_field :set_id

data/lib/segments/aip.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class HL7::Message::Segment::AIP < HL7::Message::Segment
   weight 0
   add_field :set_id

data/lib/segments/ais.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class HL7::Message::Segment::AIS < HL7::Message::Segment
   weight 1
   add_field :set_id

data/lib/segments/dg1.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HL7
   class Message::Segment::DG1 < HL7::Message::Segment
     weight 92
@@ -24,15 +26,5 @@ module HL7
     add_field :attestation_date_time do |value|
       convert_to_ts(value)
     end
-
-    private
-
-    def self.convert_to_ts(value) #:nodoc:
-      if value.is_a?(Time) || value.is_a?(Date)
-        value.to_hl7
-      else
-        value
-      end
-    end
   end
 end

data/lib/segments/err.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class HL7::Message::Segment::ERR < HL7::Message::Segment
   weight 2
   add_field :error_code_and_location

data/lib/segments/evn.rb

@@ -1,4 +1,5 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 class HL7::Message::Segment::EVN < HL7::Message::Segment
   weight 0 # should occur after the MSH segment
   add_field :type_code

data/lib/segments/ft1.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HL7
   class Message::Segment::FT1 < HL7::Message::Segment
     weight 10
@@ -12,7 +14,7 @@ module HL7
     end
     add_field :transaction_type
     add_field :transaction_code
-    add_field :transaction_description    
+    add_field :transaction_description
     add_field :transaction_description_alt
     add_field :transaction_quantity
     add_field :transaction_amount_extended
@@ -35,29 +37,27 @@ module HL7
     add_field :unit_cost
     add_field :filler_order_number
     add_field :entered_by
-    
+
     # https://en.wikipedia.org/wiki/Current_Procedural_Terminology (CPT)
     add_field :procedure_code
 
     add_field :procedure_code_modifier
-    add_field :advanced_beneficiary_notice_code      
-    add_field :medically_necessary_duplicate_procedure_reason  
+    add_field :advanced_beneficiary_notice_code
+    add_field :medically_necessary_duplicate_procedure_reason
     add_field :ndc_code
     add_field :payment_reference_id
     add_field :transaction_reference_key
     add_field :performing_facility
-    add_field :ordering_facility      
+    add_field :ordering_facility
     add_field :item_number
-    add_field :model_number 
-    add_field :special_processing_code   
+    add_field :model_number
+    add_field :special_processing_code
     add_field :clinic_code
-    add_field :referral_number 
+    add_field :referral_number
     add_field :authorization_number
-    add_field :service_provider_taxonomy_code 
+    add_field :service_provider_taxonomy_code
     add_field :revenue_code
-    add_field :prescription_number  
+    add_field :prescription_number
     add_field :ndc_qty_and_uom
-
-
   end
-end  
+end

data/lib/segments/fts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class HL7::Message::Segment::FTS < HL7::Message::Segment
   weight 1001 # at the end
   add_field :file_batch_count

data/lib/segments/gt1.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HL7
   class Message::Segment::GT1 < HL7::Message::Segment
     add_field :set_id
@@ -9,11 +11,7 @@ module HL7
     add_field :guarantor_business_phone
     add_field :guarantor_date_of_birth
     add_field :guarantor_sex do |sex|
-      unless /^[FMOUANC]$/.match(sex) || sex == nil || sex == ""
-        raise HL7::InvalidDataError.new( "bad administrative sex value (not F|M|O|U|A|N|C)" )
-      end
-      sex = "" unless sex
-      sex
+      sanitize_admin_sex!(sex)
     end
     add_field :guarantor_type
     add_field :guarantor_relationship
@@ -72,4 +70,4 @@ module HL7
     add_field :guarantor_birth_place
     add_field :vip_indicator
   end
-end   
+end

data/lib/segments/in1.rb

@@ -1,4 +1,5 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 # via https://github.com/bbhoss/ruby-hl7/blob/master/lib/segments/in1.rb
 class HL7::Message::Segment::IN1 < HL7::Message::Segment
   add_field :set_id

data/lib/segments/mfe.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class HL7::Message::Segment::MFE < HL7::Message::Segment
   weight 0
   add_field :record_level_event_code

data/lib/segments/mfi.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class HL7::Message::Segment::MFI < HL7::Message::Segment
   weight 0
   add_field :master_file_identifier

data/lib/segments/mrg.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class HL7::Message::Segment::MRG < HL7::Message::Segment
   weight 4
   add_field :prior_patient_identifier_list