Class: Roebe::TerminalPS1

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

Overview

Roebe::TerminalPS1

Constant Summary collapse

TARGET_FILE =
#

TARGET_FILE

We will generate the string into the following file.

#
'/AUTOGENERATED/ps1_rc'

Constants inherited from Base

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

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(use_this_colour = Colours.html_colours.sample, run_already = true) ⇒ TerminalPS1

#

initialize

#


28
29
30
31
32
33
34
35
 
# File 'lib/roebe/classes/terminal_ps1.rb', line 28

def initialize(
    use_this_colour = Colours.html_colours.sample,
    run_already     = true
  )
  reset
  set_use_this_colour(use_this_colour)
  run if run_already
end

Instance Method Details

#default_file? ⇒ Boolean

#

default_file?

#

Returns:

  • (Boolean) 


92
93
94
 
# File 'lib/roebe/classes/terminal_ps1.rb', line 92

def default_file?
  TARGET_FILE
end

#generate_the_main_string ⇒ Object

#

generate_the_main_string

#


78
79
80
 
# File 'lib/roebe/classes/terminal_ps1.rb', line 78

def generate_the_main_string
  @main_string << 'export PS1=$'+which_colour?.upcase+"'$(pwd)/'$CLOSING_TAG$WHITE"+N
end

#main_string? ⇒ Boolean

#

main_string?

#

Returns:

  • (Boolean) 


85
86
87
 
# File 'lib/roebe/classes/terminal_ps1.rb', line 85

def main_string?
  @main_string
end

#report_which_colour_will_be_used ⇒ Object

#

report_which_colour_will_be_used

#


109
110
111
112
 
# File 'lib/roebe/classes/terminal_ps1.rb', line 109

def report_which_colour_will_be_used
  opne "The colour that is to be used is: "\
          "#{::Colours.send(@use_this_colour, @use_this_colour)}"
end

#reset ⇒ Object

#

reset

#


40
41
42
43
44
 
# File 'lib/roebe/classes/terminal_ps1.rb', line 40

def reset
  super()
  infer_the_namespace
  @main_string = ''.dup # <- This String will be saved into the file.
end

#return_random_html_colour ⇒ Object

#

return_random_html_colour

#


64
65
66
 
# File 'lib/roebe/classes/terminal_ps1.rb', line 64

def return_random_html_colour
  Colours.html_colours.sample
end

#run ⇒ Object

#

run

#


117
118
119
120
121
 
# File 'lib/roebe/classes/terminal_ps1.rb', line 117

def run
  generate_the_main_string
  report_which_colour_will_be_used
  store_the_main_string
end

#set_use_this_colour(i = :random) ⇒ Object

#

set_use_this_colour

#


49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/roebe/classes/terminal_ps1.rb', line 49

def set_use_this_colour(i = :random)
  if i.is_a? Array
    i = i.first
  end
  i = :random if i.nil?
  case i
  when :random,'random','rand'
    i = return_random_html_colour
  end
  @use_this_colour = i
end

#store_the_main_string ⇒ Object

#

store_the_main_string

#


99
100
101
102
103
104
 
# File 'lib/roebe/classes/terminal_ps1.rb', line 99

def store_the_main_string
  into = default_file?
  what = main_string?
  opne "Now storing into `#{sfile(into)}`."
  write_what_into(what, into)
end

#use_this_colour? ⇒ Boolean Also known as: which_colour?

#

use_this_colour?

#

Returns:

  • (Boolean) 


71
72
73
 
# File 'lib/roebe/classes/terminal_ps1.rb', line 71

def use_this_colour?
  @use_this_colour
end