Class: Studium::WeeklySchedule

Inherits:
Base
  • Object
show all
Defined in:
lib/studium/utility_scripts/weekly_schedule.rb

Overview

Studium::WeeklySchedule

Constant Summary collapse

NAMESPACE =
#

NAMESPACE

#
inspect
BASE_DIR =
#

BASE_DIR

#
'/home/x/STUDIUM/YAML/WS2016/'

Constants inherited from Base

Base::ARRAY_HTML_COLOURS_IN_USE, Base::CHECK_FOR_INCORRECT_ENTRIES_IN_THE_QUESTION_ANSWER_FILE_THAT_SHOULD_BE_COMMENTS, Base::COLOURS, Base::COMMON_YEAR_DAYS_IN_MONTH, Base::GRAY, Base::LEFT_PADDING, Base::N_CHARACTERS_PER_LINE, Base::UNICODE_RIGHT_ARROW

Constants included from Colours

Colours::COLOURS

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#add_proper_year_entry_to_this_line, #already_solved_this_lva_number?, #append_what_into, #available_topics_as_short_name, #average_grade, #bachelor_master_or_diploma, #be_silent, #be_verbose?, #beautiful_url, #change_directory, #cheering_person, #cliner, #colour_for_ects_points, #colourize_percentage, #commandline_arguments?, #commandline_arguments_joined, #commandline_arguments_with_hyphens?, #convert_this_array_of_lectures_into_the_full_dataset, #copy, #cpruby, #create_directory, #create_file, #csv_file?, #current_month?, #datum?, #day_month_year, #debug?, #delete_file, #directory_of_the_exam_topics?, #directory_to_my_exam_topics, #directory_to_the_exam_topics?, #disable_colours, #disable_colours_globally, #do_not_be_verbose, #do_not_use_opn, #do_these_curricula_include_both_a_bachelor_and_a_master_curriculum?, #does_this_line_include_a_german_weekday?, #does_this_line_include_a_html_colour?, #e, #ecomment, #editor?, #ee, #enable_colours, #enable_colours_globally, #enable_debug, #encoding?, #english_to_german_weekday, #ensure_main_encoding, #ensure_that_the_log_directory_exists, #eparse, #erev, #esystem, #etomato, #exit_program, #expand_topic, #extract_dd_mm_yyyy, #file_lecture_information?, #file_read_with_proper_encoding, #filter_away_invalid_questions, #find_corresponding_exam_topic, #first_argument?, #first_non_hyphen_argument?, #from_curriculum_id_to_university, #german_date_notation, #german_weekday?, #german_weekdays?, #has_a_bachelor_curriculum?, #has_a_master_curriculum?, #has_this_exam_topic_been_solved?, #has_year_entry?, #hh_mm_ss_dd_mm_yyyy, #horizontal_bar?, #html_log_directory?, #is_a_master_lecture?, #is_a_weekday?, #is_connected_to_the_www?, #is_on_roebe?, #is_prüfungsimmanent?, #is_this_a_valid_html_colour?, #is_this_day_today?, #konsole_support?, #last_file?, #lectures_from_indi1, #lectures_from_indi2, #lectures_from_indi3, #lectures_from_indi4, #lectures_from_the_bachelor_genetik_curriculum, #lectures_from_the_individual_vektor_curricula, #load_yaml_dataset, #move_file, #n_days_difference_from_today_to_this_day, #no_ext_name, #no_file_at, #number_to_month, #obtain, #obtain_lectures_from_this_curriculum, #open_in_editor, #path_to_exam_topic?, #read_dataset_from_a_curriculum_file, #read_in_exam_dataset_from_this_file, #read_this_file_with_default_encoding, #readlines_from_this_input_file, #register_sigint, #remove_empty_strings, #remove_escape_sequences, #remove_internal_comments, #remove_leading_comments, #remove_leading_weekday_names_from, #remove_newlines, #remove_tags_from_this_input, #rename_kde_konsole_tab, #rename_konsole_tab?, #replace_all_html_colours_in_this, #replace_bold_token_with_default_colour, #replace_italic_token_with_default_colour, #replace_italic_token_with_this_colour, #replace_regular_numbers_with_unicode_numbers, #replace_underline_token_with_default_colour, #replace_underline_token_with_this_colour, #return_all_bachelor_lectures, #return_all_exams_on_this_day, #return_all_numbers_from, #return_all_registered_curricula, #return_all_steop_lectures, #return_current_year, #return_dataset_for_this_topic, #return_dataset_from_this_curriculum_file, #return_dd_mm_yy_and_time_from, #return_directory_for, #return_ects_points_from_these_lectures, #return_either_grey_or_the_custom_colour_for_answers, #return_either_grey_or_the_custom_colour_for_questions, #return_file_for_this_curriculum, #return_german_name_for_this_english_month, #return_german_weekday_of?, #return_hh_mm_ss_from, #return_hour_from_this, #return_lectures_from_bachelor_vektor_curriculum, #return_lectures_with_at_the_least_one_upcoming_exam, #return_local_path_of_this_pwdstud, #return_lva_number_of_this_lecture, #return_month_fitting_to_this_input, #return_n_days_until_monday, #return_n_days_until_sunday, #return_n_exam_questions_in, #return_n_questions_were_answered_for_this_topic, #return_name_of_the_weekday, #return_name_of_this_curriculum, #return_name_of_this_curriculum_based_on_its_id_number, #return_opnn, #return_passed_courses, #return_pwd, #return_random_curriculum, #return_sanitized_dataset_from_the_file_lecture_information, #return_solved_lectures, #return_steop_lectures, #return_the_remote_homepage_url, #return_this_line_has_n_characters_as_html_colour_tags, #return_title_from_this_curriculum_file, #rev, #right_arrow?, #rinstall2, #roebe_exam_directory?, #ruby_src_dir_at_home?, #runmode?, #sanitize_this_topic, #sanitize_url, #select_lectures_with_this_key, #set_be_quiet, #set_be_verbose, #set_commandline_arguments, #set_commandline_mode, #set_runmode, #set_this_cd_alias_to, #set_www_mode, #sfancy, #shall_we_make_use_of_unicode_symbols?, #show_todays_date, #simp, #sort_these_lecture_names_by_time, #spacer, #swarn, #this_month_has_n_days?, #total_ects_points_passed, #translate_dd_mm_yyyy_to_weekday, #try_to_require_the_rcfiles, #turn_this_array_into_the_full_dataset, #unicode_blocks_line, #use_colours?, #use_opn?, #vertical_bar?, #web_liner, #weekday?, #weekdays?, #word_wrap, #write_what_into, #www_connection_is_unavailable, #www_mode?, #yaml_dir?

