Class: RBT::UrlAction

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

Overview

RBT::UrlAction

Constant Summary collapse

DEFAULT_COLOUR =
#

DEFAULT_COLOUR

#
'green'
ARRAY_ALLOWED_ACTIONS =
#

ARRAY_ALLOWED_ACTIONS

#
%i(
  install
  query
  remove
)
EXTRACT_TO =

Default for most users, I guess.

'/home/Temp/'

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

#

initialize

The input can also include a version-component of a given program, such as “1.5.22”.

If the program version is omitted, we will default to the latest version that is registered.

#


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
# File 'lib/rbt/url_action/url_action.rb', line 113

def initialize(
    i           = nil,
    run_already = true
  )
  reset
  set_input(i)
  case run_already
  # ======================================================================= #
  # === :do_not_run_yet
  # ======================================================================= #
  when :do_not_run_yet
    run_already = false
  end
  run if run_already
end

Class Method Details

.[](i = '') ⇒ Object

#

RBT::UrlAction[]

#


439
440
441
# File 'lib/rbt/url_action/url_action.rb', line 439

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

.allowed_actions?Boolean

#

RBT::UrlAction.allowed_actions?

Query which actions are allowed for class RBT::UrlActin.

#

Returns:

  • (Boolean)


62
63
64
# File 'lib/rbt/url_action/url_action.rb', line 62

def self.allowed_actions?
  ARRAY_ALLOWED_ACTIONS
end

.compile_mode?Boolean

#

UrlAction.compile_mode?

#

Returns:

  • (Boolean)


86
87
88
# File 'lib/rbt/url_action/url_action.rb', line 86

def self.compile_mode?
  @compile_mode
end

.set_compile_mode(i = :rbt) ⇒ Object

#

UrlAction.set_compile_mode

We need to keep track whether we wish to use Easycompile or RBT.

We do this by assigning to the @compile_mode variable. The three valid settings are nil, :rbt and :easycompile.

#


98
99
100
101
102
# File 'lib/rbt/url_action/url_action.rb', line 98

def self.set_compile_mode(
    i = :rbt
  )
  @compile_mode = i
end

Instance Method Details

#action_to_perform?Boolean

#

action_to_perform?

#

Returns:

  • (Boolean)


220
221
222
223
224
225
226
# File 'lib/rbt/url_action/url_action.rb', line 220

def action_to_perform?
  _ = input?
  if _.include? '/'
    _ = _.split('/').first
  end
  _ # Return it here.
end

#debug?Boolean

#

debug?

#

Returns:

  • (Boolean)


178
179
180
# File 'lib/rbt/url_action/url_action.rb', line 178

def debug? # Whether we will debug or whether we will not.
  @debug
end

#easycompile(i, program_version = nil) ⇒ Object

#

easycompile

Delegate to the easycompile project in order to compile something from source.

#


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
# File 'lib/rbt/url_action/url_action.rb', line 360

def easycompile(
    i, program_version = nil
  )
  begin
    require 'easycompile' unless Object.const_defined? :Easycompile
  rescue LoadError; end
  # ======================================================================= #
  # We assume that the user wishes to use a yaml file here.
  # This is a typical operation for Easycompile.
  # ======================================================================= #
  i << '.yml' unless i.end_with? '.yml'
  if program_version
    Easycompile::Easycompile.new(i,
      extract_to:      extract_to?,
      program_version: program_version,
      prefix:          :appdir_layout
    )
  else
    Easycompile::Easycompile.new(i,
      extract_to: extract_to?,
      prefix:     :appdir_layout
    )
  end
end

#extract_to?Boolean

#

extract_to?

#

Returns:

  • (Boolean)


213
214
215
# File 'lib/rbt/url_action/url_action.rb', line 213

def extract_to?
  @extract_to
end

#input?Boolean

#

input?

#

Returns:

  • (Boolean)


388
389
390
# File 'lib/rbt/url_action/url_action.rb', line 388

def input?
  @input
end

#install_this_program(i, program_version = nil) ⇒ Object

#

install_this_program (install tag, compile tag)

This will compile/install a given program.

We also have to support installation of a specific version.

#


399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
# File 'lib/rbt/url_action/url_action.rb', line 399

def install_this_program(i, program_version = nil)
  if i.is_a? Array
    i.each {|entry| install_this_program(entry) }
  else
    compile_mode = RBT::UrlAction.compile_mode?
    set_result('Now installing `'+sfancy(i)+'` via '+compile_mode.to_s+'.')
    opn; e result?
    case compile_mode
    when :rbt # rbt tag.
      require 'rbt/requires/require_the_installer_class.rb'
      _ = RBT::Action::Installer.new(i, :dont_run_yet)
      _.extract_to extract_to?
      _.run
    when :easycompile # Easycompile tag.
      # =================================================================== #
      # If the input includes a '-' then we assume that the user
      # wants to install a specific version.
      # =================================================================== #
      if i.include? '-'
        program_version = i.split('-')
        opn; e 'We will use version number `'+sfancy(program_version)+
               '` if possible.'
        easycompile(i, program_version)
      else
        easycompile(i)
      end
    end
  end
end

#query_package(this_package) ⇒ Object

#

query_package

This method will return a listing of all versioned directories found under the $PROGRAMS/Foo directory.

#


258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
# File 'lib/rbt/url_action/url_action.rb', line 258

