openehr 2.0.2 → 2.3.0

data/lib/openehr/parser/opt_parser.rb

@@ -1,12 +1,19 @@
 require 'nokogiri'
+require_relative 'xml_constraint_parsing'
+require_relative 'xml_primitive_parsing'
+require_relative 'xml_domain_type_parsing'
 
 module OpenEHR
   module Parser
     class OPTParser < ::OpenEHR::Parser::Base
+      include XMLConstraintParsing
+      include XMLPrimitiveParsing
+      include XMLDomainTypeParsing
+
       TEMPLATE_LANGUAGE_CODE_PATH =
         '/template/language/code_string'
       TEMPLATE_LANGUAGE_TERM_ID_PATH =
-        '/template/language/terminology_id/value'      
+        '/template/language/terminology_id/value'
       TEMPLATE_ID_PATH = '/template/template_id/value'
       UID_PATH = '/template/uid/value'
       CONCEPT_PATH = '/template/concept'
@@ -31,18 +38,14 @@ module OpenEHR
         '/template/description/other_details'
       DEFINITION_PATH = '/template/definition'
       OCCURRENCE_PATH = '/occurrences'
-      
-      def initialize(filename)
-        super(filename)
-      end
 
       def parse
         @opt = Nokogiri::XML::Document.parse(File.open(@filename))
         @opt.remove_namespaces!
-        
+
         uid = build_uid
         defs = definition