Methods included from Colours

#bold_blue, #bold_red, #bold_yellow, #cadetblue, #chartreuse, crimson, #darkgray, darkgreen, darkseagreen, deepskyblue, #deepskyblue, default_colour, #dimgray, disable_colours, #dodgerblue, e, #efancy, enable_colours, #ewarn, #forestgreen, gold, #grey, lightblue, lightgreen, #lightslategray, #lightsteelblue, #mediumorchid, #mediumseagreen, #oldlace, #olivedrab, orange, orangered, #orchid, palevioletred, #papayawhip, rev, royalblue, sdir, #sdir, sfancy, #sfancy, sfile, #sfile, simp, #simp, slateblue, steelblue, #steelblue, #swarn, swarn, #teal, turquoise, use_colours?, use_this_colour_for_exam_answers, use_this_colour_for_exam_questions, #yellow

Constructor Details

#initialize(i = nil, run_already = true) ⇒ WeeklySchedule

#

initialize

#


40
41
42
43
44
45
46
 
# File 'lib/studium/utility_scripts/weekly_schedule.rb', line 40

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

Class Method Details

.[](i = '') ⇒ Object

#

Studium::WeeklySchedule[]

#


201
202
203
 
# File 'lib/studium/utility_scripts/weekly_schedule.rb', line 201

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

Instance Method Details

#base_dir? ⇒ Boolean

#

base_dir?

#

Returns:

  • (Boolean) 


73
74
75
 
# File 'lib/studium/utility_scripts/weekly_schedule.rb', line 73

def base_dir?
  BASE_DIR
end

#display_the_week ⇒ Object

#

display_the_week

#


115
116
117
118
119
120
121
122
 
# File 'lib/studium/utility_scripts/weekly_schedule.rb', line 115

def display_the_week
  show_all_lectures_on(:monday)
  show_all_lectures_on(:tuesday)
  show_all_lectures_on(:wednesday)
  show_all_lectures_on(:thursday)
  show_all_lectures_on(:friday)
  show_all_lectures_on(:saturday)
end

#hash? ⇒ Boolean Also known as: dataset?

#

hash?

#

Returns:

  • (Boolean) 


59
60
61
 
