Class: Roebe::Shell::Commandline

Inherits:
Base show all
Includes:
Base::CommandlineArguments
Defined in:
lib/roebe/shell/commandline/commandline.rb

Overview

Roebe::Shell::Commandline

Constant Summary

Constants inherited from Base

Base::COLOURS, Base::HOME_DIRECTORY_OF_USER_X, Base::N, Base::NAMESPACE

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Base::CommandlineArguments

#append_onto_the_commandline_arguments, #clear_commandline_arguments, #commandline_arguments?, #commandline_arguments_as_string?, #commandline_arguments_without_leading_hyphens?, #first_argument?, #first_argument_without_leading_hyphens?, #has_an_argument_been_passed?, #remove_hyphened_arguments_from_the_commandline_arguments, #return_commandline_arguments_with_leading_hyphens, #second_argument?, #set_commandline_arguments

Methods inherited from Base

#actions, #append_this_onto_that_file, #append_what_into, #be_silent, #be_verbose?, #beautiful_url, #burlywood, #call_next, #chdir, #cheerful_guy, #cliner, #complex_esystem, #convert_global_env, #copy_directory, #copy_file, #cornflowerblue, #create_directory, #crimson, #current_month?, #current_time?, #current_year?, #cyan, #darkcyan, #darkgreen, #darkkhaki, #darkslateblue, #deeppink, #delete_symlink, #do_not_use_the_base_colours, #do_use_the_base_colours, #e, #ecomment, #editor_to_use?, #efancy, #eimp, #emphasis, #ensure_main_encoding, #ensure_utf_encoding, #eparse, #erev, #esteelblue, #etomato, #ewarn, #exit_program, #firebrick, #get_current_day, #get_current_month, #get_files_and_directories, #get_files_from, #get_german_name_for_this_weekday, #gold, #green, #grey, #hh_mm_ss, #hh_mm_ss_day_month_year, #home_dir?, #home_directory_of_user_x?, #infer_the_namespace, #internal_hash?, #is_a_directory?, #is_a_file?, #is_a_jpg_file?, #is_an_image_file?, #is_archive?, #is_audio_file?, #is_in_studium_dir?, #is_multimedia_file?, #is_on_roebe?, #is_on_windows?, #is_studium_available?, #is_symlink?, #is_this_a_ruby_file?, #is_video_file?, #iso_encoding?, #le, #left_colour, #lightblue, #lightgreen, #lightseagreen, #lightsteelblue, #lime, #limegreen, #localhost_to_data, #log_directory?, #main_encoding?, #mediumorchid, #mediumpurple, #mediumseagreen, #mediumslateblue, #mediumspringgreen, #mediumturquoise, #mkdir_p, #mv, #n_days_in_this_month, #n_pages_in_this_pdf_file?, #namespace?, #no_file_exists_at, #ogrey, #olive, #olivedrab, #open_in_browser, #opne, #opnesystem, #opnn, #orange, #orchid, #orev, #palegoldenrod, #palevioletred, #pink, #powderblue, #programs_dir?, #project_base_dir?, #random_html_colour, #rds, #read_file_in_iso_encoding, #read_file_via_the_default_encoding, #read_lines_via_iso_encoding, #readlines_with_main_encoding, #red, #register_sigint, #remove, #remove_directory, #remove_file, #rename_kde_konsole_tab, #replace_localhost_with_data, #report_pwd, #require_rescue, #reset_the_internal_hash, #return_all_directories_from_this_directory, #return_all_files_from_this_directory, #return_current_directory, #return_dd_mm_yyyy, #return_file_or_directory_of, #return_files_from_pwd, #return_last_part_of_the_current_directory, #return_utc, #rev, #right_arrow?, #right_colour, #roebe_log_directory?, #rosybrown, #royalblue, #ruby_base_directory?, #run_in_background, #run_rcfiles_then_run_ata_via_qdbus, #sandybrown, #sdir, #seagreen, #set_be_verbose, #set_xorg_buffer, #sfancy, #sfile, #show_help, #silent_redirection?, #simp, #simple_esystem, #skyblue, #slateblue, #slategray, #springgreen, #steelblue, #string_italic, #swarn, #symlink, #teal, #temp_dir?, #to_camelcase, #to_counted_hash, #tomato, #touch, #try_to_require_the_beautiful_url_gem, #try_to_require_the_html_template, #try_to_require_the_open_gem, #try_to_require_the_program_information_gem, #try_to_require_the_xorg_buffer, #use_colours?, #verbose_truth, #weekday?, #word_wrap, #write_what_into, #yellow

