Class: RBT::Action::SoftwareManager

Inherits:
RBT::Action show all
Includes:
CompileBaseModule
Defined in:
lib/rbt/actions/individual_actions/software_manager/software_manager.rb

Overview

RBT::Action::SoftwareManager

Constant Summary

Constants included from CompileBaseModule

CompileBaseModule::FILE_AUTOGEN

Constants inherited from LeanPrototype

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

Methods included from CompileBaseModule

#always_show_dependencies?, #capitalize_program_names?, #cflags?, #check_whether_we_will_install_only_programs_from_the_bin_subdirectory, #cleanup_system_tag_directory, #config?, #consider_removing_libtool_la_files, #consider_symlinking_cmake_modules, #consider_symlinking_header_files_into_the_usr_include_hierarchy, #consider_symlinking_lib64_into_lib, #cookbook_dataset_autosymlink_lib64?, #cookbook_dataset_program_version?, #create_a_new_current_symlink_here, #create_architecture_file, #do_invoke_symlink_program, #do_play_song, #editor_to_use?, #email?, #exit_on_unregistered_cookbook_entries?, #has_an_error_occurred?, #host_cpu?, #install_only_binaries?, #installer_constant?, make_command?, #no_error_has_occurred?, #play_song?, #recipes_dir?, #register_program, #remove_compiling_is_in_progress, #report_to_developers, #reset_the_module, #return_build_type, #return_chained_programs, #return_files_from_the_profiles_directory, #return_these_programs, #run_ldconfig?, #shall_we_symlink_the_header_files_into_the_usr_include_hierarchy?, #store_full_configure_command_into_resources_directory, #symlink_into_tags, #symlink_into_usr_lib_dir?, #symlink_m4_macros, #symlink_program, #symlink_program?, #update_kde_apps, #use_ccache?, #use_gobolinux_symlinkprogram?, #use_mrxvt?, #use_porg?, #use_stow?, #use_tags?, #uses_appdir_prefix?, #validate_the_cookbook_aliases

Methods inherited from LeanPrototype

#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_options, #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_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_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_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(commandline_arguments = nil, run_already = true) ⇒ SoftwareManager

#

initialize

#


33
34
35
36
37
38
39
40
41
42
# File 'lib/rbt/actions/individual_actions/software_manager/software_manager.rb', line 33

def initialize(
    commandline_arguments = nil,
    run_already           = true
  )
  reset
  set_commandline_arguments(
    commandline_arguments
  )
  run if run_already
end

Class Method Details

.[](i = ARGV) ⇒ Object

#

RBT::Action::SoftwareManager[]

#


348
349
350
# File 'lib/rbt/actions/individual_actions/software_manager/software_manager.rb', line 348

def self.[](i = ARGV)
  new(i)
end

Instance Method Details

#appdir_prefix_points_at?Boolean

#

appdir_prefix_points_at?

#

Returns:

  • (Boolean)


255
256
257
# File 'lib/rbt/actions/individual_actions/software_manager/software_manager.rb', line 255

def appdir_prefix_points_at?
  real_prefix?.prefix?
end

#clear_the_original_cookbook_datasetObject

#

clear_the_original_cookbook_dataset

#


127
128
129
# File 'lib/rbt/actions/individual_actions/software_manager/software_manager.rb', line 127

def clear_the_original_cookbook_dataset
  set_cookbook_dataset(nil)
end

#compile_these_programs?Boolean

#

compile_these_programs?

#

Returns:

  • (Boolean)


112
113
114
# File 'lib/rbt/actions/individual_actions/software_manager/software_manager.rb', line 112

def compile_these_programs?
  @internal_hash[:compile_these_programs]
end

#configure_options?Boolean

#

configure_options?

#

Returns:

  • (Boolean)


288
289
290
# File 'lib/rbt/actions/individual_actions/software_manager/software_manager.rb', line 288

def configure_options?
  cookbook_dataset?.configure_options?
end

#cookbook_dataset?Boolean

#

cookbook_dataset?

#

Returns:

  • (Boolean)


95
96
97
# File 'lib/rbt/actions/individual_actions/software_manager/software_manager.rb', line 95

def cookbook_dataset?
  @internal_hash[:cookbook_dataset]
end

#cookbook_program_name_and_program_version?Boolean Also known as: program_name_and_program_version?

#

cookbook_program_name_and_program_version?

#

Returns:

  • (Boolean)


201
202
203
# File 'lib/rbt/actions/individual_actions/software_manager/software_manager.rb', line 201

def cookbook_program_name_and_program_version?
  cookbook_dataset?.program_name_and_program_version?
end

#determine_the_real_commandline_arguments(i) ⇒ Object

#

determine_the_real_commandline_arguments

#


