rtp-connect 1.0 → 1.1

data/lib/rtp-connect/methods.rb

@@ -19,7 +19,7 @@ module RTP
       raise ArgumentError, "Invalid line encountered; No comma present in the string: #{line}" unless last_comma_pos
       string_to_check = line[0..last_comma_pos]
       string_remaining = line[(last_comma_pos+1)..-1]
-      raise ArgumentError, "Invalid line encountered; Valid checksum missing at end of string: #{string_remaining}" unless string_remaining.length > 3
+      raise ArgumentError, "Invalid line encountered; Valid checksum missing at end of string: #{string_remaining}" unless string_remaining.length >= 3
       checksum_extracted = string_remaining.value.to_i
       checksum_computed = string_to_check.checksum
       raise ArgumentError, "Invalid line encountered: Specified checskum #{checksum_extracted} deviates from the computed checksum #{checksum_computed}." if checksum_extracted != checksum_computed

data/lib/rtp-connect/plan.rb

@@ -71,9 +71,8 @@ module RTP
     # * <tt>string</tt> -- A string containing a plan definition record.
     #
     def self.load(string)
-      raise ArgumentError, "Invalid argument 'string'. Expected String, got #{string.class}." unless string.is_a?(String)
       # Get the quote-less values:
-      values = string.values
+      values = string.to_s.values
       raise ArgumentError, "Invalid argument 'string': Expected exactly 28 elements, got #{values.length}." unless values.length == 28
       rtp = self.new
       # Assign the values to attributes:
@@ -116,10 +115,7 @@ module RTP
     # * <tt>string</tt> -- An RTPConnect ascii string.
     #
     def self.parse(string)
-      raise ArgumentError, "Invalid argument 'string'. Expected String, got #{string.class}." unless string.is_a?(String)
-      raise ArgumentError, "Invalid argument 'string': String too short to contain valid RTP data (length: #{string.length})." if string.length < 10
-      #lines = string.lines
-      lines = string.split("\r\n")
+      lines = string.to_s.split("\r\n")
       # Create the Plan object:
       line = lines.first
       RTP::verify(line)
@@ -185,11 +181,20 @@ module RTP
       @keyword = 'PLAN_DEF'
     end
 
+    # Returns true if the argument is an instance with attributes equal to self.
+    #
+    def ==(other)
+      if other.respond_to?(:to_plan)
+        other.send(:state) == state
+      end
+    end
+
+    alias_method :eql?, :==
+
     # Adds a prescription site record to this instance.
     #
     def add_prescription(child)
-      raise ArgumentError, "Invalid argument 'child'. Expected RTP::Prescription, got #{child.class}." unless child.is_a?(RTP::Prescription)
-      @prescriptions << child
+      @prescriptions << child.to_prescription
     end
 
     # Returns the a properly sorted array of the child records of this instance.
@@ -198,6 +203,12 @@ module RTP
       return [@prescriptions, @dose_trackings].flatten.compact
     end
 
+    # Generates a Fixnum hash value for this instance.
+    #
+    def hash
+      state.hash
+    end
+
     # Returns the values of this instance in an array.
     # The values does not include the CRC.
     #
@@ -233,17 +244,25 @@ module RTP
       ]
     end
 
+    # Returns self.
+    #
+    def to_plan
+      self
+    end
+
     # Writes the Plan object + any hiearchy of child objects,
     # to a properly formatted RTPConnect ascii string.
     #
-    def to_str
+    def to_s
       str = encode #.force_encoding('utf-8')
       children.each do |child|
-        str += child.to_str #.force_encoding('utf-8')
+        str += child.to_s #.force_encoding('utf-8')
       end
       return str
     end
 
+    alias :to_str :to_s
+
     # Writes the Plan object, along with its hiearchy of child objects,
     # to a properly formatted RTPConnect ascii file.
     #
@@ -253,198 +272,172 @@ module RTP
     #
     def write(file)
       f = open_file(file)
-      f.write(to_str)
+      f.write(to_s)
       f.close
     end
 
     # Sets the keyword attribute.
     #
     def keyword=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      raise ArgumentError, "Invalid keyword. Expected 'PLAN_DEF', got #{value}." unless value.upcase == "PLAN_DEF"
+      value = value.to_s.upcase
+      raise ArgumentError, "Invalid keyword. Expected 'PLAN_DEF', got #{value}." unless value == "PLAN_DEF"
       @keyword = value
     end
 
     # Sets the patient_id attribute.
     #
     def patient_id=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @patient_id = value
+      @patient_id = value && value.to_s
     end
 
     # Sets the patient_last_name attribute.
     #
     def patient_last_name=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @patient_last_name = value
