Class: RBT::Cookbooks::ValidateAllCookbookEntries
- Inherits:
-
Base
show all
- Defined in:
- lib/rbt/checks_and_validations/validate_all_cookbook_entries.rb
Overview
RBT::ValidateAllCookbookEntries
Constant Summary
collapse
- REGEX_TO_USE_FOR_RUBY_TAGS =
/ tags:\n - ruby$/
- REGEX_TO_USE_FOR_PYTHON_TAGS =
/ tags:\n - python$/
- REGEX_FOR_PREFIX_AND_KEEP_EXTRACTED_IN_CLOSE_PROXIMITY =
/prefix: (.+)$\n keep_extracted: /
LeanPrototype::ALL_COLOUR_METHODS, LeanPrototype::ARRAY_KDE_KONSOLE_COLOURS_IN_USE, LeanPrototype::DAY_NAMES, LeanPrototype::NAMESPACE, LeanPrototype::SILENT_REDIRECTION
Class Method Summary
collapse
-
.[](i = '') ⇒ Object
# === RBT::Cookbooks::ValidateAllCookbookEntries[] ========================================================================= #.
Instance Method Summary
collapse
Methods inherited from Base
#cat, #cd_back_to_the_current_working_directory, #consider_reporting_how_many_programs_are_registered, #cookbook_files?, #copy_recursively, #delete_code_of_conduct?, #determine_appdir_prefix_from_this_input, #directory_validation?, #do_not_show_names, #fast_return_file_size_of_this_program, #file_last_symlinked_program?, #file_programs_version_url, #gem_version, #is_a_64bit_system?, #is_ccache_available?, #is_porg_available?, #is_this_binary_registered?, #is_this_program_included?, #make_command?, #make_install_command?, #new_cookbook_instance_for, #program_exists?, #publish_list_of_all_programs_version, #rcp, registered_binaries?, #remove_symlink, #rename_kde_konsole_tab, #repackage, #report_n_programs, #report_working_directory, #return_compile_time_statistics, #return_n_random_characters, #return_version_of_this_program, #run_make_then_make_install, #sanitize_url1_entry, #set_source_directory, #show_overview_over_available_utility_scripts, #symlink_all_files_from_this_directory_to_that_directory, #system_tags?, #upload_list_of_all_programs_version, #use_yaml_database_for_tags?, #warn_and_exit, #wget
#a_or_an?, #abbreviations?, #absolute_path, #action, #add_to_the_commandline_arguments, #all_binaries?, #all_files_from, #all_libraries?, #allowed_cookbook_entries?, #appdir_location_of?, #append_onto_the_internal_hash, #append_what_into, #archive_type_of?, #available_programs?, #be_quiet?, #be_verbose?, #begins_with_a_comment?, #capitalize_first_alphabetical_character, #cd_to_the_log_directory, #cd_to_the_temp_directory, #change_directory, #change_permission, #cheering_person?, #chmod, #chop_off_archive, #clear_commandline_arguments, #cliner, #coloured_and_padded_e, #coloured_and_padded_esystem, #coloured_esystem, #colourize_directory_for_system_results, #colourize_this_error, #colourize_this_file_path, #colourize_this_warning, #commandline_arguments?, #commandline_arguments_without_hyphens?, #comment, #convert_dd_mm_yyyy_to_its_long_variant, #convert_env_variable, #copy_directory, #copy_files, #cpr, #create_directory, #current_hour?, #dd_mmm_yyy, #debug, #debug?, #directory_expanded_cookbooks?, #disable_colours, #display_md5sum?, #do_not_debug, #does_the_cookbook_include_this_program?, #does_this_expanded_cookbook_file_exist_for_this_program?, #does_this_file_exist?, #does_this_file_exist_and_is_it_a_file?, #e, #eblue, #ecomment, #ecrimson, #edir, #editor?, #efancy, #eimp, #enable_colours, #enable_debug, #ensure_main_encoding_for, #eparse, #esystem, #esystem_gold, #etomato, #ewarn, #exit_program, #expanded_cookbooks_directory_exists?, #extract_this_archive, #extract_to?, #file_compiled_programs?, #file_dirname_retaining_trailing_slash, #file_predefined_installation_instructions?, #file_specification_of_registered_cookbook_entries, #find_cookbook_alias_for, #find_this_yaml_file, #first_argument?, #first_non_hyphen_argument?, #get_all_directories_from, #get_all_files_from, #get_all_programs, #get_date, #get_extended_date, #get_files_and_directories_from, #go_to_base_dir, #home_dir?, #host_system?, #infer_the_namespace, #internal_hash?, #internal_hash_set_commandline_arguments, #is_an_archive?, #is_directory?, #is_file?, #is_github_url?, #is_make_available?, #is_meson_installed?, #is_on_gobolinux?, #is_on_windows?, #is_roebe?, #is_superuser?, #is_symlink?, #is_this_a_header?, #is_this_a_library?, #is_this_program_included?, #iso_encoding?, #load_dataset_from_this_expanded_cookbook, #load_yaml, #load_yaml_file_from_the_cookbook_directory_for_this_program, #log_directory?, #main_encoding?, #meson_build_file_exists?, #months?, #move_file, #n_programs_are_available?, #n_programs_available?, #namespace?, #no_directory_exists_at, #no_directory_was_found_at, #no_opn, #no_such_file_exists, #open_in_browser, #open_in_editor, #opncomment, #opne, #opnef, #opnerev, #opnerror, #opnesystem, #opnewarn, #opnfancy, #opnn, #otomato, #packages_directory?, #path_to_this_expanded_cookbooks_dataset, #pkgconfig_directory?, #populate_the_internal_hash_with_default_values, #predefined_installation_instructions?, #prepend_this_commandline_argument, #program_version_of?, #project_base_directory?, #project_yaml_directory?, #query_path?, #rarrow?, #read_file, #read_file_in_default_encoding, #read_file_with_default_encoding, #readlines, #readlines_with_proper_encoding, #register_sigint, #registered_cookbook_entries?, #remove, #remove_archive_from_the_end, #remove_comments_from_each_line, #remove_directory, #remove_double_slashes, #remove_file, #remove_newlines, #remove_parens, #remove_symlink, #remove_the_first_commandline_argument, #remove_this_commandline_argument, #remove_this_entry_from_the_commandline_arguments, #remove_trailing_ANSII_escape_code, #remove_unnecessary_data_from_url, #rename, #report_pwd, #require_the_rbt_aliases, #reset_the_internal_hash, #return_all_archives_from_this_directory, #return_appdir_prefix, #return_commandline_arguments_with_leading_hyphens, #return_current_hour_minutes_second, #return_date, #return_day_of_the_month_based_on_utc, #return_full_time, #return_hours_minutes_seconds_based_on_utc, #return_location_to_this_programs_yaml_file, #return_month_based_on_this_number, #return_month_based_on_utc, #return_opnn, #return_program_name, #return_program_name_for_gobolinux_systems, #return_program_name_via_program_information, #return_pwd, #return_unicode_warning_symbol_or_empty_string, #return_utc, #return_utc_time_in_a_format_similar_to_slackware, #return_weekday_based_on_utc, #return_year_based_on_utc, #rev, #rpn, #run_simulation=, #run_simulation?, #sdir, #sdir_return_pwd, #set_be_silent, #set_be_verbose, #set_first_commandline_argument, #set_namespace, #set_use_colours, #set_use_opn, #set_xorg_buffer, #sfancy, #sfile, #silent_redirection?, #silently_create_this_directory_if_it_does_not_yet_exist, #simp, #source_base_directory?, #ssym, #stderr, #store_into_this_directory?, #string_right_arrow?, #swarn, #symlink, #sysbin_directory?, #sysetc_directory?, #sysinclude_directory?, #syslib_directory?, #sysshare_directory?, #system_directory?, #temp_directory?, #to_bool, #to_camelcase, #to_iso_encoding, #to_unicode, #today?, #touch, #try_to_require_beautiful_url, #try_to_require_the_environment_information_gem, #try_to_require_the_extracter_gem, #try_to_require_the_open_gem, #try_to_require_the_xorg_buffer, #try_to_require_wget, #try_to_return_a_special_compile_component, #unicode_cliner, #unicode_middle_cliner, #use_colours=, #use_colours?, #use_opn=, #use_opn?, #utf_encoding?, #verbose_truth, #word_wrap, #write_what_into, #write_what_into_via_unicode, #yes_or_no
Constructor Details
#initialize(commandline_arguments = nil, run_already = true) ⇒ ValidateAllCookbookEntries
58
59
60
61
62
63
64
65
66
67
68
|
# File 'lib/rbt/checks_and_validations/validate_all_cookbook_entries.rb', line 58
def initialize(
commandline_arguments = nil,
run_already = true
)
register_sigint
reset
set_commandline_arguments(
commandline_arguments
)
run if run_already
end
|
Class Method Details
.[](i = '') ⇒ Object
#
RBT::Cookbooks::ValidateAllCookbookEntries[]
#
436
437
438
|
# File 'lib/rbt/checks_and_validations/validate_all_cookbook_entries.rb', line 436
def self.[](i = '')
new(i)
end
|
Instance Method Details
#
The input to this method is assumed to be an Array.
#
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
# File 'lib/rbt/checks_and_validations/validate_all_cookbook_entries.rb', line 121
def (
dataset_to_use
)
position_of_prefix = dataset_to_use.index { |entry| entry.include? ' prefix:' }
= dataset_to_use.index { |entry| entry.include? ' keep_extracted:' }
if .nil?
nil
elsif position_of_prefix.nil?
nil
else
position_of_prefix > end
end
|
102
103
104
105
106
107
108
109
110
111
112
113
114
|
# File 'lib/rbt/checks_and_validations/validate_all_cookbook_entries.rb', line 102
def (i)
if i.is_a? Array
i.each {|entry| (entry) }
else
case i
when /^-?-?\d+$/
@internal_hash[:open_n_files] = i.delete('-').to_i
end
end
end
|
#open_n_files? ⇒ Boolean
140
141
142
|
# File 'lib/rbt/checks_and_validations/validate_all_cookbook_entries.rb', line 140
def open_n_files?
@internal_hash[:open_n_files]
end
|
#open_this_file_with_default_delay(i) ⇒ Object
#
open_this_file_with_default_delay (open tag)
#
147
148
149
150
151
152
153
154
155
|
# File 'lib/rbt/checks_and_validations/validate_all_cookbook_entries.rb', line 147
def open_this_file_with_default_delay(i)
unless open_n_files? == :all_of_them
return if @counter >= open_n_files?
end
@counter += 1
@how_many_individual_problems_have_been_encountered += 1
open_in_editor(i)
sleep 1
end
|
#reset ⇒ Object
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
# File 'lib/rbt/checks_and_validations/validate_all_cookbook_entries.rb', line 73
def reset
super()
infer_the_namespace
@internal_hash[:open_n_files] = :all_of_them
@counter = 0
@how_many_individual_problems_have_been_encountered = 0
end
|
#return_coloured_cheering_person ⇒ Object
#
return_coloured_cheering_person
#
160
161
162
|
# File 'lib/rbt/checks_and_validations/validate_all_cookbook_entries.rb', line 160
def return_coloured_cheering_person
gold(cheering_person?)
end
|
#run ⇒ Object
423
424
425
426
427
428
429
430
431
|
# File 'lib/rbt/checks_and_validations/validate_all_cookbook_entries.rb', line 423
def run
work_through_every_cookbook_file
if @how_many_individual_problems_have_been_encountered == 0
opne 'No problem has been encountered. '+return_coloured_cheering_person
else
opne 'There were '+sfancy(@how_many_individual_problems_have_been_encountered)+
' individual problems discovered.'
end
end
|
#set_commandline_arguments(i = '') ⇒ Object
#
set_commandline_arguments
#
93
94
95
96
97
|
# File 'lib/rbt/checks_and_validations/validate_all_cookbook_entries.rb', line 93
def set_commandline_arguments(i = '')
i = [i].flatten.compact
(i)
@commandline_arguments = i
end
|
#work_through_every_cookbook_file ⇒ Object
#
work_through_every_cookbook_file (logic tag)
This is the main powerhorse method of this class.
#
169
170
171
172
173
174
175
176
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
205
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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
|
# File 'lib/rbt/checks_and_validations/validate_all_cookbook_entries.rb', line 169
def work_through_every_cookbook_file
is_on_roebe = is_on_roebe?
sorted_programs = available_programs?.sort
sorted_programs.each_with_index {|this_program, index|
target_yaml_file = return_yaml_file_for(this_program).dup
regular_dataset = default_readlines(target_yaml_file)
string_representation_of_this_dataset = regular_dataset.join
if string_representation_of_this_dataset.include? 'tags: '
e "Wrong tags: entry in the file #{sfile(target_yaml_file)}"
open_this_file_with_default_delay(target_yaml_file) if is_on_roebe
end
if string_representation_of_this_dataset.include?(' tags:') and
string_representation_of_this_dataset.include?(' required_deps_on:') and
(
string_representation_of_this_dataset.index(' required_deps_on:') <
string_representation_of_this_dataset.index(' tags:')
)
e "The required_deps_on: entry occurs before the "\
"tags: entry, for #{sfile(target_yaml_file)}"
open_this_file_with_default_delay(target_yaml_file) if is_on_roebe
end
if string_representation_of_this_dataset.include?(' tags:') and
string_representation_of_this_dataset.include?(' prefix:') and
(
string_representation_of_this_dataset.index(' tags:') <
string_representation_of_this_dataset.index(' prefix:')
)
e "The tags: entry occurs before the "\
"prefix: entry, for #{sfile(target_yaml_file)}"
open_this_file_with_default_delay(target_yaml_file) if is_on_roebe
end
if string_representation_of_this_dataset.include?(' description:') and
string_representation_of_this_dataset.include?(' configure_options:') and
(
string_representation_of_this_dataset.index(' description:') <
string_representation_of_this_dataset.index(' configure_options:')
)
e "The tags: entry occurs before the "\
"prefix: entry, for #{sfile(target_yaml_file)}"
open_this_file_with_default_delay(target_yaml_file) if is_on_roebe
end
if string_representation_of_this_dataset.include?(' prefix:') and
string_representation_of_this_dataset.include?(' url1:') and
(
string_representation_of_this_dataset.index(' prefix:') <
string_representation_of_this_dataset.index(' url1:')
)
e "The tags: prefix occurs before the "\
"url1: entry, for #{sfile(target_yaml_file)}"
open_this_file_with_default_delay(target_yaml_file) if is_on_roebe
end
if string_representation_of_this_dataset.include?(' required_deps_on:') and
string_representation_of_this_dataset.include?(' prefix:') and
(
string_representation_of_this_dataset.index(' required_deps_on:') <
string_representation_of_this_dataset.index(' prefix:')
)
e "The required_deps_on: entry occurs before the "\
"prefix: entry, for #{sfile(target_yaml_file)}"
open_this_file_with_default_delay(target_yaml_file) if is_on_roebe
end
if string_representation_of_this_dataset.include?(' configure_options:') and
string_representation_of_this_dataset.include?(' short_description:') and
(
string_representation_of_this_dataset.index(' short_description:') <
string_representation_of_this_dataset.index(' configure_options:')
)
e "The configure_options: entry occurs after the "\
"short_description: entry, for #{sfile(target_yaml_file)}"
open_this_file_with_default_delay(target_yaml_file) if is_on_roebe
end
if string_representation_of_this_dataset.include? 'binaries: '
e "Wrong binaries: entry in the file #{sfile(target_yaml_file)}"
open_this_file_with_default_delay(target_yaml_file) if is_on_roebe
end
if string_representation_of_this_dataset.scan(/url1: /).size > 1
e "At the least two url1: entries for #{sfile(target_yaml_file)}"
open_this_file_with_default_delay(target_yaml_file) if is_on_roebe
end
if string_representation_of_this_dataset.include? 'configure_options: "'
e "Wrong configure_options: entry for #{sfile(target_yaml_file)}"
open_this_file_with_default_delay(target_yaml_file) if is_on_roebe
end
if string_representation_of_this_dataset.include? '"Extra information for this program to use."'
e 'Wrong extra_information: in the file '+sfile(target_yaml_file)
open_this_file_with_default_delay(target_yaml_file) if is_on_roebe
end
if string_representation_of_this_dataset.include? ' description: |
""'
e 'Wrong description entry for '+sfile(target_yaml_file)
open_this_file_with_default_delay(target_yaml_file) if is_on_roebe
end
if string_representation_of_this_dataset.include? ' extra_information: |
""'
e "Wrong extra_information: entry for #{sfile(target_yaml_file)}"
open_this_file_with_default_delay(target_yaml_file) if is_on_roebe
end
if string_representation_of_this_dataset.include? 'required_deps_on: '
e "#{rev}Slightly incorrect #{steelblue('required_deps_on: ')}"\
"entry for #{sfile(target_yaml_file)}"
open_this_file_with_default_delay(target_yaml_file) if is_on_roebe
end
if (string_representation_of_this_dataset.include?('short_description:') and
!string_representation_of_this_dataset.include?('short_description: |')) or
string_representation_of_this_dataset.include?('short_description: | ')
e 'Wrong '+steelblue('short_description: ')+
'entry in the file '+sfile(target_yaml_file)
open_this_file_with_default_delay(target_yaml_file) if is_on_roebe
end
if (
string_representation_of_this_dataset.include?('prefix: ') and
string_representation_of_this_dataset.include?('keep_extracted: ') and
!(string_representation_of_this_dataset =~ REGEX_FOR_PREFIX_AND_KEEP_EXTRACTED_IN_CLOSE_PROXIMITY)
)
e 'Wrong '+steelblue('prefix: ')+' and '+
steelblue('keep_extracted: ')+'combination in '\
'the file '+sfile(target_yaml_file)
e 'These entries should be close together, e. g. first '\
'prefix:, next line keep_extracted:'
open_this_file_with_default_delay(target_yaml_file) if is_on_roebe
end
unless string_representation_of_this_dataset.include?(' homepage: ')
e "There is #{gold('no homepage:')} entry for #{sfile(target_yaml_file)}"
open_this_file_with_default_delay(target_yaml_file) if is_on_roebe
end
if (regular_dataset.any? {|line| line =~ /^ - ruby$/ } and
(string_representation_of_this_dataset =~ REGEX_TO_USE_FOR_RUBY_TAGS)) or
(regular_dataset.any? {|line| line =~ /^ - python$/ } and
(string_representation_of_this_dataset =~ REGEX_TO_USE_FOR_PYTHON_TAGS))
else
=
(
regular_dataset
)
if .nil?
end
if
e 'In the file '+sfile(target_yaml_file)+':'
e
e crimson('The keep_extracted: entry occurs before the prefix: entry.')
e crimson('This is discouraged and should be changed.')
if is_on_roebe
open_this_file_with_default_delay(target_yaml_file)
end
end
end
}
end
|