Class: RBT::ChangePrefix

Inherits:
Base show all
Defined in:
lib/rbt/utility_scripts/change_prefix.rb

Overview

RBT::ChangePrefix

Constant Summary collapse

REGEX_FOR_UPPCASE_PREFIX =
#

REGEX_FOR_UPPCASE_PREFIX

#
/^(PREFIX\s*\??=) ?(.+)/i

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 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

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_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) ⇒ ChangePrefix

#

initialize

#


47
48
49
50
51
52
53
54
55
56
 
# File 'lib/rbt/utility_scripts/change_prefix.rb', line 47

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::ChangePrefix[]

#


383
384
385
386
387
 
# File 'lib/rbt/utility_scripts/change_prefix.rb', line 383

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

Instance Method Details

#contine_with_this_regex_on_that_dataset(use_this_regex, dataset_as_string) ⇒ Object

#

contine_with_this_regex_on_that_dataset

#


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
 
# File 'lib/rbt/utility_scripts/change_prefix.rb', line 290

def contine_with_this_regex_on_that_dataset(
    use_this_regex,
    dataset_as_string
  )
  main_file = main_file?
  if dataset_as_string =~ use_this_regex
    # ===================================================================== #
    # First inform the user that we have, indeed, found a match.
    # ===================================================================== #
    notify_the_user_that_a_match_was_found_in_this_file_using_that_pattern(
      main_file, use_this_regex
    )
    result = ''.dup
    dataset_as_string.split("\n").each {|line|
      if line =~ use_this_regex
        use_that_for_the_inner_regex = /(prefix\s*\??=\s*)(.+)/ # See: https://rubular.com/r/SKxjzFXhjMctH4
        if line.start_with?('prefix ') and !@we_have_already_modified_the_makefile
          # ============================================================= #
          # Then use the downcased variant.
          # ============================================================= #
          line =~ use_that_for_the_inner_regex
          line = $1.to_s.dup+@use_this_as_the_new_prefix.to_s
          @we_have_already_modified_the_makefile = true
        elsif line.start_with?('PREFIX') and !@we_have_already_modified_the_makefile
          line =~ use_that_for_the_inner_regex
          line = $1.to_s.dup+@use_this_as_the_new_prefix.to_s
          @we_have_already_modified_the_makefile = true
        else
          # ============================================================= #
          # Else do nothing for now.
          # ============================================================= #
        end
        unless @we_have_already_modified_the_makefile
          opne "The new line will be: #{lightgreen(line)}"
        end
      end
      result << "#{line.rstrip}\n"
    }
    opne "Storing into the file `#{sfile(main_file)}`."
    write_what_into(result, main_file)
  else
    opne 'The pattern '+sfile(use_this_regex.to_s)+' was not found.'
  end
end

#do_work_on_this_file(i) ⇒ Object

#

do_work_on_this_file

#


338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/rbt/utility_scripts/change_prefix.rb', line 338

def do_work_on_this_file(i)
  if i and File.exist?(i)
    dataset = default_readlines(i)
    # ===================================================================== #
    # Next we must determine which regex-pattern to use.
    #
    # In order to determine this, we run a simple .include?() check
    # first.
    # ===================================================================== #
    dataset_as_string = dataset.join
    if dataset_as_string.include?('prefix ')
      use_this_regex = regex1
      contine_with_this_regex_on_that_dataset(use_this_regex, dataset_as_string)
    elsif dataset_as_string.include?('PREFIX ')
      use_this_regex = regex2
      contine_with_this_regex_on_that_dataset(use_this_regex, dataset_as_string)
    else
      opne 'Neither the pattern for '+sfancy('prefix')+' nor for the pattern'
      opne sfancy('PREFIX')+' could be found in the file at `'+sfile(i)+'`.'
    end
  else
    opnn; no_file_exists_at(i)
  end
end

#lowercase_prefix_pattern? ⇒ Boolean Also known as: pattern?, regex1

#

lowercase_prefix_pattern? (regex1 tag)

This method will return the main regex, as-is, but with PREFIX being downcased to prefix.

#

Returns:

  • (Boolean) 


