Class: CarinForBlueButtonTestKit::Generator::SearchTestGenerator

Inherits:
Object
  • Object
show all
Defined in:
lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(group_metadata, search_metadata, base_output_dir) ⇒ SearchTestGenerator

Returns a new instance of SearchTestGenerator.



23
24
25
26
27
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 23

def initialize(group_metadata, search_metadata, base_output_dir)
  self.group_metadata = group_metadata
  self.search_metadata = search_metadata
  self.base_output_dir = base_output_dir
end

Instance Attribute Details

#base_output_dir ⇒ Object

Returns the value of attribute base_output_dir.



21
22
23
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 21

def base_output_dir
  @base_output_dir
end

#group_metadata ⇒ Object

Returns the value of attribute group_metadata.



21
22
23
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 21

def group_metadata
  @group_metadata
end

#search_metadata ⇒ Object

Returns the value of attribute search_metadata.



21
22
23
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 21

def search_metadata
  @search_metadata
end

Class Method Details

.generate(ig_metadata, base_output_dir) ⇒ Object 



9
10
11
12
13
14
15
16
17
18
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 9

def generate(ig_metadata, base_output_dir)
  ig_metadata.groups
             .select { |group| group.searches.present? }
             .each do |group|
    group.searches.each { |search| new(group, search, base_output_dir).generate }
    group.include_params.each do |param|
      IncludeSearchTestGenerator.new(group, param, base_output_dir).generate
    end
  end
end

Instance Method Details

#all_search_params ⇒ Object 



93
94
95
96
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 93

def all_search_params
  group_metadata.searches.map { |param| param[:names] }
                .flatten
end

#array_of_strings(array) ⇒ Object 



195
196
197
198
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 195

def array_of_strings(array)
  quoted_strings = array.map { |element| "'#{element}'" }
  "[#{quoted_strings.join(', ')}]"
end

#base_output_file_name ⇒ Object 



37
38
39
40
41
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 37

def base_output_file_name
  file_name = class_name.underscore
  file_name.sub!("#{profile_identifier}_", '')
  "#{file_name}.rb"
end

#class_name ⇒ Object 



67
68
69
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 67

def class_name
  "#{Naming.upper_camel_case_for_profile(group_metadata)}#{search_title}SearchTest"
end

#conformance_expectation ⇒ Object 



79
80
81
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 79

def conformance_expectation
  search_metadata[:expectation]
end

#description ⇒ Object 



287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 287

def description
  <<~DESCRIPTION.gsub(/\n{3,}/, "\n\n")
    A server #{conformance_expectation} support searching by
    #{search_param_name_string} on the #{resource_type} resource. This test
    will pass if resources are returned and match the search criteria. If
    none are returned, the test is skipped.

    #{reference_search_description}
    #{first_search_description}
    #{post_search_description}

  DESCRIPTION
end

#first_search? ⇒ Boolean

Returns:

  • (Boolean) 


98
99
100
101
102
103
104
105
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 98

def first_search?
  # Mark patient the first search for EOB
  if all_search_params.include?('patient')
    search_param_name_string == 'patient'
  else
    group_metadata.searches.first == search_metadata
  end
end

#first_search_description ⇒ Object 



267
268
269
270
271
272
273
274
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 267

def first_search_description
  return '' unless first_search?

  <<~FIRST_SEARCH_DESCRIPTION
    Because this is the first search of the sequence, resources in the
    response will be used for subsequent tests.
  FIRST_SEARCH_DESCRIPTION
end

#fixed_value_search? ⇒ Boolean

Returns:

  • (Boolean) 


107
108
109
110
111
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 107

def fixed_value_search?
  first_search? && search_metadata[:names] != ['patient'] &&
    search_metadata[:names] != ['_id'] && !group_metadata.delayed? &&
    resource_type != 'Patient'
end

#fixed_value_search_param_name ⇒ Object 



113
114
115
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 113

def fixed_value_search_param_name
  (search_metadata[:names] - [:patient]).first
end

#generate ⇒ Object 



247
248
249
250
251
252
253
254
255
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 247

def generate
  FileUtils.mkdir_p(output_file_directory)
  File.write(output_file_name, output)

  group_metadata.add_test(
    id: test_id,
    file_name: base_output_file_name
  )
end

#input_description ⇒ Object 



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 317

