inferno_core 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25ba87f81348468d348fb560fea2b87cc25a85b0a20e10c561593135583b14bc
-  data.tar.gz: 65e6e8d5726a8a7f01e47049e3e38bbd8eec84792d1afbc02bd1a4c7c912bf9a
+  metadata.gz: d4cee81fb82d77d10a15e555d118fb4dcb7c38bda12176ac5d4f6e835487ea7a
+  data.tar.gz: 3f6144ea9c28c260b6701a7c849cb4b10d530657ba8e72f3e9fbe80a40858b80
 SHA512:
-  metadata.gz: 6255877fe8d62f455d35133158c9197ed6e606fa1d4b6f0cd76ba2c9a5b5af0c88bcb1580fb0f1ca8e65edee5a04e578927359c31cae94213a2959c1af71700f
-  data.tar.gz: 5d306049dfaa4b5a6f3f64956593dd1a49a93df9dd434f2e336d1269b026b98638617849c4e4ed4133a54f94887a240248259bfedc3c2f0403fdd8f0accc5092
+  metadata.gz: f9a5ec40918160f8dcc099f69c2970cfd90857ed4f74ddda4df1f3f399f44a8a2d83bc33ce31bf69f149371b68405751a1b8d4d12376f58f97b27a3620b13e10
+  data.tar.gz: f9d7425ac56f6589406af7125acc8bcba9fde8db134a40fb74ec7c5908619e22ce48506d6cce8e27b2d83b575c0015b059370c248d81be9ebe718a0632578248

data/lib/inferno/dsl/fhir_resource_navigation.rb

@@ -2,16 +2,21 @@ require_relative 'primitive_type'
 
 module Inferno
   module DSL
-    # The FHIRResourceNavigation module is used to pick values from a FHIR resource, based on a profile.
-    # Originally intended for use for verifying the presence of Must Support elements on a resource.
-    # This module expects pre-processed metadata defining the elements of the profile
-    #  to be present in the attribute `metadata` in the including class.
+    # The FHIRResourceNavigation module is used to pick values from a FHIR
+    # resource, based on a profile. Originally intended for use for verifying
+    # the presence of Must Support elements on a resource and finding values to
+    # use for search parameters. The methods in this module related to slices
+    # expects pre-processed metadata defining the elements of the profile to be
+    # present in the attribute `metadata` in the including class.
+    #
     # @see Inferno::DSL::MustSupportMetadataExtractor
     module FHIRResourceNavigation
       DAR_EXTENSION_URL = 'http://hl7.org/fhir/StructureDefinition/data-absent-reason'.freeze
       PRIMITIVE_DATA_TYPES = FHIR::PRIMITIVES.keys
 
-      # Get a value from the given FHIR element(s) by walking the given path through the element.
+      # Get a value from the given FHIR element(s) by walking the given path
+      # through the element.
+      #
       # @param elements [FHIR::Model, Array<FHIR::Model>]
       # @param path [String]
       # @return [Array<FHIR::Model>]
@@ -29,9 +34,11 @@ module Inferno
         end.compact
       end
 
-      # Get a value from the given FHIR element(s), by navigating through the resource to the given path.
-      # Fields with a DataAbsentReason extension present may be selected if include_dar is true.
-      # To filter the resulting elements, a block may be passed in.
+      # Get a value from the given FHIR element(s), by navigating through the
+      # resource to the given path. Fields with a DataAbsentReason extension
+      # present will be excluded unless include_dar is true. To filter the
+      # resulting elements, a block may be passed in.
+      #
       # @param given_element [FHIR::Model, Array<FHIR::Model>]
       # @param path [String]
       # @param include_dar [Boolean]
@@ -56,6 +63,7 @@ module Inferno
         nil
       end
 
+      # @private
       def find_in_elements(elements, include_dar: false, &)
         unless include_dar
           elements = elements.reject do |el|
@@ -68,6 +76,7 @@ module Inferno
         elements.first
       end
 
+      # @private
       def get_next_value(element, property)
         extension_url = property[/(?<=where\(url=').*(?='\))/]
         if extension_url.present?
@@ -85,6 +94,7 @@ module Inferno
         nil
       end
 
+      # @private
       def get_primitive_type_value(element, property, value)
         source_value = element.source_hash["_#{property}"]
 
@@ -95,6 +105,7 @@ module Inferno
         primitive_value
       end
 
+      # @private
       def local_field_name(field_name)
         # fhir_models prepends fields whose names are reserved in ruby with "local_"
         # This should be used before `x.send(field_name)`
@@ -105,6 +116,7 @@ module Inferno
         end
       end
 
+      # @private
       def find_slice_via_discriminator(element, property)
         return unless metadata.present?
 
@@ -117,6 +129,7 @@ module Inferno
         slices.find { |slice| matching_slice?(slice, discriminator) }
       end
 
+      # @private
       def matching_slice?(slice, discriminator)
         case discriminator[:type]
         when 'patternCodeableConcept'
@@ -134,6 +147,7 @@ module Inferno
         end
       end
 
+      # @private
       def matching_pattern_codeable_concept_slice?(slice, discriminator)
         slice_value = discriminator[:path].present? ? slice.send((discriminator[:path]).to_s)&.coding : slice.coding
         slice_value&.any? do |coding|
@@ -141,20 +155,24 @@ module Inferno
         end
       end
 
+      # @private
       def matching_pattern_coding_slice?(slice, discriminator)
         slice_value = discriminator[:path].present? ? slice.send(discriminator[:path]) : slice
         slice_value&.code == discriminator[:code] && slice_value&.system == discriminator[:system]
       end
 
+      # @private
       def matching_pattern_identifier_slice?(slice, discriminator)
         slice.system == discriminator[:system]
       end
 
