rtp-connect 1.6 → 1.7

data/lib/rtp-connect/prescription.rb

@@ -36,28 +36,8 @@ module RTP
     # @raise [ArgumentError] if given a string containing an invalid number of elements
     #
     def self.load(string, parent)
-      # Get the quote-less values:
-      values = string.to_s.values
-      low_limit = 4
-      high_limit = 13
-      raise ArgumentError, "Invalid argument 'string': Expected at least #{low_limit} elements, got #{values.length}." if values.length < low_limit
-      RTP.logger.warn "The number of elements (#{values.length}) for this Prescription record exceeds the known number of data items for this record (#{high_limit}). This may indicate an invalid record or that the RTP format has recently been expanded with new items." if values.length > high_limit
       p = self.new(parent)
-      # Assign the values to attributes:
-      p.keyword = values[0]
-      p.course_id = values[1]
-      p.rx_site_name = values[2]
-      p.technique = values[3]
-      p.modality = values[4]
-      p.dose_spec = values[5]
-      p.rx_depth = values[6]
-      p.dose_ttl = values[7]
-      p.dose_tx = values[8]
-      p.pattern = values[9]
-      p.rx_note = values[10]
-      p.number_of_fields = values[11]
-      p.crc = values[-1]
-      return p
+      p.load(string)
     end
 
     # Creates a new Prescription site.
@@ -65,6 +45,7 @@ module RTP
     # @param [Record] parent a record which is used to determine the proper parent of this instance
     #
     def initialize(parent)
+      super('RX_DEF', 4, 13)
       # Child objects:
       @site_setup = nil
       @fields = Array.new
@@ -72,7 +53,22 @@ module RTP
       # Parent relation (may get more than one type of record here):
       @parent = get_parent(parent.to_record, Plan)
       @parent.add_prescription(self)
-      @keyword = 'RX_DEF'
+      @attributes = [
+        # Required:
+        :keyword,
+        :course_id,
+        :rx_site_name,
+        # Optional:
+        :technique,
+        :modality,
+        :dose_spec,
+        :rx_depth,
+        :dose_ttl,
+        :dose_tx,
+        :pattern,
+        :rx_note,
+        :number_of_fields
+      ]
     end
 
     # Checks for equality.
@@ -133,28 +129,6 @@ module RTP
       state.hash
     end
 
-    # Collects the values (attributes) of this instance.
-    #
-    # @note The CRC is not considered part of the actual values and is excluded.
-    # @return [Array<String>] an array of attributes (in the same order as they appear in the RTP string)
-    #
-    def values
-      return [
-        @keyword,
-        @course_id,
-        @rx_site_name,
-        @technique,
-        @modality,
-        @dose_spec,
-        @rx_depth,
-        @dose_ttl,
-        @dose_tx,
-        @pattern,
-        @rx_note,
-        @number_of_fields
-      ]
-    end
-
     # Returns self.
     #
     # @return [Prescription] self
@@ -180,18 +154,6 @@ module RTP
 
     alias :to_str :to_s
 
-    # Sets the keyword attribute.
-    #
-    # @note Since only a specific string is accepted, this is more of an argument check than a traditional setter method
-    # @param [#to_s] value the new attribute value
-    # @raise [ArgumentError] if given an unexpected keyword
-    #
-    def keyword=(value)
-      value = value.to_s.upcase
-      raise ArgumentError, "Invalid keyword. Expected 'RX_DEF', got #{value}." unless value == "RX_DEF"
-      @keyword = value
-    end
-
     # Sets the course_id attribute.
     #
     # @param [nil, #to_s] value the new attribute value

data/lib/rtp-connect/record.rb

@@ -10,6 +10,18 @@ module RTP
     # The CRC is used to validate the integrity of the content of the RTP string line.
     attr_reader :crc
 
+    # Creates a new Record.
+    #
+    # @param [String] keyword the keyword which identifies this record
+    # @param [Integer] min_elements the minimum number of data elements required for this record
+    # @param [Integer] max_elements the maximum supported number of data elements for this record
+    #
+    def initialize(keyword, min_elements, max_elements)
+      @keyword = keyword
+      @min_elements = min_elements
+      @max_elements = max_elements
+    end
+
     # Sets the crc (checksum) attribute.
     #
     # @note This value is not used when creating an RTP string from a record (a new crc is calculated)
