rtp-connect 1.1 → 1.2

data/lib/rtp-connect/site_setup.rb

@@ -2,10 +2,9 @@ module RTP
 
   # The SiteSetup class.
   #
-  # === Relations
-  #
-  # * Parent: Prescription
-  # * Children: none
+  # @note Relations:
+  #   * Parent: Prescription
+  #   * Children: none
   #
   class SiteSetup < Record
 
@@ -26,12 +25,12 @@ module RTP
     attr_reader :couch_angle
     attr_reader :couch_pedestal
 
-    # Creates a new SiteSetup setup by parsing a RTPConnect string line.
-    #
-    # === Parameters
+    # Creates a new SiteSetup by parsing a RTPConnect string line.
     #
-    # * <tt>string</tt> -- A string containing a site setup record.
-    # * <tt>parent</tt> -- A Record which is used to determine the proper parent of this instance.
+    # @param [#to_s] string the site setup definition record string line
+    # @param [Record] parent a record which is used to determine the proper parent of this instance
+    # @return [SiteSetup] the created SiteSetup instance
+    # @raise [ArgumentError] if given a string containing an invalid number of elements
     #
     def self.load(string, parent)
       # Get the quote-less values:
@@ -60,9 +59,7 @@ module RTP
 
     # Creates a new SiteSetup.
     #
-    # === Parameters
-    #
-    # * <tt>parent</tt> -- A Record which is used to determine the proper parent of this instance.
+    # @param [Record] parent a record which is used to determine the proper parent of this instance
     #
     def initialize(parent)
       # Parent relation (always expecting a Prescription here):
@@ -71,7 +68,13 @@ module RTP
       @keyword = 'SITE_SETUP_DEF'
     end
 
-    # Returns true if the argument is an instance with attributes equal to self.
+    # Checks for equality.
+    #
+    # Other and self are considered equivalent if they are
+    # of compatible types and their attributes are equivalent.
+    #
+    # @param other an object to be compared with self.
+    # @return [Boolean] true if self and other are considered equivalent
     #
     def ==(other)
       if other.respond_to?(:to_site_setup)
@@ -81,20 +84,28 @@ module RTP
 
     alias_method :eql?, :==
 
-    # Returns an empty array, as these instances are child-less by definition.
+    # Gives an empty array, as these instances are child-less by definition.
+    #
+    # @return [Array] an emtpy array
     #
     def children
       return Array.new
     end
 
-    # Generates a Fixnum hash value for this instance.
+    # Computes a hash code for this object.
+    #
+    # @note Two objects with the same attributes will have the same hash code.
+    #
+    # @return [Fixnum] the object's hash code
     #
     def hash
       state.hash
     end
 
-    # Returns the values of this instance in an array.
-    # The values does not include the CRC.
+    # 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 [
@@ -116,9 +127,11 @@ module RTP
       ]
     end
 
-    # Writes the SiteSetup object + any hiearchy of child objects,
+    # Encodes the SiteSetup object + any hiearchy of child objects,
     # to a properly formatted RTPConnect ascii string.
     #
+    # @return [String] an RTP string with a single or multiple lines/records
+    #
     def to_s
       str = encode
       if children
@@ -133,12 +146,18 @@ module RTP
 
     # Returns self.
     #
+    # @return [SiteSetup] self
+    #
     def to_site_setup
       self
     end
 
     # 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 'SITE_SETUP_DEF', got #{value}." unless value == "SITE_SETUP_DEF"
@@ -147,93 +166,124 @@ module RTP
 
     # Sets the rx_site_name attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def rx_site_name=(value)
       @rx_site_name = value && value.to_s
     end
 
     # Sets the patient_orientation attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def patient_orientation=(value)
       @patient_orientation = value && value.to_s
     end
 
     # Sets the treatment_machine attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def treatment_machine=(value)
       @treatment_machine = value && value.to_s
     end
 
     # Sets the tolerance_table attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def tolerance_table=(value)
-      @tolerance_table = value && value.to_s
+      @tolerance_table = value && value.to_s.strip
     end
 
     # Sets the iso_pos_x attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def iso_pos_x=(value)
-      @iso_pos_x = value && value.to_s
+      @iso_pos_x = value && value.to_s.strip
     end
 
     # Sets the iso_pos_y attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def iso_pos_y=(value)
-      @iso_pos_y = value && value.to_s
+      @iso_pos_y = value && value.to_s.strip
     end
 
     # Sets the iso_pos_z attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def iso_pos_z=(value)
-      @iso_pos_z = value && value.to_s
+      @iso_pos_z = value && value.to_s.strip
     end
 
     # Sets the structure_set_uid attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def structure_set_uid=(value)
       @structure_set_uid = value && value.to_s
     end
 
     # Sets the frame_of_ref_uid attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def frame_of_ref_uid=(value)
       @frame_of_ref_uid = value && value.to_s
     end
 
     # Sets the couch_vertical attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def couch_vertical=(value)
-      @couch_vertical = value && value.to_s
+      @couch_vertical = value && value.to_s.strip
     end
 
     # Sets the couch_lateral attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def couch_lateral=(value)
