Class: Roebe::KeyValueParser

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

Overview

Roebe::KeyValueParser

Constant Summary

Constants inherited from Base

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

Class Method 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, #exit_program, #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, #ogrey, #olive, #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(i = nil, run_already = true) ⇒ KeyValueParser

#

initialize

#


26
27
28
29
30
31
32
33
 
# File 'lib/roebe/classes/key_value_parser.rb', line 26

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

Class Method Details

.[](i = '') ⇒ Object

#

[]

#


137
138
139
 
# File 'lib/roebe/classes/key_value_parser.rb', line 137

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

Instance Method Details

#input? ⇒ Boolean

#

input?

#

Returns:

  • (Boolean) 


63
64
65
 
# File 'lib/roebe/classes/key_value_parser.rb', line 63

def input?
  @input
end

#main_hash? ⇒ Boolean

#

main_hash?

#

Returns:

  • (Boolean) 


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

def main_hash?
  @main_hash
end

#process_this_file(i = @input) ⇒ Object

#

process_this_file

Invoke this method only after checking that the file really does exist.

#


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/roebe/classes/key_value_parser.rb', line 73

def process_this_file(
    i = @input
  )
  dataset = readlines_with_proper_encoding(i)
  dataset.map! {|line|
    line.strip!
    if line.include? ' # '
      line = line.split(' #').first.strip
    end
    if line.include? ':'
      line = line.split(':').map(&:strip)
    end
    if line.is_a? Array
      line.flatten!
    end
    line
  }
  dataset.each {|key, value|
    value.strip!
    @main_hash[key] = value
  }
end

#reset ⇒ Object

#

reset (reset tag)

#


38
39
40
41
42
 
# File 'lib/roebe/classes/key_value_parser.rb', line 38

def reset
  super()
  infer_the_namespace
  @main_hash = {} # Store it here.
end

#run ⇒ Object

#

run (run tag)

#


126
127
128
129
130
131
132
 
# File 'lib/roebe/classes/key_value_parser.rb', line 126

def run
  if File.exist? @input
    process_this_file(@input)
  else
    e "No file exists at #{sfile(@input)}."
  end
end

#set_input(i = '') ⇒ Object

#

set_input

#


54
55
56
57
58
 
# File 'lib/roebe/classes/key_value_parser.rb', line 54

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

#values_to_numbers(integers_or_floats = :integers) ⇒ Object

#

values_to_numbers

This will try to convert the values into numbers. Alternatively we could have used .transform_values() instead.

The input argument can be either :integers or :floats. The value will be converted to that class, respectively.

Usage example for this:

this_file = '/Users/x/STUDIUM/UNI_WIEN/301080_Bioinformatik_für_Biologen/Assignment_3/tree_space.md'
x = Roebe::KeyValueParser.new(this_file)
x.values_to_numbers; hash = x.main_hash?; pp hash
#


110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/roebe/classes/key_value_parser.rb', line 110

def values_to_numbers(
    integers_or_floats = :integers
  )
  @main_hash.each {|key, value|
    case integers_or_floats
    when :integers
      @main_hash[key] = value.to_i
    when :floats
      @main_hash[key] = value.to_f
    end
  }
end