Class: RBT::Action::GatherInformation
- Inherits:
-
RBT::Action
show all
- Defined in:
- lib/rbt/actions/individual_actions/information/gather_information.rb
Overview
Constant Summary
collapse
- BR =
'<br>'+N
- B =
'<b>'
- CB =
'</b>'
- P =
'<p>'
- CP =
'</p>'
- DIV =
'<div>'
- CDIV =
'</div>'
- EXIT_ON_FAULTY_COOKBOOK_DISCOVERED =
#
EXIT_ON_FAULTY_COOKBOOK_DISCOVERED
#
false
- DEFAULT_MODE_TO_USE =
:html
- INFO_DIR =
"#{DEPOT_DIR}Information/"
- ARRAY_ALLOWED_TASKS =
[ :all,
:html,
:htm, :ht, :h, :video,
:vid,
:audio,
:aud,
:games,
:lfs,
:lfs_page,
:html_project,
:html_pages,
:HELP
]
LeanPrototype::ALL_COLOUR_METHODS, LeanPrototype::ARRAY_KDE_KONSOLE_COLOURS_IN_USE, LeanPrototype::DAY_NAMES, LeanPrototype::NAMESPACE, LeanPrototype::SILENT_REDIRECTION
Class Method Summary
collapse
Instance Method Summary
collapse
#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, #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_information, #return_program_name_for_gobolinux_systems, #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, #run_simulation=, #run_simulation?, #sdir, #sdir_return_pwd, #set_be_silent, #set_be_verbose, #set_first_commandline_argument, #set_namespace, #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(mode_to_use = nil, run_already = true) ⇒ GatherInformation
85
86
87
88
89
90
91
92
|
# File 'lib/rbt/actions/individual_actions/information/gather_information.rb', line 85
def initialize(
mode_to_use = nil, run_already = true
)
reset
set_mode_to_use(mode_to_use)
run if run_already
end
|
Class Method Details
.[](i = ARGV) ⇒ Object
369
370
371
|
# File 'lib/rbt/actions/individual_actions/information/gather_information.rb', line 369
def self.[](i = ARGV)
new(i)
end
|
Instance Method Details
#
No need for more than one “when” clauses / entry, because this method will be invoked only after it was sanitized - see above.
#
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
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
|
# File 'lib/rbt/actions/individual_actions/information/gather_information.rb', line 148
def feedback_information(
on_these_applications = @mode_to_use
)
if on_these_applications.is_a? Array
on_these_applications = on_these_applications.join(', ')
end
unless ARRAY_ALLOWED_TASKS.include? on_these_applications
opne "Not a registered task: #{simp(on_these_applications.to_s)}"
opne
opne 'Please choose among these registered entries:'
opne
e
e ARRAY_ALLOWED_TASKS.map {|entry| ' - '+entry.to_s }
e
exit
end
unless on_these_applications == :HELP
opne simp('Reporting info on `')+
sfancy(on_these_applications.to_s)+
simp('` next.')
end
case on_these_applications when :html, :htm, :ht, :h
generate_html
when :HELP show_usage
when :all feedback_information :html
feedback_information :video
feedback_information :audio
feedback_information :games
feedback_information :html_project
when :lfs,
:lfs_page,
:html_project,
:html_pages
generate_html_project
when :video, :vid
@_.each { |program|
seek_program(program)
feedback_url if @data['tags'].to_s.include? 'vid'
}
when :audio, :aud
@_.each { |program|
seek_program(program)
feedback_url if @data['tags'].to_s.include? 'aud'
}
when :games
@_.each { |game|
seek_program(game)
feedback_url if @data['tags'].include? 'game'
}
else
end
end
|
#feedback_url(url1 = ) ⇒ Object
#
feedback_url
This gives us the url.
#
134
135
136
137
138
139
140
|
# File 'lib/rbt/actions/individual_actions/information/gather_information.rb', line 134
def feedback_url(
url1 = @data['url1']
)
unless url1.to_s.empty?
e ' '+@data['short_name'].to_s+": #{sfancy(url1)}"
end
end
|
#generate_html(i = @html_file) ⇒ Object
#
generate_html (html tag)
This method will generate a HTML file.
To generate the html section, simply do:
rinfo html
#
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
|
# File 'lib/rbt/actions/individual_actions/information/gather_information.rb', line 289
def generate_html(
i = @html_file
)
opne 'Generating a HTML file next.'
opne "#{rev}Will store into `#{sfile(i)}#{rev}`."
remove(i) if File.exist? i string_to_store =
'<html><head><title>Information about installed programs</title></head><body>'.dup
@_.each { |program|
seek_program(program)
name = @data['program_name']+N
opne " #{name.chomp}" string_to_store <<
'<div style="margin-top:5px;border: 3px dotted darkgreen;padding:0.40em">'+N
string_to_store << '<b style="font-size:1.5em;color:darkblue"> Name: '+name+CB+BR
description = @data['description']
unless description.empty?
string_to_store << "#{BR}<b style=\"background-color:violet;font-size:1.45em\"> "\
"Description: </b>#{BR}"\
"<b style=\"font-size:1.0em; padding-left:1.5em; padding-right:1.5em; margin-left:3em\">"\
"#{description}#{N}</b>"
end
string_to_store << BR+'<b style="padding-left:3em;font-size:0.95em">
URL1:</b> <a href="'+@data['url1'].to_s+'">'+
@data['url1'].to_s+'</a><br>'+BR+N
second_url = @data['url2']
if second_url
string_to_store << '<b style="padding-left:3em;font-size:0.95em">
URL2:</b> <a href="'+second_url+'">'+second_url+'</a><br>'+BR+N
end
string_to_store << '</div>'+N+'<hr>'
}
string_to_store << '</body></html>'
save_file(string_to_store, i) opne 'We did find `'+simp(@available_programs.size.to_s)+
'` registered programs.'
opne "#{rev}Finished! Stored into `#{sfile(i)}`."
end
|
#generate_html_project ⇒ Object
#
generate_html_project (html tag)
#
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
|
# File 'lib/rbt/actions/individual_actions/information/gather_information.rb', line 244
def generate_html_project @_.each_with_index { |program, index|
seek_program(program)
name = @data['program_name']
e " #{name.chomp}" where = INFO_DIR+program+'.html'
description = @data['description']
dependencies = @data['required_deps_on']
@array_all_html_pages << [
@data['short_name'], name, where, description, dependencies
]
}
@array_all_html_pages.each_with_index {|entry, index|
previous_url = '' next_url = '' previous_url = @array_all_html_pages[index-1][2] if @array_all_html_pages[index-1]
next_url = @array_all_html_pages[index+1][2] if @array_all_html_pages[index+1]
main_url = entry[2].to_s description = entry[3].to_s
dependencies = entry[4].to_s
_ = ''.dup
_ << '<html><title>'+entry.first.to_s+'</title>'+N
_ << '<body style="padding:5px; font-size:1.2em">'+N
_ << '<h1 style="text-align: center">'+entry[0]+'</h1>'+N
_ << B+'Introduction to '+entry[0]+CB+BR
_ << entry[0]+BR+B+' Dependencies'+CB+BR+B+'Required'+CB+BR+dependencies+BR
_ << HtmlTags.div { 'Description:'+BR+P+description+CP }
_ << DIV+'<a href="'+previous_url+'">'+File.basename(previous_url)+'</a>'+BR
_ << '<a href="'+next_url+'">'+File.basename(next_url)+'</a>'+BR+CDIV
_ << '</body></html>'+N
opne 'Storing into '+sfile(main_url)+'.'
save_file(_, main_url)
}
end
|
#reset ⇒ Object
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
# File 'lib/rbt/actions/individual_actions/information/gather_information.rb', line 97
def reset
super()
infer_the_namespace
@cookbook_dataset = action(:SanitizeCookbook, :do_not_run_yet) { :fast }
@_ = @available_programs = return_available_programs
@html_file = INFO_DIR+'ApplicationsFeedback.html'
@array_all_html_pages = [] end
|
#run ⇒ Object
362
363
364
|
# File 'lib/rbt/actions/individual_actions/information/gather_information.rb', line 362
def run
feedback_information
end
|
#seek_program(i) ⇒ Object
#
seek_program
This method can be used to seek to the program at hand. Since as of December 2017, we will first try to load an expanded dataset.
#
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
|
# File 'lib/rbt/actions/individual_actions/information/gather_information.rb', line 340
def seek_program(i)
begin possible_target_at_expanded_cookbooks = "#{RBT.rbt_log_directory?}expanded_cookbooks/#{i.delete('-_')}"
if File.exist? possible_target_at_expanded_cookbooks
@data = YAML.load_file(possible_target_at_expanded_cookbooks)
else
@cookbook_dataset = action(:SanitizeCookbook, i) { :fast } @data = @cookbook_dataset.return_dataset
end
rescue ArgumentError => error
opne 'An error happened, probably in the yaml file.'
opne 'The error is:'
pp error
pp error.class
opne 'The faulty program was: '+simp(i)
exit if EXIT_ON_FAULTY_COOKBOOK_DISCOVERED
end
end
|
#set_mode_to_use(i) ⇒ Object
122
123
124
125
126
127
|
# File 'lib/rbt/actions/individual_actions/information/gather_information.rb', line 122
def set_mode_to_use(i)
i = DEFAULT_MODE_TO_USE if i.nil?
i = i.first if i.is_a? Array i = i.to_sym if i.is_a? String
@mode_to_use = i
end
|
#show_usage ⇒ Object
234
235
236
237
238
239
|
# File 'lib/rbt/actions/individual_actions/information/gather_information.rb', line 234
def show_usage
opne 'This umbrella project allows you to feedback all sorts of'
opne 'useful information. You can even generate chained HTML'
opne 'pages, such as in use by the LFS project.'; print ' '
opnn; pp ARRAY_ALLOWED_TASKS
end
|