Class: RBT::Action::Cookbooks::ScanForBlfsPrograms

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

Overview

RBT::Action::Cookbooks::ScanForBlfsPrograms

Constant Summary collapse

OPEN_IN_EDITOR =
#

OPEN_IN_EDITOR

#
true
REMOTE_BASE_URL =
#

REMOTE_BASE_URL

#
'https://www.linuxfromscratch.org/blfs/view/svn/'
ALSO_REMOVE_NUMBERS_FROM_REMOTE_PROGRAM_NAMES =
#

ALSO_REMOVE_NUMBERS_FROM_REMOTE_PROGRAM_NAMES

If the following constant is set, then we will remove all numbers from the given input.

#
false
ALSO_GIVE_HELP_FOR_MODIFYING_THESE_ENTRIES =
#

ALSO_GIVE_HELP_FOR_MODIFYING_THESE_ENTRIES

#
true
REGEX_FOR_PROGRAMS_REGISTERED_AT_THE_REMOTE_BLFS_WEBPAGE =
#

REGEX_FOR_PROGRAMS_REGISTERED_AT_THE_REMOTE_BLFS_WEBPAGE

#
/<li class="sect1">\s+<a href=\s*?"general\/(.+)\.html">/

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

#

initialize

#


64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/rbt/actions/individual_actions/cookbooks/scan_for_blfs_programs/scan_for_blfs_programs.rb', line 64

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::Cookbooks::ScanForBlfsPrograms[]

#


218
219
220
 
# File 'lib/rbt/actions/individual_actions/cookbooks/scan_for_blfs_programs/scan_for_blfs_programs.rb', line 218

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

Instance Method Details

#iterate_over_all_programs_missing_a_blfs_entry ⇒ Object

#

iterate_over_all_programs_missing_a_blfs_entry

#


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
174
175
176
177
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/cookbooks/scan_for_blfs_programs/scan_for_blfs_programs.rb', line 147

def iterate_over_all_programs_missing_a_blfs_entry
  # ======================================================================= #
  # First, build up our Array that has the programs registered which
  # also have a remote BLFS page.
  # ======================================================================= #
  array_these_local_programs_do_not_have_a_blfs_entry = []
  @programs_missing_a_blfs_entry.each {|this_program|
    if ALSO_REMOVE_NUMBERS_FROM_REMOTE_PROGRAM_NAMES
      if this_program =~ /\d+/
        this_program = remove_all_numbers_from(this_program)
      end
    end
    if @remotely_available_programs.include? this_program
      array_these_local_programs_do_not_have_a_blfs_entry << this_program
    end
  }
  if array_these_local_programs_do_not_have_a_blfs_entry.empty?
    opne 'All remote programs have already been registered '\
         'locally. This is '+gold('good')+"#{rev}! \\o/" 
  else
    array_these_local_programs_do_not_have_a_blfs_entry.each {|this_program|
      remote_blfs_page = remote_blfs_page?
      opne 'The program `'+sfancy(this_program)+rev+
           '` is missing a blfs: entry.'
      remote_html_page = remote_blfs_page+'general/'+this_program+'.html'
      opne "#{rev}The remote BLFS page is: #{simp(remote_html_page)}"
      # =================================================================== #
      # Next, also report where it is available locally.
      # =================================================================== #
      if on_roebe?
        local_path = "#{RUBY_SRC_RBT_COOKBOOKS}#{this_program}.yml"
      else
        local_path = return_location_to_this_programs_yaml_file(this_program)
      end
      if ALSO_GIVE_HELP_FOR_MODIFYING_THESE_ENTRIES
        e
        e "#{rev}  bl #{sfile(local_path)}"
        e "  #{simp(remote_html_page)}"
        if OPEN_IN_EDITOR and is_on_roebe?
          e
          e "#{rev}Opening in the editor as well, after a "\
            "delay of 0.8 seconds."
          sleep 0.8
          open_in_editor(local_path)
        end
        e
      end
    }
  end