def input_description
  desc_content = if needs_patient_id?
                   "
                    Comma separated list of patient IDs that in sum
                    contain all MUST SUPPORT elements
                    "
                 else
                   "
                    This input is optional. If running all tests, the search will look for
                    its parameter values from the results returned in the EOB tests. If no
                    #{resource_type} resource was returned in previous EOB tests and this
                    input is not provided, the search is skipped.

                    When running just the #{resource_type} Test group, this input is
                    required to perform the search, otherwise the search is skipped.
                    "
                 end

  <<~INPUT_DESCRIPTION
    #{desc_content}
  INPUT_DESCRIPTION
end

#input_id ⇒ Object 



301
302
303
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 301

def input_id
  needs_patient_id? ? 'patient_ids' : "#{test_id}_param"
end

#input_title ⇒ Object 



305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 305

def input_title
  title_content = if needs_patient_id?
                    'Patient IDs'
                  else
                    "#{resource_type} search parameter for #{search_param_name_string}"
                  end

  <<~INPUT_TITLE
    #{title_content.strip}
  INPUT_TITLE
end

#module_name ⇒ Object 



71
72
73
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 71

def module_name
  "CARIN4BB#{group_metadata.reformatted_version.upcase}"
end

#needs_patient_id? ⇒ Boolean

Returns:

  • (Boolean) 


121
122
123
124
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 121

def needs_patient_id?
  search_metadata[:names].include?('patient') ||
    (resource_type == 'Patient' && search_metadata[:names].include?('_id'))
end

#optional? ⇒ Boolean

Returns:

  • (Boolean) 


152
153
154
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 152

def optional?
  conformance_expectation != 'SHALL' || !search_metadata[:must_support_or_mandatory]
end

#output ⇒ Object 



33
34
35
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 33

def output
  @output ||= ERB.new(template).result(binding)
end

#output_file_directory ⇒ Object 



43
44
45
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 43

def output_file_directory
  File.join(base_output_dir, profile_identifier)
end

#output_file_name ⇒ Object 



47
48
49
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 47

def output_file_name
  File.join(output_file_directory, base_output_file_name)
end

#path_for_value(path) ⇒ Object 



134
135
136
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 134

def path_for_value(path)
  path == 'class' ? 'local_class' : path
end

#possible_status_search? ⇒ Boolean

Returns:

  • (Boolean) 


164
165
166
167
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 164

def possible_status_search?
  search_metadata[:names].none? { |name| name.include? 'status' } &&
    group_metadata.search_definitions.keys.any? { |key| key.to_s.include? 'status' }
end

#post_search_description ⇒ Object 



276
277
278
279
280
281
282
283
284
285
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 276

def post_search_description
  return '' unless test_post_search?

  <<~POST_SEARCH_DESCRIPTION
    Additionally, this test will check that GET and POST search methods
    return the same number of results. Search by POST is required by the
    FHIR R4 specification, and these tests interpret search by GET as a
    requirement of CARIN IG for Blue Button® #{group_metadata.version}.
  POST_SEARCH_DESCRIPTION
end

#profile_identifier ⇒ Object 



51
52
53
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 51

def profile_identifier
  Naming.snake_case_for_profile(group_metadata)
end

#reference_search_description ⇒ Object 



257
258
259
260
261
262
263
264
265
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 257

def reference_search_description
  return '' unless test_reference_variants?

  <<~REFERENCE_SEARCH_DESCRIPTION
    This test verifies that the server supports searching by reference using
    the form `patient=[id]` as well as `patient=Patient/[id]`. The two
    different forms are expected to return the same number of results. CARIN requires that both forms are supported by CARIN for Blue Button responders.
  REFERENCE_SEARCH_DESCRIPTION
end

#required_comparators ⇒ Object 



144
145
146
147
148
149
150
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 144

def required_comparators
  @required_comparators ||=
    search_param_names.each_with_object({}) do |name, comparators|
      required_comparators = required_comparators_for_param(name)
      comparators[name] = required_comparators if required_comparators.present?
    end
end

#required_comparators_for_param(name) ⇒ Object 



138
139
140
141
142
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 138

def required_comparators_for_param(name)
  search_definition(name)[:comparators].select { |_comparator, expectation| expectation == 'SHALL' }
rescue NoMethodError
  []
end

#required_comparators_string ⇒ Object 



191
192
193
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 191

def required_comparators_string
  array_of_strings(required_comparators.keys)
end

#required_multiple_or_search_params ⇒ Object 



180
181
182
183
184
185
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 180

