Class: Roebe::GenerateFstabFile

Inherits:
Base show all
Defined in:
lib/roebe/classes/generate_fstab_file/generate_fstab_file.rb

Overview

Roebe::GenerateFstabFile

Constant Summary collapse

USE_THIS_YAML_FILE =
#

USE_THIS_YAML_FILE

bl $RUBY_SRC/roebe/lib/roebe/yaml/fstab/fstab.yml

#
"#{Roebe.project_yaml_directory?}fstab/fstab.yml"
DEFAULT_FSTAB_LOCATION =
#

DEFAULT_FSTAB_LOCATION

#
'/etc/fstab'

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 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, #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

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

Constructor Details

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

#

initialize

#


68
69
70
71
72
73
74
75
76
77
 
# File 'lib/roebe/classes/generate_fstab_file/generate_fstab_file.rb', line 68

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

Class Method Details

.[](i = '') ⇒ Object

#

Roebe::GenerateFstabFile[]

#


247
248
249
 
# File 'lib/roebe/classes/generate_fstab_file/generate_fstab_file.rb', line 247

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

Instance Method Details

#do_run_the_necessary_steps_for_creating_the_fstab_file(i = { with_this: @dataset }) ⇒ Object

#

do_run_the_necessary_steps_for_creating_the_fstab_file

#


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
 
# File 'lib/roebe/classes/generate_fstab_file/generate_fstab_file.rb', line 100

def do_run_the_necessary_steps_for_creating_the_fstab_file(
    i = { with_this: @dataset }
   )
  if i.is_a? Hash
    # ===================================================================== #
    # === :with_this
    # ===================================================================== #
    if i.has_key? :with_this
      i = i[:with_this]
    end
  end
  # ======================================================================= #
  # Past this point assume that "i" is a Hash.
  #
  # A typical key-value pair looks like this:
  #
  #   "/dev/sda1"=>["/Mount/USB1", "vfat auto,noatime,shortname=mixed 0 0"]
  #
  # ======================================================================= #
  _ = ''.dup
  @biggest_ljust_value = i.keys.sort.reverse.first.size+1
  i.each_pair {|name_of_the_device, inner_array|
    if inner_array.size < 2
      ewarn 'Something seems wrong with the Array - there are too few entries.'
      e 'Showing the Array next:'
      e
      pp inner_array
      e
    end
    last_entry = inner_array.last.squeeze(' ')
    if last_entry.include? ' '
      last_entry = last_entry.split(' ').map {|entry|
        entry.strip.ljust(12)
      }
      # =================================================================== #
      # This array now looks like so:
      #
      #   ["ext4        ", "defaults    ", "1           ", "1           "]
      #
      # =================================================================== #
      last_entry[1] = last_entry[1].ljust(35)
      last_entry = last_entry.join(' ')
    end
    _ << name_of_the_device.ljust(@biggest_ljust_value)
    _ << inner_array.first.ljust(13)
    _ << last_entry
    _ << "\n\n"
  }
  into = File.absolute_path('fstab')
  show_the_content(_)
  report_where_the_new_file_will_be_stored(into)
  write_what_into(_, into)
  pwd = return_pwd
  if is_on_roebe? and pwd.include?('/Mount')
    # ===================================================================== #
    # Move it into /etc/ in this case.
    # ===================================================================== #
    move_file(into, '/etc/fstab')
  end
end

#menu(i = commandline_arguments? ) ⇒ Object

#

menu (menu tag)

#


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
 
# File 'lib/roebe/classes/generate_fstab_file/generate_fstab_file.rb', line 191

def menu(
    i = commandline_arguments?
  )
  if i.is_a? Array
    i.each {|entry| menu(entry) }
  else
    case i # case tag
    # ===================================================================== #
    # === rfstab --help
    # ===================================================================== #
    when /-?-?help/
      show_help
      exit
    # ===================================================================== #
    # === rfstab --append-DVD
    # ===================================================================== #
    when /-?-?append(-|_)?dvd/i
      what = "
# =========================================================================== #
# === /Mount/DVD/
#
# Specify where to mount DVDs at. This refers to normal DVDs that tend
# to be bundled into desktop computer systems; external DVD burners
# =========================================================================== #
/dev/sr0       /Mount/DVD        udf,iso9660 defaults,ro,users,noexec,auto 0 0

"

      onto = '/etc/fstab'
      e rev+'Appending onto `'+sfile(onto)+'` next.'
      append_what_onto(what, onto)
      exit
    end
  end
end

#report_where_the_new_file_will_be_stored(into) ⇒ Object

#

report_where_the_new_file_will_be_stored

#


164
165
166
 
# File 'lib/roebe/classes/generate_fstab_file/generate_fstab_file.rb', line 164

def report_where_the_new_file_will_be_stored(into)
  opne "Storing the new fstab-entries into the file `#{sfile(into)}`."
end

#reset ⇒ Object

#

reset (reset tag)

#


82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/roebe/classes/generate_fstab_file/generate_fstab_file.rb', line 82

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @biggest_ljust_value
  #
  # This variable will determine the most important padding to be
  # used lateron, when creating the actual fstab-file.
  #
  # This is nil initially because its true value will be determined
  # at a later point.
  # ======================================================================= #
  @biggest_ljust_value = nil
end

#run ⇒ Object

#

run (run tag)

#


230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/roebe/classes/generate_fstab_file/generate_fstab_file.rb', line 230

def run
  menu
  # ======================================================================= #
  # Read in the information from our main YAML file next:
  # ======================================================================= #
  yaml_file = USE_THIS_YAML_FILE
  if File.exist? yaml_file # Always check whether the file exists.
    @dataset = YAML.load_file(yaml_file)
    do_run_the_necessary_steps_for_creating_the_fstab_file(with_this: @dataset)
  else
    opnn; no_file_exists_at(yaml_file)
  end
end

#show_help ⇒ Object

#

show_help

#


181
182
183
184
185
186
 
# File 'lib/roebe/classes/generate_fstab_file/generate_fstab_file.rb', line 181

def show_help
  e 'The following help options are documented so far:'
  e
  e '  --append-dvd # Append only /Mount/DVD to the existing /etc/fstab file'
  e
end

#show_the_content(i) ⇒ Object

#

show_the_content

#


171
172
173
174
175
176
 
# File 'lib/roebe/classes/generate_fstab_file/generate_fstab_file.rb', line 171

def show_the_content(i)
  opne sfancy('The file to be generated will look like this:')
  e
  e tomato(i.strip)
  e
end