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

Constants inherited from Base

Base::COMMON_YEAR_DAYS_IN_MONTH, Base::LEFT_PADDING, Base::NAMESPACE, Base::N_CHARACTERS_PER_LINE

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, #be_silent, #be_verbose?, #beautiful_url, #change_directory, #cheering_person, #chmod, #cliner, #colour_for_ects_points, #colourize_percentage, #convert_this_array_of_lectures_into_the_full_dataset, #copy, #course_filter, #cpruby, #create_directory, #create_file, #csv_file?, #current_month?, #current_semester?, #dataset?, #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?, #does_this_line_include_an_english_weekday?, #does_this_line_start_with_a_german_weekday?, #e, #ecomment, #editor?, #ee, #egrey, #enable_colours, #enable_colours_globally, #enable_debug, #encoding?, #english_to_german_weekday, #ensure_that_a_base_directory_exists_for_this_file, #ensure_that_the_log_directory_exists, #eparse, #esystem, #etomato, #exit_program, #extract_dd_mm_yyyy, #fetch_this_curriculum, #file_important_exams?, #file_lecture_information?, #file_passed_exams_per_month, #file_read_with_proper_encoding, #filter_away_already_answered_questions, #filter_away_invalid_questions, #filter_for_all_passed_exams, #find_corresponding_exam_topic, #from_curriculum_id_to_university, #german_date_notation, #german_weekday?, #german_weekdays?, #german_weekend_for?, #german_yes_or_no, #has_a_bachelor_and_a_master_curriculum?, #has_a_bachelor_curriculum?, #has_a_master_curriculum?, #has_lva_dates_registered?, #has_this_exam_topic_been_solved?, #has_year_entry?, #hh_mm_ss_dd_mm_yyyy, #horizontal_bar?, #html_log_directory?, #infer_the_namespace, #initialize_the_internal_hash, #internal_hash?, #is_a_master_lecture?, #is_a_registered_curriculum?, #is_a_weekday?, #is_connected_to_the_www?, #is_german_weekday?, #is_on_roebe?, #is_prüfungsimmanent?, #is_this_a_registered_exam_topic?, #is_this_a_valid_html_colour?, #is_this_day_today?, #is_this_lecture_a_practical_course?, #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, #left_arrow?, #load_yaml_dataset, #map_input_to_this_curriculum_filename, #move_file, #n_days_difference_from_today_to_this_day, #n_seconds_to_n_days, #namespace?, #no_ext_name, #no_file_exists_at, #number_to_month, #obtain, #obtain_lectures_from_this_curriculum, #open_in_browser, #open_in_editor, #opne, #opnerev, #opnn, #padded_current_month?, #parse_dd_mm_yyyy, #parse_this_line_for_date_entry, #path_to_exam_topic?, #project_yaml_directory?, #rds, #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, #require_open_uri, #reset_the_internal_state, #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, #right_arrow?, #rinstall2, #roebe_exam_directory?, #roebe_path_to_file_lecture_information?, #ruby_src_dir_at_home?, #sanitize_this_topic, #sanitize_url, #select_for_prüfungsimmanente_LVs, #select_lectures_with_this_key, #set_be_verbose, #set_this_cd_alias_to, #set_xorg_buffer, #sfancy, #shall_we_make_use_of_unicode_symbols?, #show_todays_date, #silently_open_in_browser, #simp, #sort_these_lecture_names_by_time, #spacer, #studium_log_dir?, #this_month_has_n_days?, #total_ects_points_passed, #translate_dd_mm_yyyy_to_weekday, #try_to_require_html_templates, #try_to_require_the_open_gem, #try_to_require_the_rcfiles, #try_to_require_the_verbose_truth_gem, #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, #yaml_dir?, #yellowrev, #yes_or_no

Methods included from RunmodeModule

#commandline?, #runmode?, #set_commandline_mode, #set_runmode, #set_www_mode, #www_mode?

Methods included from CommandlineArgumentsModule

#commandline_arguments?, #commandline_arguments_joined, #commandline_arguments_with_hyphens?, #commandline_arguments_without_leading_hyphens?, #first_argument?, #first_non_hyphen_argument?, #reset_the_commandline_arguments, #set_commandline_arguments, #set_first_argument

Methods included from HtmlColoursModule

#aquamarine, #blanchedalmond, #brown, #cadetblue, #chocolate, #coral, #cornflowerblue, #crimson, #cyan, #darkblue, #darkcyan, #darkgoldenrod, #darkgreen, #darkkhaki, #darkolivegreen, #darkorange, #darkred, #darkseagreen, #darkslateblue, #darkslategray, #darkturquoise, #deepskyblue, #firebrick, #forestgreen, #gold, #goldenrod, #green, #grey, #indianred, #khaki, #lavender, #lawngreen, #lightblue, #lightcoral, #lightgreen, #lightred, #lightseagreen, #lightskyblue, #lightslategray, #lightslategrey, #lime, #limegreen, #mediumaquamarine, #mediumblue, #mediumpurple, #mediumseagreen, #mediumslateblue, #mediumspringgreen, #mediumturquoise, #mediumvioletred, #mintcream, #moccasin, #oldlace, #olive, #olivedrab, #orange, #orangered, #orchid, #palegoldenrod, #palegreen, #paleturquoise, #palevioletred, #peru, #plum, #powderblue, #red, #rosybrown, #royalblue, #saddlebrown, #salmon, #sandybrown, #seagreen, #sienna, #silver, #skyblue, #slateblue, #slategray, #springgreen, #steelblue, #tan, #teal, #thistle, #tomato, #turquoise, #violet, #whitesmoke, #yellow, #yellowgreen

