Class: Studium::GenerateSpreadsheet
- Inherits:
-
Base
- Object
- Base
- Studium::GenerateSpreadsheet
show all
- Defined in:
- lib/studium/utility_scripts/generate_spreadsheet/misc.rb,
lib/studium/utility_scripts/generate_spreadsheet/generate_spreadsheet.rb
Overview
Studium::GenerateSpreadsheet
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
Class Method Summary
collapse
-
.[](i = '') ⇒ Object
# === Studium::GenerateSpreadsheet[] ========================================================================= #.
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
#commandline?, #runmode?, #set_commandline_mode, #set_runmode, #set_www_mode, #www_mode?
#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
#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(commandline_arguments = nil, run_already = true) ⇒ GenerateSpreadsheet
49
50
51
52
53
54
55
56
57
58
59
|
# File 'lib/studium/utility_scripts/generate_spreadsheet/generate_spreadsheet.rb', line 49
def initialize(
commandline_arguments = nil,
run_already = true
)
reset
set_commandline_arguments(
commandline_arguments
)
sanitize_commandline_arguments
run if run_already
end
|
Class Method Details
.[](i = '') ⇒ Object
#
Studium::GenerateSpreadsheet[]
#
344
345
346
|
# File 'lib/studium/utility_scripts/generate_spreadsheet/generate_spreadsheet.rb', line 344
def self.[](i = '')
new(i)
end
|
Instance Method Details
#check_for_the_availability_of_the_main_gem ⇒ Object
#
check_for_the_availability_of_the_main_gem
#
63
64
65
66
67
|
# File 'lib/studium/utility_scripts/generate_spreadsheet/misc.rb', line 63
def check_for_the_availability_of_the_main_gem
if Object.const_defined? :Axlsx
@can_we_continue = true
end
end
|
#consider_opening_the_generated_file ⇒ Object
#
consider_opening_the_generated_file (open tag)
#
32
33
34
35
36
37
38
39
|
# File 'lib/studium/utility_scripts/generate_spreadsheet/misc.rb', line 32
def consider_opening_the_generated_file
if is_on_roebe?
begin
require 'open'
Open.in_editor(@generate_this_file)
rescue LoadError; end
end
end
|
#consider_removing_the_old_file(i = @generate_this_file) ⇒ Object
#
consider_removing_the_old_file
#
44
45
46
47
48
49
50
51
|
# File 'lib/studium/utility_scripts/generate_spreadsheet/misc.rb', line 44
def consider_removing_the_old_file(
i = @generate_this_file
)
if File.exist?(i) and i.end_with?('.xlsx')
e "#{rev}Deleting the file #{sfile(i)} next." if is_on_roebe?
File.delete(i)
end
end
|
#create_new_spreadsheet_instance ⇒ Object
#
create_new_spreadsheet_instance
#
56
57
58
|
# File 'lib/studium/utility_scripts/generate_spreadsheet/misc.rb', line 56
def create_new_spreadsheet_instance
@p = Axlsx::Package.new
end
|
#horizontal_center ⇒ Object
99
100
101
|
# File 'lib/studium/utility_scripts/generate_spreadsheet/generate_spreadsheet.rb', line 99
def horizontal_center
return { horizontal: :center }
end
|
#main_file? ⇒ Boolean
337
338
339
|
# File 'lib/studium/utility_scripts/generate_spreadsheet/generate_spreadsheet.rb', line 337
def main_file?
@generate_this_file
end
|
#
Don’t forget to add new entries to this menu.
#
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
# File 'lib/studium/utility_scripts/generate_spreadsheet/misc.rb', line 103
def (
i = commandline_arguments?
)
if i.is_a? Array
i.each {|entry| (entry) }
else
case i.to_s
when /^-?-?help/i
show_help
exit
when /^-?-?Bachelorcurriculum(-|_| )?Informatik(-|_| )?und(-|_| )?molekulare(-|_| )?Biologie$/i,
/^-?-?indi1$/i
@dataset = Studium.load_this_yaml_file(:indi1)
when /^-?-?indi2$/i
@dataset = Studium.load_this_yaml_file(:indi2)
when /^-?-?indi3$/i,
/^-?-?Bachelorcurriculum(-|_| )?Informatik(-|_| )?und(-|_| )?molekulare(-|_| )?Biologie$/i
@dataset = Studium.load_this_yaml_file(:indi3)
when /^-?-?indi4$/i,
/^-?-?Mastercurriculum(-|_| )?\(?Bio\)?Informatics(-|_| )?and(-|_| )?molecular(-|_| )?biotechnology(-|_| )?including(-|_| )?aspects(-|_| )?from(-|_| )?molecular(-|_| )?medicine$/i,
/^-?-?Mastercurriculum(-|_| )?Informatik(-|_| )?und(-|_| )?molekulare(-|_| )?Biologie$/i
@dataset = Studium.load_this_yaml_file(:indi4)
end
end
end
|
#rbg_to_hex(i = :lightsteelblue) ⇒ Object
72
73
74
75
76
|
# File 'lib/studium/utility_scripts/generate_spreadsheet/misc.rb', line 72
def rbg_to_hex(i = :lightsteelblue)
return ::Colours.to_hex(
::Colours.to_rgb(i.to_s)
)
end
|
#reset ⇒ Object
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
89
90
91
92
93
94
|
# File 'lib/studium/utility_scripts/generate_spreadsheet/generate_spreadsheet.rb', line 64
def reset
super()
infer_the_namespace
@dataset_from_the_file_lecture_information =
return_dataset_from_the_file_lecture_information
@generate_this_file = 'studium.xlsx'
@dataset = nil
@size_of_the_header_font = 18
@can_we_continue = false
end
|
#return_hash_for_the_courier_font ⇒ Object
#
return_hash_for_the_courier_font
#
106
107
108
109
110
111
112
|
# File 'lib/studium/utility_scripts/generate_spreadsheet/generate_spreadsheet.rb', line 106
def return_hash_for_the_courier_font
{
b: true,
font_name: 'Courier',
sz: 15
}
end
|
#run ⇒ Object
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
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
168
169
170
171
172
173
174
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
|
# File 'lib/studium/utility_scripts/generate_spreadsheet/generate_spreadsheet.rb', line 117
def run
check_for_the_availability_of_the_main_gem
if @can_we_continue
consider_removing_the_old_file
create_new_spreadsheet_instance
begin
require 'caxlsx'
rescue LoadError; end
@p = Axlsx::Package.new
wb = @p.workbook
workbook_styles = wb.styles
wb.styles { |style|
_larger_font = workbook_styles.add_style(sz: main_font_size?)
_larger_font_and_centered_alignment_and_moccasin_background = wb.styles.add_style(
bg_color: rbg_to_hex(:moccasin),
sz: main_font_size?,
alignment: horizontal_center
)
larger_font_and_centered_alignment_with_lightsteelblue_background = wb.styles.add_style(
return_hash_for_the_courier_font.merge(
bg_color: rbg_to_hex(:lightsteelblue),
sz: main_font_size?,
alignment: horizontal_center
)
)
larger_font_and_centered_alignment = wb.styles.add_style(
return_hash_for_the_courier_font.merge(
sz: main_font_size?,
alignment: horizontal_center
)
)
centered_alignment_and_border_and_seashell_background = wb.styles.add_style(
return_hash_for_the_courier_font.merge(
bg_color: rbg_to_hex(:seashell),
alignment: horizontal_center,
border: thin_border
)
)
_larger_font_and_centered_alignment_and_border_and_seashell_background = wb.styles.add_style(
return_hash_for_the_courier_font.merge(
bg_color: rbg_to_hex(:seashell),
sz: main_font_size?,
alignment: horizontal_center,
border: thin_border
)
)
_larger_font_and_centered_alignment_and_border = wb.styles.add_style(
return_hash_for_the_courier_font.merge(
sz: main_font_size?,
alignment: horizontal_center,
border: thin_border
)
)
_medium_font = wb.styles.add_style(sz: 16)
highlighted_and_centered_cell = wb.styles.add_style(
return_hash_for_the_courier_font.merge(
bg_color: 'EFC376', alignment: horizontal_center,
)
)
_center_alignment = wb.styles.add_style(
{ :alignment => horizontal_center }
)
_red_border = wb.styles.add_style(
:border => {
color: 'FF0000',
style: :thin
}
)
use_this_style_array = [
highlighted_and_centered_cell,
larger_font_and_centered_alignment_with_lightsteelblue_background,
centered_alignment_and_border_and_seashell_background,
larger_font_and_centered_alignment,
larger_font_and_centered_alignment,
larger_font_and_centered_alignment,
larger_font_and_centered_alignment ]
wb.add_worksheet(name: 'Curriculum') {|sheet|
sheet.add_row(
[
'#', 'Universität', 'LVA ID', 'Name der Lehrveranstaltung', 'Modul', 'n ECTS', 'LVA Typ' ],
style: use_this_style_array,
sz: @size_of_the_header_font
)
sheet.add_row sheet.add_row
index = 0
if @dataset.nil?
opnn
e 'No '+steelblue('@dataset')+' was found. Thus, no excel '\
'file can be generated.'
return
end
@dataset.each {|entry| index += 1
splitted = entry.split(' ')
lva_id = splitted.first.to_s name_of_the_lecture = splitted[1 .. -1].join(' ').strip
this_university = @dataset_from_the_file_lecture_information[entry][:university].to_s.strip
n_ects = @dataset_from_the_file_lecture_information[entry][:ects].to_s.strip
n_ects = '%.1f' % n_ects.to_f
lva_typ = @dataset_from_the_file_lecture_information[entry][:type].to_s.strip
sheet.add_row(
[
index.to_s, this_university, lva_id, name_of_the_lecture, '(unknown module)', n_ects, lva_typ ],
style: use_this_style_array,
types: [:text, :text, :text, :text, :text, :float, :text],
sz: 18
)
sheet.add_hyperlink(
location: Studium.return_url_from(entry).to_s,
ref: sheet.rows.last.cells.first
)
sheet.add_hyperlink(
location: Studium.return_url_from(entry).to_s,
ref: sheet.rows.last.cells[2] )
sheet.add_hyperlink(
location: Studium.return_url_from(entry).to_s,
ref: sheet.rows.last.cells[3] )
sheet.rows.last.cells.each {|this_cell|
this_cell.b = true
}
sheet.rows[-1].cells.each {|this_cell|
this_cell.b = true }
}
}
}
@p.serialize(main_file?)
if File.exist? @generate_this_file
opnn; e 'Saving into the file `'+
sfile(@generate_this_file)+'`.'
consider_opening_the_generated_file
end
else
e 'The main gem (gem install axlsx) '\
'is not available - thus we can not continue.'
end
end
|
#sanitize_commandline_arguments ⇒ Object
#
sanitize_commandline_arguments
#
23
24
25
26
27
|
# File 'lib/studium/utility_scripts/generate_spreadsheet/misc.rb', line 23
def sanitize_commandline_arguments
if @commandline_arguments.empty? and is_on_roebe?
@commandline_arguments << :indi2
end
end
|
#show_help ⇒ Object
88
89
90
91
92
93
94
95
96
|
# File 'lib/studium/utility_scripts/generate_spreadsheet/misc.rb', line 88
def show_help
e 'Available options are:'
e
e ' --indi1'
e ' --indi2'
e ' --indi3'
e ' --indi4'
e
end
|
16
17
18
|
# File 'lib/studium/utility_scripts/generate_spreadsheet/misc.rb', line 16
def
@size_of_the_header_font
end
|
#thin_border ⇒ Object
81
82
83
|
# File 'lib/studium/utility_scripts/generate_spreadsheet/misc.rb', line 81
def thin_border
Axlsx::STYLE_THIN_BORDER
end
|