Class: RBT::Cookbooks::CheckIfSourceDirectoriesExist

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

Overview

RBT::Cookbooks::CheckIfSourceDirectoriesExist

Constant Summary collapse

PADDING =
#

PADDING

#
35

Constants inherited from LeanPrototype

LeanPrototype::ALL_COLOUR_METHODS, LeanPrototype::ARRAY_KDE_KONSOLE_COLOURS_IN_USE, LeanPrototype::DAY_NAMES, LeanPrototype::NAMESPACE, LeanPrototype::SILENT_REDIRECTION

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(optional_input = nil, run_already = true) ⇒ CheckIfSourceDirectoriesExist

#

initialize

#


32
33
34
35
36
37
38
39
40
41
 
# File 'lib/rbt/cookbooks/check_for_existing_source_directories.rb', line 32

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

Instance Method Details

#check_commandline_arguments ⇒ Object

#

check_commandline_arguments

#


83
84
85
86
87
88
89
90
91
 
# File 'lib/rbt/cookbooks/check_for_existing_source_directories.rb', line 83

def check_commandline_arguments
  case first_argument? # case tag
  # ======================================================================= #
  # === --help
  # ======================================================================= #
  when /^-?-?help$/i
    show_help_then_exit
  end
end

#check_each_entry ⇒ Object

#

check_each_entry

#


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

def check_each_entry
  available_programs?.each {|entry|
    target = source_directory?+File.basename(entry).sub(/\.yml$/,'')+'/'
    shall_we_check_this_target = false
    if File.exist? target # ok, the target exists, all may be fine, so we pass through.
      shall_we_check_this_target = true
    end
    # ===================================================================== #
    # Some entries in the yaml file have a "do_not_download"
    # entry. In that case we will ignore them. 
    # ===================================================================== #
    location = individual_cookbooks_directory?+File.basename(entry)
    if File.exist? location
      hash = load_this_cookbook(location) # in module_methods.rb
      unless hash['do_not_download'].nil?
      end
    end
    if shall_we_check_this_target
      if be_verbose?
        e 'Target '+sfile(target.ljust(padding?))+' does exist.'
      end
    else # does not exist, report
      register_target_does_not_exist(target)
    end
  }
end

#load_this_cookbook(i) ⇒ Object

#

load_this_cookbook

#


142
143
144
 
# File 'lib/rbt/cookbooks/check_for_existing_source_directories.rb', line 142

def load_this_cookbook(i)
  action(:SanitizeCookbook, i) { :fast }
end

#padding? ⇒ Boolean

#

padding?

#

Returns:

  • (Boolean) 


135
136
137
 
# File 'lib/rbt/cookbooks/check_for_existing_source_directories.rb', line 135

def padding?
  PADDING
end

#register_target_does_not_exist(i) ⇒ Object

#

register_target_does_not_exist

#


96
97
98
 
# File 'lib/rbt/cookbooks/check_for_existing_source_directories.rb', line 96

def register_target_does_not_exist(i)
  @array_targets << i
end

#report_missing_entries ⇒ Object

#

report_missing_entries

Report all missing entries here.

#


105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/rbt/cookbooks/check_for_existing_source_directories.rb', line 105

def report_missing_entries # report them all now.
  sanitize_targets
  # ======================================================================= #
  # Next display all found targets:
  # ======================================================================= #
  e
  @array_targets.sort.each {|entry|
    e "  #{sdir(entry.squeeze('/').ljust(PADDING))} #{rev}does "\
      "#{tomato('not')} #{rev}exist."
  }
  e
  unless @array_targets.empty?
    _ = @array_targets.size.to_s
    # ===================================================================== #
    # Always report non-existing directories.
    # ===================================================================== #
    opne "#{simp(_)} #{rev}non-existing directories were found."
  end
end

#reset ⇒ Object

#

reset

#


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

def reset
  super()
  # ======================================================================= #
  # === @array_targets
  # ======================================================================= #
  @array_targets = []
  # ======================================================================= #
  # === :be_verbose
  # ======================================================================= #
  set_do_not_be_verbose # if true then we will also report directories that exist.
end

#run ⇒ Object

#

run (run tag)

#


179
180
181
182
183
 
# File 'lib/rbt/cookbooks/check_for_existing_source_directories.rb', line 179

def run
  check_commandline_arguments
  check_each_entry
  report_missing_entries
end

#sanitize_targets ⇒ Object

#

sanitize_targets

#


128
129
130
 
# File 'lib/rbt/cookbooks/check_for_existing_source_directories.rb', line 128

def sanitize_targets
  @array_targets.map! {|entry| entry << '/' }
end

#show_help(optional_then_exit = false) ⇒ Object

#

show_help

#


68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/rbt/cookbooks/check_for_existing_source_directories.rb', line 68

def show_help(
    optional_then_exit = false
  )
  begin
    require 'class_docu_shower'
  rescue LoadError; end
  if Object.const_defined? :ClassDocuShower
    ClassDocuShower.new(__FILE__)
  end
  exit if optional_then_exit
end

#show_help_then_exit ⇒ Object

#

show_help_then_exit

#


61
62
63
 
# File 'lib/rbt/cookbooks/check_for_existing_source_directories.rb', line 61

def show_help_then_exit
  show_help :then_exit
end