def required_multiple_or_search_params
  @required_multiple_or_search_params ||=
    search_param_names.select do |name|
      search_definition(name)[:multiple_or] == 'SHALL'
    end
end

#required_multiple_or_search_params_string ⇒ Object 



187
188
189
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 187

def required_multiple_or_search_params_string
  array_of_strings(required_multiple_or_search_params)
end

#resource_type ⇒ Object 



75
76
77
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 75

def resource_type
  group_metadata.resource
end

#saves_delayed_references? ⇒ Boolean

Returns:

  • (Boolean) 


160
161
162
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 160

def saves_delayed_references?
  first_search? && group_metadata.delayed_references.present?
end

#search_definition(name) ⇒ Object 



156
157
158
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 156

def search_definition(name)
  group_metadata.search_definitions[name.to_sym]
end

#search_identifier ⇒ Object 



59
60
61
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 59

def search_identifier
  search_metadata[:names].join('_').tr('-', '_')
end

#search_param_name_string ⇒ Object 



117
118
119
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 117

def search_param_name_string
  search_metadata[:names].join(' + ')
end

#search_param_names ⇒ Object 



126
127
128
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 126

def search_param_names
  search_params.map { |param| param[:name] }
end

#search_param_names_array ⇒ Object 



130
131
132
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 130

def search_param_names_array
  array_of_strings(search_param_names)
end

#search_params ⇒ Object 



83
84
85
86
87
88
89
90
91
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 83

def search_params
  @search_params ||=
    search_metadata[:names].map do |name|
      {
        name:,
        path: search_definition(name)[:path]
      }
    end
end

#search_properties ⇒ Object 



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 212

def search_properties
  {}.tap do |properties|
    properties[:first_search] = 'true' if first_search?
    properties[:fixed_value_search] = 'true' if fixed_value_search?
    properties[:resource_type] = "'#{resource_type}'"
    properties[:search_param_names] = search_param_names_array
    properties[:saves_delayed_references] = 'true' if saves_delayed_references?
    properties[:possible_status_search] = 'true' if possible_status_search?
    properties[:test_medication_inclusion] = 'true' if test_medication_inclusion?
    properties[:token_search_params] = token_search_params_string if token_search_params.present?
    properties[:test_reference_variants] = 'true' if test_reference_variants?
    properties[:params_with_comparators] = required_comparators_string if required_comparators.present?
    if required_multiple_or_search_params.present?
      properties[:multiple_or_search_params] =
        required_multiple_or_search_params_string
    end
    properties[:test_post_search] = 'true' if first_search?
  end
end

#search_test_properties_string ⇒ Object 



241
242
243
244
245
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 241

def search_test_properties_string
  search_properties
    .map { |key, value| "#{' ' * 8}#{key}: #{value}" }
    .join(",\n")
end

#search_title ⇒ Object 



63
64
65
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 63

def search_title
  search_identifier.camelize
end

#template ⇒ Object 



29
30
31
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 29

def template
  @template ||= File.read(File.join(__dir__, 'templates', 'search.rb.erb'))
end

#test_id ⇒ Object 



55
56
57
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 55

def test_id
  "c4bb_#{group_metadata.reformatted_version}_#{profile_identifier}_#{search_identifier}_search_test"
end

#test_medication_inclusion? ⇒ Boolean

Returns:

  • (Boolean) 


204
205
206
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 204

def test_medication_inclusion?
  resource_type == 'MedicationRequest'
end

#test_post_search? ⇒ Boolean

Returns:

  • (Boolean) 


208
209
210
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 208

def test_post_search?
  first_search?
end

#test_reference_variants? ⇒ Boolean

Returns:

  • (Boolean) 


200
201
202
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 200

def test_reference_variants?
  first_search? && search_param_names.include?('patient')
end

#token_search_params ⇒ Object 



169
170
171
172
173
174
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 169

def token_search_params
  @token_search_params ||=
    search_param_names.select do |name|
      %w[Identifier CodeableConcept Coding].include? group_metadata.search_definitions[name.to_sym][:type]
    end
end

#token_search_params_string ⇒ Object 



176
177
178
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 176

def token_search_params_string
  array_of_strings(token_search_params)
end

#url_version ⇒ Object 



232
233
234
235
236
237
238
239
 
# File 'lib/carin_for_blue_button_test_kit/generator/search_test_generator.rb', line 232

def url_version
  case group_metadata.version
  when 'v3.1.1'
    'STU3.1.1'
  when 'v4.0.0'
    'STU4'
  end
end