end

#obtain_all_programs_that_miss_a_blfs_entry ⇒ Object

#

obtain_all_programs_that_miss_a_blfs_entry

#


133
134
135
 
# File 'lib/rbt/actions/individual_actions/cookbooks/scan_for_blfs_programs/scan_for_blfs_programs.rb', line 133

def obtain_all_programs_that_miss_a_blfs_entry
  @programs_missing_a_blfs_entry = RBT.return_array_of_programs_without_a_blfs_entry
end

#obtain_dataset_from_the_remote_webpage ⇒ Object

#

obtain_dataset_from_the_remote_webpage

#


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/rbt/actions/individual_actions/cookbooks/scan_for_blfs_programs/scan_for_blfs_programs.rb', line 113

def obtain_dataset_from_the_remote_webpage
  opne "#{rev}Obtaining data from #{steelblue(REMOTE_BASE_URL)}#{rev}."
  @dataset_from_the_remote_webpage = URI.open(REMOTE_BASE_URL).read
  # ======================================================================= #
  # The remote homepage is actually in ISO format.
  # ======================================================================= #
  @dataset_from_the_remote_webpage.force_encoding('iso-8859-1')
  # ======================================================================= #
  # The next variable will contain all programs that are available
  # at the BLFS webpage.
  # ======================================================================= #
  @remotely_available_programs = @dataset_from_the_remote_webpage.scan(
    remote_regex?
  ).flatten
end

#remote_blfs_page? ⇒ Boolean

#

remote_blfs_page?

#

Returns:

  • (Boolean) 


99
100
101
 
# File 'lib/rbt/actions/individual_actions/cookbooks/scan_for_blfs_programs/scan_for_blfs_programs.rb', line 99

def remote_blfs_page?
  REMOTE_BASE_URL
end

#remote_regex? ⇒ Boolean

#

remote_regex?

#

Returns:

  • (Boolean) 


106
107
108
 
# File 'lib/rbt/actions/individual_actions/cookbooks/scan_for_blfs_programs/scan_for_blfs_programs.rb', line 106

def remote_regex?
  REGEX_FOR_PROGRAMS_REGISTERED_AT_THE_REMOTE_BLFS_WEBPAGE
end

#remove_all_numbers_from(i) ⇒ Object

#

remove_all_numbers_from

#


140
141
142
 
# File 'lib/rbt/actions/individual_actions/cookbooks/scan_for_blfs_programs/scan_for_blfs_programs.rb', line 140

def remove_all_numbers_from(i)
  i.gsub(/\d/,'')
end

#report_how_many_remote_entries_exist ⇒ Object

#

report_how_many_remote_entries_exist

#


201
202
203
204
205
 
# File 'lib/rbt/actions/individual_actions/cookbooks/scan_for_blfs_programs/scan_for_blfs_programs.rb', line 201

def report_how_many_remote_entries_exist
  opne "#{rev}The remote BLFS webpage has at the least "+
        simp(@remotely_available_programs.size.to_s)+
        " #{rev}programs registered."
end

#reset ⇒ Object

#

reset (reset tag)

#


84
85
86
87
88
89
90
91
92
93
 
# File 'lib/rbt/actions/individual_actions/cookbooks/scan_for_blfs_programs/scan_for_blfs_programs.rb', line 84

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @dataset_from_the_remote_webpage
  # ======================================================================= #
  @dataset_from_the_remote_webpage = nil
  obtain_all_programs_that_miss_a_blfs_entry
  obtain_dataset_from_the_remote_webpage
end

#run ⇒ Object

#

run (run tag)

#


210
211
212
213
 
# File 'lib/rbt/actions/individual_actions/cookbooks/scan_for_blfs_programs/scan_for_blfs_programs.rb', line 210

def run
  report_how_many_remote_entries_exist
  iterate_over_all_programs_missing_a_blfs_entry 
end