313
314
315
316
317
318
# File 'lib/rbt/actions/individual_actions/software_manager/software_manager.rb', line 313

def determine_the_real_commandline_arguments(i)
  i = [i].flatten.compact
  @internal_hash[:real_commandline_arguments] = i.select {|entry|
    entry.start_with?('--')
  }
end

#do_compile_this_registered_program(i) ⇒ Object

#

do_compile_this_registered_program

#


134
135
136
137
138
139
140
141
142
143
144
145
146
147
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
# File 'lib/rbt/actions/individual_actions/software_manager/software_manager.rb', line 134

def do_compile_this_registered_program(i)
  clear_the_original_cookbook_dataset
  orev 'We will extract the program called '+steelblue(i)+
        rev+' next.'
  orev 'The local path to be assumed is:'
  initialize_cookbook_dataset_for(i)
  menu(real_commandline_arguments?)
  local_path = cookbook_dataset?.local_path?
  e
  e "  #{steelblue(local_path)}"
  e
  # ======================================================================= #
  # Must check whether this file also exists next:
  # ======================================================================= #
  if File.exist? local_path
    orev 'Extracting the archive at `'+sfile(local_path)+rev+
         '` next.'
    to = rbt_log_dir?+
         File.basename(
           remove_suffix_from_the_end(
             local_path
           )
         )+
         '/'
    orev 'The extracted directory should be located at'
    orev '`'+sfile(to)+"#{rev}`,"
    orev 'if everything will be alright.'
    action(:extract_what_to, local_path, extract_to: to) { :be_quiet }
    orev 'The extraction-step has finished now.'
    if File.directory? to
      orev "Entering the directory at #{sdir(to)}#{rev} next."
      cd(to)
      run_the_equivalent_configure_like_stage_for_this_program(i)
    else
      orev 'No directory was found at `'+sdir(to)+rev+'`.'
    end
  else
    opnn; no_file_exists_at(local_path)
  end
end

#do_handle_the_post_installation_stepsObject

#

do_handle_the_post_installation_steps

#


262
263
264
265
266
267
268
269
270
271
# File 'lib/rbt/actions/individual_actions/software_manager/software_manager.rb', line 262

def do_handle_the_post_installation_steps
  if appdir_prefix?
    _ = appdir_prefix_points_at?
    orev "Trying to update or create the #{steelblue('Current')}"\
         "#{rev} symlink next."
    action(:ToCurrent, _)
    orev 'Trying to symlink various entries from '+steelblue(_)+rev+' next.'
    action(:symlink_from_to_current, _)
  end
end

#initialize_cookbook_dataset_for(i) ⇒ Object

#

initialize_cookbook_dataset_for

#


119
120
121
122
# File 'lib/rbt/actions/individual_actions/software_manager/software_manager.rb', line 119

def initialize_cookbook_dataset_for(i)
  cookbook_dataset = action(:cookbook_dataset, i)
  set_cookbook_dataset(cookbook_dataset)
end
#

menu (menu tag)

#


178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
# File 'lib/rbt/actions/individual_actions/software_manager/software_manager.rb', line 178

def menu(
    i = real_commandline_arguments?
  )
  if i.is_a? Array
    i.each {|entry| menu(entry) }
  else
    case i # case tag
    # =================================================================== #
    # === SM htop --ntrad
    # =================================================================== #
    when /^-?-?ntrad/
      _ = real_prefix?.do_use_appdir_prefix_from_this_input(
            program_name_and_program_version?
          )
      @internal_hash[:shall_we_use_an_appdir_prefix] = true
      real_prefix?.set_use_this_prefix(_)
    end
  end
end

#prefix_object?Boolean Also known as: real_prefix?

#

prefix_object?

#

Returns:

  • (Boolean)


81
82
83
# File 'lib/rbt/actions/individual_actions/software_manager/software_manager.rb', line 81

def prefix_object?
  @internal_hash[:prefix_object]
end

#real_commandline_arguments?Boolean

#

real_commandline_arguments?

#

Returns:

  • (Boolean)


323
324
325
# File 'lib/rbt/actions/individual_actions/software_manager/software_manager.rb', line 323

def real_commandline_arguments?
  @internal_hash[:real_commandline_arguments]
end

#resetObject

#

reset (reset tag)

#


47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# File 'lib/rbt/actions/individual_actions/software_manager/software_manager.rb', line 47

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === :cookbook_dataset
  # ======================================================================= #
  @internal_hash[:cookbook_dataset] = nil
  # ======================================================================= #
  # === :compile_these_programs
  # ======================================================================= #
  @internal_hash[:compile_these_programs] = []
  # ======================================================================= #
  # === :shall_we_use_an_appdir_prefix
  #
  # This variable must be set to true if we make use of an AppDir
  # prefix.
  # ======================================================================= #
  @internal_hash[:shall_we_use_an_appdir_prefix] = false
  # ======================================================================= #
  # === :prefix_object
  # ======================================================================= #
  @internal_hash[:prefix_object] = action(:prefix, :default_prefix)
