Class: Roebe::GenerateUnitFiles

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

Overview

Roebe::GenerateUnitFiles

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

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 = nil, run_already = true) ⇒ GenerateUnitFiles

#

initialize

#


52
53
54
55
56
57
58
59
60
61
 
# File 'lib/roebe/classes/generate_unit_files/generate_unit_files.rb', line 52

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

Class Method Details

.[](i = ARGV) ⇒ Object

#

[]

#


184
185
186
 
# File 'lib/roebe/classes/generate_unit_files/generate_unit_files.rb', line 184

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

Instance Method Details

#add(i = '', add_newline = true) ⇒ Object

#

add (add tag)

#


84
85
86
87
88
89
90
91
92
93
 
# File 'lib/roebe/classes/generate_unit_files/generate_unit_files.rb', line 84

def add(
    i           = '',
    add_newline = true # Whether to append a newline or not. By default we will.
  )
  if add_newline
    i = i.dup if i.frozen?
    i << N
  end
  @_ << i
end

#add_description(i) ⇒ Object

#

add_description

#


119
120
121
122
123
124
125
 
# File 'lib/roebe/classes/generate_unit_files/generate_unit_files.rb', line 119

def add_description(i)
  if i.frozen?
    i = i.dup
  end
  add 'Description='+i
  add
end

#add_header(i) ⇒ Object

#

add_header

#


98
99
100
101
102
103
104
105
106
107
 
# File 'lib/roebe/classes/generate_unit_files/generate_unit_files.rb', line 98

def add_header(i)
  i = i.dup if i.frozen?
  unless i.start_with? '['
    i.prepend '['
  end
  unless i.end_with? ']'
    i << ']'
  end
  add i
end

#add_key_value(key = 'ExecStart', value = '/usr/sbin/foo-daemon') ⇒ Object

#

add_key_value

#


130
131
132
133
134
 
# File 'lib/roebe/classes/generate_unit_files/generate_unit_files.rb', line 130

def add_key_value(
    key = 'ExecStart', value = '/usr/sbin/foo-daemon'
  )
  add key+'='+value
end

#add_newline ⇒ Object Also known as: nl

#

add_newline

#


112
113
114
 
# File 'lib/roebe/classes/generate_unit_files/generate_unit_files.rb', line 112

def add_newline
  add
end

#filename? ⇒ Boolean

#

filename?

#

Returns:

  • (Boolean) 


139
140
141
 
# File 'lib/roebe/classes/generate_unit_files/generate_unit_files.rb', line 139

def filename?
  @filename
end

#reset ⇒ Object

#

reset (reset tag)

#


66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/roebe/classes/generate_unit_files/generate_unit_files.rb', line 66

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # The next variable stores the filename of the file that is to be
  # generated.
  # ======================================================================= #
  @filename = 'example.service'
  # ======================================================================= #
  # The next instance variable is the one that holds the content of the
  # service-file.
  # ======================================================================= #
  @_ = ''.dup
end

#run ⇒ Object

#

run (run tag)

#


169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/roebe/classes/generate_unit_files/generate_unit_files.rb', line 169

def run
  add_header 'Unit'
  add_description 'Foo'
  add_header 'service'
  add_key_value 'ExecStart','/usr/sbin/foo-daemon'
  add_newline
  add_header 'Install'
  add_key_value 'WantedBy','multi-user-target'
  save_the_file
  show_the_file_content
end

#save_the_file ⇒ Object

#

save_the_file

#


146
147
148
149
150
151
 
# File 'lib/roebe/classes/generate_unit_files/generate_unit_files.rb', line 146

def save_the_file
  what = @_
  into = filename?
  opne "#{rev}Now storing into the file `#{sfile(into)}`."
  write_what_into(what, into)
end

#show_the_file_content ⇒ Object

#

show_the_file_content

#


156
157
158
159
160
161
162
163
164
 
# File 'lib/roebe/classes/generate_unit_files/generate_unit_files.rb', line 156

def show_the_file_content
  _ = filename?
  if File.exist? _
    opne 'The content of the file '+sfile(_)+' is:'
    e
    e File.read(_)
    e
  end
end