# File 'lib/studium/utility_scripts/weekly_schedule.rb', line 59

def hash?
  @hash
end

#load_the_yaml_dataset ⇒ Object

#

load_the_yaml_dataset

#


80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/studium/utility_scripts/weekly_schedule.rb', line 80

def load_the_yaml_dataset
  return_all_yaml_files.each {|file|
    hash = {}
    splitted = File.basename(file).gsub(/\.yml$/,'').split('_')
    id, *name_of_the_lecture = splitted
    name_of_the_lecture = name_of_the_lecture.flatten.join('_')
    dataset = YAML.load_file(file)
    # ===================================================================== #
    # We must turn the key and value pairs into ISO Encoding.
    # ===================================================================== #
    dataset.dup.each_pair {|key, value|
      key.capitalize! if key == 'tage'
      hash[key] = value
    }
    hash['Titel'] = name_of_the_lecture
    _ = {}
    id = id.to_s # The ID must be a String because some IDs are like "950.222"
    _[id] = hash
    @hash.update(_) 
  }
end

#notify_the_user_about_the_base_directory ⇒ Object

#

notify_the_user_about_the_base_directory

#


105
106
107
108
109
110
 
# File 'lib/studium/utility_scripts/weekly_schedule.rb', line 105

def notify_the_user_about_the_base_directory
  opnn; e 'We will use the base directory:'
  e
  e '    '+sdir(base_dir?)
  e
end

#opnn ⇒ Object

#

opnn

#


185
186
187
 
# File 'lib/studium/utility_scripts/weekly_schedule.rb', line 185

def opnn
  super(NAMESPACE)
end

#report_all_lectures_for_this_dataset(this_day, report_this_array) ⇒ Object

#

report_all_lectures_for_this_dataset

#


166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/studium/utility_scripts/weekly_schedule.rb', line 166

def report_all_lectures_for_this_dataset(this_day, report_this_array)
  if report_this_array.empty?
    e 'No lectures on '+simp(this_day)+'.'
  else
    # ===================================================================== #
    # Ok, we did find entries on this day.
    # ===================================================================== #
    e 'There are lectures on `'+simp(this_day)+'`.'
    report_this_array.each {|the_lecture_id, titel, priority|
      e '  The ID is '+
         limegreen(the_lecture_id.to_s)+' '+khaki(titel)+
         ', Priority: '+simp(priority.to_s)
    }
  end
end

#reset ⇒ Object

#

reset (reset tag)

#


51
52
53
54
 
# File 'lib/studium/utility_scripts/weekly_schedule.rb', line 51

def reset
  super()
  @hash = {}
end

#return_all_yaml_files ⇒ Object

#

return_all_yaml_files

#


66
67
68
 
# File 'lib/studium/utility_scripts/weekly_schedule.rb', line 66

def return_all_yaml_files
  Dir[BASE_DIR+'*.yml']
end

#run ⇒ Object

#

run (run tag)

#


192
193
194
195
196
 
# File 'lib/studium/utility_scripts/weekly_schedule.rb', line 192

def run
  load_the_yaml_dataset
  notify_the_user_about_the_base_directory
  display_the_week
end

#show_all_lectures_on(this_day = :monday) ⇒ Object

#

show_all_lectures_on

We will show all lectures on the given day.

#


136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/studium/utility_scripts/weekly_schedule.rb', line 136

def show_all_lectures_on(this_day = :monday)
  dataset = dataset?
  this_day = this_day.to_s.capitalize
  the_lecture_id = nil
  titel = ''
  priority = 0
  report_this_array = []
  dataset.each_pair {|lecture_id, inner_hash|
    the_lecture_id = lecture_id
    titel = dataset[lecture_id].fetch('Titel')
    priority = dataset[lecture_id].fetch('Priorität')
    tage = inner_hash.fetch('Tage') # Fetch the days here.
    results = tage.select {|entry|
      _ = Roebe::WochentagAnzeiger.return_english_weekday(entry)
      _ == this_day
    }
    if results.empty?
      # Found nothing.
    else # else append it to the main array
      report_this_array << [
        the_lecture_id, titel, priority
      ]
    end
  }
  report_all_lectures_for_this_dataset(this_day, report_this_array)
end

#today? ⇒ Boolean

#

today?

#

Returns:

  • (Boolean) 


127
128
129
 
# File 'lib/studium/utility_scripts/weekly_schedule.rb', line 127

def today?
  ::Studium.today?
end