Class: Studium::Exams::CreateCsvPassedExamsFile

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

Overview

Studium::CreateCsvPassedExamsFile

Constant Summary collapse

NAMESPACE =
#

NAMESPACE

#
inspect
CSV_SEPARATOR_TOKEN_TO_USE =
#

CSV_SEPARATOR_TOKEN_TO_USE

#
'|'

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

#

initialize

#


51
52
53
54
55
56
57
58
 
# File 'lib/studium/exams/csv/create_csv_passed_exams_file.rb', line 51

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

Class Method Details

.[](i = '') ⇒ Object

#

Studium::Exams::CreateCsvPassedExamsFile[]

#


217
218
219
 
# File 'lib/studium/exams/csv/create_csv_passed_exams_file.rb', line 217

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

Instance Method Details

#build_up_the_main_hash ⇒ Object

#

build_up_the_main_hash

#


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
 
# File 'lib/studium/exams/csv/create_csv_passed_exams_file.rb', line 175

def build_up_the_main_hash
  if input_came_from_the_file_lecture_information?
    # ===================================================================== #
    # In this case, we have to query the internal hash for the
    # necessary information.
    # ===================================================================== #
    @dataset.each_pair {|name_of_the_lecture, internal_hash|
      already_solved = internal_hash[:already_solved]
      if already_solved == true
        already_solved_at = internal_hash[:already_solved_at]
        # We must simplify the name of the lecture in this
        # case.
        if name_of_the_lecture.include? ' '
          name_of_the_lecture = name_of_the_lecture.split(' ')[1..-1].join(' ')
        end
        @hash[name_of_the_lecture] = already_solved_at
      end 
    }
  else
    @dataset.each {|line|
      splitted = line.split(CSV_SEPARATOR_TOKEN_TO_USE).map {|inner_line|
        inner_line.strip
      }
      name_of_the_lecture      = splitted.last # This is the name of the lecture
      exam_passed_at_this_date = splitted.first
      @hash[name_of_the_lecture] = exam_passed_at_this_date
    }
  end
end

#create_a_new_csv_file ⇒ Object

#

create_a_new_csv_file

#


162
163
164
165
166
167
168
169
170
 
# File 'lib/studium/exams/csv/create_csv_passed_exams_file.rb', line 162

def create_a_new_csv_file
  what = ''.dup
  @hash.to_a.each {|a, b|
    what << "#{a}#{CSV_SEPARATOR_TOKEN_TO_USE}#{b}#{N}"
  }
  into = 'exams_passed.csv'
  opnn; e 'Saving into `'+sfile(into)+'`.'
  write_what_into(what, into)
end

#input? ⇒ Boolean

#

input?

#

Returns:

  • (Boolean) 


131
132
133
 
# File 'lib/studium/exams/csv/create_csv_passed_exams_file.rb', line 131

def input?
  @input
end

#input_came_from_the_file_lecture_information? ⇒ Boolean

#

input_came_from_the_file_lecture_information?

#

Returns:

  • (Boolean) 


108
109
110
 
# File 'lib/studium/exams/csv/create_csv_passed_exams_file.rb', line 108

def input_came_from_the_file_lecture_information?
  @use_input_from == :lecture_information
end

#main_token? ⇒ Boolean

#

main_token?

#

Returns:

  • (Boolean) 


155
156
157
 
# File 'lib/studium/exams/csv/create_csv_passed_exams_file.rb', line 155

def main_token?
  CSV_SEPARATOR_TOKEN_TO_USE
end

#reset ⇒ Object

#

reset (reset tag)

#


63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/studium/exams/csv/create_csv_passed_exams_file.rb', line 63

def reset
  super()
  # ======================================================================= #
  # === @namespace
  # ======================================================================= #
  @namespace = NAMESPACE
  # ======================================================================= #
  # === @hash
  # ======================================================================= #
  @hash = {} # This is the main hash.
  # ======================================================================= #
  # === @use_input_from
  # ======================================================================= #
  @use_input_from = :csv_file # Can be :csv_file or :lecture_information.
  if use_input_from_csv_file? and File.exist?(FILE_PASSED_EXAMS_PER_MONTH)
    @dataset = readlines_with_default_encoding(FILE_PASSED_EXAMS_PER_MONTH)
  else
    @use_input_from = :lecture_information
    dataset = return_dataset_from_the_file_lecture_information
    dataset.select! {|a,b|
      b.has_key?(:already_solved) and
      (b[:already_solved] == true)
    }
    @dataset = dataset
  end
end

#run ⇒ Object

#

run (run tag)

#


208
209
210
211
212
 
# File 'lib/studium/exams/csv/create_csv_passed_exams_file.rb', line 208

def run
  try_to_sanitize_the_main_dataset
  build_up_the_main_hash
  create_a_new_csv_file
end

#set_input(i = '') ⇒ Object

#

set_input

#


122
123
124
125
126
 
# File 'lib/studium/exams/csv/create_csv_passed_exams_file.rb', line 122

def set_input(i = '')
  i = i.first if i.is_a? Array
  i = i.to_s.dup
  @input = i
end

#toggle ⇒ Object

#

toggle

This method can be used to quickly toggle between the two main modes described on top of this file.

#


96
97
98
99
100
101
102
103
 
# File 'lib/studium/exams/csv/create_csv_passed_exams_file.rb', line 96

def toggle
  case @use_input_from
  when :csv_file
    @use_input_from = :lecture_information
  else
    @use_input_from = :csv_file
  end
end

#try_to_sanitize_the_main_dataset ⇒ Object

#

try_to_sanitize_the_main_dataset

Clean up the dataset. This is only required for when our input is a .csv file, as otherwise we could use the file called “lecture_information.yml”.

#


142
143
144
145
146
147
148
149
150
 
# File 'lib/studium/exams/csv/create_csv_passed_exams_file.rb', line 142

def try_to_sanitize_the_main_dataset
  if @dataset
    if input_came_from_a_csv_file?
      @dataset.reject! {|line|
        line.strip.empty? or line.strip.start_with?('#')
      }
    end
  end
end

#use_input_from_csv_file? ⇒ Boolean Also known as: input_came_from_a_csv_file?

#

use_input_from_csv_file?

#

Returns:

  • (Boolean) 


115
116
117
 
# File 'lib/studium/exams/csv/create_csv_passed_exams_file.rb', line 115

def use_input_from_csv_file?
  @use_input_from == :csv_file
end