+      @patient_last_name = value && value.to_s
     end
 
     # Sets the patient_first_name attribute.
     #
     def patient_first_name=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @patient_first_name = value
+      @patient_first_name = value && value.to_s
     end
 
     # Sets the patient_middle_initial attribute.
     #
     def patient_middle_initial=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @patient_middle_initial = value
+      @patient_middle_initial = value && value.to_s
     end
 
     # Sets the plan_id attribute.
     #
     def plan_id=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @plan_id = value
+      @plan_id = value && value.to_s
     end
 
     # Sets the plan_date attribute.
     #
     def plan_date=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @plan_date = value
+      @plan_date = value && value.to_s
     end
 
     # Sets the plan_time attribute.
     #
     def plan_time=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @plan_time = value
+      @plan_time = value && value.to_s
     end
 
     # Sets the course_id attribute.
     #
     def course_id=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @course_id = value
+      @course_id = value && value.to_s
     end
 
     # Sets the diagnosis attribute.
     #
     def diagnosis=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @diagnosis = value
+      @diagnosis = value && value.to_s
     end
 
     # Sets the md_last_name attribute.
     #
     def md_last_name=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @md_last_name = value
+      @md_last_name = value && value.to_s
     end
 
     # Sets the md_first_name attribute.
     #
     def md_first_name=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @md_first_name = value
+      @md_first_name = value && value.to_s
     end
 
     # Sets the md_middle_initial attribute.
     #
     def md_middle_initial=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @md_middle_initial = value
+      @md_middle_initial = value && value.to_s
     end
 
     # Sets the md_approve_last_name attribute.
     #
     def md_approve_last_name=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @md_approve_last_name = value
+      @md_approve_last_name = value && value.to_s
     end
 
     # Sets the md_approve_first_name attribute.
     #
     def md_approve_first_name=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @md_approve_first_name = value
+      @md_approve_first_name = value && value.to_s
     end
 
     # Sets the md_approve_middle_initial attribute.
     #
     def md_approve_middle_initial=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @md_approve_middle_initial = value
+      @md_approve_middle_initial = value && value.to_s
     end
 
     # Sets the phy_approve_last_name attribute.
     #
     def phy_approve_last_name=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @phy_approve_last_name = value
+      @phy_approve_last_name = value && value.to_s
     end
 
     # Sets the phy_approve_first_name attribute.
     #
     def phy_approve_first_name=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @phy_approve_first_name = value
+      @phy_approve_first_name = value && value.to_s
     end
 
     # Sets the phy_approve_middle_initial attribute.
     #
     def phy_approve_middle_initial=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @phy_approve_middle_initial = value
+      @phy_approve_middle_initial = value && value.to_s
     end
 
     # Sets the author_last_name attribute.
     #
     def author_last_name=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @author_last_name = value
+      @author_last_name = value && value.to_s
     end
 
     # Sets the author_first_name attribute.
     #
     def author_first_name=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @author_first_name = value
+      @author_first_name = value && value.to_s
     end
 
     # Sets the author_middle_initial attribute.
     #
     def author_middle_initial=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @author_middle_initial = value
+      @author_middle_initial = value && value.to_s
     end
 
     # Sets the rtp_mfg attribute.
     #
     def rtp_mfg=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @rtp_mfg = value
+      @rtp_mfg = value && value.to_s
     end
 
     # Sets the rtp_model attribute.
     #
     def rtp_model=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @rtp_model = value
+      @rtp_model = value && value.to_s
     end
 
     # Sets the rtp_version attribute.
     #
     def rtp_version=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @rtp_version = value
+      @rtp_version = value && value.to_s
     end
 
     # Sets the rtp_if_protocol attribute.
     #
     def rtp_if_protocol=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @rtp_if_protocol = value
+      @rtp_if_protocol = value && value.to_s
     end
 
     # Sets the rtp_if_version attribute.
     #
     def rtp_if_version=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @rtp_if_version = value
+      @rtp_if_version = value && value.to_s
     end
 
 
@@ -529,6 +522,10 @@ module RTP
       @current_parent = s
     end
 
+    # Returns the attributes of this instance in an array (for comparison purposes).
+    #
+    alias_method :state, :values
+
     # Creates a treatment field record from the given string.
     #
     # === Parameters

data/lib/rtp-connect/prescription.rb

@@ -35,10 +35,8 @@ module RTP
     # * <tt>parent</tt> -- A Record which is used to determine the proper parent of this instance.
     #
     def self.load(string, parent)