end

#runObject

#

run (run tag)

#


330
331
332
333
334
335
336
337
338
339
340
341
342
343
# File 'lib/rbt/actions/individual_actions/software_manager/software_manager.rb', line 330

def run
  _ = first?
  determine_the_real_commandline_arguments(
    commandline_arguments?[1 .. -1]
  )
  if _ and !_.empty?
    set_compile_these_programs(_)
    compile_these_programs?.each {|this_program|
      try_to_install_this_program(this_program)
    }
  else
    orev 'Please supply an argument to this action.'
  end
end

#run_makeObject

#

run_make (make tag)

#


295
296
297
298
299
# File 'lib/rbt/actions/individual_actions/software_manager/software_manager.rb', line 295

def run_make
  e
  _ = 'make'
  colourized_and_padded_esystem(_)
end

#run_make_installObject

#

run_make_install (make install tag)

#


304
305
306
307
308
# File 'lib/rbt/actions/individual_actions/software_manager/software_manager.rb', line 304

def run_make_install
  _ = 'make install'
  colourized_and_padded_esystem(_)
  e
end

#run_the_equivalent_configure_like_stage_for_this_program(i) ⇒ Object

#

run_the_equivalent_configure_like_stage_for_this_program

#


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
# File 'lib/rbt/actions/individual_actions/software_manager/software_manager.rb', line 224

def run_the_equivalent_configure_like_stage_for_this_program(i)
  orev 'The '+lightgreen('configure-like stage')+
       rev+' for '+steelblue(i)+rev+' will be run next.'
  # ======================================================================= #
  # Here we have to do a decision: either we make use of the
  # use_this_build_system specified value, or we have to infer the
  # build system. Either way we begin this by quering the
  # use_this_build_system value.
  # ======================================================================= #
  use_this_build_system = cookbook_dataset?.use_this_build_system?
  use_this_build_system = use_this_build_system.to_sym
  case use_this_build_system
  # ======================================================================= #
  # === :configure
  # ======================================================================= #
  when :configure
    run_traditional_GNU_configure
    run_make
    run_make_install
  else
    orev 'Not registered build-system type: '+
          steelblue(use_this_build_system.to_sym)
    orev 'No way to proceed, thus stopping now.'
    return
  end
  do_handle_the_post_installation_steps
end

#run_traditional_GNU_configureObject

#

run_traditional_GNU_configure

#


276
277
278
279
280
281
282
283
# File 'lib/rbt/actions/individual_actions/software_manager/software_manager.rb', line 276

def run_traditional_GNU_configure
  _ = './configure --prefix='+prefix_object?.prefix?.dup
  configure_options = configure_options?
  if configure_options and !configure_options.empty?
    _ << " #{configure_options}"
  end
  colourized_and_padded_esystem(_)
end

#set_compile_these_programs(i) ⇒ Object

#

set_compile_these_programs

This variant will always be an Array.

#


104
105
106
107
# File 'lib/rbt/actions/individual_actions/software_manager/software_manager.rb', line 104

def set_compile_these_programs(i)
  @internal_hash[:compile_these_programs] << [i].flatten.compact
  @internal_hash[:compile_these_programs].flatten!
end

#set_cookbook_dataset(i) ⇒ Object

#

set_cookbook_dataset

#


88
89
90
# File 'lib/rbt/actions/individual_actions/software_manager/software_manager.rb', line 88

def set_cookbook_dataset(i)
  @internal_hash[:cookbook_dataset] = i
end

#shall_we_use_an_appdir_prefix?Boolean Also known as: appdir_prefix?

#

shall_we_use_an_appdir_prefix?

#

Returns:

  • (Boolean)


74
75
76
# File 'lib/rbt/actions/individual_actions/software_manager/software_manager.rb', line 74

def shall_we_use_an_appdir_prefix?
  @internal_hash[:shall_we_use_an_appdir_prefix]
end

#try_to_install_this_program(i) ⇒ Object

#

try_to_install_this_program

#


208
209
210
211
212
213
214
215
216
217
218
219
# File 'lib/rbt/actions/individual_actions/software_manager/software_manager.rb', line 208

def try_to_install_this_program(i)
  orev 'Trying to install '+steelblue(i)+rev+' next.'
  # ===================================================================== #
  # === Check whether the given input is a registered program
  # ===================================================================== #
  if is_this_program_part_of_the_RBT_project?(i)
    do_compile_this_registered_program(i)
  else
    orev 'Unfortunately the program '+steelblue(i)+rev+' is '\
         'not registered as part of the RBT project.'
  end
end