Class: RBT::Action::FilterForValidProgramNames

Inherits:
RBT::Action show all
Defined in:
lib/rbt/actions/individual_actions/filter_for_valid_program_names/filter_for_valid_program_names.rb

Overview

RBT::Action::FilterForValidProgramNames

Constant Summary

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 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(i = ARGV, run_already = true, &block) ⇒ FilterForValidProgramNames

#

initialize

#


27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/rbt/actions/individual_actions/filter_for_valid_program_names/filter_for_valid_program_names.rb', line 27

def initialize(
    i           = ARGV,
    run_already = true,
    &block
  )
  reset
  set_commandline_arguments(i)
  case run_already
  # ======================================================================= #
  # === :do_not_run_yet
  # ======================================================================= #
  when :do_not_run_yet
    run_already = false
  end
  run if run_already
end

Class Method Details

.[](i = ARGV) ⇒ Object

#

RBT::Action::FilterForValidProgramNames[]

#


137
138
139
 
# File 'lib/rbt/actions/individual_actions/filter_for_valid_program_names/filter_for_valid_program_names.rb', line 137

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

Instance Method Details

#filter_for_valid_program_names(i = first?, , dataset_containing_the_abbreviations = RBT.file_abbreviations, get_rid_of_unwanted_characters = true) ⇒ Object

#

filter_for_valid_program_names

#


55
56
57
58
59
60
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
113
114
115
116
117
118
 
# File 'lib/rbt/actions/individual_actions/filter_for_valid_program_names/filter_for_valid_program_names.rb', line 55

def filter_for_valid_program_names(
    i                                    = first?,
    dataset_containing_the_abbreviations = RBT.file_abbreviations,
    get_rid_of_unwanted_characters       = true
  )
  if i.is_a? Array
    i = i.first
  end
  i = i.dup
  i = remove_archive_from_the_end(i)
  if dataset_containing_the_abbreviations.is_a?(String) and
    File.exist?(dataset_containing_the_abbreviations)
    dataset_containing_the_abbreviations = 
      YAML.load_file(dataset_containing_the_abbreviations)
  end
  i.delete!(N) if i.include? N # Get rid of "\n".
  # ======================================================================= #
  # i.delete!('.') if i.include? '.' # Get rid of ".".
  # ^^^ The above line was deleted at 25.02.2022 because we may
  # also give "foobar-1.0.tar.xz" as input. If we then delete
  # '.' the net result is evidently incorrect.
  # ======================================================================= #
  if get_rid_of_unwanted_characters
    # ===================================================================== #
    # === Get rid of .yml, .pc and .md substrings
    # ===================================================================== #
    i.delete_suffix!('.yml') if i.end_with? '.yml'
    i.delete_suffix!('.pc')  if i.end_with? '.pc'
    i.delete_suffix!('.md')  if i.end_with? '.md'
    i.delete!(':') if i.include? ':'
    i.delete!('?') if i.include? '?'
    # ===================================================================== #
    # The next line can cause problems. I realised this in September 2022
    # when I did input "[email protected]". I would lose information, 
    # which is bad, so the next line was commented out. This comment
    # should be preserved, in case I forget this.
    # ===================================================================== #
    # i.delete!('-') if i.include? '-'
    i.chop! if i.end_with? '.'
  end
  i.strip!
  # ======================================================================= #
  # Use some exceptions for "kde1" and "mate1", which will be
  # used in the next Array:
  # ======================================================================= #
  this_array = ARRAY_SPECIAL_COMPONENT_CONTAINING_MANY_SUBCOMPONENTS
  if i.respond_to?(:start_with?) and
     i.start_with?(*this_array) and 
    (i =~ /\d{1,4}$/) and
    !is_included?(i) # ← We have to prioritize on any registered program here.
    # ===================================================================== #
    # Next we will consider passing this into a special case/when menu
    # which will replace input such as "gnome1" with the corresponding
    # entry from the Array containing all gnome programs.
    # ===================================================================== #
    i = try_to_return_a_special_compile_component("--#{i}")
  else
    if !is_included?(i) and dataset_containing_the_abbreviations.has_key?(i)
      i = dataset_containing_the_abbreviations[i]
    end
  end
  @result = i
  return i
end

#reset ⇒ Object

#

reset (reset tag)

#


47
48
49
50
 
# File 'lib/rbt/actions/individual_actions/filter_for_valid_program_names/filter_for_valid_program_names.rb', line 47

def reset
  super()
  infer_the_namespace
end

#result? ⇒ Boolean

#

result?

#

Returns:

  • (Boolean) 


130
131
132
 
# File 'lib/rbt/actions/individual_actions/filter_for_valid_program_names/filter_for_valid_program_names.rb', line 130

def result?
  @result
end

#run ⇒ Object

#

run (run tag)

#


123
124
125
 
# File 'lib/rbt/actions/individual_actions/filter_for_valid_program_names/filter_for_valid_program_names.rb', line 123

def run
  filter_for_valid_program_names(first?)
end