Class: RBT::GenerateShellscript
- Inherits:
-
Base
show all
- Defined in:
- lib/rbt/generate_files/generate_shellscript.rb
Overview
Constant Summary
collapse
- DEFAULT_PROGRAM =
'htop'
'/home/x/programming/ruby/src/roebe/lib/roebe/shell_scripts/extract_archive.sh'
LeanPrototype::ALL_COLOUR_METHODS, LeanPrototype::ARRAY_KDE_KONSOLE_COLOURS_IN_USE, LeanPrototype::DAY_NAMES, LeanPrototype::NAMESPACE, LeanPrototype::SILENT_REDIRECTION
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, #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(sdata = nil, save_into_file = true, display_result = true, append_source_file = true) ⇒ GenerateShellscript
#
initialize
The first argument, ‘sdata`, should be the whole dataset of the program we wish to create a shell script for. But you can also pass in a program name instead.
The second argument, sdata, passes in the datastructure associated with that very program. It can be omitted however, in which case we will load the data on our own.
Only the first argument is mandatory - the other arguments are not mandatory.
#
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
# File 'lib/rbt/generate_files/generate_shellscript.rb', line 52
def initialize(
sdata = nil,
save_into_file = true,
display_result = true,
append_source_file = true
)
reset
set_data(sdata) set_save_into_file(save_into_file)
set_append_source_file(append_source_file)
set_display_result(display_result)
if block_given?
_ = yield
if _.is_a? Hash
if _.has_key? :also_run_at_once
set_also_run_at_once _.delete(:also_run_at_once)
end
end
end
run
end
|
Instance Method Details
#_(i) ⇒ Object
415
416
417
|
# File 'lib/rbt/generate_files/generate_shellscript.rb', line 415
def _(i)
@_ << i
end
|
#dataset? ⇒ Boolean
445
446
447
|
# File 'lib/rbt/generate_files/generate_shellscript.rb', line 445
def dataset?
@cookbook_dataset
end
|
#empty_main_string ⇒ Object
388
389
390
|
# File 'lib/rbt/generate_files/generate_shellscript.rb', line 388
def empty_main_string @_ = ''.dup
end
|
#generate_main_string(also_run_at_once = @also_run_at_once) ⇒ Object
#
generate_main_string
This method will generate the shell-string that will be saved and then used.
#
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
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
|
# File 'lib/rbt/generate_files/generate_shellscript.rb', line 161
def generate_main_string(
also_run_at_once = @also_run_at_once
)
url = url1? empty_main_string program_version = program_version?
use_this_subdirectory = "#{rbt_log_dir?}shell_scripts/"
mkdir(use_this_subdirectory)
location_where_to_store_the_shell_file = use_this_subdirectory+
@program.to_s+'-'+
program_version+'.sh'
if @append_source_file
_ 'if [ ! -f "$file" ]'+N
_ 'then'+N
_ ' source $LINUX/SHELL/SCRIPTS/roeberia.sh'+N
_ "fi#{N}#{N}"
end
_
_ '# === '+@program+N
_ '#'+N
_ '# This will attempt to download and install the program '+N
_ '# called `'+@program+'`.'+N
_ '#'+N
_ '# The location of the shell script will be at '+N
_ '#'+N
_ '# '+location_where_to_store_the_shell_file+N
_ '#'+N
_ '# This program has the following description:'+N
description = dataset?.desc?
description.split(N).each {|line|
_ '# '+line+N
} if description.is_a? Array
_
function_name = 'compile_'+@program
_ 'function '+function_name.to_s+'() {'+N
program_name = program_name?
_ " application_name='"+program_name.to_s+"'"+N
_ ' type="'+dataset?.archive_type?.to_s+'"'+N
base_dir = ''.dup
unless dataset?.base_dir?.empty?
base_dir << dataset?.base_dir?
end
source_location = base_dir+'${application_name}${type}'
_ ' source '+PATH_TO_THE_FILE_EXTRACT_ARCHIVE+N+N
_ ' echo "The remote URL can be found at:'+N+N
_ ' '+url?.to_s+'"'+N+N
_ N
_ ' sleep 0.1'+N
_ N
_ ' file='+source_location+N+N
_ ' echo "The file should be at the location:"'+N+N
_ ' echo " $file"'+N+N+N
_ ' if [ -f $file ]'+N
_ ' then'+N
_ ' echo "$file exists! Thus we can continue."'+N
_ ' else'+N
_ ' echo "$file does not exist."'+N
_ ' echo "We will thus download it now."'+N
src_dir = source_directory?
_ ' cd '+src_dir+N
target_dir = src_dir+'${'+program_name+'^^*}' _ ' mkdir '+target_dir+N
_ ' cd '+target_dir+N
_ ' wget '+url.to_s+N
_ ' fi'+N+N
_ ' echo "We will now extract the package into '+temp_dir?+':"'+N+N
_ ' sleep 0.3'+N
_ ' extract_archive '+source_location+N
_ ' echo "Now entering the directory \`'+temp_dir?+'$application_name\`".'+N
_ ' cd '+temp_dir?+'$application_name '+N
_ ' pwd'+N
if dataset?.make_options?
unless dataset?.make_options?.empty?
_ ' '+dataset?.make_options?.join(', ').strip+N
end
end
if dataset?.prefix? == true
_ ' doit'+N
else this_configure_line = ' ./configure --prefix=/'+programs_dir?
if @data
short_name = short_name?.to_s.capitalize
this_configure_line << short_name.to_s
this_configure_line << '/'
this_configure_line << program_version?
this_configure_line << ' '+dataset?.configure_options?+N
this_configure_line << ' make'+N
this_configure_line << ' make install'+N
end
_ ' echo "Running these commands next: `'+
rds(this_configure_line).strip+'`"'+N
_ N
_ rds(this_configure_line)
end
_ N
if ! url.to_s.empty?
_ ' echo -e "\nIn case you missed it, here is the URL to \`'+
program_name.to_s+'\`"'+N
_ ' echo -e "again: "'+N+N
_ ' echo " '+url.to_s+'"'+N+N
end
_ ' echo "Let us see whether we shall keep the source package"'+N
_ ' echo "extracted for the program '+program?+' or not, next:"'+N+N
= dataset?.
case .to_s
when 'true','t'
_ ' keep_extracted="true"'+N
else
_ ' keep_extracted="false"'+N
end
_ ' if [ "$keep_extracted" = "true" ]'+N
_ ' then'+N
_ ' echo " Yes, we keep the archive extracted."'+N
_ ' else'+N
_ ' echo "Not keeping the archive. Removing it now:"'+N
_ ' echo rm -rf '+temp_dir?+'$application_name'+N
_ ' rm -rf '+temp_dir?+'$application_name'+N
_ ' fi'+N
_ '}'+N
_
_ '# Next we wil add some aliases to the function:'+N
_
_ "alias 'c"+@program+"'=\"compile_"+@program+"\""+N
_ "alias 'c_"+@program+"'=\"compile_"+@program+"\""+N _ N if also_run_at_once
_ '# '+('='* 76)+' #'+N
_ '# We also compile at once.'+N
_ '# '+('='* 76)+' #'+N
_ function_name+N
end
if @save_into_file
saving_into(location_where_to_store_the_shell_file)
if File.exist?(location_where_to_store_the_shell_file)
remove_file(location_where_to_store_the_shell_file)
end
save_file(@_, location_where_to_store_the_shell_file)
end
if @display_result
opne 'Also displaying its content next, for convenience.'
cliner
e N+@_ end
saved_into(location_where_to_store_the_shell_file) return @_ end
|
151
152
153
|
# File 'lib/rbt/generate_files/generate_shellscript.rb', line 151
def
'# '+('=' * 75)+' #'+N
end
|
#program? ⇒ Boolean
438
439
440
|
# File 'lib/rbt/generate_files/generate_shellscript.rb', line 438
def program?
@program
end
|
#program_name? ⇒ Boolean
144
145
146
|
# File 'lib/rbt/generate_files/generate_shellscript.rb', line 144
def program_name?
dataset?.program_name?.to_s
end
|
#program_version? ⇒ Boolean
130
131
132
|
# File 'lib/rbt/generate_files/generate_shellscript.rb', line 130
def program_version?
dataset?.program_version?.to_s
end
|
#report_task ⇒ Object
430
431
432
433
|
# File 'lib/rbt/generate_files/generate_shellscript.rb', line 430
def report_task
opne 'Generating a shell script now for the '+
'program `'+sfancy(@program)+'`.'
end
|
#reset ⇒ Object
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
# File 'lib/rbt/generate_files/generate_shellscript.rb', line 80
def reset
super()
infer_the_namespace
@program = nil
@data = nil
@save_into_file = nil
@display_result = nil
@also_run_at_once = true
empty_main_string
end
|
#run ⇒ Object
485
486
487
488
|
# File 'lib/rbt/generate_files/generate_shellscript.rb', line 485
def run
report_task
generate_main_string
end
|
#saved_into(file) ⇒ Object
#
saved_into
This method will inform the user where the file has been saved.
#
454
455
456
457
458
|
# File 'lib/rbt/generate_files/generate_shellscript.rb', line 454
def saved_into(file)
cliner {
opne "The file was saved into: #{sfile(file)}"
}
end
|
#saving_into(file) ⇒ Object
406
407
408
409
410
|
# File 'lib/rbt/generate_files/generate_shellscript.rb', line 406
def saving_into(file)
cliner {
opne "Saving into #{sfile(file)}"
}
end
|
#set_also_run_at_once(i = true) ⇒ Object
109
110
111
|
# File 'lib/rbt/generate_files/generate_shellscript.rb', line 109
def set_also_run_at_once(i = true)
@also_run_at_once = i
end
|
#set_append_source_file(i) ⇒ Object
#
set_append_source_file
#
116
117
118
|
# File 'lib/rbt/generate_files/generate_shellscript.rb', line 116
def set_append_source_file(i)
@append_source_file = i
end
|
#set_data(i = program?)
) ⇒ Object
#
set_data
Since at least June 2014 we store @data as symbols.
#
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
|
# File 'lib/rbt/generate_files/generate_shellscript.rb', line 465
def set_data(i = program?)
if i.nil? @cookbook_dataset = action(:SanitizeCookbook) { :do_not_run_yet }
@cookbook_dataset.find @program
elsif i.is_a? String
@cookbook_dataset = action(:SanitizeCookbook, i)
elsif i.is_a? RBT::Action::Cookbooks::SanitizeCookbook
@cookbook_dataset = i
else e swarn('Error!'); pp i; exit
end
new_name = @cookbook_dataset.short_name?
set_program(new_name) @data = @cookbook_dataset
end
|
#set_display_result(i) ⇒ Object
377
378
379
380
381
382
383
|
# File 'lib/rbt/generate_files/generate_shellscript.rb', line 377
def set_display_result(i)
case i
when :display_result
i = true
end
@display_result = i
end
|
#set_program(i = DEFAULT_PROGRAM) ⇒ Object
369
370
371
372
|
# File 'lib/rbt/generate_files/generate_shellscript.rb', line 369
def set_program(i = DEFAULT_PROGRAM) i = i.to_s.downcase
@program = i
end
|
#set_save_into_file(i = true) ⇒ Object
395
396
397
398
399
400
401
|
# File 'lib/rbt/generate_files/generate_shellscript.rb', line 395
def set_save_into_file(i = true) case i
when :save_into_file
i = true
end
@save_into_file = i
end
|
#short_name? ⇒ Boolean
137
138
139
|
# File 'lib/rbt/generate_files/generate_shellscript.rb', line 137
def short_name?
dataset?.short_name?.to_s
end
|
#string? ⇒ Boolean
Also known as:
_?, dataset
422
423
424
|
# File 'lib/rbt/generate_files/generate_shellscript.rb', line 422
def string? @_
end
|
#url1? ⇒ Boolean
Also known as:
url?
123
124
125
|
# File 'lib/rbt/generate_files/generate_shellscript.rb', line 123
def url1?
dataset?.url1?
end
|