Class: Studium::Exams::ExamTopics

Inherits:
Base
  • Object
show all
Defined in:
lib/studium/exams/exam_topics.rb

Overview

Studium::Exams::ExamTopics

Constant Summary collapse

NAMESPACE =
#

NAMESPACE

#
inspect
FILE_EXAM_TOPICS =
#

FILE_EXAM_TOPICS

#
'exam_topics.md'

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) ⇒ ExamTopics

#

initialize

#


40
41
42
43
44
45
46
47
 
# File 'lib/studium/exams/exam_topics.rb', line 40

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

Class Method Details

.[](i = '') ⇒ Object

#

Studium::Exams::ExamTopics[]

#


192
193
194
 
# File 'lib/studium/exams/exam_topics.rb', line 192

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

Instance Method Details

#ask_random_question_from_this_array(array) ⇒ Object

#

ask_random_question_from_this_array

#


130
131
132
133
 
# File 'lib/studium/exams/exam_topics.rb', line 130

def ask_random_question_from_this_array(array)
  sample = array.sample
  ::Studium::Exams::ExamQuestion.new(sample)
end

#determine_whether_the_exam_topics_file_exists ⇒ Object

#

determine_whether_the_exam_topics_file_exists

#


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

def determine_whether_the_exam_topics_file_exists
  unless File.exist? @check_this_location_for_the_exam_topics_file
    unless @check_this_location_for_the_exam_topics_file.include? '/'
      # =================================================================== #
      # In this case, simply use the next upcoming exam.
      # =================================================================== #
      _ = return_local_path_of_this_pwdstud(1)+
          File.basename(@check_this_location_for_the_exam_topics_file)
      if File.exist? _
        set_main_file(_)
      else
        notify_the_user_that_no_exam_topic_file_could_be_found(_)
      end
    else
      notify_the_user_that_no_exam_topic_file_could_be_found
    end
  end
end

#file_cd_aliases? ⇒ Boolean

#

file_cd_aliases?

#

Returns:

  • (Boolean) 


123
124
125
 
# File 'lib/studium/exams/exam_topics.rb', line 123

def file_cd_aliases?
  FILE_CD_ALIASES
end

#menu(i = commandline_arguments? ) ⇒ Object

#

menu (menu tag)

#


138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/studium/exams/exam_topics.rb', line 138

def menu(
    i = commandline_arguments?
  )
  if i.is_a? Array
    i.each {|entry| menu(entry) }
  else
    case i # case tag
    # ===================================================================== #
    # === exam_topics --help
    # ===================================================================== #
    when /help/
      show_help
      exit
    # ===================================================================== #
    # === exam_topics --debug
    # ===================================================================== #
    when /debug$/
      @debug = true
    else
      # =================================================================== #
      # The next clause will handle numbers that are passed to this class.
      # =================================================================== #
      if i.to_s =~ /^(\d+)$/ # Only numbers as input.
        _ = return_local_path_of_this_pwdstud($1)+
            FILE_EXAM_TOPICS
        set_main_file(_)
      end
    end
  end
end

#notify_the_user_that_no_exam_topic_file_could_be_found(i = @check_this_location_for_the_exam_topics_file) ⇒ Object

#

notify_the_user_that_no_exam_topic_file_could_be_found

#


103
104
105
106
107
108
109
110
 
# File 'lib/studium/exams/exam_topics.rb', line 103

def notify_the_user_that_no_exam_topic_file_could_be_found(
    i = @check_this_location_for_the_exam_topics_file
  )
  e 'No exam-topics file could be found at:'
  e
  e "  #{sfancy(i)}"
  e
end

#reset ⇒ Object

#

reset (reset tag)

#


52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/studium/exams/exam_topics.rb', line 52

def reset
  super()
  # ======================================================================= #
  # === @namespace
  # ======================================================================= #
  @namespace = NAMESPACE
  # ======================================================================= #
  # === @debug
  # ======================================================================= #
  @debug = false
  # ======================================================================= #
  # === @check_this_location_for_the_exam_topics_file
  # ======================================================================= #
  @check_this_location_for_the_exam_topics_file = FILE_EXAM_TOPICS
  determine_whether_the_exam_topics_file_exists
end

#run ⇒ Object

#

run (run tag)

#


172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/studium/exams/exam_topics.rb', line 172

def run
  menu
  if File.exist? @check_this_location_for_the_exam_topics_file
    dataset = file_readlines(@check_this_location_for_the_exam_topics_file).reject {|line|
      line.strip.empty?
    }.map {|line|
      line.delete!('-')
      line.strip
    }
    if @debug
      opnn; e 'The complete dataset is:'
      pp dataset
    end
    ask_random_question_from_this_array(dataset)
  end
end

#set_main_file(i = FILE_EXAM_TOPICS) ⇒ Object

#

set_main_file

#


72
73
74
75
76
 
# File 'lib/studium/exams/exam_topics.rb', line 72

def set_main_file(
    i = FILE_EXAM_TOPICS
  )
  @check_this_location_for_the_exam_topics_file = i.to_s.dup
end

#show_help ⇒ Object

#

show_help (help tag)

#


115
116
117
118
 
# File 'lib/studium/exams/exam_topics.rb', line 115

def show_help
  e 'Input the full path to the file `'+sfile(FILE_EXAM_TOPICS)+'` in'
  e 'order to read it.'
end