Methods included from Colours

#bold_blue, #bold_red, #bold_yellow, cadetblue, #cadetblue, #chartreuse, #coral, coral, #cornflowerblue, cornflowerblue, crimson, #cyan, cyan, darkgoldenrod, #darkgoldenrod, #darkgray, darkgreen, darkolivegreen, darkseagreen, #darkslateblue, darkslateblue, #darkslategray, darkslategray, #darkturquoise, darkturquoise, #deepskyblue, deepskyblue, default_colour, #dimgray, disable_colours, #dodgerblue, e, #efancy, enable_colours, #erev, #ewarn, #forestgreen, forestgreen, gold, #goldenrod, goldenrod, #grey, grey, indianred, #indianred, khaki, #khaki, lawngreen, #lawngreen, lightblue, lightgreen, lightsalmon, #lightseagreen, lightseagreen, lightskyblue, #lightskyblue, #lightslategray, lightslategray, #lightsteelblue, lime, #lime, limegreen, #limegreen, #mediumaquamarine, mediumaquamarine, #mediumorchid, #mediumpurple, mediumpurple, #mediumseagreen, mediumseagreen, #mediumslateblue, mediumslateblue, #mediumspringgreen, mediumspringgreen, #mediumturquoise, mediumturquoise, #oldlace, olive, #olive, olivedrab, #olivedrab, orange, orangered, #orchid, orchid, palegreen, #palegreen, paleturquoise, #paleturquoise, palevioletred, #papayawhip, peru, #peru, plum, #plum, #powderblue, powderblue, rev, #rev?, royalblue, saddlebrown, #saddlebrown, #sandybrown, sandybrown, sdir, #sdir, seagreen, #seagreen, sfancy, #sfancy, sfile, #sfile, #simp, simp, #skyblue, skyblue, slateblue, #slategray, slategray, springgreen, #springgreen, #steelblue, steelblue, #swarn, swarn, #tan, tan, teal, #teal, #tomato, tomato, turquoise, use_colours?, use_this_colour_for_exam_answers, use_this_colour_for_exam_questions, #yellow, yellowgreen, #yellowgreen

Constructor Details

#initialize(run_already = true) ⇒ SyncStudiumRelevantEntriesOneLevelDownwards

#

initialize

#


48
49
50
51
52
53
 
# File 'lib/studium/utility_scripts/sync_studium_relevant_entries_one_level_downwards.rb', line 48

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.

#


158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/studium/utility_scripts/sync_studium_relevant_entries_one_level_downwards.rb', line 158

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
      opne 'Some error happened. Please fix this error first before'
      opne 'we can continue.'
      exit
    end
  end
end

#backup_old_exams_file ⇒ Object

#

backup_old_exams_file

#


118
119
120
 
# File 'lib/studium/utility_scripts/sync_studium_relevant_entries_one_level_downwards.rb', line 118

def backup_old_exams_file
  Studium.backup_old_exams_file
end

#cd(i) ⇒ Object

#

cd (cd tag)

#


125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/studium/utility_scripts/sync_studium_relevant_entries_one_level_downwards.rb', line 125

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)
    opne "Now cd-ing into `#{sdir(i)}`."
    cd(i)
  else
    opne "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

#


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

def correct_the_entries_in_exams_yaml_file
  _ = Studium.file_exams?
  if File.exist? _
    opne 'Now reading in the dataset of '+sfile(_)+'.'
    opne '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) 


177
178
179
 
# File 'lib/studium/utility_scripts/sync_studium_relevant_entries_one_level_downwards.rb', line 177

def may_we_continue?
  @may_we_continue
end

#report_that_we_have_finished ⇒ Object

#

report_that_we_have_finished

#


102
103
104
 
# File 'lib/studium/utility_scripts/sync_studium_relevant_entries_one_level_downwards.rb', line 102

def report_that_we_have_finished
  opne 'All done now.'
end

#report_what_we_will_do ⇒ Object

#

report_what_we_will_do

#


70
71
72
 
# File 'lib/studium/utility_scripts/sync_studium_relevant_entries_one_level_downwards.rb', line 70

def report_what_we_will_do
  opne 'Now syncing all older entries one level downwards.'
end

#reset ⇒ Object

#

reset (reset tag)

#


58
59
60
61
62
63
64
65
 
# File 'lib/studium/utility_scripts/sync_studium_relevant_entries_one_level_downwards.rb', line 58

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

#run ⇒ Object

#

run

#


77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/studium/utility_scripts/sync_studium_relevant_entries_one_level_downwards.rb', line 77

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

#


109
110
111
112
113
 
# File 'lib/studium/utility_scripts/sync_studium_relevant_entries_one_level_downwards.rb', line 109

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