-      raise ArgumentError, "Invalid argument 'string'. Expected String, got #{string.class}." unless string.is_a?(String)
-      raise ArgumentError, "Invalid argument 'parent'. Expected RTP::Record, got #{parent.class}." unless parent.is_a?(RTP::Record)
       # Get the quote-less values:
-      values = string.values
+      values = string.to_s.values
       raise ArgumentError, "Invalid argument 'string': Expected exactly 13 elements, got #{values.length}." unless values.length == 13
       p = self.new(parent)
       # Assign the values to attributes:
@@ -65,28 +63,35 @@ module RTP
     # * <tt>parent</tt> -- A Record which is used to determine the proper parent of this instance.
     #
     def initialize(parent)
-      raise ArgumentError, "Invalid argument 'parent'. Expected RTP::Record, got #{parent.class}." unless parent.is_a?(RTP::Record)
       # Child objects:
       @site_setup = nil
       @fields = Array.new
-      # Parent relation:
-      @parent = get_parent(parent, Plan)
+      # 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'
     end
 
+    # Returns true if the argument is an instance with attributes equal to self.
+    #
+    def ==(other)
+      if other.respond_to?(:to_prescription)
+        other.send(:state) == state
+      end
+    end
+
+    alias_method :eql?, :==
+
     # Adds a treatment Field record to this instance.
     #
     def add_field(child)
-      raise ArgumentError, "Invalid argument 'child'. Expected RTP::Field, got #{child.class}." unless child.is_a?(RTP::Field)
-      @fields << child
+      @fields << child.to_field
     end
 
     # Connects a Site setup record to this instance.
     #
     def add_site_setup(child)
-      raise ArgumentError, "Invalid argument 'child'. Expected RTP::SiteSetup, got #{child.class}." unless child.is_a?(RTP::SiteSetup)
-      @site_setup = child
+      @site_setup = child.to_site_setup
     end
 
     # Returns the a properly sorted array of the child records of this instance.
@@ -95,6 +100,12 @@ module RTP
       return [@site_setup, @fields].flatten.compact
     end
 
+    # Generates a Fixnum hash value for this instance.
+    #
+    def hash
+      state.hash
+    end
+
     # Returns the values of this instance in an array.
     # The values does not include the CRC.
     #
@@ -115,104 +126,109 @@ module RTP
       ]
     end
 
+    # Returns self.
+    #
+    def to_prescription
+      self
+    end
+
     # Writes the Prescription object + any hiearchy of child objects,
     # to a properly formatted RTPConnect ascii string.
     #
-    def to_str
+    def to_s
       str = encode
       if children
         children.each do |child|
-          str += child.to_str
+          str += child.to_s
         end
       end
       return str
     end
 
+    alias :to_str :to_s
+
     # Sets the keyword attribute.
     #
     def keyword=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      raise ArgumentError, "Invalid keyword. Expected 'RX_DEF', got #{value}." unless value.upcase == "RX_DEF"
+      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.
     #
     def course_id=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @course_id = value
+      @course_id = value && value.to_s
     end
 
     # Sets the rx_site_name attribute.
     #
     def rx_site_name=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @rx_site_name = value
+      @rx_site_name = value && value.to_s
     end
 
     # Sets the technique attribute.
     #
     def technique=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @technique = value
+      @technique = value && value.to_s
     end
 
     # Sets the modality attribute.
     #
     def modality=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @modality = value
+      @modality = value && value.to_s
     end
 
     # Sets the dose_spec attribute.
     #
     def dose_spec=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @dose_spec = value
+      @dose_spec = value && value.to_s
     end
 
     # Sets the rx_depth attribute.
     #
     def rx_depth=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @rx_depth = value
+      @rx_depth = value && value.to_s
     end
 
     # Sets the dose_ttl attribute.
     #
     def dose_ttl=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @dose_ttl = value
+      @dose_ttl = value && value.to_s
     end
 
     # Sets the dose_tx attribute.
     #
     def dose_tx=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @dose_tx = value
+      @dose_tx = value && value.to_s
     end
 
     # Sets the pattern attribute.
     #
     def pattern=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @pattern = value
+      @pattern = value && value.to_s
     end
 
     # Sets the rx_note attribute.
     #
     def rx_note=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @rx_note = value
+      @rx_note = value && value.to_s
     end
 
     # Sets the number_of_fields attribute.
     #
     def number_of_fields=(value)
-      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
-      @number_of_fields = value
+      @number_of_fields = value && value.to_s
     end
 
+
+    private
+
+
+    # Returns the attributes of this instance in an array (for comparison purposes).
+    #
+    alias_method :state, :values
+
   end
 
 end