@@ -26,7 +38,8 @@ module RTP
     # @return [String] a proper RTPConnect type CSV string
     #
     def encode
-      content = CSV.generate_line(values, force_quotes: true, row_sep: '') + ","
+      encoded_values = values.collect {|v| v && v.encode('ISO8859-1')}
+      content = CSV.generate_line(encoded_values, force_quotes: true, row_sep: '') + ","
       checksum = content.checksum
       # Complete string is content + checksum (in double quotes) + carriage return + line feed
       return (content + checksum.to_s.wrap + "\r\n").encode('ISO8859-1')
@@ -45,6 +58,32 @@ module RTP
       end
     end
 
+    # Verifies a proposed keyword attribute.
+    #
+    # @note Since only a specific string is accepted, this is more of an argument check than a traditional setter method.
+    # @param [#to_s] value the proposed keyword attribute
+    # @raise [ArgumentError] if given an unexpected keyword
+    #
+    def keyword=(value)
+      value = value.to_s.upcase
+      raise ArgumentError, "Invalid keyword. Expected '#{@keyword}', got #{value}." unless value == @keyword
+    end
+
+    # Sets up a record by parsing a RTPConnect string line.
+    #
+    # @param [#to_s] string the extended treatment field definition record string line
+    # @return [Record] the updated Record instance
+    # @raise [ArgumentError] if given a string containing an invalid number of elements
+    #
+    def load(string, options={})
+      # Extract processed values:
+      values = string.to_s.values(options[:repair])
+      raise ArgumentError, "Invalid argument 'string': Expected at least #{@min_elements} elements for #{@keyword}, got #{values.length}." if values.length < @min_elements
+      RTP.logger.warn "The number of given elements (#{values.length}) exceeds the known number of data elements for this record (#{@max_elements}). This may indicate an invalid string record or that the RTP format has recently been expanded with new elements." if values.length > @max_elements
+      self.send(:set_attributes, values)
+      self
+    end
+
     # Returns self.
     #
     # @return [Record] self
@@ -53,6 +92,28 @@ module RTP
       self
     end
 
+    # Collects the values (attributes) of this instance.
+    #
+    # @note The CRC is not considered part of the actual values and is excluded.
+    # @return [Array<String>] an array of attributes (in the same order as they appear in the RTP string)
+    #
+    def values
+      @attributes.collect {|attribute| self.send(attribute)}
+    end
+
+
+    private
+
+
+    # Sets the attributes of the record instance.
+    #
+    # @param [Array<String>] values the record attributes (as parsed from a record string)
+    #
+    def set_attributes(values)
+      @attributes.each_index {|i| self.send("#{@attributes[i]}=", values[i])}
+      @crc = values[-1]
+    end
+
   end
 
 end

data/lib/rtp-connect/ruby_extensions.rb

@@ -26,6 +26,17 @@ class String
     self.split(',')
   end
 
+  # Reformats a string, attempting to fix broken CSV format. Note that this
+  # method attempts to fix the CSV in a rather primitive, crude way: Any attributes
+  # containing a " character, will have these characters simply removed.
+  #
+  # @return [String] the processed string
+  #
+  def repair_csv
+    arr = self[1..-2].split('","')
+    "\"#{arr.collect{|e| e.gsub('"', '')}.join('","')}\""
+  end
+
   # Removes leading & trailing double quotes from a string.
   #
   # @return [String] the processed string
@@ -38,14 +49,24 @@ class String
   # quotation (leading and trailing double-quote characters) from the extracted
   # string elements.
   #
+  # @param [Boolean] repair if true, the method will attempt to repair a string that fails CSV processing, and then try to process it a second time
   # @return [Array<String>] an array of the comma separated values
   #
-  def values
+  def values(repair=false)
     begin
       CSV.parse(self).first
     rescue StandardError => e