Constructor Details

#initialize(commandline_arguments = ARGV, run_already = true) ⇒ Commandline

#

initialize

#


37
38
39
40
41
42
43
44
45
46
 
# File 'lib/roebe/shell/commandline/commandline.rb', line 37

def initialize(
    commandline_arguments = ARGV,
    run_already           = true
  )
  reset
  set_commandline_arguments(
    commandline_arguments
  )
  run if run_already
end

Class Method Details

.[](i = ARGV) ⇒ Object

#

Roebe::Shell::Commandline[]

#


372
373
374
 
# File 'lib/roebe/shell/commandline/commandline.rb', line 372

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

Instance Method Details

#do_extract_these_files_to(these_files, extract_to) ⇒ Object

#

do_extract_these_files_to

#


324
325
326
327
328
329
 
# File 'lib/roebe/shell/commandline/commandline.rb', line 324

def do_extract_these_files_to(
    these_files,
    extract_to
  )
  Roebe.extract(these_files, extract_to)
end

#do_start_a_new_roebe_shell_instance ⇒ Object Also known as: consider_delegating_towards_roebe_shell

#

do_start_a_new_roebe_shell_instance

This is the method that will instantiate a new instance of class Roebe::Shell.

#


337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/roebe/shell/commandline/commandline.rb', line 337

def do_start_a_new_roebe_shell_instance
  commandline_arguments = commandline_arguments?
  fast_menu(commandline_arguments)
  unless commandline_arguments.empty?
    first = commandline_arguments.first
    # ========================================================================= #
    # First, we handle the special case when we use benchmark-options.
    # ========================================================================= #
    if Roebe::Shell.valid_benchmark_options.include?(first) # rda --benchmark
      Roebe::Shell.do_use_benchmark_while_loading
    # ========================================================================= #
    # Next, we handle the situation when the user does not want to
    # make use of the configuration-yaml files.
    # ========================================================================= #
    elsif Roebe::Shell.valid_no_configuration_options.include?(first) # rda --noconfig
      Roebe::Shell.do_not_use_configuration
    end
  end
  require 'roebe/shell/shell/shell.rb'
  # ======================================================================= #
  # In this case Roebe::Shell will proceed.
  # ======================================================================= #
  Roebe::Shell.new(commandline_arguments) { @hash_to_be_passed }
end

#fast_menu(i) ⇒ Object Also known as: intercept_commandline_actions

#

fast_menu (fast menu, fast tag)

#


65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
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
129
130
131
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/roebe/shell/commandline/commandline.rb', line 65