def query_package(this_package)
  if this_package.is_a? Array
    this_package.each {|package| query_package(package) }
  else
    opne "Querying package `#{sfancy(this_package)}` next."
    location = (programs_dir?+this_package.capitalize+'/').squeeze '/'
    if File.exist? location
      _ = Dir[location+'*'].select {|i| i =~ /\d+/ } # Select entries with a number.
      if _.empty? # Do nothing if it is empty.
      else
        reset_result
        @result << "#{N}Found these packages:"
        efancy @result
        _.each {|package|
          string = ''+package
          @result << string
          e string
        }
      end
    else
      @result = "  The location `#{location}` does not exist."
      opnwarn @result
    end
  end
end

#remove_this_program(i) ⇒ Object

#

remove_this_program (remove tag)

Remove a package/program through this method.

We need to be sure that a specific version is mentioned, too. If it is not then we will remove all versions.

#


292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
# File 'lib/rbt/url_action/url_action.rb', line 292

def remove_this_program(i)
  if i.is_a? Array
    i.each {|my_program|
      remove_this_program(my_program)
    }
  else
    i = programs_dir?+i.capitalize
    if File.exist? i
      opne "Removing `#{sdir(i)}` now."
      remove_directory(i) # Remove a directory here.
      possible_current_symlink = i.split('/')[0..-2].join('/')+'/Current'
      if File.symlink? possible_current_symlink
        File.delete(possible_current_symlink)
      end
    else
      @result = i+' not found. Can not remove.'
      opne @result
    end
  end
end

#report_unknown_action(i = nil) ⇒ Object

#

report_unknown_action

Presently, only these three actions are known:

- query
- remove
- install

A few aliases exist to these actions, such as ‘_’ and ‘?’.

#


200
201
202
203
204
205
206
207
208
# File 'lib/rbt/url_action/url_action.rb', line 200

def report_unknown_action(
    i = nil
  )
  i = i.to_s unless i.is_a? String # Need a String.
  unless i.empty?
    set_result 'The action called `'+i+'` is unknown.'
    e @result
  end
end

#resetObject

#

reset (reset tag)

#


132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
# File 'lib/rbt/url_action/url_action.rb', line 132

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @result
  # ======================================================================= #
  @result      = nil
  # ======================================================================= #
  # === @input
  # ======================================================================= #
  @input       = nil
  # ======================================================================= #
  # === :debug
  # ======================================================================= #
  enable_debug
  # ======================================================================= #
  # === :be_verbose
  # ======================================================================= #
  set_be_verbose
  # ======================================================================= #
  # === :use_colours
  # ======================================================================= #
  enable_colours # Whether to use colours or not.
  set_extract_to # Must initialize it once.
  RBT::UrlAction.set_compile_mode :rbt # Initialize it to this default.
end

#reset_resultObject

#

reset_result

#


248
249
250
# File 'lib/rbt/url_action/url_action.rb', line 248

def reset_result
  @result = nil
end

#result?Boolean Also known as: result

#

result?

#

Returns:

  • (Boolean)


241
242
243
# File 'lib/rbt/url_action/url_action.rb', line 241

def result?
  @result
end

#runObject

#

run (run tag)

#


432
433
434
# File 'lib/rbt/url_action/url_action.rb', line 432

def run
  run_everything
end

#run_everythingObject

#

run_everything (action tag, act tag)

This is the powerhorse of the project.

#


318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
# File 'lib/rbt/url_action/url_action.rb', line 318

def run_everything
  _ = action_to_perform?.to_sym
  if RBT::UrlAction.allowed_actions?.include? _
    this_program = nil
    # ===================================================================== #
    # Ok, the action is allowed, thus we can continue.
    # ===================================================================== #
    which_action_to_perform = input?
    if which_action_to_perform.include? '/'
      splitted = which_action_to_perform.split('/')
      splitted.reject!(&:empty?) # Get rid of empty entries.
      which_action_to_perform = splitted.first # Grab the first entry.
      this_program = splitted[1]
    end
    case which_action_to_perform # case tag
    # ===================================================================== #
    # === query
    # ===================================================================== #
    when 'query','q','?' # ? is also treated as a query
      query_package(this_program)
    # ===================================================================== #
    # === remove
    # ===================================================================== #
    when 'remove','rm','entferne','lösche'
      remove_this_program(this_program)
    # ===================================================================== #
    # === install
    # ===================================================================== #
    when 'install','i','compile','_'
      install_this_program(this_program)
    end
  else # Else the action is not included.
    report_unknown_action _
  end
end

#set_extract_to(i = EXTRACT_TO) ⇒ Object

#

set_extract_to

Defaults to /Depot/Temp for extracting.

#


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

def set_extract_to(i = EXTRACT_TO)
  i = EXTRACT_TO if i.nil?
  @extract_to = i
end

#set_input(i = '') ⇒ Object Also known as: set_action

#

set_input

#


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

def set_input(i = '')
  i = i.join(' ').strip if i.is_a? Array
  i = i.to_s.dup # Must be a String.
  # ======================================================================= #
  # Eliminate leading '/' characters. We never need them really.
  # ======================================================================= #
  i[0,0] = '' if i.start_with? '/'
  if debug? and i and !i.nil? and !i.empty?
    opne "Now setting the input to `#{sfancy(i)}`."
  end
  @input = i
end

#set_result(i) ⇒ Object

#

set_result

#


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

def set_result(i)
  @result = i
end