Class: Inferno::CLI::RequirementsExporter

Inherits:
Object
  • Object
show all
Defined in:
lib/inferno/apps/cli/requirements_exporter.rb

Constant Summary collapse

INPUT_HEADERS = 
[
  'ID*',
  'URL*',
  'Requirement*',
  'Conformance*',
  'Actors*',
  'Sub-Requirement(s)',
  'Conditionality',
  'Verifiable?',
  'Verifiability Details',
  'Planning To Test?',
  'Planning To Test Details'
].freeze
REQUIREMENTS_OUTPUT_HEADERS = 
[
  'Req Set',
  'ID',
  'URL',
  'Requirement',
  'Conformance',
  'Actors',
  'Sub-Requirement(s)',
  'Conditionality',
  'Not Tested Reason',
  'Not Tested Details'
].freeze

Instance Method Summary collapse

Instance Method Details

#available_input_worksheets ⇒ Object 



55
56
57
58
59
 
# File 'lib/inferno/apps/cli/requirements_exporter.rb', line 55

def available_input_worksheets
  @available_input_worksheets ||=
    Dir.glob(File.join(base_requirements_folder, '*.xlsx'))
      .reject { |f| f.include?('~$') }
end

#base_requirements_folder ⇒ Object 



43
44
45
 
# File 'lib/inferno/apps/cli/requirements_exporter.rb', line 43

def base_requirements_folder
  @base_requirements_folder ||= Dir.glob(File.join(Dir.pwd, 'lib', '*', 'requirements')).first
end

#check_presence_of_input_files ⇒ Object 



240
241
242
243
244
245
246
 
# File 'lib/inferno/apps/cli/requirements_exporter.rb', line 240

def check_presence_of_input_files
  return if available_input_worksheets.present?

  puts 'Could not find any input files in directory ' \
       "#{base_requirements_folder}. Aborting requirements collection."
  exit(1)
end

#check_subrequirements ⇒ Object 



169
170
171
172
173
174
175
 
# File 'lib/inferno/apps/cli/requirements_exporter.rb', line 169

def check_subrequirements
  return if missing_subrequirements.blank?

  missing_subrequirements.each do |id, subrequirement_ids|
    puts "#{id} is missing the following sub-requirements:\n  #{subrequirement_ids.join(', ')}"
  end
end

#input_requirement_sets ⇒ Object

Of the form: { requirement_set_id_1: [row1, row2, row 3, …], requirement_set_id_2: [row1, row2, row 3, …] }



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/inferno/apps/cli/requirements_exporter.rb', line 72

def input_requirement_sets
  @input_requirement_sets ||=
    begin
      requirement_set_hash = Hash.new { |hash, key| hash[key] = [] }
      available_input_worksheets.each_with_object(requirement_set_hash) do |worksheet_file, requirement_sets|
        worksheet = Roo::Spreadsheet.open(worksheet_file)
        set_identifier = requirement_set_id(worksheet)

        CSV.parse(
          worksheet.sheet('Requirements').to_csv,
          headers: true
        ).each do |row|
          row_hash = row.to_h.slice(*INPUT_HEADERS)
          row_hash['Sub-Requirement(s)']&.delete_prefix!('mailto:')

          requirement_sets[set_identifier] << row_hash
        end
      end
    end
end

#local_test_kit_gem ⇒ Object 



35
36
37
 
# File 'lib/inferno/apps/cli/requirements_exporter.rb', line 35

def local_test_kit_gem
  @local_test_kit_gem ||= Bundler.definition.specs.find { |spec| spec.full_gem_path == Dir.pwd }
end

#missing_actor_subrequirements(subrequirement_string) ⇒ Object 



155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/inferno/apps/cli/requirements_exporter.rb', line 155

def missing_actor_subrequirements(subrequirement_string)
  return [] if subrequirement_string.blank?

  return [] unless subrequirement_string.include? '#'

  subrequirement_string
    .split(',')
    .map(&:strip)
    .select { |requirement_string| requirement_string.include? '#' }
    .select do |requirement_string|
      Inferno::Entities::Requirement.expand_requirement_ids(requirement_string).blank?
    end
end

#missing_subrequirements ⇒ Object 



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/inferno/apps/cli/requirements_exporter.rb', line 131

def missing_subrequirements
  @missing_subrequirements =
    {}.tap do |missing_requirements|
      repo = Inferno::Repositories::Requirements.new

      input_requirement_sets
        .each do |requirement_set, requirements|
          requirements.each do |requirement_hash|
            missing_subrequirements =
              Inferno::Entities::Requirement.expand_requirement_ids(requirement_hash['Sub-Requirement(s)'])
                .reject { |requirement_id| repo.exists? requirement_id }

            missing_subrequirements += missing_actor_subrequirements(requirement_hash['Sub-Requirement(s)'])

            next if missing_subrequirements.blank?

            id = "#{requirement_set}@#{requirement_hash['ID*']}"

            missing_requirements[id] = missing_subrequirements
          end
        end
    end