def fast_menu(i)
  if i.is_a? Array
    i.each {|entry| fast_menu(entry) }
  else
    case i
    # ===================================================================== #
    # === dia --is-on-roebe
    # ===================================================================== #
    when /^-?-?is(-|_| )?on(-|_| )?roebe$/
      @hash_to_be_passed[:is_roebe] = true
    # ===================================================================== #
    # === dia --is-not-on-roebe
    # ===================================================================== #
    when /^-?-?is(-|_| )?not(-|_| )?on(-|_| )?roebe$/
      @hash_to_be_passed[:is_roebe] = false
    # ===================================================================== #
    # === dia --enable-readline
    # ===================================================================== #
    when /^-?-?enable(-|_| )?readline$/
      @hash_to_be_passed[:enable_readline] = true
    # ===================================================================== #
    # === dia --use-readline
    # ===================================================================== #
    when /^-?-?use(-|_| )?readline$/,
         /^-?-?readline$/
      @hash_to_be_passed[:use_this_method_for_obtaining_user_input] = :readline
    # ===================================================================== #
    # === dia --use-reline
    # ===================================================================== #
    when /^-?-?use(-|_| )?reline$/,
         /^-?-?reline$/
      @hash_to_be_passed[:use_this_method_for_obtaining_user_input] = :reline
    # ===================================================================== #
    # === dia --use-stdin
    # ===================================================================== #
    when /^-?-?use(-|_| )?stdin$/,
         /^-?-?stdin$/
      @hash_to_be_passed[:use_this_method_for_obtaining_user_input] = :stdin
    # ===================================================================== #
    # === dia --readline
    # ===================================================================== #
    when /^-?-?disable(-|_| )?readline$/,
         '--readline',
         /^-?-?no?(-|_| )?readline$/,
         'noreadline',
         'readline-',
         'nreadline',
         'NOREADLINE',
         '--no_readline',
         '--disablereadline'
      @hash_to_be_passed[:enable_readline] = false
    # ===================================================================== #
    # === dia --no-config
    # ===================================================================== #
    when *Roebe::Shell.valid_no_configuration_options
      @hash_to_be_passed[:use_configuration] = false # This here can be invoked via:  dia --norc
    # ===================================================================== #
    # === dia --nocolours
    # ===================================================================== #
    when /-?-?no(-|_)?colou?rs?$/,
         /-?-?disable(-|_)?colou?rs?$/
      @hash_to_be_passed[:use_colours] = false
    # ===================================================================== #
    # === dia --enable-colours
    # ===================================================================== #
    when /-?-?enable(-|_)?colou?rs?$/
      @hash_to_be_passed[:use_colours] = true
    # ===================================================================== #
    # === dia --use-benchmarks
    # ===================================================================== #
    when *ARRAY_VALID_BENCHMARK_OPTIONS
      Roebe::Shell.do_use_benchmark_while_loading
    # ===================================================================== #
    # === dia --no-startup
    # ===================================================================== #
    when /^-?-?no(-|_)?startup$/i
      @hash_to_be_passed[:skip_startup] = true
    # ===================================================================== #
    # === dia --time
    # ===================================================================== #
    when /^-?-?time\??$/i,
         /^-?-?show(_|-)?time$/
      require 'roebe/time/time.rb'
      ::Roebe.show_time
      exit
    # ===================================================================== #
    # === dia --version?
    # ===================================================================== #
    when *ARRAY_VALID_VERSION_OPTIONS
      Roebe.report_version
      exit
    # ===================================================================== #
    # === dia --disable-anmeldung
    # ===================================================================== #
    when /-?-?disable(-|_)?anmeldunge?n?$/
      require 'roebe/shell/module_methods/anmeldung.rb'
      Roebe::Shell.disable_anmeldung # <- Note that this overrules config-settings.
    # ===================================================================== #
    # === dia --generate_tab_completion
    # ===================================================================== #
    when /^-?-?generate(-|_| )?tab(-|_| )?completion$/,
         /^-?-?completion$/
      require 'roebe/shell/module_methods/generate_tab_completion.rb'
      Roebe::Shell.generate_tab_completion
      exit
    # ===================================================================== #
    # === dia --crazy-make-mode
    # ===================================================================== #
    when /crazy(_|-)?make(_|-)?mode/,
         /crazy(_|-)?make/,
         'ccmake',
         'crazy!'
      e 'Commandline: invoking the crazy make mode next '\
        '(copy .h files after running "make")'
      require 'roebe/toplevel_methods/crazy_make_mode.rb'
      ::Roebe.crazy_make_mode
      exit_shell
    # ===================================================================== #
    # === dia --no-history
    # ===================================================================== #
    when *Roebe::Shell::ARRAY_ABBREVIATIONS_FOR_DISABLING_THE_HISTORY
      @hash_to_be_passed[:use_history] = false
    # ===================================================================== #
    # === dia --debug
    # ===================================================================== #
    when /^-?-?debug$/
      e 'We will debug for this instance of the Roebe::Shell.'
      @hash_to_be_passed[:enable_debug] = true
    # ===================================================================== #
    # === dia --run-method print_pwd
    # ===================================================================== #
    when '--run-method',
         '--runmethod',
         '--rmethod',
         '-run-method',
         '-runmethod',
         'rmethod',
         'runmethod',
         'run_method'
      _ = commandline_arguments?.join(' ')
      scanned = _.scan(
        /#{Regexp.quote(i)} (.+)/
      ).flatten.first
      @hash_to_be_passed[:be_quiet] = true
      @hash_to_be_passed[:skip_startup] = true
      @hash_to_be_passed[:run_this_method] = scanned
    # ===================================================================== #
    # === dia --silent-startup
    #
    # This entry point makes the Roebe::Shell less noisy. It will
    # be silently enabled.
    # ===================================================================== #
    when *Roebe::Shell::ARRAY_ABBREVIATIONS_FOR_THE_SILENT_START
      @hash_to_be_passed[:be_quiet] = true
    # ===================================================================== #
    # === dia --on-roebe
    # ===================================================================== #
    when /-?-?enable(-|_)?roebe/,
         /-?-?is(-|_)?on(-|_)?roebe/,
         /-?-?on(-|_)?roebe/,
         /-?-?roebe/
      e "#{rev}Enabling home-system support. Will thus include "\
        "all features."
      Roebe.is_on_roebe # This here enables "home-system support".
    else
      if File.exist? i.to_s # If the file exists, we assign it.
        @hash_to_be_passed[:assign_to_this_file] = File.absolute_path(i.to_s)
      elsif i.include?('--')
        e 'The commandline-argument `'+simp(i)+'` is unknown.'
      end
    end
  end
