Class: Studium::Vorbesprechungen

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

Overview

Studium::Vorbesprechungen

Constant Summary collapse

NAMESPACE =
#

NAMESPACE

#
inspect
REGEX_FOR_NOT_OPTIMAL_UHR_POSITION =
#

REGEX_FOR_NOT_OPTIMAL_UHR_POSITION

#
/\d{1,2}:\d{1,2}-\d{1,2}:\d{1,2},/
N_LJUST_NAME_OF_THE_LECTURE =
#

N_LJUST_NAME_OF_THE_LECTURE

#
92

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, #base_dir?, #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, #opnn, #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) ⇒ Vorbesprechungen

#

initialize

#


43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/studium/utility_scripts/vorbesprechungen.rb', line 43

def initialize(
    i           = nil,
    run_already = true
  )
  reset
  set_commandline_arguments(i)
  if block_given?
    yielded = yield
    case yielded
    when :do_not_report_anything
      @do_report = false
    end
  end
  run if run_already
end

Class Method Details

.[](i = '') ⇒ Object

#

Studium::Vorbesprechungen[]

#


268
269
270
 
# File 'lib/studium/utility_scripts/vorbesprechungen.rb', line 268

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

Instance Method Details

#consider_applying_a_filter_to_the_main_dataset ⇒ Object

#

consider_applying_a_filter_to_the_main_dataset

#


217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/studium/utility_scripts/vorbesprechungen.rb', line 217

def consider_applying_a_filter_to_the_main_dataset
  if @limit_showing_vorbesprechungs_termine_up_to_this_day
    filter_on = Time.parse(@limit_showing_vorbesprechungs_termine_up_to_this_day)+
                (ONE_DAY - 1)
    @dataset.select! {|name_of_the_lecture, inner_dataset|
      vorbesprechungs_time = inner_dataset['vorbesprechung']
      if vorbesprechungs_time.include? ','
        vorbesprechungs_time = vorbesprechungs_time.split(',').first
      end
      vorbesprechungs_time = Time.parse(vorbesprechungs_time)
      vorbesprechungs_time < filter_on # Filter it away.
    }
  end
end

#menu(i = commandline_arguments?) ) ⇒ Object

#

menu (menu tag)

#


99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/studium/utility_scripts/vorbesprechungen.rb', line 99

def menu(i = commandline_arguments?)
  if i.is_a? Array
    i.each {|entry| menu(entry) }
  else
    case i # case tag
    # ===================================================================== #
    # === vor "until 05.10.2018"
    # ===================================================================== #
    when /until (\d{1,2}\.\d{1,2}\.\d{4})/
      set_limit_to_this_day($1.to_s.dup)
    # ===================================================================== #
    # === vorbesprechung --help
    # ===================================================================== #
    when /-?-?help/i
      show_help
      exit
    end
  end
end

#report ⇒ Object

#

report

#


235
236
237
238
239
240
 
# File 'lib/studium/utility_scripts/vorbesprechungen.rb', line 235

def report
  # ======================================================================= #
  # We should sort this within the following method.
  # ======================================================================= #
  show_these_vorbesprechungen(@dataset)
end

#reset ⇒ Object

#

reset (reset tag)

#


62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/studium/utility_scripts/vorbesprechungen.rb', line 62

def reset
  super()
  # ======================================================================= #
  # === @namespace
  # ======================================================================= #
  @namespace = NAMESPACE
  # ======================================================================= #
  # === @limit_showing_vorbesprechungs_termine_up_to_this_day
  # ======================================================================= #
  @limit_showing_vorbesprechungs_termine_up_to_this_day = nil
  # ======================================================================= #
  # === @do_report
  # ======================================================================= #
  @do_report = true
  # ======================================================================= #
  # === @dataset_from_the_file_lecture_information
  # ======================================================================= #
  @dataset_from_the_file_lecture_information =
    return_dataset_from_the_file_lecture_information
  select_all_preliminary_meetings_entries
end

#run ⇒ Object

#

run (run tag)

#


259
260
261
262
263
 
# File 'lib/studium/utility_scripts/vorbesprechungen.rb', line 259

def run
  menu
  consider_applying_a_filter_to_the_main_dataset
  report if @do_report
end

#select_all_preliminary_meetings_entries ⇒ Object

#

select_all_preliminary_meetings_entries

The purpose of this method is to select all entries that have the String key called 'vorbesprechung'.

#


90
91
92
93
94
 
# File 'lib/studium/utility_scripts/vorbesprechungen.rb', line 90