-      RTP.logger.error("Unable to parse the given string record. Probably invalid CSV format: #{self}")
-      raise e
+      if repair
+        RTP.logger.warn("CSV processing failed. Will attempt to reformat and reprocess the string record.")
+        begin
+          CSV.parse(self.repair_csv).first
+        rescue StandardError => e
+          RTP.logger.error("Unable to parse the given string record. Probably the CSV format is invalid and beyond repair: #{self}")
+        end
+      else
+        RTP.logger.error("Unable to parse the given string record. Probably invalid CSV format: #{self}")
+        raise e
+      end
     end
   end
 
@@ -76,6 +97,16 @@ class Array
     return wrapped.join(',')
   end
 
+  # Validates the number of elements in an array and converts all elements
+  # to strings.
+  #
+  # @param [Integer] nr the required number of elements in the array
+  #
+  def validate_and_process(nr)
+    raise ArgumentError, "Invalid array length. Expected exactly #{nr} elements, got #{self.length}." unless self.length == nr
+    self.collect {|e| e && e.to_s.strip}
+  end
+
 end
 
 # An extension to the NilClass, facilitating a transformation from nil to

data/lib/rtp-connect/simulation_field.rb

@@ -70,68 +70,8 @@ module RTP
     # @raise [ArgumentError] if given a string containing an invalid number of elements
     #
     def self.load(string, parent)
-      # Get the quote-less values:
-      values = string.to_s.values
-      low_limit = 17
-      high_limit = 53
-      raise ArgumentError, "Invalid argument 'string': Expected at least #{low_limit} elements, got #{values.length}." if values.length < low_limit
-      RTP.logger.warn "The number of elements (#{values.length}) for this Simulation Field record exceeds the known number of data items for this record (#{high_limit}). This may indicate an invalid record or that the RTP format has recently been expanded with new items." if values.length > high_limit
       sf = self.new(parent)
-      # Assign the values to attributes:
-      sf.keyword = values[0]
-      sf.rx_site_name = values[1]
-      sf.field_name = values[2]
-      sf.field_id = values[3]
-      sf.field_note = values[4]
-      sf.treatment_machine = values[5]
-      sf.gantry_angle = values[6]
-      sf.collimator_angle = values[7]
-      sf.field_x_mode = values[8]
-      sf.field_x = values[9]
-      sf.collimator_x1 = values[10]
-      sf.collimator_x2 = values[11]
-      sf.field_y_mode = values[12]
-      sf.field_y = values[13]
-      sf.collimator_y1 = values[14]
-      sf.collimator_y2 = values[15]
-      sf.couch_vertical = values[16]
-      sf.couch_lateral = values[17]
-      sf.couch_longitudinal = values[18]
-      sf.couch_angle = values[19]
-      sf.couch_pedestal = values[20]
-      sf.sad = values[21]
-      sf.ap_separation = values[22]
-      sf.pa_separation = values[23]
-      sf.lateral_separation = values[24]
-      sf.tangential_separation = values[25]
-      sf.other_label_1 = values[26]
-      sf.ssd_1 = values[27]
-      sf.sfd_1 = values[28]
-      sf.other_label_2 = values[29]
-      sf.other_measurement_1 = values[30]
-      sf.other_measurement_2 = values[31]
-      sf.other_label_3 = values[32]
-      sf.other_measurement_3 = values[33]
-      sf.other_measurement_4 = values[34]
-      sf.other_label_4 = values[35]
-      sf.other_measurement_5 = values[36]
-      sf.other_measurement_6 = values[37]
-      sf.blade_x_mode = values[38]
-      sf.blade_x = values[39]
-      sf.blade_x1 = values[40]
-      sf.blade_x2 = values[41]
-      sf.blade_y_mode = values[42]
-      sf.blade_y = values[43]
-      sf.blade_y1 = values[44]
-      sf.blade_y2 = values[45]
-      sf.ii_lateral = values[46]
-      sf.ii_longitudinal = values[47]
-      sf.ii_vertical = values[48]
-      sf.kvp = values[49]
-      sf.ma = values[50]
-      sf.seconds = values[51]
-      sf.crc = values[-1]
-      return sf
+      sf.load(string)
     end
 
     # Creates a new SimulationField.
@@ -139,10 +79,66 @@ module RTP
     # @param [Record] parent a record which is used to determine the proper parent of this instance
     #
     def initialize(parent)