275
276
277
 
# File 'lib/rbt/utility_scripts/change_prefix.rb', line 275

def lowercase_prefix_pattern?
  return /^(prefix\s*\??=) ?(.+)/i
end

#menu(i = commandline_arguments? ) ⇒ Object

#

menu (menu tag)

#


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
 
# File 'lib/rbt/utility_scripts/change_prefix.rb', line 152

def menu(
    i = commandline_arguments?
  )
  if i.is_a? Array
    i.each {|entry| menu(entry) }
  else
    case i
    # ===================================================================== #
    # === change_prefix --use-the-working-directory-as-input
    # ===================================================================== #
    when /^-?-?use(_|-)?the(_|-)?working(_|-)?directory(_|-)?as(_|-)?input$/i
      _ = File.basename(return_pwd)
      program_name    = ProgramInformation.return_program_name(_)
      program_version = ProgramInformation.return_program_version(_)
      new_prefix = programs_dir?+
                   program_name.capitalize+'/'+
                   program_version+'/'
      set_use_this_as_the_new_prefix(new_prefix)
      # =================================================================== #
      # Must also designate a new Makefile.
      # =================================================================== #
      set_modify_this_file(return_pwd+'Makefile')
    # ===================================================================== #
    # === change_prefix --help
    # ===================================================================== #
    when /^-?-?help$/i,
         /^-?-?show(_|-)?help$/i
      show_help
    else
      if i.is_a?(String) and File.exist?(i)
        # ================================================================= #
        # Use this existing file in that case.
        # ================================================================= #
        set_main_file(i)
      else
        # ================================================================= #
        # Try to find a Makefile in the current location.
        # ================================================================= #
        if File.exist?('Makefile') and !File.exist?(@modify_this_file)
          set_main_file(
            File.absolute_path(return_pwd)+'Makefile'
          )
        end
      end
    end
  end
end

#modify_this_file? ⇒ Boolean Also known as: modify_which_file?, of_this_makefile, main_file?

#

modify_this_file?

#

Returns:

  • (Boolean) 


134
135
136
 
# File 'lib/rbt/utility_scripts/change_prefix.rb', line 134

def modify_this_file?
  @modify_this_file
end

#notify_the_user_that_a_match_was_found_in_this_file_using_that_pattern(_, pattern) ⇒ Object

#

notify_the_user_that_a_match_was_found_in_this_file_using_that_pattern

#


261
262
263
264
265
266
267
 
# File 'lib/rbt/utility_scripts/change_prefix.rb', line 261

def notify_the_user_that_a_match_was_found_in_this_file_using_that_pattern(
    _,
    pattern
  )
  opne "A match was found within the file #{sfile(_)},"
  opne "using the pattern #{steelblue(pattern)}."
end

#perform_the_modification ⇒ Object

#

perform_the_modification

This is the method that will be used to modify the Makefile at hand.

#


368
369
370
 
# File 'lib/rbt/utility_scripts/change_prefix.rb', line 368

def perform_the_modification
  do_work_on_this_file(main_file?)
end

#reset ⇒ Object

#

reset (reset tag)

#


61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
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
105
106
107
108
109
110
111
112
 
# File 'lib/rbt/utility_scripts/change_prefix.rb', line 61

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # Designate which file is to be modified next:
  # ======================================================================= #
  set_modify_this_file(:default_file)
  # ======================================================================= #
  # === @we_have_already_modified_the_makefile
  # ======================================================================= #
  @we_have_already_modified_the_makefile = false
  # ======================================================================= #
  # === @search_for_this_pattern
  #
  # Designate which pattern we are trying to find in that file.
  #
  # Unfortunately there does not seem to be a general consensus in
  # what is allowed and what is not in a given Makefile. For example,
  # the program called 'mxk-1.10' makes use of exactly this line
  # "prefix  = /usr/local", whereas the program called 'libcli-1.9.8-4'
  # makes use of exactly this line "PREFIX = /usr/local". Thus, we
  # will have to check for these variants, which is why we will
  # ask rubular for help here.
  #
  # In June 2023 I discovered a Makefile that contains this dual-prefix:
  #
  #   prefix      ?= /usr/local
  #   PREFIX      ?= $(prefix)
  #
  # So it seems as if we also have to match against the "?" part there.
  #
  # See:
  #
  #   https://rubular.com/r/jUCLVDCCVRqZb4
  #
  # ======================================================================= #
  @search_for_this_pattern =
    REGEX_FOR_UPPCASE_PREFIX
  # ======================================================================= #
  # Infer the name and program version from return_pwd, via
  # ProgramInformation.
  # ======================================================================= #
  program_information = ProgramInformation.new(return_pwd)
  version = program_information.version?
  name    = program_information.program_name?
  @use_this_as_the_new_prefix = 
    rds(
      programs_dir?+
      name.capitalize+'/'+
      version+'/'
    )
