Class: Roebe::GenerateNanoConfig

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

Overview

Roebe::GenerateNanoConfig

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

#

initialize

#


30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/roebe/classes/nano_config.rb', line 30

def initialize(
    i           = nil,
    run_already = true
  )
  reset
  set_input(i)
  case run_already
  when :do_not_run_yet
    run_already = false
  end
  run if run_already
end

Class Method Details

.[](i = ARGV) ⇒ Object

#

Roebe::GenerateNanoConfig[]

#


154
155
156
 
# File 'lib/roebe/classes/nano_config.rb', line 154

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

Instance Method Details

#append_file_content_to_main_dataset_instance_variable ⇒ Object

#

append_file_content_to_main_dataset_instance_variable

#


99
100
101
102
103
 
# File 'lib/roebe/classes/nano_config.rb', line 99

def append_file_content_to_main_dataset_instance_variable
  @all_files.each {|this_file|
    @dataset << "#{File.read(this_file)}#{N}"
  }
end

#dataset? ⇒ Boolean Also known as: content?

#

dataset?

#

Returns:

  • (Boolean) 


108
109
110
 
# File 'lib/roebe/classes/nano_config.rb', line 108

def dataset?
  @dataset
end

#delete_old_nanorc_file ⇒ Object

#

delete_old_nanorc_file

#


63
64
65
66
67
68
 
# File 'lib/roebe/classes/nano_config.rb', line 63

def delete_old_nanorc_file
  _ = @store_the_nanorc_file_here
  if File.exist? _
    remove_file(_)
  end
end

#do_all_the_tasks_before_storing_into_a_nano_config_file ⇒ Object Also known as: prepare_step

#

do_all_the_tasks_before_storing_into_a_nano_config_file

#


115
116
117
118
 
# File 'lib/roebe/classes/nano_config.rb', line 115

def do_all_the_tasks_before_storing_into_a_nano_config_file
  select_all_nano_rc_files
  append_file_content_to_main_dataset_instance_variable
end

#do_save_the_file ⇒ Object

#

do_save_the_file

#


135
136
137
138
139
140
141
 
# File 'lib/roebe/classes/nano_config.rb', line 135

def do_save_the_file
  what = @dataset
  into = @store_the_nanorc_file_here
  opne "Now storing the new configuration"
  opne "file for the editor nano into `#{sfile(into)}`."
  write_what_into(what, into)
end

#input? ⇒ Boolean

#

input?

#

Returns:

  • (Boolean) 


82
83
84
 
# File 'lib/roebe/classes/nano_config.rb', line 82

def input?
  @input
end

#rc_directory? ⇒ Boolean

#

rc_directory?

This method will point to a target such as /usr/lib/ruby/site_ruby/3.1.0/roebe/nano/.

#

Returns:

  • (Boolean) 


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

def rc_directory?
  DIRECTORY_CONTAINING_THE_NANO_RC_FILES
end

#reset ⇒ Object

#

reset (reset tag)

#


46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/roebe/classes/nano_config.rb', line 46

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @dataset
  # ======================================================================= #
  @dataset = "# Autogenerated nanorc file#{N}".dup # Need a non-frozen String.
  # ======================================================================= #
  # === @store_the_nanorc_file_here
  # ======================================================================= #
  @store_the_nanorc_file_here = "#{ENV['HOME']}/.nanorc"
  delete_old_nanorc_file
end

#run ⇒ Object

#

run (run tag)

#


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

def run
  do_all_the_tasks_before_storing_into_a_nano_config_file
  do_save_the_file
end

#select_all_nano_rc_files ⇒ Object

#

select_all_nano_rc_files

#


123
124
125
126
127
128
129
130
 
# File 'lib/roebe/classes/nano_config.rb', line 123

def select_all_nano_rc_files
  # ======================================================================= #
  # Obtain all .md files next, from a directory such as
  # '/usr/lib/ruby/site_ruby/3.2.0/roebe/nano/'.
  # ======================================================================= #
  @all_files = Dir["#{rc_directory?}*.md"]
  @all_files.reject! {|file| file.include? 'README' }
end

#set_input(i = '') ⇒ Object

#

set_input

#


73
74
75
76
77
 
# File 'lib/roebe/classes/nano_config.rb', line 73

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