Class: Roebe::ReturnNAliases

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

Direct Known Subclasses

ReturnTenAliases, ReturnTwentyAliases

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

#

initialize

#


32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/roebe/classes/return_aliases/return_n_aliases.rb', line 32

def initialize(
    i           = nil,
    run_already = true
  )
  reset
  set_input(i)
  # ======================================================================= #
  # === Handle blocks next
  # ======================================================================= #
  if block_given?
    yielded = yield
    if yielded.is_a? Integer
      add(yielded - @array_use_these_entries.size)
    end
  end
  run if run_already
end

Class Method Details

.[](i = '') ⇒ Object

#

Roebe::ReturnNAliases[]

This will return the main hash.

The format will typically be like this:

{ 1 => "ab2",
  2 => "molplants",
  3 => "panatomy" }
#


155
156
157
 
# File 'lib/roebe/classes/return_aliases/return_n_aliases.rb', line 155

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

Instance Method Details

#add(n_entries = 5) ⇒ Object

#

add

Here we can add “5 entries”, for example. The method thus allows us to add n elements to the main Array.

#


76
77
78
79
80
81
82
83
 
# File 'lib/roebe/classes/return_aliases/return_n_aliases.rb', line 76

def add(n_entries = 5)
  if n_entries > 0
    n_entries.times {
      @array_use_these_entries << (@array_use_these_entries.last.to_i + 1).to_s
      @array_use_these_entries.uniq!
    }
  end
end

#input? ⇒ Boolean

#

input?

#

Returns:

  • (Boolean) 


97
98
99
 
# File 'lib/roebe/classes/return_aliases/return_n_aliases.rb', line 97

def input?
  @input
end

#main_hash? ⇒ Boolean Also known as: main_hash

#

main_hash?

This Hash stores the ten aliases.

#

Returns:

  • (Boolean) 


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

def main_hash?
  @main_hash
end

#obtain_dataset_for_the_ten_aliases ⇒ Object

#

obtain_dataset_for_the_ten_aliases

#


113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/roebe/classes/return_aliases/return_n_aliases.rb', line 113

def obtain_dataset_for_the_ten_aliases
  @main_hash = {} # Store things here.
  @array_use_these_entries.each {|this_entry|
    # ===================================================================== #
    # The aliases are stored as numbers in the file "aliases.yml".
    # ===================================================================== #
    this_entry = this_entry.to_i
    dataset = @dataset_from_file_aliases[this_entry]
    @main_hash.update(
      { this_entry => dataset }
    )
  }
end

#reset ⇒ Object

#

reset (reset tag)

#


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/roebe/classes/return_aliases/return_n_aliases.rb', line 53

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @dataset_from_file_aliases
  # ======================================================================= #
  @dataset_from_file_aliases = YAML.load_file(
    Rcfiles.file_aliases?
  )
  # ======================================================================= #
  # === @array_use_these_entries
  # ======================================================================= #
  @array_use_these_entries = %w(
    1 2 3 4 5
  )
end

#result_as_string? ⇒ Boolean

#

result_as_string?

Return the Hash “result” as a String.

#

Returns:

  • (Boolean) 


132
133
134
 
# File 'lib/roebe/classes/return_aliases/return_n_aliases.rb', line 132

def result_as_string?
  @main_hash.map {|key, value| "#{key}=#{value}\n"}.join(' ')
end

#run ⇒ Object

#

run (run tag)

#


139
140
141
 
# File 'lib/roebe/classes/return_aliases/return_n_aliases.rb', line 139

def run
  obtain_dataset_for_the_ten_aliases
end

#set_input(i = '') ⇒ Object

#

set_input

#


88
89
90
91
92
 
# File 'lib/roebe/classes/return_aliases/return_n_aliases.rb', line 88

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