end

#new_requirements_csv ⇒ Object

rubocop:disable Metrics/CyclomaticComplexity



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/inferno/apps/cli/requirements_exporter.rb', line 93

def new_requirements_csv # rubocop:disable Metrics/CyclomaticComplexity
  @new_requirements_csv ||=
    CSV.generate(+"\xEF\xBB\xBF") do |csv| # start with an unnecessary BOM to make viewing in excel easier
      csv << REQUIREMENTS_OUTPUT_HEADERS

      input_requirement_sets.each do |requirement_set_id, input_rows|
        input_rows.each do |row| # NOTE: use row order from source file
          csv << REQUIREMENTS_OUTPUT_HEADERS.map do |header|
            (
              case header
              when 'Req Set'
                requirement_set_id
              when 'Not Tested Reason'
                if spreadsheet_value_falsy?(row['Verifiable?'])
                  'Not Verifiable'
                elsif spreadsheet_value_falsy?(row['Planning To Test?'])
                  'Not Tested'
                end
              when 'Not Tested Details'
                if spreadsheet_value_falsy?(row['Verifiable?'])
                  row['Verifiability Details']
                elsif spreadsheet_value_falsy?(row['Planning To Test?'])
                  row['Planning To Test Details']
                end
              else
                row[header] || row["#{header}*"]
              end
            )&.strip
          end
        end
      end
    end
end

#old_requirements_csv ⇒ Object 



127
128
129
 
# File 'lib/inferno/apps/cli/requirements_exporter.rb', line 127

def old_requirements_csv
  @old_requirements_csv ||= File.read(requirements_output_file_path)
end

#requirement_set_id(worksheet) ⇒ Object 



61
62
63
64
65
 
# File 'lib/inferno/apps/cli/requirements_exporter.rb', line 61

def requirement_set_id(worksheet)
  sheet = worksheet.sheet('Metadata')
  id_row = sheet.column(1).find_index('Id') + 1
  sheet.row(id_row)[1]
end

#requirements_output_file_name ⇒ Object 



47
48
49
 
# File 'lib/inferno/apps/cli/requirements_exporter.rb', line 47

def requirements_output_file_name
  "#{test_kit_name}_requirements.csv"
end

#requirements_output_file_path ⇒ Object 



51
52
53
 
# File 'lib/inferno/apps/cli/requirements_exporter.rb', line 51

def requirements_output_file_path
  File.join(base_requirements_folder, requirements_output_file_name).freeze
end

#run ⇒ Object 



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/inferno/apps/cli/requirements_exporter.rb', line 177

def run
  check_presence_of_input_files

  update_requirements =
    if File.exist?(requirements_output_file_path)
      if old_requirements_csv == new_requirements_csv
        puts "'#{requirements_output_file_name}' file is up to date."
        false
      else
        puts 'Requirements set has changed.'
        true
      end
    else
      puts "No existing #{requirements_output_file_name}."
      true
    end

  if update_requirements
    puts "Writing to file #{requirements_output_file_name}..."
    File.write(requirements_output_file_path, new_requirements_csv, encoding: Encoding::UTF_8)
  end

  Inferno::Application.start(:requirements)

  check_subrequirements

  puts 'Done.'
end

#run_check ⇒ Object 



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/inferno/apps/cli/requirements_exporter.rb', line 206

def run_check
  check_presence_of_input_files

  requirements_ok =
    if File.exist?(requirements_output_file_path)
      if old_requirements_csv == new_requirements_csv
        puts "'#{requirements_output_file_name}' file is up to date."
        true
      else
        puts "#{requirements_output_file_name} file is out of date."
        false
      end
    else
      puts "No existing #{requirements_output_file_name} file."
      false
    end

  unless requirements_ok
    puts <<~MESSAGE
      Check Failed. To resolve, run:

            bundle exec inferno requirements export_csv

    MESSAGE
    exit(1)
  end

  check_subrequirements

  return if missing_subrequirements.blank?

  exit(1)
end

#spreadsheet_value_falsy?(string) ⇒ Boolean

Returns:

  • (Boolean) 


248
249
250
 
# File 'lib/inferno/apps/cli/requirements_exporter.rb', line 248

def spreadsheet_value_falsy?(string)
  ['no', 'false'].include? string&.downcase
end

#test_kit_name ⇒ Object 



39
40
41
 
# File 'lib/inferno/apps/cli/requirements_exporter.rb', line 39

def test_kit_name
  local_test_kit_gem.name
end