+      super('SIM_DEF', 17, 53)
       # Parent relation (may get more than one type of record here):
       @parent = get_parent(parent.to_record, Prescription)
       @parent.add_simulation_field(self)
-      @keyword = 'SIM_DEF'
+      @attributes = [
+        # Required:
+        :keyword,
+        :rx_site_name,
+        :field_name,
+        :field_id,
+        :field_note,
+        :treatment_machine,
+        :gantry_angle,
+        :collimator_angle,
+        :field_x_mode,
+        :field_x,
+        :collimator_x1,
+        :collimator_x2,
+        :field_y_mode,
+        :field_y,
+        :collimator_y1,
+        :collimator_y2,
+        # Optional:
+        :couch_vertical,
+        :couch_lateral,
+        :couch_longitudinal,
+        :couch_angle,
+        :couch_pedestal,
+        :sad,
+        :ap_separation,
+        :pa_separation,
+        :lateral_separation,
+        :tangential_separation,
+        :other_label_1,
+        :ssd_1,
+        :sfd_1,
+        :other_label_2,
+        :other_measurement_1,
+        :other_measurement_2,
+        :other_label_3,
+        :other_measurement_3,
+        :other_measurement_4,
+        :other_label_4,
+        :other_measurement_5,
+        :other_measurement_6,
+        :blade_x_mode,
+        :blade_x,
+        :blade_x1,
+        :blade_x2,
+        :blade_y_mode,
+        :blade_y,
+        :blade_y1,
+        :blade_y2,
+        :ii_lateral,
+        :ii_longitudinal,
+        :ii_vertical,
+        :kvp,
+        :ma,
+        :seconds
+      ]
     end
 
     # Checks for equality.
@@ -179,68 +175,6 @@ module RTP
       state.hash
     end
 
-    # Collects the values (attributes) of this instance.
-    #
-    # @note The CRC is not considered part of the actual values and is excluded.
-    # @return [Array<String>] an array of attributes (in the same order as they appear in the RTP string)
-    #
-    def values
-      return [
-        @keyword,
-        @rx_site_name,
-        @field_name,
-        @field_id,
-        @field_note,
-        @treatment_machine,
-        @gantry_angle,
-        @collimator_angle,
-        @field_x_mode,
-        @field_x,
-        @collimator_x1,
-        @collimator_x2,
-        @field_y_mode,
-        @field_y,
-        @collimator_y1,
-        @collimator_y2,
-        @couch_vertical,
-        @couch_lateral,
-        @couch_longitudinal,
-        @couch_angle,
-        @couch_pedestal,
-        @sad,
-        @ap_separation,
-        @pa_separation,
-        @lateral_separation,
-        @tangential_separation,
-        @other_label_1,
-        @ssd_1,
-        @sfd_1,
-        @other_label_2,
-        @other_measurement_1,
-        @other_measurement_2,
-        @other_label_3,
-        @other_measurement_3,
-        @other_measurement_4,
-        @other_label_4,
-        @other_measurement_5,
-        @other_measurement_6,
-        @blade_x_mode,
-        @blade_x,
-        @blade_x1,
-        @blade_x2,
-        @blade_y_mode,
-        @blade_y,
-        @blade_y1,
-        @blade_y2,
-        @ii_lateral,
-        @ii_longitudinal,
-        @ii_vertical,
-        @kvp,
-        @ma,
-        @seconds
-      ]
-    end
-
     # Returns self.
     #
     # @return [SimulationField] self
@@ -266,18 +200,6 @@ module RTP
 
     alias :to_str :to_s
 
-    # Sets the keyword attribute.
-    #
-    # @note Since only a specific string is accepted, this is more of an argument check than a traditional setter method
-    # @param [#to_s] value the new attribute value
-    # @raise [ArgumentError] if given an unexpected keyword
-    #
-    def keyword=(value)
-      value = value.to_s.upcase
-      raise ArgumentError, "Invalid keyword. Expected 'SIM_DEF', got #{value}." unless value == "SIM_DEF"
-      @keyword = value
-    end
-
     # Sets the rx_site_name attribute.
     #
     # @param [nil, #to_s] value the new attribute value