Class: Studium::Curriculum

Inherits:
Base
  • Object
show all
Defined in:
lib/studium/curricula/curriculum.rb

Overview

Studium::Curriculum

Constant Summary collapse

NAMESPACE =
#

NAMESPACE

#
inspect

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

Studium::Colours::COLOURS

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

#

initialize

#


28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/studium/curricula/curriculum.rb', line 28

def initialize(
    optional_use_this_curriculum_file = nil,
    run_already                       = true
  )
  reset
  if optional_use_this_curriculum_file
    load_this_curriculum_file(optional_use_this_curriculum_file)
  end
  if block_given?
    yielded = yield
    case yielded
    when :filter_for_steop_lectures
      filter_for_steop_lectures
    end
  end
  run if run_already
end

Instance Method Details

#dataset? ⇒ Boolean

#

dataset?

#

Returns:

  • (Boolean) 


193
194
195
 
# File 'lib/studium/curricula/curriculum.rb', line 193

def dataset?
  @dataset
end

#filter_away_solved_lectures ⇒ Object

#

filter_away_solved_lectures

This method will filter away (aka remove) lectures that have already been solved.

#


180
181
182
183
184
185
186
187
188
 
# File 'lib/studium/curricula/curriculum.rb', line 180

def filter_away_solved_lectures
  @dataset.reject! {|a, b|
    if b.has_key? :already_solved
      b[:already_solved]
    else
      false
    end
  }
end

#filter_for_steop_lectures ⇒ Object

#

filter_for_steop_lectures

This filter will keep only lectures that are STEOP lectures.

#


135
136
137
138
139
140
141
142
143
 
# File 'lib/studium/curricula/curriculum.rb', line 135

def filter_for_steop_lectures
  if @dataset
    selection = @dataset.select {|a, b|
      b.has_key?(:is_a_steop_lecture) and
      (b[:is_a_steop_lecture] == true)
    }
    @dataset = selection
  end
end

#lectures? ⇒ Boolean

#

lectures?

#

Returns:

  • (Boolean) 


163
164
165
 
# File 'lib/studium/curricula/curriculum.rb', line 163

def lectures?
  @dataset.keys
end

#load_this_curriculum_file(i = :ktww) ⇒ Object

#

load_this_curriculum_file

#


73
74
75
76
77
78
79
 
# File 'lib/studium/curricula/curriculum.rb', line 73

def load_this_curriculum_file(
    i = :ktww
  )
  @dataset = read_dataset_from_a_curriculum_file(i) { :remove_comments }
  map_dataset_to_real_entries_in_the_file_lecture
  turn_this_dataset_into_a_hash
end

#map ⇒ Object

#

map

#


170
171
172
 
# File 'lib/studium/curricula/curriculum.rb', line 170

def map
  yield if block_given?
end

#map_dataset_to_real_entries_in_the_file_lecture ⇒ Object

#

map_dataset_to_real_entries_in_the_file_lecture

This method will replace the Strings in the @dataset variable with the full entry from the file lecture_information.

#


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/studium/curricula/curriculum.rb', line 98

def map_dataset_to_real_entries_in_the_file_lecture
  @dataset.map! {|this_lecture_as_string|
    this_lecture_as_string.squeeze!(' ')
    this_lecture_as_string.strip!
    if @dataset_from_the_file_lecture_information.has_key? this_lecture_as_string
      {
        this_lecture_as_string =>
          @dataset_from_the_file_lecture_information[this_lecture_as_string]
      }
    else
      opnn; e "No key called "\
              "#{royalblue(this_lecture_as_string)}"\
              " could be found."
      exit if shall_we_exit_on_missing_key?
    end
  }
end

#merge(i) ⇒ Object

#

merge

This method can be used to merge two Curricula entries together.

It will do a replacement as-is.

#


152
153
154
155
156
157
158
 
# File 'lib/studium/curricula/curriculum.rb', line 152

def merge(i)
  if i.is_a? Studium::Curriculum
    @dataset.update(i.dataset?)
  else
    raise 'can only merge classes belonging to Studium::Curriculum'
  end
end

#n_entries? ⇒ Boolean

#

n_entries?

#

Returns:

  • (Boolean) 


126
127
128
 
# File 'lib/studium/curricula/curriculum.rb', line 126

def n_entries?
  @dataset.size
end

#reset ⇒ Object

#

reset

#


49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/studium/curricula/curriculum.rb', line 49

def reset
  super()
  # ======================================================================= #
  # === @namespace
  # ======================================================================= #
  @namespace = NAMESPACE
  # ======================================================================= #
  # === @dataset
  # ======================================================================= #
  @dataset = nil # Must be nil initially.
  # ======================================================================= #
  # === @shall_we_exit_on_missing_key
  # ======================================================================= #
  @shall_we_exit_on_missing_key = false
  # ======================================================================= #
  # === @dataset_from_the_file_lecture_information
  # ======================================================================= #
  @dataset_from_the_file_lecture_information =
    return_dataset_from_the_file_lecture_information 
end

#run ⇒ Object

#

run

#


200
201
 
# File 'lib/studium/curricula/curriculum.rb', line 200

def run
end

#shall_we_exit_on_missing_key? ⇒ Boolean

#

shall_we_exit_on_missing_key?

#

Returns:

  • (Boolean) 


119
120
121
 
# File 'lib/studium/curricula/curriculum.rb', line 119

def shall_we_exit_on_missing_key?
  @shall_we_exit_on_missing_key
end

#turn_this_dataset_into_a_hash ⇒ Object

#

turn_this_dataset_into_a_hash

#


84
85
86
87
88
89
90
 
# File 'lib/studium/curricula/curriculum.rb', line 84

def turn_this_dataset_into_a_hash
  new_hash = {}
  @dataset.each {|hash|
    new_hash.update(hash)
  }
  @dataset = new_hash
end