Class: RBT::Cookbooks::FindAllArchiveTypes

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

Overview

RBT::Cookbooks::FindAllArchiveTypes

Constant Summary collapse

EXIT_ON_MISSING_ARCHIVE =
#

EXIT_ON_MISSING_ARCHIVE

#
false
REPORT_POSSIBLE_PROBLEM =
#

REPORT_POSSIBLE_PROBLEM

#
true
LJUST =
#

LJUST

#
12

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(run_already = true) ⇒ FindAllArchiveTypes

#

initialize

This class does not require any argument input.

#


49
50
51
52
53
54
 
# File 'lib/rbt/cookbooks/find_all_archive_types.rb', line 49

def initialize(
    run_already = true
  )
  reset
  run if run_already
end

Instance Method Details

#add_count_for(i) ⇒ Object

#

add_count_for

Use this method to keep track of all the entries that are part of our @hash. We will count +1 for each of .zip, .tar.bz2, .tar.gz and .tar.xz.

#


109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/rbt/cookbooks/find_all_archive_types.rb', line 109

def add_count_for(i)
  case i # case tag
  when /\.zip$/
    @hash[ZIP] += 1
  when /\.tar\.bz2$/
    @hash[TAR_BZ2] += 1
  when /\.tar\.gz$/
    @hash[TAR_GZ] += 1
  when /\.tar\.xz$/
    @hash[TAR_XZ] += 1
  end
end

#all_directories? ⇒ Boolean

#

all_directories?

#

Returns:

  • (Boolean) 


98
99
100
 
# File 'lib/rbt/cookbooks/find_all_archive_types.rb', line 98

def all_directories?
  @all_directories
end

#menu(i = nil) ⇒ Object

#

menu (case tag, menu tag)

#


157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/rbt/cookbooks/find_all_archive_types.rb', line 157

def menu(
    i = nil
  )
  case i # case tag
  # ======================================================================= #
  # === find_all_archive_types
  # ======================================================================= #
  when /-?-?help$/i
    opne 'Simply type anything, like gz.'
    exit
  else # Default here
    opne 'Next showing all results for '+sfancy('`'+TAR_BZ2+'`:')
    show_results_for('.tar.bz2')
    opne 'Next showing all results for '+sfancy('`'+TAR_GZ+'`:')
    show_results_for('.tar.gz')
  end
end

#obtain_all_directories_from_the_source_directory ⇒ Object

#

obtain_all_directories_from_the_source_directory

#


148
149
150
151
152
 
# File 'lib/rbt/cookbooks/find_all_archive_types.rb', line 148

def obtain_all_directories_from_the_source_directory
  @all_directories = Dir["#{@base_directory}*/"].reject {|entry|
    !File.directory? entry
  }.sort
end

#process_every_directory ⇒ Object

#

process_every_directory

#


125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/rbt/cookbooks/find_all_archive_types.rb', line 125

def process_every_directory
  all_directories?.each {|dir|
    found_entry = Dir["#{dir}*"].first
    if found_entry.nil?
      if @report_possible_problem
        opne "#{rev}There might be an error at `#{sdir(dir)}`."
      end if be_verbose? # Only if we are verbose.
      exit if @exit_on_missing_archive
    else
      if    found_entry.include? TAR_BZ2
        @array_for_tar_bz2 << found_entry
      elsif found_entry.include? TAR_GZ
        @array_for_tar_gz  << found_entry
      end
      _ = File.basename(found_entry)
      add_count_for(_)
    end
  }
end

#reset ⇒ Object

#

reset (reset tag)

#


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

def reset
  super()
  infer_the_namespace
  set_base_directory
  # ======================================================================= #
  # === @exit_on_missing_archive
  # ======================================================================= #
  @exit_on_missing_archive = EXIT_ON_MISSING_ARCHIVE
  # ======================================================================= #
  # === @report_possible_problem
  # ======================================================================= #
  @report_possible_problem = REPORT_POSSIBLE_PROBLEM
  # ======================================================================= #
  # === @hash
  # ======================================================================= #
  @hash = {}
  @hash.default = 0 # We start counting at 0.
  # ======================================================================= #
  # === @array_for_tar_bz2
  # ======================================================================= #
  @array_for_tar_bz2 = [] # Store .tar.bz2 files here.
  # ======================================================================= #
  # === @array_for_tar_gz
  # ======================================================================= #
  @array_for_tar_gz  = [] # Store .tar.gz files here.
end

#run ⇒ Object

#

run (run tag)

#


233
234
235
236
 
# File 'lib/rbt/cookbooks/find_all_archive_types.rb', line 233

def run
  obtain_all_directories_from_the_source_directory
  process_every_directory
end

#run_and_report ⇒ Object

#

run_and_report

Bundle run() and report() together.

#


225
226
227
228
 
# File 'lib/rbt/cookbooks/find_all_archive_types.rb', line 225

def run_and_report
  run
  report
end

#set_base_directory(i = source_directory? ) ⇒ Object

#

set_base_directory

#


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

def set_base_directory(
    i = source_directory?
  )
  @base_directory = i
end

#show_results ⇒ Object Also known as: report

#

show_results

This method will show the results, in a pretty-printed fashion.

#


212
213
214
215
216
217
218
 
# File 'lib/rbt/cookbooks/find_all_archive_types.rb', line 212

def show_results
  orev "We found these results:"
  e '  '+(TAR_XZ+': ' ).ljust(LJUST)+sfancy(@hash[TAR_XZ].to_s)
  e '  '+(TAR_BZ2+': ').ljust(LJUST)+sfancy(@hash[TAR_BZ2].to_s)
  e '  '+(TAR_GZ+': ' ).ljust(LJUST)+sfancy(@hash[TAR_GZ].to_s)
  e '  '+(ZIP+': '    ).ljust(LJUST)+sfancy(@hash[ZIP].to_s)
end

#show_results_for(i = TAR_BZ2) ⇒ Object

#

show_results_for

#


178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/rbt/cookbooks/find_all_archive_types.rb', line 178

def show_results_for(
    i = TAR_BZ2
  )
  case i
  # ======================================================================= #
  # === .tar.gz
  # ======================================================================= #
  when TAR_GZ
    if @array_for_tar_gz.empty?
      orev 'No '+swarn('.tar.gz')+rev+' entries were found.'
    else
      @array_for_tar_gz.each {|entry|
        e swarn("  #{entry}")
      }
    end
  # ======================================================================= #
  # === .tar.bz2
  # ======================================================================= #
  when TAR_BZ2
    if @array_for_tar_bz2.empty?
      orev 'No .tar.bz2 entries were found.'
    else
      @array_for_tar_bz2.each {|entry|
        e swarn("  #{entry}")
      }
    end
  end 
end