Class: RBT::Cookbooks::CheckForAvailableVersions

Inherits:
Base show all
Defined in:
lib/rbt/utility_scripts/check_for_available_versions.rb

Overview

Cookbooks::CheckForAvailableVersions

Constant Summary collapse

DEFAULT_PROGRAM =
#

DEFAULT_PROGRAM

#
'ruby'

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(for_this_program = nil, run_already = true, &block) ⇒ CheckForAvailableVersions

#

initialize

#


33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/rbt/utility_scripts/check_for_available_versions.rb', line 33

def initialize(
    for_this_program = nil,
    run_already      = true,
    &block
  )
  reset
  set_seek_this_program(
    for_this_program
  )
  case run_already
  # === :dont_run_yet
  when :dont_run_yet, :do_not_run_yet
    run_already = false
  when :be_verbose
    be_verbose
    run_already = true
  end
  # ======================================================================= #
  # === Handle blocks next
  # ======================================================================= #
  if block_given?
    yielded = yield
    case yielded
    when :be_verbose
      be_verbose
    end
  end
  run if run_already
end

Instance Method Details

#cleanup ⇒ Object

#

cleanup

We will get rid of two instance variables here.

#


124
125
126
127
128
129
130
131
 
# File 'lib/rbt/utility_scripts/check_for_available_versions.rb', line 124

def cleanup
  if self.instance_variable_defined? :@sanitize_cookbook_dataset
    remove_instance_variable(:@sanitize_cookbook_dataset) # Trying this.
  end
  if self.instance_variable_defined? :@data
    remove_instance_variable(:@data)
  end
end

#feedback_matches ⇒ Object Also known as: feedback_available_versions

#

feedback_matches

This method is not needed if @be_silent is set to false.

We will feedback the matches that we found (which were stored in @results).

#


229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/rbt/utility_scripts/check_for_available_versions.rb', line 229

def feedback_matches
  if @results.empty?
    opne 'No locally available version has been found.'
  else
    e
    print rev
    cliner
    @results.each_with_index { |_, index|
      index += 1
      index  = '%02s' % (index) if @results.size > 9
      e "  #{rev}(#{simp(index.to_s)}#{rev}) #{sdir(_)}" 
    }
    cliner
    e
  end
end

#fetch_entry_at_this_position(i) ⇒ Object Also known as: position_at

#

fetch_entry_at_this_position

If the argument passed to this method, ‘i`, is called “first” then we equal this to be the first entry listed in the array @results.

If the argument passed is however called “last”, then it will default to the last entry of that array.

We also have to ensure that input like “-3” is valid. -3 would translate to “give me the version minus 3. ”-1“ would say ”give me the entry that comes last“.

#


146
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
 
# File 'lib/rbt/utility_scripts/check_for_available_versions.rb', line 146

def fetch_entry_at_this_position(i)
  if @results.empty?
    obtain_all_entries_from_the_source_directory(seek?)
  end
  i = i.to_s.dup # Need to work on a copy here.
  case i # Handle the two keywords 'first' and 'last' here.
  when 'first','vnewest','newest'
    i = 1.to_s
  when 'last','vlatest','latest'
    i = @results.size.to_s
  end
  i[0,1] = '' if i.start_with? 'v' # Get rid of "v", should it exist.
  # ========================================================================= #
  # Handle negative input next.
  # ========================================================================= #
  if i.to_s.include? '-' # account for a negative number.
    i = (@results.size - i.to_i.abs + 1) # +1 since Jan 2012.
  end
  i = i.to_i
  i = 1 if i <= 0
  # ========================================================================= #
  # Hardcap to a proper size. @results must exist for this to work though.
  # ========================================================================= #
  i = @results.size if i > @results.size
  result = @results[i - 1]
  set_version(ProgramInformation.return_version(result))
  return result
end

#obtain_all_entries_from_the_source_directory(seek_this_program = seek? ) ⇒ Object

#

obtain_all_entries_from_the_source_directory

#


203
204
205
206
207
208
209
210
211
 
# File 'lib/rbt/utility_scripts/check_for_available_versions.rb', line 203

def obtain_all_entries_from_the_source_directory(
    seek_this_program = seek?
  )
  target_directory = "#{source_directory?}#{seek_this_program}/"
  @results = Dir[target_directory+'*']
  sort_results
  @results = @results.reverse # Keep it reverse-sorted.
  return @results
end

#reset ⇒ Object

#

reset

#


66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/rbt/utility_scripts/check_for_available_versions.rb', line 66

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @seek_this_program
  # ======================================================================= #
  @seek_this_program = nil
  # ======================================================================= #
  # === :be_verbose
  # ======================================================================= #
  set_be_quiet # by default the class is silent and less verbose.
  # ======================================================================= #
  # === @version
  # ======================================================================= #
  @version = nil # This variable is only set via a special method.
  # ======================================================================= #
  # === @results
  # ======================================================================= #
  @results = []
end

#results? ⇒ Boolean Also known as: data?, programs?

#

data?

#

Returns:

  • (Boolean) 


195
196
197
 
# File 'lib/rbt/utility_scripts/check_for_available_versions.rb', line 195

def results?
  @results # This should be changed perhaps.
end

#run ⇒ Object Also known as: check_for_program

#

run (run tag)

#


250
251
252
253
254
 
# File 'lib/rbt/utility_scripts/check_for_available_versions.rb', line 250

def run
  obtain_all_entries_from_the_source_directory
  cleanup
  feedback_matches if be_verbose? or debug?
end

#seek? ⇒ Boolean Also known as: program?, input?

#

seek?

#

Returns:

  • (Boolean) 


90
91
92
 
# File 'lib/rbt/utility_scripts/check_for_available_versions.rb', line 90

def seek?
  @seek_this_program
end

#set_seek_this_program(i = DEFAULT_PROGRAM) ⇒ Object Also known as: set_program

#

set_seek_this_program

This method simply sets an instance variable that will designate our main program to use or search for.

#


181
182
183
184
185
186
187
188
189
190
 
# File 'lib/rbt/utility_scripts/check_for_available_versions.rb', line 181

def set_seek_this_program(i = DEFAULT_PROGRAM)
  i = i.join if i.is_a? Array
  i = DEFAULT_PROGRAM if i.nil?
  i = i.to_s.dup # Keep a copy.
  if i.include?('-') or i.include?('_')
    i = ProgramInformation.return_name(i)
  end
  i.chop! if i.end_with? '-' # Also get rid of trailing '-' chars.
  @seek_this_program = i
end

#set_version(i) ⇒ Object

#

set_version

#


113
114
115
116
117
 
# File 'lib/rbt/utility_scripts/check_for_available_versions.rb', line 113

def set_version(i)
  i = i.sub(/\.tar\.bz2$/,'').
        sub(/\.gz$/,'')
  @version = i
end

#sort_results ⇒ Object

#

sort_results

#


98
99
100
 
# File 'lib/rbt/utility_scripts/check_for_available_versions.rb', line 98

def sort_results
  @results = @results.sort # Or we can use this: .sort_by { |key| key.scan(/\d+/).map {|x| x.to_i } }.reverse
end

#try_to_find(this) ⇒ Object

#

try_to_find

#


216
217
218
219
 
# File 'lib/rbt/utility_scripts/check_for_available_versions.rb', line 216

def try_to_find(this)
  set_program(this)
  run
end

#version? ⇒ Boolean Also known as: version, available_versions

#

version?

#

Returns:

  • (Boolean) 


105
106
107
 
# File 'lib/rbt/utility_scripts/check_for_available_versions.rb', line 105

def version?
  @version
end