Class: Studium::SyncStudiumRelevantEntriesOneLevelDownwards

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

Overview

require 'sync_studium_relevant_entries_one_level_downwards'; SyncStudiumRelevantEntriesOneLevelDownwards.new

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

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(run_already = true) ⇒ SyncStudiumRelevantEntriesOneLevelDownwards

#

initialize

#


53
54
55
56
57
58
 
# File 'lib/studium/utility_scripts/sync_studium_relevant_entries_one_level_downwards.rb', line 53

def initialize(
    run_already = true
  )
  reset
  run if run_already
end

Instance Method Details

#_(i = '') ⇒ Object

#

_

This method will accept two instructions:

(1) tostud
(2) newstud

tostud is just a cd-alias that will allow us to move to the respective directory.

newstud will delegate to Studium::NewStud[], and set a new study point.

#


162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/studium/utility_scripts/sync_studium_relevant_entries_one_level_downwards.rb', line 162

def _(i = '')
  case i # case tag
  when /^tostud/
    cd(i) # We only go from here
  when /newstud(\d+)/
    if may_we_continue?
      number = $1.to_s
      Studium::NewStud[number]
    else
      opnn; e 'Some error happened. Please fix this error first before'
      opnn; e 'we can continue.'
      exit
    end
  end
end

#backup_old_exams_file ⇒ Object

#

backup_old_exams_file

#


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

def backup_old_exams_file
  Studium.backup_old_exams_file
end

#cd(i) ⇒ Object

#

cd (cd tag)

#


129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/studium/utility_scripts/sync_studium_relevant_entries_one_level_downwards.rb', line 129

def cd(i)
  i = CD_ALIASES[i]
  i = CD_ALIASES[i] # Try again.
  i << '/' unless i.end_with? '/'
  begin
    i.gsub!(/^cd /,'') if i.include? 'cd '
    i.gsub!(/; pwd/,'')
  rescue; end
  i.strip!
  if Dir.exist?(i)
    opnn; e "Now cd-ing into `#{sdir(i)}`."
    cd(i)
  else
    opnn; e "We can not cd into `#{sdir(i)}` "\
            "as that directory does not exist."
    @may_we_continue = false
  end
end

#correct_the_entries_in_exams_yaml_file ⇒ Object

#

correct_the_entries_in_exams_yaml_file

#


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
213
214
215
 
# File 'lib/studium/utility_scripts/sync_studium_relevant_entries_one_level_downwards.rb', line 188

def correct_the_entries_in_exams_yaml_file
  _ = Studium.file_exams?
  if File.exist? _
    opnn; e 'Now reading in the dataset of '+sfile(_)+'.'
    opnn; e 'We will replace all (number) entries with a '+simp('-1')+' entry.'
    new_dataset = ''
    # ===================================================================== #
    # Next, read in the dataset into an Array.
    # ===================================================================== #
    dataset = File.readlines(_)
    dataset.each {|line|
      if line.include? '(' and line.include? ')'
        regex_to_use = /(\(\d+\))/ # See http://rubular.com/r/tsol2UZ5jP
        if line =~ regex_to_use
          old_number = ($1.to_s.dup.delete('(').delete(')').to_i - 1)
          if old_number == 0
            old_number = '' # Will be purged.
          end
          line.gsub!(/#{$1.to_s.dup}/, old_number.to_s)
          line.gsub!(/\(\)/, '') # And we also purge "()" entries.
        end
      end 
      new_dataset << line
    }
    backup_old_exams_file
    save_dataset(new_dataset)
  end
end

#may_we_continue? ⇒ Boolean

#

may_we_continue?

#

Returns:

  • (Boolean) 


181
182
183
 
# File 'lib/studium/utility_scripts/sync_studium_relevant_entries_one_level_downwards.rb', line 181

def may_we_continue?
  @may_we_continue
end

#report_that_we_have_finished ⇒ Object

#

report_that_we_have_finished

#


106
107
108
 
# File 'lib/studium/utility_scripts/sync_studium_relevant_entries_one_level_downwards.rb', line 106

def report_that_we_have_finished
  opnn; e 'All done now.'
end

#report_what_we_will_do ⇒ Object

#

report_what_we_will_do

#


74
75
76
 
# File 'lib/studium/utility_scripts/sync_studium_relevant_entries_one_level_downwards.rb', line 74

def report_what_we_will_do
  opnn; e 'Now syncing all older entries one level downwards.'
end

#reset ⇒ Object

#

reset (reset tag)

#


63
64
65
66
67
68
69
 
# File 'lib/studium/utility_scripts/sync_studium_relevant_entries_one_level_downwards.rb', line 63

def reset
  super()
  # ======================================================================= #
  # === @may_we_continue
  # ======================================================================= #
  @may_we_continue = true
end

#run ⇒ Object

#

run

#


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

def run # (run tag)
  report_what_we_will_do
  _ 'tostud2'
  _ 'newstud1'
  _ 'tostud3'
  _ 'newstud2'
  _ 'tostud4'
  _ 'newstud3'
  _ 'tostud5'
  _ 'newstud4'
  _ 'tostud6'
  _ 'newstud5'
  _ 'tostud7'
  _ 'newstud6'
  _ 'tostud8'
  _ 'newstud7'
  _ 'tostud9'
  _ 'newstud8'
  report_that_we_have_finished
  correct_the_entries_in_exams_yaml_file if on_roebe?
end

#save_dataset(dataset) ⇒ Object

#

save_dataset

#


113
114
115
116
117
 
# File 'lib/studium/utility_scripts/sync_studium_relevant_entries_one_level_downwards.rb', line 113

def save_dataset(dataset)
  into = Studium.file_exams?
  opnn; e "Now saving into #{sfile(into)}."
  write_what_into(dataset, into)
end