def select_all_preliminary_meetings_entries
  @dataset = @dataset_from_the_file_lecture_information.select {|name, dataset|
    dataset.has_key? 'vorbesprechung'
  }
end

#set_limit_to_this_day(i) ⇒ Object

#

set_limit_to_this_day

#


122
123
124
 
# File 'lib/studium/utility_scripts/vorbesprechungen.rb', line 122

def set_limit_to_this_day(i)
  @limit_showing_vorbesprechungs_termine_up_to_this_day = i
end

#show_help ⇒ Object

#

show_help (help tag)

To invoke this method, try:

vor --help
#


134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/studium/utility_scripts/vorbesprechungen.rb', line 134

def show_help
  help_string = <<-EOF

The following options are available and documented:

vor "until 05.10.2018" # filter preliminatory meeting dates
                       # up until (and including) that day

EOF
  e help_string
end

#show_these_vorbesprechungen(i) ⇒ Object

#

show_these_vorbesprechungen

The input to this method should be a Hash.

#


151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/studium/utility_scripts/vorbesprechungen.rb', line 151

def show_these_vorbesprechungen(i)
  e
  opnn; e "Folgende #{sfancy(i.keys.size)}"\
          " Vorbesprechungstermine sind fixiert:"
  e
  # ======================================================================= #
  # We must first sort it by time.
  # ======================================================================= #
  sorted = i.sort_by {|name_of_the_lecture, hash_dataset|
    date_of_vorbesprechung = hash_dataset['vorbesprechung']
    if date_of_vorbesprechung.is_a? Array
      date_of_vorbesprechung = date_of_vorbesprechung.first
    end
    modified_date_of_vorbesprechung = date_of_vorbesprechung.delete(',')
    if modified_date_of_vorbesprechung.include? 'Ort'
      modified_date_of_vorbesprechung = modified_date_of_vorbesprechung.split('Ort').first.strip
    end
    Time.parse(
      modified_date_of_vorbesprechung
    )
  }
  # ======================================================================= #
  # Next, display these "vorbesprechungs"-dates:
  # ======================================================================= #
  sorted.each {|name_of_the_lecture, hash_dataset|
    date_of_vorbesprechung = hash_dataset['vorbesprechung']
    if date_of_vorbesprechung.is_a? Array
      date_of_vorbesprechung = date_of_vorbesprechung.first
    end
    unless date_of_vorbesprechung.end_with? ' Uhr'
      if date_of_vorbesprechung .frozen?
        date_of_vorbesprechung = date_of_vorbesprechung.dup
      end
      if date_of_vorbesprechung =~ REGEX_FOR_NOT_OPTIMAL_UHR_POSITION
        date_of_vorbesprechung.sub!(
          /(\d{1,2}:\d{1,2}-\d{1,2}:\d{1,2}),/,
          '\1 Uhr,'
        )
      end
      date_of_vorbesprechung << ' Uhr' unless date_of_vorbesprechung.include? ' Uhr'
    end
    date_of_vorbesprechung = remove_leading_weekdays(date_of_vorbesprechung)
    weekday = return_name_of_the_weekday(date_of_vorbesprechung)
    unless date_of_vorbesprechung.include? weekday
      date_of_vorbesprechung.prepend(
        weekday.ljust(11)
      )
    end
    padded_name_of_the_lecture = name_of_the_lecture.ljust(N_LJUST_NAME_OF_THE_LECTURE)
    colourized_date_of_vorbesprechung = date_of_vorbesprechung.sub!(
      /(\d{1,2}\.\d{1,2}\.\d{4})/, springgreen('\1')+lightskyblue
    )
    # ===================================================================== #
    # And finally, report our results to the user, on the commandline.
    # ===================================================================== #
    e '  '+
      slateblue(padded_name_of_the_lecture)+
      ' '+
      lightskyblue(colourized_date_of_vorbesprechung)
  }
  e
end

#vorbesprechungen? ⇒ Boolean

#

vorbesprechungen?

#

Returns:

  • (Boolean) 


245
246
247
248
249
250
251
252
253
254
 
# File 'lib/studium/utility_scripts/vorbesprechungen.rb', line 245

def vorbesprechungen?
  matches = @dataset.map {|name_of_the_lecture, inner_hash_dataset|
    _ = inner_hash_dataset['vorbesprechung']
    if _.include? ','
      new_entry = _.split(',').first
      _ = remove_leading_weekdays(new_entry)
    end
  }
  return matches
end