-      @couch_lateral = value && value.to_s
+      @couch_lateral = value && value.to_s.strip
     end
 
     # Sets the couch_longitudinal attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def couch_longitudinal=(value)
-      @couch_longitudinal = value && value.to_s
+      @couch_longitudinal = value && value.to_s.strip
     end
 
     # Sets the couch_angle attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def couch_angle=(value)
-      @couch_angle = value && value.to_s
+      @couch_angle = value && value.to_s.strip
     end
 
     # Sets the couch_pedestal attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def couch_pedestal=(value)
-      @couch_pedestal = value && value.to_s
+      @couch_pedestal = value && value.to_s.strip
     end
 
 
     private
 
 
-    # Returns the attributes of this instance in an array (for comparison purposes).
+    # Collects the attributes of this instance.
+    #
+    # @note The CRC is not considered part of the attributes of interest and is excluded
+    # @return [Array<String>] an array of attributes
     #
     alias_method :state, :values
 

data/lib/rtp-connect/version.rb

@@ -1,6 +1,6 @@
-module RTP
-
-  # The RTPConnect library version string.
-  VERSION = "1.1"
-
+module RTP
+
+  # The RTPConnect library version string.
+  VERSION = "1.2"
+
 end

data/rakefile.rb

@@ -0,0 +1,29 @@
+# Available commands:
+# Testing the specification:
+#   bundle exec rake spec
+# Building a gem package from source:
+#   bundle exec rake package
+# Create html documentation files:
+#   bundle exec rake yard
+
+require 'rubygems/package_task'
+require 'rspec/core/rake_task'
+require 'yard'
+
+# Build gem:
+gem_spec = eval(File.read('rtp-connect.gemspec'))
+Gem::PackageTask.new(gem_spec) do |pkg|
+  pkg.gem_spec = gem_spec
+  #pkg.need_tar = true
+end
+
+# RSpec 2:
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"]
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+# Build documentation (YARD):
+YARD::Rake::YardocTask.new do |t|
+  t.options += ['--title', "RTP-Connect #{RTP::VERSION} Documentation"]
+end

data/rtp-connect.gemspec

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+
+require File.expand_path('../lib/rtp-connect/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.platform = Gem::Platform::RUBY
+  s.name = 'rtp-connect'
+  s.version = RTP::VERSION
+  s.date = Time.now
+  s.summary = "Library for handling RTPConnect files."
+  s.require_paths = ['lib']
+  s.author = "Christoffer Lervag"
+  s.email = "chris.lervag@gmail.com"
+  s.homepage = "https://github.com/dicom/rtp-connect"
+  s.license = "GPLv3"
+  s.description = "RTPConnect is a file format used in radiotherapy for export & import of treatment planning data."
+  s.files = Dir["{lib}/**/*", "[A-Z]*"]
+  s.rubyforge_project = 'rtp-connect'
+
+  s.required_ruby_version = '>= 1.9.2'
+  s.required_rubygems_version = '>= 1.8.6'
+
+  s.add_development_dependency('bundler', '>= 1.0.0')
+  s.add_development_dependency('dicom', '>= 0.9.3')
+  s.add_development_dependency('rake', '>= 0.9.2.2')
+  s.add_development_dependency('rspec', '>= 2.9.0')
+  s.add_development_dependency('mocha', '>= 0.10.5')
+  s.add_development_dependency('yard', '>= 0.8.2')
+end

metadata

@@ -1,77 +1,128 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rtp-connect
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: '1.2'
   prerelease: 
-  version: "1.1"
 platform: ruby
-authors: 
+authors:
 - Christoffer Lervag
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-04-18 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: dicom
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.3
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.9.2.2
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.9.0
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+- !ruby/object:Gem::Dependency
   name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.5
+  type: :development
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.10.5
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.2
   type: :development
-  version_requirements: *id004
-description: RTPConnect is a file format used in radiotherapy for export & import of treatment planning data.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+description: RTPConnect is a file format used in radiotherapy for export & import
+  of treatment planning data.
 email: chris.lervag@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/rtp-connect/constants.rb
 - lib/rtp-connect/control_point.rb
+- lib/rtp-connect/dose_tracking.rb
 - lib/rtp-connect/extended_field.rb
 - lib/rtp-connect/field.rb
 - lib/rtp-connect/logging.rb
 - lib/rtp-connect/methods.rb
 - lib/rtp-connect/plan.rb
+- lib/rtp-connect/plan_to_dcm.rb
 - lib/rtp-connect/prescription.rb
 - lib/rtp-connect/record.rb
 - lib/rtp-connect/ruby_extensions.rb
@@ -81,33 +132,34 @@ files:
 - lib/rtp-connect.rb
 - CHANGELOG.rdoc
 - COPYING
+- Gemfile
+- Gemfile.lock
+- rakefile.rb
 - README.rdoc
+- rtp-connect.gemspec
 homepage: https://github.com/dicom/rtp-connect
-licenses: 
-- GPL3
+licenses:
+- GPLv3
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.9.2
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.8.6
 requirements: []
-
 rubyforge_project: rtp-connect
-rubygems_version: 1.8.13
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Library for handling RTPConnect files.
 test_files: []
-