Class: Roebe::SizeOfStates

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

Overview

Roebe::SizeOfStates.new

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, #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 = ARGV, run_already = true) ⇒ SizeOfStates

#

initialize

#


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

def initialize(
    i           = ARGV,
    run_already = true
  )
  reset
  set_commandline_arguments(i)
  run if run_already
end

Class Method Details

.[](i = ARGV) ⇒ Object

#

Roebe::SizeOfStates[]

#


147
148
149
 
# File 'lib/roebe/classes/size_of_states.rb', line 147

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

Instance Method Details

#consider_applying_a_filter ⇒ Object

#

consider_applying_a_filter

#


119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/roebe/classes/size_of_states.rb', line 119

def consider_applying_a_filter
  unless @filter.empty?
    selection = main_dataset?.select {|name_of_the_country, area|
      name_of_the_country = ensure_main_encoding(name_of_the_country)
      _ = name_of_the_country.downcase
      @filter.include? _
    }
    # ===================================================================== #
    # Assign a new dataset if the selection is not empty.
    # ===================================================================== #
    unless selection.empty?
      set_new_dataset(selection)
    end
  end
end

#dataset? ⇒ Boolean Also known as: main_dataset?

#

dataset?

#

Returns:

  • (Boolean) 


59
60
61
 
# File 'lib/roebe/classes/size_of_states.rb', line 59

def dataset?
  @dataset
end

#display_dataset(use_this_dataset = @dataset) ⇒ Object

#

display_dataset

#


105
106
107
108
109
110
111
112
113
114
 
# File 'lib/roebe/classes/size_of_states.rb', line 105

def display_dataset(
    use_this_dataset = @dataset
  )
  e
  use_this_dataset.each_pair {|name_of_the_country, size_of_the_country|
    name_of_the_country = ensure_main_encoding(name_of_the_country)
    e '  '+slateblue((name_of_the_country+':').ljust(38))+
      royalblue(size_of_the_country.to_s.rjust(8))
  }; e
end

#menu(i = commandline_arguments? ) ⇒ Object

#

menu (menu tag)

#


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

def menu(
    i = commandline_arguments?
  )
  if i.is_a? Array
    i.each {|entry| menu(entry) }
  else
    case i # case tag
    # ======================================================================= #
    # === --help
    # ======================================================================= #
    when /help/
      show_help
      exit
    else
      @filter << i.delete('-').downcase # Add this to the filter in this case.
    end
  end
end

#reset ⇒ Object

#

reset (reset tag)

#


47
48
49
50
51
52
53
54
 
# File 'lib/roebe/classes/size_of_states.rb', line 47

def reset
  super()
  # ======================================================================= #
  # === @dataset
  # ======================================================================= #
  @dataset = YAML.load_file(FILE_SIZE_OF_COUNTRIES)
  @filter = [] # You can apply a filter to the dataset.
end

#run ⇒ Object

#

run (run tag)

#


138
139
140
141
142
 
# File 'lib/roebe/classes/size_of_states.rb', line 138

def run
  menu
  consider_applying_a_filter
  display_dataset # By default, we will simply display the countries.
end

#set_dataset(i) ⇒ Object Also known as: set_new_dataset

#

set_dataset

#


66
67
68
 
# File 'lib/roebe/classes/size_of_states.rb', line 66

def set_dataset(i)
  @dataset = i
end

#show_help ⇒ Object

#

show_help

#


95
96
97
98
99
100
 
# File 'lib/roebe/classes/size_of_states.rb', line 95

def show_help
  e
  e '  --india'
  e '  --usa'
  e
end