Class: Roebe::DayCalendar

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

Overview

Roebe::DayCalendar

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(i = nil, run_already = true) ⇒ DayCalendar

#

initialize

#


34
35
36
37
38
39
40
41
# File 'lib/roebe/classes/day_calendar.rb', line 34

def initialize(
    i           = nil,
    run_already = true
  )
  reset
  set_input(i)
  run if run_already
end

Class Method Details

.[](i = '') ⇒ Object

#

[]

#


145
146
147
# File 'lib/roebe/classes/day_calendar.rb', line 145

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

Instance Method Details

#input?Boolean

#

input?

#

Returns:

  • (Boolean)


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

def input?
  @input
end

#is_a_weekend_day?(name_of_the_day_in_german) ⇒ Boolean

#

is_a_weekend_day?

This will return true for Saturday and Sunday.

#

Returns:

  • (Boolean)


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

def is_a_weekend_day?(name_of_the_day_in_german)
  %w( Samstag Sonntag ).include? name_of_the_day_in_german
end

#output_result?Boolean

#

output_result?

#

Returns:

  • (Boolean)


62
63
64
# File 'lib/roebe/classes/day_calendar.rb', line 62

def output_result?
  @output_result
end

#resetObject

#

reset (reset tag)

#


46
47
48
49
50
51
52
53
54
55
56
57
# File 'lib/roebe/classes/day_calendar.rb', line 46

def reset
  super()
  @show_n_days_into_the_future = 180
  @hash = {} # The main hash.
  # ======================================================================= #
  # If the following is set to true, then we will also include treating
  # saturday and sundays - which normally is pointless in regular
  # university courses.
  # ======================================================================= #
  @also_use_weekend_days = false
  @output_result = true # if true then we will show the days.
end

#return_dd_mm_yyy_notation_from_time_object(time_object) ⇒ Object

#

return_dd_mm_yyy_notation_from_time_object

#


85
86
87
88
89
# File 'lib/roebe/classes/day_calendar.rb', line 85

def return_dd_mm_yyy_notation_from_time_object(time_object)
  time_object.day.to_s.rjust(2,'0')+'.'+
  time_object.month.to_s.rjust(2,'0')+'.'+
  time_object.year.to_s.rjust(4,' ')
end

#runObject

#

run (run tag)

#


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

def run
  run_main_loop
end

#run_main_loopObject

#

run_main_loop

#


122
123
124
125
126
127
128
129
130
131
132
133
# File 'lib/roebe/classes/day_calendar.rb', line 122

def run_main_loop
  time_now = Time.now
  n_days   = @show_n_days_into_the_future
  counter  =  0
  loop {
    counter += 1
    show_this_day_in_a_nicely_formatted_manner(time_now)
    @hash[return_dd_mm_yyy_notation_from_time_object(time_now)] = []
    time_now += ONE_DAY # Add a day to this.
    break if counter >= n_days
  }
end

#set_input(i = '') ⇒ Object

#

set_input

#


69
70
71
72
73
# File 'lib/roebe/classes/day_calendar.rb', line 69

def set_input(i = '')
  i = i.first if i.is_a? Array
  i = i.to_s.dup
  @input = i
end

#show_this_day_in_a_nicely_formatted_manner(time_object) ⇒ Object

#

show_this_day_in_a_nicely_formatted_manner

#


103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# File 'lib/roebe/classes/day_calendar.rb', line 103

def show_this_day_in_a_nicely_formatted_manner(time_object)
  name_of_the_day_in_german = Roebe.return_german_weekday(time_object).dup
  if is_a_weekend_day?(name_of_the_day_in_german) and
     !@also_use_weekend_days
  else
    result = (name_of_the_day_in_german+',').ljust(11)
    # ===================================================================== #
    # Next, add the specific day in DD.MM.YYYY notation.
    # ===================================================================== #
    result << ' '+lightgreen(
      return_dd_mm_yyy_notation_from_time_object(time_object)
    )
    e result if output_result?
  end
end