end

#menu(i = commandline_arguments? ) ⇒ Object

#

menu (menu tag)

#


242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/roebe/shell/commandline/commandline.rb', line 242

def menu(
    i = commandline_arguments?
  )
  if i.is_a? Array
    if i.empty?
      do_start_a_new_roebe_shell_instance
    else
      i.each {|entry| menu(entry) }
    end
  else
    case i # case tag
    # ===================================================================== #
    # === roebeshell --home-dir=
    #
    # This entry point allows us to set to a new default home directory
    # in use. This may be important for when you are in a restricted
    # environment, such as on a university campus.
    #
    # This requires a method defined in the file
    # roebe/shell/shell/constants.rb.
    #
    # Usage example:
    #
    #   roebeshell --home-dir=/opt
    #
    # ===================================================================== #
    when /-?-?home(_|-)?dir=(.+)/ # === $2
      _ = $2.to_s.dup
      require 'roebe/shell/shell/shell.rb'
      Roebe::Shell.permanently_set_home_dir(_)
    # ===================================================================== #
    # === dia --help?                                            (help tag)
    # ===================================================================== #
    when /-?-?help\??$/,
         /^-?-?options\??$/, # dia --options
         'OPTIONS' # Yield to use the available help-options.
      require 'roebe/shell/help/help.rb'
      Roebe::Shell.show_help
    # ===================================================================== #
    # === roebeshell --home-dir?
    # ===================================================================== #
    when /^-?-?home(_|-)?dir\??/ # Query the home directory in use.
      require 'roebe/shell/module_methods/report_where_the_home_directory_can_be_found.rb'
      ::Roebe::Shell.report_where_the_home_directory_can_be_found
    # ===================================================================== #
    # === roebeshell --extract
    #
    # This part of the menu can be invoked via:
    #
    #   roebeshell --extract /Depot/j/htop-2.2.0.tar.xz
    #   roebeshell --extract /Depot/jjjj/htop-3.1.2.tar.xz
    #
    # ===================================================================== #
    when /^-?-?extract$/,
         /^-?-?extract(_|-)?all$/,
         'ext'
      these_files = commandline_arguments?.last
      these_files = Dir['*'] if these_files.empty?
      # =================================================================== #
      # In commandline variant, we default to extracting to the current
      # working directory.
      # =================================================================== #
      extract_to  = (Dir.pwd+'/').squeeze('/')
      clear_commandline_arguments
      do_extract_these_files_to(these_files, extract_to)
      exit
    # ===================================================================== #
    # === roebeshell --yaml-directory?
    # ===================================================================== #
    when /-?-?yaml(_|-)?directory\??/
      e
      e sdir("  #{Roebe::Shell.project_yaml_directory?}")
      e
    else
      do_start_a_new_roebe_shell_instance
    end
  end
end

#reset ⇒ Object

#

reset (reset tag)

#


51
52
53
54
55
56
57
58
59
60
 
# File 'lib/roebe/shell/commandline/commandline.rb', line 51

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @hash_to_be_passed
  #
  # This hash is passed to the Roebe::Shell lateron.
  # ======================================================================= #
  @hash_to_be_passed = {}
end

#run ⇒ Object

#

run (run tag)

#


365
366
367
 
# File 'lib/roebe/shell/commandline/commandline.rb', line 365

def run
  menu
end