Class: Roebe::FileParser

Inherits:
Base show all
Defined in:
lib/roebe/classes/file_parser.rb

Overview

Roebe::FileParser

Constant Summary collapse

DEFAULT_FILE =
#

DEFAULT_FILE

#
"#{HOME_DIRECTORY_OF_USER_X}DATA/MISC/YAML/slogans.yml"
SPLIT_CHARACTER_TO_USE =
#

SPLIT_CHARACTER_TO_USE

#
'-'

Constants inherited from Base

Base::COLOURS, Base::HOME_DIRECTORY_OF_USER_X, Base::N, Base::NAMESPACE

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#actions, #append_this_onto_that_file, #append_what_into, #be_silent, #be_verbose?, #beautiful_url, #burlywood, #call_next, #chdir, #cheerful_guy, #cliner, #complex_esystem, #convert_global_env, #copy_directory, #copy_file, #cornflowerblue, #create_directory, #crimson, #current_month?, #current_time?, #current_year?, #cyan, #darkcyan, #darkgreen, #darkkhaki, #darkslateblue, #deeppink, #delete_symlink, #do_not_use_the_base_colours, #do_use_the_base_colours, #e, #ecomment, #editor_to_use?, #efancy, #eimp, #emphasis, #ensure_main_encoding, #ensure_utf_encoding, #eparse, #erev, #esteelblue, #etomato, #ewarn, #firebrick, #get_current_day, #get_current_month, #get_files_and_directories, #get_files_from, #get_german_name_for_this_weekday, #gold, #green, #grey, #hh_mm_ss, #hh_mm_ss_day_month_year, #home_dir?, #home_directory_of_user_x?, #infer_the_namespace, #internal_hash?, #is_a_directory?, #is_a_file?, #is_a_jpg_file?, #is_an_image_file?, #is_archive?, #is_audio_file?, #is_in_studium_dir?, #is_multimedia_file?, #is_on_roebe?, #is_on_windows?, #is_studium_available?, #is_symlink?, #is_this_a_ruby_file?, #is_video_file?, #iso_encoding?, #le, #left_colour, #lightblue, #lightgreen, #lightseagreen, #lightsteelblue, #lime, #limegreen, #localhost_to_data, #log_directory?, #main_encoding?, #mediumorchid, #mediumpurple, #mediumseagreen, #mediumslateblue, #mediumspringgreen, #mediumturquoise, #mkdir_p, #mv, #n_days_in_this_month, #n_pages_in_this_pdf_file?, #namespace?, #no_file_exists_at, #olivedrab, #open_in_browser, #opne, #opnesystem, #opnn, #orange, #orchid, #orev, #palegoldenrod, #palevioletred, #pink, #powderblue, #programs_dir?, #project_base_dir?, #random_html_colour, #rds, #read_file_in_iso_encoding, #read_file_via_the_default_encoding, #read_lines_via_iso_encoding, #readlines_with_main_encoding, #red, #register_sigint, #remove, #remove_directory, #remove_file, #rename_kde_konsole_tab, #replace_localhost_with_data, #report_pwd, #require_rescue, #reset_the_internal_hash, #return_all_directories_from_this_directory, #return_all_files_from_this_directory, #return_current_directory, #return_dd_mm_yyyy, #return_file_or_directory_of, #return_files_from_pwd, #return_last_part_of_the_current_directory, #return_utc, #rev, #right_arrow?, #right_colour, #roebe_log_directory?, #rosybrown, #royalblue, #ruby_base_directory?, #run_in_background, #run_rcfiles_then_run_ata_via_qdbus, #sandybrown, #sdir, #seagreen, #set_be_verbose, #set_xorg_buffer, #sfancy, #sfile, #show_help, #silent_redirection?, #simp, #simple_esystem, #skyblue, #slateblue, #slategray, #springgreen, #steelblue, #string_italic, #swarn, #symlink, #teal, #temp_dir?, #to_camelcase, #to_counted_hash, #tomato, #touch, #try_to_require_the_beautiful_url_gem, #try_to_require_the_html_template, #try_to_require_the_open_gem, #try_to_require_the_program_information_gem, #try_to_require_the_xorg_buffer, #use_colours?, #verbose_truth, #weekday?, #word_wrap, #write_what_into, #yellow

Methods included from Base::CommandlineArguments

#append_onto_the_commandline_arguments, #clear_commandline_arguments, #commandline_arguments?, #commandline_arguments_as_string?, #commandline_arguments_without_leading_hyphens?, #first_argument?, #first_argument_without_leading_hyphens?, #has_an_argument_been_passed?, #remove_hyphened_arguments_from_the_commandline_arguments, #return_commandline_arguments_with_leading_hyphens, #second_argument?, #set_commandline_arguments

Constructor Details

#initialize(file = DEFAULT_FILE, run_already = true) ⇒ FileParser

#

initialize

#


35
36
37
38
39
40
41
42
 
# File 'lib/roebe/classes/file_parser.rb', line 35

def initialize(
    file        = DEFAULT_FILE,
    run_already = true
  )
  reset
  set_file(file)
  run if run_already
end

Instance Attribute Details

#data ⇒ Object (readonly)

Returns the value of attribute data.



19
20
21
 
# File 'lib/roebe/classes/file_parser.rb', line 19

def data
  @data
end

Instance Method Details

#assign_data(i = @file) ⇒ Object

#

assign_data

#


64
65
66
67
68
69
70
71
72
73
 
# File 'lib/roebe/classes/file_parser.rb', line 64

def assign_data(i = @file)
  if File.exist? i
    @data = File.readlines(i).
                 reject {|x| x[0,2] == '# '}.
                 reject {|x| x == N }.
                 reject {|x| x.empty? }
  else
    warn 'But the file `'+i+'` does not seem to exist.'
  end
end

#feedback_all ⇒ Object

#

feedback_all

#


106
107
108
 
# File 'lib/roebe/classes/file_parser.rb', line 106

def feedback_all
  pp @data
end

#output_random_entry ⇒ Object

#

output_random_entry

#


99
100
101
 
# File 'lib/roebe/classes/file_parser.rb', line 99

def output_random_entry
  e random_entry
end

#process_data ⇒ Object

#

process_data

#


78
79
80
81
82
83
84
85
86
87
 
# File 'lib/roebe/classes/file_parser.rb', line 78

def process_data
  @data = @data.join
  @data = @data.split(/^#{SPLIT_CHARACTER_TO_USE} /)
  @data.map! {|entry|
    entry.gsub!(/\n/,'')
    entry.gsub!(/  /,' ')
    entry.squeeze!(' ')
    entry
  }
end

#random_entry ⇒ Object

#

random_entry

#


92
93
94
 
# File 'lib/roebe/classes/file_parser.rb', line 92

def random_entry # Return a random element here.
  @data.sample
end

#reset ⇒ Object

#

reset

#


47
48
49
50
 
# File 'lib/roebe/classes/file_parser.rb', line 47

def reset
  super()
  @data = nil
end

#run ⇒ Object

#

run (run tag)

#


113
114
115
116
 
# File 'lib/roebe/classes/file_parser.rb', line 113

def run
  assign_data
  process_data if @data # Only continue if we found it.
end

#set_file(i = DEFAULT_FILE) ⇒ Object

#

set_file

#


55
56
57
58
59
 
# File 'lib/roebe/classes/file_parser.rb', line 55

def set_file(i = DEFAULT_FILE)
  i = DEFAULT_FILE if i.nil?
  i = DEFAULT_FILE if i == ':default'
  @file = i
end