Class: RBT::Cookbooks::CheckForInclusion

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

Overview

RBT::Cookbooks::CheckForInclusion

Constant Summary collapse

ARRAY_WITH_EXCEPTIONS =
#

ARRAY_WITH_EXCEPTIONS

The following Array has a list of exceptions. If you wish to skip entries then simply add them here.

#
%w(
  /home/x/src/bios/
  /home/x/src/firmware/
  /home/x/src/firefox/
  /home/x/src/firefox/extensions/
  /home/x/src/flash/
  /home/x/src/fonts/
  /home/x/src/gobolinux/
  /home/x/src/hardware/
  /home/x/src/nvidialinux/
  /home/x/src/openjdk/
  /home/x/src/windows/
  /home/x/src/wlan/
)
DEFAULT_FILE =
#

DEFAULT_FILE

Where to store our results. A .md markdown file may seem appropriate.

#
"#{RBT.depot_directory?}Information/UnidentifiedFiles.md"

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, #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(run_already = true) ⇒ CheckForInclusion

#

initialize

#


51
52
53
54
55
 
# File 'lib/rbt/cookbooks/check_for_inclusion/check_for_inclusion.rb', line 51

def initialize(
    run_already = true
  )
  run if run_already
end

Instance Method Details

#check_each_file_whether_it_is_included ⇒ Object

#

check_each_file_whether_it_is_included

Here we report only if @be_verbose is true. (3)

#


103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/rbt/cookbooks/check_for_inclusion/check_for_inclusion.rb', line 103

def check_each_file_whether_it_is_included
  @all_files.each { |file_long_name, file_short_name|
    unless ARRAY_WITH_EXCEPTIONS.empty?
      dirname = File.dirname(file_long_name)+'/'
      next if ARRAY_WITH_EXCEPTIONS.include?(dirname)
    end
    file_short_name = ProgramInformation.return_real_name(
      File.basename(file_long_name)
    )
    file_short_name.downcase! if file_short_name
    e "#{rev}Now #{steelblue('scanning')} #{rev}for the "\
      "program `#{sfile(file_short_name)}#{rev}`."
    # ===================================================================== #
    # If it is included then everything is fine.
    # ===================================================================== #
    if is_included?(file_short_name)
      # f '`'+file_long_name+'` is included.' if be_verbose? # Be silent here. 
    else # Else it is not included.
      if be_verbose?
        opnwarn '`'+simp(file_long_name)+
                    swarn('` is not included.')
      end
      @array_files_which_were_not_found << file_long_name
    end
  }
end

#is_included?(i) ⇒ Boolean

#

is_included?

Query whether the program is included or not.

#

Returns:

  • (Boolean) 


135
136
137
138
139
140
 
# File 'lib/rbt/cookbooks/check_for_inclusion/check_for_inclusion.rb', line 135

def is_included?(i)
  i.delete!('_') if i.include? '_'
  is_included = @query.is_included?(i)
  return true if is_included
  false # default return value
end

#report_to_user_which_files_are_not_included ⇒ Object

#

report_to_user_which_files_are_not_included

#


145
146
147
148
149
150
151
152
153
154
 
# File 'lib/rbt/cookbooks/check_for_inclusion/check_for_inclusion.rb', line 145

def report_to_user_which_files_are_not_included
  e sfancy('These files were not found:')
  e
  cliner {
    @array_files_which_were_not_found.each {|entry|
      e steelblue("  #{entry}")
    }
  }
  e
end

#reset ⇒ Object

#

reset

#


60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/rbt/cookbooks/check_for_inclusion/check_for_inclusion.rb', line 60

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @base_dir
  # ======================================================================= #
  @base_dir = source_directory?
  # ======================================================================= #
  # === @array_files_which_were_not_found
  # ======================================================================= #
  @array_files_which_were_not_found = []
  # ======================================================================= #
  # === @all_files
  # ======================================================================= #
  @all_files = []
  # ======================================================================= #
  # === :be_verbose
  # ======================================================================= #
  set_be_verbose
  # ======================================================================= #
  # === @query
  # ======================================================================= #
  @query = action(:SanitizeCookbook, :do_not_run_yet) { :fast }
end

#run ⇒ Object

#

run (run tag)

#


185
186
187
 
# File 'lib/rbt/cookbooks/check_for_inclusion/check_for_inclusion.rb', line 185

def run
  run_everything
end

#run_everything ⇒ Object

#

run_everything

#


174
175
176
177
178
179
180
 
# File 'lib/rbt/cookbooks/check_for_inclusion/check_for_inclusion.rb', line 174

def run_everything
  reset                                       # (1)
  scan_for_all_files                          # (2)
  check_each_file_whether_it_is_included      # (3)
  report_to_user_which_files_are_not_included # (4)
  store_results_to_file                       # (5)
end

#scan_for_all_files ⇒ Object

#

scan_for_all_files

Scan for all files and fill up the array @all_files

#


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

def scan_for_all_files
  _ = @base_dir+'*/**'
  opne 'Scanning for all files in directory `'+sdir(_)+rev+
       '` now.'
  opne 'Be patient, this may take a while.'
  @all_files = Dir[_].sort
end

#store_results_to_file(what = @array_files_which_were_not_found, where_to = DEFAULT_FILE) ⇒ Object

#

store_results_to_file

#


159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/rbt/cookbooks/check_for_inclusion/check_for_inclusion.rb', line 159

def store_results_to_file(
    what     = @array_files_which_were_not_found,
    where_to = DEFAULT_FILE
  )
  remove_file(where_to) # Delete the old file first, before appending into a new one.
  @array_files_which_were_not_found.each { |f|
    append_what_into(f+N, where_to)
  }
  e 'Stored into:'
  e sfancy("  #{where_to}")
end