end

#run ⇒ Object

#

run (run tag)

#


375
376
377
378
 
# File 'lib/rbt/utility_scripts/change_prefix.rb', line 375

def run
  menu
  perform_the_modification
end

#set_commandline_arguments(i = '') ⇒ Object

#

set_input

#


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
 
# File 'lib/rbt/utility_scripts/change_prefix.rb', line 203

def set_commandline_arguments(i = '')
  if i.is_a? Hash
    # ===================================================================== #
    # If a Hash is given then we will modify this Hash a bit before
    # continuing here.
    # ===================================================================== #
    if i.has_key? :use_this_makefile
      set_modify_this_file(
        i.delete(:use_this_makefile)
      )
    end
    # ===================================================================== #
    # Query for another prefix that is to be used next:
    # ===================================================================== #
    if i.has_key? :use_this_as_the_new_prefix
      new_value = i.delete(:use_this_as_the_new_prefix)
      set_use_this_as_the_new_prefix(new_value)
    end
  end
  i = [i].flatten.compact
  if i.empty?
    # ===================================================================== #
    # In that case we will attempt to use a Makefile in the current
    # directory.
    # ===================================================================== #
    i << 'Makefile'
  end
  @internal_hash[:commandline_arguments] = i
end

#set_modify_this_file(i = :default) ⇒ Object Also known as: set_main_file

#

set_modify_this_file

This method can be used to designate where the target “Makefile” is exactly.

Do note that set_main_file() is an alias to this method here.

#


241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/rbt/utility_scripts/change_prefix.rb', line 241

def set_modify_this_file(i = :default)
  case i
  # ======================================================================= #
  # === :default
  # ======================================================================= #
  when :default,
       :default_file
    i = '/Depot/jjj/libcli-1.9.8-4/Makefile' 
  end
  i = i.dup if i.frozen?
  unless i.include? '/'
    i = File.absolute_path(i)
  end
  i = rds(i)
  @modify_this_file = i
end

#set_use_this_as_the_new_prefix(i) ⇒ Object

#

set_use_this_as_the_new_prefix

This method can be used to designate another prefix that is to be used - the one that will be written into the “Makefile”.

#


120
121
122
 
# File 'lib/rbt/utility_scripts/change_prefix.rb', line 120

def set_use_this_as_the_new_prefix(i)
  @use_this_as_the_new_prefix = i
end

#show_help ⇒ Object

#

show_help (help tag)

#


143
144
145
146
147
 
# File 'lib/rbt/utility_scripts/change_prefix.rb', line 143

def show_help
  e
  e 'Presently this class has no help option documented.'
  e
end

#uppercase_prefix_pattern? ⇒ Boolean Also known as: regex2

#

uppercase_prefix_pattern? (regex2 tag)

#

Returns:

  • (Boolean) 


283
284
285
 
# File 'lib/rbt/utility_scripts/change_prefix.rb', line 283

def uppercase_prefix_pattern?
  REGEX_FOR_UPPCASE_PREFIX
end

#use_this_as_the_new_prefix? ⇒ Boolean Also known as: use_this_prefix?

#

use_this_as_the_new_prefix?

#

Returns:

  • (Boolean) 


127
128
129
 
# File 'lib/rbt/utility_scripts/change_prefix.rb', line 127

def use_this_as_the_new_prefix?
  @use_this_as_the_new_prefix
end