Class: Roebe::GenerateFluxboxAppsFile

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

Overview

Roebe::GenerateFluxboxAppsFile

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, #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, #olivedrab, #open_in_browser, #opne, #opnesystem, #opnn, #orange, #orchid, #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, #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) ⇒ GenerateFluxboxAppsFile

#

initialize

#


25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# File 'lib/roebe/classes/fluxbox/generate_fluxbox_apps_file.rb', line 25

def initialize(
    commandline_arguments = nil,
    run_already           = true
  )
  reset
  set_commandline_arguments(
    commandline_arguments
  )
  if block_given?
    yielded = yield
    case yielded
    when :be_silent, :be_quiet
      @be_verbose = false
    end
  end
  run if run_already
end

Class Method Details

.[](i = '') ⇒ Object

#

Roebe::GenerateFluxboxAppsFile[]

#


138
139
140
# File 'lib/roebe/classes/fluxbox/generate_fluxbox_apps_file.rb', line 138

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

Instance Method Details

#add(i) ⇒ Object

#

add

#


103
104
105
# File 'lib/roebe/classes/fluxbox/generate_fluxbox_apps_file.rb', line 103

def add(i)
  @_ << i+N
end

#autostart_these_programsObject

#

autostart_these_programs

#


87
88
89
90
91
# File 'lib/roebe/classes/fluxbox/generate_fluxbox_apps_file.rb', line 87

def autostart_these_programs
  YAML.load_file(
    FILE_AUTOSTART_THESE_PROGRAMS
  )
end

#build_up_the_main_stringObject

#

build_up_the_main_string

#


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/roebe/classes/fluxbox/generate_fluxbox_apps_file.rb', line 68

def build_up_the_main_string
  add comment_line
  add '# === Fluxbox-apps file'
  add '#'
  add '# This file was autogenerated by class Roebe::GenerateFluxboxAppsFile'
  add '# If you wish to autogenerate the file into the current working directory'
  add '# then you can use the following command to do so:'
  add '#'
  add '#   roebe --generate-fluxbox-apps-file'
  add '#'
  add comment_line
  autostart_these_programs.each {|this_program|
    add '[startup] {'+this_program+'}' 
  }
end

#comment_lineObject

#

comment_line

#


96
97
98
# File 'lib/roebe/classes/fluxbox/generate_fluxbox_apps_file.rb', line 96

def comment_line
  '# '+('='*76)+' #'
end

#display_the_main_stringObject

#

display_the_main_string

#


59
60
61
62
63
# File 'lib/roebe/classes/fluxbox/generate_fluxbox_apps_file.rb', line 59

def display_the_main_string
  e 'The following string will be saved:'
  e
  e gold(@_)
end

#resetObject

#

reset (reset tag)

#


46
47
48
49
50
51
52
53
54
# File 'lib/roebe/classes/fluxbox/generate_fluxbox_apps_file.rb', line 46

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @_
  # ======================================================================= #
  @_ = ''.dup # This is the String that will be generated.
  @be_verbose = true
end

#runObject

#

run (run tag)

#


129
130
131
132
133
# File 'lib/roebe/classes/fluxbox/generate_fluxbox_apps_file.rb', line 129

def run
  build_up_the_main_string
  display_the_main_string if @be_verbose
  store_the_apps_file
end

#store_the_apps_fileObject

#

store_the_apps_file

#


110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
# File 'lib/roebe/classes/fluxbox/generate_fluxbox_apps_file.rb', line 110

def store_the_apps_file
  what = @_
  into = 'apps'
  # ======================================================================= #
  # On my home system I will directly generate into my home directory,
  # and the .fluxbox entry there.
  # ======================================================================= #
  if is_on_roebe? # roebe --fluxbox-apps
    into = home_dir?+'.fluxbox/'.dup
    mkdir(into) unless File.directory? into # Ensure that the directory exists.
    into << 'apps'
  end
  opne rev+'Saving into `'+sfile(into)+'`.'
  write_what_into(what, into)
end