rtp-connect 1.7 → 1.8

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDIyZThkNzk2OGI3OTdlMjY5MDk4MDQ2YmU5ODBhMTk3NTM2NzUwNg==
+    ODZiNzJlZGMxY2M5OTk4OTZhOWRjOGVlMzFlZDQxOTY3NjUwNjQ1Yw==
   data.tar.gz: !binary |-
-    MzdjNjVjMTAwYjc2Yzg5YzI5ZTI1YjBiY2ZlNDA0MmIyYjE4MGNiNQ==
+    YmU2ZDc0N2NiMTFmYTIwYmEwZWExZGM3ZTQ1MTY2NDA0YTM5OWZkNg==
 SHA512:
   metadata.gz: !binary |-
-    NzZlMGZmMDY3ODVkNjgyOGE2ZTMzMzZkNWMzMWUxMzU4MTk0NGIzY2UzZTYx
-    Y2RhODM1NDdlNzE0ZDZhN2JkOWRlYmZhZWUzNzI2MmQ5YzIwOTE2ZjYwZmYw
-    ZDZhZmRjZDc3NzAxNTU4ZDRiODdmYmEzMmRiMGYwMDI5MTRmNTY=
+    ZjY5ODBmNWNhZGJhZGJlM2Y1YmJmZTgzNWY1NjU4ZDBlMjE4YjgyZmYxNWI1
+    Y2VkMTc1NDcxMmQzNzZkZDcyODA4NTU0M2RkZDQzYjc2YTM1ZDYwNjE2NWE3
+    YjZhODU4ZGQ2ODY4NzY4ZTZjMWM1NDFlNzdhYjhlNGNkYmM4NjI=
   data.tar.gz: !binary |-
-    ZTYwNjBkOTI2NjNkOGFiNjdmMDJiMjU5NzNjZmNhOTQyYjVlNTFhNWI5NTIy
-    MTFmNWNhMTlmMzFmZjkxYjZlZTI4ZTVkNjA2OTkxYzY3ZTM0OGY2ZjRjZWY4
-    ODRhNDRiYTExODllYzQ1MWIyOTU5MWE0ZDYxYzNjMWJkOWQ2ZWM=
+    MDE5NjI3ZGIwMzY4NTVkZWJiYjRkMDAxN2UwNDQ5M2VkZjFmMGJhYzAyN2Nl
+    ZmNjM2Q3MDMxY2Q5NDFhNjc4Yzk2NmM1NWY5M2IxMThlZTk2MTA0MDUxZTA5
+    ZWQ5NzM3OGViYmJkMTA4NWQ0NTMxYTk3MzFiODQyNGZmMGQ4NTI=

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 1.8
+
+## 19th February 2015
+
+* Fixed an issue with misinterpretation of crc in RTP files from older Mosaiq versions.
+* Added support for versioning in RTP file output (supporting versions 2.4, 2.5 & 2.6).
+* Fixed an issue where you couldn't access the ExtendedPlan record from its parent Plan record.
+
+
 # 1.7
 
 ## 17th September 2014

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rtp-connect (1.7)
+    rtp-connect (1.8)
 
 GEM
   remote: http://www.rubygems.org/

data/README.md