-        
+
         # Create operational template with archetype-compatible parameters
         OpenEHR::AM::Template::OperationalTemplate.new(
           uid: uid,
@@ -123,7 +126,7 @@ module OpenEHR
         # Create a basic ontology for the template using the main concept
         concept_code = 'at0000'
         original_lang = language
-        
+
         term_definitions = {
           original_lang.code_string => [
             OpenEHR::AM::Archetype::Terminology::ArchetypeTerm.new(
@@ -135,7 +138,7 @@ module OpenEHR
             )
           ]
         }
-        
+
         OpenEHR::AM::Archetype::Terminology::ArchetypeTerminology.new(
           concept_code: concept_code,
           original_language: original_lang,
@@ -164,418 +167,6 @@ module OpenEHR
         { language.code_string => term_items }
       end
 
-      def c_archetype_root(xml, node = Node.new)
-        rm_type_name = text_on_path(xml, './rm_type_name') 
-        id = text_on_path(xml, './node_id')
-        node.id = id unless id.nil? or id.empty?
-        occurrences = occurrences(xml.xpath('./occurrences'))
-        archetype_id = OpenEHR::RM::Support::Identification::ArchetypeID.new(value: text_on_path(xml, './archetype_id/value'))
-        if node.root? or node.id.nil?
-          node.path = "/"
-        # else
-        #   node.path += "/"  #"/[#{archetype_id.value}]"
-        end
-        component_terminologies(archetype_id, xml)
-        OpenEHR::AM::Archetype::ConstraintModel::CArchetypeRoot.new(rm_type_name: rm_type_name, node_id: node.id, path: node.path, occurrences: occurrences, archetype_id: archetype_id, attributes: attributes(xml.xpath('./attributes'), node))
-      end
-
-      def c_complex_object(xml, node)
-        rm_type_name = xml.xpath('./rm_type_name').text
-        node_id = xml.xpath('./node_id').text
-        unless node_id.nil? or node_id.empty?
-          node.id = node_id
-          node.path = "#{node.path}[#{node.id}]"
-        end
-        OpenEHR::AM::Archetype::ConstraintModel::CComplexObject.new(rm_type_name: rm_type_name, node_id: node.id, path: node.path, occurrences: occurrences(xml.xpath('./occurrences')), attributes: attributes(xml.xpath('./attributes'), node))
-      end
-
-      def attributes(attributes_xml, node)
-        attributes_xml.map do |attr|
-          rm_attribute_name = attr.at('rm_attribute_name').text
-          if node.root?
-            path = "/#{rm_attribute_name}"
-          # elsif node.id
-          #   path = "#{node.path}[#{node.id}]/#{rm_attribute_name}"
-          else
-            path = "#{node.path}/#{rm_attribute_name}"
-          end
-          child_node = Node.new(node)
-          child_node.path = path
-          child_node.id = node.id
-          send attr.attributes['type'].text.downcase, attr, child_node
-        end
-      end
-
-      def children(children_xml, node)
-        children_xml.map do |child|
-          send child.attributes['type'].text.downcase, child, node
-        end
-      end
-
-      def c_single_attribute(attr_xml, node)
-        rm_attribute_name = attr_xml.at('rm_attribute_name').text
-        existence = occurrences(attr_xml.at('existence'))
-        OpenEHR::AM::Archetype::ConstraintModel::CSingleAttribute.new(rm_attribute_name: rm_attribute_name, existence: existence, path: node.path, children: children(attr_xml.xpath('./children'), node))
-      end
-
-      def c_multiple_attribute(attr_xml, node)
-        rm_attribute_name = attr_xml.at('rm_attribute_name').text
-        existence = occurrences(attr_xml.at('existence'))
-        OpenEHR::AM::Archetype::ConstraintModel::CMultipleAttribute.new(rm_attribute_name: rm_attribute_name, existence: existence, path: node.path, cardinality: cardinality(attr_xml), children: children(attr_xml.xpath('./children'), node))
-      end
-
-      def c_code_phrase(attr_xml, node)
-        terminology_id_node = attr_xml.at('terminology_id/value')
-        terminology_id = terminology_id_node ? OpenEHR::RM::Support::Identification::TerminologyID.new(value: terminology_id_node.text.strip) : nil
-        
-        code_list_nodes = attr_xml.xpath('code_list')
-        code_list = code_list_nodes.map { |code_node| code_node.text.strip }
-        code_list = [code_list.first] if code_list.size == 1 && code_list.first.empty?
-        
-        occurrences_node = attr_xml.at('occurrences')
-        occurrences_obj = occurrences_node ? occurrences(occurrences_node) : nil
-        
-        OpenEHR::AM::OpenEHRProfile::DataTypes::Text::CCodePhrase.new(
-          terminology_id: terminology_id, 
-          code_list: code_list, 
-          path: node.path, 
-          occurrences: occurrences_obj, 
-          rm_type_name: 'CODE_PHRASE'
-        )
-      end
-
-      def archetype_slot(attr_xml,node)
-        path = node.path
-        node.id = attr_xml.at('node_id').text
-        rm_type_name = attr_xml.at('rm_type_name').text
-        occurrences = occurrences(attr_xml.at('occurrences'))
-        includes_leaf = attr_xml.at('includes')
-        includes = assertions(includes_leaf.children, node) if includes_leaf
-        excludes_leaf = attr_xml.at('excludes')
-        excludes = assertions(excludes_leaf.children, node) if excludes_leaf
-        OpenEHR::AM::Archetype::ConstraintModel::ArchetypeSlot.new(path: path, node_id: node.id, rm_type_name: rm_type_name, occurrences: occurrences, includes: includes, excludes: excludes)
-      end
-
-      def occurrences(occurrence_xml)
-        return nil if occurrence_xml.nil?
-        
-        lower_node = occurrence_xml.at('lower')
-        upper_node = occurrence_xml.at('upper')
-        lower_included_node = occurrence_xml.at('lower_included')
-        upper_included_node = occurrence_xml.at('upper_included')
-        lower_unbounded_node = occurrence_xml.at('lower_unbounded')
-        upper_unbounded_node = occurrence_xml.at('upper_unbounded')
-        
-        lower = lower_node ? lower_node.text.to_i : nil
-        upper = upper_node ? upper_node.text.to_i : nil
-        lower_included = lower_included_node ? to_bool(lower_included_node.text) : (lower.nil? ? nil : true)
-        upper_included = upper_included_node ? to_bool(upper_included_node.text) : (upper.nil? ? nil : true)
-        lower_unbounded = lower_unbounded_node ? to_bool(lower_unbounded_node.text) : false
-        upper_unbounded = upper_unbounded_node ? to_bool(upper_unbounded_node.text) : false
-
-        # An occurrences element with none of its children present carries no
-        # constraint at all; Interval requires at least one bound, so treat
-        # this as "no occurrences data" rather than raising.
-        return nil if lower.nil? && upper.nil? && !lower_unbounded && !upper_unbounded
-
-        # Handle unbounded intervals properly
-        if upper_unbounded || upper.nil?
-          upper = nil
-          upper_included = nil
-        end
-        
-        if lower_unbounded || lower.nil?
-          lower = nil
-          lower_included = nil
-        end
-        
-        OpenEHR::AssumedLibraryTypes::Interval.new(
-          lower: lower, 
-          upper: upper, 
-          lower_included: lower_included, 
-          upper_included: upper_included
-        )
-      end
-
-      def cardinality(xml)
-        return nil if xml.nil?
-
-        order_node = xml.at('is_ordered')
-        unique_node = xml.at('is_unique')
-        interval_node = xml.at('interval')
-
-        # No cardinality sub-elements at all means no cardinality data.
-        return nil if order_node.nil? && unique_node.nil? && interval_node.nil?
-
-        order = order_node ? to_bool(order_node.text) : false
-        unique = unique_node ? to_bool(unique_node.text) : false
-        interval = interval_node ? occurrences(interval_node) : nil
-        
-        OpenEHR::AM::Archetype::ConstraintModel::Cardinality.new(
-          is_ordered: order, 
-          is_unique: unique, 
-          interval: interval
-        )
-      end        
-
-      def archetype_internal_ref(attr_xml, node)
-        rm_type_name = attr_xml.at('rm_type_name').text
-        target_path = attr_xml.at('target_path').text
-        occurrences = occurrences(attr_xml.at('occurrences'))
-        OpenEHR::AM::Archetype::ConstraintModel::ArchetypeInternalRef.new(rm_type_name: rm_type_name, occurrences: occurrences, target_path: target_path)
-      end
-
-      # No .opt fixture in this gem's corpus uses a C_DV_STATE (state
-      # machine) constraint, so its actual OPT XML shape is unverified;
-      # raising a clear, documented error here is safer than guessing
-      # at element names and risking a silently wrong StateMachine.
-      def c_dv_state(_attr_xml, _node)
-        raise NotImplementedError, 'OPTParser does not yet support C_DV_STATE (state machine) constraints'
-      end
-
-      def constraint_ref(attr_xml, node)
-        rm_type_name = attr_xml.at('rm_type_name').text
-        reference = attr_xml.at('reference').text
-        occurrences = occurrences(attr_xml.at('occurrences'))
-        OpenEHR::AM::Archetype::ConstraintModel::ConstraintRef.new(rm_type_name: rm_type_name, occurrences: occurrences, reference: reference)
-      end
-
-      def assertions(attr_xml, node)
-        string_expression = attr_xml.at('string_expression')
-        string_expression = string_expression.nil? ? nil : string_expression.text
-        expression_leaf = attr_xml.at 'expression'
-        expression = send expression_leaf.attributes['type'].text.downcase, expression_leaf
-        [OpenEHR::AM::Archetype::Assertion::Assertion.new(expression: expression, string_expression: string_expression)]
-      end
-
-      def expr_binary_operator(attr_xml)
-        type = attr_xml.at('type').text
-        operator = OpenEHR::AM::Archetype::Assertion::OperatorKind.new(value: attr_xml.at('operator').text.to_i)
-
-        precedence_overridden = attr_xml.at('precedence_overridden').text == 'true' ? true : false
-        right_operand_leaf = attr_xml.at 'right_operand'
-        right_operand = send right_operand_leaf.attributes['type'].text.downcase, right_operand_leaf
-        left_operand_leaf = attr_xml.at 'left_operand'
-        left_operand = send left_operand_leaf.attributes['type'].text.downcase, left_operand_leaf
-        OpenEHR::AM::Archetype::Assertion::ExprBinaryOperator.new(type: type, operator: operator, precedence_overridden: precedence_overridden, right_operand: right_operand, left_operand: left_operand)
-      end
-
-      def expr_leaf(attr_xml)
-        type = attr_xml.at('type').text
-        item_leaf = attr_xml.at('item')
-        item = send type.downcase, item_leaf
-        reference_type = attr_xml.at('reference_type').text
-        OpenEHR::AM::Archetype::Assertion::ExprLeaf.new(type: type, item: item, reference_type: reference_type)
-      end
-
-      def c_primitive_object(attr_xml, node)
-        rm_type_name = attr_xml.at('rm_type_name').text
-        occurrences = occurrences(attr_xml.at('occurrences'))
-        item = send attr_xml.at('item')['type'].downcase, attr_xml.at('item')
-        OpenEHR::AM::Archetype::ConstraintModel::CPrimitiveObject.new(rm_type_name: rm_type_name, occurrences: occurrences, node_id: node.id, item: item)
-      end
-
-      def c_string(attr_xml)
-        if attr_xml.at('pattern')
-          OpenEHR::AM::Archetype::ConstraintModel::Primitive::CString.new(pattern: attr_xml.at('pattern').text)
-        else
-          list = attr_xml.xpath('.//list').map do |str|
-            str.text
-          end
-          OpenEHR::AM::Archetype::ConstraintModel::Primitive::CString.new(list: list)
-        end
-      end
-
-      def c_dv_quantity(attr_xml, node)
-        rm_type_name = attr_xml.at('rm_type_name').text
-        occurrences = occurrences(attr_xml.at('occurrences'))
-        property = property_code_phrase(attr_xml.at('property'))
-        list = attr_xml.xpath('.//list').map do |element|
-          units = element.at('units').text if element.at('units')
-          magnitude = occurrences(element.at('magnitude')) if element.at('magnitude')
-          precision = occurrences(element.at('precision')) if element.at('precision')
-          OpenEHR::AM::OpenEHRProfile::DataTypes::Quantity::CQuantityItem.new(magnitude: magnitude, precision: precision, units: units)
-        end
-        OpenEHR::AM::OpenEHRProfile::DataTypes::Quantity::CDvQuantity.new(rm_type_name: rm_type_name, occurrences: occurrences, list: list, property: property)
-      end
-
-      # The <property> element is optional in real templates; return nil rather
-      # than dereferencing missing terminology/code nodes.
-      def property_code_phrase(property_xml)
-        return nil if property_xml.nil?
-        terminology_node = property_xml.at('terminology_id/value')
-        code_node = property_xml.at('code_string')
-        return nil if terminology_node.nil? || code_node.nil?
-        terminology_id = OpenEHR::RM::Support::Identification::TerminologyID.new(value: terminology_node.text)
-        OpenEHR::RM::DataTypes::Text::CodePhrase.new(terminology_id: terminology_id, code_string: code_node.text)
-      end
-
-      def c_dv_ordinal(attr_xml, node)
-        rm_type_name = attr_xml.at('rm_type_name').text
-        occurrences = occurrences(attr_xml.at('occurrences'))
-        list = attr_xml.xpath('list').map { |element| dv_ordinal_item(element) }.compact
-        OpenEHR::AM::OpenEHRProfile::DataTypes::Quantity::CDvOrdinal.new(rm_type_name: rm_type_name, occurrences: occurrences, list: list)
-      end
-
-      # DV_ORDINAL.symbol is spec'd as DV_CODED_TEXT; the OPT XML only
-      # carries a defining_code (terminology_id + code_string), so the
-      # DvCodedText's own value is set to that same code_string (there
-      # is no separate display text in this element).
-      def dv_ordinal_item(element)
-        value_node = element.at('value')
-        return nil unless value_node && !value_node.text.empty?
-
-        code_phrase = property_code_phrase(element.at('symbol/defining_code'))
-        return nil if code_phrase.nil?
-
-        symbol = OpenEHR::RM::DataTypes::Text::DvCodedText.new(value: code_phrase.code_string, defining_code: code_phrase)
-        OpenEHR::RM::DataTypes::Quantity::DvOrdinal.new(value: value_node.text.to_i, symbol: symbol)
-      end
-
-      def c_dv_scale(attr_xml, node)
-        rm_type_name = attr_xml.at('rm_type_name').text
-        occurrences = occurrences(attr_xml.at('occurrences'))
-        list = attr_xml.xpath('list').map { |element| dv_scale_item(element) }.compact
-        OpenEHR::AM::OpenEHRProfile::DataTypes::Quantity::CDvScale.new(rm_type_name: rm_type_name, occurrences: occurrences, list: list)
-      end
-
-      # Same XML shape as C_DV_ORDINAL's list items, but DV_SCALE.value
-      # is Real rather than Integer.
-      def dv_scale_item(element)
-        value_node = element.at('value')
-        return nil unless value_node && !value_node.text.empty?
-
-        code_phrase = property_code_phrase(element.at('symbol/defining_code'))
-        return nil if code_phrase.nil?
-
-        symbol = OpenEHR::RM::DataTypes::Text::DvCodedText.new(value: code_phrase.code_string, defining_code: code_phrase)
-        OpenEHR::RM::DataTypes::Quantity::DvScale.new(value: value_node.text.to_f, symbol: symbol)
-      end
-
-      def c_date(xml)
-        pattern = xml.at('pattern')
-        range = xml.at('range')
-        if pattern
-          OpenEHR::AM::Archetype::ConstraintModel::Primitive::CDate.new(pattern: pattern.text)
-        elsif range
-          OpenEHR::AM::Archetype::ConstraintModel::Primitive::CDate.new(range: occurrences(range))
-        else
-          OpenEHR::AM::Archetype::ConstraintModel::Primitive::CDate.new
-        end
-      end
-
-      def c_date_time(xml)
-        pattern = xml.at('pattern')
-        range = xml.at('range')
-        if pattern
-          OpenEHR::AM::Archetype::ConstraintModel::Primitive::CDateTime.new(pattern: pattern.text)
-        elsif range
-          OpenEHR::AM::Archetype::ConstraintModel::Primitive::CDateTime.new(range: occurrences(range))
-        else
-          OpenEHR::AM::Archetype::ConstraintModel::Primitive::CDateTime.new
-        end
-      end
-
-      def c_integer(xml)
-        range = xml.at('range')
-        list = xml.xpath('list')
-        if range
-          OpenEHR::AM::Archetype::ConstraintModel::Primitive::CInteger.new(range: occurrences(range))
-        elsif !list.empty?
-          list_values = list.map { |item| item.text.to_i }
-          OpenEHR::AM::Archetype::ConstraintModel::Primitive::CInteger.new(list: list_values)
-        else
-          OpenEHR::AM::Archetype::ConstraintModel::Primitive::CInteger.new
-        end
-      end
-
-      def c_real(xml)
-        range = xml.at('range')
-        list = xml.xpath('list')
-        if range
-          OpenEHR::AM::Archetype::ConstraintModel::Primitive::CReal.new(range: occurrences(range))
-        elsif !list.empty?
-          list_values = list.map { |item| item.text.to_f }
-          OpenEHR::AM::Archetype::ConstraintModel::Primitive::CReal.new(list: list_values)
-        else
-          OpenEHR::AM::Archetype::ConstraintModel::Primitive::CReal.new
-        end
-      end
-
-      def c_duration(xml)
-        pattern = xml.at('pattern')
-        range_xml = xml.at('range')
-        list = xml.xpath('list')
-        if pattern
-          OpenEHR::AM::Archetype::ConstraintModel::Primitive::CDuration.new(pattern: pattern.text)
-        elsif range_xml
-          OpenEHR::AM::Archetype::ConstraintModel::Primitive::CDuration.new(range: duration_range(range_xml))
-        elsif !list.empty?
-          OpenEHR::AM::Archetype::ConstraintModel::Primitive::CDuration.new(list: list.map(&:text))
-        else
-          OpenEHR::AM::Archetype::ConstraintModel::Primitive::CDuration.new
-        end
-      end
-
-      # A C_DURATION range's bounds are ISO8601 duration strings (e.g.
-      # PT24H), not plain numbers, so occurrences() (built for numeric
-      # Interval bounds) doesn't apply here; wrap each bound as a
-      # DV_DURATION instead, matching what CDuration#valid_value?
-      # already expects its range bounds to be.
-      def duration_range(range_xml)
-        lower = duration_bound(range_xml.at('lower'), range_xml.at('lower_unbounded'))
-        upper = duration_bound(range_xml.at('upper'), range_xml.at('upper_unbounded'))
-        return nil if lower.nil? && upper.nil?
-
-        OpenEHR::AssumedLibraryTypes::Interval.new(
-          lower: lower, upper: upper,
-          lower_included: lower.nil? ? nil : bool_node(range_xml.at('lower_included'), true),
-          upper_included: upper.nil? ? nil : bool_node(range_xml.at('upper_included'), true))
-      end
-
-      def duration_bound(value_node, unbounded_node)
-        return nil if bool_node(unbounded_node, false)
-        return nil if value_node.nil? || value_node.text.empty?
-
-        OpenEHR::RM::DataTypes::Quantity::DateTime::DvDuration.new(value: value_node.text)
-      end
-
-      def bool_node(node, default)
-        node ? to_bool(node.text) : default
-      end
-
-      def c_time(xml)
-        pattern = xml.at('pattern')
-        range = xml.at('range')
-        if pattern
-          OpenEHR::AM::Archetype::ConstraintModel::Primitive::CTime.new(pattern: pattern.text)
-        elsif range
-          OpenEHR::AM::Archetype::ConstraintModel::Primitive::CTime.new(range: occurrences(range))
-        else
-          OpenEHR::AM::Archetype::ConstraintModel::Primitive::CTime.new
-        end
-      end
-
-      def c_boolean(xml)
-        true_valid = xml.at('true_valid')
-        false_valid = xml.at('false_valid')
-        assumed_value = xml.at('assumed_value')
-        
-        true_valid_value = true_valid ? to_bool(true_valid.text) : nil
-        false_valid_value = false_valid ? to_bool(false_valid.text) : nil
-        assumed_value_value = assumed_value ? to_bool(assumed_value.text) : nil
-        
-        OpenEHR::AM::Archetype::ConstraintModel::Primitive::CBoolean.new(
-          true_valid: true_valid_value, 
-          false_valid: false_valid_value, 
-          assumed_value: assumed_value_value
-        )
-      end
-
-      def string(attr_xml)
-        attr_xml.text
-      end
-
       def empty_then_nil(val)
         if val.empty?
           return nil
@@ -587,14 +178,6 @@ module OpenEHR
       def text_on_path(xml, path)
         xml.xpath(path).text
       end
-
-      def to_bool(str)
-        return nil if str.nil?
-        str = str.text if str.respond_to?(:text)
-        return true if /true/i =~ str.to_s
-        return false if /false/i =~ str.to_s
-        nil
-      end
     end
   end
 end