Class: RBT::Cookbooks::DownloadAllSourceArchives

Inherits:
Base show all
Defined in:
lib/rbt/cookbooks/download_all_source_archives/download_all_source_archives.rb

Overview

RBT::Cookbooks::DownloadAllSourceArchives

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

#

initialize

#


53
54
55
56
57
58
59
60
61
62
# File 'lib/rbt/cookbooks/download_all_source_archives/download_all_source_archives.rb', line 53

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

#


274
275
276
# File 'lib/rbt/cookbooks/download_all_source_archives/download_all_source_archives.rb', line 274

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

Instance Method Details

#cd_to_the_archive_directoryObject

#

cd_to_the_archive_directory

#


212
213
214
# File 'lib/rbt/cookbooks/download_all_source_archives/download_all_source_archives.rb', line 212

def cd_to_the_archive_directory
  cd @archive_directory, :be_quiet
end

#consider_downloading_this_program(i) ⇒ Object

#

consider_downloading_this_program

#


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

def consider_downloading_this_program(i)
  cd_to_the_archive_directory # Always enter the archive directory. 
  # ======================================================================= #
  # Next, check whether the program exists.
  # ======================================================================= #
  _ = action(:SanitizeCookbook, i) { :fast }
  program_path = _.program_path?
  remote_url   = _.remote_url?
  unless File.exist? program_path
    this_directory = "#{@archive_directory}#{i}/"
    unless File.directory? this_directory
      opne "Creating the directory `#{sdir(this_directory)}` next."
      mkdir this_directory
    end
    cd this_directory
    unless File.exist? program_path
      download(remote_url)
      opne "#{rev}Next downloading `#{simp(remote_url)}#{rev}`."
    end
  end
end

#dataset?Boolean

#

dataset?

#

Returns:

  • (Boolean)


100
101
102
# File 'lib/rbt/cookbooks/download_all_source_archives/download_all_source_archives.rb', line 100

def dataset?
  @available_programs
end

#download(i) ⇒ Object

#

download

The download-functionality requires wget right now.

#


205
206
207
# File 'lib/rbt/cookbooks/download_all_source_archives/download_all_source_archives.rb', line 205

def download(i)
  esystem "wget #{i}"
end
#

menu (menu tag)

#


107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
# File 'lib/rbt/cookbooks/download_all_source_archives/download_all_source_archives.rb', line 107

def menu(
    i = commandline_arguments?
  )
  if i.is_a? Array
    i.each {|entry| menu(entry) }
  else
    case i
    # ===================================================================== #
    # === download_all_source_archives --tags=plasma
    #
    # This is the entry point to select a particular tag.
    #
    # Example:
    #
    #   download_all_source_archives --tags=ruby
    #
    # ===================================================================== #
    when /^-?-?tags=(.+)$/,
         /^-?-?tag=(.+)$/
      register_this_tag($1.to_s.dup)
      set_use_these_cookbooks(select_only_these_tags(@tag))
    # ===================================================================== #
    # === download_all_source_archives --help
    # ===================================================================== #
    when /help/
      show_help
      exit
    end
  end
end

#process_the_programs_one_after_the_other(i = @available_programs) ⇒ Object

#

process_the_programs_one_after_the_other

#


254
255
256
257
258
259
260
# File 'lib/rbt/cookbooks/download_all_source_archives/download_all_source_archives.rb', line 254

def process_the_programs_one_after_the_other(
    i = @available_programs
  )
  i.each {|this_program|
    consider_downloading_this_program(this_program)
  }
end

#register_this_tag(i) ⇒ Object

#

register_this_tag

#


141
142
143
# File 'lib/rbt/cookbooks/download_all_source_archives/download_all_source_archives.rb', line 141

def register_this_tag(i)
  @tag = i
end

#report_the_archive_directory_in_useObject

#

report_the_archive_directory_in_use

#


148
149
150
151
152
153
154
155
156
157
158
# File 'lib/rbt/cookbooks/download_all_source_archives/download_all_source_archives.rb', line 148

def report_the_archive_directory_in_use
  if @tag
    opne "#{rev}All registered programs with the tag #{sfancy(@tag)} "\
         "#{rev}will be downloaded into the directory:"
  else
    opne 'All registered programs will be downloaded into the directory:'
  end
  e
  e sfile("  #{@archive_directory}")
  e
end

#resetObject

#

reset (reset tag)

#


67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/rbt/cookbooks/download_all_source_archives/download_all_source_archives.rb', line 67

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @tag
  # ======================================================================= #
  @tag = nil
  # ======================================================================= #
  # === @archive_directory
  # ======================================================================= #
  @archive_directory = source_directory?
  # ======================================================================= #
  # === @available_programs
  # ======================================================================= #
  @available_programs = available_programs? # <- Must come before the menu() call.
end

#runObject

#

run (run tag)

#


265
266
267
268
269
# File 'lib/rbt/cookbooks/download_all_source_archives/download_all_source_archives.rb', line 265

def run
  menu
  report_the_archive_directory_in_use
  process_the_programs_one_after_the_other
end

#select_only_these_tags(i) ⇒ Object

#

select_only_these_tags

To invoke this method, try:

download_all_source_archives --tags=plasma
#


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
# File 'lib/rbt/cookbooks/download_all_source_archives/download_all_source_archives.rb', line 224

def select_only_these_tags(i)
  # ======================================================================= #
  # Ok, the user provided a tag, so we have to selectively filter for
  # programs that include only that tag. For now, we only use the
  # expanded cookbook dataset for this. Of course we must check whether
  # this directory exists or whether it does not.
  # ======================================================================= #
  if File.directory? directory_expanded_cookbooks?
    entries = Dir[directory_expanded_cookbooks?+'*.yml']
    results = entries.map {|entry|
      YAML.load_file(entry)
    }.select {|entry| entry['tags'].include? i }
    results.map! {|entry| entry['real_short_name'] }
    return results
  else
    opne "No directory called #{sdir(directory_expanded_cookbooks?)} "\
         "#{rev}exists."
    opne 'This class currently requires this directory to work.'
    opne 'If you wish to auto-generate the directory and the files or that'
    opne 'directory, then issue this command:'
    e
    efancy '  cookbooks --expand'
    e
    exit
  end
end

#set_use_these_cookbooks(i) ⇒ Object

#

set_use_these_cookbooks

The input to this method should be an Array.

#


89
90
91
92
93
94
95
# File 'lib/rbt/cookbooks/download_all_source_archives/download_all_source_archives.rb', line 89

def set_use_these_cookbooks(i)
  if i.is_a? Array
    i.flatten!
    i.sort!
  end
  @available_programs = i
end

#show_helpObject

#

show_help (help tag)

#


163
164
165
166
167
168
169
170
171
172
173
# File 'lib/rbt/cookbooks/download_all_source_archives/download_all_source_archives.rb', line 163

def show_help
  opne 'This class allows you to download source archives.'
  opne 'You can also selectively download only certain entries, in'
  opne 'particular those who have registered tags.'
  e
  opne 'For example, if you wish to download all KDE-plasma related entries'
  opne 'then you can issue the following command:'
  e
  opnfancy '  download_all_source_archives --tags=plasma'
  e
end