@@ -1,3 +1,5 @@
+[![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.11752.png)](http://dx.doi.org/10.5281/zenodo.11752)
+
 # RTPConnect
 
 The RTPConnect library allows you to read, edit and write RTPConnect files in Ruby.
@@ -123,7 +125,7 @@ If you encounter an RTP file with an unsupported record type, please contact me.
 
 ## COPYRIGHT
 
-Copyright 2011-2014 Christoffer Lervåg
+Copyright 2011-2015 Christoffer Lervåg
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by

data/lib/rtp-connect/constants.rb

@@ -42,7 +42,7 @@ module RTP
   # Pairs of RTPConnect keywords and parse method names.
   PARSE_METHOD = {
     "PLAN_DEF" => :plan_definition,
-    "EXTENDED_PLAN_DEF" => :extended_plan,
+    "EXTENDED_PLAN_DEF" => :extended_plan_def,
     "RX_DEF" => :prescription_site,
     "SITE_SETUP_DEF" => :site_setup,
     "SIM_DEF" => :simulation_field,

data/lib/rtp-connect/control_point.rb

@@ -279,13 +279,15 @@ module RTP
     # Encodes the ControlPoint object + any hiearchy of child objects,
     # to a properly formatted RTPConnect ascii string.
     #
+    # @param [Hash] options an optional hash parameter
+    # @option options [Float] :version the Mosaiq compatibility version number (e.g. 2.4) used for the output
     # @return [String] an RTP string with a single or multiple lines/records
     #
-    def to_s
-      str = encode
+    def to_s(options={})
+      str = encode(options)
       if children
         children.each do |child|
-          str += child.to_s
+          str += child.to_s(options)
         end
       end
       return str

data/lib/rtp-connect/dose_tracking.rb

@@ -123,13 +123,15 @@ module RTP
     # Encodes the DoseTracking object + any hiearchy of child objects,
     # to a properly formatted RTPConnect ascii string.
     #
+    # @param [Hash] options an optional hash parameter
+    # @option options [Float] :version the Mosaiq compatibility version number (e.g. 2.4) used for the output
     # @return [String] an RTP string with a single or multiple lines/records
     #
-    def to_s
-      str = encode
+    def to_s(options={})
+      str = encode(options)
       if children
         children.each do |child|
-          str += child.to_s
+          str += child.to_s(options)
         end
       end
       return str

data/lib/rtp-connect/extended_field.rb

@@ -100,13 +100,15 @@ module RTP
     # Encodes the ExtendedField object + any hiearchy of child objects,
     # to a properly formatted RTPConnect ascii string.
     #
+    # @param [Hash] options an optional hash parameter
+    # @option options [Float] :version the Mosaiq compatibility version number (e.g. 2.4) used for the output
     # @return [String] an RTP string with a single or multiple lines/records
     #
-    def to_s
-      str = encode
+    def to_s(options={})
+      str = encode(options)
       if children
         children.each do |child|
-          str += child.to_s
+          str += child.to_s(options)
         end
       end
       return str

data/lib/rtp-connect/extended_plan.rb

@@ -87,13 +87,15 @@ module RTP
     # Encodes the ExtendedPlan object + any hiearchy of child objects,
     # to a properly formatted RTPConnect ascii string.
     #
+    # @param [Hash] options an optional hash parameter
+    # @option options [Float] :version the Mosaiq compatibility version number (e.g. 2.4) used for the output
     # @return [String] an RTP string with a single or multiple lines/records
     #
-    def to_s
-      str = encode
+    def to_s(options={})
+      str = encode(options)
       if children
         children.each do |child|
-          str += child.to_s
+          str += child.to_s(options)
         end
       end
       return str

data/lib/rtp-connect/field.rb

@@ -233,13 +233,15 @@ module RTP
     # Encodes the Field object + any hiearchy of child objects,
     # to a properly formatted RTPConnect ascii string.
     #
+    # @param [Hash] options an optional hash parameter
+    # @option options [Float] :version the Mosaiq compatibility version number (e.g. 2.4) used for the output
     # @return [String] an RTP string with a single or multiple lines/records
     #
-    def to_s
-      str = encode
+    def to_s(options={})
+      str = encode(options)
       if children
         children.each do |child|
-          str += child.to_s
+          str += child.to_s(options)
         end
       end
       return str

data/lib/rtp-connect/plan.rb

@@ -1,4 +1,4 @@
-#    Copyright 2011-2014 Christoffer Lervag
+#    Copyright 2011-2015 Christoffer Lervag
 #
 #    This program is free software: you can redistribute it and/or modify
 #    it under the terms of the GNU General Public License as published by
@@ -29,6 +29,8 @@ module RTP
     attr_reader :parent
     # An array of Prescription records (if any) that belongs to this Plan.
     attr_reader :prescriptions
+    # The ExtendedPlan record (if any) that belongs to this Plan.
+    attr_reader :extended_plan
     # An array of DoseTracking records (if any) that belongs to this Plan.
     attr_reader :dose_trackings
     attr_reader :patient_id
@@ -270,12 +272,14 @@ module RTP
     # Encodes the Plan object + any hiearchy of child objects,
     # to a properly formatted RTPConnect ascii string.
     #
+    # @param [Hash] options an optional hash parameter
+    # @option options [Float] :version the Mosaiq compatibility version number (e.g. 2.4) used for the output
     # @return [String] an RTP string with a single or multiple lines/records
     #
-    def to_s
-      str = encode #.force_encoding('utf-8')
+    def to_s(options={})
+      str = encode(options)
       children.each do |child|
-        str += child.to_s #.force_encoding('utf-8')
+        str += child.to_s(options) unless child.class == ExtendedPlan && options[:version].to_f < 2.5
       end
       return str
     end
@@ -286,10 +290,12 @@ module RTP
     # to a properly formatted RTPConnect ascii file.
     #
     # @param [String] file a path/file string
+    # @param [Hash] options an optional hash parameter
+    # @option options [Float] :version the Mosaiq compatibility version number (e.g. 2.4) used for the output
     #
-    def write(file)
+    def write(file, options={})
       f = open_file(file)
-      f.write(to_s)
+      f.write(to_s(options))
       f.close
     end
 
@@ -525,7 +531,7 @@ module RTP
     #
     # @param [String] string a string line containing an extended plan definition
     #
-    def extended_plan(string)
+    def extended_plan_def(string)
       ep = ExtendedPlan.load(string, @current_parent)
       @current_parent = ep
     end

data/lib/rtp-connect/prescription.rb

@@ -140,13 +140,15 @@ module RTP
     # Encodes the Prescription object + any hiearchy of child objects,
     # to a properly formatted RTPConnect ascii string.
     #
+    # @param [Hash] options an optional hash parameter
+    # @option options [Float] :version the Mosaiq compatibility version number (e.g. 2.4) used for the output
     # @return [String] an RTP string with a single or multiple lines/records
     #
-    def to_s
-      str = encode
+    def to_s(options={})
+      str = encode(options)
       if children
         children.each do |child|
-          str += child.to_s
+          str += child.to_s(options)
         end
       end
       return str

data/lib/rtp-connect/record.rb

@@ -35,10 +35,13 @@ module RTP
     #
     # This produces the full record string line, including a computed CRC checksum.
     #
+    # @param [Hash] options an optional hash parameter
+    # @option options [Float] :version the Mosaiq compatibility version number (e.g. 2.4) used for the output
     # @return [String] a proper RTPConnect type CSV string
     #
-    def encode
+    def encode(options={})
       encoded_values = values.collect {|v| v && v.encode('ISO8859-1')}
+      encoded_values = discard_unsupported_attributes(encoded_values, options) if options[:version]
       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
@@ -110,10 +113,32 @@ module RTP
     # @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])}
+      ([values.length - 1, @max_elements - 1].min).times do |i|
+        self.send("#{@attributes[i]}=", values[i])
+      end
       @crc = values[-1]
     end
 
+    # Removes any attributes that are newer than the given compatibility target version.
+    # E.g. if a compatibility version of Mosaiq 2.4 is specified, attributes that were
+    # introduced in Mosaiq 2.5 or later is removed before the RTP string is created.
+    #
+    # @param [Array<String>] values the complete set of values of this record
+    # @param [Hash] options an optional hash parameter
+    # @option options [Float] :version the Mosaiq compatibility version number (e.g. 2.4) used for the output
+    # @return [Array<String>] an array of attributes where some of the recent attributes may have been removed
+    #
+    def discard_unsupported_attributes(values, options={})
+      case self
+      when SiteSetup
+        options[:version].to_f >= 2.6 ? values : values[0..-4]
+      when ExtendedField
+        options[:version].to_f >= 2.4 ? values : values[0..-5]
+      else
+        values
+      end
+    end
+
   end
 
 end

data/lib/rtp-connect/simulation_field.rb

@@ -186,13 +186,15 @@ module RTP
     # Encodes the SimulationField object + any hiearchy of child objects,
     # to a properly formatted RTPConnect ascii string.
     #
+    # @param [Hash] options an optional hash parameter
+    # @option options [Float] :version the Mosaiq compatibility version number (e.g. 2.4) used for the output
     # @return [String] an RTP string with a single or multiple lines/records
     #
-    def to_s
-      str = encode
+    def to_s(options={})
+      str = encode(options)
       if children
         children.each do |child|
-          str += child.to_s
+          str += child.to_s(options)
         end
       end
       return str

data/lib/rtp-connect/site_setup.rb

@@ -110,13 +110,15 @@ module RTP
     # Encodes the SiteSetup object + any hiearchy of child objects,
     # to a properly formatted RTPConnect ascii string.
     #
+    # @param [Hash] options an optional hash parameter
+    # @option options [Float] :version the Mosaiq compatibility version number (e.g. 2.4) used for the output
     # @return [String] an RTP string with a single or multiple lines/records
     #
-    def to_s
-      str = encode
+    def to_s(options={})
+      str = encode(options)
       if children
         children.each do |child|
-          str += child.to_s
+          str += child.to_s(options)
         end
       end
       return str

data/lib/rtp-connect/version.rb

@@ -1,6 +1,6 @@
 module RTP
 
   # The RTPConnect library version string.
-  VERSION = '1.7'
+  VERSION = '1.8'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rtp-connect
 version: !ruby/object:Gem::Version
-  version: '1.7'
+  version: '1.8'
 platform: ruby
 authors:
 - Christoffer Lervag
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-17 00:00:00.000000000 Z
+date: 2015-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -172,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Library for handling RTPConnect files.