+      # @private
       def matching_value_slice?(slice, discriminator)
         values = discriminator[:values].map { |value| value.merge(path: value[:path].split('.')) }
         verify_slice_by_values(slice, values)
       end
 
+      # @private
       def matching_type_slice?(slice, discriminator)
         case discriminator[:code]
         when 'Date'
@@ -176,6 +194,7 @@ module Inferno
         end
       end
 
+      # @private
       def matching_required_binding_slice?(slice, discriminator)
         slice_coding = discriminator[:path].present? ? slice.send((discriminator[:path]).to_s).coding : slice.coding
         slice_coding.any? do |coding|
@@ -190,6 +209,7 @@ module Inferno
         end
       end
 
+      # @private
       def verify_slice_by_values(element, value_definitions)
         path_prefixes = value_definitions.map { |value_definition| value_definition[:path].first }.uniq
         path_prefixes.all? do |path_prefix|
@@ -203,6 +223,7 @@ module Inferno
         end
       end
 
+      # @private
       def current_and_child_values_match?(el_found, value_definitions_for_path)
         child_element_value_definitions, current_element_value_definitions =
           value_definitions_for_path.partition { |value_definition| value_definition[:path].present? }
@@ -220,6 +241,7 @@ module Inferno
         current_element_values_match && child_element_values_match
       end
 
+      # @private
       def flatten_bundles(resources)
         resources.flat_map do |resource|
           if resource&.resourceType == 'Bundle'

data/lib/inferno/dsl/result_collection.rb

@@ -0,0 +1,88 @@
+module Inferno
+  module DSL
+    # The ResultCollection class is used to manage a collection of Inferno::Entities::Result objects.
+    # It provides methods to filter required and optional results, access results
+    # by index or by their runnable IDs, and iterate over the collection.
+    #
+    # @example
+    #
+    #   results = [
+    #     Result.new(test_group_id: 'group_id1', result: 'pass'),
+    #     Result.new(test_group_id: 'group_id2', result: 'fail'),
+    #     Result.new(test_group_id: 'group_id3', result: 'pass')
+    #   ]
+    #
+    #   result_collection = Inferno::DSL::ResultCollection.new(results)
+    #
+    #   # Access by index
+    #   result = result_collection[0]
+    #
+    #   # Access by runnable ID (partial)
+    #   result = result_collection['group_id2']
+    #
+    #   # Iterate over results
+    #   result_collection.each do |result|
+    #     puts result.result
+    #   end
+    #
+    #   # Get required results
+    #   required_results = result_collection.required_results
+    #
+    #   # Get optional results
+    #   optional_results = result_collection.optional_results
+    class ResultCollection
+      include Enumerable
+
+      attr_reader :results
+
+      def initialize(results = [])
+        @results = results
+      end
+
+      # If given an integer, returns the result at that index. If given a string
+      # or symbol, it will return the result for the runnable whose id matches
+      # the provided string/symbol.
+      #
+      # @param key [Integer, String, Symbol]
+      # @return [Inferno::DSL::Result]
+      def [](key)
+        key.is_a?(Integer) ? results[key] : lookup_by_runnable_id(key)
+      end
+
+      def <<(result)
+        (results << result).flatten!
+        self
+      end
+
+      def each(&)
+        return to_enum(:each) unless block_given?
+
+        results.each(&)
+        self
+      end
+
+      # Returns the results for required runnables
+      #
+      # @return Array<Inferno::Entities::Result>
+      def required_results
+        results.select(&:required?)
+      end
+
+      # Returns the results for optional runnables
+      #
+      # @return Array<Inferno::Entities::Result>
+      def optional_results
+        results.select(&:optional?)
+      end
+
+      private
+
+      def lookup_by_runnable_id(key)
+        results.find { |result| result.runnable&.id == key.to_s || result.runnable&.id&.end_with?("-#{key}") }
+      end
+    end
+  end
+
+  # For backwards compatibility
+  ResultCollection = DSL::ResultCollection
+end

data/lib/inferno/dsl.rb

@@ -3,6 +3,7 @@ require_relative 'dsl/auth_info'
 require_relative 'dsl/fhir_client'
 require_relative 'dsl/fhir_validation'
 require_relative 'dsl/fhir_evaluation/evaluator'
+require_relative 'dsl/fhir_resource_navigation'
 require_relative 'dsl/fhir_resource_validation'
 require_relative 'dsl/fhirpath_evaluation'
 require_relative 'dsl/http_client'
@@ -22,6 +23,7 @@ module Inferno
       Results,
       FHIRValidation,
       FHIREvaluation,
+      FHIRResourceNavigation,
       FHIRResourceValidation,
       FhirpathEvaluation,
       Messages,

data/lib/inferno/entities/test_group.rb

@@ -1,6 +1,6 @@
 require_relative '../dsl'
 require_relative '../repositories/test_groups'
-require_relative '../result_collection'
+require_relative '../dsl/result_collection'
 
 module Inferno
   module Entities
@@ -21,7 +21,7 @@ module Inferno
 
       # @private
       def initialize
-        @results = Inferno::ResultCollection.new
+        @results = Inferno::DSL::ResultCollection.new
       end
 
       # @private

data/lib/inferno/entities/test_suite.rb

@@ -6,7 +6,7 @@ require_relative '../dsl/messages'
 require_relative '../dsl/links'
 require_relative '../repositories/test_groups'
 require_relative '../repositories/test_suites'
-require_relative '../result_collection'
+require_relative '../dsl/result_collection'
 require_relative '../dsl/short_id_manager'
 
 module Inferno
@@ -33,7 +33,7 @@ module Inferno
 
       # @private
       def initialize
-        @results = Inferno::ResultCollection.new
+        @results = Inferno::DSL::ResultCollection.new
       end
 
       class << self